openapi: 3.0.0
info:
  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
    url: https://squareup.com/developers
    email: developers@squareup.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: "2.0"
  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
paths:
  /mobile/authorization-code:
    post:
      tags:
      - MobileAuthorization
      summary: CreateMobileAuthorizationCode
      description: |-
        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.

        __Important:__ 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).
      externalDocs:
        description: Build with Mobile Authorization API
        url: https://developer.squareup.com/docs/mobile-authz/build-with-mobile-authz
      operationId: CreateMobileAuthorizationCode
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMobileAuthorizationCodeRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMobileAuthorizationCodeResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE_IN_PERSON
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /oauth/protos/squareup/oauth/v1/api.proto
      x-proto-sha: f1c3dbfadb8bfd89be4dd98d020e639b81a15b72
  /oauth2/authorize:
    get:
      tags:
      - OAuth
      summary: Authorize
      description: "As part of a URL sent to a seller to authorize permissions for\
        \ \nthe developer, `Authorize` displays an authorization page and a \nlist\
        \ of requested permissions. This is not a callable API endpoint.\n\nThe completed\
        \ URL looks similar to the following example:\nhttps://connect.squareup.com/oauth2/authorize?client_id={YOUR_APP_ID}&scope=CUSTOMERS_WRITE+CUSTOMERS_READ&session=False&state=82201dd8d83d23cc8a48caf52b\n\
        \nThe seller can approve or deny the permissions. If approved,` Authorize`\
        \ \nreturns an `AuthorizeResponse` that is sent to the redirect URL and includes\
        \ \na state string and an authorization code. The code is used in the `ObtainToken`\
        \ \ncall to obtain an access token and a refresh token that the developer\
        \ uses \nto manage resources on behalf of the seller.\n\n__Important:__ The\
        \ `AuthorizeResponse` is sent to the redirect URL that you set on \nthe OAuth\
        \ page of your application in the Developer Dashboard.\n\nIf an error occurs\
        \ or the seller denies the request, `Authorize` returns an \nerror response\
        \ that includes `error` and `error_description` values. If the \nerror is\
        \ due to the seller denying the request, the error value is `access_denied`\
        \ \nand the `error_description` is `user_denied`."
      externalDocs:
        description: Create the Redirect URL and Square Authorization Page URL
        url: https://developer.squareup.com/docs/oauth-api/create-urls-for-square-authorization
      operationId: Authorize
      parameters:
      - name: client_id
        in: query
        description: "The Square-issued ID for your application, available from \n\
          the OAuth page for your application on the Developer Dashboard."
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: scope
        in: query
        description: |-
          A space-separated list of the permissions that the application is requesting.
          Default: "`MERCHANT_PROFILE_READ PAYMENTS_READ SETTLEMENTS_READ BANK_ACCOUNTS_READ`"
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/OAuthPermission'
      - name: locale
        in: query
        description: |-
          The locale to present the permission request form in. Square detects
          the appropriate locale automatically. Only provide this value if the
          application can definitively determine the preferred locale.

          Currently supported values: `en-IE`, `en-US`, `en-CA`, `es-US`, `fr-CA`, and
          `ja-JP`.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: session
        in: query
        description: |-
          If `false`, the user must log in to their Square account to
          view the Permission Request form, even if they already have a valid user
          session. This value has no effect in Sandbox.
          Default: `true`
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: state
        in: query
        description: |-
          When provided, `state` is passed to the configured redirect URL after
          the Permission Request form is submitted. You can include `state` and verify
          its value to help protect against cross-site request forgery.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: code_challenge
        in: query
        description: |-
          When provided, the oauth flow will use PKCE to authorize. The `code_challenge` will be associated
          with the authorization_code and a `code_verifier` will need to passed in to obtain the access token.
        required: false
        style: form
        explode: true
        schema:
          type: string
        x-release-status: BETA
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizeResponse'
      security: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /oauth/protos/squareup/oauth/v1/api.proto
      x-proto-sha: f1c3dbfadb8bfd89be4dd98d020e639b81a15b72
      x-visibility: DOC_ONLY
  /oauth2/clients/{client_id}/access-token/renew:
    post:
      tags:
      - OAuth
      summary: RenewToken
      description: |-
        `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see
        [Migrate from Renew to Refresh OAuth Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens).

        Renews an OAuth access token before it expires.

        OAuth access tokens besides your application's personal access token expire after 30 days.
        You can also renew expired tokens within 15 days of their expiration.
        You cannot renew an access token that has been expired for more than 15 days.
        Instead, the associated user must recomplete the OAuth flow from the beginning.

        __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 Credentials
        page in the [Developer Dashboard](https://developer.squareup.com/apps).
      operationId: RenewToken
      parameters:
      - name: client_id
        in: path
        description: Your application ID, which is available in the OAuth page in
          the [Developer Dashboard](https://developer.squareup.com/apps).
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RenewTokenRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenewTokenResponse'
      deprecated: true
      security:
      - oauth2ClientSecret: []
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /oauth/protos/squareup/oauth/v1/api.proto
      x-proto-sha: f1c3dbfadb8bfd89be4dd98d020e639b81a15b72
      x-deprecation: {}
  /oauth2/revoke:
    post:
      tags:
      - OAuth
      summary: RevokeToken
      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. When an
        OAuth access token is revoked, all of the active subscriptions associated
        with that OAuth token are canceled immediately.

        __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 on the Developer Dashboard.
      externalDocs:
        description: Refresh, Revoke, and Limit the Scope of OAuth Tokens
        url: https://developer.squareup.com/docs/oauth-api/refresh-revoke-limit-scope
      operationId: RevokeToken
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RevokeTokenRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RevokeTokenResponse'
      security:
      - oauth2ClientSecret: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /oauth/protos/squareup/oauth/v1/api.proto
      x-proto-sha: f1c3dbfadb8bfd89be4dd98d020e639b81a15b72
  /oauth2/token:
    post:
      tags:
      - OAuth
      summary: ObtainToken
      description: "Returns an OAuth access token and a refresh token unless the \n\
        `short_lived` parameter is set to `true`, in which case the endpoint \nreturns\
        \ only an access token.\n\nThe `grant_type` parameter specifies the type of\
        \ OAuth request. If \n`grant_type` is `authorization_code`, you must include\
        \ the authorization \ncode you received when a seller granted you authorization.\
        \ If `grant_type` \nis `refresh_token`, you must provide a valid refresh token.\
        \ If you are using \nan old version of the Square APIs (prior to March 13,\
        \ 2019), `grant_type` \ncan be `migration_token` and you must provide a valid\
        \ migration token.\n\nYou can use the `scopes` parameter to limit the set\
        \ of permissions granted \nto the access token and refresh token. You can\
        \ use the `short_lived` parameter \nto create an access token that expires\
        \ in 24 hours.\n\n__Note:__ OAuth tokens should be encrypted and stored on\
        \ a secure server. \nApplication clients should never interact directly with\
        \ OAuth tokens."
      externalDocs:
        description: Receive Seller Authorization and Manage Seller OAuth Tokens
        url: https://developer.squareup.com/docs/oauth-api/receive-and-manage-tokens
      operationId: ObtainToken
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ObtainTokenRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObtainTokenResponse'
      security: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /oauth/protos/squareup/oauth/v1/api.proto
      x-proto-sha: f1c3dbfadb8bfd89be4dd98d020e639b81a15b72
  /v1/batch:
    post:
      tags:
      - V1Batching
      summary: V1SubmitBatch
      description: |-
        Bundle multiple requests to Connect V1 API endpoints as a single
        request.


        The __V1SubmitBatch__ endpoint does not require an access token
        in the request header. Instead, provide an `access_token` parameter for
        each request included in the batch.

        __V1SubmitBatch__ responds with an array that contains response objects for
        each of the batched requests. There is no guarantee of the order in
        which batched requests are performed.


        __IMPORTANT__

        You cannot include more than 30 requests in a single batch and
        recursive requests to __V1SubmitBatch__ are not allowed. In
        other words, none of the requests included in a batch can itself be a
        request to the __V1SubmitBatch__ endpoint.
      operationId: V1SubmitBatch
      parameters: []
      requestBody:
        description: The set of API actions to perform.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BatchResponse'
                x-content-type: application/json
      deprecated: true
      security: []
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1batch.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-deprecation:
        deprecationDate: 2019-11-20
        retirementDate: 2020-11-18
        guideUrl: https://developer.squareup.com/docs/migrate-from-v1/general-guidance#v1batching
      x-visibility: DOC_ONLY
  /v1/{location_id}/payments:
    get:
      tags:
      - V1Transactions
      summary: V1ListPayments
      description: |-
        Provides summary information for all payments taken for a given
        Square account during a date range. Date ranges cannot exceed 1 year in
        length. See Date ranges for details of inclusive and exclusive dates.

        *Note**: Details for payments processed with Square Point of Sale while
        in offline mode may not be transmitted to Square for up to 72 hours.
        Offline payments have a `created_at` value that reflects the time the
        payment was originally processed, not the time it was subsequently
        transmitted to Square. Consequently, the ListPayments endpoint might
        list an offline payment chronologically between online payments that
        were seen in a previous request.
      operationId: V1ListPayments
      parameters:
      - name: location_id
        in: path
        description: The ID of the location to list payments for. If you specify me,
          this endpoint returns payments aggregated from all of the business's locations.
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      - name: order
        in: query
        description: The order in which payments are listed in the response.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/SortOrder'
      - name: begin_time
        in: query
        description: 'The beginning of the requested reporting period, in ISO 8601
          format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z),
          this endpoint returns an error. Default value: The current time minus one
          year.'
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
      - name: end_time
        in: query
        description: 'The end of the requested reporting period, in ISO 8601 format.
          If this value is more than one year greater than begin_time, this endpoint
          returns an error. Default value: The current time.'
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of payments to return in a single response.
          This value cannot exceed 200.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: integer
      - name: batch_token
        in: query
        description: |-
          A pagination cursor to retrieve the next set of results for your
          original query to the endpoint.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
      - name: include_partial
        in: query
        description: Indicates whether or not to include partial payments in the response.
          Partial payments will have the tenders collected so far, but the itemizations
          will be empty until the payment is completed.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/V1Payment'
                x-content-type: application/json
      deprecated: true
      security:
      - oauth2:
        - PAYMENTS_READ
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-payments.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-deprecation:
        deprecationDate: 2021-05-13
        retirementDate: TBD
        replacedBy: ListPayments
        guideUrl: https://developer.squareup.com/docs/migrate-from-v1/guides/v1-payments
  /v1/{location_id}/payments/{payment_id}:
    get:
      tags:
      - V1Transactions
      summary: V1RetrievePayment
      description: Provides comprehensive information for a single payment.
      operationId: V1RetrievePayment
      parameters:
      - name: location_id
        in: path
        description: The ID of the payment's associated location.
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      - name: payment_id
        in: path
        description: The Square-issued payment ID. payment_id comes from Payment objects
          returned by the List Payments endpoint, Settlement objects returned by the
          List Settlements endpoint, or Refund objects returned by the List Refunds
          endpoint.
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Payment'
      deprecated: true
      security:
      - oauth2:
        - PAYMENTS_READ
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-payments.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-deprecation:
        deprecationDate: 2021-05-13
        retirementDate: TBD
        replacedBy: GetPayment
        guideUrl: https://developer.squareup.com/docs/migrate-from-v1/guides/v1-payments
  /v1/{location_id}/refunds:
    get:
      tags:
      - V1Transactions
      summary: V1ListRefunds
      description: Provides the details for all refunds initiated by a merchant or
        any of the merchant's mobile staff during a date range. Date ranges cannot
        exceed one year in length.
      operationId: V1ListRefunds
      parameters:
      - name: location_id
        in: path
        description: The ID of the location to list refunds for.
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      - name: order
        in: query
        description: The order in which payments are listed in the response.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/SortOrder'
      - name: begin_time
        in: query
        description: 'The beginning of the requested reporting period, in ISO 8601
          format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z),
          this endpoint returns an error. Default value: The current time minus one
          year.'
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
      - name: end_time
        in: query
        description: 'The end of the requested reporting period, in ISO 8601 format.
          If this value is more than one year greater than begin_time, this endpoint
          returns an error. Default value: The current time.'
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: 'The approximate number of refunds to return in a single response.
          Default: 100. Max: 200. Response may contain more results than the prescribed
          limit when refunds are made simultaneously to multiple tenders in a payment
          or when refunds are generated in an exchange to account for the value of
          returned goods.'
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: integer
      - name: batch_token
        in: query
        description: |-
          A pagination cursor to retrieve the next set of results for your
          original query to the endpoint.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/V1Refund'
                x-content-type: application/json
      deprecated: true
      security:
      - oauth2:
        - PAYMENTS_READ
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-refunds.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-deprecation:
        deprecationDate: 2021-05-13
        retirementDate: TBD
        replacedBy: ListPaymentRefunds
        guideUrl: https://developer.squareup.com/docs/migrate-from-v1/guides/v1-refunds
    post:
      tags:
      - V1Transactions
      summary: V1CreateRefund
      description: |-
        Issues a refund for a previously processed payment. You must issue
        a refund within 60 days of the associated payment.

        You cannot issue a partial refund for a split tender payment. You must
        instead issue a full or partial refund for a particular tender, by
        providing the applicable tender id to the V1CreateRefund endpoint.
        Issuing a full refund for a split tender payment refunds all tenders
        associated with the payment.

        Issuing a refund for a card payment is not reversible. For development
        purposes, you can create fake cash payments in Square Point of Sale and
        refund them.
      operationId: V1CreateRefund
      parameters:
      - name: location_id
        in: path
        description: The ID of the original payment's associated location.
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V1CreateRefundRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Refund'
      deprecated: true
      security:
      - oauth2:
        - PAYMENTS_WRITE
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-refunds.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-deprecation:
        deprecationDate: 2021-05-13
        retirementDate: TBD
        replacedBy: RefundPayment
        guideUrl: https://developer.squareup.com/docs/migrate-from-v1/guides/v1-refunds
  /v1/{location_id}/settlements:
    get:
      tags:
      - V1Transactions
      summary: V1ListSettlements
      description: |-
        Provides summary information for all deposits and withdrawals
        initiated by Square to a linked bank account during a date range. Date
        ranges cannot exceed one year in length.

        *Note**: the ListSettlements endpoint does not provide entry
        information.
      operationId: V1ListSettlements
      parameters:
      - name: location_id
        in: path
        description: The ID of the location to list settlements for. If you specify
          me, this endpoint returns settlements aggregated from all of the business's
          locations.
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      - name: order
        in: query
        description: The order in which settlements are listed in the response.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/SortOrder'
      - name: begin_time
        in: query
        description: 'The beginning of the requested reporting period, in ISO 8601
          format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z),
          this endpoint returns an error. Default value: The current time minus one
          year.'
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
      - name: end_time
        in: query
        description: 'The end of the requested reporting period, in ISO 8601 format.
          If this value is more than one year greater than begin_time, this endpoint
          returns an error. Default value: The current time.'
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of settlements to return in a single response.
          This value cannot exceed 200.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: integer
      - name: status
        in: query
        description: Provide this parameter to retrieve only settlements with a particular
          status (SENT or FAILED).
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/V1ListSettlementsRequestStatus'
      - name: batch_token
        in: query
        description: |-
          A pagination cursor to retrieve the next set of results for your
          original query to the endpoint.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/V1Settlement'
                x-content-type: application/json
      deprecated: true
      security:
      - oauth2:
        - SETTLEMENTS_READ
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-settlements.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-deprecation:
        deprecationDate: 2021-05-13
        retirementDate: 2023-06-16
        replacedBy: ListPayouts
        guideUrl: https://developer.squareup.com/docs/migrate-from-v1/guides/v1-settlements
  /v1/{location_id}/settlements/{settlement_id}:
    get:
      tags:
      - V1Transactions
      summary: V1RetrieveSettlement
      description: |-
        Provides comprehensive information for a single settlement.

        The returned `Settlement` objects include an `entries` field that lists
        the transactions that contribute to the settlement total. Most
        settlement entries correspond to a payment payout, but settlement
        entries are also generated for less common events, like refunds, manual
        adjustments, or chargeback holds.

        Square initiates its regular deposits as indicated in the
        [Deposit Options with Square](https://squareup.com/help/us/en/article/3807)
        help article. Details for a regular deposit are usually not available
        from Connect API endpoints before 10 p.m. PST the same day.

        Square does not know when an initiated settlement **completes**, only
        whether it has failed. A completed settlement is typically reflected in
        a bank account within 3 business days, but in exceptional cases it may
        take longer.
      operationId: V1RetrieveSettlement
      parameters:
      - name: location_id
        in: path
        description: The ID of the settlements's associated location.
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      - name: settlement_id
        in: path
        description: The settlement's Square-issued ID. You obtain this value from
          Settlement objects returned by the List Settlements endpoint.
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Settlement'
      deprecated: true
      security:
      - oauth2:
        - SETTLEMENTS_READ
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-settlements.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-deprecation:
        deprecationDate: 2021-05-13
        retirementDate: 2023-06-16
        replacedBy: GetPayout
        guideUrl: https://developer.squareup.com/docs/migrate-from-v1/guides/v1-settlements
  /v1/{location_id}/webhooks:
    get:
      tags:
      - V1Webhooks
      summary: V1ListWebhooks
      description: |-
        Lists which types of events trigger webhook notifications for a particular location.
        See the [V1 Webhooks API guide](https://developer.squareup.com/docs/webhooks-api/what-it-does-v1) for more information.
      operationId: V1ListWebhooks
      parameters:
      - name: location_id
        in: path
        description: The ID of the location to list webhook notification types for.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/V1WebhooksEvents'
                x-content-type: application/json
      security:
      - oauth2:
        - TIMECARDS_READ
        - PAYMENTS_READ
        - ITEMS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1webhooks.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-visibility: DOC_ONLY
    put:
      tags:
      - V1Webhooks
      summary: V1UpdateWebhooks
      description: |-
        Changes the webhook event subscriptions for a location.
        See the [V1 Webhooks API guide](https://developer.squareup.com/docs/webhooks-api/what-it-does-v1) for more information.
      operationId: V1UpdateWebhooks
      parameters:
      - name: location_id
        in: path
        description: The ID of the location to list webhook notification types for.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/V1WebhooksEvents'
                x-content-type: application/json
      security:
      - oauth2:
        - TIMECARDS_READ
        - PAYMENTS_READ
        - ITEMS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1webhooks.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-visibility: DOC_ONLY
  /v2/apple-pay/domains:
    post:
      tags:
      - ApplePay
      summary: RegisterDomain
      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: The SqPaymentForm library is deprecated as of May 13, 2021, and will only receive critical security updates until it is retired on October 31, 2022.
        You must migrate your payment form code to the Web Payments SDK to continue using your domain for Apple Pay. For more information on migrating to the Web Payments SDK, see [Migrate to the Web Payments SDK](https://developer.squareup.com/docs/web-payments/migrate).

        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).
      operationId: RegisterDomain
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterDomainRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterDomainResponse'
      security:
      - oauth2: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /payapi-wallets/protos/squareup/payapi_wallets/apple_pay_domain_service.proto
      x-proto-sha: 5a571cd674a882679027661caa0270c3d59161a9
  /v2/bank-accounts:
    get:
      tags:
      - BankAccounts
      summary: ListBankAccounts
      description: Returns a list of [BankAccount](entity:BankAccount) objects linked
        to a Square account.
      externalDocs:
        description: Retrieve all bank accounts linked to a Square account
        url: https://developer.squareup.com/docs/bank-accounts-api#retrieve-all-bank-accounts-linked-to-a-square-account
      operationId: ListBankAccounts
      parameters:
      - name: cursor
        in: query
        description: "The pagination cursor returned by a previous call to this endpoint.\n\
          Use it in the next `ListBankAccounts` request to retrieve the next set \n\
          of results.\n\nSee the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)\
          \ guide for more information."
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        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."
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: location_id
        in: query
        description: "Location ID. You can specify this optional filter \nto retrieve\
          \ only the linked bank accounts belonging to a specific location."
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBankAccountsResponse'
      security:
      - oauth2:
        - BANK_ACCOUNTS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/bank_account_service.proto
      x-proto-sha: dc1003a64eea24f147d72da44df7237577699575
      x-namespace: marketplaces
  /v2/bank-accounts/by-v1-id/{v1_bank_account_id}:
    get:
      tags:
      - BankAccounts
      summary: GetBankAccountByV1Id
      description: Returns details of a [BankAccount](entity:BankAccount) identified
        by V1 bank account ID.
      externalDocs:
        description: Retrieve a bank account by using a V1 ID
        url: https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-the-v1-bank-accounts-api
      operationId: GetBankAccountByV1Id
      parameters:
      - name: v1_bank_account_id
        in: path
        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)."
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBankAccountByV1IdResponse'
      security:
      - oauth2:
        - BANK_ACCOUNTS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/bank_account_service.proto
      x-proto-sha: dc1003a64eea24f147d72da44df7237577699575
      x-namespace: marketplaces
  /v2/bank-accounts/{bank_account_id}:
    get:
      tags:
      - BankAccounts
      summary: GetBankAccount
      description: |-
        Returns details of a [BankAccount](entity:BankAccount)
        linked to a Square account.
      externalDocs:
        description: Retrieve a bank account by ID
        url: https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-id
      operationId: GetBankAccount
      parameters:
      - name: bank_account_id
        in: path
        description: Square-issued ID of the desired `BankAccount`.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBankAccountResponse'
      security:
      - oauth2:
        - BANK_ACCOUNTS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/bank_account_service.proto
      x-proto-sha: dc1003a64eea24f147d72da44df7237577699575
      x-namespace: marketplaces
  /v2/bookings:
    get:
      tags:
      - Bookings
      summary: ListBookings
      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.
      operationId: ListBookings
      parameters:
      - name: limit
        in: query
        description: The maximum number of results per page to return in a paged response.
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: cursor
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: team_member_id
        in: query
        description: The team member for whom to retrieve bookings. If this is not
          set, bookings of all members are retrieved.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: location_id
        in: query
        description: The location for which to retrieve bookings. If this is not set,
          all locations' bookings are retrieved.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: start_at_min
        in: query
        description: The RFC 3339 timestamp specifying the earliest of the start time.
          If this is not set, the current time is used.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: start_at_max
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBookingsResponse'
      security:
      - oauth2:
        - APPOINTMENTS_READ
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-example-scenarios:
        scenarios:
        - name: Retrieve a collection of bookings
          response:
            bookings:
            - id: zkras0xv0xwswx
              version: 1
              status: ACCEPTED
              created_at: 2020-10-28T15:47:41Z
              updated_at: 2020-10-28T15:49:25Z
              location_id: LEQHH0YY8B42M
              customer_id: EX2QSVGTZN4K1E5QE1CBFNVQ8M
              customer_note: ""
              seller_note: ""
              start_at: 2020-11-26T13:00:00Z
              appointment_segments:
              - duration_minutes: 60
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                team_member_id: TMXUrsBWWcHTt79t
                service_variation_version: 1599775456731
            errors: []
    post:
      tags:
      - Bookings
      summary: CreateBooking
      description: |-
        Creates 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*.
      operationId: CreateBooking
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBookingRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBookingResponse'
      security:
      - oauth2:
        - APPOINTMENTS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-example-scenarios:
        scenarios:
        - name: Create a booking
          bodyParams:
            booking:
              customer_id: EX2QSVGTZN4K1E5QE1CBFNVQ8M
              start_at: 2020-11-26T13:00:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMXUrsBWWcHTt79t
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
          response:
            booking:
              id: zkras0xv0xwswx
              version: 0
              status: ACCEPTED
              created_at: 2020-10-28T15:47:41Z
              updated_at: 2020-10-28T15:47:41Z
              location_id: LEQHH0YY8B42M
              customer_id: EX2QSVGTZN4K1E5QE1CBFNVQ8M
              customer_note: ""
              seller_note: ""
              start_at: 2020-11-26T13:00:00Z
              appointment_segments:
              - duration_minutes: 60
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                team_member_id: TMXUrsBWWcHTt79t
                service_variation_version: 1599775456731
            errors: []
  /v2/bookings/availability/search:
    post:
      tags:
      - Bookings
      summary: SearchAvailability
      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.
      operationId: SearchAvailability
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchAvailabilityRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchAvailabilityResponse'
      security:
      - oauth2:
        - APPOINTMENTS_READ
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-example-scenarios:
        scenarios:
        - name: Search for availability
          bodyParams:
            query:
              filter:
                start_at_range:
                  start_at: 2020-11-26T13:00:00Z
                  end_at: 2020-11-27T13:00:00Z
                location_id: LEQHH0YY8B42M
                segment_filters:
                - service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                  team_member_id_filter:
                    any:
                    - TMXUrsBWWcHTt79t
                    - TMaJcbiRqPIGZuS9
          response:
            availabilities:
            - start_at: 2020-11-26T13:00:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMXUrsBWWcHTt79t
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            - start_at: 2020-11-26T13:30:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMXUrsBWWcHTt79t
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            - start_at: 2020-11-26T14:00:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMaJcbiRqPIGZuS9
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            - start_at: 2020-11-26T14:30:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMaJcbiRqPIGZuS9
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            - start_at: 2020-11-26T15:00:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMaJcbiRqPIGZuS9
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            - start_at: 2020-11-26T15:30:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMaJcbiRqPIGZuS9
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            - start_at: 2020-11-26T16:00:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMaJcbiRqPIGZuS9
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            - start_at: 2020-11-27T09:00:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMXUrsBWWcHTt79t
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            - start_at: 2020-11-27T09:30:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMaJcbiRqPIGZuS9
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            - start_at: 2020-11-27T10:00:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMXUrsBWWcHTt79t
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            - start_at: 2020-11-27T10:30:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMXUrsBWWcHTt79t
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            - start_at: 2020-11-27T11:00:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMXUrsBWWcHTt79t
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            - start_at: 2020-11-27T11:30:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMaJcbiRqPIGZuS9
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            - start_at: 2020-11-27T12:00:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMaJcbiRqPIGZuS9
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            - start_at: 2020-11-27T12:30:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMaJcbiRqPIGZuS9
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            - start_at: 2020-11-27T13:00:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMXUrsBWWcHTt79t
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            - start_at: 2020-11-27T13:30:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMXUrsBWWcHTt79t
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            - start_at: 2020-11-27T14:00:00Z
              location_id: LEQHH0YY8B42M
              appointment_segments:
              - duration_minutes: 60
                team_member_id: TMaJcbiRqPIGZuS9
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                service_variation_version: 1599775456731
            errors: []
  /v2/bookings/business-booking-profile:
    get:
      tags:
      - Bookings
      summary: RetrieveBusinessBookingProfile
      description: Retrieves a seller's booking profile.
      operationId: RetrieveBusinessBookingProfile
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveBusinessBookingProfileResponse'
      security:
      - oauth2:
        - APPOINTMENTS_BUSINESS_SETTINGS_READ
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-example-scenarios:
        scenarios:
        - name: Retrieve the business's booking profile
          response:
            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
                cancellation_fee_money:
                  currency: USD
                cancellation_policy: CUSTOM_POLICY
                skip_booking_flow_staff_selection: false
            errors: []
  /v2/bookings/team-member-booking-profiles:
    get:
      tags:
      - Bookings
      summary: ListTeamMemberBookingProfiles
      description: Lists booking profiles for team members.
      operationId: ListTeamMemberBookingProfiles
      parameters:
      - name: bookable_only
        in: query
        description: Indicates whether to include only bookable team members in the
          returned result (`true`) or not (`false`).
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: limit
        in: query
        description: The maximum number of results to return in a paged response.
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: cursor
        in: query
        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.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: location_id
        in: query
        description: Indicates whether to include only team members enabled at the
          given location in the returned result.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTeamMemberBookingProfilesResponse'
      security:
      - oauth2:
        - APPOINTMENTS_BUSINESS_SETTINGS_READ
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-example-scenarios:
        scenarios:
        - name: List team member booking profiles
          response:
            team_member_booking_profiles:
            - team_member_id: TMXUrsBWWcHTt79t
              display_name: Sandbox Seller
              is_bookable: true
            - team_member_id: TMaJcbiRqPIGZuS9
              display_name: Sandbox Staff
              is_bookable: true
            errors: []
  /v2/bookings/team-member-booking-profiles/{team_member_id}:
    get:
      tags:
      - Bookings
      summary: RetrieveTeamMemberBookingProfile
      description: Retrieves a team member's booking profile.
      operationId: RetrieveTeamMemberBookingProfile
      parameters:
      - name: team_member_id
        in: path
        description: The ID of the team member to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveTeamMemberBookingProfileResponse'
      security:
      - oauth2:
        - APPOINTMENTS_BUSINESS_SETTINGS_READ
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-example-scenarios:
        scenarios:
        - name: Retrieve a booking
          pathParameters:
            team_member_id: TMaJcbiRqPIGZuS9
          response:
            team_member_booking_profile:
              team_member_id: TMaJcbiRqPIGZuS9
              display_name: Sandbox Staff
              is_bookable: true
            errors: []
  /v2/bookings/{booking_id}:
    get:
      tags:
      - Bookings
      summary: RetrieveBooking
      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.
      operationId: RetrieveBooking
      parameters:
      - name: booking_id
        in: path
        description: The ID of the [Booking](entity:Booking) object representing the
          to-be-retrieved booking.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveBookingResponse'
      security:
      - oauth2:
        - APPOINTMENTS_READ
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-example-scenarios:
        scenarios:
        - name: Retrieve a booking
          pathParameters:
            booking_id: zkras0xv0xwswx
          response:
            booking:
              id: zkras0xv0xwswx
              version: 1
              status: ACCEPTED
              created_at: 2020-10-28T15:47:41Z
              updated_at: 2020-10-28T15:49:25Z
              location_id: LEQHH0YY8B42M
              customer_id: EX2QSVGTZN4K1E5QE1CBFNVQ8M
              customer_note: ""
              seller_note: ""
              start_at: 2020-11-26T13:00:00Z
              appointment_segments:
              - duration_minutes: 60
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                team_member_id: TMXUrsBWWcHTt79t
                service_variation_version: 1599775456731
            errors: []
    put:
      tags:
      - Bookings
      summary: UpdateBooking
      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*.
      operationId: UpdateBooking
      parameters:
      - name: booking_id
        in: path
        description: The ID of the [Booking](entity:Booking) object representing the
          to-be-updated booking.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBookingRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateBookingResponse'
      security:
      - oauth2:
        - APPOINTMENTS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-example-scenarios:
        scenarios:
        - name: Update a booking
          pathParameters:
            booking_id: zkras0xv0xwswx
          bodyParams:
            booking:
              version: 1
              customer_note: I would like to sit near the window please
          response:
            booking:
              id: zkras0xv0xwswx
              version: 2
              status: ACCEPTED
              created_at: 2020-10-28T15:47:41Z
              updated_at: 2020-10-28T15:49:25Z
              location_id: LEQHH0YY8B42M
              customer_id: EX2QSVGTZN4K1E5QE1CBFNVQ8M
              customer_note: I would like to sit near the window please
              seller_note: ""
              start_at: 2020-11-26T13:00:00Z
              appointment_segments:
              - duration_minutes: 60
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                team_member_id: TMXUrsBWWcHTt79t
                service_variation_version: 1599775456731
            errors: []
  /v2/bookings/{booking_id}/cancel:
    post:
      tags:
      - Bookings
      summary: CancelBooking
      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*.
      operationId: CancelBooking
      parameters:
      - name: booking_id
        in: path
        description: The ID of the [Booking](entity:Booking) object representing the
          to-be-cancelled booking.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelBookingRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelBookingResponse'
      security:
      - oauth2:
        - APPOINTMENTS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-example-scenarios:
        scenarios:
        - name: Cancel a booking
          pathParameters:
            booking_id: zkras0xv0xwswx
          bodyParams:
            booking_version: 1
          response:
            booking:
              id: zkras0xv0xwswx
              version: 2
              status: CANCELLED_BY_CUSTOMER
              created_at: 2020-10-28T15:47:41Z
              updated_at: 2020-10-28T15:49:25Z
              location_id: LEQHH0YY8B42M
              customer_id: EX2QSVGTZN4K1E5QE1CBFNVQ8M
              customer_note: ""
              seller_note: ""
              start_at: 2020-11-26T13:00:00Z
              appointment_segments:
              - duration_minutes: 60
                service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
                team_member_id: TMXUrsBWWcHTt79t
                service_variation_version: 1599775456731
            errors: []
  /v2/cards:
    get:
      tags:
      - Cards
      summary: ListCards
      description: |-
        Retrieves a list of cards owned by the account making the request.
        A max of 25 cards will be returned.
      operationId: ListCards
      parameters:
      - name: cursor
        in: query
        description: |-
          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/basics/api101/pagination) for more information.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: customer_id
        in: query
        description: |-
          Limit results to cards associated with the customer supplied.
          By default, all cards owned by the merchant are returned.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: include_disabled
        in: query
        description: |-
          Includes disabled cards.
          By default, all enabled cards owned by the merchant are returned.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: reference_id
        in: query
        description: Limit results to cards associated with the reference_id supplied.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: sort_order
        in: query
        description: |-
          Sorts the returned list by when the card was created with the specified order.
          This field defaults to ASC.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/SortOrder'
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCardsResponse'
      security:
      - oauth2:
        - PAYMENTS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /cards-api/protos/squareup/cards/api/cards_store_service.proto
      x-proto-sha: 45981bf2b47428d1befee008c73b5fe7a15439b2
    post:
      tags:
      - Cards
      summary: CreateCard
      description: Adds a card on file to an existing merchant.
      operationId: CreateCard
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCardRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCardResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /cards-api/protos/squareup/cards/api/cards_store_service.proto
      x-proto-sha: 45981bf2b47428d1befee008c73b5fe7a15439b2
      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
      description: Retrieves details for a specific Card.
      operationId: RetrieveCard
      parameters:
      - name: card_id
        in: path
        description: Unique ID for the desired Card.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveCardResponse'
      security:
      - oauth2:
        - PAYMENTS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /cards-api/protos/squareup/cards/api/cards_store_service.proto
      x-proto-sha: 45981bf2b47428d1befee008c73b5fe7a15439b2
      x-endpoint-errors:
      - error-code: NOT_FOUND
  /v2/cards/{card_id}/disable:
    post:
      tags:
      - Cards
      summary: DisableCard
      description: |-
        Disables the card, preventing any further updates or charges.
        Disabling an already disabled card is allowed but has no effect.
      operationId: DisableCard
      parameters:
      - name: card_id
        in: path
        description: Unique ID for the desired Card.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisableCardRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisableCardResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /cards-api/protos/squareup/cards/api/cards_store_service.proto
      x-proto-sha: 45981bf2b47428d1befee008c73b5fe7a15439b2
      x-endpoint-errors:
      - error-code: NOT_FOUND
  /v2/cash-drawers/shifts:
    get:
      tags:
      - CashDrawers
      summary: ListCashDrawerShifts
      description: |-
        Provides the details for all of the cash drawer shifts for a location
        in a date range.
      externalDocs:
        description: List Cash Drawer Shifts
        url: https://developer.squareup.com/docs/cashdrawershift-api/reporting#list-cash-drawer-shifts
      operationId: ListCashDrawerShifts
      parameters:
      - name: location_id
        in: query
        description: The ID of the location to query for a list of cash drawer shifts.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: sort_order
        in: query
        description: |-
          The order in which cash drawer shifts are listed in the response,
          based on their opened_at field. Default value: ASC
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/SortOrder'
      - name: begin_time
        in: query
        description: The inclusive start time of the query on opened_at, in ISO 8601
          format.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: end_time
        in: query
        description: The exclusive end date of the query on opened_at, in ISO 8601
          format.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: |-
          Number of cash drawer shift events in a page of results (200 by
          default, 1000 max).
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: cursor
        in: query
        description: Opaque cursor for fetching the next page of results.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCashDrawerShiftsResponse'
      security:
      - oauth2:
        - CASH_DRAWER_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /cashdrawers/cashdrawers-proto/src/main/proto/squareup/cashdrawers/api/v2/connect/service.proto
      x-proto-sha: 06291dbd5e7115613debe29fc712a6c8b9bd195e
  /v2/cash-drawers/shifts/{shift_id}:
    get:
      tags:
      - CashDrawers
      summary: RetrieveCashDrawerShift
      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.
      externalDocs:
        description: Retrieve a Cash Drawer Shift
        url: https://developer.squareup.com/docs/cashdrawershift-api/reporting#retrieve-a-cash-drawer-shift
      operationId: RetrieveCashDrawerShift
      parameters:
      - name: location_id
        in: query
        description: The ID of the location to retrieve cash drawer shifts from.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: shift_id
        in: path
        description: The shift ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveCashDrawerShiftResponse'
      security:
      - oauth2:
        - CASH_DRAWER_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /cashdrawers/cashdrawers-proto/src/main/proto/squareup/cashdrawers/api/v2/connect/service.proto
      x-proto-sha: 06291dbd5e7115613debe29fc712a6c8b9bd195e
  /v2/cash-drawers/shifts/{shift_id}/events:
    get:
      tags:
      - CashDrawers
      summary: ListCashDrawerShiftEvents
      description: Provides a paginated list of events for a single cash drawer shift.
      externalDocs:
        description: List Cash Drawer Shift Events
        url: https://developer.squareup.com/docs/cashdrawershift-api/reporting#list-cash-drawer-shift-events
      operationId: ListCashDrawerShiftEvents
      parameters:
      - name: location_id
        in: query
        description: The ID of the location to list cash drawer shifts for.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: shift_id
        in: path
        description: The shift ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: limit
        in: query
        description: |-
          Number of resources to be returned in a page of results (200 by
          default, 1000 max).
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: cursor
        in: query
        description: Opaque cursor for fetching the next page of results.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCashDrawerShiftEventsResponse'
      security:
      - oauth2:
        - CASH_DRAWER_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /cashdrawers/cashdrawers-proto/src/main/proto/squareup/cashdrawers/api/v2/connect/service.proto
      x-proto-sha: 06291dbd5e7115613debe29fc712a6c8b9bd195e
  /v2/catalog/batch-delete:
    post:
      tags:
      - Catalog
      summary: BatchDeleteCatalogObjects
      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.
      operationId: BatchDeleteCatalogObjects
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchDeleteCatalogObjectsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchDeleteCatalogObjectsResponse'
      security:
      - oauth2:
        - ITEMS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/service.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-example-scenarios:
        scenarios:
        - name: Delete multiple catalog objects
          bodyParameters:
            object_ids:
            - W62UWFY35CWMYGVWK6TWJDNI
            - AA27W3M2GGTF3H6AVPNB77CK
          response:
            deleted_object_ids:
            - W62UWFY35CWMYGVWK6TWJDNI
            - AA27W3M2GGTF3H6AVPNB77CK
            deleted_at: 2016-11-16T22:25:24.878Z
  /v2/catalog/batch-retrieve:
    post:
      tags:
      - Catalog
      summary: BatchRetrieveCatalogObjects
      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.
      operationId: BatchRetrieveCatalogObjects
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchRetrieveCatalogObjectsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchRetrieveCatalogObjectsResponse'
      security:
      - oauth2:
        - ITEMS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/service.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-example-scenarios:
        scenarios:
        - name: Retrieve multiple catalog objects
          request_body:
            object_ids:
            - W62UWFY35CWMYGVWK6TWJDNI
            - AA27W3M2GGTF3H6AVPNB77CK
            include_related_objects: true
          response:
            objects:
            - type: ITEM
              id: W62UWFY35CWMYGVWK6TWJDNI
              updated_at: 2016-11-16T22:25:24.878Z
              version: 1479335124878
              is_deleted: false
              present_at_all_locations: true
              item_data:
                name: Tea
                description: Hot Leaf Juice
                category_id: BJNQCF2FJ6S6UIDT65ABHLRX
                tax_ids:
                - HURXQOOAIC4IZSI2BEXQRYFY
                variations:
                - type: ITEM_VARIATION
                  id: 2TZFAOHWGG7PAK2QEXWYPZSP
                  updated_at: 2016-11-16T22:25:24.878Z
                  version: 1479335124878
                  is_deleted: false
                  present_at_all_locations: true
                  item_variation_data:
                    item_id: W62UWFY35CWMYGVWK6TWJDNI
                    name: Mug
                    ordinal: 0
                    pricing_type: FIXED_PRICING
                    price_money:
                      amount: 150
                      currency: USD
            - type: ITEM
              id: AA27W3M2GGTF3H6AVPNB77CK
              updated_at: 2016-11-16T22:25:24.878Z
              version: 1479335124878
              is_deleted: false
              present_at_all_locations: true
              item_data:
                name: Coffee
                description: Hot Bean Juice
                category_id: BJNQCF2FJ6S6UIDT65ABHLRX
                tax_ids:
                - HURXQOOAIC4IZSI2BEXQRYFY
                variations:
                - type: ITEM_VARIATION
                  id: LBTYIHNHU52WOIHWT7SNRIYH
                  updated_at: 2016-11-16T22:25:24.878Z
                  version: 1479335124878
                  is_deleted: false
                  present_at_all_locations: true
                  item_variation_data:
                    item_id: AA27W3M2GGTF3H6AVPNB77CK
                    name: Regular
                    ordinal: 0
                    pricing_type: FIXED_PRICING
                    price_money:
                      amount: 250
                      currency: USD
                - type: ITEM_VARIATION
                  id: PKYIC7HGGKW5CYVSCVDEIMHY
                  updated_at: 2016-11-16T22:25:24.878Z
                  version: 1479335124878
                  is_deleted: false
                  present_at_all_locations: true
                  item_variation_data:
                    item_id: AA27W3M2GGTF3H6AVPNB77CK
                    name: Large
                    ordinal: 1
                    pricing_type: FIXED_PRICING
                    price_money:
                      amount: 350
                      currency: USD
            related_objects:
            - type: CATEGORY
              id: BJNQCF2FJ6S6UIDT65ABHLRX
              updated_at: 2016-11-16T22:25:24.878Z
              version: 1479335124878
              is_deleted: false
              present_at_all_locations: true
              category_data:
                name: Beverages
            - type: TAX
              id: HURXQOOAIC4IZSI2BEXQRYFY
              updated_at: 2016-11-16T22:25:24.878Z
              version: 1479335124878
              is_deleted: false
              present_at_all_locations: true
              tax_data:
                name: Sales Tax
                calculation_phase: TAX_SUBTOTAL_PHASE
                inclusion_type: ADDITIVE
                percentage: "5.0"
                enabled: true
  /v2/catalog/batch-upsert:
    post:
      tags:
      - Catalog
      summary: BatchUpsertCatalogObjects
      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.
      operationId: BatchUpsertCatalogObjects
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchUpsertCatalogObjectsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchUpsertCatalogObjectsResponse'
      security:
      - oauth2:
        - ITEMS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/service.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-endpoint-errors:
      - error-code: GENERIC_DECLINE
      x-example-scenarios:
        scenarios:
        - name: Add a batch of objects to the catalog
          bodyParams:
            idempotency_key: 789ff020-f723-43a9-b4b5-43b5dc1fa3dc
            batches:
            - objects:
              - type: ITEM
                id: '#Tea'
                present_at_all_locations: true
                item_data:
                  name: Tea
                  description: Hot Leaf Juice
                  category_id: '#Beverages'
                  tax_ids:
                  - '#SalesTax'
                  variations:
                  - type: ITEM_VARIATION
                    id: '#Tea_Mug'
                    present_at_all_locations: true
                    item_variation_data:
                      item_id: '#Tea'
                      name: Mug
                      pricing_type: FIXED_PRICING
                      price_money:
                        amount: 150
                        currency: USD
              - type: ITEM
                id: '#Coffee'
                present_at_all_locations: true
                item_data:
                  name: Coffee
                  description: Hot Bean Juice
                  category_id: '#Beverages'
                  tax_ids:
                  - '#SalesTax'
                  variations:
                  - type: ITEM_VARIATION
                    id: '#Coffee_Regular'
                    present_at_all_locations: true
                    item_variation_data:
                      item_id: '#Coffee'
                      name: Regular
                      pricing_type: FIXED_PRICING
                      price_money:
                        amount: 250
                        currency: USD
                  - type: ITEM_VARIATION
                    id: '#Coffee_Large'
                    present_at_all_locations: true
                    item_variation_data:
                      item_id: '#Coffee'
                      name: Large
                      pricing_type: FIXED_PRICING
                      price_money:
                        amount: 350
                        currency: USD
              - type: CATEGORY
                id: '#Beverages'
                present_at_all_locations: true
                category_data:
                  name: Beverages
              - 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:
            objects:
            - type: ITEM
              id: ZSDZN34NAXDLC6D5ZQMNSOUM
              updated_at: 2017-05-10T18:48:39.798Z
              version: 1494442119798
              is_deleted: false
              present_at_all_locations: true
              item_data:
                name: Tea
                description: Hot Leaf Juice
                category_id: LYT72K3WGJFFCIMB63XARP3I
                tax_ids:
                - XHSHLHNWSI3HVI4BW5ZUZXI3
                variations:
                - type: ITEM_VARIATION
                  id: NAYHET5R52MIYCEF34ZMAHFM
                  updated_at: 2017-05-10T18:48:39.798Z
                  version: 1494442119798
                  is_deleted: false
                  present_at_all_locations: true
                  item_variation_data:
                    item_id: ZSDZN34NAXDLC6D5ZQMNSOUM
                    name: Mug
                    ordinal: 0
                    pricing_type: FIXED_PRICING
                    price_money:
                      amount: 150
                      currency: USD
            - type: ITEM
              id: PJMCEBHHUS3OKDB6PYUHLCPP
              updated_at: 2017-05-10T18:48:39.798Z
              version: 1494442119798
              is_deleted: false
              present_at_all_locations: true
              item_data:
                name: Coffee
                description: Hot Bean Juice
                category_id: LYT72K3WGJFFCIMB63XARP3I
                tax_ids:
                - XHSHLHNWSI3HVI4BW5ZUZXI3
                variations:
                - type: ITEM_VARIATION
                  id: OTYDX45SPG7LJQUVCBZI4INH
                  updated_at: 2017-05-10T18:48:39.798Z
                  version: 1494442119798
                  is_deleted: false
                  present_at_all_locations: true
                  item_variation_data:
                    item_id: PJMCEBHHUS3OKDB6PYUHLCPP
                    name: Regular
                    ordinal: 0
                    pricing_type: FIXED_PRICING
                    price_money:
                      amount: 250
                      currency: USD
                - type: ITEM_VARIATION
                  id: GZDA3JB37FYVOPI4AOEBOITI
                  updated_at: 2017-05-10T18:48:39.798Z
                  version: 1494442119798
                  is_deleted: false
                  present_at_all_locations: true
                  item_variation_data:
                    item_id: PJMCEBHHUS3OKDB6PYUHLCPP
                    name: Large
                    ordinal: 1
                    pricing_type: FIXED_PRICING
                    price_money:
                      amount: 350
                      currency: USD
            - type: CATEGORY
              id: LYT72K3WGJFFCIMB63XARP3I
              updated_at: 2017-05-10T18:48:39.798Z
              version: 1494442119798
              is_deleted: false
              present_at_all_locations: true
              category_data:
                name: Beverages
            - type: TAX
              id: XHSHLHNWSI3HVI4BW5ZUZXI3
              updated_at: 2017-05-10T18:48:39.798Z
              version: 1494442119798
              is_deleted: false
              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
            id_mappings:
            - client_object_id: '#Tea'
              object_id: ZSDZN34NAXDLC6D5ZQMNSOUM
            - client_object_id: '#Coffee'
              object_id: PJMCEBHHUS3OKDB6PYUHLCPP
            - client_object_id: '#Beverages'
              object_id: LYT72K3WGJFFCIMB63XARP3I
            - client_object_id: '#SalesTax'
              object_id: XHSHLHNWSI3HVI4BW5ZUZXI3
            - client_object_id: '#Tea_Mug'
              object_id: NAYHET5R52MIYCEF34ZMAHFM
            - client_object_id: '#Coffee_Regular'
              object_id: OTYDX45SPG7LJQUVCBZI4INH
            - client_object_id: '#Coffee_Large'
              object_id: GZDA3JB37FYVOPI4AOEBOITI
  /v2/catalog/images:
    post:
      tags:
      - Catalog
      summary: CreateCatalogImage
      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.
      externalDocs:
        description: Upload and Attach an Image
        url: https://developer.squareup.com/docs/catalog-api/cookbook/create-catalog-image
      operationId: CreateCatalogImage
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/body'
            encoding:
              request:
                contentType: application/json; charset=utf-8
                style: form
              image_file:
                contentType: image/jpeg
                style: form
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCatalogImageResponse'
      security:
      - oauth2:
        - ITEMS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/service.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-endpoint-errors:
      - error-code: GENERIC_DECLINE
      x-example-scenarios:
        scenarios:
        - name: Upload an image for a catalog object
          bodyParams:
            idempotency_key: 528dea59-7bfb-43c1-bd48-4a6bba7dd61f86
            object_id: ND6EA5AAJEO5WL3JNNIAQA32
            image:
              id: '#TEMP_ID'
              type: IMAGE
              image_data:
                caption: A picture of a cup of coffee
          response:
            image:
              type: IMAGE
              id: XVGTTXX6VIFDJVH6YGDJCEK4
              updated_at: 2020-08-12T01:49:50.295Z
              version: 1597196990295
              is_deleted: false
              present_at_all_locations: true
              image_data:
                name: ""
                url: https://square-catalog-sandbox.s3.amazonaws.com/files/febae45897bdab1234dc3db23a7c0e66ddea6001/original.png
                caption: A picture of a cup of coffee
  /v2/catalog/images/{image_id}:
    put:
      tags:
      - Catalog
      summary: 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."
      operationId: UpdateCatalogImage
      parameters:
      - name: image_id
        in: path
        description: The ID of the `CatalogImage` object to update the encapsulated
          image file.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/body_1'
            encoding:
              request:
                contentType: application/json; charset=utf-8
                style: form
              image_file:
                contentType: image/jpeg
                style: form
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCatalogImageResponse'
      security:
      - oauth2:
        - ITEMS_WRITE
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/service.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
  /v2/catalog/info:
    get:
      tags:
      - Catalog
      summary: CatalogInfo
      description: |-
        Retrieves information about the Square Catalog API, such as batch size
        limits that can be used by the `BatchUpsertCatalogObjects` endpoint.
      operationId: CatalogInfo
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogInfoResponse'
      security:
      - oauth2:
        - ITEMS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/service.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-example-scenarios:
        scenarios:
        - name: Get catalog API information
          response:
            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
  /v2/catalog/list:
    get:
      tags:
      - Catalog
      summary: 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)\n\
        and set the `include_deleted_objects` attribute value to `true`."
      operationId: ListCatalog
      parameters:
      - name: cursor
        in: query
        description: |-
          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/basics/api101/pagination) for more information.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: types
        in: query
        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\n\
          of 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,\n\
          SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS."
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: catalog_version
        in: query
        description: "The specific version of the catalog objects to be included in\
          \ the response. \nThis allows you to retrieve historical\nversions 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."
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
        x-release-status: BETA
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCatalogResponse'
      security:
      - oauth2:
        - ITEMS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/service.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-example-scenarios:
        scenarios:
        - name: List catalog objects of a certain type
          requestParams:
            types: category,tax
          response:
            objects:
            - type: CATEGORY
              id: 5ZYQZZ2IECPVJ2IJ5KQPRDC3
              updated_at: 2017-02-21T14:50:26.495Z
              version: 1487688626495
              is_deleted: false
              present_at_all_locations: true
              category_data:
                name: Beverages
            - type: TAX
              id: L5R47DGBZOOVKCAFIXC56AEN
              updated_at: 2017-02-21T14:50:26.495Z
              version: 1487688626495
              is_deleted: false
              present_at_all_locations: true
              tax_data:
                name: Sales Tax
                calculation_phase: TAX_SUBTOTAL_PHASE
                inclusion_type: ADDITIVE
                percentage: "5.0"
                enabled: true
  /v2/catalog/object:
    post:
      tags:
      - Catalog
      summary: UpsertCatalogObject
      description: Creates or updates the target [CatalogObject](entity:CatalogObject).
      externalDocs:
        description: Build a Simple Catalog
        url: https://developer.squareup.com/docs/catalog-api/build-with-catalog
      operationId: UpsertCatalogObject
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertCatalogObjectRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpsertCatalogObjectResponse'
      security:
      - oauth2:
        - ITEMS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/service.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-endpoint-errors:
      - error-code: GENERIC_DECLINE
      x-example-scenarios:
        scenarios:
        - name: Add an item
          bodyParameters:
            idempotency_key: af3d1afc-7212-4300-b463-0bfc5314a5ae
            object:
              id: '#Cocoa'
              type: ITEM
              item_data:
                abbreviation: Ch
                description: Hot Chocolate
                name: Cocoa
                variations:
                - id: '#Small'
                  type: ITEM_VARIATION
                  item_variation_data:
                    item_id: '#Cocoa'
                    name: Small
                    pricing_type: VARIABLE_PRICING
                - id: '#Large'
                  type: ITEM_VARIATION
                  item_variation_data:
                    item_id: '#Cocoa'
                    name: Large
                    pricing_type: FIXED_PRICING
                    price_money:
                      amount: 400
                      currency: USD
          response:
            catalog_object:
              type: ITEM
              id: R2TA2FOBUGCJZNIWJSOSNAI4
              updated_at: 2021-06-14T15:51:39.021Z
              version: 1623685899021
              is_deleted: false
              present_at_all_locations: true
              item_data:
                name: Cocoa
                description: Hot Chocolate
                abbreviation: Ch
                variations:
                - type: ITEM_VARIATION
                  id: QRT53UP4LITLWGOGBZCUWP63
                  updated_at: 2021-06-14T15:51:39.021Z
                  version: 1623685899021
                  is_deleted: false
                  present_at_all_locations: true
                  item_variation_data:
                    item_id: R2TA2FOBUGCJZNIWJSOSNAI4
                    name: Small
                    ordinal: 0
                    pricing_type: VARIABLE_PRICING
                    stockable: true
                - type: ITEM_VARIATION
                  id: NS77DKEIQ3AEQTCP727DSA7U
                  updated_at: 2021-06-14T15:51:39.021Z
                  version: 1623685899021
                  is_deleted: false
                  present_at_all_locations: true
                  item_variation_data:
                    item_id: R2TA2FOBUGCJZNIWJSOSNAI4
                    name: Large
                    ordinal: 1
                    pricing_type: FIXED_PRICING
                    price_money:
                      amount: 400
                      currency: USD
                    stockable: true
                product_type: REGULAR
            id_mappings:
            - client_object_id: '#Cocoa'
              object_id: R2TA2FOBUGCJZNIWJSOSNAI4
            - client_object_id: '#Small'
              object_id: QRT53UP4LITLWGOGBZCUWP63
            - client_object_id: '#Large'
              object_id: NS77DKEIQ3AEQTCP727DSA7U
        - name: Add a category
          bodyParameters:
            idempotency_key: 4ef9a31f-b405-4df8-9c67-e6f964778fe8
            object:
              id: '#Beverages'
              type: CATEGORY
              category_data:
                name: Beverages
          response:
            catalog_object:
              type: CATEGORY
              id: FBBT5XUEA77WPZZQR7PVNJXW
              updated_at: 2020-08-11T22:52:08.059Z
              version: 1597186328059
              is_deleted: false
              present_at_all_locations: true
              category_data:
                name: Beverages
            id_mappings:
            - client_object_id: '#Beverages'
              object_id: FBBT5XUEA77WPZZQR7PVNJXW
  /v2/catalog/object/{object_id}:
    get:
      tags:
      - Catalog
      summary: RetrieveCatalogObject
      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.
      operationId: RetrieveCatalogObject
      parameters:
      - name: object_id
        in: path
        description: The object ID of any type of catalog objects to be retrieved.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: include_related_objects
        in: query
        description: |-
          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`
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: catalog_version
        in: query
        description: |-
          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.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
        x-release-status: BETA
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveCatalogObjectResponse'
      security:
      - oauth2:
        - ITEMS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/service.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-example-scenarios:
        scenarios:
        - name: Retrieve catalog object
          pathParameters:
            object_id: W62UWFY35CWMYGVWK6TWJDNI
          response:
            object:
              type: ITEM
              id: W62UWFY35CWMYGVWK6TWJDNI
              updated_at: 2016-11-16T22:25:24.878Z
              version: 1479335124878
              is_deleted: false
              present_at_all_locations: true
              item_data:
                name: Tea
                description: Hot Leaf Juice
                category_id: BJNQCF2FJ6S6UIDT65ABHLRX
                tax_ids:
                - HURXQOOAIC4IZSI2BEXQRYFY
                variations:
                - type: ITEM_VARIATION
                  id: 2TZFAOHWGG7PAK2QEXWYPZSP
                  updated_at: 2016-11-16T22:25:24.878Z
                  version: 1479335124878
                  is_deleted: false
                  present_at_all_locations: true
                  item_variation_data:
                    item_id: W62UWFY35CWMYGVWK6TWJDNI
                    name: Mug
                    ordinal: 0
                    pricing_type: FIXED_PRICING
                    price_money:
                      amount: 150
                      currency: USD
        - name: Retrieve catalog object and include related objects
          pathParameters:
            object_id: W62UWFY35CWMYGVWK6TWJDNI
          queryParameters:
            include_related_objects: true
          response:
            object:
              type: ITEM
              id: W62UWFY35CWMYGVWK6TWJDNI
              updated_at: 2016-11-16T22:25:24.878Z
              version: 1479335124878
              is_deleted: false
              present_at_all_locations: true
              item_data:
                name: Tea
                description: Hot Leaf Juice
                category_id: BJNQCF2FJ6S6UIDT65ABHLRX
                tax_ids:
                - HURXQOOAIC4IZSI2BEXQRYFY
                variations:
                - type: ITEM_VARIATION
                  id: 2TZFAOHWGG7PAK2QEXWYPZSP
                  updated_at: 2016-11-16T22:25:24.878Z
                  version: 1479335124878
                  is_deleted: false
                  present_at_all_locations: true
                  item_variation_data:
                    item_id: W62UWFY35CWMYGVWK6TWJDNI
                    name: Mug
                    ordinal: 0
                    pricing_type: FIXED_PRICING
                    price_money:
                      amount: 150
                      currency: USD
            related_objects:
            - type: CATEGORY
              id: BJNQCF2FJ6S6UIDT65ABHLRX
              updated_at: 2016-11-16T22:25:24.878Z
              version: 1479335124878
              is_deleted: false
              present_at_all_locations: true
              category_data:
                name: Beverages
            - type: TAX
              id: HURXQOOAIC4IZSI2BEXQRYFY
              updated_at: 2016-11-16T22:25:24.878Z
              version: 1479335124878
              is_deleted: false
              present_at_all_locations: true
              tax_data:
                name: Sales Tax
                calculation_phase: TAX_SUBTOTAL_PHASE
                inclusion_type: ADDITIVE
                percentage: "5.0"
                enabled: true
    delete:
      tags:
      - Catalog
      summary: DeleteCatalogObject
      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.
      operationId: DeleteCatalogObject
      parameters:
      - name: object_id
        in: path
        description: |-
          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).
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCatalogObjectResponse'
      security:
      - oauth2:
        - ITEMS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/service.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-example-scenarios:
        scenarios:
        - name: Delete a catalog object
          pathParameters:
            object_id: 7SB3ZQYJ5GDMVFL7JK46JCHT
          response:
            deleted_object_ids:
            - 7SB3ZQYJ5GDMVFL7JK46JCHT
            - KQLFFHA6K6J3YQAQAWDQAL57
            deleted_at: 2016-11-16T22:25:24.878Z
  /v2/catalog/search:
    post:
      tags:
      - Catalog
      summary: SearchCatalogObjects
      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.
      externalDocs:
        description: Call SearchCatalogObjects
        url: https://developer.squareup.com/docs/catalog-api/search-catalog-objects
      operationId: SearchCatalogObjects
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchCatalogObjectsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchCatalogObjectsResponse'
      security:
      - oauth2:
        - ITEMS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/service.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-example-scenarios:
        scenarios:
        - name: Search for catalog objects by name
          bodyParameters:
            object_types:
            - ITEM
            query:
              prefix_query:
                attribute_name: name
                attribute_prefix: tea
            limit: 100
          response:
            objects:
            - type: ITEM
              id: X5DZ5NWWAQ44CKBLKIFQGOWK
              updated_at: 2017-10-26T15:41:32.337Z
              version: 1509032492337
              is_deleted: false
              present_at_all_locations: true
              item_data:
                name: Tea - Black
                description: A delicious blend of black tea.
                category_id: E7CLE5RZZ744BHWVQQEAHI2C
                product_type: REGULAR
                tax_ids:
                - ZXITPM6RWHZ7GZ7EIP3YKECM
                variations:
                - type: ITEM_VARIATION
                  id: 5GSZPX6EU7MM75S57OONG3V5
                  updated_at: 2017-10-26T15:27:31.626Z
                  version: 1509031651626
                  is_deleted: false
                  present_at_all_locations: true
                  item_variation_data:
                    item_id: X5DZ5NWWAQ44CKBLKIFQGOWK
                    name: Regular
                    ordinal: 1
                    price_money:
                      amount: 150
                      currency: USD
                    pricing_type: FIXED_PRICING
                - type: ITEM_VARIATION
                  id: XVLBN7DU6JTWHJTG5F265B43
                  updated_at: 2017-10-26T15:27:31.626Z
                  version: 1509031651626
                  is_deleted: false
                  present_at_all_locations: true
                  item_variation_data:
                    item_id: X5DZ5NWWAQ44CKBLKIFQGOWK
                    name: Large
                    ordinal: 2
                    price_money:
                      amount: 225
                      currency: USD
                    pricing_type: FIXED_PRICING
                visibility: PRIVATE
            - type: ITEM
              id: NNNEM3LA656Q46NXLWCNI7S5
              updated_at: 2017-10-26T15:41:23.232Z
              version: 1509032483232
              is_deleted: false
              present_at_all_locations: true
              item_data:
                name: Tea - Green
                description: Relaxing green herbal tea.
                category_id: E7CLE5RZZ744BHWVQQEAHI2C
                product_type: REGULAR
                tax_ids:
                - ZXITPM6RWHZ7GZ7EIP3YKECM
                variations:
                - type: ITEM_VARIATION
                  id: FHYBVIA6NVBCSOVETA62WEA4
                  updated_at: 2017-10-26T15:29:00.524Z
                  version: 1509031740524
                  is_deleted: false
                  present_at_all_locations: true
                  item_variation_data:
                    item_id: NNNEM3LA656Q46NXLWCNI7S5
                    name: Regular
                    ordinal: 1
                    price_money:
                      amount: 150
                      currency: USD
                    pricing_type: FIXED_PRICING
                visibility: PRIVATE
  /v2/catalog/search-catalog-items:
    post:
      tags:
      - Catalog
      summary: SearchCatalogItems
      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.
      externalDocs:
        description: Call SearchCatalogItems
        url: https://developer.squareup.com/docs/catalog-api/search-catalog-items
      operationId: SearchCatalogItems
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchCatalogItemsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchCatalogItemsResponse'
      security:
      - oauth2:
        - ITEMS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/service.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-example-scenarios:
        scenarios:
        - name: Search for a catalog item using filters
          bodyParams:
            sort_order: ASC
            product_types:
            - REGULAR
            category_ids:
            - WINE_CATEGORY_ID
            enabled_location_ids:
            - ATL_LOCATION_ID
            text_filter: red
            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: 2017
                max: 2018
            - custom_attribute_definition_id: VARIETAL_DEFINITION_ID
              selection_ids_filter: MERLOT_SELECTION_ID
            stock_levels:
            - OUT
            - LOW
            limit: 100
          response:
            items:
            - type: ITEM
              id: GPOKJPTV2KDLVKCADJ7I77EZ
              updated_at: 2020-06-18T17:55:56.646Z
              version: 1592502956646
              is_deleted: false
              present_at_all_locations: true
              custom_attribute_values:
                VINTAGE:
                  name: Vintage
                  custom_attribute_definition_id: EI7IJQDUKYSHULREPIPH6HNU
                  type: NUMBER
                  number_value: 2018
                  key: VINTAGE
                VARIETAL:
                  name: Varietal
                  custom_attribute_definition_id: VARIETAL_DEFINITION_ID
                  type: SELECTION
                  selection_uid_values:
                  - MERLOT_SELECTION_ID
                  key: VARIETAL
                BRAND:
                  name: Brand
                  custom_attribute_definition_id: BRAND_DEFINITION_ID
                  type: STRING
                  string_value: Dark Horse
                  key: BRAND
              item_data:
                name: Dark Horse Merlot 2018
                product_type: REGULAR
                description: A nice red wine
                variations:
                - type: ITEM_VARIATION
                  id: VBJNPHCOKDFECR6VU25WRJUD
                  updated_at: 2020-06-18T17:55:56.646Z
                  version: 1592502956646
                  is_deleted: false
                  present_at_all_locations: true
                  item_variation_data:
                    item_id: GPOKJPTV2KDLVKCADJ7I77EZ
                    name: 750 mL
                    ordinal: 0
                    pricing_type: FIXED_PRICING
                    price_money:
                      amount: 1000
                      currency: USD
            matched_variation_ids:
            - VBJNPHCOKDFECR6VU25WRJUD
  /v2/catalog/update-item-modifier-lists:
    post:
      tags:
      - Catalog
      summary: UpdateItemModifierLists
      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.
      operationId: UpdateItemModifierLists
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateItemModifierListsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateItemModifierListsResponse'
      security:
      - oauth2:
        - ITEMS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/service.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-example-scenarios:
        scenarios:
        - name: Update modifier lists for a list of items
          bodyParameters:
            item_ids:
            - H42BRLUJ5KTZTTMPVSLFAACQ
            - 2JXOBJIHCWBQ4NZ3RIXQGJA6
            modifier_lists_to_enable:
            - H42BRLUJ5KTZTTMPVSLFAACQ
            - 2JXOBJIHCWBQ4NZ3RIXQGJA6
            modifier_lists_to_disable:
            - 7WRC16CJZDVLSNDQ35PP6YAD
          response:
            updated_at: 2016-11-16T22:25:24.878Z
  /v2/catalog/update-item-taxes:
    post:
      tags:
      - Catalog
      summary: UpdateItemTaxes
      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.
      operationId: UpdateItemTaxes
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateItemTaxesRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateItemTaxesResponse'
      security:
      - oauth2:
        - ITEMS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/service.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-example-scenarios:
        scenarios:
        - name: Update taxes for a list of items
          bodyParameters:
            item_ids:
            - H42BRLUJ5KTZTTMPVSLFAACQ
            - 2JXOBJIHCWBQ4NZ3RIXQGJA6
            taxes_to_enable:
            - 4WRCNHCJZDVLSNDQ35PP6YAD
            taxes_to_disable:
            - AQCEGCEBBQONINDOHRGZISEX
          response:
            updated_at: 2016-11-16T22:25:24.878Z
  /v2/customers:
    get:
      tags:
      - Customers
      summary: ListCustomers
      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.
      externalDocs:
        description: Retrieve a list of customer profiles
        url: https://developer.squareup.com/docs/customers-api/use-the-api/retrieve-profiles#retrieve-a-list-of-customer-profiles
      operationId: ListCustomers
      parameters:
      - name: cursor
        in: query
        description: |-
          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).
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: |-
          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).
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: sort_field
        in: query
        description: |-
          Indicates how customers should be sorted.

          The default value is `DEFAULT`.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/CustomerSortField'
      - name: sort_order
        in: query
        description: |-
          Indicates whether customers should be sorted in ascending (`ASC`) or
          descending (`DESC`) order.

          The default value is `ASC`.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/SortOrder'
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomersResponse'
      security:
      - oauth2:
        - CUSTOMERS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
    post:
      tags:
      - Customers
      summary: CreateCustomer
      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`
      externalDocs:
        description: Create a customer profile
        url: https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#create-a-customer-profile
      operationId: CreateCustomer
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomerRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCustomerResponse'
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-endpoint-errors:
      - error-code: INVALID_EMAIL_ADDRESS
      - error-code: INVALID_PHONE_NUMBER
  /v2/customers/custom-attribute-definitions:
    get:
      tags:
      - CustomerCustomAttributes
      summary: ListCustomerCustomAttributeDefinitions
      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`.
      externalDocs:
        description: List customer custom attribute definitions
        url: https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#list-customer-custom-attribute-definitions
      operationId: ListCustomerCustomAttributeDefinitions
      parameters:
      - name: limit
        in: query
        description: |-
          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).
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: cursor
        in: query
        description: |-
          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).
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomerCustomAttributeDefinitionsResponse'
      security:
      - oauth2:
        - CUSTOMERS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
    post:
      tags:
      - CustomerCustomAttributes
      summary: CreateCustomerCustomAttributeDefinition
      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`.
      externalDocs:
        description: Create customer custom attribute definition
        url: https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#create-customer-custom-attribute-definition
      operationId: CreateCustomerCustomAttributeDefinition
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomerCustomAttributeDefinitionRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCustomerCustomAttributeDefinitionResponse'
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-example-scenarios:
        scenarios:
        - name: Create definition for Selection attribute
          bodyParameters:
            custom_attribute_definition:
              description: The favorite beverage of the customer.
              key: favoritebeverage
              name: Favorite Beverage
              schema:
                $schema: https://developer-production-s.squarecdn.com/meta-schemas/v1/selection.json
                type: array
                items:
                  names:
                  - water
                  - lemonade
                  - iced tea
                maxItems: 1
                uniqueItems: true
              visibility: VISIBILITY_HIDDEN
          response:
            custom_attribute_definition:
              key: favoritebeverage
              name: Favorite Beverage
              description: The favorite beverage of the customer.
              version: 1
              updated_at: 2022-04-26T16:00:37Z
              schema:
                $schema: https://developer-production-s.squarecdn.com/meta-schemas/v1/selection.json
                type: array
                items:
                  names:
                  - water
                  - lemonade
                  - iced tea
                  enum:
                  - d012755e-6a3e-4fb8-8c17-d64f8483ecc9
                  - e21131a1-f1bc-467f-af95-4efb532bdd1a
                  - 1c980583-2c0c-483b-af48-d6598a05320f
                maxItems: 1
                uniqueItems: true
              created_at: 2022-04-26T16:00:37Z
              visibility: VISIBILITY_HIDDEN
        - name: Create definition for String attribute
          bodyParameters:
            custom_attribute_definition:
              description: The favorite book of the customer.
              key: favoritebook
              name: Favorite Book
              schema:
                $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String
              visibility: VISIBILITY_HIDDEN
          response:
            custom_attribute_definition:
              key: favoritebook
              name: Favorite Book
              description: The favorite book of the customer.
              version: 1
              updated_at: 2022-04-26T16:04:47Z
              schema:
                $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String
              created_at: 2022-04-26T16:04:47Z
              visibility: VISIBILITY_HIDDEN
  /v2/customers/custom-attribute-definitions/{key}:
    get:
      tags:
      - CustomerCustomAttributes
      summary: RetrieveCustomerCustomAttributeDefinition
      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`.
      externalDocs:
        description: Retrieve customer custom attribute definition
        url: https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#retrieve-customer-custom-attribute-definition
      operationId: RetrieveCustomerCustomAttributeDefinition
      parameters:
      - name: key
        in: path
        description: |-
          The key of the custom attribute definition to retrieve. If the requesting application
          is not the definition owner, you must use the qualified key.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: version
        in: query
        description: |-
          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.
        required: false
        style: form
        explode: true
        schema:
          type: integer
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveCustomerCustomAttributeDefinitionResponse'
      security:
      - oauth2:
        - CUSTOMERS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
    put:
      tags:
      - CustomerCustomAttributes
      summary: UpdateCustomerCustomAttributeDefinition
      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`.
      externalDocs:
        description: Update customer custom attribute definition
        url: https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#update-customer-custom-attribute-definition
      operationId: UpdateCustomerCustomAttributeDefinition
      parameters:
      - name: key
        in: path
        description: The key of the custom attribute definition to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomerCustomAttributeDefinitionRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCustomerCustomAttributeDefinitionResponse'
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-example-scenarios:
        scenarios:
        - name: Delete option from Selection definition
          pathParameters:
            key: favoritebeverage
          bodyParameters:
            custom_attribute_definition:
              schema:
                items:
                  names:
                  - water
                  - lemonade
                  enum:
                  - d012755e-6a3e-4fb8-8c17-d64f8483ecc9
                  - e21131a1-f1bc-467f-af95-4efb532bdd1a
          response:
            custom_attribute_definition:
              key: favoritebeverage
              name: Favorite Beverage
              description: The favorite beverage of the customer.
              version: 2
              updated_at: 2022-04-26T16:08:48Z
              schema:
                $schema: https://developer-production-s.squarecdn.com/meta-schemas/v1/selection.json
                type: array
                items:
                  names:
                  - water
                  - lemonade
                  enum:
                  - d012755e-6a3e-4fb8-8c17-d64f8483ecc9
                  - e21131a1-f1bc-467f-af95-4efb532bdd1a
                maxItems: 1
                uniqueItems: true
              created_at: 2022-04-26T16:00:37Z
              visibility: VISIBILITY_HIDDEN
        - name: Change description for String definition
          pathParameters:
            key: favoritebook
          bodyParameters:
            custom_attribute_definition:
              description: Changing the description.
          response:
            custom_attribute_definition:
              key: favoritebook
              name: Favorite Book
              description: Changing the description.
              version: 2
              updated_at: 2022-04-26T16:10:20Z
              schema:
                $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String
              created_at: 2022-04-26T16:04:47Z
              visibility: VISIBILITY_HIDDEN
      x-is-sparse-update: true
    delete:
      tags:
      - CustomerCustomAttributes
      summary: DeleteCustomerCustomAttributeDefinition
      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.
      externalDocs:
        description: Delete customer custom attribute definition
        url: https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attribute-definitions#delete-customer-custom-attribute-definition
      operationId: DeleteCustomerCustomAttributeDefinition
      parameters:
      - name: key
        in: path
        description: The key of the custom attribute definition to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCustomerCustomAttributeDefinitionResponse'
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
  /v2/customers/custom-attributes/bulk-upsert:
    post:
      tags:
      - CustomerCustomAttributes
      summary: 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.\n\
        A 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 \n\
        of 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`."
      externalDocs:
        description: Bulk upsert customer custom attributes
        url: https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#bulk-upsert-customer-custom-attributes
      operationId: BulkUpsertCustomerCustomAttributes
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpsertCustomerCustomAttributesRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkUpsertCustomerCustomAttributesResponse'
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-is-sparse-update: true
  /v2/customers/groups:
    get:
      tags:
      - CustomerGroups
      summary: ListCustomerGroups
      description: Retrieves the list of customer groups of a business.
      externalDocs:
        description: List customer groups
        url: https://developer.squareup.com/docs/customer-groups-api/how-to-use-it#list-customer-groups
      operationId: ListCustomerGroups
      parameters:
      - name: cursor
        in: query
        description: |-
          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).
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: |-
          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).
        required: false
        style: form
        explode: true
        schema:
          type: integer
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomerGroupsResponse'
      security:
      - oauth2:
        - CUSTOMERS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
    post:
      tags:
      - CustomerGroups
      summary: CreateCustomerGroup
      description: |-
        Creates a new customer group for a business.

        The request must include the `name` value of the group.
      externalDocs:
        description: Create a customer group
        url: https://developer.squareup.com/docs/customer-groups-api/how-to-use-it#create-a-customer-group
      operationId: CreateCustomerGroup
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomerGroupRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCustomerGroupResponse'
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
  /v2/customers/groups/{group_id}:
    get:
      tags:
      - CustomerGroups
      summary: RetrieveCustomerGroup
      description: Retrieves a specific customer group as identified by the `group_id`
        value.
      operationId: RetrieveCustomerGroup
      parameters:
      - name: group_id
        in: path
        description: The ID of the customer group to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveCustomerGroupResponse'
      security:
      - oauth2:
        - CUSTOMERS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
    put:
      tags:
      - CustomerGroups
      summary: UpdateCustomerGroup
      description: Updates a customer group as identified by the `group_id` value.
      operationId: UpdateCustomerGroup
      parameters:
      - name: group_id
        in: path
        description: The ID of the customer group to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomerGroupRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCustomerGroupResponse'
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
    delete:
      tags:
      - CustomerGroups
      summary: DeleteCustomerGroup
      description: Deletes a customer group as identified by the `group_id` value.
      operationId: DeleteCustomerGroup
      parameters:
      - name: group_id
        in: path
        description: The ID of the customer group to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCustomerGroupResponse'
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
  /v2/customers/search:
    post:
      tags:
      - Customers
      summary: SearchCustomers
      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.
      externalDocs:
        description: Search for Customer Profiles
        url: https://developer.squareup.com/docs/customers-api/use-the-api/search-customers
      operationId: SearchCustomers
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchCustomersRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchCustomersResponse'
      security:
      - oauth2:
        - CUSTOMERS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-example-scenarios:
        scenarios:
        - name: Search customers
          bodyParameters:
            query:
              filter:
                email_address:
                  fuzzy: example.com
                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
                group_ids:
                  all:
                  - 545AXB44B4XXWMVQ4W8SBT3HHF
              sort:
                field: CREATED_AT
                order: ASC
            limit: 2
          response:
            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
              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
              reference_id: YOUR_REFERENCE_ID_2
              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
              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
              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
        - name: Search customers with custom attribute filter
          bodyParameters:
            query:
              filter:
                custom_attribute:
                  filters:
                  - key: favoritedrink
                    filter:
                      text:
                        exact: martini
                created_at:
                  start_at: 2018-01-01T00:00:00-00:00
                  end_at: 2018-02-01T00:00:00-00:00
              sort:
                field: CREATED_AT
                order: ASC
            limit: 2
          response:
            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
              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
              reference_id: YOUR_REFERENCE_ID_2
              preferences:
                email_unsubscribed: false
              creation_source: DIRECTORY
              group_ids:
              - 545AXB44B4XXWMVQ4W8SBT3HHF
              segment_ids:
              - 1KB9JE5EGJXCW.REACHABLE
              version: 7
            cursor: 9dpS093Uy12AzeE
  /v2/customers/segments:
    get:
      tags:
      - CustomerSegments
      summary: ListCustomerSegments
      description: Retrieves the list of customer segments of a business.
      externalDocs:
        description: List customer segments
        url: https://developer.squareup.com/docs/customer-segments-api/how-to-use-it#list-customer-segments
      operationId: ListCustomerSegments
      parameters:
      - name: cursor
        in: query
        description: |-
          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).
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: |-
          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).
        required: false
        style: form
        explode: true
        schema:
          type: integer
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomerSegmentsResponse'
      security:
      - oauth2:
        - CUSTOMERS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
  /v2/customers/segments/{segment_id}:
    get:
      tags:
      - CustomerSegments
      summary: RetrieveCustomerSegment
      description: Retrieves a specific customer segment as identified by the `segment_id`
        value.
      externalDocs:
        description: Retrieve segment membership information for a customer
        url: https://developer.squareup.com/docs/customer-segments-api/how-to-use-it#retrieve-segment-membership-information-for-a-customer
      operationId: RetrieveCustomerSegment
      parameters:
      - name: segment_id
        in: path
        description: The Square-issued ID of the customer segment.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveCustomerSegmentResponse'
      security:
      - oauth2:
        - CUSTOMERS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
  /v2/customers/{customer_id}:
    get:
      tags:
      - Customers
      summary: RetrieveCustomer
      description: Returns details for a single customer.
      externalDocs:
        description: Retrieve the customer profile of a given ID
        url: https://developer.squareup.com/docs/customers-api/use-the-api/retrieve-profiles#retrieve-the-customer-profile-of-a-given-id
      operationId: RetrieveCustomer
      parameters:
      - name: customer_id
        in: path
        description: The ID of the customer to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveCustomerResponse'
      security:
      - oauth2:
        - CUSTOMERS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
    put:
      tags:
      - Customers
      summary: UpdateCustomer
      description: |-
        Updates a customer profile. To change an attribute, specify the new value. To remove an attribute, specify the value as an empty string or empty object.

        As a best practice, you should include the `version` field in the request to enable [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency) control. The value must be set to the current version of the customer profile.

        To update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.

        You cannot use this endpoint to change cards on file. To make changes, use the [Cards API](api:Cards) or [Gift Cards API](api:GiftCards).
      externalDocs:
        description: Update a customer profile
        url: https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#update-a-customer-profile
      operationId: UpdateCustomer
      parameters:
      - name: customer_id
        in: path
        description: The ID of the customer to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCustomerRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCustomerResponse'
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-endpoint-errors:
      - error-code: INVALID_EMAIL_ADDRESS
      - error-code: INVALID_PHONE_NUMBER
      x-is-sparse-update: true
    delete:
      tags:
      - Customers
      summary: DeleteCustomer
      description: "Deletes a customer profile from a business. This operation also\
        \ unlinks any associated cards on file. \n\nAs a best practice, you should\
        \ include the `version` field in the request to enable [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency)\
        \ control. The value must be set to the current version of the customer profile.\
        \ \n\nTo delete a customer profile that was created by merging existing profiles,\
        \ you must use the ID of the newly created profile."
      externalDocs:
        description: Delete a customer profile
        url: https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-a-customer-profile
      operationId: DeleteCustomer
      parameters:
      - name: customer_id
        in: path
        description: The ID of the customer to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: version
        in: query
        description: |-
          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).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCustomerResponse'
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
  /v2/customers/{customer_id}/cards:
    post:
      tags:
      - Customers
      summary: CreateCustomerCard
      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.
      externalDocs:
        description: Manage cards on file
        url: https://developer.squareup.com/docs/customers-api/use-the-api/integrate-with-other-services#save-cards-on-file
      operationId: CreateCustomerCard
      parameters:
      - name: customer_id
        in: path
        description: The Square ID of the customer profile the card is linked to.
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomerCardRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCustomerCardResponse'
      deprecated: true
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /cards-api/protos/squareup/cards/api/customer_cards_service.proto
      x-proto-sha: 45981bf2b47428d1befee008c73b5fe7a15439b2
      x-deprecation:
        deprecationDate: 2021-06-16
        replacedBy: CreateCard
        guideUrl: https://developer.squareup.com/docs/customers-api/what-it-does#deprecated-createcustomercard-endpoint
      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
      description: Removes a card on file from a customer.
      externalDocs:
        description: Manage cards on file
        url: https://developer.squareup.com/docs/customers-api/use-the-api/integrate-with-other-services#save-cards-on-file
      operationId: DeleteCustomerCard
      parameters:
      - name: customer_id
        in: path
        description: The ID of the customer that the card on file belongs to.
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      - name: card_id
        in: path
        description: The ID of the card on file to delete.
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCustomerCardResponse'
      deprecated: true
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /cards-api/protos/squareup/cards/api/customer_cards_service.proto
      x-proto-sha: 45981bf2b47428d1befee008c73b5fe7a15439b2
      x-deprecation:
        deprecationDate: 2021-06-16
        replacedBy: DisableCard
        guideUrl: https://developer.squareup.com/docs/customers-api/what-it-does#deprecated-deletecustomercard-endpoint
  /v2/customers/{customer_id}/custom-attributes:
    get:
      tags:
      - CustomerCustomAttributes
      summary: ListCustomerCustomAttributes
      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`.
      externalDocs:
        description: List customer custom attributes
        url: https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#list-customer-custom-attributes
      operationId: ListCustomerCustomAttributes
      parameters:
      - name: customer_id
        in: path
        description: The ID of the target [customer profile](entity:Customer).
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: limit
        in: query
        description: |-
          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).
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: cursor
        in: query
        description: |-
          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).
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: with_definitions
        in: query
        description: |-
          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`.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomerCustomAttributesResponse'
      security:
      - oauth2:
        - CUSTOMERS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
  /v2/customers/{customer_id}/custom-attributes/{key}:
    get:
      tags:
      - CustomerCustomAttributes
      summary: RetrieveCustomerCustomAttribute
      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`.
      externalDocs:
        description: Retrieve customer custom attribute
        url: https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#retrieve-customer-custom-attribute
      operationId: RetrieveCustomerCustomAttribute
      parameters:
      - name: customer_id
        in: path
        description: The ID of the target [customer profile](entity:Customer).
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: key
        in: path
        description: |-
          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.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: with_definition
        in: query
        description: |-
          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`.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: version
        in: query
        description: |-
          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.
        required: false
        style: form
        explode: true
        schema:
          type: integer
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveCustomerCustomAttributeResponse'
      security:
      - oauth2:
        - CUSTOMERS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
    post:
      tags:
      - CustomerCustomAttributes
      summary: UpsertCustomerCustomAttribute
      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`.
      externalDocs:
        description: Upsert customer custom attribute
        url: https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#upsert-customer-custom-attribute
      operationId: UpsertCustomerCustomAttribute
      parameters:
      - name: customer_id
        in: path
        description: The ID of the target [customer profile](entity:Customer).
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: key
        in: path
        description: |-
          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.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertCustomerCustomAttributeRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpsertCustomerCustomAttributeResponse'
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-is-sparse-update: true
    delete:
      tags:
      - CustomerCustomAttributes
      summary: DeleteCustomerCustomAttribute
      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`.
      externalDocs:
        description: Delete customer custom attribute
        url: https://developer.squareup.com/docs/customer-custom-attributes-api/custom-attributes#delete-a-customer-custom-attribute
      operationId: DeleteCustomerCustomAttribute
      parameters:
      - name: customer_id
        in: path
        description: The ID of the target [customer profile](entity:Customer).
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: key
        in: path
        description: |-
          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.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCustomerCustomAttributeResponse'
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
  /v2/customers/{customer_id}/groups/{group_id}:
    put:
      tags:
      - Customers
      summary: AddGroupToCustomer
      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.
      externalDocs:
        description: Manage customer group membership
        url: https://developer.squareup.com/docs/customer-groups-api/how-to-use-it#add-customers-to-a-customer-group
      operationId: AddGroupToCustomer
      parameters:
      - name: customer_id
        in: path
        description: The ID of the customer to add to a group.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: group_id
        in: path
        description: The ID of the customer group to add the customer to.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddGroupToCustomerResponse'
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
    delete:
      tags:
      - Customers
      summary: RemoveGroupFromCustomer
      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.
      externalDocs:
        description: Manage customer group membership
        url: https://developer.squareup.com/docs/customer-groups-api/how-to-use-it#add-customers-to-a-customer-group
      operationId: RemoveGroupFromCustomer
      parameters:
      - name: customer_id
        in: path
        description: The ID of the customer to remove from the group.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: group_id
        in: path
        description: The ID of the customer group to remove the customer from.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveGroupFromCustomerResponse'
      security:
      - oauth2:
        - CUSTOMERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/service.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
  /v2/devices/codes:
    get:
      tags:
      - Devices
      summary: ListDeviceCodes
      description: Lists all DeviceCodes associated with the merchant.
      operationId: ListDeviceCodes
      parameters:
      - name: cursor
        in: query
        description: |-
          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.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: location_id
        in: query
        description: |-
          If specified, only returns DeviceCodes of the specified location.
          Returns DeviceCodes of all locations if empty.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: product_type
        in: query
        description: |-
          If specified, only returns DeviceCodes targeting the specified product type.
          Returns DeviceCodes of all product types if empty.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/ProductType'
      - name: status
        in: query
        description: |-
          If specified, returns DeviceCodes with the specified statuses.
          Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/DeviceCodeStatus'
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDeviceCodesResponse'
      security:
      - oauth2:
        - DEVICE_CREDENTIAL_MANAGEMENT
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /device-settings/device-settings-proto/src/main/proto/squareup/devicesettings/external/device_code_service.proto
      x-proto-sha: c26abe92e5379e8660778fe30b38f9165df7fabc
      x-endpoint-errors:
      - error-code: INVALID_CURSOR
      - error-code: BAD_REQUEST
    post:
      tags:
      - Devices
      summary: CreateDeviceCode
      description: |-
        Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected
        terminal mode.
      operationId: CreateDeviceCode
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDeviceCodeRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDeviceCodeResponse'
      security:
      - oauth2:
        - DEVICE_CREDENTIAL_MANAGEMENT
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /device-settings/device-settings-proto/src/main/proto/squareup/devicesettings/external/device_code_service.proto
      x-proto-sha: c26abe92e5379e8660778fe30b38f9165df7fabc
      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
      description: Retrieves DeviceCode with the associated ID.
      operationId: GetDeviceCode
      parameters:
      - name: id
        in: path
        description: The unique identifier for the device code.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDeviceCodeResponse'
      security:
      - oauth2:
        - DEVICE_CREDENTIAL_MANAGEMENT
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /device-settings/device-settings-proto/src/main/proto/squareup/devicesettings/external/device_code_service.proto
      x-proto-sha: c26abe92e5379e8660778fe30b38f9165df7fabc
      x-endpoint-errors:
      - error-code: BAD_REQUEST
      - error-code: NOT_FOUND
      - error-code: UNAUTHORIZED
  /v2/disputes:
    get:
      tags:
      - Disputes
      summary: ListDisputes
      description: Returns a list of disputes associated with a particular account.
      externalDocs:
        description: Access dispute information
        url: https://developer.squareup.com/docs/disputes-api/process-disputes#access-dispute-information
      operationId: ListDisputes
      parameters:
      - name: cursor
        in: query
        description: |-
          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/basics/api101/pagination).
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: states
        in: query
        description: The dispute states used to filter the result. If not specified,
          the endpoint returns all disputes.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/DisputeState'
      - name: location_id
        in: query
        description: |-
          The ID of the location for which to return a list of disputes.
          If not specified, the endpoint returns disputes associated with all locations.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDisputesResponse'
      security:
      - oauth2:
        - DISPUTES_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_service.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
  /v2/disputes/{dispute_id}:
    get:
      tags:
      - Disputes
      summary: RetrieveDispute
      description: Returns details about a specific dispute.
      operationId: RetrieveDispute
      parameters:
      - name: dispute_id
        in: path
        description: The ID of the dispute you want more details about.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveDisputeResponse'
      security:
      - oauth2:
        - DISPUTES_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_service.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
  /v2/disputes/{dispute_id}/accept:
    post:
      tags:
      - Disputes
      summary: AcceptDispute
      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.
      externalDocs:
        description: Accept a dispute
        url: https://developer.squareup.com/docs/disputes-api/process-disputes#accept-a-dispute
      operationId: AcceptDispute
      parameters:
      - name: dispute_id
        in: path
        description: The ID of the dispute you want to accept.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptDisputeResponse'
      security:
      - oauth2:
        - DISPUTES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_service.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
  /v2/disputes/{dispute_id}/evidence:
    get:
      tags:
      - Disputes
      summary: ListDisputeEvidence
      description: Returns a list of evidence associated with a dispute.
      operationId: ListDisputeEvidence
      parameters:
      - name: dispute_id
        in: path
        description: The ID of the dispute.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: cursor
        in: query
        description: |-
          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).
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDisputeEvidenceResponse'
      security:
      - oauth2:
        - DISPUTES_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_service.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
  /v2/disputes/{dispute_id}/evidence-files:
    post:
      tags:
      - Disputes
      summary: CreateDisputeEvidenceFile
      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.
      externalDocs:
        description: Challenge a dispute
        url: https://developer.squareup.com/docs/disputes-api/process-disputes#challenge-a-dispute
      operationId: CreateDisputeEvidenceFile
      parameters:
      - name: dispute_id
        in: path
        description: The ID of the dispute for which you want to upload evidence.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/body_2'
            encoding:
              request:
                contentType: application/json; charset=utf-8
                style: form
              image_file:
                contentType: image/jpeg
                style: form
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDisputeEvidenceFileResponse'
      security:
      - oauth2:
        - DISPUTES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_service.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
  /v2/disputes/{dispute_id}/evidence-text:
    post:
      tags:
      - Disputes
      summary: CreateDisputeEvidenceText
      description: Uploads text to use as evidence for a dispute challenge.
      externalDocs:
        description: Challenge a dispute
        url: https://developer.squareup.com/docs/disputes-api/process-disputes#challenge-a-dispute
      operationId: CreateDisputeEvidenceText
      parameters:
      - name: dispute_id
        in: path
        description: The ID of the dispute for which you want to upload evidence.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDisputeEvidenceTextRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDisputeEvidenceTextResponse'
      security:
      - oauth2:
        - DISPUTES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_service.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
  /v2/disputes/{dispute_id}/evidence/{evidence_id}:
    get:
      tags:
      - Disputes
      summary: RetrieveDisputeEvidence
      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.
      operationId: RetrieveDisputeEvidence
      parameters:
      - name: dispute_id
        in: path
        description: The ID of the dispute from which you want to retrieve evidence
          metadata.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: evidence_id
        in: path
        description: The ID of the evidence to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveDisputeEvidenceResponse'
      security:
      - oauth2:
        - DISPUTES_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_service.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
    delete:
      tags:
      - Disputes
      summary: DeleteDisputeEvidence
      description: |-
        Removes specified evidence from a dispute.
        Square does not send the bank any evidence that is removed.
      operationId: DeleteDisputeEvidence
      parameters:
      - name: dispute_id
        in: path
        description: The ID of the dispute from which you want to remove evidence.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: evidence_id
        in: path
        description: The ID of the evidence you want to remove.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDisputeEvidenceResponse'
      security:
      - oauth2:
        - DISPUTES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_service.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
  /v2/disputes/{dispute_id}/submit-evidence:
    post:
      tags:
      - Disputes
      summary: SubmitEvidence
      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.
      externalDocs:
        description: Challenge a dispute
        url: https://developer.squareup.com/docs/disputes-api/process-disputes#challenge-a-dispute
      operationId: SubmitEvidence
      parameters:
      - name: dispute_id
        in: path
        description: The ID of the dispute for which you want to submit evidence.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitEvidenceResponse'
      security:
      - oauth2:
        - DISPUTES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_service.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
  /v2/employees:
    get:
      tags:
      - Employees
      summary: ListEmployees
      operationId: ListEmployees
      parameters:
      - name: location_id
        in: query
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
      - name: status
        in: query
        description: Specifies the EmployeeStatus to filter the employee by.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/EmployeeStatus'
      - name: limit
        in: query
        description: The number of employees to be returned on each page.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: integer
      - name: cursor
        in: query
        description: The token required to retrieve the specified page of results.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEmployeesResponse'
      deprecated: true
      security:
      - oauth2:
        - EMPLOYEES_READ
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/employee.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-deprecation:
        deprecationDate: 2020-08-26
        retirementDate: 2021-08-26
        replacedBy: SearchTeamMembers
        guideUrl: https://developer.squareup.com/docs/team/migrate-from-v2-employees
  /v2/employees/{id}:
    get:
      tags:
      - Employees
      summary: RetrieveEmployee
      operationId: RetrieveEmployee
      parameters:
      - name: id
        in: path
        description: UUID for the employee that was requested.
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveEmployeeResponse'
      deprecated: true
      security:
      - oauth2:
        - EMPLOYEES_READ
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/employee.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-deprecation:
        deprecationDate: 2020-08-26
        retirementDate: 2021-08-26
        replacedBy: RetrieveTeamMember
        guideUrl: https://developer.squareup.com/docs/team/migrate-from-v2-employees
  /v2/gift-cards:
    get:
      tags:
      - GiftCards
      summary: 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."
      operationId: ListGiftCards
      parameters:
      - name: type
        in: query
        description: |-
          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.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: state
        in: query
        description: |-
          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.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: |-
          If a limit is provided, the endpoint returns only the specified number of results per page.
          The maximum value is 50. The default value is 30.
          For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: cursor
        in: query
        description: "A pagination cursor returned by a previous call to this endpoint.\n\
          Provide 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)."
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: customer_id
        in: query
        description: If a customer ID is provided, the endpoint returns only the gift
          cards linked to the specified customer.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGiftCardsResponse'
      security:
      - oauth2:
        - GIFTCARDS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/service.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
    post:
      tags:
      - GiftCards
      summary: CreateGiftCard
      description: "Creates a digital gift card or registers a physical (plastic)\
        \ gift card. After the gift card \nis created, you must call [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity)\
        \ \nto activate the card with an initial balance before it can be used for\
        \ payment."
      externalDocs:
        description: Selling gift cards
        url: https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#selling-square-gift-cards
      operationId: CreateGiftCard
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGiftCardRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGiftCardResponse'
      security:
      - oauth2:
        - GIFTCARDS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/service.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
  /v2/gift-cards/activities:
    get:
      tags:
      - GiftCardActivities
      summary: ListGiftCardActivities
      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.
      operationId: ListGiftCardActivities
      parameters:
      - name: gift_card_id
        in: query
        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."
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: type
        in: query
        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."
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: location_id
        in: query
        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."
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: begin_time
        in: query
        description: |-
          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.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: end_time
        in: query
        description: |-
          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.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        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)."
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: cursor
        in: query
        description: |-
          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).
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: sort_order
        in: query
        description: |-
          The order in which the endpoint returns the activities, based on `created_at`.
          - `ASC` - Oldest to newest.
          - `DESC` - Newest to oldest (default).
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGiftCardActivitiesResponse'
      security:
      - oauth2:
        - GIFTCARDS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/service.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
    post:
      tags:
      - GiftCardActivities
      summary: CreateGiftCardActivity
      description: "Creates a gift card activity to manage the balance or state of\
        \ a [gift card](entity:GiftCard). \nFor example, you create an `ACTIVATE`\
        \ activity to activate a gift card with an initial balance \nbefore the gift\
        \ card can be used."
      externalDocs:
        description: Manage the gift card balance or state
        url: https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#managing-the-gift-card-balance-or-state
      operationId: CreateGiftCardActivity
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGiftCardActivityRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGiftCardActivityResponse'
      security:
      - oauth2:
        - GIFTCARDS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/service.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-endpoint-errors:
      - error-code: INSUFFICIENT_FUNDS
      - error-code: PAYMENT_LIMIT_EXCEEDED
      - error-code: REFUND_AMOUNT_INVALID
  /v2/gift-cards/from-gan:
    post:
      tags:
      - GiftCards
      summary: RetrieveGiftCardFromGAN
      description: Retrieves a gift card using the gift card account number (GAN).
      operationId: RetrieveGiftCardFromGAN
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrieveGiftCardFromGANRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveGiftCardFromGANResponse'
      security:
      - oauth2:
        - GIFTCARDS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/service.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
  /v2/gift-cards/from-nonce:
    post:
      tags:
      - GiftCards
      summary: RetrieveGiftCardFromNonce
      description: Retrieves a gift card using a secure payment token that represents
        the gift card.
      operationId: RetrieveGiftCardFromNonce
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrieveGiftCardFromNonceRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveGiftCardFromNonceResponse'
      security:
      - oauth2:
        - GIFTCARDS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/service.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-endpoint-errors:
      - error-code: CARD_TOKEN_USED
  /v2/gift-cards/{gift_card_id}/link-customer:
    post:
      tags:
      - GiftCards
      summary: LinkCustomerToGiftCard
      description: Links a customer to a gift card, which is also referred to as adding
        a card on file.
      externalDocs:
        description: Manage gift cards on file
        url: https://developer.squareup.com/docs/gift-cards/additional-considerations#manage-gift-cards-on-file
      operationId: LinkCustomerToGiftCard
      parameters:
      - name: gift_card_id
        in: path
        description: The ID of the gift card to be linked.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkCustomerToGiftCardRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkCustomerToGiftCardResponse'
      security:
      - oauth2:
        - GIFTCARDS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/service.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
  /v2/gift-cards/{gift_card_id}/unlink-customer:
    post:
      tags:
      - GiftCards
      summary: UnlinkCustomerFromGiftCard
      description: Unlinks a customer from a gift card, which is also referred to
        as removing a card on file.
      externalDocs:
        description: Manage gift cards on file
        url: https://developer.squareup.com/docs/gift-cards/additional-considerations#manage-gift-cards-on-file
      operationId: UnlinkCustomerFromGiftCard
      parameters:
      - name: gift_card_id
        in: path
        description: The ID of the gift card to be unlinked.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnlinkCustomerFromGiftCardRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnlinkCustomerFromGiftCardResponse'
      security:
      - oauth2:
        - GIFTCARDS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/service.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
  /v2/gift-cards/{id}:
    get:
      tags:
      - GiftCards
      summary: RetrieveGiftCard
      description: Retrieves a gift card using the gift card ID.
      operationId: RetrieveGiftCard
      parameters:
      - name: id
        in: path
        description: The ID of the gift card to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveGiftCardResponse'
      security:
      - oauth2:
        - GIFTCARDS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/service.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
  /v2/inventory/adjustment/{adjustment_id}:
    get:
      tags:
      - Inventory
      summary: DeprecatedRetrieveInventoryAdjustment
      description: |-
        Deprecated version of [RetrieveInventoryAdjustment](api-endpoint:Inventory-RetrieveInventoryAdjustment) after the endpoint URL
        is updated to conform to the standard convention.
      operationId: DeprecatedRetrieveInventoryAdjustment
      parameters:
      - name: adjustment_id
        in: path
        description: ID of the [InventoryAdjustment](entity:InventoryAdjustment) to
          retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        x-release-status: PUBLIC
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveInventoryAdjustmentResponse'
      deprecated: true
      security:
      - oauth2:
        - INVENTORY_READ
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-deprecation: {}
  /v2/inventory/adjustments/{adjustment_id}:
    get:
      tags:
      - Inventory
      summary: RetrieveInventoryAdjustment
      description: |-
        Returns the [InventoryAdjustment](entity:InventoryAdjustment) object
        with the provided `adjustment_id`.
      operationId: RetrieveInventoryAdjustment
      parameters:
      - name: adjustment_id
        in: path
        description: ID of the [InventoryAdjustment](entity:InventoryAdjustment) to
          retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveInventoryAdjustmentResponse'
      security:
      - oauth2:
        - INVENTORY_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
  /v2/inventory/batch-change:
    post:
      tags:
      - Inventory
      summary: DeprecatedBatchChangeInventory
      description: |-
        Deprecated version of [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) after the endpoint URL
        is updated to conform to the standard convention.
      externalDocs:
        description: Reconcile Inventory Quantities
        url: https://developer.squareup.com/docs/inventory-api/cookbook/reconcile-computed-quantity
      operationId: DeprecatedBatchChangeInventory
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchChangeInventoryRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchChangeInventoryResponse'
      deprecated: true
      security:
      - oauth2:
        - INVENTORY_WRITE
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-deprecation: {}
  /v2/inventory/batch-retrieve-changes:
    post:
      tags:
      - Inventory
      summary: DeprecatedBatchRetrieveInventoryChanges
      description: |-
        Deprecated version of [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges) after the endpoint URL
        is updated to conform to the standard convention.
      operationId: DeprecatedBatchRetrieveInventoryChanges
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchRetrieveInventoryChangesRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchRetrieveInventoryChangesResponse'
      deprecated: true
      security:
      - oauth2:
        - INVENTORY_READ
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-deprecation: {}
  /v2/inventory/batch-retrieve-counts:
    post:
      tags:
      - Inventory
      summary: DeprecatedBatchRetrieveInventoryCounts
      description: |-
        Deprecated version of [BatchRetrieveInventoryCounts](api-endpoint:Inventory-BatchRetrieveInventoryCounts) after the endpoint URL
        is updated to conform to the standard convention.
      operationId: DeprecatedBatchRetrieveInventoryCounts
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchRetrieveInventoryCountsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchRetrieveInventoryCountsResponse'
      deprecated: true
      security:
      - oauth2:
        - INVENTORY_READ
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-deprecation: {}
  /v2/inventory/changes/batch-create:
    post:
      tags:
      - Inventory
      summary: BatchChangeInventory
      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.
      externalDocs:
        description: Reconcile Inventory Quantities
        url: https://developer.squareup.com/docs/inventory-api/cookbook/reconcile-computed-quantity
      operationId: BatchChangeInventory
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchChangeInventoryRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchChangeInventoryResponse'
      security:
      - oauth2:
        - INVENTORY_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
  /v2/inventory/changes/batch-retrieve:
    post:
      tags:
      - Inventory
      summary: BatchRetrieveInventoryChanges
      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.
      operationId: BatchRetrieveInventoryChanges
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchRetrieveInventoryChangesRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchRetrieveInventoryChangesResponse'
      security:
      - oauth2:
        - INVENTORY_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
  /v2/inventory/counts/batch-retrieve:
    post:
      tags:
      - Inventory
      summary: BatchRetrieveInventoryCounts
      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.
      operationId: BatchRetrieveInventoryCounts
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchRetrieveInventoryCountsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchRetrieveInventoryCountsResponse'
      security:
      - oauth2:
        - INVENTORY_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
  /v2/inventory/physical-count/{physical_count_id}:
    get:
      tags:
      - Inventory
      summary: DeprecatedRetrieveInventoryPhysicalCount
      description: |-
        Deprecated version of [RetrieveInventoryPhysicalCount](api-endpoint:Inventory-RetrieveInventoryPhysicalCount) after the endpoint URL
        is updated to conform to the standard convention.
      operationId: DeprecatedRetrieveInventoryPhysicalCount
      parameters:
      - name: physical_count_id
        in: path
        description: |-
          ID of the
          [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        x-release-status: PUBLIC
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveInventoryPhysicalCountResponse'
      deprecated: true
      security:
      - oauth2:
        - INVENTORY_READ
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-deprecation: {}
  /v2/inventory/physical-counts/{physical_count_id}:
    get:
      tags:
      - Inventory
      summary: RetrieveInventoryPhysicalCount
      description: |-
        Returns the [InventoryPhysicalCount](entity:InventoryPhysicalCount)
        object with the provided `physical_count_id`.
      operationId: RetrieveInventoryPhysicalCount
      parameters:
      - name: physical_count_id
        in: path
        description: |-
          ID of the
          [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveInventoryPhysicalCountResponse'
      security:
      - oauth2:
        - INVENTORY_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
  /v2/inventory/transfers/{transfer_id}:
    get:
      tags:
      - Inventory
      summary: RetrieveInventoryTransfer
      description: |-
        Returns the [InventoryTransfer](entity:InventoryTransfer) object
        with the provided `transfer_id`.
      operationId: RetrieveInventoryTransfer
      parameters:
      - name: transfer_id
        in: path
        description: ID of the [InventoryTransfer](entity:InventoryTransfer) to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveInventoryTransferResponse'
      security:
      - oauth2:
        - INVENTORY_READ
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
  /v2/inventory/{catalog_object_id}:
    get:
      tags:
      - Inventory
      summary: RetrieveInventoryCount
      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.
      externalDocs:
        description: Retrieve IN_STOCK Quantities
        url: https://developer.squareup.com/docs/inventory-api/cookbook/retrieve-specific-instock-quantity
      operationId: RetrieveInventoryCount
      parameters:
      - name: catalog_object_id
        in: path
        description: ID of the [CatalogObject](entity:CatalogObject) to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: location_ids
        in: query
        description: |-
          The [Location](entity:Location) IDs to look up as a comma-separated
          list. An empty list queries all locations.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: cursor
        in: query
        description: |-
          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.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveInventoryCountResponse'
      security:
      - oauth2:
        - INVENTORY_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
  /v2/inventory/{catalog_object_id}/changes:
    get:
      tags:
      - Inventory
      summary: RetrieveInventoryChanges
      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.
      externalDocs:
        description: Retrieve the Inventory Change History
        url: https://developer.squareup.com/docs/inventory-api/cookbook/inventory-change-history
      operationId: RetrieveInventoryChanges
      parameters:
      - name: catalog_object_id
        in: path
        description: ID of the [CatalogObject](entity:CatalogObject) to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        x-release-status: PUBLIC
      - name: location_ids
        in: query
        description: |-
          The [Location](entity:Location) IDs to look up as a comma-separated
          list. An empty list queries all locations.
        required: false
        style: form
        explode: true
        schema:
          type: string
        x-release-status: PUBLIC
      - name: cursor
        in: query
        description: |-
          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.
        required: false
        style: form
        explode: true
        schema:
          type: string
        x-release-status: PUBLIC
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveInventoryChangesResponse'
      deprecated: true
      security:
      - oauth2:
        - INVENTORY_READ
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-deprecation: {}
  /v2/invoices:
    get:
      tags:
      - Invoices
      summary: 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."
      externalDocs:
        description: List invoices
        url: https://developer.squareup.com/docs/invoices-api/retrieve-list-search-invoices
      operationId: ListInvoices
      parameters:
      - name: location_id
        in: query
        description: The ID of the location for which to list invoices.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: cursor
        in: query
        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/working-with-apis/pagination)."
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        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."
        required: false
        style: form
        explode: true
        schema:
          type: integer
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInvoicesResponse'
      security:
      - oauth2:
        - INVOICES_READ
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/service/public_api.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
    post:
      tags:
      - Invoices
      summary: 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)."
      externalDocs:
        description: Create invoices
        url: https://developer.squareup.com/docs/invoices-api/create-publish-invoices
      operationId: CreateInvoice
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInvoiceRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateInvoiceResponse'
      security:
      - oauth2:
        - ORDERS_WRITE
        - INVOICES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/service/public_api.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-endpoint-errors:
      - error-code: INVALID_CARD
      - error-code: MERCHANT_SUBSCRIPTION_NOT_FOUND
      x-example-scenarios:
        scenarios:
        - name: Payment in full
          bodyParameters:
            idempotency_key: ce3748f9-5fc1-4762-aa12-aae5e843f1f4
            invoice:
              location_id: ES0RJRZYEC39A
              order_id: CAISENgvlJ6jLWAzERDzjyHVybY
              scheduled_at: 2030-01-13T10:00:00Z
              primary_recipient:
                customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
              delivery_method: EMAIL
              payment_requests:
              - request_type: BALANCE
                due_date: 2030-01-24
                tipping_enabled: true
                automatic_payment_source: NONE
                reminders:
                - message: Your invoice is due tomorrow
                  relative_scheduled_days: -1
              invoice_number: inv-100
              title: Event Planning Services
              description: We appreciate your business!
              accepted_payment_methods:
                card: true
                square_gift_card: false
                bank_account: 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
          response:
            invoice:
              id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
              version: 0
              location_id: ES0RJRZYEC39A
              order_id: CAISENgvlJ6jLWAzERDzjyHVybY
              payment_requests:
              - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355
                request_type: BALANCE
                due_date: 2030-01-24
                tipping_enabled: true
                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
                automatic_payment_source: NONE
              invoice_number: inv-100
              title: Event Planning Services
              description: We appreciate your business!
              scheduled_at: 2030-01-13T10:00:00Z
              status: DRAFT
              timezone: America/Los_Angeles
              created_at: 2020-06-18T17:45:13Z
              updated_at: 2020-06-18T17:45:13Z
              primary_recipient:
                customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
                given_name: Amelia
                family_name: Earhart
                email_address: Amelia.Earhart@aviators.com
                phone_number: 1-212-555-4240
              accepted_payment_methods:
                card: true
                square_gift_card: false
                bank_account: 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
              delivery_method: EMAIL
              sale_or_service_date: 2030-01-24
              store_payment_method_enabled: false
            errors: []
        - name: Deposit with balance due later
          bodyParameters:
            idempotency_key: 8c944132-7fb5-48a4-9811-23faf364dbbd
            invoice:
              location_id: ES0RJRZYEC39A
              order_id: MJgfQ4nbvqoUzoZH0xTvJC3QuaB
              primary_recipient:
                customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
              delivery_method: EMAIL
              payment_requests:
              - request_type: DEPOSIT
                due_date: 2022-02-01
                percentage_requested: "50"
              - request_type: BALANCE
                due_date: 2022-03-01
                tipping_enabled: true
                automatic_payment_source: NONE
                reminders:
                - message: Your invoice is due tomorrow
                  relative_scheduled_days: -1
              invoice_number: inv-101
              title: Event Planning Services
              description: We appreciate your business!
              accepted_payment_methods:
                card: true
                square_gift_card: false
                bank_account: 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
          response:
            invoice:
              id: ti_PgKSU2LeAtJ-ZhgmvtQ
              version: 0
              location_id: ES0RJRZYEC39A
              order_id: MJgfQ4nbvqoUzoZH0xTvJC3QuaB
              payment_requests:
              - uid: 5a2d03bc-18e3-4c21-8f81-a3fc3c2b5552
                request_type: DEPOSIT
                due_date: 2022-02-01
                percentage_requested: "50"
                tipping_enabled: false
                computed_amount_money:
                  amount: 5000
                  currency: USD
                total_completed_amount_money:
                  amount: 0
                  currency: USD
                automatic_payment_source: NONE
                reminders: []
              - uid: d22dbfd7-71fe-46c7-adb1-29004ba29c14
                request_type: BALANCE
                due_date: 2022-03-01
                tipping_enabled: true
                reminders:
                - uid: 7f5187a9-669d-4e16-999a-e8a901ba964e
                  relative_scheduled_days: -1
                  message: Your invoice is due tomorrow
                  status: PENDING
                computed_amount_money:
                  amount: 5000
                  currency: USD
                total_completed_amount_money:
                  amount: 0
                  currency: USD
                automatic_payment_source: NONE
              invoice_number: inv-101
              title: Event Planning Services
              description: We appreciate your business!
              status: DRAFT
              timezone: Etc/UTC
              created_at: 2021-02-18T22:20:54Z
              updated_at: 2021-02-18T22:20:54Z
              primary_recipient:
                customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
                given_name: Amelia
                family_name: Earhart
                email_address: Amelia.Earhart@aviators.com
                phone_number: 1-212-555-4240
              accepted_payment_methods:
                card: true
                square_gift_card: false
                bank_account: 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
              delivery_method: EMAIL
              sale_or_service_date: 2030-01-24
              store_payment_method_enabled: false
            errors: []
        - name: Deposit with installments
          bodyParameters:
            idempotency_key: 22506e12-dd9c-400e-9292-8bd8f1b2099b
            invoice:
              location_id: ES0RJRZYEC39A
              order_id: E90bKTQOBmeO7W4TLvG5pMIVvaB
              primary_recipient:
                customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
              delivery_method: EMAIL
              payment_requests:
              - request_type: DEPOSIT
                due_date: 2022-02-01
                percentage_requested: "20"
                automatic_payment_source: NONE
              - request_type: INSTALLMENT
                percentage_requested: "33"
                due_date: 2022-03-01
                automatic_payment_source: NONE
              - request_type: INSTALLMENT
                percentage_requested: "33"
                due_date: 2022-04-01
                automatic_payment_source: NONE
              - request_type: INSTALLMENT
                percentage_requested: "34"
                due_date: 2022-05-01
                automatic_payment_source: NONE
              invoice_number: inv-102
              title: Event Planning Services
              description: We appreciate your business!
              accepted_payment_methods:
                card: true
                square_gift_card: false
                bank_account: 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
          response:
            invoice:
              id: z8jNGjrKL0HVObL63xbWTw
              version: 0
              location_id: ES0RJRZYEC39A
              order_id: E90bKTQOBmeO7W4TLvG5pMIVvaB
              payment_requests:
              - uid: 7d926ffe-40d6-46c8-aa2a-a8320028facd
                request_type: DEPOSIT
                due_date: 2022-02-01
                percentage_requested: "20"
                tipping_enabled: false
                computed_amount_money:
                  amount: 3000
                  currency: USD
                total_completed_amount_money:
                  amount: 0
                  currency: USD
                automatic_payment_source: NONE
                reminders: []
              - uid: fc6c8a47-02fd-4d8e-bd13-466688cbcb3d
                request_type: INSTALLMENT
                due_date: 2022-03-01
                percentage_requested: "33"
                tipping_enabled: false
                computed_amount_money:
                  amount: 3960
                  currency: USD
                total_completed_amount_money:
                  amount: 0
                  currency: USD
                automatic_payment_source: NONE
                reminders: []
              - uid: 2d31defd-d089-448b-a958-f6bed3872798
                request_type: INSTALLMENT
                due_date: 2022-04-01
                percentage_requested: "33"
                tipping_enabled: false
                computed_amount_money:
                  amount: 3960
                  currency: USD
                total_completed_amount_money:
                  amount: 0
                  currency: USD
                automatic_payment_source: NONE
                reminders: []
              - uid: 8f04739e-c6a2-474a-8653-4acc3fa963cd
                request_type: INSTALLMENT
                due_date: 2022-05-01
                percentage_requested: "34"
                tipping_enabled: false
                computed_amount_money:
                  amount: 4080
                  currency: USD
                total_completed_amount_money:
                  amount: 0
                  currency: USD
                automatic_payment_source: NONE
                reminders: []
              invoice_number: inv-102
              title: Event Planning Services
              description: We appreciate your business!
              status: DRAFT
              timezone: Etc/UTC
              created_at: 2021-02-18T22:56:55Z
              updated_at: 2021-02-18T22:56:55Z
              primary_recipient:
                customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
                given_name: Amelia
                family_name: Earhart
                email_address: Amelia.Earhart@aviators.com
                phone_number: 1-212-555-4240
              accepted_payment_methods:
                card: true
                square_gift_card: false
                bank_account: 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
              delivery_method: EMAIL
              sale_or_service_date: 2030-01-24
              store_payment_method_enabled: false
            errors: []
        - name: Installments only (fixed amount)
          bodyParameters:
            idempotency_key: a0dc6108-b9ae-4e3c-aadf-55a88bebdd4f
            invoice:
              location_id: ES0RJRZYEC39A
              order_id: WaU0nObtSiP3r08mpcwPNHaivaB
              primary_recipient:
                customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
              delivery_method: EMAIL
              payment_requests:
              - request_type: INSTALLMENT
                due_date: 2022-02-01
                fixed_amount_requested_money:
                  amount: 2500
                  currency: USD
                automatic_payment_source: NONE
              - request_type: INSTALLMENT
                due_date: 2022-03-01
                fixed_amount_requested_money:
                  amount: 2500
                  currency: USD
                automatic_payment_source: NONE
              - request_type: INSTALLMENT
                due_date: 2022-04-01
                fixed_amount_requested_money:
                  amount: 2500
                  currency: USD
                automatic_payment_source: NONE
              - request_type: INSTALLMENT
                due_date: 2022-05-01
                fixed_amount_requested_money:
                  amount: 2500
                  currency: USD
                automatic_payment_source: NONE
              invoice_number: inv-103
              title: Event Planning Services
              description: We appreciate your business!
              accepted_payment_methods:
                card: true
                square_gift_card: false
                bank_account: 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
          response:
            invoice:
              id: geEI6e9E4S1RTt0y9GDMzQ
              version: 0
              location_id: ES0RJRZYEC39A
              order_id: WaU0nObtSiP3r08mpcwPNHaivaB
              payment_requests:
              - uid: 4a33e488-9270-4083-a52b-d74ef2c7f467
                request_type: INSTALLMENT
                due_date: 2022-02-01
                fixed_amount_requested_money:
                  amount: 2500
                  currency: USD
                tipping_enabled: false
                computed_amount_money:
                  amount: 2500
                  currency: USD
                total_completed_amount_money:
                  amount: 0
                  currency: USD
                automatic_payment_source: NONE
                reminders: []
              - uid: 5235676b-1ca0-4dde-866e-61b30f958baf
                request_type: INSTALLMENT
                due_date: 2022-03-01
                fixed_amount_requested_money:
                  amount: 2500
                  currency: USD
                tipping_enabled: false
                computed_amount_money:
                  amount: 2500
                  currency: USD
                total_completed_amount_money:
                  amount: 0
                  currency: USD
                automatic_payment_source: NONE
                reminders: []
              - uid: efa1c34a-39d1-4bb8-858c-f2283f936a99
                request_type: INSTALLMENT
                due_date: 2022-04-01
                fixed_amount_requested_money:
                  amount: 2500
                  currency: USD
                tipping_enabled: false
                computed_amount_money:
                  amount: 2500
                  currency: USD
                total_completed_amount_money:
                  amount: 0
                  currency: USD
                automatic_payment_source: NONE
                reminders: []
              - uid: 28e6dd92-1f6f-4857-ad47-55f6c13edc5d
                request_type: INSTALLMENT
                due_date: 2022-05-01
                fixed_amount_requested_money:
                  amount: 2500
                  currency: USD
                tipping_enabled: false
                computed_amount_money:
                  amount: 2500
                  currency: USD
                total_completed_amount_money:
                  amount: 0
                  currency: USD
                automatic_payment_source: NONE
                reminders: []
              invoice_number: inv-103
              title: Event Planning Services
              description: We appreciate your business!
              status: DRAFT
              timezone: Etc/UTC
              created_at: 2021-02-18T23:08:52Z
              updated_at: 2021-02-18T23:08:52Z
              primary_recipient:
                customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
                given_name: Amelia
                family_name: Earhart
                email_address: Amelia.Earhart@aviators.com
                phone_number: 1-212-555-4240
              accepted_payment_methods:
                card: true
                square_gift_card: false
                bank_account: 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
              delivery_method: EMAIL
              sale_or_service_date: 2030-01-24
              store_payment_method_enabled: false
            errors: []
        - name: Automatically charge card on file
          bodyParameters:
            idempotency_key: 1502dae6-c66f-48cd-a994-251b3eaebf57
            invoice:
              location_id: ES0RJRZYEC39A
              order_id: Wyo24rZbYWnQYQTqFYY92Q69uaB
              scheduled_at: 2030-01-13T10:00:00Z
              primary_recipient:
                customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
              delivery_method: EMAIL
              payment_requests:
              - request_type: BALANCE
                due_date: 2030-01-24
                tipping_enabled: true
                card_id: ccof:oSvC0j8sqGECA5DM3GB
                automatic_payment_source: CARD_ON_FILE
                reminders:
                - message: Your card on file will be charged tomorrow.
                  relative_scheduled_days: -1
              invoice_number: inv-104
              title: Event Planning Services
              description: We appreciate your business!
              accepted_payment_methods:
                card: true
                square_gift_card: false
                bank_account: 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: true
          response:
            invoice:
              id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
              version: 0
              location_id: ES0RJRZYEC39A
              order_id: Wyo24rZbYWnQYQTqFYY92Q69uaB
              payment_requests:
              - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355
                request_type: BALANCE
                due_date: 2030-01-24
                tipping_enabled: true
                card_id: ccof:oSvC0j8sqGECA5DM3GB
                reminders:
                - uid: beebd363-e47f-4075-8785-c235aaa7df11
                  relative_scheduled_days: -1
                  message: Your card on file will be charged tomorrow.
                  status: PENDING
                computed_amount_money:
                  amount: 10000
                  currency: USD
                total_completed_amount_money:
                  amount: 0
                  currency: USD
                automatic_payment_source: CARD_ON_FILE
              invoice_number: inv-100
              title: Event Planning Services
              description: We appreciate your business!
              scheduled_at: 2030-01-13T10:00:00Z
              status: DRAFT
              timezone: America/Los_Angeles
              created_at: 2020-06-18T17:45:13Z
              updated_at: 2020-06-18T17:45:13Z
              primary_recipient:
                customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
                given_name: Amelia
                family_name: Earhart
                email_address: Amelia.Earhart@aviators.com
                phone_number: 1-212-555-4240
              accepted_payment_methods:
                card: true
                square_gift_card: false
                bank_account: 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
              delivery_method: EMAIL
              sale_or_service_date: 2030-01-24
              store_payment_method_enabled: true
            errors: []
  /v2/invoices/search:
    post:
      tags:
      - Invoices
      summary: 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."
      externalDocs:
        description: Search invoices
        url: https://developer.squareup.com/docs/invoices-api/retrieve-list-search-invoices
      operationId: SearchInvoices
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchInvoicesRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchInvoicesResponse'
      security:
      - oauth2:
        - INVOICES_READ
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/service/public_api.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
  /v2/invoices/{invoice_id}:
    get:
      tags:
      - Invoices
      summary: GetInvoice
      description: Retrieves an invoice by invoice ID.
      externalDocs:
        description: Retrieve invoices
        url: https://developer.squareup.com/docs/invoices-api/retrieve-list-search-invoices
      operationId: GetInvoice
      parameters:
      - name: invoice_id
        in: path
        description: The ID of the invoice to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInvoiceResponse'
      security:
      - oauth2:
        - INVOICES_READ
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/service/public_api.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
    put:
      tags:
      - Invoices
      summary: UpdateInvoice
      description: "Updates an invoice by modifying fields, clearing fields, or both.\
        \ For most updates, you can use a sparse \n`Invoice` object to add fields\
        \ or change values and use the `fields_to_clear` field to specify fields to\
        \ clear. \nHowever, some restrictions apply. For example, you cannot change\
        \ the `order_id` or `location_id` field and you \nmust provide the complete\
        \ `custom_fields` list to update a custom field. Published invoices have additional\
        \ restrictions."
      externalDocs:
        description: Update invoices
        url: https://developer.squareup.com/docs/invoices-api/update-invoices
      operationId: UpdateInvoice
      parameters:
      - name: invoice_id
        in: path
        description: The ID of the invoice to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateInvoiceRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateInvoiceResponse'
      security:
      - oauth2:
        - ORDERS_WRITE
        - INVOICES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/service/public_api.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-endpoint-errors:
      - error-code: MERCHANT_SUBSCRIPTION_NOT_FOUND
      x-is-sparse-update: true
    delete:
      tags:
      - Invoices
      summary: 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)."
      externalDocs:
        description: Delete invoices
        url: https://developer.squareup.com/docs/invoices-api/cancel-delete-invoices
      operationId: DeleteInvoice
      parameters:
      - name: invoice_id
        in: path
        description: The ID of the invoice to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: version
        in: query
        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)."
        required: false
        style: form
        explode: true
        schema:
          type: integer
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteInvoiceResponse'
      security:
      - oauth2:
        - ORDERS_WRITE
        - INVOICES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/service/public_api.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
  /v2/invoices/{invoice_id}/cancel:
    post:
      tags:
      - Invoices
      summary: CancelInvoice
      description: "Cancels an invoice. The seller cannot collect payments for \n\
        the canceled invoice.\n\nYou cannot cancel an invoice in the `DRAFT` state\
        \ or in a terminal state: `PAID`, `REFUNDED`, `CANCELED`, or `FAILED`."
      externalDocs:
        description: Cancel invoices
        url: https://developer.squareup.com/docs/invoices-api/cancel-delete-invoices
      operationId: CancelInvoice
      parameters:
      - name: invoice_id
        in: path
        description: The ID of the [invoice](entity:Invoice) to cancel.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelInvoiceRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelInvoiceResponse'
      security:
      - oauth2:
        - ORDERS_WRITE
        - INVOICES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/service/public_api.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-endpoint-errors:
      - error-code: VERSION_MISMATCH
  /v2/invoices/{invoice_id}/publish:
    post:
      tags:
      - Invoices
      summary: 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 charge a card on file for a portion of the \n\
        invoice amount."
      externalDocs:
        description: Publish invoices
        url: https://developer.squareup.com/docs/invoices-api/create-publish-invoices
      operationId: PublishInvoice
      parameters:
      - name: invoice_id
        in: path
        description: The ID of the invoice to publish.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublishInvoiceRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublishInvoiceResponse'
      security:
      - oauth2:
        - ORDERS_WRITE
        - INVOICES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/service/public_api.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-endpoint-errors:
      - error-code: CARD_DECLINED
      - error-code: INVALID_CARD
  /v2/labor/break-types:
    get:
      tags:
      - Labor
      summary: ListBreakTypes
      description: Returns a paginated list of `BreakType` instances for a business.
      operationId: ListBreakTypes
      parameters:
      - name: location_id
        in: query
        description: |-
          Filter the returned `BreakType` results to only those that are associated with the
          specified location.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: |-
          The maximum number of `BreakType` results to return per page. The number can range between 1
          and 200. The default is 200.
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: cursor
        in: query
        description: A pointer to the next page of `BreakType` results to fetch.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBreakTypesResponse'
      security:
      - oauth2:
        - TIMECARDS_SETTINGS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/service.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
    post:
      tags:
      - Labor
      summary: CreateBreakType
      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.
      operationId: CreateBreakType
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBreakTypeRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBreakTypeResponse'
      security:
      - oauth2:
        - TIMECARDS_SETTINGS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/service.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
  /v2/labor/break-types/{id}:
    get:
      tags:
      - Labor
      summary: GetBreakType
      description: Returns a single `BreakType` specified by `id`.
      operationId: GetBreakType
      parameters:
      - name: id
        in: path
        description: The UUID for the `BreakType` being retrieved.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBreakTypeResponse'
      security:
      - oauth2:
        - TIMECARDS_SETTINGS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/service.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
    put:
      tags:
      - Labor
      summary: UpdateBreakType
      description: Updates an existing `BreakType`.
      operationId: UpdateBreakType
      parameters:
      - name: id
        in: path
        description: ' The UUID for the `BreakType` being updated.'
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBreakTypeRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateBreakTypeResponse'
      security:
      - oauth2:
        - TIMECARDS_SETTINGS_WRITE
        - TIMECARDS_SETTINGS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/service.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
    delete:
      tags:
      - Labor
      summary: DeleteBreakType
      description: |-
        Deletes an existing `BreakType`.

        A `BreakType` can be deleted even if it is referenced from a `Shift`.
      operationId: DeleteBreakType
      parameters:
      - name: id
        in: path
        description: The UUID for the `BreakType` being deleted.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteBreakTypeResponse'
      security:
      - oauth2:
        - TIMECARDS_SETTINGS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/service.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
  /v2/labor/employee-wages:
    get:
      tags:
      - Labor
      summary: ListEmployeeWages
      description: Returns a paginated list of `EmployeeWage` instances for a business.
      operationId: ListEmployeeWages
      parameters:
      - name: employee_id
        in: query
        description: Filter the returned wages to only those that are associated with
          the specified employee.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: |-
          The maximum number of `EmployeeWage` results to return per page. The number can range between
          1 and 200. The default is 200.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: integer
      - name: cursor
        in: query
        description: A pointer to the next page of `EmployeeWage` results to fetch.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEmployeeWagesResponse'
      deprecated: true
      security:
      - oauth2:
        - EMPLOYEES_READ
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/service.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-deprecation:
        deprecationDate: 2020-08-26
        retirementDate: TBD
        replacedBy: ListTeamMemberWages
        guideUrl: https://developer.squareup.com/docs/labor-api/migrate-to-teams
  /v2/labor/employee-wages/{id}:
    get:
      tags:
      - Labor
      summary: GetEmployeeWage
      description: Returns a single `EmployeeWage` specified by `id`.
      operationId: GetEmployeeWage
      parameters:
      - name: id
        in: path
        description: The UUID for the `EmployeeWage` being retrieved.
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEmployeeWageResponse'
      deprecated: true
      security:
      - oauth2:
        - EMPLOYEES_READ
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/service.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-deprecation:
        deprecationDate: 2020-08-26
        retirementDate: TBD
        replacedBy: GetTeamMemberWage
        guideUrl: https://developer.squareup.com/docs/labor-api/migrate-to-teams
  /v2/labor/shifts:
    post:
      tags:
      - Labor
      summary: CreateShift
      description: |-
        Creates a new `Shift`.

        A `Shift` represents a complete workday for a single employee.
        You must provide the following values in your request to this
        endpoint:

        - `location_id`
        - `employee_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 employee 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 employee.
        - 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.
      operationId: CreateShift
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateShiftRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateShiftResponse'
      security:
      - oauth2:
        - TIMECARDS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/service.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
  /v2/labor/shifts/search:
    post:
      tags:
      - Labor
      summary: SearchShifts
      description: |-
        Returns a paginated list of `Shift` records for a business.
        The list to be returned can be filtered by:
        - Location IDs.
        - Employee IDs.
        - Shift status (`OPEN` and `CLOSED`).
        - Shift start.
        - Shift end.
        - Workday details.

        The list can be sorted by:
        - `start_at`.
        - `end_at`.
        - `created_at`.
        - `updated_at`.
      operationId: SearchShifts
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchShiftsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchShiftsResponse'
      security:
      - oauth2:
        - TIMECARDS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/service.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
  /v2/labor/shifts/{id}:
    get:
      tags:
      - Labor
      summary: GetShift
      description: Returns a single `Shift` specified by `id`.
      operationId: GetShift
      parameters:
      - name: id
        in: path
        description: The UUID for the `Shift` being retrieved.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetShiftResponse'
      security:
      - oauth2:
        - TIMECARDS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/service.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
    put:
      tags:
      - Labor
      summary: UpdateShift
      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`.
      operationId: UpdateShift
      parameters:
      - name: id
        in: path
        description: The ID of the object being updated.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateShiftRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateShiftResponse'
      security:
      - oauth2:
        - TIMECARDS_WRITE
        - TIMECARDS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/service.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
    delete:
      tags:
      - Labor
      summary: DeleteShift
      description: Deletes a `Shift`.
      operationId: DeleteShift
      parameters:
      - name: id
        in: path
        description: The UUID for the `Shift` being deleted.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteShiftResponse'
      security:
      - oauth2:
        - TIMECARDS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/service.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
  /v2/labor/team-member-wages:
    get:
      tags:
      - Labor
      summary: ListTeamMemberWages
      description: Returns a paginated list of `TeamMemberWage` instances for a business.
      operationId: ListTeamMemberWages
      parameters:
      - name: team_member_id
        in: query
        description: |-
          Filter the returned wages to only those that are associated with the
          specified team member.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: |-
          The maximum number of `TeamMemberWage` results to return per page. The number can range between
          1 and 200. The default is 200.
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: cursor
        in: query
        description: A pointer to the next page of `EmployeeWage` results to fetch.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTeamMemberWagesResponse'
      security:
      - oauth2:
        - EMPLOYEES_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/service.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
  /v2/labor/team-member-wages/{id}:
    get:
      tags:
      - Labor
      summary: GetTeamMemberWage
      description: Returns a single `TeamMemberWage` specified by `id `.
      operationId: GetTeamMemberWage
      parameters:
      - name: id
        in: path
        description: The UUID for the `TeamMemberWage` being retrieved.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamMemberWageResponse'
      security:
      - oauth2:
        - EMPLOYEES_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/service.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
  /v2/labor/workweek-configs:
    get:
      tags:
      - Labor
      summary: ListWorkweekConfigs
      description: Returns a list of `WorkweekConfig` instances for a business.
      operationId: ListWorkweekConfigs
      parameters:
      - name: limit
        in: query
        description: The maximum number of `WorkweekConfigs` results to return per
          page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
      - name: cursor
        in: query
        description: A pointer to the next page of `WorkweekConfig` results to fetch.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWorkweekConfigsResponse'
      security:
      - oauth2:
        - TIMECARDS_SETTINGS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/service.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
  /v2/labor/workweek-configs/{id}:
    put:
      tags:
      - Labor
      summary: UpdateWorkweekConfig
      description: Updates a `WorkweekConfig`.
      operationId: UpdateWorkweekConfig
      parameters:
      - name: id
        in: path
        description: The UUID for the `WorkweekConfig` object being updated.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkweekConfigRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWorkweekConfigResponse'
      security:
      - oauth2:
        - TIMECARDS_SETTINGS_WRITE
        - TIMECARDS_SETTINGS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/service.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
  /v2/locations:
    get:
      tags:
      - Locations
      summary: ListLocations
      description: |-
        Provides details about all of the seller's [locations](https://developer.squareup.com/docs/locations-api),
        including those with an inactive status.
      externalDocs:
        description: Retrieve a list of locations
        url: https://developer.squareup.com/docs/locations-api#listlocations
      operationId: ListLocations
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLocationsResponse'
      security:
      - oauth2:
        - MERCHANT_PROFILE_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/location.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-unitTests:
      - request:
          method: GET
          uri: /v2/locations
        expectedResponse:
          x-allowExtraHeaders: true
          x-bodyMatchMode: NONE
          x-arrayOrderedMatching: false
          x-arrayCheckCount: false
          x-matchResponseSchema: true
          statusCode: "200"
          headers: {}
        x-testShouldPass: true
        x-testEnabled: true
        x-testName: ListLocations
    post:
      tags:
      - Locations
      summary: CreateLocation
      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.
      externalDocs:
        description: Create a location
        url: https://developer.squareup.com/docs/locations-api#createalocation
      operationId: CreateLocation
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLocationRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateLocationResponse'
      security:
      - oauth2:
        - MERCHANT_PROFILE_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/location.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-endpoint-errors:
      - error-code: BAD_REQUEST
      x-is-sparse-update: true
  /v2/locations/{location_id}:
    get:
      tags:
      - Locations
      summary: RetrieveLocation
      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).
      externalDocs:
        description: Retrieve a specific location
        url: https://developer.squareup.com/docs/locations-api#retrievelocation
      operationId: RetrieveLocation
      parameters:
      - name: location_id
        in: path
        description: |-
          The ID of the location to retrieve. Specify the string
          "main" to return the main location.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveLocationResponse'
      security:
      - oauth2:
        - MERCHANT_PROFILE_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/location.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-endpoint-errors:
      - error-code: NOT_FOUND
    put:
      tags:
      - Locations
      summary: UpdateLocation
      description: Updates a [location](https://developer.squareup.com/docs/locations-api).
      externalDocs:
        description: Update a location
        url: https://developer.squareup.com/docs/locations-api#updatealocation
      operationId: UpdateLocation
      parameters:
      - name: location_id
        in: path
        description: The ID of the location to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLocationRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateLocationResponse'
      security:
      - oauth2:
        - MERCHANT_PROFILE_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/location.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-endpoint-errors:
      - error-code: BAD_REQUEST
      x-is-sparse-update: true
  /v2/locations/{location_id}/checkouts:
    post:
      tags:
      - Checkout
      summary: CreateCheckout
      description: "Links a `checkoutId` to a `checkout_page_url` that customers are\n\
        directed 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).\n\
        We recommend that you use the new [CreatePaymentLink](api-endpoint:Checkout-CreatePaymentLink)\
        \ \nendpoint in place of this previously released endpoint."
      operationId: CreateCheckout
      parameters:
      - name: location_id
        in: path
        description: The ID of the business location to associate the checkout with.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        x-release-status: PUBLIC
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCheckoutRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCheckoutResponse'
      deprecated: true
      security:
      - oauth2:
        - PAYMENTS_WRITE
        - ORDERS_WRITE
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /payapi-checkouts/protos/squareup/payapi/checkouts.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-deprecation: {}
      x-endpoint-errors:
      - error-code: AMOUNT_TOO_HIGH
      - error-code: CARD_PROCESSING_NOT_ENABLED
      - error-code: ORDER_EXPIRED
  /v2/locations/{location_id}/transactions:
    get:
      tags:
      - Transactions
      summary: ListTransactions
      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
      operationId: ListTransactions
      parameters:
      - name: location_id
        in: path
        description: The ID of the location to list transactions for.
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      - name: begin_time
        in: query
        description: |-
          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.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
      - name: end_time
        in: query
        description: |-
          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.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
      - name: sort_order
        in: query
        description: |-
          The order in which results are listed in the response (`ASC` for
          oldest first, `DESC` for newest first).

          Default value: `DESC`
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/SortOrder'
      - name: cursor
        in: query
        description: |-
          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.
        required: false
        deprecated: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTransactionsResponse'
      deprecated: true
      security:
      - oauth2:
        - PAYMENTS_READ
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/service.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-deprecation:
        deprecationDate: 2019-08-15
        retirementDate: 2021-09-01
        replacedBy: SearchOrders
        guideUrl: https://developer.squareup.com/docs/payments-api/migrate-from-transactions-api
  /v2/locations/{location_id}/transactions/{transaction_id}:
    get:
      tags:
      - Transactions
      summary: RetrieveTransaction
      description: Retrieves details for a single transaction.
      operationId: RetrieveTransaction
      parameters:
      - name: location_id
        in: path
        description: The ID of the transaction's associated location.
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      - name: transaction_id
        in: path
        description: The ID of the transaction to retrieve.
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveTransactionResponse'
      deprecated: true
      security:
      - oauth2:
        - PAYMENTS_READ
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/service.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-deprecation:
        deprecationDate: 2019-08-15
        retirementDate: 2021-09-01
        replacedBy: BatchRetrieveOrders
        guideUrl: https://developer.squareup.com/docs/payments-api/migrate-from-transactions-api
  /v2/locations/{location_id}/transactions/{transaction_id}/capture:
    post:
      tags:
      - Transactions
      summary: CaptureTransaction
      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.
      operationId: CaptureTransaction
      parameters:
      - name: location_id
        in: path
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      - name: transaction_id
        in: path
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaptureTransactionResponse'
      deprecated: true
      security:
      - oauth2:
        - PAYMENTS_WRITE
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/service.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-deprecation:
        deprecationDate: 2019-08-15
        retirementDate: TBD
        replacedBy: CompletePayment
        guideUrl: https://developer.squareup.com/docs/payments-api/migrate-from-transactions-api
      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
      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.
      operationId: VoidTransaction
      parameters:
      - name: location_id
        in: path
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      - name: transaction_id
        in: path
        required: true
        deprecated: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoidTransactionResponse'
      deprecated: true
      security:
      - oauth2:
        - PAYMENTS_WRITE
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/service.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-deprecation:
        deprecationDate: 2019-08-15
        retirementDate: 2021-09-01
        replacedBy: CancelPayment
        guideUrl: https://developer.squareup.com/docs/payments-api/migrate-from-transactions-api
      x-endpoint-errors:
      - error-code: DELAYED_TRANSACTION_CAPTURED
      - error-code: DELAYED_TRANSACTION_EXPIRED
  /v2/loyalty/accounts:
    post:
      tags:
      - Loyalty
      summary: 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.
      externalDocs:
        description: Create loyalty account
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-accounts#create-loyalty-account
      operationId: CreateLoyaltyAccount
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLoyaltyAccountRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateLoyaltyAccountResponse'
      security:
      - oauth2:
        - LOYALTY_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-endpoint-errors:
      - error-code: INVALID_PHONE_NUMBER
  /v2/loyalty/accounts/search:
    post:
      tags:
      - Loyalty
      summary: 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."
      externalDocs:
        description: Search loyalty accounts
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-accounts#search-loyalty-accounts
      operationId: SearchLoyaltyAccounts
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchLoyaltyAccountsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchLoyaltyAccountsResponse'
      security:
      - oauth2:
        - LOYALTY_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-example-scenarios:
        scenarios:
        - name: Retrieve all loyalty accounts
          bodyParameters:
            query: {}
            limit: 5
          response:
            loyalty_accounts:
            - id: 79b807d2-d786-46a9-933b-918028d7a8c5
              mapping:
                id: 66aaab3f-da99-49ed-8b19-b87f851c844f
                phone_number: +14155551234
                created_at: 2020-05-08T21:44:32Z
              program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
              balance: 20
              lifetime_points: 50
              customer_id: RPJBC4YA0MTGX8DHTXE9AP2AS4
              created_at: 2020-05-08T21:44:32Z
              updated_at: 2020-05-08T21:44:32Z
            - id: 452ea896-f36e-4c5c-95d5-e5aa727b9b2c
              mapping:
                id: cbde1ec6-96df-40d4-8019-af9a4fa893ed
                phone_number: +14255554670
                created_at: 2020-05-29T04:04:11Z
              program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
              balance: -10
              lifetime_points: 10
              customer_id: 6E51KR0B3GVAKE0GP0HV69A1V0
              created_at: 2020-05-29T04:04:11Z
              updated_at: 2020-05-29T04:04:11Z
            - id: bd2d7c0d-0183-4c1e-b5d4-d1c88f24c201
              mapping:
                id: 9a85bb43-a6a5-4123-a2e7-324621cf283b
                phone_number: +12085559707
                created_at: 2020-07-22T10:50:28Z
              program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
              balance: 80
              lifetime_points: 210
              customer_id: REK96J96AS5AN2Y8Z4H01QWYE8
              created_at: 2020-07-22T10:50:28Z
              updated_at: 2020-07-22T10:50:28Z
            - id: 5bb3fc58-266a-4001-bb26-99a178533355
              mapping:
                id: d0805ad0-7bc7-45e2-ad84-932c226cd096
                phone_number: +16095552758
                created_at: 2020-09-13T04:27:43Z
              program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
              balance: 40
              lifetime_points: 40
              customer_id: 6WW3N3ZRWMYRSB21ZVW4TT4BYC
              created_at: 2020-09-13T04:27:43Z
              updated_at: 2020-09-13T04:27:43Z
            - id: 9f32fe22-777e-4655-8a82-29c1ef51e496
              mapping:
                id: fccc1899-e8e8-4423-9525-bb5d6453c6ae
                phone_number: +15055551967
                created_at: 2020-09-18T14:28:57Z
              program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
              balance: 0
              lifetime_points: 0
              customer_id: 3GR8PJ090RYTZ70KPB92YM4YZ0
              created_at: 2020-09-18T14:28:57Z
              updated_at: 2020-09-18T14:28:57Z
            cursor: LRdH9KdUiYrJqbbouAglvV46UOmVv7VByhTxMK0pprEsQdzlYfwCUiin2Q7FGR9QC
        - name: Search by phone number
          bodyParameters:
            query:
              mappings:
              - phone_number: +14155551234
            limit: 10
          response:
            loyalty_accounts:
            - id: 79b807d2-d786-46a9-933b-918028d7a8c5
              mapping:
                id: 66aaab3f-da99-49ed-8b19-b87f851c844f
                phone_number: +14155551234
                created_at: 2020-05-08T21:44:32Z
              program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
              balance: 10
              lifetime_points: 20
              customer_id: RPJBC4YA0MTGX8DHTXE9AP2AS4
              created_at: 2020-05-08T21:44:32Z
              updated_at: 2020-05-08T21:44:32Z
        - name: Search by customer ID
          bodyParameters:
            query:
              customer_ids:
              - RPJBC4YA0MTGX8DHTXE9AP2AS4
            limit: 10
          response:
            loyalty_accounts:
            - id: 79b807d2-d786-46a9-933b-918028d7a8c5
              mapping:
                id: 66aaab3f-da99-49ed-8b19-b87f851c844f
                phone_number: +14155551234
                created_at: 2020-05-08T21:44:32Z
              program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
              balance: 10
              lifetime_points: 20
              customer_id: RPJBC4YA0MTGX8DHTXE9AP2AS4
              created_at: 2020-05-08T21:44:32Z
              updated_at: 2020-05-08T21:44:32Z
  /v2/loyalty/accounts/{account_id}:
    get:
      tags:
      - Loyalty
      summary: RetrieveLoyaltyAccount
      description: Retrieves a loyalty account.
      externalDocs:
        description: Retrieve loyalty account
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-accounts#retrieve-loyalty-account
      operationId: RetrieveLoyaltyAccount
      parameters:
      - name: account_id
        in: path
        description: The ID of the [loyalty account](entity:LoyaltyAccount) to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveLoyaltyAccountResponse'
      security:
      - oauth2:
        - LOYALTY_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
  /v2/loyalty/accounts/{account_id}/accumulate:
    post:
      tags:
      - Loyalty
      summary: AccumulateLoyaltyPoints
      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).
      externalDocs:
        description: Accumulate loyalty points
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-points#accumulate-loyalty-points
      operationId: AccumulateLoyaltyPoints
      parameters:
      - name: account_id
        in: path
        description: The ID of the target [loyalty account](entity:LoyaltyAccount).
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccumulateLoyaltyPointsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccumulateLoyaltyPointsResponse'
      security:
      - oauth2:
        - LOYALTY_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
  /v2/loyalty/accounts/{account_id}/adjust:
    post:
      tags:
      - Loyalty
      summary: AdjustLoyaltyPoints
      description: "Adds points to or subtracts points from a buyer's account. \n\n\
        Use 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."
      externalDocs:
        description: Adjust loyalty points
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-points#adjust-loyalty-points
      operationId: AdjustLoyaltyPoints
      parameters:
      - name: account_id
        in: path
        description: The ID of the target [loyalty account](entity:LoyaltyAccount).
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdjustLoyaltyPointsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdjustLoyaltyPointsResponse'
      security:
      - oauth2:
        - LOYALTY_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
  /v2/loyalty/events/search:
    post:
      tags:
      - Loyalty
      summary: 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."
      externalDocs:
        description: Search loyalty events
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-events#search-loyalty-events
      operationId: SearchLoyaltyEvents
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchLoyaltyEventsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchLoyaltyEventsResponse'
      security:
      - oauth2:
        - LOYALTY_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
  /v2/loyalty/programs:
    get:
      tags:
      - Loyalty
      summary: ListLoyaltyPrograms
      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`.
      externalDocs:
        description: List loyalty programs
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-programs#list-loyalty-programs
      operationId: ListLoyaltyPrograms
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLoyaltyProgramsResponse'
      deprecated: true
      security:
      - oauth2:
        - LOYALTY_READ
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-deprecation:
        deprecationDate: 2021-05-13
        replacedBy: RetrieveLoyaltyProgram
        guideUrl: https://developer.squareup.com/docs/loyalty-api/overview#migration-notes
      x-endpoint-errors:
      - error-code: UNSUPPORTED_LOYALTY_REWARD_TIER
  /v2/loyalty/programs/{program_id}:
    get:
      tags:
      - Loyalty
      summary: 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)."
      externalDocs:
        description: Retrieve loyalty program
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-programs#retrieve-loyalty-program
      operationId: RetrieveLoyaltyProgram
      parameters:
      - name: program_id
        in: path
        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.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveLoyaltyProgramResponse'
      security:
      - oauth2:
        - LOYALTY_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-endpoint-errors:
      - error-code: UNSUPPORTED_LOYALTY_REWARD_TIER
  /v2/loyalty/programs/{program_id}/calculate:
    post:
      tags:
      - Loyalty
      summary: CalculateLoyaltyPoints
      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).
      externalDocs:
        description: Calculate loyalty points
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-points#calculate-loyalty-points
      operationId: CalculateLoyaltyPoints
      parameters:
      - name: program_id
        in: path
        description: The ID of the [loyalty program](entity:LoyaltyProgram), which
          defines the rules for accruing points.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalculateLoyaltyPointsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculateLoyaltyPointsResponse'
      security:
      - oauth2:
        - LOYALTY_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
  /v2/loyalty/programs/{program_id}/promotions:
    get:
      tags:
      - Loyalty
      summary: ListLoyaltyPromotions
      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).
      externalDocs:
        description: List loyalty promotions
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#list-loyalty-promotions
      operationId: ListLoyaltyPromotions
      parameters:
      - name: program_id
        in: path
        description: |-
          The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID,
          call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: status
        in: query
        description: |-
          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.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/LoyaltyPromotionStatus'
      - name: cursor
        in: query
        description: |-
          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).
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: |-
          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).
        required: false
        style: form
        explode: true
        schema:
          type: integer
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLoyaltyPromotionsResponse'
      security:
      - oauth2:
        - LOYALTY_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
    post:
      tags:
      - Loyalty
      summary: CreateLoyaltyPromotion
      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.
      externalDocs:
        description: Create loyalty promotions
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#create-loyalty-promotion
      operationId: CreateLoyaltyPromotion
      parameters:
      - name: program_id
        in: path
        description: |-
          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.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLoyaltyPromotionRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateLoyaltyPromotionResponse'
      security:
      - oauth2:
        - LOYALTY_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-example-scenarios:
        scenarios:
        - name: Create loyalty promotion with end date
          pathParameters:
            program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
          bodyParameters:
            idempotency_key: ec78c477-b1c3-4899-a209-a4e71337c996
            loyalty_promotion:
              name: Tuesday Happy Hour Promo
              incentive:
                type: POINTS_MULTIPLIER
                points_multiplier_data:
                  points_multiplier: 3
              available_time:
                time_periods:
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220816T160000
                  DURATION:PT2H
                  RRULE:FREQ=WEEKLY;UNTIL=20221001T000000;BYDAY=TU
                  END:VEVENT
              trigger_limit:
                times: 1
                interval: DAY
          response:
            loyalty_promotion:
              id: loypromo_f0f9b849-725e-378d-b810-511237e07b67
              name: Tuesday Happy Hour Promo
              incentive:
                type: POINTS_MULTIPLIER
                points_multiplier_data:
                  points_multiplier: 3
              available_time:
                start_date: 2022-08-16
                end_date: 2022-10-01
                time_periods:
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220816T160000
                  DURATION:PT2H
                  RRULE:FREQ=WEEKLY;UNTIL=20221001T000000;BYDAY=TU
                  END:VEVENT
              trigger_limit:
                times: 1
                interval: DAY
              status: ACTIVE
              created_at: 2022-08-16T08:38:54Z
              updated_at: 2022-08-16T08:38:54Z
              loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
        - name: Create loyalty promotion on weekdays without an end date
          pathParameters:
            program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
          bodyParameters:
            idempotency_key: 98adc7f7-6963-473b-b29c-f3c9cdd7d994
            loyalty_promotion:
              name: Happy Hour Promo
              incentive:
                type: POINTS_ADDITION
                point_addition_data:
                  points_addition: 2
              available_time:
                time_periods:
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220816T160000
                  DURATION:PT2H
                  RRULE:FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR
                  END:VEVENT
              trigger_limit:
                times: 1
                interval: DAY
          response:
            loyalty_promotion:
              id: loypromo_31e5646e-4cb9-3fb0-b1b9-64a2a3fd5cd9
              name: Happy Hour Promo
              incentive:
                type: POINTS_ADDITION
                point_addition_data:
                  points_addition: 2
              available_time:
                start_date: 2022-08-16
                time_periods:
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220816T160000
                  DURATION:PT2H
                  RRULE:FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR
                  END:VEVENT
              trigger_limit:
                times: 1
                interval: DAY
              status: ACTIVE
              created_at: 2022-08-16T08:38:54Z
              updated_at: 2022-08-16T08:38:54Z
              loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
  /v2/loyalty/programs/{program_id}/promotions/{promotion_id}:
    get:
      tags:
      - Loyalty
      summary: RetrieveLoyaltyPromotion
      description: Retrieves a loyalty promotion.
      externalDocs:
        description: Retrieve loyalty promotions
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#retrieve-loyalty-promotion
      operationId: RetrieveLoyaltyPromotion
      parameters:
      - name: promotion_id
        in: path
        description: The ID of the [loyalty promotion](entity:LoyaltyPromotion) to
          retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: program_id
        in: path
        description: |-
          The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID,
          call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveLoyaltyPromotionResponse'
      security:
      - oauth2:
        - LOYALTY_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
  /v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel:
    post:
      tags:
      - Loyalty
      summary: CancelLoyaltyPromotion
      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
      externalDocs:
        description: Cancel loyalty promotions
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#cancel-loyalty-promotion
      operationId: CancelLoyaltyPromotion
      parameters:
      - name: promotion_id
        in: path
        description: |-
          The ID of the [loyalty promotion](entity:LoyaltyPromotion) to cancel. You can cancel a
          promotion that has an `ACTIVE` or `SCHEDULED` status.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: program_id
        in: path
        description: The ID of the base [loyalty program](entity:LoyaltyProgram).
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelLoyaltyPromotionResponse'
      security:
      - oauth2:
        - LOYALTY_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
  /v2/loyalty/rewards:
    post:
      tags:
      - Loyalty
      summary: 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."
      externalDocs:
        description: Create loyalty reward
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#create-loyalty-reward
      operationId: CreateLoyaltyReward
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLoyaltyRewardRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateLoyaltyRewardResponse'
      security:
      - oauth2:
        - LOYALTY_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
  /v2/loyalty/rewards/search:
    post:
      tags:
      - Loyalty
      summary: 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."
      externalDocs:
        description: Search loyalty rewards
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#search-loyalty-rewards
      operationId: SearchLoyaltyRewards
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchLoyaltyRewardsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchLoyaltyRewardsResponse'
      security:
      - oauth2:
        - LOYALTY_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
  /v2/loyalty/rewards/{reward_id}:
    get:
      tags:
      - Loyalty
      summary: RetrieveLoyaltyReward
      description: Retrieves a loyalty reward.
      externalDocs:
        description: Retrieve loyalty reward
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#retrieve-loyalty-reward
      operationId: RetrieveLoyaltyReward
      parameters:
      - name: reward_id
        in: path
        description: The ID of the [loyalty reward](entity:LoyaltyReward) to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveLoyaltyRewardResponse'
      security:
      - oauth2:
        - LOYALTY_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
    delete:
      tags:
      - Loyalty
      summary: 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)."
      externalDocs:
        description: Delete loyalty reward
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#delete-loyalty-reward
      operationId: DeleteLoyaltyReward
      parameters:
      - name: reward_id
        in: path
        description: The ID of the [loyalty reward](entity:LoyaltyReward) to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteLoyaltyRewardResponse'
      security:
      - oauth2:
        - LOYALTY_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
  /v2/loyalty/rewards/{reward_id}/redeem:
    post:
      tags:
      - Loyalty
      summary: 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."
      externalDocs:
        description: Redeem loyalty reward
        url: https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#redeem-loyalty-reward
      operationId: RedeemLoyaltyReward
      parameters:
      - name: reward_id
        in: path
        description: The ID of the [loyalty reward](entity:LoyaltyReward) to redeem.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RedeemLoyaltyRewardRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RedeemLoyaltyRewardResponse'
      security:
      - oauth2:
        - LOYALTY_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/service.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
  /v2/merchants:
    get:
      tags:
      - Merchants
      summary: 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)\n\
        endpoint to retrieve the merchant information."
      externalDocs:
        description: Merchants API Overview
        url: https://developer.squareup.com/docs/merchants-api
      operationId: ListMerchants
      parameters:
      - name: cursor
        in: query
        description: The cursor generated by the previous response.
        required: false
        style: form
        explode: true
        schema:
          type: integer
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMerchantsResponse'
      security:
      - oauth2:
        - MERCHANT_PROFILE_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/merchant.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
  /v2/merchants/{merchant_id}:
    get:
      tags:
      - Merchants
      summary: RetrieveMerchant
      description: Retrieves the `Merchant` object for the given `merchant_id`.
      externalDocs:
        description: Merchants API Overview
        url: https://developer.squareup.com/docs/merchants-api
      operationId: RetrieveMerchant
      parameters:
      - name: merchant_id
        in: path
        description: |-
          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.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveMerchantResponse'
      security:
      - oauth2:
        - MERCHANT_PROFILE_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/merchant.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
  /v2/online-checkout/payment-links:
    get:
      tags:
      - Checkout
      summary: ListPaymentLinks
      description: Lists all payment links.
      externalDocs:
        description: Manage Checkout
        url: https://developer.squareup.com/docs/checkout-api/manage-checkout
      operationId: ListPaymentLinks
      parameters:
      - name: cursor
        in: query
        description: |-
          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/basics/api101/pagination).
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: |-
          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`
        required: false
        style: form
        explode: true
        schema:
          type: integer
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPaymentLinksResponse'
      security:
      - oauth2:
        - ORDERS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/service/online_checkout_service.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
    post:
      tags:
      - Checkout
      summary: CreatePaymentLink
      description: Creates a Square-hosted checkout page. Applications can share the
        resulting payment link with their buyer to pay for goods and services.
      externalDocs:
        description: Checkout API Overview
        url: https://developer.squareup.com/docs/checkout-api
      operationId: CreatePaymentLink
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentLinkRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePaymentLinkResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE
        - ORDERS_READ
        - ORDERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/service/online_checkout_service.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      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}:
    get:
      tags:
      - Checkout
      summary: RetrievePaymentLink
      description: Retrieves a payment link.
      externalDocs:
        description: Manage Checkout
        url: https://developer.squareup.com/docs/checkout-api/manage-checkout
      operationId: RetrievePaymentLink
      parameters:
      - name: id
        in: path
        description: The ID of link to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrievePaymentLinkResponse'
      security:
      - oauth2:
        - ORDERS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/service/online_checkout_service.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
    put:
      tags:
      - Checkout
      summary: UpdatePaymentLink
      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.
      externalDocs:
        description: Update a payment link
        url: https://developer.squareup.com/docs/checkout-api/manage-checkout#update-a-payment-link
      operationId: UpdatePaymentLink
      parameters:
      - name: id
        in: path
        description: The ID of the payment link to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePaymentLinkRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePaymentLinkResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE
        - ORDERS_READ
        - ORDERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/service/online_checkout_service.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-is-sparse-update: true
    delete:
      tags:
      - Checkout
      summary: DeletePaymentLink
      description: Deletes a payment link.
      externalDocs:
        description: Manage Checkout
        url: https://developer.squareup.com/docs/checkout-api/manage-checkout
      operationId: DeletePaymentLink
      parameters:
      - name: id
        in: path
        description: The ID of the payment link to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePaymentLinkResponse'
      security:
      - oauth2:
        - ORDERS_READ
        - ORDERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/service/online_checkout_service.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
  /v2/orders:
    post:
      tags:
      - Orders
      summary: CreateOrder
      description: "Creates a new [order](entity:Order) that can include information\
        \ about products for\npurchase and settings to apply to the purchase.\n\n\
        To 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."
      externalDocs:
        description: Create Orders
        url: https://developer.squareup.com/docs/orders-api/create-orders
      operationId: CreateOrder
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrderRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOrderResponse'
      security:
      - oauth2:
        - ORDERS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
  /v2/orders/batch-retrieve:
    post:
      tags:
      - Orders
      summary: BatchRetrieveOrders
      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.
      externalDocs:
        description: Retrieve orders
        url: https://developer.squareup.com/docs/orders-api/manage-orders#retrieve-orders
      operationId: BatchRetrieveOrders
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchRetrieveOrdersRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchRetrieveOrdersResponse'
      security:
      - oauth2:
        - ORDERS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
  /v2/orders/calculate:
    post:
      tags:
      - Orders
      summary: CalculateOrder
      description: Enables applications to preview order pricing without creating
        an order.
      externalDocs:
        description: Calculate Order
        url: https://developer.squareup.com/docs/orders-api/create-orders#calculate-order
      operationId: CalculateOrder
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalculateOrderRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculateOrderResponse'
      security:
      - oauth2: []
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
  /v2/orders/clone:
    post:
      tags:
      - Orders
      summary: 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."
      externalDocs:
        description: Clone an order
        url: https://developer.squareup.com/docs/orders-api/create-orders#clone-an-order
      operationId: CloneOrder
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloneOrderRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloneOrderResponse'
      security:
      - oauth2:
        - ORDERS_WRITE
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
  /v2/orders/search:
    post:
      tags:
      - Orders
      summary: SearchOrders
      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.
      externalDocs:
        description: Search orders
        url: https://developer.squareup.com/docs/orders-api/manage-orders#search-orders
      operationId: SearchOrders
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchOrdersRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchOrdersResponse'
      security:
      - oauth2:
        - ORDERS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
  /v2/orders/{order_id}:
    get:
      tags:
      - Orders
      summary: RetrieveOrder
      description: Retrieves an [Order](entity:Order) by ID.
      operationId: RetrieveOrder
      parameters:
      - name: order_id
        in: path
        description: The ID of the order to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveOrderResponse'
      security:
      - oauth2:
        - ORDERS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
    put:
      tags:
      - Orders
      summary: 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)\n\
        containing only the fields to update and the version to which the update is\n\
        being applied.\n- If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot-notation)\n\
        identifying 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)."
      externalDocs:
        description: Update orders
        url: https://developer.squareup.com/docs/orders-api/manage-orders#update-orders
      operationId: UpdateOrder
      parameters:
      - name: order_id
        in: path
        description: The ID of the order to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrderRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateOrderResponse'
      security:
      - oauth2:
        - ORDERS_WRITE
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-is-sparse-update: true
  /v2/orders/{order_id}/pay:
    post:
      tags:
      - Orders
      summary: PayOrder
      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.
      externalDocs:
        description: Pay for Orders
        url: https://developer.squareup.com/docs/orders-api/pay-for-orders
      operationId: PayOrder
      parameters:
      - name: order_id
        in: path
        description: The ID of the order being paid.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayOrderRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayOrderResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE
        - ORDERS_WRITE
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
  /v2/payments:
    get:
      tags:
      - Payments
      summary: ListPayments
      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.
      externalDocs:
        description: Retrieve Payments and Refunds
        url: https://developer.squareup.com/docs/payments-api/retrieve-payments
      operationId: ListPayments
      parameters:
      - name: begin_time
        in: query
        description: |-
          The timestamp for the beginning of the reporting period, in RFC 3339 format.
          Inclusive. Default: The current time minus one year.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: end_time
        in: query
        description: |-
          The timestamp for the end of the reporting period, in RFC 3339 format.

          Default: The current time.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: sort_order
        in: query
        description: |-
          The order in which results are listed:
          - `ASC` - Oldest to newest.
          - `DESC` - Newest to oldest (default).
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: cursor
        in: query
        description: |-
          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/basics/api101/pagination).
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: location_id
        in: query
        description: |-
          Limit results to the location supplied. By default, results are returned
          for the default (main) location associated with the seller.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: total
        in: query
        description: The exact amount in the `total_money` for a payment.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
      - name: last_4
        in: query
        description: The last four digits of a payment card.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: card_brand
        in: query
        description: The brand of the payment card (for example, VISA).
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: "The maximum number of results to be returned in a single page.\n\
          It 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`"
        required: false
        style: form
        explode: true
        schema:
          type: integer
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPaymentsResponse'
      security:
      - oauth2:
        - PAYMENTS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_service.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
    post:
      tags:
      - Payments
      summary: 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."
      externalDocs:
        description: Take Payments
        url: https://developer.squareup.com/docs/payments-api/take-payments
      operationId: CreatePayment
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePaymentResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_service.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-endpoint-errors:
      - error-code: ADDRESS_VERIFICATION_FAILURE
      - error-code: ALLOWABLE_PIN_TRIES_EXCEEDED
      - 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_PIN
      - error-code: INVALID_POSTAL_CODE
      - 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
      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.
      operationId: CancelPaymentByIdempotencyKey
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelPaymentByIdempotencyKeyRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPaymentByIdempotencyKeyResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_service.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
  /v2/payments/{payment_id}:
    get:
      tags:
      - Payments
      summary: GetPayment
      description: Retrieves details for a specific payment.
      externalDocs:
        description: Retrieve Payments and Refunds
        url: https://developer.squareup.com/docs/payments-api/retrieve-payments
      operationId: GetPayment
      parameters:
      - name: payment_id
        in: path
        description: A unique ID for the desired payment.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentResponse'
      security:
      - oauth2:
        - PAYMENTS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_service.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
    put:
      tags:
      - Payments
      summary: UpdatePayment
      description: |-
        Updates a payment with the APPROVED status.
        You can update the `amount_money` and `tip_money` using this endpoint.
      externalDocs:
        description: Update Payment
        url: https://developer.squareup.com/docs/payments-api/update-payments
      operationId: UpdatePayment
      parameters:
      - name: payment_id
        in: path
        description: The ID of the payment to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePaymentRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePaymentResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_service.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-endpoint-errors:
      - error-code: AMOUNT_TOO_HIGH
      - error-code: CARDHOLDER_INSUFFICIENT_PERMISSIONS
      - error-code: CHIP_INSERTION_REQUIRED
      - error-code: CVV_FAILURE
      - error-code: GENERIC_DECLINE
      - error-code: INSUFFICIENT_FUNDS
      - 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
      description: "Cancels (voids) a payment. You can use this endpoint to cancel\
        \ a payment with \nthe APPROVED `status`."
      externalDocs:
        description: Delayed capture
        url: https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment
      operationId: CancelPayment
      parameters:
      - name: payment_id
        in: path
        description: The ID of the payment to cancel.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelPaymentResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_service.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
  /v2/payments/{payment_id}/complete:
    post:
      tags:
      - Payments
      summary: CompletePayment
      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`.
      externalDocs:
        description: Delayed capture
        url: https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment
      operationId: CompletePayment
      parameters:
      - name: payment_id
        in: path
        description: The unique ID identifying the payment to be completed.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompletePaymentRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompletePaymentResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_service.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-endpoint-errors:
      - error-code: VERSION_MISMATCH
  /v2/payouts:
    get:
      tags:
      - Payouts
      summary: 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."
      externalDocs:
        description: Payouts Guide
        url: https://developer.squareup.com/docs/payouts-api/overview#list-payouts
      operationId: ListPayouts
      parameters:
      - name: location_id
        in: query
        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."
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: status
        in: query
        description: If provided, only payouts with the given status are returned.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/PayoutStatus'
      - name: begin_time
        in: query
        description: |-
          The timestamp for the beginning of the payout creation time, in RFC 3339 format.
          Inclusive. Default: The current time minus one year.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: end_time
        in: query
        description: |-
          The timestamp for the end of the payout creation time, in RFC 3339 format.
          Default: The current time.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: sort_order
        in: query
        description: The order in which payouts are listed.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/SortOrder'
      - name: cursor
        in: query
        description: |-
          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/basics/api101/pagination).
          If request parameters change between requests, subsequent results may contain duplicates or missing records.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: |-
          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`
        required: false
        style: form
        explode: true
        schema:
          type: integer
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPayoutsResponse'
      security:
      - oauth2: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payouts/payouts-proto/src/main/proto/squareup/payouts/service.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
  /v2/payouts/{payout_id}:
    get:
      tags:
      - Payouts
      summary: GetPayout
      description: "Retrieves details of a specific payout identified by a payout\
        \ ID. \nTo call this endpoint, set `PAYOUTS_READ` for the OAuth scope."
      externalDocs:
        description: Payouts Guide
        url: https://developer.squareup.com/docs/payouts-api/overview#get-payout
      operationId: GetPayout
      parameters:
      - name: payout_id
        in: path
        description: The ID of the payout to retrieve the information for.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPayoutResponse'
      security:
      - oauth2: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payouts/payouts-proto/src/main/proto/squareup/payouts/service.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
  /v2/payouts/{payout_id}/payout-entries:
    get:
      tags:
      - Payouts
      summary: ListPayoutEntries
      description: |-
        Retrieves a list of all payout entries for a specific payout.
        To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.
      externalDocs:
        description: Payouts Guide
        url: https://developer.squareup.com/docs/payouts-api/overview#list-payout-entries
      operationId: ListPayoutEntries
      parameters:
      - name: payout_id
        in: path
        description: The ID of the payout to retrieve the information for.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: sort_order
        in: query
        description: The order in which payout entries are listed.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/SortOrder'
      - name: cursor
        in: query
        description: |-
          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/basics/api101/pagination).
          If request parameters change between requests, subsequent results may contain duplicates or missing records.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: |-
          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`
        required: false
        style: form
        explode: true
        schema:
          type: integer
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPayoutEntriesResponse'
      security:
      - oauth2: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payouts/payouts-proto/src/main/proto/squareup/payouts/service.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
  /v2/refunds:
    get:
      tags:
      - Refunds
      summary: ListPaymentRefunds
      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.
      externalDocs:
        description: Retrieve Payments and Refunds
        url: https://developer.squareup.com/docs/payments-api/retrieve-payments
      operationId: ListPaymentRefunds
      parameters:
      - name: begin_time
        in: query
        description: |-
          The timestamp for the beginning of the requested reporting period, in RFC 3339 format.

          Default: The current time minus one year.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: end_time
        in: query
        description: |-
          The timestamp for the end of the requested reporting period, in RFC 3339 format.

          Default: The current time.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: sort_order
        in: query
        description: |-
          The order in which results are listed:
          - `ASC` - Oldest to newest.
          - `DESC` - Newest to oldest (default).
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: cursor
        in: query
        description: |-
          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/basics/api101/pagination).
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: location_id
        in: query
        description: |-
          Limit results to the location supplied. By default, results are returned
          for all locations associated with the seller.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: status
        in: query
        description: |-
          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.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: source_type
        in: query
        description: |-
          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.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: |-
          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
        required: false
        style: form
        explode: true
        schema:
          type: integer
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPaymentRefundsResponse'
      security:
      - oauth2:
        - PAYMENTS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_service.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
    post:
      tags:
      - Refunds
      summary: 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)."
      externalDocs:
        description: Refund a payment
        url: https://developer.squareup.com/docs/payments-api/refund-payments#refund-a-payment
      operationId: RefundPayment
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefundPaymentRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefundPaymentResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_service.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-endpoint-errors:
      - error-code: AMOUNT_TOO_HIGH
      - error-code: CARD_TOKEN_USED
      - error-code: INVALID_CARD
      - error-code: INVALID_CARD_DATA
      - error-code: PAYMENT_NOT_REFUNDABLE
      - error-code: REFUND_AMOUNT_INVALID
      - error-code: REFUND_DECLINED
      - error-code: VERSION_MISMATCH
  /v2/refunds/{refund_id}:
    get:
      tags:
      - Refunds
      summary: GetPaymentRefund
      description: Retrieves a specific refund using the `refund_id`.
      externalDocs:
        description: Retrieve refund information
        url: https://developer.squareup.com/docs/payments-api/refund-payments#retrieve-refund-information
      operationId: GetPaymentRefund
      parameters:
      - name: refund_id
        in: path
        description: The unique ID for the desired `PaymentRefund`.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentRefundResponse'
      security:
      - oauth2:
        - PAYMENTS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_service.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
  /v2/sites:
    get:
      tags:
      - Sites
      summary: ListSites
      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).
      externalDocs:
        description: List sites
        url: https://developer.squareup.com/docs/sites-api/use-the-api#list-sites
      operationId: ListSites
      parameters: []
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSitesResponse'
      security:
      - oauth2:
        - ONLINE_STORE_SITE_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /ecom-connect/protos/squareup/ecom_connect/service/ecom_connect_service.proto
      x-proto-sha: c54c1535059f8fd72c72358b3b12e2b51e50be6a
      x-not-supported-in-sandbox: true
  /v2/sites/{site_id}/snippet:
    get:
      tags:
      - Snippets
      summary: 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.

        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).
      externalDocs:
        description: Retrieve a snippet
        url: https://developer.squareup.com/docs/snippets-api/use-the-api#retrieve-snippet
      operationId: RetrieveSnippet
      parameters:
      - name: site_id
        in: path
        description: The ID of the site that contains the snippet.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveSnippetResponse'
      security:
      - oauth2:
        - ONLINE_STORE_SNIPPETS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /ecom-connect/protos/squareup/ecom_connect/service/ecom_connect_service.proto
      x-proto-sha: c54c1535059f8fd72c72358b3b12e2b51e50be6a
      x-not-supported-in-sandbox: true
    post:
      tags:
      - Snippets
      summary: 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)."
      externalDocs:
        description: Add or update a snippet
        url: https://developer.squareup.com/docs/snippets-api/use-the-api#upsert-snippet
      operationId: UpsertSnippet
      parameters:
      - name: site_id
        in: path
        description: The ID of the site where you want to add or update the snippet.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertSnippetRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpsertSnippetResponse'
      security:
      - oauth2:
        - ONLINE_STORE_SNIPPETS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /ecom-connect/protos/squareup/ecom_connect/service/ecom_connect_service.proto
      x-proto-sha: c54c1535059f8fd72c72358b3b12e2b51e50be6a
      x-not-supported-in-sandbox: true
    delete:
      tags:
      - Snippets
      summary: DeleteSnippet
      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).
      externalDocs:
        description: Delete a snippet
        url: https://developer.squareup.com/docs/snippets-api/use-the-api#delete-snippet
      operationId: DeleteSnippet
      parameters:
      - name: site_id
        in: path
        description: The ID of the site that contains the snippet.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSnippetResponse'
      security:
      - oauth2:
        - ONLINE_STORE_SNIPPETS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /ecom-connect/protos/squareup/ecom_connect/service/ecom_connect_service.proto
      x-proto-sha: c54c1535059f8fd72c72358b3b12e2b51e50be6a
      x-not-supported-in-sandbox: true
  /v2/subscriptions:
    post:
      tags:
      - Subscriptions
      summary: CreateSubscription
      description: |-
        Creates a subscription to a subscription plan by a customer.

        If you provide a card on file in the request, Square charges the card for
        the subscription. Otherwise, Square bills 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.
      externalDocs:
        description: Subscriptions Guide
        url: https://developer.squareup.com/docs/subscriptions-api/overview#create-subscriptions
      operationId: CreateSubscription
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriptionRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSubscriptionResponse'
      security:
      - oauth2:
        - CUSTOMERS_READ
        - PAYMENTS_WRITE
        - SUBSCRIPTIONS_WRITE
        - ITEMS_READ
        - ORDERS_WRITE
        - INVOICES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions_service.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-endpoint-errors:
      - error-code: CARD_PROCESSING_NOT_ENABLED
      - error-code: CUSTOMER_NOT_FOUND
      - error-code: CUSTOMER_MISSING_NAME
      - error-code: CUSTOMER_MISSING_EMAIL
      - error-code: INVALID_DATE
  /v2/subscriptions/search:
    post:
      tags:
      - Subscriptions
      summary: SearchSubscriptions
      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.

        For more information, see
        [Retrieve subscriptions](https://developer.squareup.com/docs/subscriptions-api/overview#retrieve-subscriptions).
      externalDocs:
        description: Subscriptions Guide
        url: https://developer.squareup.com/docs/subscriptions-api/overview#retrieve-subscriptions
      operationId: SearchSubscriptions
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchSubscriptionsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchSubscriptionsResponse'
      security:
      - oauth2:
        - SUBSCRIPTIONS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions_service.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-endpoint-errors:
      - error-code: CUSTOMER_NOT_FOUND
  /v2/subscriptions/{subscription_id}:
    get:
      tags:
      - Subscriptions
      summary: RetrieveSubscription
      description: Retrieves a subscription.
      externalDocs:
        description: Subscriptions Guide
        url: https://developer.squareup.com/docs/subscriptions-api/overview#retrieve-subscriptions
      operationId: RetrieveSubscription
      parameters:
      - name: subscription_id
        in: path
        description: The ID of the subscription to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: include
        in: query
        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."
        required: false
        style: form
        explode: true
        schema:
          type: string
        x-release-status: BETA
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveSubscriptionResponse'
      security:
      - oauth2:
        - SUBSCRIPTIONS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions_service.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
    put:
      tags:
      - Subscriptions
      summary: UpdateSubscription
      description: |-
        Updates a subscription. You can set, modify, and clear the
        `subscription` field values.
      externalDocs:
        description: Subscriptions Guide
        url: https://developer.squareup.com/docs/subscriptions-api/overview#update-subscriptions
      operationId: UpdateSubscription
      parameters:
      - name: subscription_id
        in: path
        description: The ID of the subscription to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSubscriptionRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSubscriptionResponse'
      security:
      - oauth2:
        - CUSTOMERS_READ
        - PAYMENTS_WRITE
        - SUBSCRIPTIONS_WRITE
        - ITEMS_READ
        - ORDERS_WRITE
        - INVOICES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions_service.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-endpoint-errors:
      - error-code: CUSTOMER_NOT_FOUND
      x-is-sparse-update: true
  /v2/subscriptions/{subscription_id}/actions/{action_id}:
    delete:
      tags:
      - Subscriptions
      summary: DeleteSubscriptionAction
      description: Deletes a scheduled action for a subscription.
      operationId: DeleteSubscriptionAction
      parameters:
      - name: subscription_id
        in: path
        description: The ID of the subscription the targeted action is to act upon.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: action_id
        in: path
        description: The ID of the targeted action to be deleted.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSubscriptionActionResponse'
      security:
      - oauth2:
        - SUBSCRIPTIONS_WRITE
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions_service.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
  /v2/subscriptions/{subscription_id}/cancel:
    post:
      tags:
      - Subscriptions
      summary: CancelSubscription
      description: "Schedules a `CANCEL` action to cancel an active subscription \n\
        by setting the `canceled_date` field to the end of the active billing period\
        \ \nand changing the subscription status from ACTIVE to CANCELED after this\
        \ date."
      externalDocs:
        description: Subscriptions Guide
        url: https://developer.squareup.com/docs/subscriptions-api/overview#cancel-subscriptions
      operationId: CancelSubscription
      parameters:
      - name: subscription_id
        in: path
        description: The ID of the subscription to cancel.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelSubscriptionResponse'
      security:
      - oauth2:
        - SUBSCRIPTIONS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions_service.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
  /v2/subscriptions/{subscription_id}/events:
    get:
      tags:
      - Subscriptions
      summary: ListSubscriptionEvents
      description: Lists all events for a specific subscription.
      externalDocs:
        description: Subscriptions Guide
        url: https://developer.squareup.com/docs/subscriptions-api/overview#subscription-events
      operationId: ListSubscriptionEvents
      parameters:
      - name: subscription_id
        in: path
        description: The ID of the subscription to retrieve the events for.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: cursor
        in: query
        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/working-with-apis/pagination)."
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: |-
          The upper limit on the number of subscription events to return
          in a paged response.
        required: false
        style: form
        explode: true
        schema:
          type: integer
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSubscriptionEventsResponse'
      security:
      - oauth2:
        - SUBSCRIPTIONS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions_service.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
  /v2/subscriptions/{subscription_id}/pause:
    post:
      tags:
      - Subscriptions
      summary: PauseSubscription
      description: Schedules a `PAUSE` action to pause an active subscription.
      externalDocs:
        description: Pause Subscriptions
        url: https://developer.squareup.com/docs/subscriptions-api/overview#pause-subscriptions
      operationId: PauseSubscription
      parameters:
      - name: subscription_id
        in: path
        description: The ID of the subscription to pause.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PauseSubscriptionRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PauseSubscriptionResponse'
      security:
      - oauth2:
        - CUSTOMERS_READ
        - PAYMENTS_WRITE
        - SUBSCRIPTIONS_WRITE
        - ITEMS_READ
        - ORDERS_WRITE
        - INVOICES_WRITE
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions_service.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      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
      description: Schedules a `RESUME` action to resume a paused or a deactivated
        subscription.
      externalDocs:
        description: Deactivated Subscriptions
        url: https://developer.squareup.com/docs/subscriptions-api/overview#deactivated-subscriptions
      operationId: ResumeSubscription
      parameters:
      - name: subscription_id
        in: path
        description: The ID of the subscription to resume.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResumeSubscriptionRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResumeSubscriptionResponse'
      security:
      - oauth2:
        - CUSTOMERS_READ
        - PAYMENTS_WRITE
        - SUBSCRIPTIONS_WRITE
        - ITEMS_READ
        - ORDERS_WRITE
        - INVOICES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions_service.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-endpoint-errors:
      - error-code: CARD_PROCESSING_NOT_ENABLED
      - error-code: CUSTOMER_NOT_FOUND
      - error-code: CUSTOMER_MISSING_NAME
      - error-code: CUSTOMER_MISSING_EMAIL
      - error-code: INVALID_DATE
  /v2/subscriptions/{subscription_id}/swap-plan:
    post:
      tags:
      - Subscriptions
      summary: SwapPlan
      description: Schedules a `SWAP_PLAN` action to swap a subscription plan in an
        existing subscription.
      externalDocs:
        description: Subscriptions Guide
        url: https://developer.squareup.com/docs/subscriptions-api/overview
      operationId: SwapPlan
      parameters:
      - name: subscription_id
        in: path
        description: The ID of the subscription to swap the subscription plan for.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SwapPlanRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SwapPlanResponse'
      security:
      - oauth2:
        - CUSTOMERS_READ
        - PAYMENTS_WRITE
        - SUBSCRIPTIONS_WRITE
        - ITEMS_READ
        - ORDERS_WRITE
        - INVOICES_WRITE
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions_service.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-endpoint-errors:
      - error-code: CARD_PROCESSING_NOT_ENABLED
      - error-code: CUSTOMER_NOT_FOUND
  /v2/team-members:
    post:
      tags:
      - Team
      summary: CreateTeamMember
      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).
      externalDocs:
        description: Set up a new team member
        url: https://developer.squareup.com/docs/team/integration#set-up-a-new-team-member
      operationId: CreateTeamMember
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTeamMemberRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTeamMemberResponse'
      security:
      - oauth2:
        - EMPLOYEES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/service.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-endpoint-errors:
      - error-code: INVALID_EMAIL_ADDRESS
  /v2/team-members/bulk-create:
    post:
      tags:
      - Team
      summary: BulkCreateTeamMembers
      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).
      externalDocs:
        description: Bulk create team members
        url: https://developer.squareup.com/docs/team/integration#bulk-create-team-members
      operationId: BulkCreateTeamMembers
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkCreateTeamMembersRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkCreateTeamMembersResponse'
      security:
      - oauth2:
        - EMPLOYEES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/service.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
  /v2/team-members/bulk-update:
    post:
      tags:
      - Team
      summary: BulkUpdateTeamMembers
      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).
      externalDocs:
        description: Bulk update team members
        url: https://developer.squareup.com/docs/team/integration#bulk-update-team-members
      operationId: BulkUpdateTeamMembers
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateTeamMembersRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkUpdateTeamMembersResponse'
      security:
      - oauth2:
        - EMPLOYEES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/service.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-is-sparse-update: true
  /v2/team-members/search:
    post:
      tags:
      - Team
      summary: SearchTeamMembers
      description: |-
        Returns a paginated list of `TeamMember` objects for a business.
        The list can be filtered by the following:
        - location IDs
        - `status`
      externalDocs:
        description: Search for team members
        url: https://developer.squareup.com/docs/team/integration#search-for-team-members
      operationId: SearchTeamMembers
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchTeamMembersRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchTeamMembersResponse'
      security:
      - oauth2:
        - EMPLOYEES_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/service.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
  /v2/team-members/{team_member_id}:
    get:
      tags:
      - Team
      summary: RetrieveTeamMember
      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).
      externalDocs:
        description: Retrieve a team member
        url: https://developer.squareup.com/docs/team/integration#retrieve-a-team-member
      operationId: RetrieveTeamMember
      parameters:
      - name: team_member_id
        in: path
        description: The ID of the team member to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveTeamMemberResponse'
      security:
      - oauth2:
        - EMPLOYEES_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/service.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
    put:
      tags:
      - Team
      summary: UpdateTeamMember
      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).
      externalDocs:
        description: Update a team member
        url: https://developer.squareup.com/docs/team/integration#update-a-team-member
      operationId: UpdateTeamMember
      parameters:
      - name: team_member_id
        in: path
        description: The ID of the team member to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTeamMemberRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateTeamMemberResponse'
      security:
      - oauth2:
        - EMPLOYEES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/service.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-is-sparse-update: true
  /v2/team-members/{team_member_id}/wage-setting:
    get:
      tags:
      - Team
      summary: RetrieveWageSetting
      description: |-
        Retrieves a `WageSetting` object for a team member specified
        by `TeamMember.id`.
        Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrievewagesetting).
      externalDocs:
        description: Retrieve a wage setting for a team member
        url: https://developer.squareup.com/docs/team/integration#retrieve-a-wage-setting-for-a-team-member
      operationId: RetrieveWageSetting
      parameters:
      - name: team_member_id
        in: path
        description: The ID of the team member for which to retrieve the wage setting.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveWageSettingResponse'
      security:
      - oauth2:
        - EMPLOYEES_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/service.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
    put:
      tags:
      - Team
      summary: UpdateWageSetting
      description: |-
        Creates or updates a `WageSetting` object. The object is created if a
        `WageSetting` with the specified `team_member_id` does not exist. Otherwise,
        it fully replaces the `WageSetting` object for the team member.
        The `WageSetting` is returned on a successful update.
        Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#create-or-update-a-wage-setting).
      externalDocs:
        description: Assign a job title and wage
        url: https://developer.squareup.com/docs/team/integration#step-2-assign-a-job-title-and-wage
      operationId: UpdateWageSetting
      parameters:
      - name: team_member_id
        in: path
        description: The ID of the team member for which to update the `WageSetting`
          object.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWageSettingRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWageSettingResponse'
      security:
      - oauth2:
        - EMPLOYEES_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/service.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
  /v2/terminals/actions:
    post:
      tags:
      - Terminal
      summary: CreateTerminalAction
      description: Creates a Terminal action request and sends it to the specified
        device.
      externalDocs:
        description: Request a Square Terminal Action
        url: https://developer.squareup.com/docs/terminal-api/square-terminal-payments#request-a-square-terminal-action
      operationId: CreateTerminalAction
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTerminalActionRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTerminalActionResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_action_service.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-endpoint-errors:
      - error-code: BAD_REQUEST
      - error-code: IDEMPOTENCY_KEY_REUSED
      - error-code: INVALID_VALUE
      - error-code: UNAUTHORIZED
  /v2/terminals/actions/search:
    post:
      tags:
      - Terminal
      summary: 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.
      externalDocs:
        description: Search for Terminal action requests
        url: https://developer.squareup.com/docs/terminal-api/square-terminal-payments#search-for-terminal-action-requests
      operationId: SearchTerminalActions
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchTerminalActionsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchTerminalActionsResponse'
      security:
      - oauth2:
        - PAYMENTS_READ
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_action_service.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      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
      description: Retrieves a Terminal action request by `action_id`. Terminal action
        requests are available for 30 days.
      operationId: GetTerminalAction
      parameters:
      - name: action_id
        in: path
        description: Unique ID for the desired `TerminalAction`
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTerminalActionResponse'
      security:
      - oauth2:
        - PAYMENTS_READ
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_action_service.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-endpoint-errors:
      - error-code: BAD_REQUEST
      - error-code: NOT_FOUND
  /v2/terminals/actions/{action_id}/cancel:
    post:
      tags:
      - Terminal
      summary: CancelTerminalAction
      description: Cancels a Terminal action request if the status of the request
        permits it.
      externalDocs:
        description: Cancel a Terminal Action
        url: https://developer.squareup.com/docs/terminal-api/square-terminal-payments#cancel-a-terminal-action
      operationId: CancelTerminalAction
      parameters:
      - name: action_id
        in: path
        description: Unique ID for the desired `TerminalAction`
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelTerminalActionRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelTerminalActionResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_action_service.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-endpoint-errors:
      - error-code: BAD_REQUEST
      - error-code: NOT_FOUND
      - error-code: TEMPORARY_ERROR
  /v2/terminals/checkouts:
    post:
      tags:
      - Terminal
      summary: CreateTerminalCheckout
      description: |-
        Creates a Terminal checkout request and sends it to the specified device to take a payment
        for the requested amount.
      externalDocs:
        description: Request a Square Terminal checkout
        url: https://developer.squareup.com/docs/terminal-api/square-terminal-payments#request-a-square-terminal-checkout
      operationId: CreateTerminalCheckout
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTerminalCheckoutRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTerminalCheckoutResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkout_service.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      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
      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.
      externalDocs:
        description: Search for Terminal checkout requests
        url: https://developer.squareup.com/docs/terminal-api/square-terminal-payments#search-for-terminal-checkout-requests
      operationId: SearchTerminalCheckouts
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchTerminalCheckoutsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchTerminalCheckoutsResponse'
      security:
      - oauth2:
        - PAYMENTS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkout_service.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      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
      description: Retrieves a Terminal checkout request by `checkout_id`. Terminal
        checkout requests are available for 30 days.
      operationId: GetTerminalCheckout
      parameters:
      - name: checkout_id
        in: path
        description: The unique ID for the desired `TerminalCheckout`.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTerminalCheckoutResponse'
      security:
      - oauth2:
        - PAYMENTS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkout_service.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-endpoint-errors:
      - error-code: BAD_REQUEST
      - error-code: NOT_FOUND
  /v2/terminals/checkouts/{checkout_id}/cancel:
    post:
      tags:
      - Terminal
      summary: CancelTerminalCheckout
      description: Cancels a Terminal checkout request if the status of the request
        permits it.
      externalDocs:
        description: Cancel a Terminal checkout
        url: https://developer.squareup.com/docs/terminal-api/square-terminal-payments#cancel-a-terminal-checkout
      operationId: CancelTerminalCheckout
      parameters:
      - name: checkout_id
        in: path
        description: The unique ID for the desired `TerminalCheckout`.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelTerminalCheckoutRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelTerminalCheckoutResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkout_service.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-endpoint-errors:
      - error-code: BAD_REQUEST
      - error-code: NOT_FOUND
  /v2/terminals/refunds:
    post:
      tags:
      - Terminal
      summary: 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).
      externalDocs:
        description: Create a Terminal refund
        url: https://developer.squareup.com/docs/terminal-api/square-terminal-refunds#create-a-terminal-refund
      operationId: CreateTerminalRefund
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTerminalRefundRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTerminalRefundResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_refund_service.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
  /v2/terminals/refunds/search:
    post:
      tags:
      - Terminal
      summary: 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.
      externalDocs:
        description: Search for Terminal refunds
        url: https://developer.squareup.com/docs/terminal-api/square-terminal-refunds#search-for-terminal-refunds
      operationId: SearchTerminalRefunds
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchTerminalRefundsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchTerminalRefundsResponse'
      security:
      - oauth2:
        - PAYMENTS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_refund_service.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
  /v2/terminals/refunds/{terminal_refund_id}:
    get:
      tags:
      - Terminal
      summary: GetTerminalRefund
      description: Retrieves an Interac Terminal refund object by ID. Terminal refund
        objects are available for 30 days.
      externalDocs:
        description: Get a Terminal refund
        url: https://developer.squareup.com/docs/terminal-api/square-terminal-refunds#get-a-terminal-refund
      operationId: GetTerminalRefund
      parameters:
      - name: terminal_refund_id
        in: path
        description: The unique ID for the desired `TerminalRefund`.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTerminalRefundResponse'
      security:
      - oauth2:
        - PAYMENTS_READ
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_refund_service.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
  /v2/terminals/refunds/{terminal_refund_id}/cancel:
    post:
      tags:
      - Terminal
      summary: CancelTerminalRefund
      description: Cancels an Interac Terminal refund request by refund request ID
        if the status of the request permits it.
      externalDocs:
        description: Cancel a Terminal refund
        url: https://developer.squareup.com/docs/terminal-api/square-terminal-refunds#cancel-a-terminal-refund
      operationId: CancelTerminalRefund
      parameters:
      - name: terminal_refund_id
        in: path
        description: The unique ID for the desired `TerminalRefund`.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelTerminalRefundRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelTerminalRefundResponse'
      security:
      - oauth2:
        - PAYMENTS_WRITE
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_refund_service.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
  /v2/vendors/bulk-create:
    post:
      tags:
      - Vendors
      summary: BulkCreateVendors
      description: Creates one or more [Vendor](entity:Vendor) objects to represent
        suppliers to a seller.
      externalDocs:
        description: Create vendors
        url: https://developer.squareup.com/docs/vendors-api/create-vendors
      operationId: BulkCreateVendors
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkCreateVendorsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkCreateVendorsResponse'
      security:
      - oauth2:
        - VENDOR_WRITE
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
  /v2/vendors/bulk-retrieve:
    post:
      tags:
      - Vendors
      summary: BulkRetrieveVendors
      description: Retrieves one or more vendors of specified [Vendor](entity:Vendor)
        IDs.
      externalDocs:
        description: Retrieve vendors
        url: https://developer.squareup.com/docs/vendors-api/retrieve-vendors
      operationId: BulkRetrieveVendors
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRetrieveVendorsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkRetrieveVendorsResponse'
      security:
      - oauth2:
        - VENDOR_READ
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
  /v2/vendors/bulk-update:
    put:
      tags:
      - Vendors
      summary: BulkUpdateVendors
      description: Updates one or more of existing [Vendor](entity:Vendor) objects
        as suppliers to a seller.
      externalDocs:
        description: Update vendors
        url: https://developer.squareup.com/docs/vendors-api/update-vendors
      operationId: BulkUpdateVendors
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateVendorsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkUpdateVendorsResponse'
      security:
      - oauth2:
        - VENDOR_WRITE
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-is-sparse-update: true
  /v2/vendors/create:
    post:
      tags:
      - Vendors
      summary: CreateVendor
      description: Creates a single [Vendor](entity:Vendor) object to represent a
        supplier to a seller.
      externalDocs:
        description: Create vendors
        url: https://developer.squareup.com/docs/vendors-api/create-vendors
      operationId: CreateVendor
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVendorRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVendorResponse'
      security:
      - oauth2:
        - VENDOR_WRITE
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
  /v2/vendors/search:
    post:
      tags:
      - Vendors
      summary: SearchVendors
      description: Searches for vendors using a filter against supported [Vendor](entity:Vendor)
        properties and a supported sorter.
      externalDocs:
        description: Search for vendors
        url: https://developer.squareup.com/docs/vendors-api/search-for-vendors
      operationId: SearchVendors
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchVendorsRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchVendorsResponse'
      security:
      - oauth2:
        - VENDOR_READ
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
  /v2/vendors/{vendor_id}:
    get:
      tags:
      - Vendors
      summary: RetrieveVendor
      description: Retrieves the vendor of a specified [Vendor](entity:Vendor) ID.
      externalDocs:
        description: Retrieve vendors
        url: https://developer.squareup.com/docs/vendors-api/retrieve-vendors
      operationId: RetrieveVendor
      parameters:
      - name: vendor_id
        in: path
        description: ID of the [Vendor](entity:Vendor) to retrieve.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveVendorResponse'
      security:
      - oauth2:
        - VENDOR_READ
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
    put:
      tags:
      - Vendors
      summary: UpdateVendor
      description: Updates an existing [Vendor](entity:Vendor) object as a supplier
        to a seller.
      externalDocs:
        description: Update vendors
        url: https://developer.squareup.com/docs/vendors-api/update-vendors
      operationId: UpdateVendor
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVendorRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateVendorResponse'
      security:
      - oauth2:
        - VENDOR_WRITE
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/inventory_service.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-is-sparse-update: true
  /v2/webhooks/event-types:
    get:
      tags:
      - WebhookSubscriptions
      summary: ListWebhookEventTypes
      description: Lists all webhook event types that can be subscribed to.
      operationId: ListWebhookEventTypes
      parameters:
      - name: api_version
        in: query
        description: The API version for which to list event types. Setting this field
          overrides the default version used by the application.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWebhookEventTypesResponse'
      security:
      - oauth2: []
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/subscriptions.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
  /v2/webhooks/subscriptions:
    get:
      tags:
      - WebhookSubscriptions
      summary: ListWebhookSubscriptions
      description: Lists all webhook subscriptions owned by your application.
      operationId: ListWebhookSubscriptions
      parameters:
      - name: cursor
        in: query
        description: |-
          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/basics/api101/pagination).
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: include_disabled
        in: query
        description: |-
          Includes disabled [Subscription](entity:WebhookSubscription)s.
          By default, all enabled [Subscription](entity:WebhookSubscription)s are returned.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: sort_order
        in: query
        description: |-
          Sorts the returned list by when the [Subscription](entity:WebhookSubscription) was created with the specified order.
          This field defaults to ASC.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/SortOrder'
      - name: limit
        in: query
        description: |-
          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
        required: false
        style: form
        explode: true
        schema:
          type: integer
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWebhookSubscriptionsResponse'
      security:
      - oauth2: []
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/subscriptions.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
    post:
      tags:
      - WebhookSubscriptions
      summary: CreateWebhookSubscription
      description: Creates a webhook subscription.
      operationId: CreateWebhookSubscription
      parameters: []
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookSubscriptionRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWebhookSubscriptionResponse'
      security:
      - oauth2: []
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/subscriptions.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
  /v2/webhooks/subscriptions/{subscription_id}:
    get:
      tags:
      - WebhookSubscriptions
      summary: RetrieveWebhookSubscription
      description: Retrieves a webhook subscription identified by its ID.
      operationId: RetrieveWebhookSubscription
      parameters:
      - name: subscription_id
        in: path
        description: '[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription)
          to retrieve.'
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveWebhookSubscriptionResponse'
      security:
      - oauth2: []
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/subscriptions.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
    put:
      tags:
      - WebhookSubscriptions
      summary: UpdateWebhookSubscription
      description: Updates a webhook subscription.
      operationId: UpdateWebhookSubscription
      parameters:
      - name: subscription_id
        in: path
        description: '[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription)
          to update.'
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWebhookSubscriptionRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWebhookSubscriptionResponse'
      security:
      - oauth2: []
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/subscriptions.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
    delete:
      tags:
      - WebhookSubscriptions
      summary: DeleteWebhookSubscription
      description: Deletes a webhook subscription.
      operationId: DeleteWebhookSubscription
      parameters:
      - name: subscription_id
        in: path
        description: '[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription)
          to delete.'
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWebhookSubscriptionResponse'
      security:
      - oauth2: []
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/subscriptions.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
  /v2/webhooks/subscriptions/{subscription_id}/signature-key:
    post:
      tags:
      - WebhookSubscriptions
      summary: UpdateWebhookSubscriptionSignatureKey
      description: Updates a webhook subscription by replacing the existing signature
        key with a new one.
      operationId: UpdateWebhookSubscriptionSignatureKey
      parameters:
      - name: subscription_id
        in: path
        description: '[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription)
          to update.'
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWebhookSubscriptionSignatureKeyRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWebhookSubscriptionSignatureKeyResponse'
      security:
      - oauth2: []
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/subscriptions.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
  /v2/webhooks/subscriptions/{subscription_id}/test:
    post:
      tags:
      - WebhookSubscriptions
      summary: TestWebhookSubscription
      description: Tests a webhook subscription by sending a test event to the notification
        URL.
      operationId: TestWebhookSubscription
      parameters:
      - name: subscription_id
        in: path
        description: '[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription)
          to test.'
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: |-
          An object containing the fields to POST for the request.

          See the corresponding object definition for field details.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestWebhookSubscriptionRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestWebhookSubscriptionResponse'
      security:
      - oauth2: []
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/subscriptions.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
components:
  schemas:
    LoyaltyAccountMappingType:
      type: string
      description: The type of mapping.
      enum:
      - TYPE_DO_NOT_USE
      - PHONE
      x-enum-elements:
      - name: PHONE
        description: The loyalty account is mapped by phone.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-account.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyAccountMappingType
    LoyaltyEventSource:
      type: string
      description: Defines whether the event was generated by the Square Point of
        Sale.
      enum:
      - SOURCE_DO_NOT_USE
      - SQUARE
      - LOYALTY_API
      x-enum-elements:
      - name: SQUARE
        description: The event is generated by the Square Point of Sale (POS).
        x-release-status: PUBLIC
      - name: LOYALTY_API
        description: The event is generated by something other than the Square Point
          of Sale that used the Loyalty API.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-event.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEventSource
    LoyaltyEventType:
      type: string
      description: The type of the loyalty event.
      enum:
      - TYPE_DO_NOT_USE
      - CREATE_ACCOUNT
      - 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
          qualified for points based on an [accrual rule](entity:LoyaltyProgramAccrualRule).
        x-release-status: PUBLIC
      - name: CREATE_REWARD
        description: A [loyalty reward](entity:LoyaltyReward) is created.
        x-release-status: PUBLIC
      - name: REDEEM_REWARD
        description: A loyalty reward is redeemed.
        x-release-status: PUBLIC
      - name: DELETE_REWARD
        description: A loyalty reward is deleted.
        x-release-status: PUBLIC
      - name: ADJUST_POINTS
        description: Loyalty points are manually adjusted.
        x-release-status: PUBLIC
      - name: EXPIRE_POINTS
        description: "Loyalty points are expired according to the \nexpiration policy\
          \ of the loyalty program."
        x-release-status: PUBLIC
      - name: OTHER
        description: Some other loyalty event occurred.
        x-release-status: PUBLIC
      - name: ACCUMULATE_PROMOTION_POINTS
        description: |2-
           Points are added to a loyalty account for a purchase that
          qualified for a [loyalty promotion](entity:LoyaltyPromotion).
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-event.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEventType
    LoyaltyProgramAccrualRuleTaxMode:
      type: string
      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."
      enum:
      - TAX_MODE_DO_NOT_USE
      - BEFORE_TAX
      - AFTER_TAX
      x-enum-elements:
      - name: BEFORE_TAX
        description: Exclude taxes from the purchase amount used for loyalty points
          accrual.
        x-release-status: PUBLIC
      - name: AFTER_TAX
        description: Include taxes in the purchase amount used for loyalty points
          accrual.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-program.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyProgramAccrualRuleTaxMode
    LoyaltyProgramAccrualRuleType:
      type: string
      description: The type of the accrual rule that defines how buyers can earn points.
      enum:
      - TYPE_DO_NOT_USE
      - 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."
        x-release-status: PUBLIC
      - name: SPEND
        description: "A spend-based accrual rule. A buyer earns points based on the\
          \ amount \nspent."
        x-release-status: PUBLIC
      - name: ITEM_VARIATION
        description: "An accrual rule based on an item variation. For example, accrue\
          \ \npoints for purchasing a coffee."
        x-release-status: PUBLIC
      - 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."
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-program.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyProgramAccrualRuleType
    LoyaltyProgramRewardDefinitionScope:
      type: string
      description: |-
        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).
      enum:
      - SCOPE_DO_NOT_USE
      - ORDER
      - ITEM_VARIATION
      - CATEGORY
      x-enum-elements:
      - name: ORDER
        description: The discount applies to the entire order.
        x-release-status: DEPRECATED
      - name: ITEM_VARIATION
        description: The discount applies only to specific item variations.
        x-release-status: DEPRECATED
      - name: CATEGORY
        description: The discount applies only to items in the given categories.
        x-release-status: DEPRECATED
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-program.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyProgramRewardDefinitionScope
    LoyaltyProgramRewardDefinitionType:
      type: string
      description: |-
        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).
      enum:
      - TYPE_DO_NOT_USE
      - FIXED_AMOUNT
      - FIXED_PERCENTAGE
      x-enum-elements:
      - name: FIXED_AMOUNT
        description: The fixed amount discounted.
        x-release-status: DEPRECATED
      - name: FIXED_PERCENTAGE
        description: The fixed percentage discounted.
        x-release-status: DEPRECATED
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-program.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyProgramRewardDefinitionType
    LoyaltyProgramStatus:
      type: string
      description: Indicates whether the program is currently active.
      enum:
      - STATUS_DO_NOT_USE
      - INACTIVE
      - ACTIVE
      x-enum-elements:
      - name: INACTIVE
        description: "The loyalty program does not have an active subscription. \n\
          Loyalty API requests fail."
        x-release-status: PUBLIC
      - name: ACTIVE
        description: The program is fully functional. The program has an active subscription.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-program.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyProgramStatus
    LoyaltyPromotionStatus:
      type: string
      description: Indicates the status of a [loyalty promotion](entity:LoyaltyPromotion).
      enum:
      - TYPE_DO_NOT_USE
      - UPCOMING
      - ACTIVE
      - ENDED
      - CANCELED
      - SCHEDULED
      x-enum-elements:
      - name: ACTIVE
        description: |-
          The loyalty promotion is currently active. Buyers can earn points for purchases
          that meet the promotion conditions, such as the promotion's `available_time`.
        x-release-status: PUBLIC
      - name: ENDED
        description: |-
          The loyalty promotion has ended because the specified `end_date` was reached.
          `ENDED` is a terminal status.
        x-release-status: PUBLIC
      - name: CANCELED
        description: The loyalty promotion was canceled. `CANCELED` is a terminal
          status.
        x-release-status: PUBLIC
      - name: SCHEDULED
        description: |-
          The loyalty promotion is scheduled to start in the future. Square changes the
          promotion status to `ACTIVE` when the `start_date` is reached.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-promotion.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyPromotionStatus
    LoyaltyPromotionIncentiveType:
      type: string
      description: |-
        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.
      enum:
      - TYPE_DO_NOT_USE
      - POINTS_MULTIPLIER
      - POINTS_ADDITION
      x-enum-elements:
      - name: POINTS_MULTIPLIER
        description: |-
          Multiply the number of points earned from the base loyalty program.
          For example, "Earn double points."
        x-release-status: PUBLIC
      - name: POINTS_ADDITION
        description: |-
          Add a specified number of points to those earned from the base loyalty program.
          For example, "Earn 10 additional points."
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-promotion.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyPromotionIncentiveType
    LoyaltyPromotionTriggerLimitInterval:
      type: string
      description: |-
        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).
      enum:
      - TYPE_DO_NOT_USE
      - 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`
          is set to 1 and `time_period` is set to `ALL_TIME`, a buyer can earn promotion points a maximum
          of one time during the promotion.
        x-release-status: PUBLIC
      - name: DAY
        description: |-
          The limit applies per day, according to the `available_time` schedule specified for the promotion.
          For example, if the `times` field of the trigger limit is set to 1, a buyer can trigger the promotion
          a maximum of once per day.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-promotion.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyPromotionTriggerLimitInterval
    LoyaltyRewardStatus:
      type: string
      description: The status of the loyalty reward.
      enum:
      - STATUS_DO_NOT_USE
      - ISSUED
      - REDEEMED
      - DELETED
      x-enum-elements:
      - name: ISSUED
        description: The reward is issued.
        x-release-status: PUBLIC
      - name: REDEEMED
        description: The reward is redeemed.
        x-release-status: PUBLIC
      - name: DELETED
        description: The reward is deleted.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-reward.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyRewardStatus
    CashDrawerEventType:
      type: string
      description: |-
        The types of events on a CashDrawerShift.
        Each event type represents an employee action on the actual cash drawer
        represented by a CashDrawerShift.
      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.
          A CashDrawerEvent of this type must have a zero money amount.
        x-release-status: PUBLIC
      - name: CASH_TENDER_PAYMENT
        description: |-
          Triggered when a cash tender payment occurs on a cash drawer.
          A CashDrawerEvent of this type can must not have a negative amount.
        x-release-status: PUBLIC
      - name: OTHER_TENDER_PAYMENT
        description: |-
          Triggered when a check, gift card, or other non-cash payment occurs
          on a cash drawer.
          A CashDrawerEvent of this type must have a zero money amount.
        x-release-status: PUBLIC
      - name: CASH_TENDER_CANCELLED_PAYMENT
        description: |-
          Triggered when a split tender bill is cancelled after cash has been
          tendered.
          A CASH_TENDER_CANCELLED_PAYMENT should have a corresponding CASH_TENDER_PAYMENT.
          A CashDrawerEvent of this type must not have a negative amount.
        x-release-status: PUBLIC
      - name: OTHER_TENDER_CANCELLED_PAYMENT
        description: |-
          Triggered when a split tender bill is cancelled after a non-cash tender
          has been tendered. An OTHER_TENDER_CANCELLED_PAYMENT should have a corresponding
          OTHER_TENDER_PAYMENT. A CashDrawerEvent of this type must have a zero money
          amount.
        x-release-status: PUBLIC
      - name: CASH_TENDER_REFUND
        description: |-
          Triggered when a cash tender refund occurs.
          A CashDrawerEvent of this type must not have a negative amount.
        x-release-status: PUBLIC
      - name: OTHER_TENDER_REFUND
        description: |-
          Triggered when an other tender refund occurs.
          A CashDrawerEvent of this type must have a zero money amount.
        x-release-status: PUBLIC
      - name: PAID_IN
        description: |-
          Triggered when money unrelated to a payment is added to the cash drawer.
          For example, an employee adds coins to the drawer.
          A CashDrawerEvent of this type must not have a negative amount.
        x-release-status: PUBLIC
      - name: PAID_OUT
        description: |-
          Triggered when money is removed from the drawer for other reasons
          than making change.
          For example, an employee pays a delivery person with cash from the cash drawer.
          A CashDrawerEvent of this type must not have a negative amount.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /cashdrawers/cashdrawers-proto/src/main/proto/squareup/cashdrawers/api/v2/connect/enum.proto
      x-proto-sha: 06291dbd5e7115613debe29fc712a6c8b9bd195e
      x-object-name: CashDrawerEventType
    CashDrawerShiftState:
      type: string
      description: The current state of a cash drawer shift.
      enum:
      - OPEN
      - ENDED
      - CLOSED
      x-enum-elements:
      - name: OPEN
        description: An open cash drawer shift.
        x-release-status: PUBLIC
      - name: ENDED
        description: A cash drawer shift that is ended but has not yet had an employee
          content audit.
        x-release-status: PUBLIC
      - name: CLOSED
        description: |-
          An ended cash drawer shift that is closed with a completed employee
          content audit and recorded result.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /cashdrawers/cashdrawers-proto/src/main/proto/squareup/cashdrawers/api/v2/connect/enum.proto
      x-proto-sha: 06291dbd5e7115613debe29fc712a6c8b9bd195e
      x-object-name: CashDrawerShiftState
    ActionCancelReason:
      type: string
      enum:
      - ACTION_CANCEL_REASON_DO_NOT_USE
      - BUYER_CANCELED
      - SELLER_CANCELED
      - TIMED_OUT
      - UNSUPPORTED
      x-enum-elements:
      - name: BUYER_CANCELED
        description: A person canceled the `TerminalCheckout` from a Square device.
        x-release-status: PUBLIC
      - name: SELLER_CANCELED
        description: A client canceled the `TerminalCheckout` using the API.
        x-release-status: PUBLIC
      - name: TIMED_OUT
        description: The `TerminalCheckout` timed out (see `deadline_duration` on
          the `TerminalCheckout`).
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_common.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: ActionCancelReason
    ApplicationDetailsExternalSquareProduct:
      type: string
      description: A list of products to return to external callers.
      enum:
      - APPOINTMENTS
      - ECOMMERCE_API
      - INVOICES
      - ONLINE_STORE
      - OTHER
      - RESTAURANTS
      - RETAIL
      - SQUARE_POS
      - TERMINAL_API
      - VIRTUAL_TERMINAL
      x-enum-elements:
      - name: APPOINTMENTS
        description: ""
        x-release-status: PUBLIC
      - name: ECOMMERCE_API
        description: ""
        x-release-status: PUBLIC
      - name: INVOICES
        description: ""
        x-release-status: PUBLIC
      - name: ONLINE_STORE
        description: ""
        x-release-status: PUBLIC
      - name: OTHER
        description: ""
        x-release-status: PUBLIC
      - name: RESTAURANTS
        description: ""
        x-release-status: PUBLIC
      - name: RETAIL
        description: ""
        x-release-status: PUBLIC
      - name: SQUARE_POS
        description: ""
        x-release-status: PUBLIC
      - name: TERMINAL_API
        description: ""
        x-release-status: PUBLIC
      - name: VIRTUAL_TERMINAL
        description: ""
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_model.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: ApplicationDetailsExternalSquareProduct
    BankAccountStatus:
      type: string
      description: Indicates the current verification status of a `BankAccount` object.
      enum:
      - VERIFICATION_IN_PROGRESS
      - VERIFIED
      - DISABLED
      x-enum-elements:
      - name: VERIFICATION_IN_PROGRESS
        description: |-
          Indicates that the verification process has started. Some features
          (for example, creditable or debitable) may be provisionally enabled on the bank
          account.
        x-release-status: PUBLIC
      - name: VERIFIED
        description: Indicates that the bank account was successfully verified.
        x-release-status: PUBLIC
      - name: DISABLED
        description: |-
          Indicates that the bank account is disabled and is permanently unusable
          for funds transfer. A bank account can be disabled because of a failed verification
          attempt or a failed deposit attempt.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/bank_accounts.proto
      x-proto-sha: dc1003a64eea24f147d72da44df7237577699575
      x-object-name: BankAccountStatus
      x-namespace: marketplaces
    BankAccountType:
      type: string
      description: Indicates the financial purpose of the bank account.
      enum:
      - UNKNOWN
      - CHECKING
      - SAVINGS
      - INVESTMENT
      - OTHER
      - BUSINESS_CHECKING
      x-enum-elements:
      - name: CHECKING
        description: |-
          An account at a financial institution against which checks can be
          drawn by the account depositor.
        x-release-status: PUBLIC
      - name: SAVINGS
        description: |-
          An account at a financial institution that pays interest but cannot be
          used directly as money in the narrow sense of a medium of exchange.
        x-release-status: PUBLIC
      - name: INVESTMENT
        description: |-
          An account at a financial institution that contains a deposit of funds
          and/or securities.
        x-release-status: PUBLIC
      - name: OTHER
        description: |-
          An account at a financial institution which cannot be described by the
          other types.
        x-release-status: PUBLIC
      - name: BUSINESS_CHECKING
        description: |-
          An account at a financial institution against which checks can be
          drawn specifically for business purposes (non-personal use).
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/bank_accounts.proto
      x-proto-sha: dc1003a64eea24f147d72da44df7237577699575
      x-object-name: BankAccountType
      x-namespace: marketplaces
    BatchRequestHttpMethod:
      type: string
      description: Indicates the applicable HTTP method.
      enum:
      - GET
      - POST
      - PUT
      - DELETE
      x-enum-elements:
      - name: GET
        description: ""
        x-release-status: DEPRECATED
      - name: POST
        description: ""
        x-release-status: DEPRECATED
      - name: PUT
        description: ""
        x-release-status: DEPRECATED
      - name: DELETE
        description: ""
        x-release-status: DEPRECATED
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1batch.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: BatchRequestHttpMethod
      x-visibility: DOC_ONLY
    ChangeTiming:
      type: string
      description: Supported timings when a pending change, as an action, takes place
        to a subscription.
      enum:
      - DEFAULT_CHANGE_TIMING_TYPE_DO_NOT_USE
      - IMMEDIATE
      - END_OF_BILLING_CYCLE
      x-enum-elements:
      - name: IMMEDIATE
        description: The action occurs immediately.
        x-release-status: BETA
      - name: END_OF_BILLING_CYCLE
        description: The action occurs at the end of the billing cycle.
        x-release-status: BETA
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: ChangeTiming
    CheckoutOptionsPaymentType:
      type: string
      enum:
      - PAYMENT_TYPE_DO_NOT_USE
      - CARD_PRESENT
      - MANUAL_CARD_ENTRY
      - FELICA_ID
      - FELICA_QUICPAY
      - FELICA_TRANSPORTATION_GROUP
      - FELICA_ALL
      - PAYPAY
      x-enum-elements:
      - name: CARD_PRESENT
        description: Accept credit card or debit card payments via tap, dip or swipe.
        x-release-status: PUBLIC
      - name: MANUAL_CARD_ENTRY
        description: Launches the manual credit or debit card entry screen for the
          buyer to complete.
        x-release-status: PUBLIC
      - name: FELICA_ID
        description: Launches the iD checkout screen for the buyer to complete.
        x-release-status: PUBLIC
      - name: FELICA_QUICPAY
        description: Launches the QUICPay checkout screen for the buyer to complete.
        x-release-status: PUBLIC
      - name: FELICA_TRANSPORTATION_GROUP
        description: Launches the Transportation Group checkout screen for the buyer
          to complete.
        x-release-status: PUBLIC
      - name: FELICA_ALL
        description: |-
          Launches a checkout screen for the buyer on the Square Terminal that
          allows them to select a specific FeliCa brand or select the check balance screen.
        x-release-status: PUBLIC
      - name: PAYPAY
        description: Launches the PayPay checkout screen for the buyer to complete.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkout_options.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: CheckoutOptionsPaymentType
    DisputeEvidenceType:
      type: string
      description: The type of the dispute evidence.
      enum:
      - UNKNOWN_TYPE
      - 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.

          Use when uploading evidence as a file or string.
        x-release-status: PUBLIC
      - name: ONLINE_OR_APP_ACCESS_LOG
        description: |-
          Server or activity logs that show proof of the cardholder’s identity and that the
          cardholder successfully ordered and received the goods (digitally or otherwise).
          Example evidence includes IP addresses, corresponding timestamps/dates, cardholder’s name and email
          address linked to a cardholder profile held by the seller, proof the same device and card (used
          in dispute) were previously used in prior undisputed transaction, and any related detailed activity.

          Use when uploading evidence as a file or string.
        x-release-status: PUBLIC
      - name: AUTHORIZATION_DOCUMENTATION
        description: |-
          Evidence that the cardholder did provide authorization for the charge.
          Example evidence includes a signed credit card authorization.

          Use when uploading evidence as a file.
        x-release-status: PUBLIC
      - name: CANCELLATION_OR_REFUND_DOCUMENTATION
        description: |-
          Evidence that the cardholder acknowledged your refund or cancellation policy.
          Example evidence includes a signature or checkbox showing the cardholder’s acknowledgement of your
          refund or cancellation policy.

          Use when uploading evidence as a file or string.
        x-release-status: PUBLIC
      - name: CARDHOLDER_COMMUNICATION
        description: |-
          Evidence that shows relevant communication with the cardholder.
          Example evidence includes emails or texts that show the cardholder received goods/services or
          demonstrate cardholder satisfaction.

          Use when uploading evidence as a file.
        x-release-status: PUBLIC
      - name: CARDHOLDER_INFORMATION
        description: |-
          Evidence that validates the customer's identity.
          Example evidence includes personally identifiable details such as name, email address, purchaser IP
          address, and a copy of the cardholder ID.

          Use when uploading evidence as a file or string.
        x-release-status: PUBLIC
      - name: PURCHASE_ACKNOWLEDGEMENT
        description: |-
          Evidence that shows proof of the sale/transaction.
          Example evidence includes an invoice, contract, or other item showing the customer’s acknowledgement
          of the purchase and your terms.

          Use when uploading evidence as a file or string.
        x-release-status: PUBLIC
      - name: DUPLICATE_CHARGE_DOCUMENTATION
        description: |-
          Evidence that shows the charges in question are valid and distinct from one another.
          Example evidence includes receipts, shipping labels, and invoices along with their distinct payment IDs.

          Use when uploading evidence as a file.
        x-release-status: PUBLIC
      - name: PRODUCT_OR_SERVICE_DESCRIPTION
        description: |-
          A description of the product or service sold.

          Use when uploading evidence as a file or string.
        x-release-status: PUBLIC
      - name: RECEIPT
        description: |-
          A receipt or message sent to the cardholder detailing the charge.
          Note: You do not need to upload the Square receipt; Square submits the receipt on your behalf.

          Use when uploading evidence as a file or string.
        x-release-status: PUBLIC
      - name: SERVICE_RECEIVED_DOCUMENTATION
        description: |-
          Evidence that the service was provided to the cardholder or the expected date that services will be rendered.
          Example evidence includes a signed delivery form, work order, expected delivery date, or other written agreements.

          Use when uploading evidence as a file or string.
        x-release-status: PUBLIC
      - name: PROOF_OF_DELIVERY_DOCUMENTATION
        description: |-
          Evidence that shows the product was provided to the cardholder or the expected date of delivery.
          Example evidence includes a signed delivery form or written agreement acknowledging receipt of the goods or services.

          Use when uploading evidence as a file or string.
        x-release-status: PUBLIC
      - name: RELATED_TRANSACTION_DOCUMENTATION
        description: |-
          Evidence that shows the cardholder previously processed transactions on the same card and did not dispute them.
          Note: Square automatically provides up to five distinct Square receipts for related transactions, when available.

          Use when uploading evidence as a file or string.
        x-release-status: PUBLIC
      - name: REBUTTAL_EXPLANATION
        description: |-
          An explanation of why the cardholder’s claim is invalid.
          Example evidence includes an explanation of why each distinct charge is a legitimate purchase, why the cardholder’s claim
          for credit owed due to their attempt to cancel, return, or refund is invalid per your stated policy and cardholder
          agreement, or an explanation of how the cardholder did not attempt to remedy the issue with you first to receive credit.

          Use when uploading evidence as a file or string.
        x-release-status: PUBLIC
      - name: TRACKING_NUMBER
        description: |-
          The tracking number for the order provided by the shipping carrier. If you have multiple numbers, they need to be
          submitted individually as separate pieces of evidence.

          Use when uploading evidence as a string.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_evidence.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: DisputeEvidenceType
    DisputeReason:
      type: string
      description: |-
        The list of possible reasons why a cardholder might initiate a
        dispute with their bank.
      enum:
      - UNKNOWN_REASON
      - AMOUNT_DIFFERS
      - CANCELLED
      - COMPLIANCE
      - DISSATISFIED
      - DUPLICATE
      - FRAUD
      - NO_KNOWLEDGE
      - NOT_AS_DESCRIBED
      - NOT_RECEIVED
      - PAID_BY_OTHER_MEANS
      - CUSTOMER_REQUESTS_CREDIT
      - UNAUTHORIZED
      - RETURNED
      - INSUFFICIENT_RESPONSE
      - REQUEST_DOCUMENTATION
      - EMV_LIABILITY_SHIFT
      x-enum-elements:
      - name: AMOUNT_DIFFERS
        description: |-
          The cardholder claims that they were charged the wrong amount for the purchase.
          To challenge this dispute, provide specific and concrete evidence that the cardholder agreed
          to the amount charged.
        x-release-status: PUBLIC
      - name: CANCELLED
        description: |-
          The cardholder claims that they attempted to return the goods or cancel the service.
          To challenge this dispute, provide specific and concrete evidence to prove that the cardholder
          is not due a refund and that the cardholder acknowledged your cancellation policy.
        x-release-status: PUBLIC
      - name: DUPLICATE
        description: |-
          The cardholder claims that they were charged twice for the same purchase.
          To challenge this dispute, provide specific and concrete evidence that shows both charges are
          legitimate and independent of one another.
        x-release-status: PUBLIC
      - name: NO_KNOWLEDGE
        description: |-
          The cardholder claims that they did not make this purchase nor authorized the charge.
          To challenge this dispute, provide specific and concrete evidence that proves that the cardholder
          identity was verified at the time of purchase and that the purchase was authorized.
        x-release-status: PUBLIC
      - name: NOT_AS_DESCRIBED
        description: |-
          The cardholder claims the product or service was provided, but the quality of the deliverable
          did not align with the expectations of the cardholder based on the description.
          To challenge this dispute, provide specific and concrete evidence that shows the cardholder is in
          possession of the product as described or received the service as described and agreed on.
        x-release-status: PUBLIC
      - name: NOT_RECEIVED
        description: |-
          The cardholder claims the product or service was not received by the cardholder within the
          stated time frame.
          To challenge this dispute, provide specific and concrete evidence to prove that the cardholder is
          in possession of or received the product or service sold.
        x-release-status: PUBLIC
      - name: PAID_BY_OTHER_MEANS
        description: |-
          The cardholder claims that they previously paid for this purchase.
          To challenge this dispute, provide specific and concrete evidence that shows both charges are
          legitimate and independent of one another or proof that you already provided a credit for the charge.
        x-release-status: PUBLIC
      - name: CUSTOMER_REQUESTS_CREDIT
        description: |-
          The cardholder claims that the purchase was canceled or returned, but they have not yet received
          the credit.
          To challenge this dispute, provide specific and concrete evidence to prove that the cardholder is not
          due a refund and that they acknowledged your cancellation and/or refund policy.
        x-release-status: PUBLIC
      - name: EMV_LIABILITY_SHIFT
        description: |-
          A chip-enabled card was not processed through a compliant chip-card reader (for example, it was swiped
          instead of dipped into a chip-card reader).
          You cannot challenge this dispute because the payment did not comply with EMV security requirements.
          For more information, see [What Is EMV?](https://squareup.com/emv)
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: DisputeReason
    DisputeState:
      type: string
      description: The list of possible dispute states.
      enum:
      - UNKNOWN_STATE
      - INQUIRY_EVIDENCE_REQUIRED
      - INQUIRY_PROCESSING
      - INQUIRY_CLOSED
      - EVIDENCE_REQUIRED
      - PROCESSING
      - WON
      - LOST
      - ACCEPTED
      - WAITING_THIRD_PARTY
      x-enum-elements:
      - name: INQUIRY_EVIDENCE_REQUIRED
        description: The initial state of an inquiry with evidence required
        x-release-status: PUBLIC
      - name: INQUIRY_PROCESSING
        description: Inquiry evidence has been submitted and the bank is processing
          the inquiry
        x-release-status: PUBLIC
      - name: INQUIRY_CLOSED
        description: The inquiry is complete
        x-release-status: PUBLIC
      - name: EVIDENCE_REQUIRED
        description: The initial state of a dispute with evidence required
        x-release-status: PUBLIC
      - name: PROCESSING
        description: Dispute evidence has been submitted and the bank is processing
          the dispute
        x-release-status: PUBLIC
      - name: WON
        description: The bank has completed processing the dispute and the seller
          has won
        x-release-status: PUBLIC
      - name: LOST
        description: The bank has completed processing the dispute and the seller
          has lost
        x-release-status: PUBLIC
      - name: ACCEPTED
        description: The seller has accepted the dispute
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: DisputeState
    RiskEvaluationRiskLevel:
      type: string
      enum:
      - DO_NOT_USE
      - PENDING
      - NORMAL
      - MODERATE
      - HIGH
      x-enum-elements:
      - name: PENDING
        description: Indicates Square is still evaluating the payment.
        x-release-status: BETA
      - name: NORMAL
        description: Indicates payment risk is within the normal range.
        x-release-status: BETA
      - name: MODERATE
        description: Indicates elevated risk level associated with the payment.
        x-release-status: BETA
      - name: HIGH
        description: Indicates significantly elevated risk level with the payment.
        x-release-status: BETA
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /riskml-common/risk-evaluation-external/src/main/proto/squareup/riskevaluation/external/risk_evaluation.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: RiskEvaluationRiskLevel
    SubscriptionActionType:
      type: string
      description: Supported types of an action as a pending change to a subscription.
      enum:
      - DEFAULT_SUBSCRIPTION_ACTION_TYPE_DO_NOT_USE
      - CANCEL
      - PAUSE
      - RESUME
      - SWAP_PLAN
      x-enum-elements:
      - name: CANCEL
        description: The action to execute a scheduled cancellation of a subscription.
        x-release-status: BETA
      - name: PAUSE
        description: The action to execute a scheduled pause of a subscription.
        x-release-status: BETA
      - name: RESUME
        description: The action to execute a scheduled resumption of a subscription.
        x-release-status: BETA
      - name: SWAP_PLAN
        description: The action to execute a scheduled swap of a subscription plan
          in a subscription.
        x-release-status: BETA
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: SubscriptionActionType
    SubscriptionEventInfoCode:
      type: string
      description: Supported info codes of a subscription event.
      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.
        x-release-status: PUBLIC
      - name: LOCATION_CANNOT_ACCEPT_PAYMENT
        description: The location cannot accept payments.
        x-release-status: PUBLIC
      - name: CUSTOMER_DELETED
        description: The subscribing customer profile has been deleted.
        x-release-status: PUBLIC
      - name: CUSTOMER_NO_EMAIL
        description: The subscribing customer does not have an email.
        x-release-status: PUBLIC
      - name: CUSTOMER_NO_NAME
        description: The subscribing customer does not have a name.
        x-release-status: PUBLIC
      - name: USER_PROVIDED
        description: User-provided detail.
        x-release-status: BETA
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: SubscriptionEventInfoCode
    SubscriptionEventSubscriptionEventType:
      type: string
      description: Supported types of an event occurred to a subscription.
      enum:
      - DEFAULT_SUBSCRIPTION_EVENT_TYPE_DO_NOT_USE
      - START_SUBSCRIPTION
      - PLAN_CHANGE
      - STOP_SUBSCRIPTION
      - DEACTIVATE_SUBSCRIPTION
      - RESUME_SUBSCRIPTION
      - PAUSE_SUBSCRIPTION
      x-enum-elements:
      - name: START_SUBSCRIPTION
        description: The subscription was started.
        x-release-status: PUBLIC
      - name: PLAN_CHANGE
        description: The subscription plan was changed.
        x-release-status: PUBLIC
      - name: STOP_SUBSCRIPTION
        description: The subscription was stopped.
        x-release-status: PUBLIC
      - name: DEACTIVATE_SUBSCRIPTION
        description: The subscription was deactivated
        x-release-status: PUBLIC
      - name: RESUME_SUBSCRIPTION
        description: The subscription was resumed.
        x-release-status: PUBLIC
      - name: PAUSE_SUBSCRIPTION
        description: The subscription was paused.
        x-release-status: BETA
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: SubscriptionEventSubscriptionEventType
    SubscriptionStatus:
      type: string
      description: Supported subscription statuses.
      enum:
      - DEFAULT_SUBSCRIPTION_STATUS_DO_NOT_USE
      - PENDING
      - ACTIVE
      - CANCELED
      - DEACTIVATED
      - PAUSED
      x-enum-elements:
      - name: PENDING
        description: The subscription is pending to start in the future.
        x-release-status: PUBLIC
      - name: ACTIVE
        description: The subscription is active.
        x-release-status: PUBLIC
      - name: CANCELED
        description: The subscription is canceled.
        x-release-status: PUBLIC
      - name: DEACTIVATED
        description: The subscription is deactivated.
        x-release-status: PUBLIC
      - name: PAUSED
        description: The subscription is paused.
        x-release-status: BETA
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: SubscriptionStatus
    TerminalActionActionType:
      type: string
      description: Describes the type of this unit and indicates which field contains
        the unit information. This is an ‘open’ enum.
      enum:
      - INVALID_TYPE
      - UNSUPPORTED_ACTION_TYPE
      - CHECKOUT
      - REFUND
      - QR_CODE
      - PING
      - SAVE_CARD
      - SIGNATURE
      - CONFIRMATION
      - RECEIPT
      - DATA_COLLECTION
      - SELECT
      - STACK
      - CONFIG
      x-enum-elements:
      - name: PING
        description: |-
          The action represents a request to check if the specific device is
          online or currently active with the merchant in question. Does not require an action options value.
        x-release-status: BETA
      - name: SAVE_CARD
        description: Represents a request to save a card for future card-on-file use.
        x-release-status: BETA
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_actions.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: TerminalActionActionType
    TransactionType:
      type: string
      description: The transaction type used in the disputed payment.
      enum:
      - DEBIT
      - CREDIT
      x-enum-elements:
      - name: DEBIT
        description: ""
        x-release-status: PUBLIC
      - name: CREDIT
        description: ""
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: TransactionType
    V1CreateRefundRequestType:
      type: string
      enum:
      - FULL
      - PARTIAL
      x-enum-elements:
      - name: FULL
        description: ""
        x-release-status: DEPRECATED
      - name: PARTIAL
        description: ""
        x-release-status: DEPRECATED
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-refunds.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1CreateRefundRequestType
    V1ListSettlementsRequestStatus:
      type: string
      enum:
      - SENT
      - FAILED
      x-enum-elements:
      - name: SENT
        description: ""
        x-release-status: DEPRECATED
      - name: FAILED
        description: ""
        x-release-status: DEPRECATED
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-settlements.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1ListSettlementsRequestStatus
    V1PaymentItemizationItemizationType:
      type: string
      enum:
      - ITEM
      - CUSTOM_AMOUNT
      - GIFT_CARD_ACTIVATION
      - GIFT_CARD_RELOAD
      - GIFT_CARD_UNKNOWN
      - OTHER
      x-enum-elements:
      - name: ITEM
        description: ""
        x-release-status: DEPRECATED
      - name: CUSTOM_AMOUNT
        description: ""
        x-release-status: DEPRECATED
      - name: GIFT_CARD_ACTIVATION
        description: ""
        x-release-status: DEPRECATED
      - name: GIFT_CARD_RELOAD
        description: ""
        x-release-status: DEPRECATED
      - name: GIFT_CARD_UNKNOWN
        description: ""
        x-release-status: DEPRECATED
      - name: OTHER
        description: ""
        x-release-status: DEPRECATED
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-payments.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1PaymentItemizationItemizationType
    V1PaymentSurchargeType:
      type: string
      enum:
      - UNKNOWN
      - AUTO_GRATUITY
      - CUSTOM
      x-enum-elements:
      - name: UNKNOWN
        description: ""
        x-release-status: DEPRECATED
      - name: AUTO_GRATUITY
        description: ""
        x-release-status: DEPRECATED
      - name: CUSTOM
        description: ""
        x-release-status: DEPRECATED
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-payments.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1PaymentSurchargeType
    V1PaymentTaxInclusionType:
      type: string
      enum:
      - ADDITIVE
      - INCLUSIVE
      x-enum-elements:
      - name: ADDITIVE
        description: ""
        x-release-status: DEPRECATED
      - name: INCLUSIVE
        description: ""
        x-release-status: DEPRECATED
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-payments.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1PaymentTaxInclusionType
    V1RefundType:
      type: string
      enum:
      - FULL
      - PARTIAL
      x-enum-elements:
      - name: FULL
        description: ""
        x-release-status: DEPRECATED
      - name: PARTIAL
        description: ""
        x-release-status: DEPRECATED
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-refunds.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1RefundType
    V1SettlementStatus:
      type: string
      enum:
      - FAILED
      - SENT
      x-enum-elements:
      - name: FAILED
        description: ""
        x-release-status: DEPRECATED
      - name: SENT
        description: ""
        x-release-status: DEPRECATED
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-settlements.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1SettlementStatus
    V1SettlementEntryType:
      type: string
      enum:
      - ADJUSTMENT
      - BALANCE_CHARGE
      - CHARGE
      - FREE_PROCESSING
      - HOLD_ADJUSTMENT
      - PAID_SERVICE_FEE
      - PAID_SERVICE_FEE_REFUND
      - REDEMPTION_CODE
      - REFUND
      - RETURNED_PAYOUT
      - SQUARE_CAPITAL_ADVANCE
      - SQUARE_CAPITAL_PAYMENT
      - SQUARE_CAPITAL_REVERSED_PAYMENT
      - SUBSCRIPTION_FEE
      - SUBSCRIPTION_FEE_REFUND
      - OTHER
      - INCENTED_PAYMENT
      - RETURNED_ACH_ENTRY
      - RETURNED_SQUARE_275
      - SQUARE_275
      - SQUARE_CARD
      x-enum-elements:
      - name: ADJUSTMENT
        description: A manual adjustment applied to the merchant's account by Square
        x-release-status: DEPRECATED
      - name: BALANCE_CHARGE
        description: A payment from an existing Square balance, such as a gift card
        x-release-status: DEPRECATED
      - name: CHARGE
        description: A credit card payment CAPTURE
        x-release-status: DEPRECATED
      - name: FREE_PROCESSING
        description: Square offers Free Payments Processing for a variety of business
          scenarios including seller referral or when we want to apologize for a bug,
          customer service, repricing complication, etc. This entry represents a credit
          to the merchant for the purposes of Free Processing.
        x-release-status: DEPRECATED
      - name: HOLD_ADJUSTMENT
        description: An adjustment made by Square related to holding/releasing a payment
        x-release-status: DEPRECATED
      - name: PAID_SERVICE_FEE
        description: a fee paid to a 3rd party merchant
        x-release-status: DEPRECATED
      - name: PAID_SERVICE_FEE_REFUND
        description: a refund for a 3rd party merchant fee
        x-release-status: DEPRECATED
      - name: REDEMPTION_CODE
        description: Repayment for a redemption code
        x-release-status: DEPRECATED
      - name: REFUND
        description: A refund for an existing card payment
        x-release-status: DEPRECATED
      - name: RETURNED_PAYOUT
        description: An entry created when we receive a response for the ACH file
          we sent indicating that the settlement of the original entry failed.
        x-release-status: DEPRECATED
      - name: SQUARE_CAPITAL_ADVANCE
        description: Initial deposit to a merchant for a Capital merchant cash advance
          (MCA).
        x-release-status: DEPRECATED
      - name: SQUARE_CAPITAL_PAYMENT
        description: Capital merchant cash advance (MCA) assessment. These are, generally,
          proportional to the merchant's sales but may be issued for other reasons
          related to the MCA.
        x-release-status: DEPRECATED
      - name: SQUARE_CAPITAL_REVERSED_PAYMENT
        description: Capital merchant cash advance (MCA) assessment refund. These
          are, generally, proportional to the merchant's refunds but may be issued
          for other reasons related to the MCA.
        x-release-status: DEPRECATED
      - name: SUBSCRIPTION_FEE
        description: Fee charged for subscription to a Square product
        x-release-status: DEPRECATED
      - name: SUBSCRIPTION_FEE_REFUND
        description: Refund of a previously charged Square product subscription fee.
        x-release-status: DEPRECATED
      - name: OTHER
        description: ""
        x-release-status: DEPRECATED
      - name: INCENTED_PAYMENT
        description: A payment in which Square covers part of the funds for a purchase
        x-release-status: DEPRECATED
      - name: RETURNED_ACH_ENTRY
        description: A settlement failed to be processed and the settlement amount
          has been returned to the account
        x-release-status: DEPRECATED
      - name: RETURNED_SQUARE_275
        description: Refund for cancelling a Square Plus subscription
        x-release-status: DEPRECATED
      - name: SQUARE_275
        description: Fee charged for a Square Plus subscription ($275)
        x-release-status: DEPRECATED
      - name: SQUARE_CARD
        description: Settlements to or withdrawals from the Square Card (an asset)
        x-release-status: DEPRECATED
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-settlements.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1SettlementEntryType
    V1TenderCardBrand:
      type: string
      description: The brand of a credit card.
      enum:
      - OTHER_BRAND
      - VISA
      - MASTER_CARD
      - AMERICAN_EXPRESS
      - DISCOVER
      - DISCOVER_DINERS
      - JCB
      - CHINA_UNIONPAY
      - SQUARE_GIFT_CARD
      x-enum-elements:
      - name: OTHER_BRAND
        description: ""
        x-release-status: DEPRECATED
      - name: VISA
        description: ""
        x-release-status: DEPRECATED
      - name: MASTER_CARD
        description: ""
        x-release-status: DEPRECATED
      - name: AMERICAN_EXPRESS
        description: ""
        x-release-status: DEPRECATED
      - name: DISCOVER
        description: ""
        x-release-status: DEPRECATED
      - name: DISCOVER_DINERS
        description: ""
        x-release-status: DEPRECATED
      - name: JCB
        description: ""
        x-release-status: DEPRECATED
      - name: CHINA_UNIONPAY
        description: ""
        x-release-status: DEPRECATED
      - name: SQUARE_GIFT_CARD
        description: ""
        x-release-status: DEPRECATED
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1common.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1TenderCardBrand
    V1TenderEntryMethod:
      type: string
      enum:
      - MANUAL
      - SCANNED
      - SQUARE_CASH
      - SQUARE_WALLET
      - SWIPED
      - WEB_FORM
      - OTHER
      x-enum-elements:
      - name: MANUAL
        description: ""
        x-release-status: DEPRECATED
      - name: SCANNED
        description: ""
        x-release-status: DEPRECATED
      - name: SQUARE_CASH
        description: ""
        x-release-status: DEPRECATED
      - name: SQUARE_WALLET
        description: ""
        x-release-status: DEPRECATED
      - name: SWIPED
        description: ""
        x-release-status: DEPRECATED
      - name: WEB_FORM
        description: ""
        x-release-status: DEPRECATED
      - name: OTHER
        description: ""
        x-release-status: DEPRECATED
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1common.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1TenderEntryMethod
    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: ""
        x-release-status: DEPRECATED
      - name: CASH
        description: ""
        x-release-status: DEPRECATED
      - name: THIRD_PARTY_CARD
        description: ""
        x-release-status: DEPRECATED
      - name: NO_SALE
        description: ""
        x-release-status: DEPRECATED
      - name: SQUARE_WALLET
        description: ""
        x-release-status: DEPRECATED
      - name: SQUARE_GIFT_CARD
        description: ""
        x-release-status: DEPRECATED
      - name: UNKNOWN
        description: ""
        x-release-status: DEPRECATED
      - name: OTHER
        description: ""
        x-release-status: DEPRECATED
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1common.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1TenderType
    V1WebhooksEvents:
      type: string
      description: V1WebhooksEvents
      enum:
      - PAYMENT_UPDATED
      - INVENTORY_UPDATED
      - TIMECARD_UPDATED
      x-enum-elements:
      - name: PAYMENT_UPDATED
        description: |-
          A charge was made or refunded through Square Point of Sale or the Transaction API.

          Required permission: `PAYMENTS_READ`
        x-release-status: PUBLIC
      - name: INVENTORY_UPDATED
        description: |-
          The inventory quantity for a catalog item was updated.

          Required permission: `ITEMS_READ`
        x-release-status: PUBLIC
      - name: TIMECARD_UPDATED
        description: |-
          A timecard was created in the Square dashboard or an employee clocked in using Square Point of Sale.

          Required permission: `TIMECARDS_READ`
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1webhooks.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1WebhooksEvents
      x-visibility: DOC_ONLY
    BookingBookingSource:
      type: string
      description: Supported sources a booking was created from.
      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.
        x-release-status: PUBLIC
      - name: FIRST_PARTY_BUYER
        description: The booking was created by a buyer from a Square Appointments
          application, such as Square Online Booking Site.
        x-release-status: PUBLIC
      - name: THIRD_PARTY_BUYER
        description: The booking was created by a buyer created from a third-party
          application.
        x-release-status: PUBLIC
      - name: API
        description: The booking was created by a seller or a buyer from the Square
          Bookings API.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: BookingBookingSource
    BookingCreatorDetailsCreatorType:
      type: string
      description: Supported types of a booking creator.
      enum:
      - TEAM_MEMBER
      - CUSTOMER
      x-enum-elements:
      - name: TEAM_MEMBER
        description: The creator is of the seller type.
        x-release-status: PUBLIC
      - name: CUSTOMER
        description: The creator is of the buyer type.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: BookingCreatorDetailsCreatorType
    BookingStatus:
      type: string
      description: Supported booking statuses.
      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.
        x-release-status: PUBLIC
      - name: CANCELLED_BY_CUSTOMER
        description: A customer-cancelled booking. It is visible to both the seller
          and the customer.
        x-release-status: PUBLIC
      - name: CANCELLED_BY_SELLER
        description: A seller-cancelled booking. It is visible to both the seller
          and the customer.
        x-release-status: PUBLIC
      - name: DECLINED
        description: A declined booking. It had once been pending, but was then declined
          by the seller.
        x-release-status: PUBLIC
      - name: ACCEPTED
        description: An accepted booking agreed to or accepted by the seller.
        x-release-status: PUBLIC
      - 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
          the seller because the client either missed the booking or cancelled it without enough notice.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: BookingStatus
    BusinessAppointmentSettingsAlignmentTime:
      type: string
      description: Time units of a service duration for bookings.
      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.
        x-release-status: PUBLIC
      - name: QUARTER_HOURLY
        description: The service duration unit is a 15-minute interval. Bookings can
          be scheduled every quarter hour.
        x-release-status: PUBLIC
      - name: HALF_HOURLY
        description: The service duration unit is a 30-minute interval. Bookings can
          be scheduled every half hour.
        x-release-status: PUBLIC
      - name: HOURLY
        description: The service duration unit is a 60-minute interval. Bookings can
          be scheduled every hour.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: BusinessAppointmentSettingsAlignmentTime
    BusinessAppointmentSettingsBookingLocationType:
      type: string
      description: Supported types of location where service is provided.
      enum:
      - BUSINESS_LOCATION
      - CUSTOMER_LOCATION
      - PHONE
      x-enum-elements:
      - name: BUSINESS_LOCATION
        description: The service is provided at a seller location.
        x-release-status: PUBLIC
      - name: CUSTOMER_LOCATION
        description: The service is provided at a customer location.
        x-release-status: PUBLIC
      - name: PHONE
        description: The service is provided over the phone.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: BusinessAppointmentSettingsBookingLocationType
    BusinessAppointmentSettingsCancellationPolicy:
      type: string
      description: The category of the seller’s cancellation policy.
      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`.
        x-release-status: PUBLIC
      - name: CUSTOM_POLICY
        description: Cancellations follow the seller-specified policy that is described
          in free-form text and not enforced automatically by Square.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: BusinessAppointmentSettingsCancellationPolicy
    BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType:
      type: string
      description: Types of daily appointment limits.
      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.
        x-release-status: PUBLIC
      - name: PER_LOCATION
        description: The maximum number of daily appointments is set on a per location
          basis.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType
    BusinessBookingProfileBookingPolicy:
      type: string
      description: Policies for accepting bookings.
      enum:
      - ACCEPT_ALL
      - REQUIRES_ACCEPTANCE
      x-enum-elements:
      - name: ACCEPT_ALL
        description: The seller accepts all booking requests automatically.
        x-release-status: PUBLIC
      - name: REQUIRES_ACCEPTANCE
        description: The seller must accept requests to complete bookings.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: BusinessBookingProfileBookingPolicy
    BusinessBookingProfileCustomerTimezoneChoice:
      type: string
      description: Choices of customer-facing time zone used for bookings.
      enum:
      - BUSINESS_LOCATION_TIMEZONE
      - CUSTOMER_CHOICE
      x-enum-elements:
      - name: BUSINESS_LOCATION_TIMEZONE
        description: Use the time zone of the business location for bookings.
        x-release-status: PUBLIC
      - name: CUSTOMER_CHOICE
        description: Use the customer-chosen time zone for bookings.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: BusinessBookingProfileCustomerTimezoneChoice
    Currency:
      type: string
      description: |-
        Indicates the associated currency for an amount of money. Values correspond
        to [ISO 4217](https://wikipedia.org/wiki/ISO_4217).
      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
      - 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
      x-enum-elements:
      - name: UNKNOWN_CURRENCY
        description: Unknown currency
        x-release-status: PUBLIC
      - name: AED
        description: United Arab Emirates dirham
        x-release-status: PUBLIC
      - name: AFN
        description: Afghan afghani
        x-release-status: PUBLIC
      - name: ALL
        description: Albanian lek
        x-release-status: PUBLIC
      - name: AMD
        description: Armenian dram
        x-release-status: PUBLIC
      - name: ANG
        description: Netherlands Antillean guilder
        x-release-status: PUBLIC
      - name: AOA
        description: Angolan kwanza
        x-release-status: PUBLIC
      - name: ARS
        description: Argentine peso
        x-release-status: PUBLIC
      - name: AUD
        description: Australian dollar
        x-release-status: PUBLIC
      - name: AWG
        description: Aruban florin
        x-release-status: PUBLIC
      - name: AZN
        description: Azerbaijani manat
        x-release-status: PUBLIC
      - name: BAM
        description: Bosnia and Herzegovina convertible mark
        x-release-status: PUBLIC
      - name: BBD
        description: Barbados dollar
        x-release-status: PUBLIC
      - name: BDT
        description: Bangladeshi taka
        x-release-status: PUBLIC
      - name: BGN
        description: Bulgarian lev
        x-release-status: PUBLIC
      - name: BHD
        description: Bahraini dinar
        x-release-status: PUBLIC
      - name: BIF
        description: Burundian franc
        x-release-status: PUBLIC
      - name: BMD
        description: Bermudian dollar
        x-release-status: PUBLIC
      - name: BND
        description: Brunei dollar
        x-release-status: PUBLIC
      - name: BOB
        description: Boliviano
        x-release-status: PUBLIC
      - name: BOV
        description: Bolivian Mvdol
        x-release-status: PUBLIC
      - name: BRL
        description: Brazilian real
        x-release-status: PUBLIC
      - name: BSD
        description: Bahamian dollar
        x-release-status: PUBLIC
      - name: BTN
        description: Bhutanese ngultrum
        x-release-status: PUBLIC
      - name: BWP
        description: Botswana pula
        x-release-status: PUBLIC
      - name: BYR
        description: Belarusian ruble
        x-release-status: PUBLIC
      - name: BZD
        description: Belize dollar
        x-release-status: PUBLIC
      - name: CAD
        description: Canadian dollar
        x-release-status: PUBLIC
      - name: CDF
        description: Congolese franc
        x-release-status: PUBLIC
      - name: CHE
        description: WIR Euro
        x-release-status: PUBLIC
      - name: CHF
        description: Swiss franc
        x-release-status: PUBLIC
      - name: CHW
        description: WIR Franc
        x-release-status: PUBLIC
      - name: CLF
        description: Unidad de Fomento
        x-release-status: PUBLIC
      - name: CLP
        description: Chilean peso
        x-release-status: PUBLIC
      - name: CNY
        description: Chinese yuan
        x-release-status: PUBLIC
      - name: COP
        description: Colombian peso
        x-release-status: PUBLIC
      - name: COU
        description: Unidad de Valor Real
        x-release-status: PUBLIC
      - name: CRC
        description: Costa Rican colon
        x-release-status: PUBLIC
      - name: CUC
        description: Cuban convertible peso
        x-release-status: PUBLIC
      - name: CUP
        description: Cuban peso
        x-release-status: PUBLIC
      - name: CVE
        description: Cape Verdean escudo
        x-release-status: PUBLIC
      - name: CZK
        description: Czech koruna
        x-release-status: PUBLIC
      - name: DJF
        description: Djiboutian franc
        x-release-status: PUBLIC
      - name: DKK
        description: Danish krone
        x-release-status: PUBLIC
      - name: DOP
        description: Dominican peso
        x-release-status: PUBLIC
      - name: DZD
        description: Algerian dinar
        x-release-status: PUBLIC
      - name: EGP
        description: Egyptian pound
        x-release-status: PUBLIC
      - name: ERN
        description: Eritrean nakfa
        x-release-status: PUBLIC
      - name: ETB
        description: Ethiopian birr
        x-release-status: PUBLIC
      - name: EUR
        description: Euro
        x-release-status: PUBLIC
      - name: FJD
        description: Fiji dollar
        x-release-status: PUBLIC
      - name: FKP
        description: Falkland Islands pound
        x-release-status: PUBLIC
      - name: GBP
        description: Pound sterling
        x-release-status: PUBLIC
      - name: GEL
        description: Georgian lari
        x-release-status: PUBLIC
      - name: GHS
        description: Ghanaian cedi
        x-release-status: PUBLIC
      - name: GIP
        description: Gibraltar pound
        x-release-status: PUBLIC
      - name: GMD
        description: Gambian dalasi
        x-release-status: PUBLIC
      - name: GNF
        description: Guinean franc
        x-release-status: PUBLIC
      - name: GTQ
        description: Guatemalan quetzal
        x-release-status: PUBLIC
      - name: GYD
        description: Guyanese dollar
        x-release-status: PUBLIC
      - name: HKD
        description: Hong Kong dollar
        x-release-status: PUBLIC
      - name: HNL
        description: Honduran lempira
        x-release-status: PUBLIC
      - name: HRK
        description: Croatian kuna
        x-release-status: PUBLIC
      - name: HTG
        description: Haitian gourde
        x-release-status: PUBLIC
      - name: HUF
        description: Hungarian forint
        x-release-status: PUBLIC
      - name: IDR
        description: Indonesian rupiah
        x-release-status: PUBLIC
      - name: ILS
        description: Israeli new shekel
        x-release-status: PUBLIC
      - name: INR
        description: Indian rupee
        x-release-status: PUBLIC
      - name: IQD
        description: Iraqi dinar
        x-release-status: PUBLIC
      - name: IRR
        description: Iranian rial
        x-release-status: PUBLIC
      - name: ISK
        description: Icelandic króna
        x-release-status: PUBLIC
      - name: JMD
        description: Jamaican dollar
        x-release-status: PUBLIC
      - name: JOD
        description: Jordanian dinar
        x-release-status: PUBLIC
      - name: JPY
        description: Japanese yen
        x-release-status: PUBLIC
      - name: KES
        description: Kenyan shilling
        x-release-status: PUBLIC
      - name: KGS
        description: Kyrgyzstani som
        x-release-status: PUBLIC
      - name: KHR
        description: Cambodian riel
        x-release-status: PUBLIC
      - name: KMF
        description: Comoro franc
        x-release-status: PUBLIC
      - name: KPW
        description: North Korean won
        x-release-status: PUBLIC
      - name: KRW
        description: South Korean won
        x-release-status: PUBLIC
      - name: KWD
        description: Kuwaiti dinar
        x-release-status: PUBLIC
      - name: KYD
        description: Cayman Islands dollar
        x-release-status: PUBLIC
      - name: KZT
        description: Kazakhstani tenge
        x-release-status: PUBLIC
      - name: LAK
        description: Lao kip
        x-release-status: PUBLIC
      - name: LBP
        description: Lebanese pound
        x-release-status: PUBLIC
      - name: LKR
        description: Sri Lankan rupee
        x-release-status: PUBLIC
      - name: LRD
        description: Liberian dollar
        x-release-status: PUBLIC
      - name: LSL
        description: Lesotho loti
        x-release-status: PUBLIC
      - name: LTL
        description: Lithuanian litas
        x-release-status: PUBLIC
      - name: LVL
        description: Latvian lats
        x-release-status: PUBLIC
      - name: LYD
        description: Libyan dinar
        x-release-status: PUBLIC
      - name: MAD
        description: Moroccan dirham
        x-release-status: PUBLIC
      - name: MDL
        description: Moldovan leu
        x-release-status: PUBLIC
      - name: MGA
        description: Malagasy ariary
        x-release-status: PUBLIC
      - name: MKD
        description: Macedonian denar
        x-release-status: PUBLIC
      - name: MMK
        description: Myanmar kyat
        x-release-status: PUBLIC
      - name: MNT
        description: Mongolian tögrög
        x-release-status: PUBLIC
      - name: MOP
        description: Macanese pataca
        x-release-status: PUBLIC
      - name: MRO
        description: Mauritanian ouguiya
        x-release-status: PUBLIC
      - name: MUR
        description: Mauritian rupee
        x-release-status: PUBLIC
      - name: MVR
        description: Maldivian rufiyaa
        x-release-status: PUBLIC
      - name: MWK
        description: Malawian kwacha
        x-release-status: PUBLIC
      - name: MXN
        description: Mexican peso
        x-release-status: PUBLIC
      - name: MXV
        description: Mexican Unidad de Inversion
        x-release-status: PUBLIC
      - name: MYR
        description: Malaysian ringgit
        x-release-status: PUBLIC
      - name: MZN
        description: Mozambican metical
        x-release-status: PUBLIC
      - name: NAD
        description: Namibian dollar
        x-release-status: PUBLIC
      - name: NGN
        description: Nigerian naira
        x-release-status: PUBLIC
      - name: NIO
        description: Nicaraguan córdoba
        x-release-status: PUBLIC
      - name: NOK
        description: Norwegian krone
        x-release-status: PUBLIC
      - name: NPR
        description: Nepalese rupee
        x-release-status: PUBLIC
      - name: NZD
        description: New Zealand dollar
        x-release-status: PUBLIC
      - name: OMR
        description: Omani rial
        x-release-status: PUBLIC
      - name: PAB
        description: Panamanian balboa
        x-release-status: PUBLIC
      - name: PEN
        description: Peruvian sol
        x-release-status: PUBLIC
      - name: PGK
        description: Papua New Guinean kina
        x-release-status: PUBLIC
      - name: PHP
        description: Philippine peso
        x-release-status: PUBLIC
      - name: PKR
        description: Pakistani rupee
        x-release-status: PUBLIC
      - name: PLN
        description: Polish złoty
        x-release-status: PUBLIC
      - name: PYG
        description: Paraguayan guaraní
        x-release-status: PUBLIC
      - name: QAR
        description: Qatari riyal
        x-release-status: PUBLIC
      - name: RON
        description: Romanian leu
        x-release-status: PUBLIC
      - name: RSD
        description: Serbian dinar
        x-release-status: PUBLIC
      - name: RUB
        description: Russian ruble
        x-release-status: PUBLIC
      - name: RWF
        description: Rwandan franc
        x-release-status: PUBLIC
      - name: SAR
        description: Saudi riyal
        x-release-status: PUBLIC
      - name: SBD
        description: Solomon Islands dollar
        x-release-status: PUBLIC
      - name: SCR
        description: Seychelles rupee
        x-release-status: PUBLIC
      - name: SDG
        description: Sudanese pound
        x-release-status: PUBLIC
      - name: SEK
        description: Swedish krona
        x-release-status: PUBLIC
      - name: SGD
        description: Singapore dollar
        x-release-status: PUBLIC
      - name: SHP
        description: Saint Helena pound
        x-release-status: PUBLIC
      - name: SLL
        description: Sierra Leonean leone
        x-release-status: PUBLIC
      - name: SOS
        description: Somali shilling
        x-release-status: PUBLIC
      - name: SRD
        description: Surinamese dollar
        x-release-status: PUBLIC
      - name: SSP
        description: South Sudanese pound
        x-release-status: PUBLIC
      - name: STD
        description: São Tomé and Príncipe dobra
        x-release-status: PUBLIC
      - name: SVC
        description: Salvadoran colón
        x-release-status: PUBLIC
      - name: SYP
        description: Syrian pound
        x-release-status: PUBLIC
      - name: SZL
        description: Swazi lilangeni
        x-release-status: PUBLIC
      - name: THB
        description: Thai baht
        x-release-status: PUBLIC
      - name: TJS
        description: Tajikstani somoni
        x-release-status: PUBLIC
      - name: TMT
        description: Turkmenistan manat
        x-release-status: PUBLIC
      - name: TND
        description: Tunisian dinar
        x-release-status: PUBLIC
      - name: TOP
        description: Tongan pa'anga
        x-release-status: PUBLIC
      - name: TRY
        description: Turkish lira
        x-release-status: PUBLIC
      - name: TTD
        description: Trinidad and Tobago dollar
        x-release-status: PUBLIC
      - name: TWD
        description: New Taiwan dollar
        x-release-status: PUBLIC
      - name: TZS
        description: Tanzanian shilling
        x-release-status: PUBLIC
      - name: UAH
        description: Ukrainian hryvnia
        x-release-status: PUBLIC
      - name: UGX
        description: Ugandan shilling
        x-release-status: PUBLIC
      - name: USD
        description: United States dollar
        x-release-status: PUBLIC
      - name: USN
        description: United States dollar (next day)
        x-release-status: PUBLIC
      - name: USS
        description: United States dollar (same day)
        x-release-status: PUBLIC
      - name: UYI
        description: Uruguay Peso en Unidedades Indexadas
        x-release-status: PUBLIC
      - name: UYU
        description: Uruguyan peso
        x-release-status: PUBLIC
      - name: UZS
        description: Uzbekistan som
        x-release-status: PUBLIC
      - name: VEF
        description: Venezuelan bolívar soberano
        x-release-status: PUBLIC
      - name: VND
        description: Vietnamese đồng
        x-release-status: PUBLIC
      - name: VUV
        description: Vanuatu vatu
        x-release-status: PUBLIC
      - name: WST
        description: Samoan tala
        x-release-status: PUBLIC
      - name: XAF
        description: CFA franc BEAC
        x-release-status: PUBLIC
      - name: XAG
        description: Silver
        x-release-status: PUBLIC
      - name: XAU
        description: Gold
        x-release-status: PUBLIC
      - name: XBA
        description: European Composite Unit
        x-release-status: PUBLIC
      - name: XBB
        description: European Monetary Unit
        x-release-status: PUBLIC
      - name: XBC
        description: European Unit of Account 9
        x-release-status: PUBLIC
      - name: XBD
        description: European Unit of Account 17
        x-release-status: PUBLIC
      - name: XCD
        description: East Caribbean dollar
        x-release-status: PUBLIC
      - name: XDR
        description: Special drawing rights (International Monetary Fund)
        x-release-status: PUBLIC
      - name: XOF
        description: CFA franc BCEAO
        x-release-status: PUBLIC
      - name: XPD
        description: Palladium
        x-release-status: PUBLIC
      - name: XPF
        description: CFP franc
        x-release-status: PUBLIC
      - name: XPT
        description: Platinum
        x-release-status: PUBLIC
      - name: XTS
        description: Code reserved for testing
        x-release-status: PUBLIC
      - name: XXX
        description: No currency
        x-release-status: PUBLIC
      - name: YER
        description: Yemeni rial
        x-release-status: PUBLIC
      - name: ZAR
        description: South African rand
        x-release-status: PUBLIC
      - name: ZMK
        description: Zambian kwacha
        x-release-status: PUBLIC
      - name: ZMW
        description: Zambian kwacha
        x-release-status: PUBLIC
      - name: BTC
        description: Bitcoin
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/money.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: Currency
    DayOfWeek:
      type: string
      description: Indicates the specific day  of the week.
      enum:
      - SUN
      - MON
      - TUE
      - WED
      - THU
      - FRI
      - SAT
      x-enum-elements:
      - name: SUN
        description: Sunday
        x-release-status: PUBLIC
      - name: MON
        description: Monday
        x-release-status: PUBLIC
      - name: TUE
        description: Tuesday
        x-release-status: PUBLIC
      - name: WED
        description: Wednesday
        x-release-status: PUBLIC
      - name: THU
        description: Thursday
        x-release-status: PUBLIC
      - name: FRI
        description: Friday
        x-release-status: PUBLIC
      - name: SAT
        description: Saturday
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/day_of_week.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: DayOfWeek
    MeasurementUnitArea:
      type: string
      description: Unit of area used to measure a quantity.
      enum:
      - INVALID_AREA
      - 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.
        x-release-status: PUBLIC
      - name: IMPERIAL_SQUARE_INCH
        description: The area is measured in square inches.
        x-release-status: PUBLIC
      - name: IMPERIAL_SQUARE_FOOT
        description: The area is measured in square feet.
        x-release-status: PUBLIC
      - name: IMPERIAL_SQUARE_YARD
        description: The area is measured in square yards.
        x-release-status: PUBLIC
      - name: IMPERIAL_SQUARE_MILE
        description: The area is measured in square miles.
        x-release-status: PUBLIC
      - name: METRIC_SQUARE_CENTIMETER
        description: The area is measured in square centimeters.
        x-release-status: PUBLIC
      - name: METRIC_SQUARE_METER
        description: The area is measured in square meters.
        x-release-status: PUBLIC
      - name: METRIC_SQUARE_KILOMETER
        description: The area is measured in square kilometers.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/measurement_units.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: MeasurementUnitArea
    MeasurementUnitGeneric:
      type: string
      enum:
      - INVALID_GENERIC_UNIT
      - UNIT
      x-enum-elements:
      - name: UNIT
        description: The generic unit.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/measurement_units.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: MeasurementUnitGeneric
    MeasurementUnitLength:
      type: string
      description: The unit of length used to measure a quantity.
      enum:
      - INVALID_LENGTH
      - 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.
        x-release-status: PUBLIC
      - name: IMPERIAL_FOOT
        description: The length is measured in feet.
        x-release-status: PUBLIC
      - name: IMPERIAL_YARD
        description: The length is measured in yards.
        x-release-status: PUBLIC
      - name: IMPERIAL_MILE
        description: The length is measured in miles.
        x-release-status: PUBLIC
      - name: METRIC_MILLIMETER
        description: The length is measured in millimeters.
        x-release-status: PUBLIC
      - name: METRIC_CENTIMETER
        description: The length is measured in centimeters.
        x-release-status: PUBLIC
      - name: METRIC_METER
        description: The length is measured in meters.
        x-release-status: PUBLIC
      - name: METRIC_KILOMETER
        description: The length is measured in kilometers.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/measurement_units.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: MeasurementUnitLength
    MeasurementUnitTime:
      type: string
      description: Unit of time used to measure a quantity (a duration).
      enum:
      - INVALID_TIME
      - GENERIC_MILLISECOND
      - GENERIC_SECOND
      - GENERIC_MINUTE
      - GENERIC_HOUR
      - GENERIC_DAY
      x-enum-elements:
      - name: GENERIC_MILLISECOND
        description: The time is measured in milliseconds.
        x-release-status: PUBLIC
      - name: GENERIC_SECOND
        description: The time is measured in seconds.
        x-release-status: PUBLIC
      - name: GENERIC_MINUTE
        description: The time is measured in minutes.
        x-release-status: PUBLIC
      - name: GENERIC_HOUR
        description: The time is measured in hours.
        x-release-status: PUBLIC
      - name: GENERIC_DAY
        description: The time is measured in days.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/measurement_units.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: MeasurementUnitTime
    MeasurementUnitUnitType:
      type: string
      description: Describes the type of this unit and indicates which field contains
        the unit information. This is an ‘open’ enum.
      enum:
      - INVALID_TYPE
      - TYPE_CUSTOM
      - TYPE_AREA
      - TYPE_LENGTH
      - TYPE_VOLUME
      - TYPE_WEIGHT
      - TYPE_TIME
      - TYPE_GENERIC
      x-enum-elements:
      - name: TYPE_CUSTOM
        description: The unit details are contained in the custom_unit field.
        x-release-status: PUBLIC
      - name: TYPE_AREA
        description: The unit details are contained in the area_unit field.
        x-release-status: PUBLIC
      - name: TYPE_LENGTH
        description: The unit details are contained in the length_unit field.
        x-release-status: PUBLIC
      - name: TYPE_VOLUME
        description: The unit details are contained in the volume_unit field.
        x-release-status: PUBLIC
      - name: TYPE_WEIGHT
        description: The unit details are contained in the weight_unit field.
        x-release-status: PUBLIC
      - name: TYPE_GENERIC
        description: The unit details are contained in the generic_unit field.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/measurement_units.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: MeasurementUnitUnitType
    MeasurementUnitVolume:
      type: string
      description: The unit of volume used to measure a quantity.
      enum:
      - INVALID_VOLUME
      - 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.
        x-release-status: PUBLIC
      - name: GENERIC_SHOT
        description: The volume is measured in shots.
        x-release-status: PUBLIC
      - name: GENERIC_CUP
        description: The volume is measured in cups.
        x-release-status: PUBLIC
      - name: GENERIC_PINT
        description: The volume is measured in pints.
        x-release-status: PUBLIC
      - name: GENERIC_QUART
        description: The volume is measured in quarts.
        x-release-status: PUBLIC
      - name: GENERIC_GALLON
        description: The volume is measured in gallons.
        x-release-status: PUBLIC
      - name: IMPERIAL_CUBIC_INCH
        description: The volume is measured in cubic inches.
        x-release-status: PUBLIC
      - name: IMPERIAL_CUBIC_FOOT
        description: The volume is measured in cubic feet.
        x-release-status: PUBLIC
      - name: IMPERIAL_CUBIC_YARD
        description: The volume is measured in cubic yards.
        x-release-status: PUBLIC
      - name: METRIC_MILLILITER
        description: The volume is measured in metric milliliters.
        x-release-status: PUBLIC
      - name: METRIC_LITER
        description: The volume is measured in metric liters.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/measurement_units.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: MeasurementUnitVolume
    MeasurementUnitWeight:
      type: string
      description: Unit of weight used to measure a quantity.
      enum:
      - INVALID_WEIGHT
      - 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.
        x-release-status: PUBLIC
      - name: IMPERIAL_POUND
        description: The weight is measured in pounds.
        x-release-status: PUBLIC
      - name: IMPERIAL_STONE
        description: The weight is measured in stones.
        x-release-status: PUBLIC
      - name: METRIC_MILLIGRAM
        description: The weight is measured in milligrams.
        x-release-status: PUBLIC
      - name: METRIC_GRAM
        description: The weight is measured in grams.
        x-release-status: PUBLIC
      - name: METRIC_KILOGRAM
        description: The weight is measured in kilograms.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/measurement_units.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: MeasurementUnitWeight
    Product:
      type: string
      description: Indicates the Square product used to generate a change.
      enum:
      - PRODUCT_DO_NOT_USE
      - SQUARE_POS
      - EXTERNAL_API
      - BILLING
      - APPOINTMENTS
      - INVOICES
      - ONLINE_STORE
      - PAYROLL
      - DASHBOARD
      - ITEM_LIBRARY_IMPORT
      - RETAIL
      - RESTAURANT
      - CUSTOMERS_DIRECTORY
      - OTHER
      x-enum-elements:
      - name: SQUARE_POS
        description: Square Point of Sale application.
        x-release-status: PUBLIC
      - name: EXTERNAL_API
        description: Square Connect APIs (for example, Orders API or Checkout API).
        x-release-status: PUBLIC
      - name: BILLING
        description: A Square subscription (various products).
        x-release-status: PUBLIC
      - name: APPOINTMENTS
        description: Square Appointments.
        x-release-status: PUBLIC
      - name: INVOICES
        description: Square Invoices.
        x-release-status: PUBLIC
      - name: ONLINE_STORE
        description: Square Online Store.
        x-release-status: PUBLIC
      - name: PAYROLL
        description: Square Payroll.
        x-release-status: PUBLIC
      - name: DASHBOARD
        description: Square Dashboard.
        x-release-status: PUBLIC
      - name: ITEM_LIBRARY_IMPORT
        description: Item Library Import.
        x-release-status: PUBLIC
      - name: OTHER
        description: A Square product that does not match any other value.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/source_application.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: Product
    SortOrder:
      type: string
      description: The order (e.g., chronological or alphabetical) in which results
        from a request are returned.
      enum:
      - DESC
      - ASC
      x-enum-elements:
      - name: DESC
        description: The results are returned in descending (e.g., newest-first or
          Z-A) order.
        x-release-status: PUBLIC
      - name: ASC
        description: The results are returned in ascending (e.g., oldest-first or
          A-Z) order.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/sort.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: SortOrder
    InventoryChangeType:
      type: string
      description: Indicates how the inventory change was applied to a tracked product
        quantity.
      enum:
      - INVENTORY_CHANGE_TYPE_DO_NOT_USE
      - PHYSICAL_COUNT
      - ADJUSTMENT
      - TRANSFER
      - AVAILABILITY
      x-enum-elements:
      - name: PHYSICAL_COUNT
        description: The change occurred as part of a physical count update.
        x-release-status: PUBLIC
      - name: ADJUSTMENT
        description: |-
          The change occurred as part of the normal lifecycle of goods
          (e.g., as an inventory adjustment).
        x-release-status: PUBLIC
      - name: TRANSFER
        description: The change occurred as part of an inventory transfer.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/resources/inventory.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: InventoryChangeType
    InventoryState:
      type: string
      description: Indicates the state of a tracked item quantity in the lifecycle
        of goods.
      enum:
      - INVENTORY_STATE_DO_NOT_USE
      - 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
      x-enum-elements:
      - name: CUSTOM
        description: |-
          The related quantity of items are in a custom state. **READ-ONLY**:
          the Inventory API cannot move quantities to or from this state.
        x-release-status: PUBLIC
      - name: IN_STOCK
        description: The related quantity of items are on hand and available for sale.
        x-release-status: PUBLIC
      - name: SOLD
        description: |-
          The related quantity of items were sold as part of an itemized
          transaction. Quantities in the `SOLD` state are no longer tracked.
        x-release-status: PUBLIC
      - name: RETURNED_BY_CUSTOMER
        description: |-
          The related quantity of items were returned through the Square Point
          of Sale application, but are not yet available for sale. **READ-ONLY**:
          the Inventory API cannot move quantities to or from this state.
        x-release-status: PUBLIC
      - name: RESERVED_FOR_SALE
        description: |-
          The related quantity of items are on hand, but not currently
          available for sale. **READ-ONLY**: the Inventory API cannot move
          quantities to or from this state.
        x-release-status: PUBLIC
      - name: SOLD_ONLINE
        description: |-
          The related quantity of items were sold online. **READ-ONLY**: the
          Inventory API cannot move quantities to or from this state.
        x-release-status: PUBLIC
      - name: ORDERED_FROM_VENDOR
        description: |-
          The related quantity of items were ordered from a vendor but not yet
          received. **READ-ONLY**: the Inventory API cannot move quantities to or
          from this state.
        x-release-status: PUBLIC
      - name: RECEIVED_FROM_VENDOR
        description: |-
          The related quantity of items were received from a vendor but are
          not yet available for sale. **READ-ONLY**: the Inventory API cannot move
          quantities to or from this state.
        x-release-status: PUBLIC
      - name: IN_TRANSIT_TO
        description: |-
          The related quantity of items are in transit between locations.
          *READ-ONLY**: the Inventory API cannot move quantities to or from this
          state.
        x-release-status: PUBLIC
      - name: NONE
        description: |-
          A placeholder indicating that the related quantity of items are not
          currently tracked in Square. Transferring quantities from the `NONE` state
          to a tracked state (e.g., `IN_STOCK`) introduces stock into the system.
        x-release-status: PUBLIC
      - name: WASTE
        description: |-
          The related quantity of items are lost or damaged and cannot be
          sold.
        x-release-status: PUBLIC
      - name: UNLINKED_RETURN
        description: |-
          The related quantity of items were returned but not linked to a
          previous transaction. Unlinked returns are not tracked in Square.
          Transferring a quantity from `UNLINKED_RETURN` to a tracked state (e.g.,
          `IN_STOCK`) introduces new stock into the system.
        x-release-status: PUBLIC
      - name: COMPOSED
        description: The related quantity of items that are part of a composition
          consisting one or more components.
        x-release-status: BETA
      - name: DECOMPOSED
        description: The related quantity of items that are part of a component.
        x-release-status: BETA
      - 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.
        x-release-status: BETA
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/resources/inventory.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: InventoryState
    VendorStatus:
      type: string
      description: |-
        The status of the [Vendor](entity:Vendor),
        whether a [Vendor](entity:Vendor) is active or inactive.
      enum:
      - DO_NOT_USE
      - ACTIVE
      - INACTIVE
      x-enum-elements:
      - name: ACTIVE
        description: Vendor is active and can receive purchase orders.
        x-release-status: BETA
      - name: INACTIVE
        description: Vendor is inactive and cannot receive purchase orders.
        x-release-status: BETA
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/resources/inventory.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: VendorStatus
    SearchVendorsRequestSortField:
      type: string
      description: The field to sort the returned [Vendor](entity:Vendor) objects
        by.
      enum:
      - NAME
      - CREATED_AT
      x-enum-elements:
      - name: NAME
        description: To sort the result by the name of the [Vendor](entity:Vendor)
          objects.
        x-release-status: BETA
      - name: CREATED_AT
        description: To sort the result by the creation time of the [Vendor](entity:Vendor)
          objects.
        x-release-status: BETA
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/search_vendors.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: SearchVendorsRequestSortField
    CatalogCustomAttributeDefinitionAppVisibility:
      type: string
      description: |-
        Defines the visibility of a custom attribute to applications other than their
        creating application.
      enum:
      - APP_VISIBILITY_DO_NOT_USE
      - 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.
        x-release-status: BETA
      - name: APP_VISIBILITY_READ_ONLY
        description: |-
          Other applications can read this custom attribute definition and
          values.
        x-release-status: BETA
      - name: APP_VISIBILITY_READ_WRITE_VALUES
        description: |-
          Other applications can read and write custom attribute values on objects.
          They can read but cannot edit the custom attribute definition.
        x-release-status: BETA
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogCustomAttributeDefinitionAppVisibility
    CatalogCustomAttributeDefinitionSellerVisibility:
      type: string
      description: |-
        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).
      enum:
      - SELLER_VISIBILITY_DO_NOT_USE
      - 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
          applications or Square APIs.
        x-release-status: BETA
      - name: SELLER_VISIBILITY_READ_WRITE_VALUES
        description: |-
          Sellers can read and write this custom attribute value in catalog objects,
          but cannot edit the custom attribute definition.
        x-release-status: BETA
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogCustomAttributeDefinitionSellerVisibility
    CatalogCustomAttributeDefinitionType:
      type: string
      description: Defines the possible types for a custom attribute.
      enum:
      - ATTRIBUTE_TYPE_DO_NOT_USE
      - STRING
      - INTEGER
      - BOOLEAN
      - NUMBER
      - SELECTION
      - STRING_INT
      - TOKEN_INT
      x-enum-elements:
      - name: STRING
        description: A free-form string containing up to 255 characters.
        x-release-status: BETA
      - name: BOOLEAN
        description: A `true` or `false` value.
        x-release-status: BETA
      - name: NUMBER
        description: A decimal string representation of a number. Can support up to
          5 digits after the decimal point.
        x-release-status: BETA
      - name: SELECTION
        description: One or more choices from `allowed_selections`.
        x-release-status: BETA
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogCustomAttributeDefinitionType
    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.
        x-release-status: PUBLIC
      - name: DO_NOT_MODIFY_TAX_BASIS
        description: Application of the discount will not modify the tax basis.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/enums.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogDiscountModifyTaxBasis
    CatalogDiscountType:
      type: string
      description: How to apply a CatalogDiscount to a CatalogItem.
      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.
        x-release-status: PUBLIC
      - name: FIXED_AMOUNT
        description: Apply the discount as a fixed amount (e.g., $1.00) off the item
          price.
        x-release-status: PUBLIC
      - 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.
        x-release-status: PUBLIC
      - 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.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/enums.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogDiscountType
    CatalogItemProductType:
      type: string
      description: The type of a CatalogItem. Connect V2 only allows the creation
        of `REGULAR` or `APPOINTMENTS_SERVICE` items.
      enum:
      - REGULAR
      - GIFT_CARD
      - APPOINTMENTS_SERVICE
      - CLASS_TICKET
      x-enum-elements:
      - name: REGULAR
        description: An ordinary item.
        x-release-status: PUBLIC
      - name: GIFT_CARD
        description: A Square gift card.
        x-release-status: DEPRECATED
      - name: APPOINTMENTS_SERVICE
        description: A service that can be booked using the Square Appointments app.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/enums.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogItemProductType
    CatalogModifierListSelectionType:
      type: string
      description: Indicates whether a CatalogModifierList supports multiple selections.
      enum:
      - SINGLE
      - MULTIPLE
      x-enum-elements:
      - name: SINGLE
        description: |-
          Indicates that a CatalogModifierList allows only a
          single CatalogModifier to be selected.
        x-release-status: PUBLIC
      - name: MULTIPLE
        description: |-
          Indicates that a CatalogModifierList allows multiple
          CatalogModifier to be selected.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/enums.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogModifierListSelectionType
    CatalogObjectType:
      type: string
      description: |-
        Possible types of CatalogObjects returned from the catalog, each
        containing type-specific properties in the `*_data` field corresponding to the specfied object type.
      enum:
      - CATALOG_OBJECT_TYPE_DO_NOT_USE
      - ITEM
      - IMAGE
      - CATEGORY
      - ITEM_VARIATION
      - TAX
      - DISCOUNT
      - MODIFIER_LIST
      - MODIFIER
      - DINING_OPTION
      - TAX_EXEMPTION
      - SERVICE_CHARGE
      - PRICING_RULE
      - PRODUCT_SET
      - TIME_PERIOD
      - MEASUREMENT_UNIT
      - SUBSCRIPTION_PLAN
      - ITEM_OPTION
      - ITEM_OPTION_VAL
      - CUSTOM_ATTRIBUTE_DEFINITION
      - QUICK_AMOUNTS_SETTINGS
      - COMPONENT
      - COMPOSITION
      - RESOURCE
      - CHECKOUT_LINK
      - ADDRESS
      - SUBSCRIPTION_PRODUCT
      x-enum-elements:
      - name: ITEM
        description: |-
          The `CatalogObject` instance is of the [CatalogItem](entity:CatalogItem) type and represents an item. The item-specific data
          must be set on the `item_data` field.
        x-release-status: PUBLIC
      - name: IMAGE
        description: |-
          The `CatalogObject` instance is of the [CatalogImage](entity:CatalogImage) type and represents an image. The image-specific data
          must be set on the `image_data` field.
        x-release-status: PUBLIC
      - name: CATEGORY
        description: |-
          The `CatalogObject` instance is of the [CatalogCategory](entity:CatalogCategory) type and represents a category. The category-specific data
          must be set on the `category_data` field.
        x-release-status: PUBLIC
      - name: ITEM_VARIATION
        description: |-
          The `CatalogObject` instance is of the  [CatalogItemVariation](entity:CatalogItemVariation) type and represents an item variation, also referred to as variation.
          The item variation-specific data must be set on the `item_variation_data` field.
        x-release-status: PUBLIC
      - name: TAX
        description: |-
          The `CatalogObject` instance is of the [CatalogTax](entity:CatalogTax) type and represents a tax. The tax-specific data
          must be set on the `tax_data` field.
        x-release-status: PUBLIC
      - name: DISCOUNT
        description: |-
          The `CatalogObject` instance is of the [CatalogDiscount](entity:CatalogDiscount) type and represents a discount. The discount-specific data
          must be set on the `discount_data` field.
        x-release-status: PUBLIC
      - name: MODIFIER_LIST
        description: |-
          The `CatalogObject` instance is of the [CatalogModifierList](entity:CatalogModifierList) type and represents a modifier list.
          The modifier-list-specific data must be set on the `modifier_list_data` field.
        x-release-status: PUBLIC
      - name: MODIFIER
        description: |-
          The `CatalogObject` instance is of the [CatalogModifier](entity:CatalogModifier) type and represents a modifier. The modifier-specific data
          must be set on the `modifier_data` field.
        x-release-status: PUBLIC
      - name: PRICING_RULE
        description: |-
          The `CatalogObject` instance is of the [CatalogPricingRule](entity:CatalogPricingRule) type and represents a pricing rule. The pricing-rule-specific data
          must be set on the `pricing_rule_data` field.
        x-release-status: BETA
      - name: PRODUCT_SET
        description: |-
          The `CatalogObject` instance is of the [CatalogProductSet](entity:CatalogProductSet) type and represents a product set.
          The product-set-specific data will be stored in the `product_set_data` field.
        x-release-status: BETA
      - name: TIME_PERIOD
        description: |-
          The `CatalogObject` instance is of the [CatalogTimePeriod](entity:CatalogTimePeriod) type and represents a time period.
          The time-period-specific data must be set on the `time_period_data` field.
        x-release-status: BETA
      - name: MEASUREMENT_UNIT
        description: |-
          The `CatalogObject` instance is of the [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) type and represents a measurement unit specifying the unit of
          measure and precision in which an item variation is sold. The measurement-unit-specific data must set on the `measurement_unit_data` field.
        x-release-status: BETA
      - name: SUBSCRIPTION_PLAN
        description: |-
          The `CatalogObject` instance is of the [CatalogSubscriptionPlan](entity:CatalogSubscriptionPlan) type and represents a subscription plan.
          The subscription-plan-specific data must be stored on the `subscription_plan_data` field.
        x-release-status: BETA
      - 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."
        x-release-status: BETA
      - 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.
          For example, an item option of "Size" may have item option values such as "Small" or "Medium".
          The item-option-value-specific data must be on the `item_option_value_data` field.
        x-release-status: BETA
      - 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."
        x-release-status: BETA
      - 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."
        x-release-status: BETA
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/enums.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogObjectType
    CatalogPricingType:
      type: string
      description: Indicates whether the price of a CatalogItemVariation should be
        entered manually at the time of sale.
      enum:
      - FIXED_PRICING
      - VARIABLE_PRICING
      x-enum-elements:
      - name: FIXED_PRICING
        description: The catalog item variation's price is fixed.
        x-release-status: PUBLIC
      - name: VARIABLE_PRICING
        description: The catalog item variation's price is entered at the time of
          sale.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/enums.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogPricingType
    CatalogQuickAmountType:
      type: string
      description: Determines the type of a specific Quick Amount.
      enum:
      - QUICK_AMOUNT_TYPE_DO_NOT_USE
      - 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.
        x-release-status: BETA
      - name: QUICK_AMOUNT_TYPE_AUTO
        description: Quick Amount is generated automatically by machine learning algorithms.
        x-release-status: BETA
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/enums.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogQuickAmountType
    CatalogQuickAmountsSettingsOption:
      type: string
      description: Determines a seller's option on Quick Amounts feature.
      enum:
      - QUICK_AMOUNTS_SETTINGS_OPTION_DO_NOT_USE
      - DISABLED
      - MANUAL
      - AUTO
      x-enum-elements:
      - name: DISABLED
        description: Option for seller to disable Quick Amounts.
        x-release-status: BETA
      - name: MANUAL
        description: Option for seller to choose manually created Quick Amounts.
        x-release-status: BETA
      - name: AUTO
        description: Option for seller to choose automatically created Quick Amounts.
        x-release-status: BETA
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/enums.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogQuickAmountsSettingsOption
    EcomVisibility:
      type: string
      description: Determines item visibility in Ecom (Online Store) and Online Checkout.
      enum:
      - ECOM_VISIBILITY_DO_NOT_USE
      - UNINDEXED
      - UNAVAILABLE
      - HIDDEN
      - VISIBLE
      x-enum-elements:
      - name: UNINDEXED
        description: Item is not synced with Ecom (Weebly). This is the default state
        x-release-status: PUBLIC
      - name: UNAVAILABLE
        description: Item is synced but is unavailable within Ecom (Weebly) and Online
          Checkout
        x-release-status: PUBLIC
      - name: HIDDEN
        description: Option for seller to choose manually created Quick Amounts.
        x-release-status: PUBLIC
      - name: VISIBLE
        description: Item is synced but available within Ecom (Weebly) and Online
          Checkout but is hidden from Ecom Store.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/enums.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: EcomVisibility
    ExcludeStrategy:
      type: string
      description: |-
        Indicates which products matched by a CatalogPricingRule
        will be excluded if the pricing rule uses an exclude set.
      enum:
      - EXCLUDE_STRATEGY_DO_NOT_USE
      - LEAST_EXPENSIVE
      - MOST_EXPENSIVE
      x-enum-elements:
      - name: LEAST_EXPENSIVE
        description: |-
          The least expensive matched products are excluded from the pricing. If
          the pricing rule is set to exclude one product and multiple products in the
          match set qualify as least expensive, then one will be excluded at random.

          Excluding the least expensive product gives the best discount value to the buyer.
        x-release-status: BETA
      - name: MOST_EXPENSIVE
        description: |-
          The most expensive matched product is excluded from the pricing rule.
          If multiple products have the same price and all qualify as least expensive,
          one will be excluded at random.

          This guarantees that the most expensive product is purchased at full price.
        x-release-status: BETA
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/enums.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: ExcludeStrategy
    InventoryAlertType:
      type: string
      description: Indicates whether Square should alert the merchant when the inventory
        quantity of a CatalogItemVariation is low.
      enum:
      - INVENTORY_ALERT_TYPE_DO_NOT_USE
      - NONE
      - LOW_QUANTITY
      x-enum-elements:
      - name: NONE
        description: The variation does not display an alert.
        x-release-status: PUBLIC
      - name: LOW_QUANTITY
        description: The variation generates an alert when its quantity is low.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/enums.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: InventoryAlertType
    SubscriptionCadence:
      type: string
      description: Determines the billing cadence of a [Subscription](entity:Subscription)
      enum:
      - SUBSCRIPTION_CADENCE_DO_NOT_USE
      - 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
        x-release-status: PUBLIC
      - name: WEEKLY
        description: Once per week
        x-release-status: PUBLIC
      - name: EVERY_TWO_WEEKS
        description: Every two weeks
        x-release-status: PUBLIC
      - name: THIRTY_DAYS
        description: Once every 30 days
        x-release-status: PUBLIC
      - name: SIXTY_DAYS
        description: Once every 60 days
        x-release-status: PUBLIC
      - name: NINETY_DAYS
        description: Once every 90 days
        x-release-status: PUBLIC
      - name: MONTHLY
        description: Once per month
        x-release-status: PUBLIC
      - name: EVERY_TWO_MONTHS
        description: Once every two months
        x-release-status: PUBLIC
      - name: QUARTERLY
        description: Once every three months
        x-release-status: PUBLIC
      - name: EVERY_FOUR_MONTHS
        description: Once every four months
        x-release-status: PUBLIC
      - name: EVERY_SIX_MONTHS
        description: Once every six months
        x-release-status: PUBLIC
      - name: ANNUAL
        description: Once per year
        x-release-status: PUBLIC
      - name: EVERY_TWO_YEARS
        description: Once every two years
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/enums.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: SubscriptionCadence
    TaxCalculationPhase:
      type: string
      description: When to calculate the taxes due on a cart.
      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.
        x-release-status: PUBLIC
      - name: TAX_TOTAL_PHASE
        description: The fee is calculated based on the payment's total.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/enums.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: TaxCalculationPhase
    TaxInclusionType:
      type: string
      description: Whether to the tax amount should be additional to or included in
        the CatalogItem price.
      enum:
      - ADDITIVE
      - INCLUSIVE
      x-enum-elements:
      - name: ADDITIVE
        description: |-
          The tax is an additive tax. The tax amount is added on top of the
          CatalogItemVariation price. For example, a $1.00 item with a 10% additive
          tax would have a total cost to the buyer of $1.10.
        x-release-status: PUBLIC
      - name: INCLUSIVE
        description: |-
          The tax is an inclusive tax. The tax amount is included in the
          CatalogItemVariation price. For example, a $1.00 item with a 10% inclusive
          tax would have a total cost to the buyer of $1.00, with $0.91 (91 cents) of
          that total being the cost of the item and $0.09 (9 cents) being tax.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/enums.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: TaxInclusionType
    SearchCatalogItemsRequestStockLevel:
      type: string
      description: Defines supported stock levels of the item inventory.
      enum:
      - STOCK_LEVEL_DO_NOT_USE
      - OUT
      - LOW
      x-enum-elements:
      - name: OUT
        description: The item inventory is empty.
        x-release-status: PUBLIC
      - name: LOW
        description: The item inventory is low.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/search-catalog-items.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: SearchCatalogItemsRequestStockLevel
    CardBrand:
      type: string
      description: Indicates a card's brand, such as `VISA` or `MASTERCARD`.
      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: ""
        x-release-status: PUBLIC
      - name: VISA
        description: ""
        x-release-status: PUBLIC
      - name: MASTERCARD
        description: ""
        x-release-status: PUBLIC
      - name: AMERICAN_EXPRESS
        description: ""
        x-release-status: PUBLIC
      - name: DISCOVER
        description: ""
        x-release-status: PUBLIC
      - name: DISCOVER_DINERS
        description: ""
        x-release-status: PUBLIC
      - name: JCB
        description: ""
        x-release-status: PUBLIC
      - name: CHINA_UNIONPAY
        description: ""
        x-release-status: PUBLIC
      - name: SQUARE_GIFT_CARD
        description: ""
        x-release-status: PUBLIC
      - name: SQUARE_CAPITAL_CARD
        description: ""
        x-release-status: PUBLIC
      - name: INTERAC
        description: ""
        x-release-status: PUBLIC
      - name: EFTPOS
        description: ""
        x-release-status: PUBLIC
      - name: FELICA
        description: ""
        x-release-status: PUBLIC
      - name: EBT
        description: ""
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/card.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: CardBrand
    CardCoBrand:
      type: string
      description: Indicates the brand for a co-branded card.
      enum:
      - UNKNOWN
      - AFTERPAY
      - CLEARPAY
      x-enum-elements:
      - name: UNKNOWN
        description: ""
        x-release-status: PUBLIC
      - name: AFTERPAY
        description: ""
        x-release-status: PUBLIC
      - name: CLEARPAY
        description: ""
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/card.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: CardCoBrand
    CardPrepaidType:
      type: string
      description: Indicates a card's prepaid type, such as `NOT_PREPAID` or `PREPAID`.
      enum:
      - UNKNOWN_PREPAID_TYPE
      - NOT_PREPAID
      - PREPAID
      x-enum-elements:
      - name: UNKNOWN_PREPAID_TYPE
        description: ""
        x-release-status: PUBLIC
      - name: NOT_PREPAID
        description: ""
        x-release-status: PUBLIC
      - name: PREPAID
        description: ""
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/card.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: CardPrepaidType
    CardType:
      type: string
      description: Indicates a card's type, such as `CREDIT` or `DEBIT`.
      enum:
      - UNKNOWN_CARD_TYPE
      - CREDIT
      - DEBIT
      x-enum-elements:
      - name: UNKNOWN_CARD_TYPE
        description: ""
        x-release-status: PUBLIC
      - name: CREDIT
        description: ""
        x-release-status: PUBLIC
      - name: DEBIT
        description: ""
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/card.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: CardType
    Country:
      type: string
      description: |-
        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).
      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
        x-release-status: PUBLIC
      - name: AD
        description: Andorra
        x-release-status: PUBLIC
      - name: AE
        description: United Arab Emirates
        x-release-status: PUBLIC
      - name: AF
        description: Afghanistan
        x-release-status: PUBLIC
      - name: AG
        description: Antigua and Barbuda
        x-release-status: PUBLIC
      - name: AI
        description: Anguilla
        x-release-status: PUBLIC
      - name: AL
        description: Albania
        x-release-status: PUBLIC
      - name: AM
        description: Armenia
        x-release-status: PUBLIC
      - name: AO
        description: Angola
        x-release-status: PUBLIC
      - name: AQ
        description: Antartica
        x-release-status: PUBLIC
      - name: AR
        description: Argentina
        x-release-status: PUBLIC
      - name: AS
        description: American Samoa
        x-release-status: PUBLIC
      - name: AT
        description: Austria
        x-release-status: PUBLIC
      - name: AU
        description: Australia
        x-release-status: PUBLIC
      - name: AW
        description: Aruba
        x-release-status: PUBLIC
      - name: AX
        description: Åland Islands
        x-release-status: PUBLIC
      - name: AZ
        description: Azerbaijan
        x-release-status: PUBLIC
      - name: BA
        description: Bosnia and Herzegovina
        x-release-status: PUBLIC
      - name: BB
        description: Barbados
        x-release-status: PUBLIC
      - name: BD
        description: Bangladesh
        x-release-status: PUBLIC
      - name: BE
        description: Belgium
        x-release-status: PUBLIC
      - name: BF
        description: Burkina Faso
        x-release-status: PUBLIC
      - name: BG
        description: Bulgaria
        x-release-status: PUBLIC
      - name: BH
        description: Bahrain
        x-release-status: PUBLIC
      - name: BI
        description: Burundi
        x-release-status: PUBLIC
      - name: BJ
        description: Benin
        x-release-status: PUBLIC
      - name: BL
        description: Saint Barthélemy
        x-release-status: PUBLIC
      - name: BM
        description: Bermuda
        x-release-status: PUBLIC
      - name: BN
        description: Brunei
        x-release-status: PUBLIC
      - name: BO
        description: Bolivia
        x-release-status: PUBLIC
      - name: BQ
        description: Bonaire
        x-release-status: PUBLIC
      - name: BR
        description: Brazil
        x-release-status: PUBLIC
      - name: BS
        description: Bahamas
        x-release-status: PUBLIC
      - name: BT
        description: Bhutan
        x-release-status: PUBLIC
      - name: BV
        description: Bouvet Island
        x-release-status: PUBLIC
      - name: BW
        description: Botswana
        x-release-status: PUBLIC
      - name: BY
        description: Belarus
        x-release-status: PUBLIC
      - name: BZ
        description: Belize
        x-release-status: PUBLIC
      - name: CA
        description: Canada
        x-release-status: PUBLIC
      - name: CC
        description: Cocos Islands
        x-release-status: PUBLIC
      - name: CD
        description: Democratic Republic of the Congo
        x-release-status: PUBLIC
      - name: CF
        description: Central African Republic
        x-release-status: PUBLIC
      - name: CG
        description: Congo
        x-release-status: PUBLIC
      - name: CH
        description: Switzerland
        x-release-status: PUBLIC
      - name: CI
        description: Ivory Coast
        x-release-status: PUBLIC
      - name: CK
        description: Cook Islands
        x-release-status: PUBLIC
      - name: CL
        description: Chile
        x-release-status: PUBLIC
      - name: CM
        description: Cameroon
        x-release-status: PUBLIC
      - name: CN
        description: China
        x-release-status: PUBLIC
      - name: CO
        description: Colombia
        x-release-status: PUBLIC
      - name: CR
        description: Costa Rica
        x-release-status: PUBLIC
      - name: CU
        description: Cuba
        x-release-status: PUBLIC
      - name: CV
        description: Cabo Verde
        x-release-status: PUBLIC
      - name: CW
        description: Curaçao
        x-release-status: PUBLIC
      - name: CX
        description: Christmas Island
        x-release-status: PUBLIC
      - name: CY
        description: Cyprus
        x-release-status: PUBLIC
      - name: CZ
        description: Czechia
        x-release-status: PUBLIC
      - name: DE
        description: Germany
        x-release-status: PUBLIC
      - name: DJ
        description: Djibouti
        x-release-status: PUBLIC
      - name: DK
        description: Denmark
        x-release-status: PUBLIC
      - name: DM
        description: Dominica
        x-release-status: PUBLIC
      - name: DO
        description: Dominican Republic
        x-release-status: PUBLIC
      - name: DZ
        description: Algeria
        x-release-status: PUBLIC
      - name: EC
        description: Ecuador
        x-release-status: PUBLIC
      - name: EE
        description: Estonia
        x-release-status: PUBLIC
      - name: EG
        description: Egypt
        x-release-status: PUBLIC
      - name: EH
        description: Western Sahara
        x-release-status: PUBLIC
      - name: ER
        description: Eritrea
        x-release-status: PUBLIC
      - name: ES
        description: Spain
        x-release-status: PUBLIC
      - name: ET
        description: Ethiopia
        x-release-status: PUBLIC
      - name: FI
        description: Finland
        x-release-status: PUBLIC
      - name: FJ
        description: Fiji
        x-release-status: PUBLIC
      - name: FK
        description: Falkland Islands
        x-release-status: PUBLIC
      - name: FM
        description: Federated States of Micronesia
        x-release-status: PUBLIC
      - name: FO
        description: Faroe Islands
        x-release-status: PUBLIC
      - name: FR
        description: France
        x-release-status: PUBLIC
      - name: GA
        description: Gabon
        x-release-status: PUBLIC
      - name: GB
        description: United Kingdom
        x-release-status: PUBLIC
      - name: GD
        description: Grenada
        x-release-status: PUBLIC
      - name: GE
        description: Georgia
        x-release-status: PUBLIC
      - name: GF
        description: French Guiana
        x-release-status: PUBLIC
      - name: GG
        description: Guernsey
        x-release-status: PUBLIC
      - name: GH
        description: Ghana
        x-release-status: PUBLIC
      - name: GI
        description: Gibraltar
        x-release-status: PUBLIC
      - name: GL
        description: Greenland
        x-release-status: PUBLIC
      - name: GM
        description: Gambia
        x-release-status: PUBLIC
      - name: GN
        description: Guinea
        x-release-status: PUBLIC
      - name: GP
        description: Guadeloupe
        x-release-status: PUBLIC
      - name: GQ
        description: Equatorial Guinea
        x-release-status: PUBLIC
      - name: GR
        description: Greece
        x-release-status: PUBLIC
      - name: GS
        description: South Georgia and the South Sandwich Islands
        x-release-status: PUBLIC
      - name: GT
        description: Guatemala
        x-release-status: PUBLIC
      - name: GU
        description: Guam
        x-release-status: PUBLIC
      - name: GW
        description: Guinea-Bissau
        x-release-status: PUBLIC
      - name: GY
        description: Guyana
        x-release-status: PUBLIC
      - name: HK
        description: Hong Kong
        x-release-status: PUBLIC
      - name: HM
        description: Heard Island and McDonald Islands
        x-release-status: PUBLIC
      - name: HN
        description: Honduras
        x-release-status: PUBLIC
      - name: HR
        description: Croatia
        x-release-status: PUBLIC
      - name: HT
        description: Haiti
        x-release-status: PUBLIC
      - name: HU
        description: Hungary
        x-release-status: PUBLIC
      - name: ID
        description: Indonesia
        x-release-status: PUBLIC
      - name: IE
        description: Ireland
        x-release-status: PUBLIC
      - name: IL
        description: Israel
        x-release-status: PUBLIC
      - name: IM
        description: Isle of Man
        x-release-status: PUBLIC
      - name: IN
        description: India
        x-release-status: PUBLIC
      - name: IO
        description: British Indian Ocean Territory
        x-release-status: PUBLIC
      - name: IQ
        description: Iraq
        x-release-status: PUBLIC
      - name: IR
        description: Iran
        x-release-status: PUBLIC
      - name: IS
        description: Iceland
        x-release-status: PUBLIC
      - name: IT
        description: Italy
        x-release-status: PUBLIC
      - name: JE
        description: Jersey
        x-release-status: PUBLIC
      - name: JM
        description: Jamaica
        x-release-status: PUBLIC
      - name: JO
        description: Jordan
        x-release-status: PUBLIC
      - name: JP
        description: Japan
        x-release-status: PUBLIC
      - name: KE
        description: Kenya
        x-release-status: PUBLIC
      - name: KG
        description: Kyrgyzstan
        x-release-status: PUBLIC
      - name: KH
        description: Cambodia
        x-release-status: PUBLIC
      - name: KI
        description: Kiribati
        x-release-status: PUBLIC
      - name: KM
        description: Comoros
        x-release-status: PUBLIC
      - name: KN
        description: Saint Kitts and Nevis
        x-release-status: PUBLIC
      - name: KP
        description: Democratic People's Republic of Korea
        x-release-status: PUBLIC
      - name: KR
        description: Republic of Korea
        x-release-status: PUBLIC
      - name: KW
        description: Kuwait
        x-release-status: PUBLIC
      - name: KY
        description: Cayman Islands
        x-release-status: PUBLIC
      - name: KZ
        description: Kazakhstan
        x-release-status: PUBLIC
      - name: LA
        description: Lao People's Democratic Republic
        x-release-status: PUBLIC
      - name: LB
        description: Lebanon
        x-release-status: PUBLIC
      - name: LC
        description: Saint Lucia
        x-release-status: PUBLIC
      - name: LI
        description: Liechtenstein
        x-release-status: PUBLIC
      - name: LK
        description: Sri Lanka
        x-release-status: PUBLIC
      - name: LR
        description: Liberia
        x-release-status: PUBLIC
      - name: LS
        description: Lesotho
        x-release-status: PUBLIC
      - name: LT
        description: Lithuania
        x-release-status: PUBLIC
      - name: LU
        description: Luxembourg
        x-release-status: PUBLIC
      - name: LV
        description: Latvia
        x-release-status: PUBLIC
      - name: LY
        description: Libya
        x-release-status: PUBLIC
      - name: MA
        description: Morocco
        x-release-status: PUBLIC
      - name: MC
        description: Monaco
        x-release-status: PUBLIC
      - name: MD
        description: Moldova
        x-release-status: PUBLIC
      - name: ME
        description: Montenegro
        x-release-status: PUBLIC
      - name: MF
        description: Saint Martin
        x-release-status: PUBLIC
      - name: MG
        description: Madagascar
        x-release-status: PUBLIC
      - name: MH
        description: Marshall Islands
        x-release-status: PUBLIC
      - name: MK
        description: North Macedonia
        x-release-status: PUBLIC
      - name: ML
        description: Mali
        x-release-status: PUBLIC
      - name: MM
        description: Myanmar
        x-release-status: PUBLIC
      - name: MN
        description: Mongolia
        x-release-status: PUBLIC
      - name: MO
        description: Macao
        x-release-status: PUBLIC
      - name: MP
        description: Northern Mariana Islands
        x-release-status: PUBLIC
      - name: MQ
        description: Martinique
        x-release-status: PUBLIC
      - name: MR
        description: Mauritania
        x-release-status: PUBLIC
      - name: MS
        description: Montserrat
        x-release-status: PUBLIC
      - name: MT
        description: Malta
        x-release-status: PUBLIC
      - name: MU
        description: Mauritius
        x-release-status: PUBLIC
      - name: MV
        description: Maldives
        x-release-status: PUBLIC
      - name: MW
        description: Malawi
        x-release-status: PUBLIC
      - name: MX
        description: Mexico
        x-release-status: PUBLIC
      - name: MY
        description: Malaysia
        x-release-status: PUBLIC
      - name: MZ
        description: Mozambique
        x-release-status: PUBLIC
      - name: NA
        description: Namibia
        x-release-status: PUBLIC
      - name: NC
        description: New Caledonia
        x-release-status: PUBLIC
      - name: NE
        description: Niger
        x-release-status: PUBLIC
      - name: NF
        description: Norfolk Island
        x-release-status: PUBLIC
      - name: NG
        description: Nigeria
        x-release-status: PUBLIC
      - name: NI
        description: Nicaragua
        x-release-status: PUBLIC
      - name: NL
        description: Netherlands
        x-release-status: PUBLIC
      - name: "NO"
        description: Norway
        x-release-status: PUBLIC
      - name: NP
        description: Nepal
        x-release-status: PUBLIC
      - name: NR
        description: Nauru
        x-release-status: PUBLIC
      - name: NU
        description: Niue
        x-release-status: PUBLIC
      - name: NZ
        description: New Zealand
        x-release-status: PUBLIC
      - name: OM
        description: Oman
        x-release-status: PUBLIC
      - name: PA
        description: Panama
        x-release-status: PUBLIC
      - name: PE
        description: Peru
        x-release-status: PUBLIC
      - name: PF
        description: French Polynesia
        x-release-status: PUBLIC
      - name: PG
        description: Papua New Guinea
        x-release-status: PUBLIC
      - name: PH
        description: Philippines
        x-release-status: PUBLIC
      - name: PK
        description: Pakistan
        x-release-status: PUBLIC
      - name: PL
        description: Poland
        x-release-status: PUBLIC
      - name: PM
        description: Saint Pierre and Miquelon
        x-release-status: PUBLIC
      - name: PN
        description: Pitcairn
        x-release-status: PUBLIC
      - name: PR
        description: Puerto Rico
        x-release-status: PUBLIC
      - name: PS
        description: Palestine
        x-release-status: PUBLIC
      - name: PT
        description: Portugal
        x-release-status: PUBLIC
      - name: PW
        description: Palau
        x-release-status: PUBLIC
      - name: PY
        description: Paraguay
        x-release-status: PUBLIC
      - name: QA
        description: Qatar
        x-release-status: PUBLIC
      - name: RE
        description: Réunion
        x-release-status: PUBLIC
      - name: RO
        description: Romania
        x-release-status: PUBLIC
      - name: RS
        description: Serbia
        x-release-status: PUBLIC
      - name: RU
        description: Russia
        x-release-status: PUBLIC
      - name: RW
        description: Rwanda
        x-release-status: PUBLIC
      - name: SA
        description: Saudi Arabia
        x-release-status: PUBLIC
      - name: SB
        description: Solomon Islands
        x-release-status: PUBLIC
      - name: SC
        description: Seychelles
        x-release-status: PUBLIC
      - name: SD
        description: Sudan
        x-release-status: PUBLIC
      - name: SE
        description: Sweden
        x-release-status: PUBLIC
      - name: SG
        description: Singapore
        x-release-status: PUBLIC
      - name: SH
        description: Saint Helena, Ascension and Tristan da Cunha
        x-release-status: PUBLIC
      - name: SI
        description: Slovenia
        x-release-status: PUBLIC
      - name: SJ
        description: Svalbard and Jan Mayen
        x-release-status: PUBLIC
      - name: SK
        description: Slovakia
        x-release-status: PUBLIC
      - name: SL
        description: Sierra Leone
        x-release-status: PUBLIC
      - name: SM
        description: San Marino
        x-release-status: PUBLIC
      - name: SN
        description: Senegal
        x-release-status: PUBLIC
      - name: SO
        description: Somalia
        x-release-status: PUBLIC
      - name: SR
        description: Suriname
        x-release-status: PUBLIC
      - name: SS
        description: South Sudan
        x-release-status: PUBLIC
      - name: ST
        description: Sao Tome and Principe
        x-release-status: PUBLIC
      - name: SV
        description: El Salvador
        x-release-status: PUBLIC
      - name: SX
        description: Sint Maarten
        x-release-status: PUBLIC
      - name: SY
        description: Syrian Arab Republic
        x-release-status: PUBLIC
      - name: SZ
        description: Eswatini
        x-release-status: PUBLIC
      - name: TC
        description: Turks and Caicos Islands
        x-release-status: PUBLIC
      - name: TD
        description: Chad
        x-release-status: PUBLIC
      - name: TF
        description: French Southern Territories
        x-release-status: PUBLIC
      - name: TG
        description: Togo
        x-release-status: PUBLIC
      - name: TH
        description: Thailand
        x-release-status: PUBLIC
      - name: TJ
        description: Tajikistan
        x-release-status: PUBLIC
      - name: TK
        description: Tokelau
        x-release-status: PUBLIC
      - name: TL
        description: Timor-Leste
        x-release-status: PUBLIC
      - name: TM
        description: Turkmenistan
        x-release-status: PUBLIC
      - name: TN
        description: Tunisia
        x-release-status: PUBLIC
      - name: TO
        description: Tonga
        x-release-status: PUBLIC
      - name: TR
        description: Turkey
        x-release-status: PUBLIC
      - name: TT
        description: Trinidad and Tobago
        x-release-status: PUBLIC
      - name: TV
        description: Tuvalu
        x-release-status: PUBLIC
      - name: TW
        description: Taiwan
        x-release-status: PUBLIC
      - name: TZ
        description: Tanzania
        x-release-status: PUBLIC
      - name: UA
        description: Ukraine
        x-release-status: PUBLIC
      - name: UG
        description: Uganda
        x-release-status: PUBLIC
      - name: UM
        description: United States Minor Outlying Islands
        x-release-status: PUBLIC
      - name: US
        description: United States of America
        x-release-status: PUBLIC
      - name: UY
        description: Uruguay
        x-release-status: PUBLIC
      - name: UZ
        description: Uzbekistan
        x-release-status: PUBLIC
      - name: VA
        description: Vatican City
        x-release-status: PUBLIC
      - name: VC
        description: Saint Vincent and the Grenadines
        x-release-status: PUBLIC
      - name: VE
        description: Venezuela
        x-release-status: PUBLIC
      - name: VG
        description: British Virgin Islands
        x-release-status: PUBLIC
      - name: VI
        description: U.S. Virgin Islands
        x-release-status: PUBLIC
      - name: VN
        description: Vietnam
        x-release-status: PUBLIC
      - name: VU
        description: Vanuatu
        x-release-status: PUBLIC
      - name: WF
        description: Wallis and Futuna
        x-release-status: PUBLIC
      - name: WS
        description: Samoa
        x-release-status: PUBLIC
      - name: YE
        description: Yemen
        x-release-status: PUBLIC
      - name: YT
        description: Mayotte
        x-release-status: PUBLIC
      - name: ZA
        description: South Africa
        x-release-status: PUBLIC
      - name: ZM
        description: Zambia
        x-release-status: PUBLIC
      - name: ZW
        description: Zimbabwe
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/country.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: Country
    CustomerCreationSource:
      type: string
      description: Indicates the method used to create the customer profile.
      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
          compatibility when the original source of a customer profile is
          unrecognized. For example, when older clients do not support newer
          source types.
        x-release-status: PUBLIC
      - name: APPOINTMENTS
        description: |-
          The customer profile was created automatically when an appointment
          was scheduled.
        x-release-status: PUBLIC
      - name: COUPON
        description: |-
          The customer profile was created automatically when a coupon was issued
          using Square Point of Sale.
        x-release-status: PUBLIC
      - name: DELETION_RECOVERY
        description: |-
          The customer profile was restored through Square's deletion recovery
          process.
        x-release-status: PUBLIC
      - name: DIRECTORY
        description: "The customer profile was created manually through Square Seller\
          \ Dashboard or the \nPoint of Sale application."
        x-release-status: PUBLIC
      - name: EGIFTING
        description: |-
          The customer profile was created automatically when a gift card was
          issued using Square Point of Sale. Customer profiles are created for
          both the buyer and the recipient of the gift card.
        x-release-status: PUBLIC
      - name: EMAIL_COLLECTION
        description: |-
          The customer profile was created through Square Point of Sale when
          signing up for marketing emails during checkout.
        x-release-status: PUBLIC
      - name: FEEDBACK
        description: |-
          The customer profile was created automatically when providing feedback
          through a digital receipt.
        x-release-status: PUBLIC
      - name: IMPORT
        description: |-
          The customer profile was created automatically when importing customer
          data through Square Seller Dashboard.
        x-release-status: PUBLIC
      - name: INVOICES
        description: The customer profile was created automatically during an invoice
          payment.
        x-release-status: PUBLIC
      - name: LOYALTY
        description: |-
          The customer profile was created automatically when customers provide a
          phone number for loyalty reward programs during checkout.
        x-release-status: PUBLIC
      - name: MARKETING
        description: |-
          The customer profile was created as the result of a campaign managed
          through Square’s Facebook integration.
        x-release-status: PUBLIC
      - name: MERGE
        description: |-
          The customer profile was created as the result of explicitly merging
          multiple customer profiles through the Square Seller Dashboard or the Point of
          Sale application.
        x-release-status: PUBLIC
      - name: ONLINE_STORE
        description: |-
          The customer profile was created through Square's Online Store solution
          (legacy service).
        x-release-status: PUBLIC
      - name: INSTANT_PROFILE
        description: |-
          The customer profile was created automatically as the result of a successful
          transaction that did not explicitly link to an existing customer profile.
        x-release-status: PUBLIC
      - name: TERMINAL
        description: The customer profile was created through Square's Virtual Terminal.
        x-release-status: PUBLIC
      - name: THIRD_PARTY
        description: The customer profile was created through a Square API call.
        x-release-status: PUBLIC
      - name: THIRD_PARTY_IMPORT
        description: |-
          The customer profile was created by a third-party product and imported
          through an official integration.
        x-release-status: PUBLIC
      - name: UNMERGE_RECOVERY
        description: |-
          The customer profile was restored through Square's unmerge recovery
          process.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CustomerCreationSource
    CustomerInclusionExclusion:
      type: string
      description: |-
        Indicates whether customers should be included in, or excluded from,
        the result set when they match the filtering criteria.
      enum:
      - INCLUDE
      - EXCLUDE
      x-enum-elements:
      - name: INCLUDE
        description: |-
          Customers should be included in the result set when they match the
          filtering criteria.
        x-release-status: PUBLIC
      - name: EXCLUDE
        description: |-
          Customers should be excluded from the result set when they match
          the filtering criteria.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CustomerInclusionExclusion
    CustomerSortField:
      type: string
      description: Specifies customer attributes as the sort key to customer profiles
        returned from a search.
      enum:
      - DEFAULT
      - CREATED_AT
      x-enum-elements:
      - name: DEFAULT
        description: |-
          Use the default sort key. By default, customers are sorted
          alphanumerically by concatenating their `given_name` and `family_name`. If
          neither name field is set, string comparison is performed using one of the
          remaining fields in the following order: `company_name`, `email`,
          `phone_number`.
        x-release-status: PUBLIC
      - name: CREATED_AT
        description: Use the creation date attribute (`created_at`) of customer profiles
          as the sort key.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CustomerSortField
    ErrorCategory:
      type: string
      description: |-
        Indicates which high-level category of error has occurred during a
        request to the Connect API.
      enum:
      - API_ERROR
      - AUTHENTICATION_ERROR
      - INVALID_REQUEST_ERROR
      - RATE_LIMIT_ERROR
      - PAYMENT_METHOD_ERROR
      - REFUND_ERROR
      - MERCHANT_SUBSCRIPTION_ERROR
      x-enum-elements:
      - name: API_ERROR
        description: An error occurred with the Connect API itself.
        x-release-status: PUBLIC
      - name: AUTHENTICATION_ERROR
        description: |-
          An authentication error occurred. Most commonly, the request had
          a missing, malformed, or otherwise invalid `Authorization` header.
        x-release-status: PUBLIC
      - name: INVALID_REQUEST_ERROR
        description: |-
          The request was invalid. Most commonly, a required parameter was
          missing, or a provided parameter had an invalid value.
        x-release-status: PUBLIC
      - 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
          to Square APIs in a short period of time.

          Your 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)
          schedule 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.
        x-release-status: PUBLIC
      - name: PAYMENT_METHOD_ERROR
        description: |-
          An error occurred while processing a payment method. Most commonly,
          the details of the payment method were invalid (such as a card's CVV
          or expiration date).
        x-release-status: PUBLIC
      - name: REFUND_ERROR
        description: An error occurred while attempting to process a refund.
        x-release-status: PUBLIC
      - name: MERCHANT_SUBSCRIPTION_ERROR
        description: An error occurred when checking a merchant subscription status
        x-release-status: BETA
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/error.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: ErrorCategory
    ErrorCode:
      type: string
      description: |-
        Indicates the specific error that occurred during a request to a
        Square API.
      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
      - BUYER_NOT_FOUND
      - ONE_INSTRUMENT_EXPECTED
      - NO_FIELDS_SET
      - DEPRECATED_FIELD_SET
      - RETIRED_FIELD_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
      - JOB_TEMPLATE_NAME_TAKEN
      - CLIENT_NOT_SUPPORTED
      - 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
      - INVALID_PIN
      - MISSING_PIN
      - MISSING_ACCOUNT_TYPE
      - INVALID_POSTAL_CODE
      - INVALID_FEES
      - MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED
      - PAYMENT_LIMIT_EXCEEDED
      - GIFT_CARD_AVAILABLE_AMOUNT
      - GIFT_CARD_BUYER_DAILY_LIMIT_REACHED
      - GIFT_CARD_INVALID_AMOUNT
      - GIFT_CARD_MAX_VALUE_REACHED
      - GIFT_CARD_MERCHANT_MAX_OUTSTANDING_BALANCE_REACHED
      - GIFT_CARD_VALUE_ADDITION_LIMIT_REACHED
      - 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
      - REFUND_DECLINED
      - INVALID_CARD_DATA
      - SOURCE_USED
      - SOURCE_EXPIRED
      - UNSUPPORTED_LOYALTY_REWARD_TIER
      - LOCATION_MISMATCH
      - ORDER_EXPIRED
      - ORDER_ALREADY_USED
      - ORDER_TOO_MANY_CATALOG_OBJECTS
      - INSUFFICIENT_INVENTORY
      - PRICE_MISMATCH
      - VERSION_MISMATCH
      - 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
      - INVALID_URL
      - HTTPS_ONLY
      - UNREACHABLE_URL
      - SESSION_EXPIRED
      - INVALID_VERIFICATION_CODE
      - 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
      - BLOCKED_BY_BLOCKLIST
      - FULFILLMENT_PREFERENCES_RESTRICTED_DATE_NOT_UNIQUE
      - FULFILLMENT_PREFERENCES_INVALID_SCHEDULING_DATETIME
      - FULFILLMENT_PREFERENCES_FULFILLMENT_SCHEDULE_NOT_ALLOWED
      - FULFILLMENT_PREFERENCES_ASSIGNMENT_IS_IMMUTABLE
      - INVALID_TIMEZONE
      - UNKNOWN_BODY_PARAMETER
      - FULFILLMENT_PREFERENCES_CONFLICTING_ASSIGNMENT_TYPE
      - 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
      - CLIENT_CLOSED_REQUEST
      - NOT_IMPLEMENTED
      - BAD_GATEWAY
      - SERVICE_UNAVAILABLE
      - TEMPORARY_ERROR
      - GATEWAY_TIMEOUT
      x-enum-elements:
      - name: INTERNAL_SERVER_ERROR
        description: A general server error occurred.
        x-release-status: PUBLIC
        error-category: API_ERROR
        http-code: 500
      - name: UNAUTHORIZED
        description: A general authorization error occurred.
        x-release-status: PUBLIC
        error-category: AUTHENTICATION_ERROR
        http-code: 401
      - name: ACCESS_TOKEN_EXPIRED
        description: The provided access token has expired.
        x-release-status: PUBLIC
        error-category: AUTHENTICATION_ERROR
        http-code: 401
      - name: ACCESS_TOKEN_REVOKED
        description: The provided access token has been revoked.
        x-release-status: PUBLIC
        error-category: AUTHENTICATION_ERROR
        http-code: 401
      - name: CLIENT_DISABLED
        description: The provided client has been disabled.
        x-release-status: PUBLIC
        error-category: AUTHENTICATION_ERROR
        http-code: 401
      - name: FORBIDDEN
        description: A general access error occurred.
        x-release-status: PUBLIC
        error-category: AUTHENTICATION_ERROR
        http-code: 403
      - name: INSUFFICIENT_SCOPES
        description: |-
          The provided access token does not have permission
          to execute the requested action.
        x-release-status: PUBLIC
        error-category: AUTHENTICATION_ERROR
        http-code: 403
      - name: APPLICATION_DISABLED
        description: The calling application was disabled.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 403
      - name: V1_APPLICATION
        description: |-
          The calling application was created prior to
          2016-03-30 and is not compatible with v2 Square API calls.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 403
      - name: V1_ACCESS_TOKEN
        description: |-
          The calling application is using an access token
          created prior to 2016-03-30 and is not compatible with v2 Square API
          calls.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 403
      - name: CARD_PROCESSING_NOT_ENABLED
        description: |-
          The location provided in the API call is not
          enabled for credit card processing.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 403
      - name: MERCHANT_SUBSCRIPTION_NOT_FOUND
        description: A required subscription was not found for the merchant
        x-release-status: BETA
        error-category: MERCHANT_SUBSCRIPTION_ERROR
        http-code: 403
      - name: BAD_REQUEST
        description: A general error occurred with the request.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: MISSING_REQUIRED_PARAMETER
        description: |-
          The request is missing a required path, query, or
          body parameter.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: INCORRECT_TYPE
        description: |-
          The value provided in the request is the wrong
          type. For example, a string instead of an integer.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: INVALID_TIME
        description: |-
          Formatting for the provided time value is
          incorrect.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: INVALID_TIME_RANGE
        description: |-
          The time range provided in the request is invalid.
          For example, the end time is before the start time.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: INVALID_VALUE
        description: |-
          The provided value is invalid. For example,
          including `%` in a phone number.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: INVALID_CURSOR
        description: |-
          The pagination cursor included in the request is
          invalid.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: UNKNOWN_QUERY_PARAMETER
        description: |-
          The query parameters provided is invalid for the
          requested endpoint.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: CONFLICTING_PARAMETERS
        description: |-
          One or more of the request parameters conflict with
          each other.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: EXPECTED_JSON_BODY
        description: The request body is not a JSON object.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: INVALID_SORT_ORDER
        description: |-
          The provided sort order is not a valid key.
          Currently, sort order must be `ASC` or `DESC`.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: VALUE_REGEX_MISMATCH
        description: |-
          The provided value does not match an expected
          regular expression.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: VALUE_TOO_SHORT
        description: |-
          The provided string value is shorter than the
          minimum length allowed.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: VALUE_TOO_LONG
        description: |-
          The provided string value is longer than the
          maximum length allowed.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: VALUE_TOO_LOW
        description: |-
          The provided value is less than the supported
          minimum.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: VALUE_TOO_HIGH
        description: |-
          The provided value is greater than the supported
          maximum.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: VALUE_EMPTY
        description: |-
          The provided value has a default (empty) value
          such as a blank string.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: ARRAY_LENGTH_TOO_LONG
        description: The provided array has too many elements.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: ARRAY_LENGTH_TOO_SHORT
        description: The provided array has too few elements.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: ARRAY_EMPTY
        description: The provided array is empty.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: EXPECTED_BOOLEAN
        description: |-
          The endpoint expected the provided value to be a
          boolean.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: EXPECTED_INTEGER
        description: |-
          The endpoint expected the provided value to be an
          integer.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: EXPECTED_FLOAT
        description: |-
          The endpoint expected the provided value to be a
          float.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: EXPECTED_STRING
        description: |-
          The endpoint expected the provided value to be a
          string.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: EXPECTED_OBJECT
        description: |-
          The endpoint expected the provided value to be a
          JSON object.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: EXPECTED_ARRAY
        description: |-
          The endpoint expected the provided value to be an
          array or list.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: EXPECTED_MAP
        description: |-
          The endpoint expected the provided value to be a
          map or associative array.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: EXPECTED_BASE64_ENCODED_BYTE_ARRAY
        description: |-
          The endpoint expected the provided value to be an
          array encoded in base64.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: INVALID_ARRAY_VALUE
        description: |-
          One or more objects in the array does not match the
          array type.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: INVALID_ENUM_VALUE
        description: |-
          The provided static string is not valid for the
          field.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: INVALID_CONTENT_TYPE
        description: Invalid content type header.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: INVALID_FORM_VALUE
        description: |-
          Only relevant for applications created prior to
          2016-03-30. Indicates there was an error while parsing form values.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: CUSTOMER_NOT_FOUND
        description: The provided customer id can't be found in the merchant's customers
          list.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: ONE_INSTRUMENT_EXPECTED
        description: A general error occurred.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: NO_FIELDS_SET
        description: A general error occurred.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: DEPRECATED_FIELD_SET
        description: ""
        x-release-status: RETIRED
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: RETIRED_FIELD_SET
        description: ""
        x-release-status: RETIRED
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: TOO_MANY_MAP_ENTRIES
        description: Too many entries in the map field.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: MAP_KEY_LENGTH_TOO_SHORT
        description: The length of one of the provided keys in the map is too short.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: MAP_KEY_LENGTH_TOO_LONG
        description: The length of one of the provided keys in the map is too long.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: CUSTOMER_MISSING_NAME
        description: The provided customer does not have a recorded name.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: CUSTOMER_MISSING_EMAIL
        description: The provided customer does not have a recorded email.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: INVALID_PAUSE_LENGTH
        description: The subscription cannot be paused longer than the duration of
          the current phase.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: INVALID_DATE
        description: The subscription cannot be paused/resumed on the given date.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: CARD_EXPIRED
        description: The card issuer declined the request because the card is expired.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: INVALID_EXPIRATION
        description: |-
          The expiration date for the payment card is invalid. For example,
          it indicates a date in the past.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: INVALID_EXPIRATION_YEAR
        description: |-
          The expiration year for the payment card is invalid. For example,
          it indicates a year in the past or contains invalid characters.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: INVALID_EXPIRATION_DATE
        description: |-
          The expiration date for the payment card is invalid. For example,
          it contains invalid characters.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: UNSUPPORTED_CARD_BRAND
        description: The credit card provided is not from a supported issuer.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: UNSUPPORTED_ENTRY_METHOD
        description: The entry method for the credit card (swipe, dip, tap) is not
          supported.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: INVALID_ENCRYPTED_CARD
        description: The encrypted card information is invalid.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: INVALID_CARD
        description: The credit card cannot be validated based on the provided details.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: PAYMENT_AMOUNT_MISMATCH
        description: |-
          The payment was declined because there was a payment amount mismatch.
          The money amount Square was expecting does not match the amount provided.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: GENERIC_DECLINE
        description: |-
          Square received a decline without any additional information.
          If the payment information seems correct, the buyer can contact their
          issuer to ask for more information.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: CVV_FAILURE
        description: The card issuer declined the request because the CVV value is
          invalid.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: ADDRESS_VERIFICATION_FAILURE
        description: The card issuer declined the request because the postal code
          is invalid.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: INVALID_ACCOUNT
        description: The issuer was not able to locate the account on record.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: CURRENCY_MISMATCH
        description: |-
          The currency associated with the payment is not valid for the provided
          funding source. For example, a gift card funded in USD cannot be used to process
          payments in GBP.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: INSUFFICIENT_FUNDS
        description: The funding source has insufficient funds to cover the payment.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: INSUFFICIENT_PERMISSIONS
        description: |-
          The Square account does not have the permissions to accept
          this payment. For example, Square may limit which merchants are
          allowed to receive gift card payments.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: CARDHOLDER_INSUFFICIENT_PERMISSIONS
        description: |-
          The card issuer has declined the transaction due to restrictions on where the card can be used.
          For example, a gift card is limited to a single merchant.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: INVALID_LOCATION
        description: |-
          The Square account cannot take payments in the specified region.
          A Square account can take payments only from the region where the account was created.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: TRANSACTION_LIMIT
        description: |-
          The card issuer has determined the payment amount is either too high or too low.
          The API returns the error code mostly for credit cards (for example, the card reached
          the credit limit). However, sometimes the issuer bank can indicate the error for debit
          or prepaid cards (for example, card has insufficient funds).
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: VOICE_FAILURE
        description: The card issuer declined the request because the issuer requires
          voice authorization from the cardholder.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: PAN_FAILURE
        description: |-
          The specified card number is invalid. For example, it is of
          incorrect length or is incorrectly formatted.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: EXPIRATION_FAILURE
        description: |-
          The card expiration date is either invalid or indicates that the
          card is expired.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: CARD_NOT_SUPPORTED
        description: |-
          The card is not supported either in the geographic region or by
          the [merchant category code](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) (MCC).
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: INVALID_PIN
        description: The card issuer declined the request because the PIN is invalid.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: MISSING_PIN
        description: The payment is missing a required PIN.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: MISSING_ACCOUNT_TYPE
        description: The payment is missing a required ACCOUNT_TYPE parameter.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: INVALID_POSTAL_CODE
        description: The postal code is incorrectly formatted.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: INVALID_FEES
        description: The app_fee_money on a payment is too high.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - 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.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: PAYMENT_LIMIT_EXCEEDED
        description: Square declined the request because the payment amount exceeded
          the processing limit for this merchant.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: GIFT_CARD_AVAILABLE_AMOUNT
        description: |-
          When a Gift Card is a payment source, you can allow taking a partial payment
          by adding the `accept_partial_authorization` parameter in the request.
          However, taking such a partial payment does not work if your request also includes
          `tip_money`, `app_fee_money`, or both. Square declines such payments and returns
          the `GIFT_CARD_AVAILABLE_AMOUNT` error.
          For more information, see
          [CreatePayment errors (additional information)](https://developer.squareup.com/docs/payments-api/error-codes#createpayment-errors-additional-information).
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: ACCOUNT_UNUSABLE
        description: The account provided cannot carry out transactions.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: BUYER_REFUSED_PAYMENT
        description: Bank account rejected or was not authorized for the payment.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 400
      - name: DELAYED_TRANSACTION_EXPIRED
        description: The application tried to update a delayed-capture payment that
          has expired.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: DELAYED_TRANSACTION_CANCELED
        description: The application tried to cancel a delayed-capture payment that
          was already cancelled.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: DELAYED_TRANSACTION_CAPTURED
        description: The application tried to capture a delayed-capture payment that
          was already captured.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: DELAYED_TRANSACTION_FAILED
        description: The application tried to update a delayed-capture payment that
          failed.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: CARD_TOKEN_EXPIRED
        description: The provided card token (nonce) has expired.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: CARD_TOKEN_USED
        description: The provided card token (nonce) was already used to process the
          payment or refund.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: AMOUNT_TOO_HIGH
        description: The requested payment amount is too high for the provided payment
          source.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: UNSUPPORTED_INSTRUMENT_TYPE
        description: The API request references an unsupported instrument type/
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: REFUND_AMOUNT_INVALID
        description: The requested refund amount exceeds the amount available to refund.
        x-release-status: PUBLIC
        error-category: REFUND_ERROR
        http-code: 400
      - name: REFUND_ALREADY_PENDING
        description: The payment already has a pending refund.
        x-release-status: PUBLIC
        error-category: REFUND_ERROR
        http-code: 400
      - name: PAYMENT_NOT_REFUNDABLE
        description: |-
          The payment is not refundable. For example, the payment has been disputed and is no longer eligible for
          refunds.
        x-release-status: PUBLIC
        error-category: REFUND_ERROR
        http-code: 400
      - name: REFUND_DECLINED
        description: Request failed - The card issuer declined the refund.
        x-release-status: PUBLIC
        error-category: REFUND_ERROR
        http-code: 400
      - name: INVALID_CARD_DATA
        description: Generic error - the provided card data is invalid.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: SOURCE_USED
        description: The provided source id was already used to create a card.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: SOURCE_EXPIRED
        description: The provided source id has expired.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: UNSUPPORTED_LOYALTY_REWARD_TIER
        description: |-
          The referenced loyalty program reward tier is not supported.
          This could happen if the reward tier created in a first party
          application is incompatible with the Loyalty API.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: LOCATION_MISMATCH
        description: Generic error - the given location does not matching what is
          expected.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: IDEMPOTENCY_KEY_REUSED
        description: The provided idempotency key has already been used.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: UNEXPECTED_VALUE
        description: General error - the value provided was unexpected.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: SANDBOX_NOT_SUPPORTED
        description: The API request is not supported in sandbox.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: INVALID_EMAIL_ADDRESS
        description: The provided email address is invalid.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: INVALID_PHONE_NUMBER
        description: The provided phone number is invalid.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: CHECKOUT_EXPIRED
        description: The provided checkout URL has expired.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: BAD_CERTIFICATE
        description: Bad certificate.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: INVALID_SQUARE_VERSION_FORMAT
        description: The provided Square-Version is incorrectly formatted.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: API_VERSION_INCOMPATIBLE
        description: The provided Square-Version is incompatible with the requested
          action.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: CARD_DECLINED
        description: The card was declined.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 402
      - name: VERIFY_CVV_FAILURE
        description: The CVV could not be verified.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 402
      - name: VERIFY_AVS_FAILURE
        description: The AVS could not be verified.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 402
      - name: CARD_DECLINED_CALL_ISSUER
        description: |-
          The payment card was declined with a request
          for the card holder to call the issuer.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 402
      - name: CARD_DECLINED_VERIFICATION_REQUIRED
        description: |-
          The payment card was declined with a request
          for additional verification.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 402
      - name: BAD_EXPIRATION
        description: |-
          The card expiration date is either missing or
          incorrectly formatted.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 402
      - name: CHIP_INSERTION_REQUIRED
        description: |-
          The card issuer requires that the card be read
          using a chip reader.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 402
      - name: ALLOWABLE_PIN_TRIES_EXCEEDED
        description: |-
          The card has exhausted its available pin entry
          retries set by the card issuer. Resolving the error typically requires the
          card holder to contact the card issuer.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 402
      - name: RESERVATION_DECLINED
        description: The card issuer declined the refund.
        x-release-status: PUBLIC
        error-category: REFUND_ERROR
        http-code: 402
      - name: UNKNOWN_BODY_PARAMETER
        description: The body parameter is not recognized by the requested endpoint.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 400
      - name: NOT_FOUND
        description: Not Found - a general error occurred.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 404
      - name: APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND
        description: Square could not find the associated Apple Pay certificate.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 404
      - name: METHOD_NOT_ALLOWED
        description: Method Not Allowed - a general error occurred.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 405
      - name: NOT_ACCEPTABLE
        description: Not Acceptable - a general error occurred.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 406
      - name: REQUEST_TIMEOUT
        description: Request Timeout - a general error occurred.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 408
      - name: CONFLICT
        description: Conflict - a general error occurred.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 409
      - name: GONE
        description: |-
          The target resource is no longer available and this
          condition is likely to be permanent.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 410
      - name: REQUEST_ENTITY_TOO_LARGE
        description: Request Entity Too Large - a general error occurred.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 413
      - name: UNSUPPORTED_MEDIA_TYPE
        description: Unsupported Media Type - a general error occurred.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 415
      - name: UNPROCESSABLE_ENTITY
        description: Unprocessable Entity - a general error occurred.
        x-release-status: PUBLIC
        error-category: INVALID_REQUEST_ERROR
        http-code: 422
      - name: RATE_LIMITED
        description: Rate Limited - a general error occurred.
        x-release-status: PUBLIC
        error-category: RATE_LIMIT_ERROR
        http-code: 429
      - name: NOT_IMPLEMENTED
        description: Not Implemented - a general error occurred.
        x-release-status: PUBLIC
        error-category: API_ERROR
        http-code: 501
      - name: BAD_GATEWAY
        description: Bad Gateway - a general error occurred.
        x-release-status: PUBLIC
        error-category: API_ERROR
        http-code: 502
      - name: SERVICE_UNAVAILABLE
        description: Service Unavailable - a general error occurred.
        x-release-status: PUBLIC
        error-category: API_ERROR
        http-code: 503
      - name: TEMPORARY_ERROR
        description: |-
          A temporary internal error occurred. You can safely retry your call
          using the same idempotency key.
        x-release-status: PUBLIC
        error-category: PAYMENT_METHOD_ERROR
        http-code: 503
      - name: GATEWAY_TIMEOUT
        description: Gateway Timeout - a general error occurred.
        x-release-status: PUBLIC
        error-category: API_ERROR
        http-code: 504
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/error.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: ErrorCode
    LocationCapability:
      type: string
      description: The capabilities a location might have.
      enum:
      - CREDIT_CARD_PROCESSING
      - AUTOMATIC_TRANSFERS
      x-enum-elements:
      - name: CREDIT_CARD_PROCESSING
        description: The capability to process credit card transactions with Square.
        x-release-status: PUBLIC
      - name: AUTOMATIC_TRANSFERS
        description: The capability to receive automatic transfers from Square.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/location.proto
      x-proto-sha: 8239a09bf9fffc9b344c259c62b98d688ef2d107
      x-object-name: LocationCapability
    LocationStatus:
      type: string
      description: A location's status.
      enum:
      - ACTIVE
      - INACTIVE
      x-enum-elements:
      - name: ACTIVE
        description: A location that is active for business.
        x-release-status: PUBLIC
      - name: INACTIVE
        description: |-
          A location that is not active for business. Inactive locations provide historical
          information. Hide inactive locations unless the user has requested to see them.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/location.proto
      x-proto-sha: 8239a09bf9fffc9b344c259c62b98d688ef2d107
      x-object-name: LocationStatus
    LocationType:
      type: string
      description: A location's type.
      enum:
      - PHYSICAL
      - MOBILE
      x-enum-elements:
      - name: PHYSICAL
        description: A place of business with a physical location.
        x-release-status: PUBLIC
      - name: MOBILE
        description: A place of business that is mobile, such as a food truck or online
          store.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/location.proto
      x-proto-sha: 8239a09bf9fffc9b344c259c62b98d688ef2d107
      x-object-name: LocationType
    RefundStatus:
      type: string
      description: Indicates a refund's current status.
      enum:
      - PENDING
      - APPROVED
      - REJECTED
      - FAILED
      x-enum-elements:
      - name: PENDING
        description: The refund is pending.
        x-release-status: PUBLIC
      - name: APPROVED
        description: The refund has been approved by Square.
        x-release-status: PUBLIC
      - name: REJECTED
        description: The refund has been rejected by Square.
        x-release-status: PUBLIC
      - name: FAILED
        description: The refund failed.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/refund.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: RefundStatus
    TenderCardDetailsEntryMethod:
      type: string
      description: Indicates the method used to enter the card's details.
      enum:
      - SWIPED
      - KEYED
      - EMV
      - ON_FILE
      - CONTACTLESS
      x-enum-elements:
      - name: SWIPED
        description: The card was swiped through a Square reader or Square stand.
        x-release-status: PUBLIC
      - name: KEYED
        description: |-
          The card information was keyed manually into Square Point of Sale or a
          Square-hosted web form.
        x-release-status: PUBLIC
      - name: EMV
        description: The card was processed via EMV with a Square reader.
        x-release-status: PUBLIC
      - name: ON_FILE
        description: The buyer's card details were already on file with Square.
        x-release-status: PUBLIC
      - name: CONTACTLESS
        description: |-
          The card was processed via a contactless (i.e., NFC) transaction
          with a Square reader.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/tender.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: TenderCardDetailsEntryMethod
    TenderCardDetailsStatus:
      type: string
      description: Indicates the card transaction's current status.
      enum:
      - AUTHORIZED
      - CAPTURED
      - VOIDED
      - FAILED
      x-enum-elements:
      - name: AUTHORIZED
        description: The card transaction has been authorized but not yet captured.
        x-release-status: PUBLIC
      - name: CAPTURED
        description: The card transaction was authorized and subsequently captured
          (i.e., completed).
        x-release-status: PUBLIC
      - name: VOIDED
        description: The card transaction was authorized and subsequently voided (i.e.,
          canceled).
        x-release-status: PUBLIC
      - name: FAILED
        description: The card transaction failed.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/tender.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: TenderCardDetailsStatus
    TenderType:
      type: string
      description: Indicates a tender's type.
      enum:
      - CARD
      - CASH
      - THIRD_PARTY_CARD
      - SQUARE_GIFT_CARD
      - NO_SALE
      - CHECK
      - MERCHANT_GIFT_CARD
      - THIRD_PARTY_E_MONEY
      - BANK_ACCOUNT
      - WALLET
      - BUY_NOW_PAY_LATER
      - SQUARE_ACCOUNT
      - OTHER
      x-enum-elements:
      - name: CARD
        description: A credit card.
        x-release-status: PUBLIC
      - name: CASH
        description: Cash.
        x-release-status: PUBLIC
      - name: THIRD_PARTY_CARD
        description: |-
          A credit card processed with a card processor other than Square.

          This value applies only to merchants in countries where Square does not
          yet provide card processing.
        x-release-status: PUBLIC
      - name: SQUARE_GIFT_CARD
        description: A Square gift card.
        x-release-status: PUBLIC
      - name: NO_SALE
        description: This tender represents the register being opened for a "no sale"
          event.
        x-release-status: PUBLIC
      - name: WALLET
        description: |-
          A payment from a digital wallet, e.g. Cash App.

          Note: Some "digital wallets", including Google Pay and Apple Pay, facilitate
          card payments.  Those payments have the `CARD` type.
        x-release-status: PUBLIC
      - name: OTHER
        description: A form of tender that does not match any other value.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/tender.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: TenderType
    TransactionProduct:
      type: string
      description: Indicates the Square product used to process a transaction.
      enum:
      - REGISTER
      - EXTERNAL_API
      - BILLING
      - APPOINTMENTS
      - INVOICES
      - ONLINE_STORE
      - PAYROLL
      - OTHER
      x-enum-elements:
      - name: REGISTER
        description: Square Point of Sale.
        x-release-status: DEPRECATED
      - name: EXTERNAL_API
        description: The Square Connect API.
        x-release-status: DEPRECATED
      - name: BILLING
        description: A Square subscription for one of multiple products.
        x-release-status: DEPRECATED
      - name: APPOINTMENTS
        description: Square Appointments.
        x-release-status: DEPRECATED
      - name: INVOICES
        description: Square Invoices.
        x-release-status: DEPRECATED
      - name: ONLINE_STORE
        description: Square Online Store.
        x-release-status: DEPRECATED
      - name: PAYROLL
        description: Square Payroll.
        x-release-status: DEPRECATED
      - name: OTHER
        description: A Square product that does not match any other value.
        x-release-status: DEPRECATED
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/transaction/resources/transaction.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: TransactionProduct
    OauthAuthorizationRevokedWebhookRevokerType:
      type: string
      description: Defines the possible types for the revoking client.
      enum:
      - APPLICATION
      - MERCHANT
      - SQUARE
      x-enum-elements:
      - name: APPLICATION
        description: The application that requested access to a merchant's data.
        x-release-status: BETA
      - name: MERCHANT
        description: The admin for the merchant.
        x-release-status: BETA
      - name: SQUARE
        description: An internal Square employee.
        x-release-status: BETA
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/oauth/oauth-authorization-revoked-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: OauthAuthorizationRevokedWebhookRevokerType
      x-visibility: DOC_ONLY
    VendorCreatedWebhookObjectOperation:
      type: string
      description: The operation that can be performed against a vendor to cause the
        webhook event to be published.
      enum:
      - CREATED
      x-enum-elements:
      - name: CREATED
        description: ""
        x-release-status: BETA
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/inventory/inventory-vendor-created-webhook.proto
      x-proto-sha: a67ca34456c709110577d62f998cbabba55c83f4
      x-object-name: VendorCreatedWebhookObjectOperation
      x-visibility: DOC_ONLY
    VendorUpdatedWebhookObjectOperation:
      type: string
      description: The operation that can be performed against a vendor to cause the
        webhook event to be published.
      enum:
      - UPDATED
      x-enum-elements:
      - name: UPDATED
        description: ""
        x-release-status: BETA
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/inventory/inventory-vendor-updated-webhook.proto
      x-proto-sha: a67ca34456c709110577d62f998cbabba55c83f4
      x-object-name: VendorUpdatedWebhookObjectOperation
      x-visibility: DOC_ONLY
    ProductType:
      type: string
      enum:
      - UNKNOWN
      - REGISTER
      - RESTAURANT
      - RETAIL
      - PAY_SDK
      - TERMINAL_API
      - KDS
      x-enum-elements:
      - name: TERMINAL_API
        description: ""
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /device-settings/device-settings-proto/src/main/proto/squareup/devicesettings/product_type.proto
      x-proto-sha: c26abe92e5379e8660778fe30b38f9165df7fabc
      x-object-name: ProductType
    DeviceCodeStatus:
      type: string
      description: DeviceCode.Status enum.
      enum:
      - UNKNOWN
      - UNPAIRED
      - PAIRED
      - EXPIRED
      x-enum-elements:
      - name: UNKNOWN
        description: The status cannot be determined or does not exist.
        x-release-status: PUBLIC
      - name: UNPAIRED
        description: The device code is just created and unpaired.
        x-release-status: PUBLIC
      - name: PAIRED
        description: The device code has been signed in and paired to a device.
        x-release-status: PUBLIC
      - name: EXPIRED
        description: The device code was unpaired and expired before it was paired.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /device-settings/device-settings-proto/src/main/proto/squareup/devicesettings/external/device_code.proto
      x-proto-sha: c26abe92e5379e8660778fe30b38f9165df7fabc
      x-object-name: DeviceCodeStatus
    CustomAttributeDefinitionVisibility:
      type: string
      description: |-
        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.
      enum:
      - VISIBILITY_DO_NOT_USE
      - 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
          of all seller data) and other developers.
        x-release-status: PUBLIC
      - name: VISIBILITY_READ_ONLY
        description: |-
          The seller and other developers can read the custom attribute definition and values
          on resources.
        x-release-status: PUBLIC
      - name: VISIBILITY_READ_WRITE_VALUES
        description: |-
          The seller and other developers can read the custom attribute definition,
          and can read and write values on resources. A custom attribute definition
          can only be edited or deleted by the application that created it.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /devs-custom-attr/devs-custom-attr-proto/src/main/proto/squareup/devscustomattr/datatypes.proto
      x-proto-sha: 0d940eef0bc6b41096b9965c2a9d595202f7c8b3
      x-object-name: CustomAttributeDefinitionVisibility
    VisibilityFilter:
      type: string
      description: Enumeration of visibility-filter values used to set the ability
        to view custom attributes or custom attribute definitions.
      enum:
      - VISIBILITY_FILTER_DO_NOT_USE
      - ALL
      - READ
      - READ_WRITE
      x-enum-elements:
      - name: ALL
        description: All custom attributes or custom attribute definitions.
        x-release-status: PUBLIC
      - name: READ
        description: All custom attributes or custom attribute definitions with the
          `visibility` field set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
        x-release-status: PUBLIC
      - name: READ_WRITE
        description: All custom attributes or custom attribute definitions with the
          `visibility` field set to `VISIBILITY_READ_WRITE_VALUES`.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /devs-custom-attr/devs-custom-attr-proto/src/main/proto/squareup/devscustomattr/datatypes.proto
      x-proto-sha: 0d940eef0bc6b41096b9965c2a9d595202f7c8b3
      x-object-name: VisibilityFilter
    GiftCardGANSource:
      type: string
      description: "Indicates the source that generated the gift card \naccount number\
        \ (GAN)."
      enum:
      - GAN_SOURCE_DO_NOT_USE
      - SQUARE
      - OTHER
      x-enum-elements:
      - name: SQUARE
        description: The GAN is generated by Square.
        x-release-status: PUBLIC
      - 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)."
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardGANSource
    GiftCardStatus:
      type: string
      description: Indicates the gift card state.
      enum:
      - STATUS_DO_NOT_USE
      - NOT_ACTIVE
      - ACTIVE
      - DEACTIVATED
      - BLOCKED
      - PENDING
      - UNREGISTERED
      x-enum-elements:
      - name: ACTIVE
        description: The gift card is active and can be used as a payment source.
        x-release-status: PUBLIC
      - name: DEACTIVATED
        description: Any activity that changes the gift card balance is permanently
          forbidden.
        x-release-status: PUBLIC
      - name: BLOCKED
        description: Any activity that changes the gift card balance is temporarily
          forbidden.
        x-release-status: PUBLIC
      - name: PENDING
        description: |-
          The gift card is pending activation.
          This is the initial state when a gift card is created. You must activate the gift card
          before it can be used.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardStatus
    GiftCardType:
      type: string
      description: Indicates the gift card type.
      enum:
      - TYPE_DO_NOT_USE
      - PHYSICAL
      - DIGITAL
      x-enum-elements:
      - name: PHYSICAL
        description: A plastic gift card.
        x-release-status: PUBLIC
      - name: DIGITAL
        description: A digital gift card.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardType
    GiftCardActivityType:
      type: string
      description: Indicates the type of [gift card activity](entity:GiftCardActivity).
      enum:
      - TYPE_DO_NOT_USE
      - ACTIVATE
      - LOAD
      - REDEEM
      - CLEAR_BALANCE
      - DEACTIVATE
      - ADJUST_INCREMENT
      - ADJUST_DECREMENT
      - REFUND
      - UNLINKED_ACTIVITY_REFUND
      - IMPORT
      - OTHER
      - BLOCK
      - UNBLOCK
      - IMPORT_REVERSAL
      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."
        x-release-status: PUBLIC
      - name: LOAD
        description: Loaded a gift card with additional funds.
        x-release-status: PUBLIC
      - name: REDEEM
        description: Redeemed a gift card for a purchase.
        x-release-status: PUBLIC
      - name: CLEAR_BALANCE
        description: Set the balance of a gift card to zero.
        x-release-status: PUBLIC
      - name: DEACTIVATE
        description: Permanently blocked a gift card from balance-changing activities.
        x-release-status: PUBLIC
      - name: ADJUST_INCREMENT
        description: Added money to a gift card outside of a typical `ACTIVATE`, `LOAD`,
          or `REFUND` activity flow.
        x-release-status: PUBLIC
      - name: ADJUST_DECREMENT
        description: Deducted money from a gift card outside of a typical `REDEEM`
          activity flow.
        x-release-status: PUBLIC
      - 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 gift card payment processed\
          \ by Square can be refunded to the same gift card using Square Point of\
          \ Sale,\nthe Square Seller Dashboard, or the Refunds API.\n- A cross-tender\
          \ payment processed by Square can be refunded to a gift card using Square\
          \ Point of Sale or the\nSquare Seller Dashboard. The payment source might\
          \ be a credit card or different gift card.\n- A payment processed using\
          \ a custom payment processing system can be refunded to the same gift card."
        x-release-status: PUBLIC
      - name: UNLINKED_ACTIVITY_REFUND
        description: |-
          Added money to a gift card from a refunded transaction that was processed using a custom payment
          processing system and not linked to the gift card.
        x-release-status: PUBLIC
      - 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."
        x-release-status: PUBLIC
      - 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."
        x-release-status: PUBLIC
      - 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."
        x-release-status: PUBLIC
      - 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."
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityType
    GiftCardActivityAdjustDecrementReason:
      type: string
      description: Indicates the reason for deducting money from a [gift card](entity:GiftCard).
      enum:
      - REASON_DO_NOT_USE
      - 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
          on the gift card.
        x-release-status: PUBLIC
      - name: BALANCE_ACCIDENTALLY_INCREASED
        description: The balance was decreased to reverse an unintentional balance
          increase.
        x-release-status: PUBLIC
      - name: SUPPORT_ISSUE
        description: The balance was decreased to accommodate support issues.
        x-release-status: PUBLIC
      - name: PURCHASE_WAS_REFUNDED
        description: |-
          The balance was decreased because the order used to purchase or reload the
          gift card was refunded.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-adjust-decrement.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityAdjustDecrementReason
    GiftCardActivityAdjustIncrementReason:
      type: string
      description: Indicates the reason for adding money to a [gift card](entity:GiftCard).
      enum:
      - REASON_DO_NOT_USE
      - COMPLIMENTARY
      - SUPPORT_ISSUE
      - TRANSACTION_VOIDED
      x-enum-elements:
      - name: COMPLIMENTARY
        description: The seller gifted a complimentary gift card balance increase.
        x-release-status: PUBLIC
      - name: SUPPORT_ISSUE
        description: "The seller increased the gift card balance \nto accommodate\
          \ support issues."
        x-release-status: PUBLIC
      - name: TRANSACTION_VOIDED
        description: The transaction is voided.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-adjust-increment.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityAdjustIncrementReason
    GiftCardActivityBlockReason:
      type: string
      description: Indicates the reason for blocking a [gift card](entity:GiftCard).
      enum:
      - REASON_DO_NOT_USE
      - 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.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-block.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityBlockReason
    GiftCardActivityClearBalanceReason:
      type: string
      description: Indicates the reason for clearing the balance of a [gift card](entity:GiftCard).
      enum:
      - REASON_DO_NOT_USE
      - SUSPICIOUS_ACTIVITY
      - REUSE_GIFTCARD
      - UNKNOWN_REASON
      x-enum-elements:
      - name: SUSPICIOUS_ACTIVITY
        description: The seller suspects suspicious activity.
        x-release-status: PUBLIC
      - name: REUSE_GIFTCARD
        description: The seller cleared the balance to reuse the gift card.
        x-release-status: PUBLIC
      - name: UNKNOWN_REASON
        description: |-
          The gift card balance was cleared for an unknown reason.

          This reason is read-only and cannot be used to create a `CLEAR_BALANCE` activity using the Gift Card Activities API.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-clear-balance.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityClearBalanceReason
    GiftCardActivityDeactivateReason:
      type: string
      description: Indicates the reason for deactivating a [gift card](entity:GiftCard).
      enum:
      - REASON_DO_NOT_USE
      - SUSPICIOUS_ACTIVITY
      - UNKNOWN_REASON
      - CHARGEBACK_DEACTIVATE
      x-enum-elements:
      - name: SUSPICIOUS_ACTIVITY
        description: The seller suspects suspicious activity.
        x-release-status: PUBLIC
      - name: UNKNOWN_REASON
        description: |-
          The gift card was deactivated for an unknown reason.

          This reason is read-only and cannot be used to create a `DEACTIVATE` activity using the Gift Card Activities API.
        x-release-status: PUBLIC
      - name: CHARGEBACK_DEACTIVATE
        description: |-
          A chargeback on the gift card purchase (or the gift card load) was ruled in favor of the buyer.

          This reason is read-only and cannot be used to create a `DEACTIVATE` activity using the Gift Card Activities API.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-deactivate.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityDeactivateReason
    GiftCardActivityRedeemStatus:
      type: string
      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."
      enum:
      - TYPE_DO_NOT_USE
      - 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."
        x-release-status: PUBLIC
      - name: COMPLETED
        description: The gift card redemption is completed.
        x-release-status: PUBLIC
      - name: CANCELED
        description: "The gift card redemption is canceled. A redemption is canceled\
          \ if the authorization \non the gift card is voided."
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-redeem.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityRedeemStatus
    GiftCardActivityUnblockReason:
      type: string
      description: Indicates the reason for unblocking a [gift card](entity:GiftCard).
      enum:
      - REASON_DO_NOT_USE
      - CHARGEBACK_UNBLOCK
      x-enum-elements:
      - name: CHARGEBACK_UNBLOCK
        description: The gift card is unblocked because a chargeback was ruled in
          favor of the seller.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-unblock.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityUnblockReason
    InvoiceDeliveryMethod:
      type: string
      description: Indicates how Square delivers the [invoice](entity:Invoice) to
        the customer.
      enum:
      - INVOICE_DELIVERY_METHOD_DO_NOT_USE
      - EMAIL
      - SHARE_MANUALLY
      - SMS
      x-enum-elements:
      - name: EMAIL
        description: Directs Square to send invoices, reminders, and receipts to the
          customer using email.
        x-release-status: PUBLIC
      - name: SHARE_MANUALLY
        description: |-
          Directs Square to take no action on the invoice. In this case, the seller
          or application developer follows up with the customer for payment. For example,
          a seller might collect a payment in the Seller Dashboard or Point of Sale (POS) application.
          The seller might also share the URL of the Square-hosted invoice page (`public_url`) with the customer to request payment.
        x-release-status: PUBLIC
      - name: SMS
        description: |-
          Directs Square to send invoices and receipts to the customer using SMS (text message).

          You cannot set `SMS` as a delivery method using the Invoices API, but you can change an `SMS` delivery method to `EMAIL` or `SHARE_MANUALLY`.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/model/invoice_delivery_method.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: InvoiceDeliveryMethod
    InvoiceAutomaticPaymentSource:
      type: string
      description: Indicates the automatic payment method for an [invoice payment
        request](entity:InvoicePaymentRequest).
      enum:
      - INVOICE_AUTOMATIC_PAYMENT_SOURCE_DO_NOT_USE
      - NONE
      - CARD_ON_FILE
      - BANK_ON_FILE
      x-enum-elements:
      - name: NONE
        description: An automatic payment is not configured for the payment request.
        x-release-status: PUBLIC
      - name: CARD_ON_FILE
        description: |-
          Use a card on file as the automatic payment method. On the due date, Square charges the card
          for the amount of the payment request.

          For `CARD_ON_FILE` payments, the invoice delivery method must be `EMAIL` and `card_id` must be
          specified for the payment request before the invoice can be published.
        x-release-status: PUBLIC
      - 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.\n\nThis payment method applies only to recurring invoices\
          \ that sellers create in the Seller Dashboard or other\nSquare first-party\
          \ applications. 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`."
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/model/payment_request.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: InvoiceAutomaticPaymentSource
    InvoiceCustomFieldPlacement:
      type: string
      description: "Indicates where to render a custom field on the Square-hosted\
        \ invoice page and in emailed or PDF \ncopies of the invoice."
      enum:
      - UNKNOWN_PLACEMENT_DO_NOT_USE
      - ABOVE_LINE_ITEMS
      - BELOW_LINE_ITEMS
      x-enum-elements:
      - name: ABOVE_LINE_ITEMS
        description: Render the custom field above the invoice line items.
        x-release-status: PUBLIC
      - name: BELOW_LINE_ITEMS
        description: Render the custom field below the invoice line items.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/model/custom_fields.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: InvoiceCustomFieldPlacement
    InvoicePaymentReminderStatus:
      type: string
      description: The status of a payment request reminder.
      enum:
      - INVOICE_PAYMENT_REMINDER_STATUS_DO_NOT_USE
      - 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).
        x-release-status: PUBLIC
      - name: NOT_APPLICABLE
        description: |-
          The reminder is not applicable and is not sent. The following are examples
          of when reminders are not applicable and are not sent:
          - You schedule a reminder to be sent before the invoice is published.
          - The invoice is configured with multiple payment requests and a payment request reminder
          is configured to be sent after the next payment request `due_date`.
          - Two reminders (for different payment requests) are configured to be sent on the
          same date. Therefore, only one reminder is sent.
          - You configure a reminder to be sent on the date that the invoice is scheduled to be sent.
          - The payment request is already paid.
          - The invoice status is `CANCELED` or `FAILED`.
        x-release-status: PUBLIC
      - name: SENT
        description: The reminder is sent.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/model/payment_reminder.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: InvoicePaymentReminderStatus
    InvoiceRequestMethod:
      type: string
      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."
      enum:
      - INVOICE_REQUEST_METHOD_DO_NOT_USE
      - 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.
          Square sends the invoice after it is published (either immediately or at the `scheduled_at`
          time, if specified in the [invoice](entity:Invoice)).
        x-release-status: DEPRECATED
      - name: CHARGE_CARD_ON_FILE
        description: |-
          Directs Square to charge the card on file on the `due_date` specified in the payment request
          and to use email to send invoices, reminders, and receipts.
        x-release-status: DEPRECATED
      - 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. \n\
          The seller might also share the URL of the Square-hosted invoice page (`public_url`)\
          \ with the customer requesting payment."
        x-release-status: DEPRECATED
      - name: CHARGE_BANK_ON_FILE
        description: "Directs Square to charge the bank account on file on the `due_date`\
          \ specified in the\npayment request and to use email to send invoices, reminders,\
          \ and receipts.\n\nThe bank on file payment method applies only to recurring\
          \ invoices that sellers create in the Seller Dashboard or other\nSquare\
          \ first-party applications. 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."
        x-release-status: DEPRECATED
      - 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."
        x-release-status: DEPRECATED
      - 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."
        x-release-status: DEPRECATED
      - name: SMS_CHARGE_BANK_ON_FILE
        description: "Directs Square to charge the bank account on file on the `due_date`\
          \ specified in the payment request\nand to use SMS (text message) to send\
          \ invoices and receipts. \n\nThe bank on file payment method applies only\
          \ to recurring invoices that sellers create in the Seller Dashboard\nor\
          \ other Square first-party applications. 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."
        x-release-status: DEPRECATED
      x-release-status: DEPRECATED
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/model/payment_request.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: InvoiceRequestMethod
    InvoiceRequestType:
      type: string
      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)."
      enum:
      - INVOICE_REQUEST_TYPE_DO_NOT_USE
      - 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."
        x-release-status: PUBLIC
      - 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."
        x-release-status: PUBLIC
      - 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)."
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/model/payment_request.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: InvoiceRequestType
    InvoiceSortField:
      type: string
      description: The field to use for sorting.
      enum:
      - INVOICE_SORT_FIELD_DO_NOT_USE
      - INVOICE_SORT_DATE
      x-enum-elements:
      - name: INVOICE_SORT_DATE
        description: |-
          The field works as follows:

          - If the invoice is a draft, it uses the invoice `created_at` date.
          - If the invoice is scheduled for publication, it uses the `scheduled_at` date.
          - If the invoice is published, it uses the invoice publication date.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/search_invoices.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: InvoiceSortField
    InvoiceStatus:
      type: string
      description: Indicates the status of an invoice.
      enum:
      - INVOICE_STATUS_DO_NOT_USE
      - 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.
          A draft invoice has no `public_url`, so it is not available to customers.
        x-release-status: PUBLIC
      - name: UNPAID
        description: The invoice is published but not yet paid.
        x-release-status: PUBLIC
      - name: SCHEDULED
        description: |-
          The invoice is scheduled to be processed. On the scheduled date,
          Square sends the invoice, initiates an automatic payment, or takes no action, depending on
          the delivery method and payment request settings. Square also sets the invoice status to the
          appropriate state: `UNPAID`, `PAID`, `PARTIALLY_PAID`, or `PAYMENT_PENDING`.
        x-release-status: PUBLIC
      - name: PARTIALLY_PAID
        description: A partial payment is received for the invoice.
        x-release-status: PUBLIC
      - name: PAID
        description: The customer paid the invoice in full.
        x-release-status: PUBLIC
      - name: PARTIALLY_REFUNDED
        description: |-
          The invoice is paid (or partially paid) and some but not all the amount paid is
          refunded.
        x-release-status: PUBLIC
      - name: REFUNDED
        description: The full amount that the customer paid for the invoice is refunded.
        x-release-status: PUBLIC
      - name: CANCELED
        description: |-
          The invoice is canceled. Square no longer requests payments from the customer.
          The `public_url` page remains and is accessible, but it displays the invoice
          as canceled and does not accept payment.
        x-release-status: PUBLIC
      - name: FAILED
        description: Square canceled the invoice due to suspicious activity.
        x-release-status: PUBLIC
      - name: PAYMENT_PENDING
        description: |-
          A payment on the invoice was initiated but has not yet been processed.

          When in this state, invoices cannot be updated and other payments cannot be initiated.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/model/invoice.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: InvoiceStatus
    ShiftStatus:
      type: string
      description: Enumerates the possible status of a `Shift`.
      enum:
      - UNKNOWN_STATUS
      - OPEN
      - CLOSED
      x-enum-elements:
      - name: OPEN
        description: Employee started a work shift and the shift is not complete
        x-release-status: PUBLIC
      - name: CLOSED
        description: Employee started and ended a work shift.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/resources/datatypes.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: ShiftStatus
    ShiftFilterStatus:
      type: string
      description: Specifies the `status` of `Shift` records to be returned.
      enum:
      - DO_NOT_USE
      - OPEN
      - CLOSED
      x-enum-elements:
      - name: OPEN
        description: Shifts that have been started and not ended.
        x-release-status: PUBLIC
      - name: CLOSED
        description: Shifts that have been started and ended.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/resources/datatypes.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: ShiftFilterStatus
    ShiftSortField:
      type: string
      description: Enumerates the `Shift` fields to sort on.
      enum:
      - DO_NOT_USE
      - START_AT
      - END_AT
      - CREATED_AT
      - UPDATED_AT
      x-enum-elements:
      - name: START_AT
        description: The start date/time of a `Shift`
        x-release-status: PUBLIC
      - name: END_AT
        description: The end date/time of a `Shift`
        x-release-status: PUBLIC
      - name: CREATED_AT
        description: The date/time that a `Shift` is created
        x-release-status: PUBLIC
      - name: UPDATED_AT
        description: The most recent date/time that a `Shift` is updated
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/resources/datatypes.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: ShiftSortField
    ShiftWorkdayMatcher:
      type: string
      description: Defines the logic used to apply a workday filter.
      enum:
      - DO_NOT_USE
      - START_AT
      - END_AT
      - INTERSECTION
      x-enum-elements:
      - name: START_AT
        description: All shifts that start on or after the specified workday
        x-release-status: PUBLIC
      - name: END_AT
        description: All shifts that end on or before the specified workday
        x-release-status: PUBLIC
      - name: INTERSECTION
        description: All shifts that start between the start and end workdays (inclusive)
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/resources/datatypes.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: ShiftWorkdayMatcher
    Weekday:
      type: string
      description: The days of the week.
      enum:
      - UNKNOWN_WEEKDAY
      - MON
      - TUE
      - WED
      - THU
      - FRI
      - SAT
      - SUN
      x-enum-elements:
      - name: MON
        description: Monday
        x-release-status: PUBLIC
      - name: TUE
        description: Tuesday
        x-release-status: PUBLIC
      - name: WED
        description: Wednesday
        x-release-status: PUBLIC
      - name: THU
        description: Thursday
        x-release-status: PUBLIC
      - name: FRI
        description: Friday
        x-release-status: PUBLIC
      - name: SAT
        description: Saturday
        x-release-status: PUBLIC
      - name: SUN
        description: Sunday
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/resources/enums.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: Weekday
    OAuthPermission:
      type: string
      description: |-
        When you direct your user to the permissions form, you specify the
        scope of the permissions your application will have. Personal access tokens
        have all available permissions (at the time the application was created) by default.

        __Important:__ Never request more than the minimum permissions required for your application
        to function properly.
      enum:
      - BANK_ACCOUNTS_READ
      - CASH_DRAWER_READ
      - CUSTOMERS_READ
      - CUSTOMERS_WRITE
      - DEVICE_CREDENTIAL_MANAGEMENT
      - EMPLOYEES_READ
      - EMPLOYEES_WRITE
      - INVENTORY_READ
      - INVENTORY_WRITE
      - ITEMS_READ
      - ITEMS_WRITE
      - LOYALTY_READ
      - LOYALTY_WRITE
      - MERCHANT_PROFILE_READ
      - ORDERS_READ
      - ORDERS_WRITE
      - PAYMENTS_READ
      - PAYMENTS_WRITE
      - PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS
      - PAYMENTS_WRITE_IN_PERSON
      - SETTLEMENTS_READ
      - TIMECARDS_READ
      - TIMECARDS_WRITE
      - TIMECARDS_SETTINGS_READ
      - TIMECARDS_SETTINGS_WRITE
      - APPOINTMENTS_READ
      - APPOINTMENTS_WRITE
      - APPOINTMENTS_BUSINESS_SETTINGS_READ
      - INVOICES_READ
      - INVOICES_WRITE
      - SUBSCRIPTIONS_READ
      - SUBSCRIPTIONS_WRITE
      - DISPUTES_READ
      - DISPUTES_WRITE
      - GIFTCARDS_READ
      - GIFTCARDS_WRITE
      - ONLINE_STORE_SNIPPETS_WRITE
      - ONLINE_STORE_SNIPPETS_READ
      - ONLINE_STORE_SITE_READ
      - PAYMENTS_WRITE_SHARED_ONFILE
      - APPOINTMENTS_ALL_READ
      - APPOINTMENTS_ALL_WRITE
      - MERCHANT_PROFILE_WRITE
      - VENDOR_READ
      - VENDOR_WRITE
      - PAYOUTS_READ
      - RESERVATIONS_READ
      - RESERVATIONS_WRITE
      x-enum-elements:
      - name: BANK_ACCOUNTS_READ
        description: |-
          __HTTP Method__: `GET`

          Grants read access to bank account information associated with the targeted
          Square account. For example, to call the Connect v1 ListBankAccounts endpoint.
        x-release-status: PUBLIC
      - name: CASH_DRAWER_READ
        description: |-
          __HTTP Method__: `GET`

          Grants read access to cash drawer shift information. For example, to call the
          ListCashDrawerShifts endpoint.
        x-release-status: PUBLIC
      - name: CUSTOMERS_READ
        description: |-
          __HTTP Method__: `GET`

          Grants read access to customer information. For example, to call the
          ListCustomers endpoint.
        x-release-status: PUBLIC
      - name: CUSTOMERS_WRITE
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Grants write access to customer information. For example, to create and update
          customer profiles.
        x-release-status: PUBLIC
      - name: DEVICE_CREDENTIAL_MANAGEMENT
        description: |-
          __HTTP Method__: `POST`, `GET`

          Grants read/write access to device credentials information. For example, to
          call the CreateDeviceCode endpoint.
        x-release-status: PUBLIC
      - name: EMPLOYEES_READ
        description: |-
          __HTTP Method__: `GET`

          Grants read access to employee profile information. For example, to call the
          Connect v1 Employees API.
        x-release-status: PUBLIC
      - name: EMPLOYEES_WRITE
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Grants write access to employee profile information. For example, to create
          and modify employee profiles.
        x-release-status: PUBLIC
      - name: INVENTORY_READ
        description: |-
          __HTTP Method__: `GET`

          Grants read access to inventory information. For example, to call the
          RetrieveInventoryCount endpoint.
        x-release-status: PUBLIC
      - name: INVENTORY_WRITE
        description: |-
          __HTTP Method__:  `POST`, `PUT`, `DELETE`

          Grants write access to inventory information. For example, to call the
          BatchChangeInventory endpoint.
        x-release-status: PUBLIC
      - name: ITEMS_READ
        description: |-
          __HTTP Method__: `GET`

          Grants read access to business and location information. For example, to
          obtain a location ID for subsequent activity.
        x-release-status: PUBLIC
      - name: ITEMS_WRITE
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Grants write access to product catalog information. For example, to modify or
          add to a product catalog.
        x-release-status: PUBLIC
      - name: LOYALTY_READ
        description: |-
          __HTTP Method__: `GET`

          Grants read access to loyalty information. For example, to call the
          ListLoyaltyPrograms endpoint.
        x-release-status: PUBLIC
      - name: LOYALTY_WRITE
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Grants write access to loyalty information. For example, to call the
          CreateLoyaltyAccount endpoint.
        x-release-status: PUBLIC
      - name: MERCHANT_PROFILE_READ
        description: |-
          __HTTP Method__: `GET`

          Grants read access to business and location information. For example, to
          obtain a location ID for subsequent activity.
        x-release-status: PUBLIC
      - name: ORDERS_READ
        description: |-
          __HTTP Method__: `GET`

          Grants read access to order information. For example, to call the
          BatchRetrieveOrders endpoint.
        x-release-status: PUBLIC
      - name: ORDERS_WRITE
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Grants write access to order information. For example, to call the
          CreateCheckout endpoint.
        x-release-status: PUBLIC
      - name: PAYMENTS_READ
        description: |-
          __HTTP Method__: `GET`

          Grants read access to transaction and refund information. For example, to call
          the RetrieveTransaction endpoint.
        x-release-status: PUBLIC
      - name: PAYMENTS_WRITE
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Grants write access to transaction and refunds information. For example, to
          process payments with the Payments or Checkout API.
        x-release-status: PUBLIC
      - name: PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Allow third party applications to deduct a portion of each transaction amount.
          __Required__ to use multiparty transaction functionality with the Payments
          API.
        x-release-status: PUBLIC
      - name: PAYMENTS_WRITE_IN_PERSON
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Grants write access to payments and refunds information. For example, to
          process in-person payments.
        x-release-status: PUBLIC
      - name: SETTLEMENTS_READ
        description: |-
          __HTTP Method__: `GET`

          Grants read access to settlement (deposit) information. For example, to call
          the Connect v1 ListSettlements endpoint.
        x-release-status: PUBLIC
      - name: TIMECARDS_READ
        description: |-
          __HTTP Method__: `GET`

          Grants read access to employee timecard information. For example, to call the
          Connect v2 SearchShifts endpoint.
        x-release-status: PUBLIC
      - name: TIMECARDS_WRITE
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Grants write access to employee shift information. For example, to create
          and modify employee shifts.
        x-release-status: PUBLIC
      - name: TIMECARDS_SETTINGS_READ
        description: |-
          __HTTP Method__: `GET`

          Grants read access to employee timecard settings information. For example, to
          call the GetBreakType endpoint.
        x-release-status: PUBLIC
      - name: TIMECARDS_SETTINGS_WRITE
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Grants write access to employee timecard settings information. For example, to
          call the UpdateBreakType endpoint.
        x-release-status: PUBLIC
      - name: APPOINTMENTS_READ
        description: |-
          __HTTP Method__: `GET`, `POST`

          Grants read access to booking information. For example, to call the
          RetrieveBooking endpoint.
        x-release-status: PUBLIC
      - name: APPOINTMENTS_WRITE
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Grants write access to booking information. For example, to call the CreateBooking endpoint.
        x-release-status: PUBLIC
      - name: APPOINTMENTS_BUSINESS_SETTINGS_READ
        description: |-
          __HTTP Method__: `GET`

          Grants read access to booking business settings. For example, to call the
          ListTeamMemberBookingProfiles endpoint.
        x-release-status: PUBLIC
      - name: INVOICES_READ
        description: |-
          __HTTP Method__: `GET`, `POST`

          Grants read access to invoice information. For example, to call the ListInvoices endpoint.
        x-release-status: PUBLIC
      - name: INVOICES_WRITE
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Grants write access to invoice information. For example, to call the CreateInvoice endpoint.
        x-release-status: PUBLIC
      - name: SUBSCRIPTIONS_READ
        description: |-
          __HTTP Method__: `GET`, `POST`

          Grants read access to subscription information. For example, to call the RetrieveSubscription
          endpoint.
        x-release-status: PUBLIC
      - name: SUBSCRIPTIONS_WRITE
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Grants write access to subscription information. For example, to call the CreateSubscription
          endpoint.
        x-release-status: PUBLIC
      - name: DISPUTES_READ
        description: |-
          __HTTP Method__: `GET`

          Grants read access to dispute information. For example, to call the RetrieveDispute
          endpoint.
        x-release-status: PUBLIC
      - name: DISPUTES_WRITE
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Grants write access to dispute information. For example, to call the SubmitEvidence
          endpoint.
        x-release-status: PUBLIC
      - name: GIFTCARDS_READ
        description: |-
          __HTTP Method__: `GET`, `POST`

          Grants read access to gift card information. For example, to call the RetrieveGiftCard
          endpoint.
        x-release-status: PUBLIC
      - name: GIFTCARDS_WRITE
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Grants write access to gift card information. For example, to call the CreateGiftCard
          endpoint.
        x-release-status: PUBLIC
      - name: ONLINE_STORE_SNIPPETS_WRITE
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Write access to ECOM online store snippets on published websites.
        x-release-status: PUBLIC
      - name: ONLINE_STORE_SNIPPETS_READ
        description: |-
          __HTTP Method__: `GET`, `POST`

          Read access to ECOM online store snippets on published websites.
        x-release-status: PUBLIC
      - name: ONLINE_STORE_SITE_READ
        description: |-
          __HTTP Method__: `GET`, `POST`

          Read access to ECOM online store site details.
        x-release-status: PUBLIC
      - name: PAYMENTS_WRITE_SHARED_ONFILE
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Allows the developer to process payments on behalf of a seller using a shared on file payment method.
        x-release-status: PUBLIC
      - name: APPOINTMENTS_ALL_READ
        description: |-
          __HTTP Method__: `GET`, `POST`

          Grants read access to all of a seller's booking information, calendar, and business details.
          This permission must be accompanied by the `APPOINTMENTS_READ` permission.
        x-release-status: PUBLIC
      - name: APPOINTMENTS_ALL_WRITE
        description: |-
          __HTTP Method__: `POST`, `PUT`, `DELETE`

          Grants write access to all booking details, including double-booking a seller.
          This permission must be accompanied by the `APPOINTMENTS_WRITE` permission.
        x-release-status: PUBLIC
      - name: MERCHANT_PROFILE_WRITE
        description: |-
          __HTTP Method__: `POST`, `PUT`

          Grants write access to business and location information. For example, to create a new location or
          update the business hours at an existing location.
        x-release-status: PUBLIC
      - name: VENDOR_READ
        description: |-
          __HTTP Method__: `GET`, `POST`

          Grants read access to vendor information, for example, when calling the
          `RetrieveVendor` endpoint.
        x-release-status: BETA
      - name: VENDOR_WRITE
        description: |-
          __HTTP Method__:  `POST`, `PUT`, `DELETE`

          Grants write access to vendor information, for example, when calling the
          `BulkUpdateVendors` endpoint.
        x-release-status: BETA
      - name: PAYOUTS_READ
        description: |-
          __HTTP Method__: `GET`

          Grants read access to payouts and payout entries information. For example,
          to call the Connect v2 `ListPayouts` endpoint.
        x-release-status: BETA
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /oauth/protos/squareup/oauth/v1/oauth-permission.proto
      x-proto-sha: f1c3dbfadb8bfd89be4dd98d020e639b81a15b72
      x-object-name: OAuthPermission
      x-visibility: DOC_ONLY
    SearchOrdersSortField:
      type: string
      description: Specifies which timestamp to use to sort `SearchOrder` results.
      enum:
      - DO_NOT_USE
      - 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
          filtering for a time range in this query, you must set the `CREATED_AT`
          field in your `DateTimeFilter`.
        x-release-status: PUBLIC
      - name: UPDATED_AT
        description: |-
          The time when the order last updated, in RFC-3339 format. If you are also
          filtering for a time range in this query, you must set the `UPDATED_AT`
          field in your `DateTimeFilter`.
        x-release-status: PUBLIC
      - name: CLOSED_AT
        description: |-
          The time when the order was closed, in RFC-3339 format. If you use this
          value, you must also set a `StateFilter` with closed states. If you are also
          filtering for a time range in this query, you must set the `CLOSED_AT`
          field in your `DateTimeFilter`.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/search_orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: SearchOrdersSortField
    OrderFulfillmentFulfillmentLineItemApplication:
      type: string
      description: |-
        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.
      enum:
      - UNKNOWN_APPLICATION
      - ALL
      - ENTRY_LIST
      x-enum-elements:
      - name: ALL
        description: If `ALL`, `entries` must be unset.
        x-release-status: BETA
      - name: ENTRY_LIST
        description: If `ENTRY_LIST`, supply a list of `entries`.
        x-release-status: BETA
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderFulfillmentFulfillmentLineItemApplication
    OrderFulfillmentState:
      type: string
      description: The current state of this fulfillment.
      enum:
      - FULFILLMENT_STATE_DO_NOT_USE
      - PROPOSED
      - RESERVED
      - PREPARED
      - COMPLETED
      - CANCELED
      - FAILED
      x-enum-elements:
      - name: PROPOSED
        description: Indicates that the fulfillment has been proposed.
        x-release-status: PUBLIC
      - name: RESERVED
        description: Indicates that the fulfillment has been reserved.
        x-release-status: PUBLIC
      - name: PREPARED
        description: Indicates that the fulfillment has been prepared.
        x-release-status: PUBLIC
      - name: COMPLETED
        description: Indicates that the fulfillment was successfully completed.
        x-release-status: PUBLIC
      - name: CANCELED
        description: Indicates that the fulfillment was canceled.
        x-release-status: PUBLIC
      - name: FAILED
        description: |-
          Indicates that the fulfillment failed to be completed, but was not explicitly
          canceled.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderFulfillmentState
    OrderFulfillmentPickupDetailsScheduleType:
      type: string
      description: The schedule type of the pickup fulfillment.
      enum:
      - FULFILLMENT_PICKUP_DETAILS_SCHEDULE_TYPE_DO_NOT_USE
      - SCHEDULED
      - ASAP
      x-enum-elements:
      - name: SCHEDULED
        description: Indicates that the fulfillment will be picked up at a scheduled
          pickup time.
        x-release-status: PUBLIC
      - name: ASAP
        description: |-
          Indicates that the fulfillment will be picked up as soon as possible and
          should be prepared immediately.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderFulfillmentPickupDetailsScheduleType
    OrderFulfillmentType:
      type: string
      description: The type of fulfillment.
      enum:
      - FULFILLMENT_TYPE_DO_NOT_USE
      - CUSTOM
      - PICKUP
      - MANAGED_DELIVERY
      - SHIPMENT
      - DIGITAL
      - DELIVERY
      - SIMPLE
      x-enum-elements:
      - name: PICKUP
        description: A recipient to pick up the fulfillment from a physical [location](entity:Location).
        x-release-status: PUBLIC
      - name: SHIPMENT
        description: A shipping carrier to ship the fulfillment.
        x-release-status: BETA
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderFulfillmentType
    OrderLineItemDiscountScope:
      type: string
      description: Indicates whether this is a line-item or order-level discount.
      enum:
      - OTHER_DISCOUNT_SCOPE
      - LINE_ITEM
      - ORDER
      x-enum-elements:
      - name: OTHER_DISCOUNT_SCOPE
        description: |-
          Used for reporting only.
          The original transaction discount scope is currently not supported by the API.
        x-release-status: PUBLIC
      - name: LINE_ITEM
        description: |-
          The discount should be applied to only line items specified by
          `OrderLineItemAppliedDiscount` reference records.
        x-release-status: PUBLIC
      - name: ORDER
        description: The discount should be applied to the entire order.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderLineItemDiscountScope
    OrderLineItemDiscountType:
      type: string
      description: Indicates how the discount is applied to the associated line item
        or order.
      enum:
      - UNKNOWN_DISCOUNT
      - FIXED_PERCENTAGE
      - FIXED_AMOUNT
      - VARIABLE_PERCENTAGE
      - VARIABLE_AMOUNT
      x-enum-elements:
      - name: UNKNOWN_DISCOUNT
        description: |-
          Used for reporting only.
          The original transaction discount type is currently not supported by the API.
        x-release-status: PUBLIC
      - name: FIXED_PERCENTAGE
        description: Apply the discount as a fixed percentage (such as 5%) off the
          item price.
        x-release-status: PUBLIC
      - name: FIXED_AMOUNT
        description: Apply the discount as a fixed monetary value (such as $1.00)
          off the item price.
        x-release-status: PUBLIC
      - name: VARIABLE_PERCENTAGE
        description: |-
          Apply the discount as a variable percentage based on the item
          price.

          The specific discount percentage of a `VARIABLE_PERCENTAGE` discount
          is assigned at the time of the purchase.
        x-release-status: PUBLIC
      - name: VARIABLE_AMOUNT
        description: |-
          Apply the discount as a variable amount based on the item price.

          The specific discount amount of a `VARIABLE_AMOUNT` discount
          is assigned at the time of the purchase.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderLineItemDiscountType
    OrderLineItemItemType:
      type: string
      description: Represents the line item type.
      enum:
      - DO_NOT_USE
      - ITEM
      - CUSTOM_AMOUNT
      - GIFT_CARD
      x-enum-elements:
      - name: ITEM
        description: Indicates that the line item is an itemized sale.
        x-release-status: BETA
      - name: CUSTOM_AMOUNT
        description: Indicates that the line item is a non-itemized sale.
        x-release-status: BETA
      - name: GIFT_CARD
        description: |-
          Indicates that the line item is a gift card sale. Gift cards sold through
          the Orders API are sold in an unactivated state and can be activated through the
          Gift Cards API using the line item `uid`.
        x-release-status: BETA
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderLineItemItemType
    OrderLineItemTaxScope:
      type: string
      description: Indicates whether this is a line-item or order-level tax.
      enum:
      - OTHER_TAX_SCOPE
      - LINE_ITEM
      - ORDER
      x-enum-elements:
      - name: OTHER_TAX_SCOPE
        description: |-
          Used for reporting only.
          The original transaction tax scope is currently not supported by the API.
        x-release-status: PUBLIC
      - name: LINE_ITEM
        description: |-
          The tax should be applied only to line items specified by
          the `OrderLineItemAppliedTax` reference records.
        x-release-status: PUBLIC
      - name: ORDER
        description: The tax should be applied to the entire order.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderLineItemTaxScope
    OrderLineItemTaxType:
      type: string
      description: Indicates how the tax is applied to the associated line item or
        order.
      enum:
      - UNKNOWN_TAX
      - ADDITIVE
      - INCLUSIVE
      x-enum-elements:
      - name: UNKNOWN_TAX
        description: |-
          Used for reporting only.
          The original transaction tax type is currently not supported by the API.
        x-release-status: PUBLIC
      - name: ADDITIVE
        description: |-
          The tax is an additive tax. The tax amount is added on top of the price.
          For example, an item with a cost of 1.00 USD and a 10% additive tax has a total
          cost to the buyer of 1.10 USD.
        x-release-status: PUBLIC
      - name: INCLUSIVE
        description: |-
          The tax is an inclusive tax. Inclusive taxes are already included
          in the line item price or order total. For example, an item with a cost of
          1.00 USD and a 10% inclusive tax has a pretax cost of 0.91 USD
          (91 cents) and a 0.09 (9 cents) tax for a total cost of 1.00 USD to
          the buyer.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderLineItemTaxType
    OrderServiceChargeCalculationPhase:
      type: string
      description: |-
        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)
      enum:
      - SERVICE_CHARGE_CALCULATION_PHASE_DO_NOT_USE
      - 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
          taxes.
        x-release-status: PUBLIC
      - name: TOTAL_PHASE
        description: |-
          The service charge is applied after all discounts and taxes
          are applied.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderServiceChargeCalculationPhase
    OrderServiceChargeType:
      type: string
      enum:
      - SERVICE_CHARGE_TYPE_DO_NOT_USE
      - AUTO_GRATUITY
      - CUSTOM
      x-enum-elements:
      - name: AUTO_GRATUITY
        description: ""
        x-release-status: PUBLIC
      - name: CUSTOM
        description: ""
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderServiceChargeType
    OrderState:
      type: string
      description: The state of the order.
      enum:
      - DO_NOT_USE
      - OPEN
      - COMPLETED
      - CANCELED
      - DRAFT
      x-enum-elements:
      - name: OPEN
        description: Indicates that the order is open. Open orders can be updated.
        x-release-status: PUBLIC
      - name: COMPLETED
        description: Indicates that the order is completed. Completed orders are fully
          paid. This is a terminal state.
        x-release-status: PUBLIC
      - name: CANCELED
        description: Indicates that the order is canceled. Canceled orders are not
          paid. This is a terminal state.
        x-release-status: PUBLIC
      - name: DRAFT
        description: |-
          Indicates that the order is in a draft state. Draft orders can be updated,
          but cannot be paid or fulfilled.
          For more information, see [Create Orders](https://developer.squareup.com/docs/orders-api/create-orders).
        x-release-status: BETA
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderState
    RegisterDomainResponseStatus:
      type: string
      description: The status of the domain registration.
      enum:
      - PENDING
      - VERIFIED
      - DO_NOT_USE
      x-enum-elements:
      - name: PENDING
        description: The domain is added, but not verified.
        x-release-status: PUBLIC
      - name: VERIFIED
        description: The domain is added and verified. It can be used to accept Apple
          Pay transactions.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /payapi-wallets/protos/squareup/payapi_wallets/actions/apple_pay_domain_service_actions.proto
      x-proto-sha: 5a571cd674a882679027661caa0270c3d59161a9
      x-object-name: RegisterDomainResponseStatus
    ActivityType:
      type: string
      enum:
      - UNKNOWN_PAYOUT_ENTRY_TYPE_DO_NOT_USE
      - ADJUSTMENT
      - APP_FEE_REFUND
      - APP_FEE_REVENUE
      - AUTOMATIC_SAVINGS
      - AUTOMATIC_SAVINGS_REVERSED
      - CHARGE
      - DEPOSIT_FEE
      - 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
      x-enum-elements:
      - name: ADJUSTMENT
        description: A manual adjustment applied to the seller's account by Square.
        x-release-status: PUBLIC
      - name: APP_FEE_REFUND
        description: A refund for an application fee on a payment.
        x-release-status: PUBLIC
      - name: APP_FEE_REVENUE
        description: Revenue generated from an application fee on a payment.
        x-release-status: PUBLIC
      - 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.
        x-release-status: PUBLIC
      - 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.
        x-release-status: PUBLIC
      - name: CHARGE
        description: A credit card payment capture.
        x-release-status: PUBLIC
      - name: DEPOSIT_FEE
        description: Any fees involved with deposits such as instant deposits.
        x-release-status: PUBLIC
      - name: DISPUTE
        description: The balance change due to a dispute event.
        x-release-status: PUBLIC
      - name: ESCHEATMENT
        description: An escheatment entry for remittance.
        x-release-status: PUBLIC
      - name: FEE
        description: The Square processing fee.
        x-release-status: PUBLIC
      - name: FREE_PROCESSING
        description: |-
          Square offers free payments processing for a variety of business scenarios, including seller
          referrals or when Square wants to apologize (for example, for a bug, customer service, or repricing complication).
          This entry represents a credit to the seller for the purposes of free processing.
        x-release-status: PUBLIC
      - name: HOLD_ADJUSTMENT
        description: An adjustment made by Square related to holding a payment.
        x-release-status: PUBLIC
      - 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 hold and refund.
        x-release-status: PUBLIC
      - name: MONEY_TRANSFER
        description: The balance change from a money transfer.
        x-release-status: PUBLIC
      - name: MONEY_TRANSFER_REVERSAL
        description: The reversal of a money transfer.
        x-release-status: PUBLIC
      - name: OPEN_DISPUTE
        description: The balance change for a chargeback that has been filed.
        x-release-status: PUBLIC
      - name: OTHER
        description: Any other type that does not belong in the rest of the types.
        x-release-status: PUBLIC
      - name: OTHER_ADJUSTMENT
        description: Any other type of adjustment that does not fall under existing
          types.
        x-release-status: PUBLIC
      - name: PAID_SERVICE_FEE
        description: A fee paid to a third-party merchant.
        x-release-status: PUBLIC
      - name: PAID_SERVICE_FEE_REFUND
        description: A fee paid to a third-party merchant.
        x-release-status: PUBLIC
      - name: REDEMPTION_CODE
        description: Repayment for a redemption code.
        x-release-status: PUBLIC
      - name: REFUND
        description: A refund for an existing card payment.
        x-release-status: PUBLIC
      - name: RELEASE_ADJUSTMENT
        description: An adjustment made by Square related to releasing a payment.
        x-release-status: PUBLIC
      - name: RESERVE_HOLD
        description: Fees paid for funding risk reserve.
        x-release-status: PUBLIC
      - name: RESERVE_RELEASE
        description: Fees released from risk reserve.
        x-release-status: PUBLIC
      - name: RETURNED_PAYOUT
        description: |-
          An entry created when Square receives a response for the ACH file that Square sent indicating that the
          settlement of the original entry failed.
        x-release-status: PUBLIC
      - 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.
        x-release-status: PUBLIC
      - 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.
        x-release-status: PUBLIC
      - name: SUBSCRIPTION_FEE
        description: A fee charged for subscription to a Square product.
        x-release-status: PUBLIC
      - name: SUBSCRIPTION_FEE_PAID_REFUND
        description: A Square subscription fee that has been refunded.
        x-release-status: PUBLIC
      - name: SUBSCRIPTION_FEE_REFUND
        description: The refund of a previously charged Square product subscription
          fee.
        x-release-status: PUBLIC
      - name: TAX_ON_FEE
        description: The tax paid on fee amounts.
        x-release-status: PUBLIC
      - name: THIRD_PARTY_FEE
        description: Fees collected by a third-party platform.
        x-release-status: PUBLIC
      - name: THIRD_PARTY_FEE_REFUND
        description: Refunded fees from a third-party platform.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: ActivityType
    DestinationType:
      type: string
      description: List of possible destinations against which a payout can be made.
      enum:
      - UNKNOWN_DESTINATION_TYPE_DO_NOT_USE
      - BANK_ACCOUNT
      - CARD
      - SQUARE_BALANCE
      - SQUARE_STORED_BALANCE
      x-enum-elements:
      - name: BANK_ACCOUNT
        description: An external bank account outside of Square.
        x-release-status: PUBLIC
      - name: CARD
        description: An external card outside of Square used for the transfer.
        x-release-status: PUBLIC
      - name: SQUARE_BALANCE
        description: ""
        x-release-status: DEPRECATED
      - name: SQUARE_STORED_BALANCE
        description: |-
          Square Checking or Savings account (US), Square Card (CA), Square Current account (UK),
          Square Compte Courant (FR), Cuenta Corriente Square (ES)
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payouts/payouts-proto/src/main/proto/squareup/payouts/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: DestinationType
    PayoutFeeType:
      type: string
      description: Represents the type of payout fee that can incur as part of a payout.
      enum:
      - UNKNOWN_PAYOUT_FEE_TYPE_DO_NOT_USE
      - TRANSFER_FEE
      - TAX_ON_TRANSFER_FEE
      x-enum-elements:
      - name: TRANSFER_FEE
        description: Fee type associated with transfers.
        x-release-status: PUBLIC
      - name: TAX_ON_TRANSFER_FEE
        description: Taxes associated with the transfer fee.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payouts/payouts-proto/src/main/proto/squareup/payouts/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PayoutFeeType
    PayoutStatus:
      type: string
      description: Payout status types
      enum:
      - UNKNOWN_PAYOUT_STATUS_DO_NOT_USE
      - SENT
      - FAILED
      - PAID
      x-enum-elements:
      - name: SENT
        description: Indicates that the payout was successfully sent to the banking
          destination.
        x-release-status: PUBLIC
      - name: FAILED
        description: Indicates that the payout was rejected by the banking destination.
        x-release-status: PUBLIC
      - name: PAID
        description: Indicates that the payout has successfully completed.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payouts/payouts-proto/src/main/proto/squareup/payouts/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PayoutStatus
    PayoutType:
      type: string
      description: |-
        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.
      enum:
      - UNKNOWN_PAYOUT_TYPE_DO_NOT_USE
      - BATCH
      - SIMPLE
      x-enum-elements:
      - name: BATCH
        description: Payouts that include a list of payout entries that can be considered
          settled.
        x-release-status: PUBLIC
      - name: SIMPLE
        description: |-
          Payouts that do not have any payout entries associated with them and will
          show up as one of the payout entries in a future BATCH payout.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payouts/payouts-proto/src/main/proto/squareup/payouts/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PayoutType
    EmployeeStatus:
      type: string
      description: The status of the Employee being retrieved.
      enum:
      - DO_NOT_USE
      - ACTIVE
      - INACTIVE
      x-enum-elements:
      - name: ACTIVE
        description: Specifies that the employee is in the Active state.
        x-release-status: DEPRECATED
      - name: INACTIVE
        description: Specifies that the employee is in the Inactive state.
        x-release-status: DEPRECATED
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/employee.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: EmployeeStatus
    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.
        x-release-status: PUBLIC
      - name: INACTIVE
        description: |-
          A functionally limited merchant account. The merchant can only have limited interaction
          via Square APIs. The merchant cannot log in or access the seller dashboard.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/merchant.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: MerchantStatus
    JobAssignmentPayType:
      type: string
      description: Enumerates the possible pay types that a job can be assigned.
      enum:
      - STATUS_DO_NOT_USE
      - NONE
      - HOURLY
      - SALARY
      x-enum-elements:
      - name: NONE
        description: The job does not have a defined pay type.
        x-release-status: PUBLIC
      - name: HOURLY
        description: The job pays an hourly rate.
        x-release-status: PUBLIC
      - name: SALARY
        description: The job pays an annual salary.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/resources/datatypes.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: JobAssignmentPayType
    TeamMemberAssignedLocationsAssignmentType:
      type: string
      description: Enumerates the possible assignment types that the team member can
        have.
      enum:
      - DO_NOT_USE
      - 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
          is empty if the team member has this assignment type.
        x-release-status: PUBLIC
      - name: EXPLICIT_LOCATIONS
        description: |-
          The team member is assigned to an explicit subset of locations. The `location_ids` field
          is the list of locations that the team member is assigned to.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/resources/datatypes.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: TeamMemberAssignedLocationsAssignmentType
    TeamMemberInvitationStatus:
      type: string
      description: Enumerates the possible invitation statuses the team member can
        have within a business.
      enum:
      - INVITATION_STATUS_DO_NOT_USE
      - UNINVITED
      - PENDING
      - ACCEPTED
      x-enum-elements:
      - name: UNINVITED
        description: The team member has not received an invitation.
        x-release-status: PUBLIC
      - name: PENDING
        description: The team member has received an invitation, but had not accepted
          it.
        x-release-status: PUBLIC
      - name: ACCEPTED
        description: The team member has both received and accepted an invitation.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/resources/datatypes.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: TeamMemberInvitationStatus
    TeamMemberStatus:
      type: string
      description: Enumerates the possible statuses the team member can have within
        a business.
      enum:
      - STATUS_DO_NOT_USE
      - ACTIVE
      - INACTIVE
      x-enum-elements:
      - name: ACTIVE
        description: The team member can sign in to Point of Sale and the Seller Dashboard.
        x-release-status: PUBLIC
      - name: INACTIVE
        description: |-
          The team member can no longer sign in to Point of Sale or the Seller Dashboard,
          but the team member's sales reports remain available.
        x-release-status: PUBLIC
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/resources/datatypes.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: TeamMemberStatus
    AccumulateLoyaltyPointsRequest:
      required:
      - accumulate_points
      - idempotency_key
      - location_id
      type: object
      properties:
        accumulate_points:
          $ref: '#/components/schemas/LoyaltyEventAccumulatePoints'
        idempotency_key:
          maxLength: 128
          minLength: 1
          type: string
          description: "A unique string that identifies the `AccumulateLoyaltyPoints`\
            \ request. \nKeys can be any valid string but must be unique for every\
            \ request."
        location_id:
          type: string
          description: The [location](entity:Location) where the purchase was made.
      description: Represents an [AccumulateLoyaltyPoints](api-endpoint:Loyalty-AccumulateLoyaltyPoints)
        request.
      example:
        accumulate_points:
          order_id: RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY
        location_id: P034NEENMD09F
        idempotency_key: 58b90739-c3e8-4b11-85f7-e636d48d72cb
      x-property-order:
      - accumulate_points
      - idempotency_key
      - location_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/accumulate-loyalty-points.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: AccumulateLoyaltyPointsRequest
      x-params-example: ?account_id=5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd
    AccumulateLoyaltyPointsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        event:
          $ref: '#/components/schemas/LoyaltyEvent'
        events:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/LoyaltyEvent'
      description: Represents an [AccumulateLoyaltyPoints](api-endpoint:Loyalty-AccumulateLoyaltyPoints)
        response.
      example:
        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
          loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd
          location_id: P034NEENMD09F
          source: LOYALTY_API
      x-property-order:
      - errors
      - event
      - events
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/accumulate-loyalty-points.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: AccumulateLoyaltyPointsResponse
    AdjustLoyaltyPointsRequest:
      required:
      - adjust_points
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          maxLength: 128
          minLength: 1
          type: string
          description: "A unique string that identifies this `AdjustLoyaltyPoints`\
            \ request. \nKeys can be any valid string, but must be unique for every\
            \ request."
        adjust_points:
          $ref: '#/components/schemas/LoyaltyEventAdjustPoints'
        allow_negative_balance:
          type: boolean
          description: |-
            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`.
      description: Represents an [AdjustLoyaltyPoints](api-endpoint:Loyalty-AdjustLoyaltyPoints)
        request.
      example:
        adjust_points:
          points: 10
          reason: Complimentary points
        idempotency_key: bc29a517-3dc9-450e-aa76-fae39ee849d1
      x-property-order:
      - adjust
      - idempotency_key
      - adjust_points
      - allow_negative_balance
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/adjust-loyalty-points.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: AdjustLoyaltyPointsRequest
      x-params-example: ?account_id=5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd
    AdjustLoyaltyPointsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        event:
          $ref: '#/components/schemas/LoyaltyEvent'
      description: Represents an [AdjustLoyaltyPoints](api-endpoint:Loyalty-AdjustLoyaltyPoints)
        request.
      example:
        event:
          id: 613a6fca-8d67-39d0-bad2-3b4bc45c8637
          type: ADJUST_POINTS
          created_at: 2020-05-08T21:42:32Z
          adjust_points:
            loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
            points: 10
            reason: Complimentary points
          loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd
          source: LOYALTY_API
      x-property-order:
      - errors
      - event
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/adjust-loyalty-points.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: AdjustLoyaltyPointsResponse
    CalculateLoyaltyPointsRequest:
      type: object
      properties:
        order_id:
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Money'
        loyalty_account_id:
          maxLength: 36
          minLength: 1
          type: string
          description: |-
            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.
      description: Represents a [CalculateLoyaltyPoints](api-endpoint:Loyalty-CalculateLoyaltyPoints)
        request.
      example:
        order_id: RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY
        loyalty_account_id: 79b807d2-d786-46a9-933b-918028d7a8c5
      x-property-order:
      - transaction_amount
      - order_id
      - transaction_amount_money
      - loyalty_account_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/calculate-loyalty-points.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: CalculateLoyaltyPointsRequest
      x-params-example: ?program_id=d619f755-2d17-41f3-990d-c04ecedd64dd
    CalculateLoyaltyPointsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        points:
          minimum: 0
          type: integer
          description: The number of points that the buyer can earn from the base
            loyalty program.
        promotion_points:
          minimum: 0
          type: integer
          description: |-
            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.
      description: Represents a [CalculateLoyaltyPoints](api-endpoint:Loyalty-CalculateLoyaltyPoints)
        response.
      example:
        points: 6
        promotion_points: 12
      x-property-order:
      - errors
      - points
      - promotion_points
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/calculate-loyalty-points.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: CalculateLoyaltyPointsResponse
    CancelLoyaltyPromotionRequest:
      type: object
      properties: {}
      description: Represents a [CancelLoyaltyPromotion](api-endpoint:Loyalty-CancelLoyaltyPromotion)
        request.
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/cancel-loyalty-promotion.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: CancelLoyaltyPromotionRequest
      x-params-example: ?program_id=d619f755-2d17-41f3-990d-c04ecedd64dd&promotion_id=loypromo_f0f9b849-725e-378d-b810-511237e07b67
    CancelLoyaltyPromotionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        loyalty_promotion:
          $ref: '#/components/schemas/LoyaltyPromotion'
      description: |-
        Represents a [CancelLoyaltyPromotion](api-endpoint:Loyalty-CancelLoyaltyPromotion) response.
        Either `loyalty_promotion` or `errors` is present in the response.
      example:
        loyalty_promotion:
          id: loypromo_f0f9b849-725e-378d-b810-511237e07b67
          name: Tuesday Happy Hour Promo
          incentive:
            type: POINTS_MULTIPLIER
            points_multiplier_data:
              points_multiplier: 3
          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: 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
      x-property-order:
      - errors
      - loyalty_promotion
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/cancel-loyalty-promotion.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: CancelLoyaltyPromotionResponse
    CreateLoyaltyAccountRequest:
      required:
      - idempotency_key
      - loyalty_account
      type: object
      properties:
        loyalty_account:
          $ref: '#/components/schemas/LoyaltyAccount'
        idempotency_key:
          maxLength: 128
          minLength: 1
          type: string
          description: "A unique string that identifies this `CreateLoyaltyAccount`\
            \ request. \nKeys can be any valid string, but must be unique for every\
            \ request."
      description: A request to create a new loyalty account.
      example:
        loyalty_account:
          mapping:
            phone_number: +14155551234
          program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
        idempotency_key: ec78c477-b1c3-4899-a209-a4e71337c996
      x-property-order:
      - loyalty_account
      - idempotency_key
      - order_id
      - location_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/create-loyalty-account.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: CreateLoyaltyAccountRequest
    CreateLoyaltyAccountResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        loyalty_account:
          $ref: '#/components/schemas/LoyaltyAccount'
      description: A response that includes loyalty account created.
      example:
        loyalty_account:
          id: 79b807d2-d786-46a9-933b-918028d7a8c5
          mapping:
            id: 66aaab3f-da99-49ed-8b19-b87f851c844f
            phone_number: +14155551234
            created_at: 2020-05-08T21:44:32Z
          program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
          balance: 0
          lifetime_points: 0
          customer_id: QPTXM8PQNX3Q726ZYHPMNP46XC
          created_at: 2020-05-08T21:44:32Z
          updated_at: 2020-05-08T21:44:32Z
      x-property-order:
      - errors
      - loyalty_account
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/create-loyalty-account.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: CreateLoyaltyAccountResponse
    CreateLoyaltyPromotionRequest:
      required:
      - idempotency_key
      - loyalty_promotion
      type: object
      properties:
        loyalty_promotion:
          $ref: '#/components/schemas/LoyaltyPromotion'
        idempotency_key:
          maxLength: 128
          minLength: 1
          type: string
          description: |-
            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).
      description: Represents a [CreateLoyaltyPromotion](api-endpoint:Loyalty-CreateLoyaltyPromotion)
        request.
      example:
        loyalty_promotion:
          name: Tuesday Happy Hour Promo
          incentive:
            type: POINTS_MULTIPLIER
            points_multiplier_data:
              points_multiplier: 3
          available_time:
            time_periods:
            - |-
              BEGIN:VEVENT
              DTSTART:20220816T160000
              DURATION:PT2H
              RRULE:FREQ=WEEKLY;BYDAY=TU
              END:VEVENT
          trigger_limit:
            times: 1
            interval: DAY
        idempotency_key: ec78c477-b1c3-4899-a209-a4e71337c996
      x-property-order:
      - loyalty_promotion
      - idempotency_key
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/create-loyalty-promotion.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: CreateLoyaltyPromotionRequest
      x-params-example: ?program_id=d619f755-2d17-41f3-990d-c04ecedd64dd
    CreateLoyaltyPromotionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        loyalty_promotion:
          $ref: '#/components/schemas/LoyaltyPromotion'
      description: |-
        Represents a [CreateLoyaltyPromotion](api-endpoint:Loyalty-CreateLoyaltyPromotion) response.
        Either `loyalty_promotion` or `errors` is present in the response.
      example:
        loyalty_promotion:
          id: loypromo_f0f9b849-725e-378d-b810-511237e07b67
          name: Tuesday Happy Hour Promo
          incentive:
            type: POINTS_MULTIPLIER
            points_multiplier_data:
              points_multiplier: 3
          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
          updated_at: 2022-08-16T08:38:54Z
          loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
      x-property-order:
      - errors
      - loyalty_promotion
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/create-loyalty-promotion.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: CreateLoyaltyPromotionResponse
    CreateLoyaltyRewardRequest:
      required:
      - idempotency_key
      - reward
      type: object
      properties:
        reward:
          $ref: '#/components/schemas/LoyaltyReward'
        idempotency_key:
          maxLength: 128
          minLength: 1
          type: string
          description: "A unique string that identifies this `CreateLoyaltyReward`\
            \ request. \nKeys can be any valid string, but must be unique for every\
            \ request."
      description: A request to create a loyalty reward.
      example:
        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
      x-property-order:
      - reward
      - idempotency_key
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/create-loyalty-reward.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: CreateLoyaltyRewardRequest
    CreateLoyaltyRewardResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        reward:
          $ref: '#/components/schemas/LoyaltyReward'
      description: A response that includes the loyalty reward created.
      example:
        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
      x-property-order:
      - errors
      - reward
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/create-loyalty-reward.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: CreateLoyaltyRewardResponse
    DeleteLoyaltyRewardRequest:
      type: object
      properties: {}
      description: A request to delete a loyalty reward.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/delete-loyalty-reward.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: DeleteLoyaltyRewardRequest
      x-params-example: ?reward_id=9f18ac21-233a-31c3-be77-b45840f5a810
    DeleteLoyaltyRewardResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: A response returned by the API call.
      example: {}
      x-property-order:
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/delete-loyalty-reward.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: DeleteLoyaltyRewardResponse
    ListLoyaltyProgramsRequest:
      type: object
      properties: {}
      description: A request to list `LoyaltyProgram`.
      example: {}
      deprecated: true
      x-property-order: []
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/list-loyalty-programs.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: ListLoyaltyProgramsRequest
    ListLoyaltyProgramsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        programs:
          type: array
          description: A list of `LoyaltyProgram` for the merchant.
          items:
            $ref: '#/components/schemas/LoyaltyProgram'
      description: A response that contains all loyalty programs.
      example:
        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: "1605486402527"
          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
      deprecated: true
      x-property-order:
      - errors
      - programs
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/list-loyalty-programs.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: ListLoyaltyProgramsResponse
    ListLoyaltyPromotionsRequest:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/LoyaltyPromotionStatus'
        cursor:
          type: string
          description: |-
            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:
          maximum: 30
          minimum: 1
          type: integer
          description: |-
            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).
      description: Represents a [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions)
        request.
      example: {}
      x-property-order:
      - status
      - cursor
      - limit
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/list-loyalty-promotions.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: ListLoyaltyPromotionsRequest
      x-params-example: ?program_id=d619f755-2d17-41f3-990d-c04ecedd64dd
    ListLoyaltyPromotionsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        loyalty_promotions:
          type: array
          description: The retrieved loyalty promotions.
          items:
            $ref: '#/components/schemas/LoyaltyPromotion'
        cursor:
          type: string
          description: |-
            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).
      description: |-
        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`.
      example:
        loyalty_promotions:
        - id: loypromo_f0f9b849-725e-378d-b810-511237e07b67
          name: Tuesday Happy Hour Promo
          incentive:
            type: POINTS_MULTIPLIER
            points_multiplier_data:
              points_multiplier: 3
          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
          updated_at: 2022-08-16T08:38:54Z
          loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
        - id: loypromo_e696f057-2286-35ff-8108-132241328106
          name: July Special
          incentive:
            type: POINTS_MULTIPLIER
            points_multiplier_data:
              points_multiplier: 2
          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
          minimum_spend_amount_money:
            amount: 2000
            currency: USD
          status: ENDED
          created_at: 2022-06-27T15:37:38Z
          updated_at: 2022-06-27T15:37:38Z
          loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
      x-property-order:
      - errors
      - loyalty_promotions
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/list-loyalty-promotions.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: ListLoyaltyPromotionsResponse
    LoyaltyEventDateTimeFilter:
      required:
      - created_at
      type: object
      properties:
        created_at:
          $ref: '#/components/schemas/TimeRange'
      description: Filter events by date time range.
      x-property-order:
      - created_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/search-loyalty-events.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEventDateTimeFilter
    LoyaltyEventFilter:
      type: object
      properties:
        loyalty_account_filter:
          $ref: '#/components/schemas/LoyaltyEventLoyaltyAccountFilter'
        type_filter:
          $ref: '#/components/schemas/LoyaltyEventTypeFilter'
        date_time_filter:
          $ref: '#/components/schemas/LoyaltyEventDateTimeFilter'
        location_filter:
          $ref: '#/components/schemas/LoyaltyEventLocationFilter'
        order_filter:
          $ref: '#/components/schemas/LoyaltyEventOrderFilter'
      description: "The filtering criteria. If the request specifies multiple filters,\
        \ \nthe endpoint uses a logical AND to evaluate them."
      x-property-order:
      - loyalty_account_filter
      - type_filter
      - date_time_filter
      - location_filter
      - order_filter
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/search-loyalty-events.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEventFilter
    LoyaltyEventLocationFilter:
      required:
      - location_ids
      type: object
      properties:
        location_ids:
          type: array
          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."
          items:
            minLength: 1
            type: string
      description: Filter events by location.
      x-property-order:
      - location_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/search-loyalty-events.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEventLocationFilter
    LoyaltyEventLoyaltyAccountFilter:
      required:
      - loyalty_account_id
      type: object
      properties:
        loyalty_account_id:
          minLength: 1
          type: string
          description: The ID of the [loyalty account](entity:LoyaltyAccount) associated
            with loyalty events.
      description: Filter events by loyalty account.
      x-property-order:
      - loyalty_account_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/search-loyalty-events.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEventLoyaltyAccountFilter
    LoyaltyEventOrderFilter:
      required:
      - order_id
      type: object
      properties:
        order_id:
          minLength: 1
          type: string
          description: The ID of the [order](entity:Order) associated with the event.
      description: Filter events by the order associated with the event.
      x-property-order:
      - order_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/search-loyalty-events.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEventOrderFilter
    LoyaltyEventQuery:
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/LoyaltyEventFilter'
      description: Represents a query used to search for loyalty events.
      x-property-order:
      - filter
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/search-loyalty-events.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEventQuery
    LoyaltyEventTypeFilter:
      required:
      - types
      type: object
      properties:
        types:
          type: array
          description: "The loyalty event types used to filter the result.\nIf multiple\
            \ values are specified, the endpoint uses a \nlogical OR to combine them.\n\
            See [LoyaltyEventType](#type-loyaltyeventtype) for possible values"
          items:
            $ref: '#/components/schemas/LoyaltyEventType'
      description: Filter events by event type.
      x-property-order:
      - types
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/search-loyalty-events.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEventTypeFilter
    RedeemLoyaltyRewardRequest:
      required:
      - idempotency_key
      - location_id
      type: object
      properties:
        idempotency_key:
          maxLength: 128
          minLength: 1
          type: string
          description: "A unique string that identifies this `RedeemLoyaltyReward`\
            \ request. \nKeys can be any valid string, but must be unique for every\
            \ request."
        location_id:
          minLength: 1
          type: string
          description: The ID of the [location](entity:Location) where the reward
            is redeemed.
      description: A request to redeem a loyalty reward.
      example:
        idempotency_key: 98adc7f7-6963-473b-b29c-f3c9cdd7d994
        location_id: P034NEENMD09F
      x-property-order:
      - idempotency_key
      - location_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/redeem-loyalty-reward.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: RedeemLoyaltyRewardRequest
      x-params-example: ?reward_id=9f18ac21-233a-31c3-be77-b45840f5a810
    RedeemLoyaltyRewardResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        event:
          $ref: '#/components/schemas/LoyaltyEvent'
      description: A response that includes the `LoyaltyEvent` published for redeeming
        the reward.
      example:
        event:
          id: 67377a6e-dbdc-369d-aa16-2e7ed422e71f
          type: REDEEM_REWARD
          created_at: 2020-05-08T21:56:00Z
          redeem_reward:
            loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
            reward_id: 9f18ac21-233a-31c3-be77-b45840f5a810
          loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd
          location_id: P034NEENMD09F
          source: LOYALTY_API
      x-property-order:
      - errors
      - event
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/redeem-loyalty-reward.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: RedeemLoyaltyRewardResponse
    RetrieveLoyaltyAccountRequest:
      type: object
      properties: {}
      description: A request to retrieve a loyalty account.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/retrieve-loyalty-account.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: RetrieveLoyaltyAccountRequest
      x-params-example: ?account_id=79b807d2-d786-46a9-933b-918028d7a8c5
    RetrieveLoyaltyAccountResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        loyalty_account:
          $ref: '#/components/schemas/LoyaltyAccount'
      description: A response that includes the loyalty account.
      example:
        loyalty_account:
          id: 79b807d2-d786-46a9-933b-918028d7a8c5
          mapping:
            id: 66aaab3f-da99-49ed-8b19-b87f851c844f
            phone_number: +14155551234
            created_at: 2020-05-08T21:44:32Z
          program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
          balance: 10
          lifetime_points: 20
          customer_id: Q8002FAM9V1EZ0ADB2T5609X6NET1H0
          created_at: 2020-05-08T21:44:32Z
          updated_at: 2020-05-08T21:44:32Z
      x-property-order:
      - errors
      - loyalty_account
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/retrieve-loyalty-account.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: RetrieveLoyaltyAccountResponse
    RetrieveLoyaltyProgramRequest:
      type: object
      properties: {}
      description: A request to retrieve the [loyalty program](entity:LoyaltyProgram)
        that belongs to a seller. A seller can have only one loyalty program.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/retrieve-loyalty-program.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: RetrieveLoyaltyProgramRequest
      x-params-example: ?program_id=main
    RetrieveLoyaltyProgramResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        program:
          $ref: '#/components/schemas/LoyaltyProgram'
      description: A response that contains the loyalty program.
      example:
        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: "1605486402527"
          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
      x-property-order:
      - errors
      - program
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/retrieve-loyalty-program.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: RetrieveLoyaltyProgramResponse
    RetrieveLoyaltyPromotionRequest:
      type: object
      properties: {}
      description: Represents a [RetrieveLoyaltyPromotionPromotions](api-endpoint:Loyalty-RetrieveLoyaltyPromotion)
        request.
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/retrieve-loyalty-promotion.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: RetrieveLoyaltyPromotionRequest
      x-params-example: ?program_id=d619f755-2d17-41f3-990d-c04ecedd64dd&promotion_id=loypromo_f0f9b849-725e-378d-b810-511237e07b67
    RetrieveLoyaltyPromotionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        loyalty_promotion:
          $ref: '#/components/schemas/LoyaltyPromotion'
      description: Represents a [RetrieveLoyaltyPromotionPromotions](api-endpoint:Loyalty-RetrieveLoyaltyPromotion)
        response.
      example:
        loyalty_promotion:
          id: loypromo_f0f9b849-725e-378d-b810-511237e07b67
          name: Tuesday Happy Hour Promo
          incentive:
            type: POINTS_MULTIPLIER
            points_multiplier_data:
              points_multiplier: 3
          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
          updated_at: 2022-08-16T08:38:54Z
          loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
      x-property-order:
      - errors
      - loyalty_promotion
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/retrieve-loyalty-promotion.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: RetrieveLoyaltyPromotionResponse
    RetrieveLoyaltyRewardRequest:
      type: object
      properties: {}
      description: A request to retrieve a loyalty reward.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/retrieve-loyalty-reward.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: RetrieveLoyaltyRewardRequest
      x-params-example: ?reward_id=9f18ac21-233a-31c3-be77-b45840f5a810
    RetrieveLoyaltyRewardResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        reward:
          $ref: '#/components/schemas/LoyaltyReward'
      description: A response that includes the loyalty reward.
      example:
        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
          created_at: 2020-05-08T21:55:42Z
          updated_at: 2020-05-08T21:56:00Z
          redeemed_at: 2020-05-08T21:56:00Z
      x-property-order:
      - errors
      - reward
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/retrieve-loyalty-reward.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: RetrieveLoyaltyRewardResponse
    SearchLoyaltyAccountsRequest:
      type: object
      properties:
        query:
          $ref: '#/components/schemas/SearchLoyaltyAccountsRequestLoyaltyAccountQuery'
        limit:
          maximum: 30
          minimum: 1
          type: integer
          description: The maximum number of results to include in the response. The
            default value is 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.\n\nFor more information, \nsee [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)."
      description: A request to search for loyalty accounts.
      example:
        query:
          mappings:
          - phone_number: +14155551234
        limit: 10
      x-property-order:
      - query
      - limit
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/search-loyalty-accounts.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: SearchLoyaltyAccountsRequest
    SearchLoyaltyAccountsRequestLoyaltyAccountQuery:
      type: object
      properties:
        mappings:
          type: array
          description: "The set of mappings to use in the loyalty account search.\
            \  \n\nThis cannot be combined with `customer_ids`.  \n\nMax: 30 mappings"
          items:
            $ref: '#/components/schemas/LoyaltyAccountMapping'
        customer_ids:
          type: array
          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"
          items:
            type: string
      description: The search criteria for the loyalty accounts.
      x-property-order:
      - mappings
      - customer_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/search-loyalty-accounts.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: SearchLoyaltyAccountsRequestLoyaltyAccountQuery
    SearchLoyaltyAccountsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        loyalty_accounts:
          type: array
          description: "The loyalty accounts that met the search criteria,  \nin order\
            \ of creation date."
          items:
            $ref: '#/components/schemas/LoyaltyAccount'
        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/basics/api101/pagination)."
      description: A response that includes loyalty accounts that satisfy the search
        criteria.
      example:
        loyalty_accounts:
        - id: 79b807d2-d786-46a9-933b-918028d7a8c5
          mapping:
            id: 66aaab3f-da99-49ed-8b19-b87f851c844f
            phone_number: +14155551234
            created_at: 2020-05-08T21:44:32Z
          program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
          balance: 10
          lifetime_points: 20
          customer_id: Q8002FAM9V1EZ0ADB2T5609X6NET1H0
          created_at: 2020-05-08T21:44:32Z
          updated_at: 2020-05-08T21:44:32Z
      x-property-order:
      - errors
      - loyalty_accounts
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/search-loyalty-accounts.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: SearchLoyaltyAccountsResponse
    SearchLoyaltyEventsRequest:
      type: object
      properties:
        query:
          $ref: '#/components/schemas/LoyaltyEventQuery'
        limit:
          maximum: 30
          minimum: 1
          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."
        cursor:
          type: string
          description: |-
            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/basics/api101/pagination).
      description: A request to search for loyalty events.
      example:
        query:
          filter:
            order_filter:
              order_id: PyATxhYLfsMqpVkcKJITPydgEYfZY
        limit: 30
      x-property-order:
      - query
      - limit
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/search-loyalty-events.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: SearchLoyaltyEventsRequest
    SearchLoyaltyEventsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        events:
          type: array
          description: The loyalty events that satisfy the search criteria.
          items:
            $ref: '#/components/schemas/LoyaltyEvent'
        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/basics/api101/pagination)."
      description: "A response that contains loyalty events that satisfy the search\
        \ \ncriteria, in order by the `created_at` date."
      example:
        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
          loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd
          location_id: P034NEENMD09F
          source: LOYALTY_API
        - id: e4a5cbc3-a4d0-3779-98e9-e578885d9430
          type: REDEEM_REWARD
          created_at: 2020-05-08T22:01:15Z
          redeem_reward:
            loyalty_program_id: d619f755-2d17-41f3-990d-c04ecedd64dd
            reward_id: d03f79f4-815f-3500-b851-cc1e68a457f9
            order_id: PyATxhYLfsMqpVkcKJITPydgEYfZY
          loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd
          location_id: P034NEENMD09F
          source: LOYALTY_API
        - 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
          loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd
          source: LOYALTY_API
      x-property-order:
      - errors
      - events
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/search-loyalty-events.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: SearchLoyaltyEventsResponse
    SearchLoyaltyRewardsRequest:
      type: object
      properties:
        query:
          $ref: '#/components/schemas/SearchLoyaltyRewardsRequestLoyaltyRewardQuery'
        limit:
          maximum: 30
          minimum: 1
          type: integer
          description: The maximum number of results to return in the response. The
            default value is 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/basics/api101/pagination)."
      description: A request to search for loyalty rewards.
      example:
        query:
          loyalty_account_id: 5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd
        limit: 10
      x-property-order:
      - query
      - limit
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/search-loyalty-rewards.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: SearchLoyaltyRewardsRequest
    SearchLoyaltyRewardsRequestLoyaltyRewardQuery:
      required:
      - loyalty_account_id
      type: object
      properties:
        loyalty_account_id:
          minLength: 1
          type: string
          description: The ID of the [loyalty account](entity:LoyaltyAccount) to which
            the loyalty reward belongs.
        status:
          $ref: '#/components/schemas/LoyaltyRewardStatus'
      description: The set of search requirements.
      x-property-order:
      - loyalty_account_id
      - status
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/search-loyalty-rewards.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: SearchLoyaltyRewardsRequestLoyaltyRewardQuery
    SearchLoyaltyRewardsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        rewards:
          type: array
          description: |-
            The loyalty rewards that satisfy the search criteria.
            These are returned in descending order by `updated_at`.
          items:
            $ref: '#/components/schemas/LoyaltyReward'
        cursor:
          type: string
          description: "The pagination cursor to be used in a subsequent \nrequest.\
            \ If empty, this is the final response."
      description: A response that includes the loyalty rewards satisfying the search
        criteria.
      example:
        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
          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
        - 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
      x-property-order:
      - errors
      - rewards
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/interfaces/search-loyalty-rewards.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: SearchLoyaltyRewardsResponse
    LoyaltyAccount:
      required:
      - program_id
      type: object
      properties:
        id:
          maxLength: 36
          type: string
          description: The Square-assigned ID of the loyalty account.
          readOnly: true
        mappings:
          type: array
          description: "The list of mappings that the account is associated with.\
            \ \nCurrently, a buyer can only be mapped to a loyalty account using \n\
            a phone number. Therefore, the list can only have one mapping.\nRETIRED\
            \ at version 2021-05-13. Replaced by the `mapping` field."
          items:
            $ref: '#/components/schemas/LoyaltyAccountMapping'
          x-release-status: RETIRED
        program_id:
          maxLength: 36
          minLength: 1
          type: string
          description: The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram)
            to which the account belongs.
        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.

            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.
          readOnly: true
        lifetime_points:
          minimum: 0
          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.
        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."
        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'
        expiring_point_deadlines:
          type: array
          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."
          items:
            $ref: '#/components/schemas/LoyaltyAccountExpiringPointDeadline'
      description: |-
        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).
      x-property-order:
      - id
      - mappings
      - program_id
      - balance
      - lifetime_points
      - customer_id
      - enrolled_at
      - created_at
      - updated_at
      - mapping
      - expiring_point_deadlines
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-account.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyAccount
    LoyaltyAccountExpiringPointDeadline:
      required:
      - expires_at
      - points
      type: object
      properties:
        points:
          minimum: 0
          type: integer
          description: The number of points scheduled to expire at the `expires_at`
            timestamp.
        expires_at:
          minLength: 1
          type: string
          description: The timestamp of when the points are scheduled to expire, in
            RFC 3339 format.
      description: Represents a set of points for a loyalty account that are scheduled
        to expire on a specific date.
      x-property-order:
      - points
      - expires_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-account.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyAccountExpiringPointDeadline
    LoyaltyAccountMapping:
      type: object
      properties:
        id:
          maxLength: 36
          type: string
          description: The Square-assigned ID of the mapping.
          readOnly: true
        type:
          $ref: '#/components/schemas/LoyaltyAccountMappingType'
        value:
          type: string
          description: |-
            The mapping value, which is used with `type` to represent a phone number mapping.
            The value can be a phone number in E.164 format. For example, "+14155551111".
            RETIRED at version 2021-05-13. When specifying a mapping, use the `phone_number` field instead.
          x-release-status: RETIRED
        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".
      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-property-order:
      - id
      - type
      - value
      - created_at
      - phone_number
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-account.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyAccountMapping
    LoyaltyEvent:
      required:
      - created_at
      - id
      - loyalty_account_id
      - source
      - type
      type: object
      properties:
        id:
          minLength: 1
          type: string
          description: The Square-assigned ID of the loyalty event.
          readOnly: true
        type:
          $ref: '#/components/schemas/LoyaltyEventType'
        created_at:
          minLength: 1
          type: string
          description: The timestamp when the event was created, in RFC 3339 format.
          readOnly: true
        accumulate_points:
          $ref: '#/components/schemas/LoyaltyEventAccumulatePoints'
        create_reward:
          $ref: '#/components/schemas/LoyaltyEventCreateReward'
        redeem_reward:
          $ref: '#/components/schemas/LoyaltyEventRedeemReward'
        delete_reward:
          $ref: '#/components/schemas/LoyaltyEventDeleteReward'
        adjust_points:
          $ref: '#/components/schemas/LoyaltyEventAdjustPoints'
        loyalty_account_id:
          maxLength: 36
          minLength: 1
          type: string
          description: The ID of the [loyalty account](entity:LoyaltyAccount) associated
            with the event.
          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'
        expire_points:
          $ref: '#/components/schemas/LoyaltyEventExpirePoints'
        other_event:
          $ref: '#/components/schemas/LoyaltyEventOther'
        accumulate_promotion_points:
          $ref: '#/components/schemas/LoyaltyEventAccumulatePromotionPoints'
      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-property-order:
      - id
      - type
      - created_at
      - create_account
      - accumulate_points
      - create_reward
      - redeem_reward
      - delete_reward
      - adjust_points
      - loyalty_account_id
      - location_id
      - source
      - expire_points
      - other_event
      - source_application
      - accumulate_promotion_points
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-event.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEvent
    LoyaltyEventAccumulatePoints:
      type: object
      properties:
        loyalty_program_id:
          maxLength: 36
          type: string
          description: The ID of the [loyalty program](entity:LoyaltyProgram).
          readOnly: true
        points:
          minimum: 1
          type: integer
          description: The number of points accumulated by the event.
        order_id:
          type: string
          description: |-
            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.
      description: Provides metadata when the event `type` is `ACCUMULATE_POINTS`.
      x-property-order:
      - loyalty_program_id
      - points
      - order_id
      - reason
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-event.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEventAccumulatePoints
    LoyaltyEventAccumulatePromotionPoints:
      required:
      - order_id
      - points
      type: object
      properties:
        loyalty_program_id:
          maxLength: 36
          type: string
          description: The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram).
          readOnly: true
        loyalty_promotion_id:
          maxLength: 255
          minLength: 1
          type: string
          description: The Square-assigned ID of the [loyalty promotion](entity:LoyaltyPromotion).
          readOnly: true
        points:
          minimum: 0
          type: integer
          description: The number of points earned by the event.
          readOnly: true
        order_id:
          minLength: 1
          type: string
          description: |-
            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.
          readOnly: true
      description: Provides metadata when the event `type` is `ACCUMULATE_PROMOTION_POINTS`.
      x-property-order:
      - loyalty_program_id
      - loyalty_promotion_id
      - points
      - order_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-event.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEventAccumulatePromotionPoints
    LoyaltyEventAdjustPoints:
      required:
      - points
      type: object
      properties:
        loyalty_program_id:
          maxLength: 36
          type: string
          description: The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram).
          readOnly: true
        points:
          type: integer
          description: The number of points added or removed.
        reason:
          type: string
          description: The reason for the adjustment of points.
      description: Provides metadata when the event `type` is `ADJUST_POINTS`.
      x-property-order:
      - loyalty_program_id
      - points
      - reason
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-event.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEventAdjustPoints
    LoyaltyEventCreateReward:
      required:
      - loyalty_program_id
      - points
      type: object
      properties:
        loyalty_program_id:
          maxLength: 36
          minLength: 1
          type: string
          description: The ID of the [loyalty program](entity:LoyaltyProgram).
          readOnly: true
        reward_id:
          maxLength: 36
          type: string
          description: |-
            The Square-assigned ID of the created [loyalty reward](entity:LoyaltyReward).
            This field is returned only if the event source is `LOYALTY_API`.
          readOnly: true
        points:
          maximum: 0
          type: integer
          description: The loyalty points used to create the reward.
          readOnly: true
      description: Provides metadata when the event `type` is `CREATE_REWARD`.
      x-property-order:
      - loyalty_program_id
      - reward_id
      - points
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-event.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEventCreateReward
    LoyaltyEventDeleteReward:
      required:
      - loyalty_program_id
      - points
      type: object
      properties:
        loyalty_program_id:
          maxLength: 36
          minLength: 1
          type: string
          description: The ID of the [loyalty program](entity:LoyaltyProgram).
          readOnly: true
        reward_id:
          maxLength: 36
          type: string
          description: |-
            The ID of the deleted [loyalty reward](entity:LoyaltyReward).
            This field is returned only if the event source is `LOYALTY_API`.
          readOnly: true
        points:
          minimum: 0
          type: integer
          description: The number of points returned to the loyalty account.
          readOnly: true
      description: Provides metadata when the event `type` is `DELETE_REWARD`.
      x-property-order:
      - loyalty_program_id
      - reward_id
      - points
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-event.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEventDeleteReward
    LoyaltyEventExpirePoints:
      required:
      - loyalty_program_id
      - points
      type: object
      properties:
        loyalty_program_id:
          maxLength: 36
          minLength: 1
          type: string
          description: The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram).
          readOnly: true
        points:
          maximum: 0
          type: integer
          description: The number of points expired.
      description: Provides metadata when the event `type` is `EXPIRE_POINTS`.
      x-property-order:
      - loyalty_program_id
      - points
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-event.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEventExpirePoints
    LoyaltyEventOther:
      required:
      - loyalty_program_id
      - points
      type: object
      properties:
        loyalty_program_id:
          maxLength: 36
          minLength: 1
          type: string
          description: The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram).
          readOnly: true
        points:
          type: integer
          description: The number of points added or removed.
      description: Provides metadata when the event `type` is `OTHER`.
      x-property-order:
      - loyalty_program_id
      - points
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-event.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEventOther
    LoyaltyEventRedeemReward:
      required:
      - loyalty_program_id
      type: object
      properties:
        loyalty_program_id:
          maxLength: 36
          minLength: 1
          type: string
          description: The ID of the [loyalty program](entity:LoyaltyProgram).
          readOnly: true
        reward_id:
          maxLength: 36
          type: string
          description: |-
            The ID of the redeemed [loyalty reward](entity:LoyaltyReward).
            This field is returned only if the event source is `LOYALTY_API`.
          readOnly: true
        order_id:
          type: string
          description: |-
            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.
          readOnly: true
      description: Provides metadata when the event `type` is `REDEEM_REWARD`.
      x-property-order:
      - loyalty_program_id
      - reward_id
      - order_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-event.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyEventRedeemReward
    LoyaltyProgram:
      required:
      - accrual_rules
      - created_at
      - id
      - reward_tiers
      - status
      - terminology
      - updated_at
      type: object
      properties:
        id:
          maxLength: 36
          minLength: 1
          type: string
          description: "The Square-assigned ID of the loyalty program. Updates to\
            \ \nthe loyalty program do not modify the identifier."
          readOnly: true
        status:
          $ref: '#/components/schemas/LoyaltyProgramStatus'
        reward_tiers:
          type: array
          description: The list of rewards for buyers, sorted by ascending points.
          readOnly: true
          items:
            $ref: '#/components/schemas/LoyaltyProgramRewardTier'
        expiration_policy:
          $ref: '#/components/schemas/LoyaltyProgramExpirationPolicy'
        terminology:
          $ref: '#/components/schemas/LoyaltyProgramTerminology'
        location_ids:
          type: array
          description: The [locations](entity:Location) at which the program is active.
          readOnly: true
          items:
            minLength: 1
            type: string
        created_at:
          minLength: 1
          type: string
          description: The timestamp when the program was created, in RFC 3339 format.
          readOnly: true
        updated_at:
          minLength: 1
          type: string
          description: The timestamp when the reward was last updated, in RFC 3339
            format.
          readOnly: true
        accrual_rules:
          type: array
          description: |-
            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).
          readOnly: true
          items:
            $ref: '#/components/schemas/LoyaltyProgramAccrualRule'
      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-property-order:
      - id
      - description
      - status
      - reward_tiers
      - rule
      - expiration_policy
      - terminology
      - location_ids
      - created_at
      - updated_at
      - accrual_rules
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-program.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyProgram
    LoyaltyProgramAccrualRule:
      required:
      - accrual_type
      type: object
      properties:
        accrual_type:
          $ref: '#/components/schemas/LoyaltyProgramAccrualRuleType'
        points:
          minimum: 1
          type: integer
          description: "The number of points that \nbuyers earn based on the `accrual_type`."
          readOnly: true
        visit_minimum_amount_money:
          $ref: '#/components/schemas/Money'
        spend_amount_money:
          $ref: '#/components/schemas/Money'
        catalog_object_id:
          type: string
          description: "When the accrual rule is item-based or category-based, this\
            \ field specifies the ID \nof the [catalog object](entity:CatalogObject)\
            \ that buyers can purchase to earn points. \nIf `accrual_type` is `ITEM_VARIATION`,\
            \ the object is an item variation. \nIf `accrual_type` is `CATEGORY`,\
            \ the object is a category."
          readOnly: true
          x-release-status: RETIRED
        excluded_category_ids:
          type: array
          description: "When the accrual rule is spend-based (`accrual_type` is `SPEND`),\
            \ this field \nlists 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."
          readOnly: true
          items:
            type: string
          x-release-status: RETIRED
        excluded_item_variation_ids:
          type: array
          description: "When the accrual rule is spend-based (`accrual_type` is `SPEND`),\
            \ this field \nlists 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."
          readOnly: true
          items:
            type: string
          x-release-status: RETIRED
        visit_data:
          $ref: '#/components/schemas/LoyaltyProgramAccrualRuleVisitData'
        spend_data:
          $ref: '#/components/schemas/LoyaltyProgramAccrualRuleSpendData'
        item_variation_data:
          $ref: '#/components/schemas/LoyaltyProgramAccrualRuleItemVariationData'
        category_data:
          $ref: '#/components/schemas/LoyaltyProgramAccrualRuleCategoryData'
      description: Represents an accrual rule, which defines how buyers can earn points
        from the base [loyalty program](entity:LoyaltyProgram).
      x-property-order:
      - accrual_type
      - points
      - visit_minimum_amount_money
      - spend_amount_money
      - catalog_object_id
      - excluded_category_ids
      - excluded_item_variation_ids
      - visit_data
      - spend_data
      - item_variation_data
      - category_data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-program.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyProgramAccrualRule
    LoyaltyProgramAccrualRuleCategoryData:
      required:
      - category_id
      type: object
      properties:
        category_id:
          minLength: 1
          type: string
          description: |-
            The ID of the `CATEGORY` [catalog object](entity:CatalogObject) that buyers can purchase to earn
            points.
          readOnly: true
      description: Represents additional data for rules with the `CATEGORY` accrual
        type.
      x-property-order:
      - category_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-program.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyProgramAccrualRuleCategoryData
    LoyaltyProgramAccrualRuleItemVariationData:
      required:
      - item_variation_id
      type: object
      properties:
        item_variation_id:
          minLength: 1
          type: string
          description: |-
            The ID of the `ITEM_VARIATION` [catalog object](entity:CatalogObject) that buyers can purchase to earn
            points.
          readOnly: true
      description: Represents additional data for rules with the `ITEM_VARIATION`
        accrual type.
      x-property-order:
      - item_variation_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-program.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyProgramAccrualRuleItemVariationData
    LoyaltyProgramAccrualRuleSpendData:
      required:
      - amount_money
      - tax_mode
      type: object
      properties:
        amount_money:
          $ref: '#/components/schemas/Money'
        excluded_category_ids:
          type: array
          description: |-
            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.
          readOnly: true
          items:
            type: string
        excluded_item_variation_ids:
          type: array
          description: |-
            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.
          readOnly: true
          items:
            type: string
        tax_mode:
          $ref: '#/components/schemas/LoyaltyProgramAccrualRuleTaxMode'
      description: Represents additional data for rules with the `SPEND` accrual type.
      x-property-order:
      - amount_money
      - excluded_category_ids
      - excluded_item_variation_ids
      - tax_mode
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-program.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyProgramAccrualRuleSpendData
    LoyaltyProgramAccrualRuleVisitData:
      required:
      - tax_mode
      type: object
      properties:
        minimum_amount_money:
          $ref: '#/components/schemas/Money'
        tax_mode:
          $ref: '#/components/schemas/LoyaltyProgramAccrualRuleTaxMode'
      description: Represents additional data for rules with the `VISIT` accrual type.
      x-property-order:
      - minimum_amount_money
      - tax_mode
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-program.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyProgramAccrualRuleVisitData
    LoyaltyProgramExpirationPolicy:
      required:
      - expiration_duration
      type: object
      properties:
        expiration_duration:
          minLength: 1
          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."
          readOnly: true
      description: Describes when the loyalty program expires.
      x-property-order:
      - expiration_duration
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-program.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyProgramExpirationPolicy
    LoyaltyProgramRewardDefinition:
      required:
      - discount_type
      - scope
      type: object
      properties:
        scope:
          $ref: '#/components/schemas/LoyaltyProgramRewardDefinitionScope'
        discount_type:
          $ref: '#/components/schemas/LoyaltyProgramRewardDefinitionType'
        percentage_discount:
          type: string
          description: |-
            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.
          readOnly: true
        catalog_object_ids:
          type: array
          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.
            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.
          readOnly: true
          items:
            type: string
        fixed_discount_money:
          $ref: '#/components/schemas/Money'
        max_discount_money:
          $ref: '#/components/schemas/Money'
      description: |-
        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).
      deprecated: true
      x-property-order:
      - scope
      - discount_type
      - fixed_discount
      - percentage_discount
      - max_discount
      - catalog_object_ids
      - fixed_discount_money
      - max_discount_money
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-program.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyProgramRewardDefinition
    LoyaltyProgramRewardTier:
      required:
      - created_at
      - definition
      - id
      - name
      - points
      type: object
      properties:
        id:
          maxLength: 36
          minLength: 1
          type: string
          description: The Square-assigned ID of the reward tier.
          readOnly: true
        points:
          minimum: 1
          type: integer
          description: The points exchanged for the reward tier.
          readOnly: true
        name:
          minLength: 1
          type: string
          description: The name of the reward tier.
          readOnly: true
        definition:
          $ref: '#/components/schemas/LoyaltyProgramRewardDefinition'
        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: 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-property-order:
      - id
      - points
      - name
      - definition
      - created_at
      - pricing_rule_reference
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-program.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyProgramRewardTier
    LoyaltyProgramTerminology:
      required:
      - one
      - other
      type: object
      properties:
        one:
          minLength: 1
          type: string
          description: A singular unit for a point (for example, 1 point is called
            1 star).
          readOnly: true
        other:
          minLength: 1
          type: string
          description: A plural unit for point (for example, 10 points is called 10
            stars).
          readOnly: true
      description: Represents the naming used for loyalty points.
      x-property-order:
      - one
      - other
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-program.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyProgramTerminology
    LoyaltyPromotion:
      required:
      - available_time
      - incentive
      - name
      type: object
      properties:
        id:
          maxLength: 255
          minLength: 1
          type: string
          description: The Square-assigned ID of the promotion.
          readOnly: true
        name:
          maxLength: 50
          minLength: 1
          type: string
          description: The name of the promotion.
        incentive:
          $ref: '#/components/schemas/LoyaltyPromotionIncentive'
        available_time:
          $ref: '#/components/schemas/LoyaltyPromotionAvailableTimeData'
        trigger_limit:
          $ref: '#/components/schemas/LoyaltyPromotionTriggerLimit'
        status:
          $ref: '#/components/schemas/LoyaltyPromotionStatus'
        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: |-
        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.
      x-property-order:
      - id
      - name
      - incentive
      - available_time
      - trigger_limit
      - minimum_amount_spent_money
      - status
      - created_at
      - canceled_at
      - updated_at
      - loyalty_program_id
      - version
      - minimum_spend_amount_money
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-promotion.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyPromotion
    LoyaltyPromotionAvailableTimeData:
      required:
      - time_periods
      type: object
      properties:
        start_date:
          type: string
          description: |-
            The date that the promotion starts, in `YYYY-MM-DD` format. Square populates this field
            based 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
            based on the provided `time_periods`. If an end date is not specified, an `ACTIVE` promotion
            remains available until it is canceled.
          readOnly: true
        time_periods:
          type: array
          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."
          items:
            type: string
      description: |-
        Represents scheduling information that determines when purchases can qualify to earn points
        from a [loyalty promotion](entity:LoyaltyPromotion).
      x-property-order:
      - start_date
      - end_date
      - time_periods
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-promotion.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyPromotionAvailableTimeData
    LoyaltyPromotionIncentive:
      required:
      - type
      type: object
      properties:
        type:
          $ref: '#/components/schemas/LoyaltyPromotionIncentiveType'
        points_multiplier_data:
          $ref: '#/components/schemas/LoyaltyPromotionIncentivePointsMultiplierData'
        points_addition_data:
          $ref: '#/components/schemas/LoyaltyPromotionIncentivePointsAdditionData'
      description: |-
        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.
      x-property-order:
      - type
      - points_multiplier_data
      - points_addition_data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-promotion.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyPromotionIncentive
    LoyaltyPromotionIncentivePointsAdditionData:
      required:
      - points_addition
      type: object
      properties:
        points_addition:
          minimum: 1
          type: integer
          description: |-
            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).
      description: Represents the metadata for a `POINTS_ADDITION` type of [loyalty
        promotion incentive](entity:LoyaltyPromotionIncentive).
      x-property-order:
      - points_addition
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-promotion.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyPromotionIncentivePointsAdditionData
    LoyaltyPromotionIncentivePointsMultiplierData:
      required:
      - points_multiplier
      type: object
      properties:
        points_multiplier:
          maximum: 10
          minimum: 2
          type: integer
          description: |-
            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).
      description: Represents the metadata for a `POINTS_MULTIPLIER` type of [loyalty
        promotion incentive](entity:LoyaltyPromotionIncentive).
      x-property-order:
      - points_multiplier
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-promotion.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyPromotionIncentivePointsMultiplierData
    LoyaltyPromotionTriggerLimit:
      required:
      - times
      type: object
      properties:
        times:
          maximum: 30
          minimum: 1
          type: integer
          description: The maximum number of times a buyer can trigger the promotion
            during the specified `interval`.
        interval:
          $ref: '#/components/schemas/LoyaltyPromotionTriggerLimitInterval'
      description: |-
        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.
      x-property-order:
      - times
      - time_period
      - interval
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-promotion.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyPromotionTriggerLimit
    LoyaltyReward:
      required:
      - loyalty_account_id
      - reward_tier_id
      type: object
      properties:
        id:
          maxLength: 36
          type: string
          description: The Square-assigned ID of the loyalty reward.
          readOnly: true
        status:
          $ref: '#/components/schemas/LoyaltyRewardStatus'
        loyalty_account_id:
          maxLength: 36
          minLength: 1
          type: string
          description: The Square-assigned ID of the [loyalty account](entity:LoyaltyAccount)
            to which the reward belongs.
        reward_tier_id:
          maxLength: 36
          minLength: 1
          type: string
          description: The Square-assigned ID of the [reward tier](entity:LoyaltyProgramRewardTier)
            used to create the reward.
        points:
          minimum: 1
          type: integer
          description: The number of loyalty points used for the reward.
          readOnly: true
        order_id:
          type: string
          description: The Square-assigned ID of the [order](entity:Order) to which
            the reward is attached.
        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
      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-property-order:
      - id
      - status
      - loyalty_account_id
      - reward_tier_id
      - points
      - order_id
      - created_at
      - updated_at
      - redeemed_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /card/balance/connect-api/src/main/proto/squareup/card/balance/loyalty_api/model/loyalty-reward.proto
      x-proto-sha: 74ecdcca771fee744cc30915042ec24293628a28
      x-object-name: LoyaltyReward
    CreateCardRequest:
      required:
      - card
      - idempotency_key
      - source_id
      type: object
      properties:
        idempotency_key:
          minLength: 1
          type: string
          description: |-
            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/basics/api101/idempotency) for more information.
        source_id:
          maxLength: 16384
          minLength: 1
          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.
        verification_token:
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Card'
      description: |-
        Creates a card from the source (nonce, payment id, etc). Accessible via
        HTTP requests at POST https://connect.squareup.com/v2/cards
      example:
        idempotency_key: 4935a656-a929-4792-b97c-8848be85c27c
        source_id: cnon:uIbfJXhXETSP197M3GB
        card:
          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
          customer_id: VDKXEEKPJN48QDG3BGGFAK05P8
          reference_id: user-id-1
      x-property-order:
      - idempotency_key
      - source_id
      - verification_token
      - card
      - square_product
      - card_nonce
      - billing_address
      - cardholder_name
      - reference_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /cards-api/protos/squareup/cards/api/cards_store_api.proto
      x-proto-sha: 45981bf2b47428d1befee008c73b5fe7a15439b2
      x-object-name: CreateCardRequest
    CreateCardResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        card:
          $ref: '#/components/schemas/Card'
      description: |-
        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.
      example:
        card:
          id: ccof:uIbfJXhXETSP197M3GB
          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
          bin: "411111"
          card_brand: VISA
          card_type: CREDIT
          cardholder_name: Amelia Earhart
          customer_id: VDKXEEKPJN48QDG3BGGFAK05P8
          enabled: true
          exp_month: 11
          exp_year: 2022
          last_4: "1111"
          merchant_id: 6SSW7HV8K2ST5
          prepaid_type: NOT_PREPAID
          reference_id: user-id-1
          version: 1
      x-property-order:
      - errors
      - card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /cards-api/protos/squareup/cards/api/cards_store_api.proto
      x-proto-sha: 45981bf2b47428d1befee008c73b5fe7a15439b2
      x-object-name: CreateCardResponse
    DisableCardRequest:
      type: object
      properties: {}
      description: |-
        Disables the card, preventing any further updates or charges. Disabling
        an already disabled card is allowed but has no effect. Accessible via
        HTTP requests at POST https://connect.squareup.com/v2/cards/{card_id}/disable
      example: {}
      x-property-order:
      - square_product
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /cards-api/protos/squareup/cards/api/cards_store_api.proto
      x-proto-sha: 45981bf2b47428d1befee008c73b5fe7a15439b2
      x-object-name: DisableCardRequest
    DisableCardResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        card:
          $ref: '#/components/schemas/Card'
      description: |-
        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.
      example:
        card:
          id: ccof:uIbfJXhXETSP197M3GB
          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
          bin: "411111"
          card_brand: VISA
          card_type: CREDIT
          cardholder_name: Amelia Earhart
          customer_id: VDKXEEKPJN48QDG3BGGFAK05P8
          enabled: false
          exp_month: 11
          exp_year: 2022
          last_4: "1111"
          merchant_id: 6SSW7HV8K2ST5
          prepaid_type: NOT_PREPAID
          reference_id: user-id-1
          version: 2
      x-property-order:
      - errors
      - card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /cards-api/protos/squareup/cards/api/cards_store_api.proto
      x-proto-sha: 45981bf2b47428d1befee008c73b5fe7a15439b2
      x-object-name: DisableCardResponse
    ListCardsRequest:
      type: object
      properties:
        cursor:
          maxLength: 256
          type: string
          description: |-
            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/basics/api101/pagination) for more information.
        customer_id:
          type: string
          description: |-
            Limit results to cards associated with the customer supplied.
            By default, all cards owned by the merchant are returned.
        include_disabled:
          type: boolean
          description: |-
            Includes disabled cards.
            By default, all enabled cards owned by the merchant are returned.
        reference_id:
          type: string
          description: Limit results to cards associated with the reference_id supplied.
        sort_order:
          $ref: '#/components/schemas/SortOrder'
      description: |-
        Retrieves details for a specific Card. Accessible via
        HTTP requests at GET https://connect.squareup.com/v2/cards
      example: {}
      x-property-order:
      - cursor
      - customer_id
      - buyer_id
      - include_disabled
      - reference_id
      - fidelius_token
      - sort_order
      - limit
      - enabled
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /cards-api/protos/squareup/cards/api/cards_store_api.proto
      x-proto-sha: 45981bf2b47428d1befee008c73b5fe7a15439b2
      x-object-name: ListCardsRequest
    ListCardsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        cards:
          type: array
          description: The requested list of `Card`s.
          items:
            $ref: '#/components/schemas/Card'
        cursor:
          type: string
          description: |-
            The pagination cursor to be used in a subsequent request. If empty,
            this is the final response.

            See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.
      description: |-
        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.
      example:
        cards:
        - card:
            id: ccof:uIbfJXhXETSP197M3GB
            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
            bin: "411111"
            card_brand: VISA
            card_type: CREDIT
            cardholder_name: Amelia Earhart
            customer_id: VDKXEEKPJN48QDG3BGGFAK05P8
            enabled: true
            exp_month: 11
            exp_year: 2022
            last_4: "1111"
            merchant_id: 6SSW7HV8K2ST5
            prepaid_type: NOT_PREPAID
            reference_id: user-id-1
            version: 1
      x-property-order:
      - errors
      - cards
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /cards-api/protos/squareup/cards/api/cards_store_api.proto
      x-proto-sha: 45981bf2b47428d1befee008c73b5fe7a15439b2
      x-object-name: ListCardsResponse
    RetrieveCardRequest:
      type: object
      properties: {}
      description: |-
        Retrieves details for a specific Card. Accessible via
        HTTP requests at GET https://connect.squareup.com/v2/cards/{card_id}
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /cards-api/protos/squareup/cards/api/cards_store_api.proto
      x-proto-sha: 45981bf2b47428d1befee008c73b5fe7a15439b2
      x-object-name: RetrieveCardRequest
    RetrieveCardResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        card:
          $ref: '#/components/schemas/Card'
      description: |-
        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.
      example:
        card:
          id: ccof:uIbfJXhXETSP197M3GB
          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
          bin: "411111"
          card_brand: VISA
          card_type: CREDIT
          cardholder_name: Amelia Earhart
          customer_id: VDKXEEKPJN48QDG3BGGFAK05P8
          enabled: true
          exp_month: 11
          exp_year: 2022
          last_4: "1111"
          merchant_id: 6SSW7HV8K2ST5
          prepaid_type: NOT_PREPAID
          reference_id: user-id-1
          version: 1
      x-property-order:
      - errors
      - card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /cards-api/protos/squareup/cards/api/cards_store_api.proto
      x-proto-sha: 45981bf2b47428d1befee008c73b5fe7a15439b2
      x-object-name: RetrieveCardResponse
    CashDrawerDevice:
      type: object
      properties:
        id:
          type: string
          description: The device Square-issued ID
        name:
          type: string
          description: The device merchant-specified name.
      x-property-order:
      - id
      - name
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /cashdrawers/cashdrawers-proto/src/main/proto/squareup/cashdrawers/api/v2/connect/models.proto
      x-proto-sha: 06291dbd5e7115613debe29fc712a6c8b9bd195e
      x-object-name: CashDrawerDevice
    CashDrawerShift:
      type: object
      properties:
        id:
          type: string
          description: The shift unique ID.
        state:
          $ref: '#/components/schemas/CashDrawerShiftState'
        opened_at:
          type: string
          description: The time when the shift began, in ISO 8601 format.
        ended_at:
          type: string
          description: The time when the shift ended, in ISO 8601 format.
        closed_at:
          type: string
          description: The time when the shift was closed, in ISO 8601 format.
        employee_ids:
          type: array
          description: |-
            The IDs of all employees that were logged into Square Point of Sale at any
            point while the cash drawer shift was open.
          items:
            type: string
        opening_employee_id:
          type: string
          description: The ID of the employee that started the cash drawer shift.
        ending_employee_id:
          type: string
          description: The ID of the employee that ended the cash drawer shift.
        closing_employee_id:
          type: string
          description: |-
            The ID of the employee that closed the cash drawer shift by auditing
            the cash drawer contents.
        description:
          type: string
          description: The free-form text description of a cash drawer by an employee.
        opened_cash_money:
          $ref: '#/components/schemas/Money'
        cash_payment_money:
          $ref: '#/components/schemas/Money'
        cash_refunds_money:
          $ref: '#/components/schemas/Money'
        cash_paid_in_money:
          $ref: '#/components/schemas/Money'
        cash_paid_out_money:
          $ref: '#/components/schemas/Money'
        expected_cash_money:
          $ref: '#/components/schemas/Money'
        closed_cash_money:
          $ref: '#/components/schemas/Money'
        device:
          $ref: '#/components/schemas/CashDrawerDevice'
      description: |-
        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.
      x-property-order:
      - id
      - state
      - opened_at
      - ended_at
      - closed_at
      - employee_ids
      - opening_employee_id
      - ending_employee_id
      - closing_employee_id
      - description
      - opened_cash_money
      - cash_payment_money
      - cash_refunds_money
      - cash_paid_in_money
      - cash_paid_out_money
      - expected_cash_money
      - closed_cash_money
      - device
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /cashdrawers/cashdrawers-proto/src/main/proto/squareup/cashdrawers/api/v2/connect/models.proto
      x-proto-sha: 06291dbd5e7115613debe29fc712a6c8b9bd195e
      x-object-name: CashDrawerShift
    CashDrawerShiftEvent:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the event.
        employee_id:
          type: string
          description: The ID of the employee that created the event.
        event_type:
          $ref: '#/components/schemas/CashDrawerEventType'
        event_money:
          $ref: '#/components/schemas/Money'
        created_at:
          type: string
          description: The event time in ISO 8601 format.
          readOnly: true
        description:
          type: string
          description: |-
            An optional description of the event, entered by the employee that
            created the event.
      x-property-order:
      - id
      - employee_id
      - event_type
      - event_money
      - created_at
      - description
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /cashdrawers/cashdrawers-proto/src/main/proto/squareup/cashdrawers/api/v2/connect/models.proto
      x-proto-sha: 06291dbd5e7115613debe29fc712a6c8b9bd195e
      x-object-name: CashDrawerShiftEvent
    CashDrawerShiftSummary:
      type: object
      properties:
        id:
          type: string
          description: The shift unique ID.
        state:
          $ref: '#/components/schemas/CashDrawerShiftState'
        opened_at:
          type: string
          description: The shift start time in ISO 8601 format.
        ended_at:
          type: string
          description: The shift end time in ISO 8601 format.
        closed_at:
          type: string
          description: The shift close time in ISO 8601 format.
        description:
          type: string
          description: An employee free-text description of a cash drawer shift.
        opened_cash_money:
          $ref: '#/components/schemas/Money'
        expected_cash_money:
          $ref: '#/components/schemas/Money'
        closed_cash_money:
          $ref: '#/components/schemas/Money'
      description: |-
        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.
      x-property-order:
      - id
      - state
      - opened_at
      - ended_at
      - closed_at
      - description
      - opened_cash_money
      - expected_cash_money
      - closed_cash_money
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /cashdrawers/cashdrawers-proto/src/main/proto/squareup/cashdrawers/api/v2/connect/models.proto
      x-proto-sha: 06291dbd5e7115613debe29fc712a6c8b9bd195e
      x-object-name: CashDrawerShiftSummary
    ListCashDrawerShiftEventsRequest:
      required:
      - location_id
      type: object
      properties:
        location_id:
          minLength: 1
          type: string
          description: The ID of the location to list cash drawer shifts for.
        limit:
          maximum: 1000
          type: integer
          description: |-
            Number of resources to be returned in a page of results (200 by
            default, 1000 max).
        cursor:
          type: string
          description: Opaque cursor for fetching the next page of results.
      example: {}
      x-property-order:
      - location_id
      - limit
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /cashdrawers/cashdrawers-proto/src/main/proto/squareup/cashdrawers/api/v2/connect/service.proto
      x-proto-sha: 06291dbd5e7115613debe29fc712a6c8b9bd195e
      x-object-name: ListCashDrawerShiftEventsRequest
    ListCashDrawerShiftEventsResponse:
      type: object
      properties:
        events:
          type: array
          description: |-
            All of the events (payments, refunds, etc.) for a cash drawer during
            the shift.
          items:
            $ref: '#/components/schemas/CashDrawerShiftEvent'
        cursor:
          type: string
          description: |-
            Opaque cursor for fetching the next page. Cursor is not present in
            the last page of results.
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        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: ""
        - 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: ""
        - 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: ""
        - 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: ""
        - 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
        - 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
      x-property-order:
      - events
      - cursor
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /cashdrawers/cashdrawers-proto/src/main/proto/squareup/cashdrawers/api/v2/connect/service.proto
      x-proto-sha: 06291dbd5e7115613debe29fc712a6c8b9bd195e
      x-object-name: ListCashDrawerShiftEventsResponse
    ListCashDrawerShiftsRequest:
      required:
      - location_id
      type: object
      properties:
        location_id:
          minLength: 1
          type: string
          description: The ID of the location to query for a list of cash drawer shifts.
        sort_order:
          $ref: '#/components/schemas/SortOrder'
        begin_time:
          type: string
          description: The inclusive start time of the query on opened_at, in ISO
            8601 format.
        end_time:
          type: string
          description: The exclusive end date of the query on opened_at, in ISO 8601
            format.
        limit:
          maximum: 1000
          type: integer
          description: |-
            Number of cash drawer shift events in a page of results (200 by
            default, 1000 max).
        cursor:
          type: string
          description: Opaque cursor for fetching the next page of results.
      example: {}
      x-property-order:
      - location_id
      - sort_order
      - begin_time
      - end_time
      - limit
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /cashdrawers/cashdrawers-proto/src/main/proto/squareup/cashdrawers/api/v2/connect/service.proto
      x-proto-sha: 06291dbd5e7115613debe29fc712a6c8b9bd195e
      x-object-name: ListCashDrawerShiftsRequest
    ListCashDrawerShiftsResponse:
      type: object
      properties:
        items:
          type: array
          description: |-
            A collection of CashDrawerShiftSummary objects for shifts that match
            the query.
          items:
            $ref: '#/components/schemas/CashDrawerShiftSummary'
        cursor:
          type: string
          description: |-
            Opaque cursor for fetching the next page of results. Cursor is not
            present in the last page of results.
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        items:
        - 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
      x-property-order:
      - items
      - cursor
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /cashdrawers/cashdrawers-proto/src/main/proto/squareup/cashdrawers/api/v2/connect/service.proto
      x-proto-sha: 06291dbd5e7115613debe29fc712a6c8b9bd195e
      x-object-name: ListCashDrawerShiftsResponse
    RetrieveCashDrawerShiftRequest:
      required:
      - location_id
      type: object
      properties:
        location_id:
          minLength: 1
          type: string
          description: The ID of the location to retrieve cash drawer shifts from.
      example: {}
      x-property-order:
      - location_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /cashdrawers/cashdrawers-proto/src/main/proto/squareup/cashdrawers/api/v2/connect/service.proto
      x-proto-sha: 06291dbd5e7115613debe29fc712a6c8b9bd195e
      x-object-name: RetrieveCashDrawerShiftRequest
    RetrieveCashDrawerShiftResponse:
      type: object
      properties:
        cash_drawer_shift:
          $ref: '#/components/schemas/CashDrawerShift'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        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
          opening_employee_id: ""
          ending_employee_id: ""
          closing_employee_id: ""
          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:
            name: My iPad
      x-property-order:
      - cash_drawer_shift
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /cashdrawers/cashdrawers-proto/src/main/proto/squareup/cashdrawers/api/v2/connect/service.proto
      x-proto-sha: 06291dbd5e7115613debe29fc712a6c8b9bd195e
      x-object-name: RetrieveCashDrawerShiftResponse
    BulkUpsertCustomerCustomAttributesRequest:
      required:
      - values
      type: object
      properties:
        values:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/BulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest'
          description: |-
            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.
          x-is-sparse-update-payload: true
      description: Represents a [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes)
        request.
      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
      x-property-order:
      - values
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: BulkUpsertCustomerCustomAttributesRequest
    BulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest:
      required:
      - custom_attribute
      - customer_id
      type: object
      properties:
        customer_id:
          minLength: 1
          type: string
          description: The ID of the target [customer profile](entity:Customer).
        custom_attribute:
          $ref: '#/components/schemas/CustomAttribute'
        idempotency_key:
          maxLength: 45
          type: string
          description: |-
            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).
      description: |-
        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.
      x-property-order:
      - customer_id
      - custom_attribute
      - idempotency_key
      - fields_to_clear
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: BulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest
    BulkUpsertCustomerCustomAttributesResponse:
      type: object
      properties:
        values:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/BulkUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse'
          description: |-
            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: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Represents a [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) response,
        which contains a map of responses that each corresponds to an individual upsert request.
      example:
        values:
          id2:
            customer_id: SY8EMWRNDN3TQDP2H4KS1QWMMM
            custom_attribute:
              key: ownsmovie
              version: 2
              visibility: VISIBILITY_READ_WRITE_VALUES
              updated_at: 2021-12-09T00:16:23Z
              value: false
              created_at: 2021-12-09T00:16:20Z
          id1:
            customer_id: N3NCVYY3WS27HF0HKANA3R9FP8
            custom_attribute:
              key: favoritemovie
              version: 1
              visibility: VISIBILITY_READ_WRITE_VALUES
              updated_at: 2021-12-09T00:16:23Z
              value: Dune
              created_at: 2021-12-08T23:14:47Z
          id3:
            customer_id: SY8EMWRNDN3TQDP2H4KS1QWMMM
            custom_attribute:
              key: favoritemovie
              version: 2
              visibility: VISIBILITY_READ_WRITE_VALUES
              updated_at: 2021-12-09T00:16:23Z
              value: Star Wars
              created_at: 2021-12-09T00:16:20Z
          id4:
            customer_id: N3NCVYY3WS27HF0HKANA3R9FP8
            custom_attribute:
              key: square:a0f1505a-2aa1-490d-91a8-8d31ff181808
              version: 1
              visibility: VISIBILITY_READ_WRITE_VALUES
              updated_at: 2021-12-09T00:16:23Z
              value: "10.5"
              created_at: 2021-12-08T23:14:47Z
          id5:
            customer_id: 70548QG1HN43B05G0KCZ4MMC1G
            custom_attribute:
              key: sq0ids-0evKIskIGaY45fCyNL66aw:backupemail
              version: 2
              visibility: VISIBILITY_READ_WRITE_VALUES
              updated_at: 2021-12-09T00:16:23Z
              value: fake-email@squareup.com
              created_at: 2021-12-09T00:16:20Z
      x-property-order:
      - values
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: BulkUpsertCustomerCustomAttributesResponse
    BulkUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse:
      type: object
      properties:
        customer_id:
          type: string
          description: The ID of the customer profile associated with the custom attribute.
        custom_attribute:
          $ref: '#/components/schemas/CustomAttribute'
        errors:
          type: array
          description: Any errors that occurred while processing the individual request.
          items:
            $ref: '#/components/schemas/Error'
      description: Represents a response for an individual upsert request in a [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes)
        operation.
      example:
        customer_id: N3NCVYY3WS27HF0HKANA3R9FP8
        custom_attribute:
          key: favoritemovie
          version: 1
          visibility: VISIBILITY_READ_WRITE_VALUES
          updated_at: 2021-12-09T00:16:23Z
          value: Dune
          created_at: 2021-12-08T23:14:47Z
      x-property-order:
      - customer_id
      - custom_attribute
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: BulkUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse
    CreateCustomerCustomAttributeDefinitionRequest:
      required:
      - custom_attribute_definition
      type: object
      properties:
        custom_attribute_definition:
          $ref: '#/components/schemas/CustomAttributeDefinition'
        idempotency_key:
          maxLength: 45
          type: string
          description: |-
            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).
      description: Represents a [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition)
        request.
      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
      x-property-order:
      - custom_attribute_definition
      - idempotency_key
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: CreateCustomerCustomAttributeDefinitionRequest
    CreateCustomerCustomAttributeDefinitionResponse:
      type: object
      properties:
        custom_attribute_definition:
          $ref: '#/components/schemas/CustomAttributeDefinition'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Represents a [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) response.
        Either `custom_attribute_definition` or `errors` is present in the response.
      example:
        custom_attribute_definition:
          key: favoritemovie
          name: Favorite Movie
          description: The favorite movie of the customer.
          version: 1
          updated_at: 2022-04-26T15:27:30Z
          schema:
            $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String
          created_at: 2022-04-26T15:27:30Z
          visibility: VISIBILITY_HIDDEN
      x-property-order:
      - custom_attribute_definition
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: CreateCustomerCustomAttributeDefinitionResponse
    DeleteCustomerCustomAttributeDefinitionRequest:
      type: object
      properties: {}
      description: Represents a [DeleteCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-DeleteCustomerCustomAttributeDefinition)
        request.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: DeleteCustomerCustomAttributeDefinitionRequest
      x-params-example: ?key=favoritemovie
    DeleteCustomerCustomAttributeDefinitionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Represents a response from a delete request containing error messages
        if there are any.
      example: {}
      x-property-order:
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: DeleteCustomerCustomAttributeDefinitionResponse
    DeleteCustomerCustomAttributeRequest:
      type: object
      properties: {}
      description: Represents a [DeleteCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-DeleteCustomerCustomAttribute)
        request.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: DeleteCustomerCustomAttributeRequest
      x-params-example: ?customer_id=Z57QXKM2FGXEQDV42W8RBZY7BR&key=favoritemovie
    DeleteCustomerCustomAttributeResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Represents a [DeleteCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-DeleteCustomerCustomAttribute) response.
        Either an empty object `{}` (for a successful deletion) or `errors` is present in the response.
      example: {}
      x-property-order:
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: DeleteCustomerCustomAttributeResponse
    ListCustomerCustomAttributeDefinitionsRequest:
      type: object
      properties:
        limit:
          maximum: 100
          minimum: 1
          type: integer
          description: |-
            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: string
          description: |-
            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).
      description: Represents a [ListCustomerCustomAttributeDefinitions](api-endpoint:CustomerCustomAttributes-ListCustomerCustomAttributeDefinitions)
        request.
      x-property-order:
      - limit
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: ListCustomerCustomAttributeDefinitionsRequest
      x-params-example: ?limit=2
    ListCustomerCustomAttributeDefinitionsResponse:
      type: object
      properties:
        custom_attribute_definitions:
          type: array
          description: |-
            The retrieved custom attribute definitions. If no custom attribute definitions are found,
            Square returns an empty object (`{}`).
          items:
            $ref: '#/components/schemas/CustomAttributeDefinition'
        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. 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: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        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`.
      example:
        custom_attribute_definitions:
        - key: favoritemovie
          name: Favorite Movie
          description: Update the description as desired.
          version: 3
          updated_at: 2022-04-26T15:39:38Z
          schema:
            $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String
          created_at: 2022-04-26T15:27:30Z
          visibility: VISIBILITY_READ_ONLY
        - key: ownsmovie
          name: Owns Movie
          description: Customer owns movie.
          version: 1
          updated_at: 2022-04-26T15:49:05Z
          schema:
            $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Boolean
          created_at: 2022-04-26T15:49:05Z
          visibility: VISIBILITY_HIDDEN
        cursor: YEk4UPbUEsu8MUV0xouO5hCiFcD9T5ztB6UWEJq5vZnqBFmoBEi0j1j6HWYTFGMRre4p7T5wAQBj3Th1NX3XgBFcQVEVsIxUQ2NsbwjRitfoEZDml9uxxQXepowyRvCuSThHPbJSn7M7wInl3x8XypQF9ahVVQXegJ0CxEKc0SBH
      x-property-order:
      - custom_attribute_definitions
      - cursor
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: ListCustomerCustomAttributeDefinitionsResponse
    ListCustomerCustomAttributesRequest:
      type: object
      properties:
        limit:
          maximum: 100
          minimum: 1
          type: integer
          description: |-
            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: string
          description: |-
            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: boolean
          description: |-
            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`.
      description: Represents a [ListCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-ListCustomerCustomAttributes)
        request.
      x-property-order:
      - limit
      - cursor
      - with_definitions
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: ListCustomerCustomAttributesRequest
      x-params-example: ?customer_id=Z57QXKM2FGXEQDV42W8RBZY7BR
    ListCustomerCustomAttributesResponse:
      type: object
      properties:
        custom_attributes:
          type: array
          description: |-
            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 (`{}`).
          items:
            $ref: '#/components/schemas/CustomAttribute'
        cursor:
          type: string
          description: |-
            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: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        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`.
      example:
        custom_attributes:
        - key: favoritemovie
          version: 1
          updated_at: 2022-04-26T15:50:27Z
          value: Dune
          created_at: 2022-04-26T15:50:27Z
          visibility: VISIBILITY_READ_ONLY
        - key: ownsmovie
          version: 1
          updated_at: 2022-04-26T15:51:53Z
          value: false
          created_at: 2022-04-26T15:51:53Z
          visibility: VISIBILITY_HIDDEN
      x-property-order:
      - custom_attributes
      - cursor
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: ListCustomerCustomAttributesResponse
    RetrieveCustomerCustomAttributeDefinitionRequest:
      type: object
      properties:
        version:
          type: integer
          description: |-
            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.
      description: Represents a [RetrieveCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttributeDefinition)
        request.
      x-property-order:
      - version
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: RetrieveCustomerCustomAttributeDefinitionRequest
      x-params-example: ?key=favoritemovie
    RetrieveCustomerCustomAttributeDefinitionResponse:
      type: object
      properties:
        custom_attribute_definition:
          $ref: '#/components/schemas/CustomAttributeDefinition'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Represents a [RetrieveCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttributeDefinition) response.
        Either `custom_attribute_definition` or `errors` is present in the response.
      example:
        custom_attribute_definition:
          key: favoritemovie
          name: Favorite Movie
          description: The favorite movie of the customer.
          version: 1
          updated_at: 2022-04-26T15:27:30Z
          schema:
            $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String
          created_at: 2022-04-26T15:27:30Z
          visibility: VISIBILITY_READ_WRITE_VALUES
      x-property-order:
      - custom_attribute_definition
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: RetrieveCustomerCustomAttributeDefinitionResponse
    RetrieveCustomerCustomAttributeRequest:
      type: object
      properties:
        with_definition:
          type: boolean
          description: |-
            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: integer
          description: |-
            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.
      description: Represents a [RetrieveCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttribute)
        request.
      x-property-order:
      - with_definition
      - version
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: RetrieveCustomerCustomAttributeRequest
      x-params-example: ?customer_id=Z57QXKM2FGXEQDV42W8RBZY7BR&key=favoritemovie
    RetrieveCustomerCustomAttributeResponse:
      type: object
      properties:
        custom_attribute:
          $ref: '#/components/schemas/CustomAttribute'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Represents a [RetrieveCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-RetrieveCustomerCustomAttribute) response.
        Either `custom_attribute_definition` or `errors` is present in the response.
      example:
        custom_attribute:
          key: favoritemovie
          version: 1
          updated_at: 2022-04-26T15:50:27Z
          value: Dune
          created_at: 2022-04-26T15:50:27Z
          visibility: VISIBILITY_READ_ONLY
      x-property-order:
      - custom_attribute
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: RetrieveCustomerCustomAttributeResponse
    UpdateCustomerCustomAttributeDefinitionRequest:
      required:
      - custom_attribute_definition
      type: object
      properties:
        custom_attribute_definition:
          $ref: '#/components/schemas/CustomAttributeDefinition'
        idempotency_key:
          maxLength: 45
          type: string
          description: |-
            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).
      description: Represents an [UpdateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-UpdateCustomerCustomAttributeDefinition)
        request.
      example:
        custom_attribute_definition:
          visibility: VISIBILITY_READ_ONLY
          description: Update the description as desired.
      x-property-order:
      - custom_attribute_definition
      - idempotency_key
      - fields_to_clear
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: UpdateCustomerCustomAttributeDefinitionRequest
      x-params-example: ?key=favoritemovie
    UpdateCustomerCustomAttributeDefinitionResponse:
      type: object
      properties:
        custom_attribute_definition:
          $ref: '#/components/schemas/CustomAttributeDefinition'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Represents an [UpdateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-UpdateCustomerCustomAttributeDefinition) response.
        Either `custom_attribute_definition` or `errors` is present in the response.
      example:
        custom_attribute_definition:
          key: favoritemovie
          name: Favorite Movie
          description: Update the description as desired.
          version: 2
          updated_at: 2022-04-26T15:39:38Z
          schema:
            $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String
          created_at: 2022-04-26T15:27:30Z
          visibility: VISIBILITY_READ_ONLY
      x-property-order:
      - custom_attribute_definition
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: UpdateCustomerCustomAttributeDefinitionResponse
    UpsertCustomerCustomAttributeRequest:
      required:
      - custom_attribute
      type: object
      properties:
        custom_attribute:
          $ref: '#/components/schemas/CustomAttribute'
        idempotency_key:
          maxLength: 45
          type: string
          description: |-
            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).
      description: Represents an [UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute)
        request.
      example:
        custom_attribute:
          value: Dune
      x-property-order:
      - custom_attribute
      - idempotency_key
      - fields_to_clear
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: UpsertCustomerCustomAttributeRequest
      x-params-example: ?customer_id=Z57QXKM2FGXEQDV42W8RBZY7BR&key=favoritemovie
    UpsertCustomerCustomAttributeResponse:
      type: object
      properties:
        custom_attribute:
          $ref: '#/components/schemas/CustomAttribute'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Represents an [UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) response.
        Either `custom_attribute_definition` or `errors` is present in the response.
      example:
        custom_attribute:
          key: favoritemovie
          version: 1
          updated_at: 2022-04-26T15:50:27Z
          value: Dune
          created_at: 2022-04-26T15:50:27Z
          visibility: VISIBILITY_READ_ONLY
      x-property-order:
      - custom_attribute
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /connectcustomers/connectcustomers-proto/src/main/proto/squareup/connectcustomers/requests/custom_attributes.proto
      x-proto-sha: 79199e987d3b1a8dfdc136268703d85fdba0b505
      x-object-name: UpsertCustomerCustomAttributeResponse
    V1InventoryUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the target merchant associated with the event.
        event_type:
          type: string
          description: The type of event this represents, i.e. `INVENTORY_UPDATED`.
        entity_id:
          type: string
          description: The ID of the V1 Item whose inventory was updated.
      description: Published when the inventory quantity for a catalog item is updated.
      example:
        merchant_id: 18YC4JBH91E1H
        location_id: JGHJ0343
        event_type: INVENTORY_UPDATED
        entity_id: Jq74mCczmFXk1tC10GB
      x-property-order:
      - merchant_id
      - location_id
      - event_type
      - entity_id
      x-release-status: RETIRED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/inventory/v1-inventory-updated-webhook.proto
      x-proto-sha: a67ca34456c709110577d62f998cbabba55c83f4
      x-object-name: V1InventoryUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: INVENTORY_UPDATED
        scopes:
        - ITEMS_READ
      x-api: '#/components/x-apis/Inventory'
    V1PaymentUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the target merchant associated with the event.
        event_type:
          type: string
          description: The type of event this represents, i.e. `PAYMENT_UPDATED`.
        entity_id:
          type: string
          description: The ID of the updated V1 Payment.
      description: |-
        Published when a charge is made or refunded through the Square
        Point of Sale app or the Transactions API.
      example:
        merchant_id: 18YC4JBH91E1H
        location_id: JGHJ0343
        event_type: PAYMENT_UPDATED
        entity_id: Jq74mCczmFXk1tC10GB
      x-property-order:
      - merchant_id
      - location_id
      - event_type
      - entity_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/payments/v1-payment-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: V1PaymentUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: PAYMENT_UPDATED
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Payments'
    V1TimecardUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the target merchant associated with the event.
        event_type:
          type: string
          description: The type of event this represents, i.e. `TIMECARD_UPDATED`.
        entity_id:
          type: string
          description: The ID of the updated V1 Timecard.
      description: |-
        Published when a timecard is created in the Seller Dashboard
        or an employee clocks in using the Square Point of Sale app.
      example:
        merchant_id: 18YC4JBH91E1H
        location_id: JGHJ0343
        event_type: TIMECARD_UPDATED
        entity_id: Jq74mCczmFXk1tC10GB
      x-property-order:
      - merchant_id
      - location_id
      - event_type
      - entity_id
      x-release-status: RETIRED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/labor/v1-timecard-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: V1TimecardUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: TIMECARD_UPDATED
        scopes:
        - TIMECARDS_READ
      x-api: '#/components/x-apis/Labor'
    ACHDetails:
      type: object
      properties:
        routing_number:
          maxLength: 50
          type: string
          description: The routing number for the bank account.
        account_number_suffix:
          maxLength: 4
          minLength: 1
          type: string
          description: The last few digits of the bank account number.
        account_type:
          maxLength: 50
          type: string
          description: |-
            The type of the bank account performing the transfer. The account type can be `CHECKING`,
            `SAVINGS`, or `UNKNOWN`.
      description: ACH-specific details about `BANK_ACCOUNT` type payments with the
        `transfer_type` of `ACH`.
      x-property-order:
      - routing_number
      - account_number_suffix
      - account_type
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_model.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: ACHDetails
    AcceptDisputeRequest:
      type: object
      properties: {}
      description: Defines the request parameters for the `AcceptDispute` endpoint.
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: AcceptDisputeRequest
    AcceptDisputeResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        dispute:
          $ref: '#/components/schemas/Dispute'
      description: Defines the fields in an `AcceptDispute` response.
      example:
        dispute:
          amount_money:
            amount: 2500
            currency: USD
          reason: NO_KNOWLEDGE
          state: ACCEPTED
          due_at: 2022-07-13T00:00:00.000Z
          disputed_payment:
            payment_id: zhyh1ch64kRBrrlfVhwjCEjZWzNZY
          card_brand: VISA
          created_at: 2022-06-29T18:45:22.265Z
          updated_at: 2022-07-07T19:14:42.650Z
          brand_dispute_id: "100000809947"
          version: 2
          location_id: L1HN3ZMQK64X9
          id: XDgyFu7yo1E2S5lQGGpYn
          reported_at: 2022-06-29T00:00:00.000Z
      x-property-order:
      - errors
      - dispute
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: AcceptDisputeResponse
    AfterpayDetails:
      type: object
      properties:
        email_address:
          maxLength: 255
          type: string
          description: Email address on the buyer's Afterpay account.
      description: Additional details about Afterpay payments.
      x-property-order:
      - email_address
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_model.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: AfterpayDetails
    ApplicationDetails:
      type: object
      properties:
        square_product:
          $ref: '#/components/schemas/ApplicationDetailsExternalSquareProduct'
        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."
      description: Details about the application that took the payment.
      x-property-order:
      - square_product
      - application_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_model.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: ApplicationDetails
    BankAccount:
      required:
      - account_number_suffix
      - account_type
      - country
      - creditable
      - currency
      - debitable
      - holder_name
      - id
      - primary_bank_identification_number
      - status
      type: object
      properties:
        id:
          maxLength: 30
          minLength: 1
          type: string
          description: The unique, Square-issued identifier for the bank account.
          x-namespace: marketplaces
        account_number_suffix:
          minLength: 1
          type: string
          description: The last few digits of the account number.
          x-namespace: marketplaces
        country:
          $ref: '#/components/schemas/Country'
        currency:
          $ref: '#/components/schemas/Currency'
        account_type:
          $ref: '#/components/schemas/BankAccountType'
        holder_name:
          minLength: 1
          type: string
          description: "Name of the account holder. This name must match the name\
            \ \non the targeted bank account record."
          x-namespace: marketplaces
        primary_bank_identification_number:
          maxLength: 40
          type: string
          description: "Primary identifier for the bank. For more information, see\
            \ \n[Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api)."
          x-namespace: marketplaces
        secondary_bank_identification_number:
          maxLength: 40
          type: string
          description: "Secondary identifier for the bank. For more information, see\
            \ \n[Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api)."
          x-namespace: marketplaces
        debit_mandate_reference_id:
          type: string
          description: |-
            Reference identifier that will be displayed to UK bank account owners
            when collecting direct debit authorization. Only required for UK bank accounts.
          x-namespace: marketplaces
        reference_id:
          type: string
          description: |-
            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).
          x-namespace: marketplaces
        location_id:
          type: string
          description: The location to which the bank account belongs.
          x-namespace: marketplaces
        status:
          $ref: '#/components/schemas/BankAccountStatus'
        creditable:
          type: boolean
          description: Indicates whether it is possible for Square to send money to
            this bank account.
          x-namespace: marketplaces
        debitable:
          type: boolean
          description: "Indicates whether it is possible for Square to take money\
            \ from this \nbank account."
          x-namespace: marketplaces
        fingerprint:
          type: string
          description: |-
            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.
          x-namespace: marketplaces
        version:
          type: integer
          description: The current version of the `BankAccount`.
          x-namespace: marketplaces
        bank_name:
          maxLength: 100
          type: string
          description: "Read only. Name of actual financial institution. \nFor example\
            \ \"Bank of America\"."
          x-namespace: marketplaces
      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-property-order:
      - id
      - account_number_suffix
      - country
      - currency
      - account_type
      - holder_name
      - primary_bank_identification_number
      - secondary_bank_identification_number
      - debit_mandate_reference_id
      - reference_id
      - metadata
      - location_id
      - status
      - creditable
      - debitable
      - fingerprint
      - version
      - bank_name
      - created_at
      - updated_at
      - purpose
      - customer_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/bank_accounts.proto
      x-proto-sha: dc1003a64eea24f147d72da44df7237577699575
      x-object-name: BankAccount
      x-namespace: marketplaces
    BankAccountPaymentDetails:
      type: object
      properties:
        bank_name:
          maxLength: 100
          type: string
          description: The name of the bank associated with the bank account.
        transfer_type:
          maxLength: 50
          type: string
          description: The type of the bank transfer. The type can be `ACH` or `UNKNOWN`.
        account_ownership_type:
          maxLength: 50
          type: string
          description: |-
            The ownership type of the bank account performing the transfer.
            The type can be `INDIVIDUAL`, `COMPANY`, or `UNKNOWN`.
        fingerprint:
          maxLength: 255
          type: string
          description: |-
            Uniquely identifies the bank account for this seller and can be used
            to determine if payments are from the same bank account.
        country:
          maxLength: 2
          minLength: 2
          type: string
          description: The two-letter ISO code representing the country the bank account
            is located in.
        statement_description:
          maxLength: 1000
          type: string
          description: The statement description as sent to the bank.
        ach_details:
          $ref: '#/components/schemas/ACHDetails'
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Additional details about BANK_ACCOUNT type payments.
      x-property-order:
      - bank_name
      - transfer_type
      - account_ownership_type
      - fingerprint
      - country
      - statement_description
      - ach_details
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_model.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: BankAccountPaymentDetails
    BatchRequest:
      required:
      - access_token
      - method
      - relative_path
      type: object
      properties:
        method:
          $ref: '#/components/schemas/BatchRequestHttpMethod'
        relative_path:
          type: string
          description: Endpoint path for the API call.
        access_token:
          type: string
          description: |-
            [Square access token](https://developer.squareup.com/docs/build-basics/access-tokens) for the API
            call.
        body:
          type: object
          additionalProperties:
            type: string
          description: Request body for the API call. Only used for API calls using
            POST.
        request_id:
          type: string
          description: Client-provided value to identify the request.
      description: |-
        Represents a batched request included in a call to the __SubmitBatch__
        endpoint.
      deprecated: true
      x-property-order:
      - method
      - relative_path
      - access_token
      - body
      - request_id
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1batch.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: BatchRequest
      x-visibility: DOC_ONLY
    BatchResponse:
      type: object
      properties:
        status_code:
          type: integer
          description: HTTP status code for the response
        body:
          type: object
          additionalProperties:
            type: string
          description: The body of the response (if any).
        headers:
          type: object
          additionalProperties:
            type: string
          description: |-
            Contains any important headers for the response, indexed by header
            name. For example, if the response includes a pagination header, the header
            value is available from `headers["Link"]`.
        request_id:
          type: string
          description: |-
            The value provided in a request for `request_id` in the corresponding
            `BatchRequest` (if any).
      description: |-
        Represents an individual response for a batched request to the
        __SubmitBatch__ endpoint.
      example:
        headers:
          key: headers
        status_code: 0
        body:
          key: body
        request_id: request_id
      deprecated: true
      x-property-order:
      - status_code
      - body
      - headers
      - request_id
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1batch.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: BatchResponse
      x-visibility: DOC_ONLY
    BuyNowPayLaterDetails:
      type: object
      properties:
        brand:
          maxLength: 50
          type: string
          description: |-
            The brand used for the Buy Now Pay Later payment.
            The brand can be `AFTERPAY`, `CLEARPAY` or `UNKNOWN`.
        afterpay_details:
          $ref: '#/components/schemas/AfterpayDetails'
        clearpay_details:
          $ref: '#/components/schemas/ClearpayDetails'
      description: Additional details about a Buy Now Pay Later payment type.
      x-property-order:
      - brand
      - afterpay_details
      - clearpay_details
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_model.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: BuyNowPayLaterDetails
    CancelPaymentByIdempotencyKeyRequest:
      required:
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          maxLength: 45
          minLength: 1
          type: string
          description: The `idempotency_key` identifying the payment to be canceled.
      description: "Describes a request to cancel a payment using \n[CancelPaymentByIdempotencyKey](api-endpoint:Payments-CancelPaymentByIdempotencyKey)."
      example:
        idempotency_key: a7e36d40-d24b-11e8-b568-0800200c9a66
      x-property-order:
      - idempotency_key
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: CancelPaymentByIdempotencyKeyRequest
    CancelPaymentByIdempotencyKeyResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: "Defines the response returned by \n[CancelPaymentByIdempotencyKey](api-endpoint:Payments-CancelPaymentByIdempotencyKey).\n\
        On success, `errors` is empty."
      example: {}
      x-property-order:
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: CancelPaymentByIdempotencyKeyResponse
    CancelPaymentRequest:
      type: object
      properties: {}
      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)."
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: CancelPaymentRequest
    CancelPaymentResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        payment:
          $ref: '#/components/schemas/Payment'
      description: Defines the response returned by [CancelPayment](api-endpoint:Payments-CancelPayment).
      example:
        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
          status: CANCELED
          delay_duration: PT168H
          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
            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
          location_id: L88917AVBK2S5
          order_id: nUSN9TdxpiK3SrQg3wzmf6r8LP9YY
          risk_evaluation:
            created_at: 2021-10-13T20:26:45.271Z
            risk_level: NORMAL
          note: Example Note
          customer_id: W92WH6P11H4Z77CTET0RNTGFW8
          total_money:
            amount: 1100
            currency: USD
          approved_money:
            amount: 1000
            currency: USD
          delay_action: CANCEL
          delayed_until: 2021-10-20T20:26:44.191Z
          application_details:
            square_product: ECOMMERCE_API
            application_id: sq0ids-TcgftTEtKxJTRF1lCFJ9TA
          version_token: N8AGYgEjCiY9Q57Jw7aVHEpBq8bzGCDCQMRX8Vs56N06o
      x-property-order:
      - errors
      - payment
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: CancelPaymentResponse
    CancelSubscriptionRequest:
      type: object
      properties: {}
      description: "Defines input parameters in a request to the \n[CancelSubscription](api-endpoint:Subscriptions-CancelSubscription)\
        \ endpoint."
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: CancelSubscriptionRequest
    CancelSubscriptionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        subscription:
          $ref: '#/components/schemas/Subscription'
        actions:
          type: array
          description: A list of a single `CANCEL` action scheduled for the subscription.
          items:
            $ref: '#/components/schemas/SubscriptionAction'
          x-release-status: BETA
      description: "Defines output parameters in a response from the \n[CancelSubscription](api-endpoint:Subscriptions-CancelSubscription)\
        \ endpoint."
      example:
        subscription:
          id: 910afd30-464a-4e00-a8d8-2296eEXAMPLE
          location_id: S8GWD5R9QB376
          plan_id: 6JHXF3B2CW3YKHDV4XEM674H
          customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G
          card_id: ccof:qy5x8hHGYsgLrp4Q4GB
          start_date: 2021-10-20
          canceled_date: 2021-10-20
          paid_until_date: 2021-11-20
          status: ACTIVE
          created_at: 2021-10-20T21:53:10Z
          version: 1594311617331
          timezone: America/Los_Angeles
          source:
            name: My App
      x-property-order:
      - errors
      - subscription
      - actions
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: CancelSubscriptionResponse
    CancelTerminalActionRequest:
      type: object
      properties: {}
      example: {}
      x-property-order:
      - cancel_reason
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_actions.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: CancelTerminalActionRequest
    CancelTerminalActionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        action:
          $ref: '#/components/schemas/TerminalAction'
      example:
        action:
          id: termapia:jveJIAkkAjILHkdCE
          device_id: DEVICE_ID
          deadline_duration: PT5M
          created_at: 2021-07-28T23:22:07.476Z
          updated_at: 2021-07-28T23:22:29.511Z
          status: CANCELED
          cancel_reason: SELLER_CANCELED
          location_id: LOCATION_ID
          type: SAVE_CARD
          app_id: APP_ID
          save_card_options:
            customer_id: CUSTOMER_ID
            reference_id: user-id-1
      x-property-order:
      - errors
      - action
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_actions.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: CancelTerminalActionResponse
    CancelTerminalCheckoutRequest:
      type: object
      properties: {}
      example: {}
      x-property-order:
      - cancel_reason
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkouts.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: CancelTerminalCheckoutRequest
    CancelTerminalCheckoutResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        checkout:
          $ref: '#/components/schemas/TerminalCheckout'
      example:
        checkout:
          id: S1yDlPQx7slqO
          amount_money:
            amount: 123
            currency: USD
          reference_id: id36815
          device_options:
            device_id: dbb5d83a-7838-11ea-bc55-0242ac130003
            tip_settings:
              allow_tipping: true
            skip_receipt_screen: true
          status: CANCELED
          cancel_reason: SELLER_CANCELED
          created_at: 2020-03-16T15:31:19.934Z
          updated_at: 2020-03-16T15:31:45.787Z
          app_id: APP_ID
          deadline_duration: PT10M
      x-property-order:
      - errors
      - checkout
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkouts.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: CancelTerminalCheckoutResponse
    CancelTerminalRefundRequest:
      type: object
      properties: {}
      example: {}
      x-property-order:
      - cancel_reason
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_refunds.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: CancelTerminalRefundRequest
    CancelTerminalRefundResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        refund:
          $ref: '#/components/schemas/TerminalRefund'
      example:
        refund:
          id: g6ycb6HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY
          payment_id: 5O5OvgkcNUhl7JBuINflcjKqUzXZY
          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
          card:
            card_brand: INTERAC
            last_4: "1111"
            exp_month: 1
            exp_year: 2022
            fingerprint: sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw
            card_type: CREDIT
            bin: "411111"
          order_id: kcuKDKreRaI4gF4TjmEgZjHk8Z7YY
          location_id: 76C9W6K8CNNQ5
      x-property-order:
      - errors
      - refund
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_refunds.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: CancelTerminalRefundResponse
    CardPaymentDetails:
      type: object
      properties:
        status:
          maxLength: 50
          type: string
          description: |-
            The card payment's current state. The state can be AUTHORIZED, CAPTURED, VOIDED, or
            FAILED.
        card:
          $ref: '#/components/schemas/Card'
        entry_method:
          maxLength: 50
          type: string
          description: |-
            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:
          maxLength: 50
          type: string
          description: |-
            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:
          maxLength: 50
          type: string
          description: |-
            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:
          maxLength: 10
          type: string
          description: |-
            The status code returned by the card issuer that describes the payment's
            authorization status.
        application_identifier:
          maxLength: 32
          type: string
          description: For EMV payments, the application ID identifies the EMV application
            used for the payment.
        application_name:
          maxLength: 16
          type: string
          description: For EMV payments, the human-readable name of the EMV application
            used for the payment.
        application_cryptogram:
          maxLength: 16
          type: string
          description: For EMV payments, the cryptogram generated for the payment.
        verification_method:
          maxLength: 50
          type: string
          description: |-
            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:
          maxLength: 50
          type: string
          description: |-
            For EMV payments, the results of the cardholder verification. The result can be
            `SUCCESS`, `FAILURE`, or `UNKNOWN`.
        statement_description:
          maxLength: 50
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/DeviceDetails'
        card_payment_timeline:
          $ref: '#/components/schemas/CardPaymentTimeline'
        refund_requires_card_presence:
          type: boolean
          description: |-
            Whether the card must be physically present for the payment to
            be refunded.  If set to `true`, the card must be present.
          x-release-status: BETA
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Reflects the current status of a card payment. Contains only non-confidential
        information.
      x-property-order:
      - status
      - card
      - entry_method
      - cvv_status
      - avs_status
      - auth_result_code
      - application_identifier
      - application_name
      - application_cryptogram
      - verification_method
      - verification_results
      - statement_description
      - device_details
      - pan_fidelius_token
      - card_payment_timeline
      - refund_requires_card_presence
      - account_type
      - signature_behavior
      - application_transaction_counter
      - remaining_balance_amount_money
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_model.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: CardPaymentDetails
    CardPaymentTimeline:
      type: object
      properties:
        authorized_at:
          type: string
          description: The timestamp when the payment was authorized, in RFC 3339
            format.
        captured_at:
          type: string
          description: The timestamp when the payment was captured, in RFC 3339 format.
        voided_at:
          type: string
          description: The timestamp when the payment was voided, in RFC 3339 format.
      description: The timeline for card payments.
      x-property-order:
      - authorized_at
      - captured_at
      - voided_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_model.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: CardPaymentTimeline
    CashAppDetails:
      type: object
      properties:
        buyer_full_name:
          maxLength: 255
          type: string
          description: The name of the Cash App account holder.
        buyer_country_code:
          maxLength: 2
          minLength: 2
          type: string
          description: |-
            The country of the Cash App account holder, in ISO 3166-1-alpha-2 format.

            For possible values, see [Country](entity:Country).
        buyer_cashtag:
          maxLength: 21
          minLength: 1
          type: string
          description: $Cashtag of the Cash App account holder.
          readOnly: true
      description: Additional details about `WALLET` type payments with the `brand`
        of `CASH_APP`.
      x-property-order:
      - buyer_full_name
      - buyer_country_code
      - buyer_cashtag
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_model.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: CashAppDetails
    CashPaymentDetails:
      required:
      - buyer_supplied_money
      type: object
      properties:
        buyer_supplied_money:
          $ref: '#/components/schemas/Money'
        change_back_money:
          $ref: '#/components/schemas/Money'
      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-property-order:
      - buyer_supplied_money
      - change_back_money
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_model.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: CashPaymentDetails
    ClearpayDetails:
      type: object
      properties:
        email_address:
          maxLength: 255
          type: string
          description: Email address on the buyer's Clearpay account.
      description: Additional details about Clearpay payments.
      x-property-order:
      - email_address
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_model.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: ClearpayDetails
    CompletePaymentRequest:
      type: object
      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
      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`."
      example: {}
      x-property-order:
      - encrypted_emv_data
      - version_token
      - is_offline_request
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: CompletePaymentRequest
    CompletePaymentResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        payment:
          $ref: '#/components/schemas/Payment'
      description: Defines the response returned by[CompletePayment](api-endpoint:Payments-CompletePayment).
      example:
        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
          status: COMPLETED
          delay_duration: PT168H
          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
          location_id: L88917AVBK2S5
          order_id: d7eKah653Z579f3gVtjlxpSlmUcZY
          processing_fee:
          - effective_at: 2021-10-13T21:34:35.000Z
            type: INITIAL
            amount_money:
              amount: 34
              currency: USD
          note: Test Note
          total_money:
            amount: 555
            currency: USD
          approved_money:
            amount: 555
            currency: USD
          employee_id: TMoK_ogh6rH1o4dV
          receipt_number: bP9m
          receipt_url: https://squareup.com/receipt/preview/bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY
          delay_action: CANCEL
          delayed_until: 2021-10-20T19:34:33.524Z
          team_member_id: TMoK_ogh6rH1o4dV
          application_details:
            square_product: VIRTUAL_TERMINAL
            application_id: sq0ids-Pw67AZAlLVB7hsRmwlJPuA
          version_token: 56pRkL3slrzet2iQrTp9n0bdJVYTB9YEWdTNjQfZOPV6o
      x-property-order:
      - errors
      - payment
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: CompletePaymentResponse
    CreateDisputeEvidenceFileRequest:
      required:
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          maxLength: 45
          minLength: 1
          type: string
          description: A unique key identifying the request. For more information,
            see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
        evidence_type:
          $ref: '#/components/schemas/DisputeEvidenceType'
        content_type:
          maxLength: 40
          minLength: 1
          type: string
          description: |-
            The MIME type of the uploaded file.
            The type can be image/heic, image/heif, image/jpeg, application/pdf, image/png, or image/tiff.
      description: Defines the parameters for a `CreateDisputeEvidenceFile` request.
      x-property-order:
      - idempotency_key
      - evidence_type
      - content_type
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_evidence.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: CreateDisputeEvidenceFileRequest
    CreateDisputeEvidenceFileResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        evidence:
          $ref: '#/components/schemas/DisputeEvidence'
      description: Defines the fields in a `CreateDisputeEvidenceFile` response.
      example:
        evidence:
          dispute_id: bVTprrwk0gygTLZ96VX1oB
          evidence_file:
            filename: customer-interaction.jpg
            filetype: image/jpeg
          uploaded_at: 2022-05-18T16:01:10.000Z
          id: TOomLInj6iWmP3N8qfCXrB
      x-property-order:
      - errors
      - evidence
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_evidence.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: CreateDisputeEvidenceFileResponse
    CreateDisputeEvidenceTextRequest:
      required:
      - evidence_text
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          maxLength: 45
          minLength: 1
          type: string
          description: A unique key identifying the request. For more information,
            see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
        evidence_type:
          $ref: '#/components/schemas/DisputeEvidenceType'
        evidence_text:
          maxLength: 500
          minLength: 1
          type: string
          description: The evidence string.
      description: Defines the parameters for a `CreateDisputeEvidenceText` request.
      example:
        evidence_type: TRACKING_NUMBER
        evidence_text: 1Z8888888888888888
        idempotency_key: ed3ee3933d946f1514d505d173c82648
      x-property-order:
      - idempotency_key
      - evidence_type
      - evidence_text
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_evidence.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: CreateDisputeEvidenceTextRequest
    CreateDisputeEvidenceTextResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        evidence:
          $ref: '#/components/schemas/DisputeEvidence'
      description: Defines the fields in a `CreateDisputeEvidenceText` response.
      example:
        evidence:
          dispute_id: bVTprrwk0gygTLZ96VX1oB
          uploaded_at: 2022-05-18T16:01:10.000Z
          evidence_type: REBUTTAL_EXPLANATION
          evidence_text: The customer purchased the item twice, on April 11 and April
            28.
          id: TOomLInj6iWmP3N8qfCXrB
      x-property-order:
      - errors
      - evidence
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_evidence.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: CreateDisputeEvidenceTextResponse
    CreatePaymentRequest:
      required:
      - amount_money
      - idempotency_key
      - source_id
      type: object
      properties:
        source_id:
          minLength: 1
          type: string
          description: "The ID for the source of funds for this payment. This can\
            \ be a payment token \n(card nonce) generated by the Square payment form\
            \ or a card on file made with the \nCustomers API. If recording a payment\
            \ that the seller \nreceived outside of Square, specify either \"CASH\"\
            \ or \"EXTERNAL\". \nFor more information, see \n[Take Payments](https://developer.squareup.com/docs/payments-api/take-payments)."
        idempotency_key:
          maxLength: 45
          minLength: 1
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Money'
        tip_money:
          $ref: '#/components/schemas/Money'
        app_fee_money:
          $ref: '#/components/schemas/Money'
        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
            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: 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.

            This is required if the `source_id` refers to a card on file created using the Customers API.
        location_id:
          type: string
          description: |-
            The location ID to associate with the payment. If not specified, the default location is
            used.
        team_member_id:
          type: string
          description: "An optional [TeamMember](entity:TeamMember) ID to associate\
            \ with \nthis payment."
        reference_id:
          maxLength: 40
          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)."
        verification_token:
          type: string
          description: |-
            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: boolean
          description: |-
            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:
          maxLength: 255
          type: string
          description: The buyer's email address.
        billing_address:
          $ref: '#/components/schemas/Address'
        shipping_address:
          $ref: '#/components/schemas/Address'
        note:
          maxLength: 500
          type: string
          description: An optional note to be entered by the developer when creating
            a payment.
        statement_description_identifier:
          maxLength: 20
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/CashPaymentDetails'
        external_details:
          $ref: '#/components/schemas/ExternalPaymentDetails'
      description: "Describes a request to create a payment using \n[CreatePayment](api-endpoint:Payments-CreatePayment)."
      example:
        idempotency_key: 7b0f3ec5-086a-4871-8f13-3c81b3875218
        amount_money:
          amount: 1000
          currency: USD
        source_id: ccof:GaJGNaZa8x4OgDJn4GB
        autocomplete: true
        customer_id: W92WH6P11H4Z77CTET0RNTGFW8
        location_id: L88917AVBK2S5
        reference_id: "123456"
        note: Brief description
        app_fee_money:
          amount: 10
          currency: USD
      x-property-order:
      - source_id
      - card_present_options
      - idempotency_key
      - amount_money
      - tip_money
      - tax_money
      - app_fee_money
      - app_fee_location_id
      - payment_fees_spec
      - delay_duration
      - delay_action
      - autocomplete
      - create_order
      - order_id
      - customer_id
      - payment_config_id
      - location_id
      - employee_id
      - team_member_id
      - reference_id
      - verification_token
      - terminal_checkout_id
      - accept_partial_authorization
      - buyer_email_address
      - billing_address
      - shipping_address
      - note
      - statement_description_identifier
      - requested_statement_description
      - revenue_association_tags
      - application_id_attribution
      - geo_location
      - auxiliary_info
      - cash_details
      - external_details
      - payin_details
      - billpay_details
      - billpay_pull_details
      - device_details
      - square_product
      - fee_plan_product
      - refund_policy
      - peripheral_metadata
      - customer_details
      - recurring_details
      - request_context_token
      - is_offline_request
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: CreatePaymentRequest
    CreatePaymentResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        payment:
          $ref: '#/components/schemas/Payment'
      description: |-
        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`.
      example:
        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
          app_fee_money:
            amount: 10
            currency: USD
          status: COMPLETED
          delay_duration: PT168H
          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
            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
          location_id: L88917AVBK2S5
          order_id: pRsjRTgFWATl7so6DxdKBJa7ssbZY
          reference_id: "123456"
          risk_evaluation:
            created_at: 2021-10-13T21:14:30.423Z
            risk_level: NORMAL
          note: Brief Description
          customer_id: W92WH6P11H4Z77CTET0RNTGFW8
          total_money:
            amount: 1000
            currency: USD
          approved_money:
            amount: 1000
            currency: USD
          receipt_number: R2B3
          receipt_url: https://squareup.com/receipt/preview/EXAMPLE_RECEIPT_ID
          delay_action: CANCEL
          delayed_until: 2021-10-20T21:14:29.577Z
          application_details:
            square_product: ECOMMERCE_API
            application_id: sq0ids-TcgftTEtKxJTRF1lCFJ9TA
          version_token: TPtNEOBOa6Qq6E3C3IjckSVOM6b3hMbfhjvTxHBQUsB6o
      x-property-order:
      - errors
      - payment
      - encrypted_emv_data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: CreatePaymentResponse
    CreateSubscriptionRequest:
      required:
      - customer_id
      - location_id
      - plan_id
      type: object
      properties:
        idempotency_key:
          type: string
          description: |-
            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/working-with-apis/idempotency).
        location_id:
          minLength: 1
          type: string
          description: The ID of the location the subscription is associated with.
        plan_id:
          minLength: 1
          type: string
          description: "The ID of the subscription plan created using the Catalog\
            \ API.\nFor more information, see\n[Set Up and Manage a Subscription Plan](https://developer.squareup.com/docs/subscriptions-api/setup-plan)\
            \ and \n[Subscriptions Walkthrough](https://developer.squareup.com/docs/subscriptions-api/walkthrough)."
        customer_id:
          minLength: 1
          type: string
          description: The ID of the [customer](entity:Customer) subscribing to the
            subscription plan.
        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 configuration.\nIf the cancellation date is earlier\
            \ than the end date of a subscription cycle, the subscription stops\n\
            at 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:
          maxLength: 10
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Money'
        card_id:
          type: string
          description: |-
            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. For an example to
            create a customer profile for a subscriber and add a card on file, see [Subscriptions Walkthrough](https://developer.squareup.com/docs/subscriptions-api/walkthrough).
        timezone:
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/SubscriptionSource'
      description: "Defines input parameters in a request to the \n[CreateSubscription](api-endpoint:Subscriptions-CreateSubscription)\
        \ endpoint."
      example:
        idempotency_key: 8193148c-9586-11e6-99f9-28cfe92138cf
        location_id: S8GWD5R9QB376
        plan_id: 6JHXF3B2CW3YKHDV4XEM674H
        customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G
        card_id: ccof:qy5x8hHGYsgLrp4Q4GB
        start_date: 2021-10-20
        tax_percentage: "5"
        price_override_money:
          amount: 100
          currency: USD
        timezone: America/Los_Angeles
        source:
          name: My App
      x-property-order:
      - idempotency_key
      - location_id
      - plan_id
      - customer_id
      - start_date
      - canceled_date
      - tax_percentage
      - price_override_money
      - card_id
      - show_buyer_self_management_token
      - timezone
      - order_template_id
      - note
      - bank_account_id
      - source
      - billing_cycle_date
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: CreateSubscriptionRequest
    CreateSubscriptionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        subscription:
          $ref: '#/components/schemas/Subscription'
      description: |-
        Defines output parameters in a response from the
        [CreateSubscription](api-endpoint:Subscriptions-CreateSubscription) endpoint.
      example:
        subscription:
          id: 56214fb2-cc85-47a1-93bc-44f3766bb56f
          location_id: S8GWD5R9QB376
          plan_id: 6JHXF3B2CW3YKHDV4XEM674H
          customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G
          start_date: 2021-10-20
          status: PENDING
          tax_percentage: "5"
          price_override_money:
            amount: 100
            currency: USD
          version: 1594155459464
          created_at: 2021-10-20T21:53:10Z
          card_id: ccof:qy5x8hHGYsgLrp4Q4GB
          timezone: America/Los_Angeles
          source:
            name: My App
      x-property-order:
      - errors
      - subscription
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: CreateSubscriptionResponse
    CreateTerminalActionRequest:
      required:
      - action
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          maxLength: 64
          minLength: 1
          type: string
          description: |-
            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/basics/api101/idempotency) for more
            information.
        action:
          $ref: '#/components/schemas/TerminalAction'
      example:
        idempotency_key: thahn-70e75c10-47f7-4ab6-88cc-aaa4076d065e
        action:
          device_id: '{{DEVICE_ID}}'
          type: SAVE_CARD
          deadline_duration: PT5M
          save_card_options:
            customer_id: '{{CUSTOMER_ID}}'
            reference_id: user-id-1
      x-property-order:
      - idempotency_key
      - action
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_actions.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: CreateTerminalActionRequest
    CreateTerminalActionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        action:
          $ref: '#/components/schemas/TerminalAction'
      example:
        action:
          id: termapia:jveJIAkkAjILHkdCE
          device_id: DEVICE_ID
          deadline_duration: PT5M
          status: PENDING
          created_at: 2021-07-28T23:22:07.476Z
          updated_at: 2021-07-28T23:22:07.476Z
          location_id: LOCATION_ID
          type: SAVE_CARD
          app_id: APP_ID
          save_card_options:
            customer_id: CUSTOMER_ID
            reference_id: user-id-1
      x-property-order:
      - errors
      - action
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_actions.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: CreateTerminalActionResponse
    CreateTerminalCheckoutRequest:
      required:
      - checkout
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          maxLength: 64
          minLength: 1
          type: string
          description: |-
            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/basics/api101/idempotency) for more information.
        checkout:
          $ref: '#/components/schemas/TerminalCheckout'
      example:
        idempotency_key: 28a0c3bc-7839-11ea-bc55-0242ac130003
        checkout:
          amount_money:
            amount: 2610
            currency: USD
          reference_id: id11572
          device_options:
            device_id: dbb5d83a-7838-11ea-bc55-0242ac130003
          note: A brief note
      x-property-order:
      - idempotency_key
      - checkout
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkouts.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: CreateTerminalCheckoutRequest
    CreateTerminalCheckoutResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        checkout:
          $ref: '#/components/schemas/TerminalCheckout'
      example:
        checkout:
          id: 08YceKh7B3ZqO
          amount_money:
            amount: 2610
            currency: USD
          reference_id: id11572
          note: A brief note
          device_options:
            device_id: dbb5d83a-7838-11ea-bc55-0242ac130003
            tip_settings:
              allow_tipping: false
            skip_receipt_screen: false
          status: PENDING
          created_at: 2020-04-06T16:39:32.545Z
          updated_at: 2020-04-06T16:39:32.545Z
          app_id: APP_ID
          deadline_duration: PT10M
          payment_type: CARD_PRESENT
      x-property-order:
      - errors
      - checkout
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkouts.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: CreateTerminalCheckoutResponse
    CreateTerminalRefundRequest:
      required:
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          maxLength: 64
          minLength: 1
          type: string
          description: |-
            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/basics/api101/idempotency) for more information.
        refund:
          $ref: '#/components/schemas/TerminalRefund'
      example:
        idempotency_key: 402a640b-b26f-401f-b406-46f839590c04
        refund:
          amount_money:
            amount: 111
            currency: CAD
          device_id: f72dfb8e-4d65-4e56-aade-ec3fb8d33291
          reason: Returning items
          payment_id: 5O5OvgkcNUhl7JBuINflcjKqUzXZY
      x-property-order:
      - idempotency_key
      - refund
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_refunds.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: CreateTerminalRefundRequest
    CreateTerminalRefundResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        refund:
          $ref: '#/components/schemas/TerminalRefund'
      example:
        refund:
          id: 009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY
          payment_id: 5O5OvgkcNUhl7JBuINflcjKqUzXZY
          amount_money:
            amount: 111
            currency: CAD
          reason: Returning items
          device_id: f72dfb8e-4d65-4e56-aade-ec3fb8d33291
          deadline_duration: PT5M
          status: PENDING
          created_at: 2020-09-29T15:21:46.771Z
          updated_at: 2020-09-29T15:21:46.771Z
          app_id: sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ
          card:
            card_brand: INTERAC
            last_4: "1111"
            exp_month: 1
            exp_year: 2022
            fingerprint: sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw
            card_type: CREDIT
            bin: "411111"
          order_id: kcuKDKreRaI4gF4TjmEgZjHk8Z7YY
          location_id: 76C9W6K8CNNQ5
      x-property-order:
      - errors
      - refund
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_refunds.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: CreateTerminalRefundResponse
    DeleteDisputeEvidenceRequest:
      type: object
      properties: {}
      description: Defines the parameters for a `DeleteDisputeEvidence` request.
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_evidence.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: DeleteDisputeEvidenceRequest
      x-params-example: ?dispute_id=bVTprrwk0gygTLZ96VX1oB&evidence_id=CpfnkwGselCwS8QFvxN6
    DeleteDisputeEvidenceResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Defines the fields in a `DeleteDisputeEvidence` response.
      example: {}
      x-property-order:
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_evidence.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: DeleteDisputeEvidenceResponse
    DeleteSubscriptionActionRequest:
      type: object
      properties: {}
      description: "Defines input parameters in a call to the \n[DeleteSubscriptionAction](api-endpoint:Subscriptions-DeleteSubscriptionAction)\n\
        endpoint."
      x-property-order: []
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: DeleteSubscriptionActionRequest
    DeleteSubscriptionActionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        subscription:
          $ref: '#/components/schemas/Subscription'
      description: |-
        Defines output parameters in a response of the [DeleteSubscriptionAction](api-endpoint:Subscriptions-DeleteSubscriptionAction)
        endpoint.
      example:
        subscription:
          id: 8151fc89-da15-4eb9-a685-1a70883cebfc
          location_id: S8GWD5R9QB376
          plan_id: 6JHXF3B2CW3YKHDV4XEM674H
          customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G
          start_date: 2021-10-20
          charged_through_date: 2021-11-20
          status: ACTIVE
          invoice_ids:
          - grebK0Q_l8H4fqoMMVvt-Q
          - rcX_i3sNmHTGKhI4W2mceA
          price_override_money:
            amount: 1000
            currency: USD
          created_at: 2021-10-20T21:53:10Z
          paid_until_date: 2021-11-20
          timezone: America/Los_Angeles
          source:
            name: My App
      x-property-order:
      - errors
      - subscription
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: DeleteSubscriptionActionResponse
    DeprecatedCreateDisputeEvidenceFileRequest:
      required:
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          maxLength: 45
          minLength: 1
          type: string
          description: The Unique ID. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
        evidence_type:
          $ref: '#/components/schemas/DisputeEvidenceType'
        content_type:
          maxLength: 40
          minLength: 1
          type: string
          description: |-
            The MIME type of the uploaded file.
            The type can be image/heic, image/heif, image/jpeg, application/pdf, image/png, or image/tiff.
      description: Defines the parameters for a `DeprecatedCreateDisputeEvidenceFile`
        request.
      x-property-order:
      - idempotency_key
      - evidence_type
      - content_type
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_evidence.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: DeprecatedCreateDisputeEvidenceFileRequest
    DeprecatedCreateDisputeEvidenceFileResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        evidence:
          $ref: '#/components/schemas/DisputeEvidence'
      description: Defines the fields in a `DeprecatedCreateDisputeEvidenceFile` response.
      example:
        evidence:
          evidence_id: TOomLInj6iWmP3N8qfCXrB
          dispute_id: bVTprrwk0gygTLZ96VX1oB
          evidence_file:
            filename: evidence.tiff
            filetype: image/tiff
          evidence_type: GENERIC_EVIDENCE
          uploaded_at: 2018-10-18T16:01:10.000Z
      x-property-order:
      - errors
      - evidence
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_evidence.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: DeprecatedCreateDisputeEvidenceFileResponse
    DeprecatedCreateDisputeEvidenceTextRequest:
      required:
      - evidence_text
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          maxLength: 45
          minLength: 1
          type: string
          description: The Unique ID. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
        evidence_type:
          $ref: '#/components/schemas/DisputeEvidenceType'
        evidence_text:
          maxLength: 500
          minLength: 1
          type: string
          description: The evidence string.
      description: Defines the parameters for a `DeprecatedCreateDisputeEvidenceText`
        request.
      example:
        evidence_type: TRACKING_NUMBER
        evidence_text: 1Z8888888888888888
        idempotency_key: ed3ee3933d946f1514d505d173c82648
      x-property-order:
      - idempotency_key
      - evidence_type
      - evidence_text
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_evidence.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: DeprecatedCreateDisputeEvidenceTextRequest
    DeprecatedCreateDisputeEvidenceTextResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        evidence:
          $ref: '#/components/schemas/DisputeEvidence'
      description: Defines the fields in a `DeprecatedCreateDisputeEvidenceText` response.
      example:
        evidence:
          dispute_id: bVTprrwk0gygTLZ96VX1oB
          uploaded_at: 2022-05-18T16:01:10.000Z
          evidence_type: REBUTTAL_EXPLANATION
          evidence_text: The customer purchased the item twice, on April 11 and April
            28.
          id: TOomLInj6iWmP3N8qfCXrB
      x-property-order:
      - errors
      - evidence
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_evidence.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: DeprecatedCreateDisputeEvidenceTextResponse
    Device:
      type: object
      properties:
        id:
          type: string
          description: The device's Square-issued ID.
        name:
          type: string
          description: The device's merchant-specified name.
      example:
        name: name
        id: id
      deprecated: true
      x-property-order:
      - id
      - name
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1common.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: Device
    DeviceCheckoutOptions:
      required:
      - device_id
      type: object
      properties:
        device_id:
          type: string
          description: |-
            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: boolean
          description: Instructs the device to skip the receipt screen. Defaults to
            false.
        collect_signature:
          type: boolean
          description: Indicates that signature collection is desired during checkout.
            Defaults to false.
        tip_settings:
          $ref: '#/components/schemas/TipSettings'
        show_itemized_cart:
          type: boolean
          description: |-
            Show the itemization screen prior to taking a payment. This field is only meaningful when the
            checkout includes an order ID. Defaults to true.
          x-release-status: BETA
      x-property-order:
      - device_id
      - display_digital_receipt
      - print_receipt
      - skip_receipt_screen
      - collect_signature
      - tip_settings
      - loyalty_settings
      - allow_split_payment
      - show_itemized_cart
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkouts.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: DeviceCheckoutOptions
    DeviceDetails:
      type: object
      properties:
        device_id:
          maxLength: 255
          type: string
          description: The Square-issued ID of the device.
        device_installation_id:
          maxLength: 255
          type: string
          description: The Square-issued installation ID for the device.
        device_name:
          maxLength: 255
          type: string
          description: The name of the device set by the seller.
      description: Details about the device that took the payment.
      x-property-order:
      - device_id
      - device_installation_id
      - device_name
      - device_credential
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_model.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: DeviceDetails
    DeviceMetadata:
      type: object
      properties:
        battery_percentage:
          type: string
          description: The Terminal’s remaining battery percentage, between 1-100.
        charging_state:
          type: string
          description: |-
            The current charging state of the Terminal.
            Options: `CHARGING`, `NOT_CHARGING`
        location_id:
          type: string
          description: The ID of the Square seller business location associated with
            the Terminal.
        merchant_id:
          type: string
          description: The ID of the Square merchant account that is currently signed-in
            to the Terminal.
        network_connection_type:
          type: string
          description: |-
            The Terminal’s current network connection type.
            Options: `WIFI`, `ETHERNET`
        payment_region:
          type: string
          description: The country in which the Terminal is authorized to take payments.
        serial_number:
          type: string
          description: |-
            The unique identifier assigned to the Terminal, which can be found on the lower back
            of the device.
        os_version:
          type: string
          description: The current version of the Terminal’s operating system.
        app_version:
          type: string
          description: The current version of the application running on the Terminal.
        wifi_network_name:
          type: string
          description: The name of the Wi-Fi network to which the Terminal is connected.
        wifi_network_strength:
          type: string
          description: |-
            The signal strength of the Wi-FI network connection.
            Options: `POOR`, `FAIR`, `GOOD`, `EXCELLENT`
        ip_address:
          type: string
          description: The IP address of the Terminal.
      x-property-order:
      - battery_percentage
      - charging_state
      - firmware_version
      - hardware_id
      - location_id
      - merchant_id
      - network_connection_type
      - payment_region
      - serial_number
      - spe_hardware_id
      - spe_serial_number
      - system_uptime
      - version
      - os_version
      - app_version
      - wifi_network_name
      - wifi_network_strength
      - wifi_network_security
      - ip_address
      - device_name
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_actions.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: DeviceMetadata
    DigitalWalletDetails:
      type: object
      properties:
        status:
          maxLength: 50
          type: string
          description: |-
            The status of the `WALLET` payment. The status can be `AUTHORIZED`, `CAPTURED`, `VOIDED`, or
            `FAILED`.
        brand:
          maxLength: 50
          type: string
          description: The brand used for the `WALLET` payment. The brand can be `CASH_APP`,
            `PAYPAY` or `UNKNOWN`.
        cash_app_details:
          $ref: '#/components/schemas/CashAppDetails'
      description: Additional details about `WALLET` type payments. Contains only
        non-confidential information.
      x-property-order:
      - status
      - brand
      - statement_description
      - device_details
      - cash_app_details
      - alipay_details
      - paypay_details
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_model.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: DigitalWalletDetails
    Dispute:
      type: object
      properties:
        dispute_id:
          maxLength: 40
          minLength: 1
          type: string
          description: The unique ID for this `Dispute`, generated by Square.
          x-release-status: DEPRECATED
        id:
          maxLength: 40
          minLength: 1
          type: string
          description: The unique ID for this `Dispute`, generated by Square.
        amount_money:
          $ref: '#/components/schemas/Money'
        reason:
          $ref: '#/components/schemas/DisputeReason'
        state:
          $ref: '#/components/schemas/DisputeState'
        due_at:
          maxLength: 40
          minLength: 1
          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).
        disputed_payment:
          $ref: '#/components/schemas/DisputedPayment'
        evidence_ids:
          type: array
          description: The IDs of the evidence associated with the dispute.
          items:
            maxLength: 40
            minLength: 1
            type: string
          x-release-status: DEPRECATED
        card_brand:
          $ref: '#/components/schemas/CardBrand'
        created_at:
          maxLength: 40
          minLength: 1
          type: string
          description: The timestamp when the dispute was created, in RFC 3339 format.
          readOnly: true
        updated_at:
          maxLength: 40
          minLength: 1
          type: string
          description: The timestamp when the dispute was last updated, in RFC 3339
            format.
          readOnly: true
        brand_dispute_id:
          maxLength: 40
          minLength: 1
          type: string
          description: The ID of the dispute in the card brand system, generated by
            the card brand.
        reported_date:
          maxLength: 40
          minLength: 1
          type: string
          description: The timestamp when the dispute was reported, in RFC 3339 format.
          x-release-status: DEPRECATED
        reported_at:
          maxLength: 40
          minLength: 1
          type: string
          description: The timestamp when the dispute was reported, in RFC 3339 format.
        version:
          type: integer
          description: The current version of the `Dispute`.
        location_id:
          maxLength: 40
          minLength: 1
          type: string
          description: The ID of the location where the dispute originated.
      description: Represents a [dispute](https://developer.squareup.com/docs/disputes-api/overview)
        a cardholder initiated with their bank.
      x-property-order:
      - dispute_id
      - id
      - amount_money
      - reason
      - state
      - due_at
      - disputed_payment
      - evidence_ids
      - card_brand
      - created_at
      - updated_at
      - brand_dispute_id
      - reported_date
      - reported_at
      - version
      - location_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: Dispute
    DisputeEvidence:
      type: object
      properties:
        evidence_id:
          maxLength: 40
          minLength: 1
          type: string
          description: The Square-generated ID of the evidence.
          x-release-status: DEPRECATED
        id:
          maxLength: 40
          minLength: 1
          type: string
          description: The Square-generated ID of the evidence.
        dispute_id:
          maxLength: 40
          minLength: 1
          type: string
          description: The ID of the dispute the evidence is associated with.
        evidence_file:
          $ref: '#/components/schemas/DisputeEvidenceFile'
        evidence_text:
          maxLength: 500
          minLength: 1
          type: string
          description: Raw text
        uploaded_at:
          maxLength: 40
          minLength: 1
          type: string
          description: The time when the evidence was uploaded, in RFC 3339 format.
        evidence_type:
          $ref: '#/components/schemas/DisputeEvidenceType'
      x-property-order:
      - evidence_id
      - id
      - dispute_id
      - evidence_file
      - evidence_text
      - uploaded_at
      - evidence_type
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_evidence.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: DisputeEvidence
    DisputeEvidenceFile:
      type: object
      properties:
        filename:
          maxLength: 40
          minLength: 1
          type: string
          description: 'The file name including the file extension. For example: "receipt.tiff".'
        filetype:
          maxLength: 40
          minLength: 1
          type: string
          description: Dispute evidence files must be application/pdf, image/heic,
            image/heif, image/jpeg, image/png, or image/tiff formats.
      description: A file to be uploaded as dispute evidence.
      x-property-order:
      - filename
      - filetype
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_evidence.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: DisputeEvidenceFile
    DisputedPayment:
      type: object
      properties:
        payment_id:
          maxLength: 192
          minLength: 1
          type: string
          description: Square-generated unique ID of the payment being disputed.
      description: The payment the cardholder disputed.
      x-property-order:
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: DisputedPayment
    ExternalPaymentDetails:
      required:
      - source
      - type
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: |-
            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:
          maxLength: 255
          type: string
          description: "A description of the external payment source. For example,\
            \ \n\"Food Delivery Service\"."
        source_id:
          maxLength: 255
          type: string
          description: An ID to associate the payment to its originating source.
        source_fee_money:
          $ref: '#/components/schemas/Money'
      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-property-order:
      - type
      - source
      - source_id
      - source_fee_money
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_model.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: ExternalPaymentDetails
    GetBankAccountByV1IdRequest:
      type: object
      properties: {}
      description: |-
        Request object for fetching a specific `BankAccount`
        by the object ID.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/bank_accounts.proto
      x-proto-sha: dc1003a64eea24f147d72da44df7237577699575
      x-object-name: GetBankAccountByV1IdRequest
      x-namespace: marketplaces
    GetBankAccountByV1IdResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
          x-namespace: marketplaces
        bank_account:
          $ref: '#/components/schemas/BankAccount'
      description: Response object returned by GetBankAccountByV1Id.
      example:
        bank_account:
          id: w3yRgCGYQnwmdl0R3GB
          account_number_suffix: "971"
          country: US
          currency: USD
          account_type: CHECKING
          holder_name: Jane Doe
          primary_bank_identification_number: "112200303"
          location_id: S8GWD5example
          status: VERIFICATION_IN_PROGRESS
          creditable: false
          debitable: false
          version: 5
          bank_name: Bank Name
      x-property-order:
      - errors
      - bank_account
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/bank_accounts.proto
      x-proto-sha: dc1003a64eea24f147d72da44df7237577699575
      x-object-name: GetBankAccountByV1IdResponse
      x-namespace: marketplaces
    GetBankAccountRequest:
      type: object
      properties: {}
      description: |-
        Request object to fetch a specific `BankAccount`
        by the object ID.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/bank_accounts.proto
      x-proto-sha: dc1003a64eea24f147d72da44df7237577699575
      x-object-name: GetBankAccountRequest
      x-namespace: marketplaces
    GetBankAccountResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
          x-namespace: marketplaces
        bank_account:
          $ref: '#/components/schemas/BankAccount'
      description: Response object returned by `GetBankAccount`.
      example:
        bank_account:
          id: w3yRgCGYQnwmdl0R3GB
          account_number_suffix: "971"
          country: US
          currency: USD
          account_type: CHECKING
          holder_name: Jane Doe
          primary_bank_identification_number: "112200303"
          location_id: S8GWD5example
          status: VERIFICATION_IN_PROGRESS
          creditable: false
          debitable: false
          version: 5
          bank_name: Bank Name
      x-property-order:
      - errors
      - bank_account
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/bank_accounts.proto
      x-proto-sha: dc1003a64eea24f147d72da44df7237577699575
      x-object-name: GetBankAccountResponse
      x-namespace: marketplaces
    GetPaymentRefundRequest:
      type: object
      properties: {}
      description: |-
        Describes a request to retrieve a refund using
        [GetPaymentRefund](api-endpoint:Refunds-GetPaymentRefund).
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/refunds_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: GetPaymentRefundRequest
    GetPaymentRefundResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        refund:
          $ref: '#/components/schemas/PaymentRefund'
      description: |-
        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.
      example:
        refund:
          id: bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY_69MmgHubkLqx9wGhnmenRUHOaKitE6llfZuxcWYjGxd
          status: COMPLETED
          amount_money:
            amount: 555
            currency: USD
          payment_id: bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY
          order_id: 9ltv0bx5PuvGXUYHYHxYSKEqC3IZY
          created_at: 2021-10-13T19:59:05.073Z
          updated_at: 2021-10-13T20:00:02.442Z
          processing_fee:
          - effective_at: 2021-10-13T21:34:35.000Z
            type: INITIAL
            amount_money:
              amount: -34
              currency: USD
          location_id: L88917AVBK2S5
          reason: Example Refund
      x-property-order:
      - errors
      - refund
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/refunds_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: GetPaymentRefundResponse
    GetPaymentRequest:
      type: object
      properties: {}
      description: "Describes a request to retrieve a payment using \n[GetPayment](api-endpoint:Payments-GetPayment)."
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: GetPaymentRequest
    GetPaymentResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        payment:
          $ref: '#/components/schemas/Payment'
      description: Defines the response returned by [GetPayment](api-endpoint:Payments-GetPayment).
      example:
        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
          status: COMPLETED
          delay_duration: PT168H
          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
          location_id: L88917AVBK2S5
          order_id: d7eKah653Z579f3gVtjlxpSlmUcZY
          processing_fee:
          - effective_at: 2021-10-13T21:34:35.000Z
            type: INITIAL
            amount_money:
              amount: 34
              currency: USD
          note: Test Note
          total_money:
            amount: 555
            currency: USD
          approved_money:
            amount: 555
            currency: USD
          employee_id: TMoK_ogh6rH1o4dV
          receipt_number: bP9m
          receipt_url: https://squareup.com/receipt/preview/bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY
          delay_action: CANCEL
          delayed_until: 2021-10-20T19:34:33.524Z
          team_member_id: TMoK_ogh6rH1o4dV
          application_details:
            square_product: VIRTUAL_TERMINAL
            application_id: sq0ids-Pw67AZAlLVB7hsRmwlJPuA
          version_token: 56pRkL3slrzet2iQrTp9n0bdJVYTB9YEWdTNjQfZOPV6o
      x-property-order:
      - errors
      - payment
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: GetPaymentResponse
    GetTerminalActionRequest:
      type: object
      properties: {}
      example: {}
      x-property-order:
      - include
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_actions.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: GetTerminalActionRequest
    GetTerminalActionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        action:
          $ref: '#/components/schemas/TerminalAction'
      example:
        action:
          id: termapia:jveJIAkkAjILHkdCE
          device_id: DEVICE_ID
          deadline_duration: PT5M
          status: IN_PROGRESS
          created_at: 2021-07-28T23:22:07.476Z
          updated_at: 2021-07-28T23:22:08.301Z
          location_id: LOCATION_ID
          type: SAVE_CARD
          app_id: APP_ID
          save_card_options:
            customer_id: CUSTOMER_ID
            reference_id: user-id-1
      x-property-order:
      - errors
      - action
      - included_resources
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_actions.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: GetTerminalActionResponse
    GetTerminalCheckoutRequest:
      type: object
      properties: {}
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkouts.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: GetTerminalCheckoutRequest
    GetTerminalCheckoutResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        checkout:
          $ref: '#/components/schemas/TerminalCheckout'
      example:
        checkout:
          id: 08YceKh7B3ZqO
          amount_money:
            amount: 2610
            currency: USD
          reference_id: id11572
          note: A brief note
          device_options:
            device_id: dbb5d83a-7838-11ea-bc55-0242ac130003
            tip_settings:
              allow_tipping: false
            skip_receipt_screen: false
          status: IN_PROGRESS
          created_at: 2020-04-06T16:39:32.545Z
          updated_at: 2020-04-06T16:39:323.001Z
          app_id: APP_ID
          deadline_duration: PT10M
      x-property-order:
      - errors
      - checkout
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkouts.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: GetTerminalCheckoutResponse
    GetTerminalRefundRequest:
      type: object
      properties: {}
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_refunds.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: GetTerminalRefundRequest
    GetTerminalRefundResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        refund:
          $ref: '#/components/schemas/TerminalRefund'
      example:
        refund:
          id: 009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY
          refund_id: 5O5OvgkcNUhl7JBuINflcjKqUzXZY_43Q4iGp7sNeATiWrUruA1EYeMRUXaddXXlDDJ1EQLvb
          payment_id: 5O5OvgkcNUhl7JBuINflcjKqUzXZY
          amount_money:
            amount: 111
            currency: CAD
          reason: Returning item
          device_id: f72dfb8e-4d65-4e56-aade-ec3fb8d33291
          deadline_duration: PT5M
          status: COMPLETED
          created_at: 2020-09-29T15:21:46.771Z
          updated_at: 2020-09-29T15:21:48.675Z
          app_id: sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ
          card:
            card_brand: INTERAC
            last_4: "1111"
            exp_month: 1
            exp_year: 2022
            fingerprint: sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw
            card_type: CREDIT
            bin: "411111"
          order_id: kcuKDKreRaI4gF4TjmEgZjHk8Z7YY
          location_id: 76C9W6K8CNNQ5
      x-property-order:
      - errors
      - refund
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_refunds.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: GetTerminalRefundResponse
    ListBankAccountsRequest:
      type: object
      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."
          x-namespace: marketplaces
        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."
          x-namespace: marketplaces
        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."
          x-namespace: marketplaces
      description: |-
        Request object for fetching all `BankAccount`
        objects linked to a account.
      x-property-order:
      - cursor
      - limit
      - location_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/bank_accounts.proto
      x-proto-sha: dc1003a64eea24f147d72da44df7237577699575
      x-object-name: ListBankAccountsRequest
      x-namespace: marketplaces
    ListBankAccountsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
          x-namespace: marketplaces
        bank_accounts:
          type: array
          description: List of BankAccounts associated with this account.
          items:
            $ref: '#/components/schemas/BankAccount'
          x-namespace: marketplaces
        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.\n\
            If empty, this is the final response.\n\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
          x-namespace: marketplaces
      description: Response object returned by ListBankAccounts.
      example:
        bank_accounts:
        - id: ao6iaQ9vhDiaQD7n3GB
          account_number_suffix: "971"
          country: US
          currency: USD
          account_type: CHECKING
          holder_name: Jane Doe
          primary_bank_identification_number: "112200303"
          location_id: S8GWD5example
          status: VERIFICATION_IN_PROGRESS
          creditable: false
          debitable: false
          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"
          location_id: S8GWD5example
          status: VERIFICATION_IN_PROGRESS
          creditable: false
          debitable: false
          version: 5
          bank_name: Bank Name
      x-property-order:
      - errors
      - bank_accounts
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/bank_accounts.proto
      x-proto-sha: dc1003a64eea24f147d72da44df7237577699575
      x-object-name: ListBankAccountsResponse
      x-namespace: marketplaces
    ListDisputeEvidenceRequest:
      type: object
      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 results for the original query.
            For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
      description: Defines the parameters for a `ListDisputeEvidence` request.
      example: {}
      x-property-order:
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_evidence.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: ListDisputeEvidenceRequest
      x-params-example: ?dispute_id=bVTprrwk0gygTLZ96VX1oB
    ListDisputeEvidenceResponse:
      type: object
      properties:
        evidence:
          type: array
          description: The list of evidence previously uploaded to the specified dispute.
          items:
            $ref: '#/components/schemas/DisputeEvidence'
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        cursor:
          type: string
          description: |-
            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).
      description: Defines the fields in a `ListDisputeEvidence` response.
      example:
        evidence:
        - dispute_id: bVTprrwk0gygTLZ96VX1oB
          evidence_file:
            filename: customer-interaction
            filetype: JPG
          uploaded_at: 2022-05-10T15:57:13.802Z
          evidence_type: CARDHOLDER_COMMUNICATION
          id: CpfnkwGselCwS8QFvxN6
        - dispute_id: bVTprrwk0gygTLZ96VX1oB
          evidence_file:
            filename: ""
            filetype: ""
          uploaded_at: 2022-05-18T16:01:10.000Z
          evidence_type: REBUTTAL_EXPLANATION
          id: TOomLInj6iWmP3N8qfCXrB
      x-property-order:
      - evidence
      - errors
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_evidence.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: ListDisputeEvidenceResponse
    ListDisputesRequest:
      type: object
      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 results for the original query.
            For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).
        states:
          type: array
          description: |-
            The dispute states used to filter the result. If not specified, the endpoint returns all disputes.
            See [DisputeState](#type-disputestate) for possible values
          items:
            $ref: '#/components/schemas/DisputeState'
        location_id:
          maxLength: 40
          minLength: 1
          type: string
          description: |-
            The ID of the location for which to return a list of disputes.
            If not specified, the endpoint returns disputes associated with all locations.
      description: Defines the request parameters for the `ListDisputes` endpoint.
      example: {}
      x-property-order:
      - cursor
      - states
      - location_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: ListDisputesRequest
    ListDisputesResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        disputes:
          type: array
          description: The list of disputes.
          items:
            $ref: '#/components/schemas/Dispute'
        cursor:
          type: string
          description: |-
            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/basics/api101/pagination).
      description: Defines fields in a `ListDisputes` response.
      example:
        disputes:
        - amount_money:
            amount: 2500
            currency: USD
          reason: NO_KNOWLEDGE
          state: ACCEPTED
          due_at: 2022-07-13T00:00:00.000Z
          disputed_payment:
            payment_id: zhyh1ch64kRBrrlfVhwjCEjZWzNZY
          card_brand: VISA
          created_at: 2022-06-29T18:45:22.265Z
          updated_at: 2022-07-07T19:14:42.650Z
          brand_dispute_id: "100000809947"
          version: 2
          location_id: L1HN3ZMQK64X9
          id: XDgyFu7yo1E2S5lQGGpYn
          reported_at: 2022-06-29T00:00:00.000Z
        - 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
          card_brand: VISA
          created_at: 2022-04-29T18:45:22.265Z
          updated_at: 2022-04-29T18:45:22.265Z
          brand_dispute_id: r5Of6YaGT7AdeRaVoAGCJw
          version: 1
          location_id: 18YC4JDH91E1H
          id: jLGg7aXC7lvKPr9PISt0T
          reported_at: 2022-04-29T00:00:00.000Z
        cursor: G1aSTRm48CLjJsg6Sg3hQN1b1OMaoVuG
      x-property-order:
      - errors
      - disputes
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: ListDisputesResponse
    ListPaymentRefundsRequest:
      type: object
      properties:
        begin_time:
          type: string
          description: |-
            The timestamp for the beginning of the requested reporting period, in RFC 3339 format.

            Default: The current time minus one year.
        end_time:
          type: string
          description: |-
            The timestamp for the end of the requested reporting period, in RFC 3339 format.

            Default: The current time.
        sort_order:
          type: string
          description: |-
            The order in which results are listed:
            - `ASC` - Oldest to newest.
            - `DESC` - Newest to oldest (default).
        cursor:
          type: string
          description: |-
            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/basics/api101/pagination).
        location_id:
          type: string
          description: |-
            Limit results to the location supplied. By default, results are returned
            for all locations associated with the seller.
        status:
          type: string
          description: |-
            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: string
          description: |-
            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: integer
          description: |-
            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
      description: |-
        Describes a request to list refunds using
        [ListPaymentRefunds](api-endpoint:Refunds-ListPaymentRefunds).

        The maximum results per page is 100.
      example: {}
      x-property-order:
      - begin_time
      - end_time
      - sort_order
      - cursor
      - location_id
      - status
      - source_type
      - limit
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/refunds_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: ListPaymentRefundsRequest
    ListPaymentRefundsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        refunds:
          type: array
          description: The list of requested refunds.
          items:
            $ref: '#/components/schemas/PaymentRefund'
        cursor:
          type: string
          description: |-
            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/basics/api101/pagination).
      description: |-
        Defines the response returned by [ListPaymentRefunds](api-endpoint:Refunds-ListPaymentRefunds).

        Either `errors` or `refunds` is present in a given response (never both).
      example:
        refunds:
        - id: bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY_69MmgHubkLqx9wGhnmenRUHOaKitE6llfZuxcWYjGxd
          status: COMPLETED
          amount_money:
            amount: 555
            currency: USD
          payment_id: bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY
          order_id: 9ltv0bx5PuvGXUYHYHxYSKEqC3IZY
          created_at: 2021-10-13T19:59:05.342Z
          updated_at: 2021-10-13T20:00:03.497Z
          processing_fee:
          - effective_at: 2021-10-13T21:34:35.000Z
            type: INITIAL
            amount_money:
              amount: -34
              currency: USD
          location_id: L88917AVBK2S5
          reason: Example Refund
        cursor: 5evquW1YswHoT4EoyUhzMmTsCnsSXBU9U0WJ4FU4623nrMQcocH0RGU6Up1YkwfiMcF59ood58EBTEGgzMTGHQJpocic7ExOL0NtrTXCeWcv0UJIJNk8eXb
      x-property-order:
      - errors
      - refunds
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/refunds_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: ListPaymentRefundsResponse
    ListPaymentsRequest:
      type: object
      properties:
        begin_time:
          type: string
          description: |-
            The timestamp for the beginning of the reporting period, in RFC 3339 format.
            Inclusive. Default: The current time minus one year.
        end_time:
          type: string
          description: |-
            The timestamp for the end of the reporting period, in RFC 3339 format.

            Default: The current time.
        sort_order:
          type: string
          description: |-
            The order in which results are listed:
            - `ASC` - Oldest to newest.
            - `DESC` - Newest to oldest (default).
        cursor:
          type: string
          description: |-
            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/basics/api101/pagination).
        location_id:
          type: string
          description: |-
            Limit results to the location supplied. By default, results are returned
            for the default (main) location associated with the seller.
        total:
          minimum: 0
          type: integer
          description: The exact amount in the `total_money` for a payment.
          format: int64
        last_4:
          type: string
          description: The last four digits of a payment card.
        card_brand:
          type: string
          description: The brand of the payment card (for example, VISA).
        limit:
          type: integer
          description: "The maximum number of results to be returned in a single page.\n\
            It 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`"
      description: "Describes a request to list payments using \n[ListPayments](api-endpoint:Payments-ListPayments).\n\
        \nThe maximum results per page is 100."
      example: {}
      x-property-order:
      - begin_time
      - end_time
      - sort_order
      - cursor
      - location_id
      - payment_config_id
      - total
      - last_4
      - card_brand
      - limit
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: ListPaymentsRequest
    ListPaymentsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        payments:
          type: array
          description: The requested list of payments.
          items:
            $ref: '#/components/schemas/Payment'
        cursor:
          type: string
          description: |-
            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/basics/api101/pagination).
      description: Defines the response returned by [ListPayments](api-endpoint:Payments-ListPayments).
      example:
        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
          status: COMPLETED
          delay_duration: PT168H
          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
          location_id: L88917AVBK2S5
          order_id: d7eKah653Z579f3gVtjlxpSlmUcZY
          processing_fee:
          - effective_at: 2021-10-13T21:34:35.000Z
            type: INITIAL
            amount_money:
              amount: 34
              currency: USD
          note: Test Note
          total_money:
            amount: 555
            currency: USD
          approved_money:
            amount: 555
            currency: USD
          employee_id: TMoK_ogh6rH1o4dV
          receipt_number: bP9m
          receipt_url: https://squareup.com/receipt/preview/bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY
          delay_action: CANCEL
          delayed_until: 2021-10-20T19:34:33.524Z
          team_member_id: TMoK_ogh6rH1o4dV
          application_details:
            square_product: VIRTUAL_TERMINAL
            application_id: sq0ids-Pw67AZAlLVB7hsRmwlJPuA
          version_token: vguW2km0KpVCdAXZcNTZ438qg5LlVPTP4HO5OpiHNfa6o
      x-property-order:
      - errors
      - payments
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: ListPaymentsResponse
    ListSubscriptionEventsRequest:
      type: object
      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/working-with-apis/pagination)."
        limit:
          minimum: 1
          type: integer
          description: |-
            The upper limit on the number of subscription events to return
            in a paged response.
      description: "Defines input parameters in a request to the \n[ListSubscriptionEvents](api-endpoint:Subscriptions-ListSubscriptionEvents)\n\
        endpoint."
      x-property-order:
      - cursor
      - limit
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: ListSubscriptionEventsRequest
    ListSubscriptionEventsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        subscription_events:
          type: array
          description: The retrieved subscription events.
          items:
            $ref: '#/components/schemas/SubscriptionEvent'
        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.\n\
            If the cursor is unset, the response contains the last page of the results.\n\
            \nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
      description: |-
        Defines output parameters in a response from the
        [ListSubscriptionEvents](api-endpoint:Subscriptions-ListSubscriptionEvents).
      example:
        subscription_events:
        - id: 06809161-3867-4598-8269-8aea5be4f9de
          subscription_event_type: START_SUBSCRIPTION
          effective_date: 2020-04-24
          plan_id: 6JHXF3B2CW3YKHDV4XEM674H
        - id: f2736603-cd2e-47ec-8675-f815fff54f88
          subscription_event_type: DEACTIVATE_SUBSCRIPTION
          effective_date: 2020-05-01
          plan_id: 6JHXF3B2CW3YKHDV4XEM674H
          info:
            detail: The customer with ID `V74BMG0GPS2KNCWJE1BTYJ37Y0` does not have
              a name on record.
            code: CUSTOMER_NO_NAME
        - id: b426fc85-6859-450b-b0d0-fe3a5d1b565f
          subscription_event_type: RESUME_SUBSCRIPTION
          effective_date: 2022-05-01
          plan_id: 6JHXF3B2CW3YKHDV4XEM674H
        - id: 09f14de1-2f53-4dae-9091-49aa53f83d01
          subscription_event_type: PAUSE_SUBSCRIPTION
          effective_date: 2022-05-02
          plan_id: 6JHXF3B2CW3YKHDV4XEM674H
        - id: f28a73ac-1a1b-4b0f-8eeb-709a72945776
          subscription_event_type: RESUME_SUBSCRIPTION
          effective_date: 2020-05-02
          plan_id: 6JHXF3B2CW3YKHDV4XEM674H
        - id: a0c08083-5db0-4800-85c7-d398de4fbb6e
          subscription_event_type: STOP_SUBSCRIPTION
          effective_date: 2020-05-06
          plan_id: 6JHXF3B2CW3YKHDV4XEM674H
      x-property-order:
      - errors
      - subscription_events
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: ListSubscriptionEventsResponse
    OrderCreated:
      type: object
      properties:
        order_id:
          type: string
          description: The order's unique ID.
        version:
          type: integer
          description: |-
            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:
          type: string
          description: The ID of the seller location that this order is associated
            with.
        state:
          $ref: '#/components/schemas/OrderState'
        created_at:
          type: string
          description: The timestamp for when the order was created, in RFC 3339 format.
          readOnly: true
      x-property-order:
      - order_id
      - version
      - location_id
      - state
      - created_at
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders-webhooks/orders-webhooks-proto/src/main/proto/squareup/orderswebhooks/payload.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderCreated
    OrderCreatedObject:
      type: object
      properties:
        order_created:
          $ref: '#/components/schemas/OrderCreated'
      x-property-order:
      - order_created
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders-webhooks/orders-webhooks-proto/src/main/proto/squareup/orderswebhooks/payload.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderCreatedObject
    OrderFulfillmentUpdated:
      type: object
      properties:
        order_id:
          type: string
          description: The order's unique ID.
        version:
          type: integer
          description: |-
            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:
          type: string
          description: The ID of the seller location that this order is associated
            with.
        state:
          $ref: '#/components/schemas/OrderState'
        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
          description: The fulfillments that were updated with this version change.
          items:
            $ref: '#/components/schemas/OrderFulfillmentUpdatedUpdate'
      x-property-order:
      - order_id
      - version
      - location_id
      - state
      - created_at
      - updated_at
      - fulfillment_update
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders-webhooks/orders-webhooks-proto/src/main/proto/squareup/orderswebhooks/payload.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderFulfillmentUpdated
    OrderFulfillmentUpdatedUpdate:
      type: object
      properties:
        fulfillment_uid:
          type: string
          description: A unique ID that identifies the fulfillment only within this
            order.
        old_state:
          $ref: '#/components/schemas/OrderFulfillmentState'
        new_state:
          $ref: '#/components/schemas/OrderFulfillmentState'
      description: Information about fulfillment updates.
      x-property-order:
      - fulfillment_uid
      - old_state
      - new_state
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders-webhooks/orders-webhooks-proto/src/main/proto/squareup/orderswebhooks/payload.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderFulfillmentUpdatedUpdate
    OrderFulfillmentUpdatedObject:
      type: object
      properties:
        order_fulfillment_updated:
          $ref: '#/components/schemas/OrderFulfillmentUpdated'
      x-property-order:
      - order_fulfillment_updated
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders-webhooks/orders-webhooks-proto/src/main/proto/squareup/orderswebhooks/payload.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderFulfillmentUpdatedObject
    OrderUpdated:
      type: object
      properties:
        order_id:
          type: string
          description: The order's unique ID.
        version:
          type: integer
          description: |-
            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:
          type: string
          description: The ID of the seller location that this order is associated
            with.
        state:
          $ref: '#/components/schemas/OrderState'
        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
      x-property-order:
      - order_id
      - version
      - location_id
      - state
      - created_at
      - updated_at
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders-webhooks/orders-webhooks-proto/src/main/proto/squareup/orderswebhooks/payload.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderUpdated
    OrderUpdatedObject:
      type: object
      properties:
        order_updated:
          $ref: '#/components/schemas/OrderUpdated'
      x-property-order:
      - order_updated
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders-webhooks/orders-webhooks-proto/src/main/proto/squareup/orderswebhooks/payload.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderUpdatedObject
    PauseSubscriptionRequest:
      type: object
      properties:
        pause_effective_date:
          type: string
          description: |-
            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: 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
        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`."
        resume_change_timing:
          $ref: '#/components/schemas/ChangeTiming'
        pause_reason:
          maxLength: 255
          type: string
          description: The user-provided reason to pause the subscription.
      description: |-
        Defines input parameters in a request to the
        [PauseSubscription](api-endpoint:Subscriptions-PauseSubscription) endpoint.
      x-property-order:
      - pause_effective_date
      - pause_cycle_duration
      - resume_effective_date
      - resume_change_timing
      - pause_reason
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: PauseSubscriptionRequest
    PauseSubscriptionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        subscription:
          $ref: '#/components/schemas/Subscription'
        actions:
          type: array
          description: The list of a `PAUSE` action and a possible `RESUME` action
            created by the request.
          items:
            $ref: '#/components/schemas/SubscriptionAction'
      description: |-
        Defines output parameters in a response from the
        [PauseSubscription](api-endpoint:Subscriptions-PauseSubscription) endpoint.
      example:
        subscription:
          id: 9ba40961-995a-4a3d-8c53-048c40cafc13
          location_id: S8GWD5R9QB376
          plan_id: 6JHXF3B2CW3YKHDV4XEM674H
          customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G
          status: ACTIVE
          price_override_money:
            amount: 2000
            currency: USD
          version: 1594311617331
          created_at: 2021-10-20T21:53:10Z
          timezone: America/Los_Angeles
          source:
            name: My App
        actions:
        - id: 99b2439e-63f7-3ad5-95f7-ab2447a80673
          type: PAUSE
          effective_date: 2021-11-17
      x-property-order:
      - errors
      - subscription
      - actions
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: PauseSubscriptionResponse
    Payment:
      type: object
      properties:
        id:
          maxLength: 192
          type: string
          description: A unique ID for the payment.
          readOnly: true
        created_at:
          maxLength: 32
          type: string
          description: The timestamp of when the payment was created, in RFC 3339
            format.
          readOnly: true
        updated_at:
          maxLength: 32
          type: string
          description: The timestamp of when the payment was last updated, in RFC
            3339 format.
          readOnly: true
        amount_money:
          $ref: '#/components/schemas/Money'
        tip_money:
          $ref: '#/components/schemas/Money'
        total_money:
          $ref: '#/components/schemas/Money'
        app_fee_money:
          $ref: '#/components/schemas/Money'
        approved_money:
          $ref: '#/components/schemas/Money'
        processing_fee:
          type: array
          description: The processing fees and fee adjustments assessed by Square
            for this payment.
          readOnly: true
          items:
            $ref: '#/components/schemas/ProcessingFee'
        refunded_money:
          $ref: '#/components/schemas/Money'
        status:
          maxLength: 50
          type: string
          description: Indicates whether the payment is APPROVED, PENDING, COMPLETED,
            CANCELED, or FAILED.
          readOnly: true
        delay_duration:
          type: string
          description: |-
            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.
          readOnly: true
        delay_action:
          type: string
          description: |-
            The action to be applied to the payment when the `delay_duration` has elapsed.

            Current values include `CANCEL` and `COMPLETE`.
        delayed_until:
          type: string
          description: |-
            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.
          readOnly: true
        source_type:
          maxLength: 50
          type: string
          description: "The source type for this payment.\n\nCurrent values include\
            \ `CARD`, `BANK_ACCOUNT`, `WALLET`, `BUY_NOW_PAY_LATER`, `CASH`, or\n\
            `EXTERNAL`. For information about these payment source types, \nsee [Take\
            \ Payments](https://developer.squareup.com/docs/payments-api/take-payments)."
          readOnly: true
        card_details:
          $ref: '#/components/schemas/CardPaymentDetails'
        cash_details:
          $ref: '#/components/schemas/CashPaymentDetails'
        bank_account_details:
          $ref: '#/components/schemas/BankAccountPaymentDetails'
        external_details:
          $ref: '#/components/schemas/ExternalPaymentDetails'
        wallet_details:
          $ref: '#/components/schemas/DigitalWalletDetails'
        buy_now_pay_later_details:
          $ref: '#/components/schemas/BuyNowPayLaterDetails'
        location_id:
          maxLength: 50
          type: string
          description: The ID of the location associated with the payment.
          readOnly: true
        order_id:
          maxLength: 192
          type: string
          description: The ID of the order associated with the payment.
          readOnly: true
        reference_id:
          maxLength: 40
          type: string
          description: |-
            An optional ID that associates the payment with an entity in
            another system.
          readOnly: true
        customer_id:
          maxLength: 191
          type: string
          description: The [Customer](entity:Customer) ID of the customer associated
            with the payment.
          readOnly: true
        employee_id:
          maxLength: 192
          type: string
          description: |-
            __Deprecated__: Use `Payment.team_member_id` instead.

            An optional ID of the employee associated with taking the payment.
          readOnly: true
          x-release-status: DEPRECATED
        team_member_id:
          maxLength: 192
          type: string
          description: An optional ID of the [TeamMember](entity:TeamMember) associated
            with taking the payment.
          readOnly: true
        refund_ids:
          type: array
          description: A list of `refund_id`s identifying refunds for the payment.
          readOnly: true
          items:
            type: string
        risk_evaluation:
          $ref: '#/components/schemas/RiskEvaluation'
        buyer_email_address:
          maxLength: 255
          type: string
          description: The buyer's email address.
          readOnly: true
        billing_address:
          $ref: '#/components/schemas/Address'
        shipping_address:
          $ref: '#/components/schemas/Address'
        note:
          maxLength: 500
          type: string
          description: An optional note to include when creating a payment.
          readOnly: true
        statement_description_identifier:
          type: string
          description: |-
            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.
          readOnly: true
        capabilities:
          type: array
          description: |-
            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.
          readOnly: true
          items:
            type: string
        receipt_number:
          maxLength: 4
          type: string
          description: |-
            The payment's receipt number.
            The field is missing if a payment is canceled.
          readOnly: true
        receipt_url:
          maxLength: 255
          type: string
          description: |-
            The URL for the payment's receipt.
            The field is only populated for COMPLETED payments.
          readOnly: true
        device_details:
          $ref: '#/components/schemas/DeviceDetails'
        application_details:
          $ref: '#/components/schemas/ApplicationDetails'
        version_token:
          type: string
          description: |-
            Used for optimistic concurrency. This opaque token identifies a specific version of the
            `Payment` object.
      description: Represents a payment processed by the Square API.
      x-property-order:
      - id
      - created_at
      - updated_at
      - amount_money
      - tip_money
      - tax_money
      - total_money
      - app_fee_money
      - approved_money
      - payment_fees_spec
      - processing_fee
      - app_processing_fee
      - refunded_money
      - status
      - delay_duration
      - delay_action
      - delayed_until
      - source_type
      - card_details
      - balance_details
      - cash_details
      - bank_account_details
      - external_details
      - wallet_details
      - buy_now_pay_later_details
      - square_account_details
      - location_id
      - order_id
      - reference_id
      - customer_id
      - employee_id
      - team_member_id
      - refund_ids
      - dispute_ids
      - risk_evaluation
      - terminal_checkout_id
      - account_id
      - buyer_email_address
      - billing_address
      - shipping_address
      - note
      - statement_description_identifier
      - capabilities
      - disabled_capabilities
      - receipt_number
      - receipt_url
      - refund_policy
      - recurring_details
      - device_details
      - application_details
      - foreign_exchange
      - version_token
      - version
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_model.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: Payment
    PaymentOptions:
      type: object
      properties:
        autocomplete:
          type: boolean
          description: |-
            Indicates whether the `Payment` objects created from this `TerminalCheckout` are automatically
            `COMPLETED` or left in an `APPROVED` state for later modification.
        delay_duration:
          type: string
          description: |-
            The duration of time after the payment's creation when Square automatically cancels the
            payment. This automatic cancellation applies only to payments that do not reach a terminal state
            (COMPLETED, CANCELED, or FAILED) 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.

            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.
        accept_partial_authorization:
          type: boolean
          description: |-
            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`.
            This field cannot be `true` when an `order_id` isn't specified.

            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
      x-property-order:
      - autocomplete
      - delay_duration
      - accept_partial_authorization
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkout_options.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: PaymentOptions
    PaymentRefund:
      required:
      - amount_money
      - id
      type: object
      properties:
        id:
          maxLength: 255
          minLength: 1
          type: string
          description: The unique ID for this refund, generated by Square.
        status:
          maxLength: 50
          type: string
          description: |-
            The refund's status:
            - `PENDING` - Awaiting approval.
            - `COMPLETED` - Successfully completed.
            - `REJECTED` - The refund was rejected.
            - `FAILED` - An error occurred.
        location_id:
          maxLength: 50
          type: string
          description: The location ID associated with the payment this refund is
            attached to.
        amount_money:
          $ref: '#/components/schemas/Money'
        app_fee_money:
          $ref: '#/components/schemas/Money'
        processing_fee:
          type: array
          description: Processing fees and fee adjustments assessed by Square for
            this refund.
          items:
            $ref: '#/components/schemas/ProcessingFee'
        payment_id:
          maxLength: 192
          type: string
          description: The ID of the payment associated with this refund.
        order_id:
          maxLength: 192
          type: string
          description: The ID of the order associated with the refund.
        reason:
          maxLength: 192
          type: string
          description: The reason for the refund.
        created_at:
          maxLength: 32
          type: string
          description: The timestamp of when the refund was created, in RFC 3339 format.
          readOnly: true
        updated_at:
          maxLength: 32
          type: string
          description: The timestamp of when the refund was last updated, in RFC 3339
            format.
          readOnly: true
        team_member_id:
          maxLength: 192
          type: string
          description: An optional ID of the team member associated with taking the
            payment.
          readOnly: true
      description: |-
        Represents a refund of a payment made using Square. Contains information about
        the original payment and the amount of money refunded.
      x-property-order:
      - id
      - status
      - account_id
      - location_id
      - unlinked
      - destination_type
      - destination_subtype
      - amount_money
      - app_fee_money
      - refund_fees_spec
      - processing_fee
      - app_processing_fee
      - payment_id
      - order_id
      - reason
      - created_at
      - updated_at
      - team_member_id
      - device_details
      - foreign_exchange
      - version
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/refunds_model.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: PaymentRefund
    ProcessingFee:
      type: object
      properties:
        effective_at:
          type: string
          description: The timestamp of when the fee takes effect, in RFC 3339 format.
        type:
          type: string
          description: The type of fee assessed or adjusted. The fee type can be `INITIAL`
            or `ADJUSTMENT`.
        amount_money:
          $ref: '#/components/schemas/Money'
      description: Represents the Square processing fee.
      x-property-order:
      - effective_at
      - type
      - amount_money
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_model.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: ProcessingFee
    RefundPaymentRequest:
      required:
      - amount_money
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          minLength: 1
          type: string
          description: |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).
        amount_money:
          $ref: '#/components/schemas/Money'
        app_fee_money:
          $ref: '#/components/schemas/Money'
        payment_id:
          type: string
          description: The unique ID of the payment being refunded. Must be provided
            and non-empty.
        reason:
          maxLength: 192
          type: string
          description: A description of the reason for the refund.
        payment_version_token:
          type: string
          description: |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.
          x-release-status: BETA
        team_member_id:
          maxLength: 192
          type: string
          description: An optional [TeamMember](entity:TeamMember) ID to associate
            with this refund.
      description: Describes a request to refund a payment using [RefundPayment](api-endpoint:Refunds-RefundPayment).
      example:
        idempotency_key: 9b7f2dcf-49da-4411-b23e-a2d6af21333a
        payment_id: R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY
        amount_money:
          amount: 1000
          currency: USD
        app_fee_money:
          amount: 10
          currency: USD
        reason: Example
      x-property-order:
      - idempotency_key
      - amount_money
      - app_fee_money
      - refund_fees_spec
      - payment_id
      - order_id
      - destination_id
      - unlinked
      - location_id
      - customer_id
      - reason
      - payment_version_token
      - team_member_id
      - device_details
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/refunds_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: RefundPaymentRequest
    RefundPaymentResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        refund:
          $ref: '#/components/schemas/PaymentRefund'
      description: |-
        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`.
      example:
        refund:
          id: R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY_KlWP8IC1557ddwc9QWTKrCVU6m0JXDz15R2Qym5eQfR
          status: PENDING
          amount_money:
            amount: 1000
            currency: USD
          payment_id: R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY
          order_id: 1JLEUZeEooAIX8HMqm9kvWd69aQZY
          created_at: 2021-10-13T21:23:19.116Z
          updated_at: 2021-10-13T21:23:19.508Z
          app_fee_money:
            amount: 10
            currency: USD
          location_id: L88917AVBK2S5
          reason: Example
      x-property-order:
      - errors
      - refund
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/refunds_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: RefundPaymentResponse
    ResumeSubscriptionRequest:
      type: object
      properties:
        resume_effective_date:
          type: string
          description: The `YYYY-MM-DD`-formatted date when the subscription reactivated.
          x-release-status: BETA
        resume_change_timing:
          $ref: '#/components/schemas/ChangeTiming'
      description: |-
        Defines input parameters in a request to the
        [ResumeSubscription](api-endpoint:Subscriptions-ResumeSubscription) endpoint.
      x-property-order:
      - resume_effective_date
      - resume_change_timing
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: ResumeSubscriptionRequest
    ResumeSubscriptionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        subscription:
          $ref: '#/components/schemas/Subscription'
        actions:
          type: array
          description: A list of `RESUME` actions created by the request and scheduled
            for the subscription.
          items:
            $ref: '#/components/schemas/SubscriptionAction'
          x-release-status: BETA
      description: "Defines output parameters in a response from the \n[ResumeSubscription](api-endpoint:Subscriptions-ResumeSubscription)\
        \ endpoint."
      example:
        subscription:
          id: 9ba40961-995a-4a3d-8c53-048c40cafc13
          location_id: S8GWD5R9QB376
          plan_id: 6JHXF3B2CW3YKHDV4XEM674H
          customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G
          status: ACTIVE
          price_override_money:
            amount: 2000
            currency: USD
          version: 1594311617331
          created_at: 2021-10-20T21:53:10Z
          timezone: America/Los_Angeles
          source:
            name: My App
        actions:
        - id: 18ff74f4-3da4-30c5-929f-7d6fca84f115
          type: RESUME
          effective_date: 2022-01-01
      x-property-order:
      - errors
      - subscription
      - actions
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: ResumeSubscriptionResponse
    RetrieveDisputeEvidenceRequest:
      type: object
      properties: {}
      description: Defines the parameters for a `RetrieveDisputeEvidence` request.
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_evidence.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: RetrieveDisputeEvidenceRequest
    RetrieveDisputeEvidenceResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        evidence:
          $ref: '#/components/schemas/DisputeEvidence'
      description: Defines the fields in a `RetrieveDisputeEvidence` response.
      example:
        evidence:
          dispute_id: bVTprrwk0gygTLZ96VX1oB
          evidence_file:
            filename: customer-interaction.jpg
            filetype: image/jpeg
          uploaded_at: 2022-05-18T16:01:10.000Z
          evidence_type: CARDHOLDER_COMMUNICATION
          id: TOomLInj6iWmP3N8qfCXrB
      x-property-order:
      - errors
      - evidence
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes_evidence.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: RetrieveDisputeEvidenceResponse
    RetrieveDisputeRequest:
      type: object
      properties: {}
      description: Defines the request parameters for the `RetrieveDispute` endpoint.
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: RetrieveDisputeRequest
    RetrieveDisputeResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        dispute:
          $ref: '#/components/schemas/Dispute'
      description: Defines fields in a `RetrieveDispute` response.
      example:
        dispute:
          amount_money:
            amount: 2500
            currency: USD
          reason: NO_KNOWLEDGE
          state: ACCEPTED
          due_at: 2022-07-13T00:00:00.000Z
          disputed_payment:
            payment_id: zhyh1ch64kRBrrlfVhwjCEjZWzNZY
          card_brand: VISA
          created_at: 2022-06-29T18:45:22.265Z
          updated_at: 2022-07-07T19:14:42.650Z
          brand_dispute_id: "100000809947"
          version: 2
          location_id: L1HN3ZMQK64X9
          id: XDgyFu7yo1E2S5lQGGpYn
          reported_at: 2022-06-29T00:00:00.000Z
      x-property-order:
      - errors
      - dispute
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: RetrieveDisputeResponse
    RetrieveSubscriptionRequest:
      type: object
      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
      description: "Defines input parameters in a request to the \n[RetrieveSubscription](api-endpoint:Subscriptions-RetrieveSubscription)\
        \ endpoint."
      x-property-order:
      - include
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: RetrieveSubscriptionRequest
    RetrieveSubscriptionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        subscription:
          $ref: '#/components/schemas/Subscription'
      description: |-
        Defines output parameters in a response from the
        [RetrieveSubscription](api-endpoint:Subscriptions-RetrieveSubscription) endpoint.
      example:
        subscription:
          id: 8151fc89-da15-4eb9-a685-1a70883cebfc
          location_id: S8GWD5R9QB376
          plan_id: 6JHXF3B2CW3YKHDV4XEM674H
          customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G
          start_date: 2021-10-20
          charged_through_date: 2021-11-20
          status: ACTIVE
          invoice_ids:
          - grebK0Q_l8H4fqoMMVvt-Q
          - rcX_i3sNmHTGKhI4W2mceA
          price_override_money:
            amount: 1000
            currency: USD
          created_at: 2021-10-20T21:53:10Z
          paid_until_date: 2021-11-20
          timezone: America/Los_Angeles
          source:
            name: My App
      x-property-order:
      - errors
      - subscription
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: RetrieveSubscriptionResponse
    RiskEvaluation:
      required:
      - status
      type: object
      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: |-
        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).
      x-property-order:
      - status
      - level
      - numeric_score
      - reasons
      - rules_flagged
      - action
      - created_at
      - risk_level
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /riskml-common/risk-evaluation-external/src/main/proto/squareup/riskevaluation/external/risk_evaluation.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: RiskEvaluation
    SaveCardOptions:
      required:
      - customer_id
      type: object
      properties:
        customer_id:
          type: string
          description: The square-assigned ID of the customer linked to the saved
            card.
        card_id:
          maxLength: 64
          type: string
          description: The id of the created card-on-file.
          readOnly: true
        reference_id:
          maxLength: 128
          type: string
          description: |-
            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.
      description: Describes save-card action fields.
      x-property-order:
      - customer_id
      - card_id
      - reference_id
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/save_card_options.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: SaveCardOptions
    SearchSubscriptionsFilter:
      type: object
      properties:
        customer_ids:
          type: array
          description: A filter to select subscriptions based on the subscribing customer
            IDs.
          items:
            type: string
        location_ids:
          type: array
          description: A filter to select subscriptions based on the location.
          items:
            type: string
        source_names:
          type: array
          description: A filter to select subscriptions based on the source application.
          items:
            type: string
          x-release-status: BETA
      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-property-order:
      - customer_ids
      - location_ids
      - source_names
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: SearchSubscriptionsFilter
    SearchSubscriptionsQuery:
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/SearchSubscriptionsFilter'
      description: Represents a query, consisting of specified query expressions,
        used to search for subscriptions.
      x-property-order:
      - filter
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: SearchSubscriptionsQuery
    SearchSubscriptionsRequest:
      type: object
      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/working-with-apis/pagination)."
        limit:
          minimum: 1
          type: integer
          description: |-
            The upper limit on the number of subscriptions to return
            in a paged response.
        query:
          $ref: '#/components/schemas/SearchSubscriptionsQuery'
        include:
          type: array
          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."
          items:
            type: string
          x-release-status: BETA
      description: "Defines input parameters in a request to the \n[SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions)\
        \ endpoint."
      example:
        query:
          filter:
            location_ids:
            - S8GWD5R9QB376
            customer_ids:
            - CHFGVKYY8RSV93M5KCYTG4PN0G
            source_names:
            - My App
      x-property-order:
      - location_ids
      - customer_ids
      - cursor
      - limit
      - query
      - include
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: SearchSubscriptionsRequest
    SearchSubscriptionsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        subscriptions:
          type: array
          description: The subscriptions matching the specified query expressions.
          items:
            $ref: '#/components/schemas/Subscription'
        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/working-with-apis/pagination)."
      description: |-
        Defines output parameters in a response from the
        [SearchSubscriptions](api-endpoint:Subscriptions-SearchSubscriptions) endpoint.
      example:
        subscriptions:
        - id: de86fc96-8664-474b-af1a-abbe59cacf0e
          location_id: S8GWD5R9QB376
          plan_id: L3TJVDHVBEQEGQDEZL2JJM7R
          customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G
          start_date: 2021-10-20
          canceled_date: 2021-10-20
          charged_through_date: 2021-11-20
          status: CANCELED
          created_at: 2021-10-20T21:53:10Z
          card_id: ccof:mueUsvgajChmjEbp4GB
          paid_until_date: 2021-11-20
          timezone: UTC
          source:
            name: My Application
        - id: 56214fb2-cc85-47a1-93bc-44f3766bb56f
          location_id: S8GWD5R9QB376
          plan_id: 6JHXF3B2CW3YKHDV4XEM674H
          customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G
          start_date: 2021-10-20
          status: PENDING
          tax_percentage: "5"
          price_override_money:
            amount: 100
            currency: USD
          version: 1594155459464
          created_at: 2021-10-20T21:53:10Z
          timezone: America/Los_Angeles
          source:
            name: My Application
        - id: 8151fc89-da15-4eb9-a685-1a70883cebfc
          location_id: S8GWD5R9QB376
          plan_id: 6JHXF3B2CW3YKHDV4XEM674H
          customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G
          start_date: 2021-10-20
          charged_through_date: 2021-11-20
          status: ACTIVE
          invoice_ids:
          - grebK0Q_l8H4fqoMMVvt-Q
          - rcX_i3sNmHTGKhI4W2mceA
          price_override_money:
            amount: 1000
            currency: USD
          created_at: 2021-10-20T21:53:10Z
          paid_until_date: 2021-11-20
          timezone: America/Los_Angeles
          source:
            name: My Application
      x-property-order:
      - errors
      - subscriptions
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: SearchSubscriptionsResponse
    SearchTerminalActionsRequest:
      type: object
      properties:
        query:
          $ref: '#/components/schemas/TerminalActionQuery'
        cursor:
          type: string
          description: |-
            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/basics/api101/pagination) for more
            information.
        limit:
          maximum: 100
          minimum: 1
          type: integer
          description: Limit the number of results returned for a single request.
      example:
        limit: 2
        query:
          sort:
            sort_order: DESC
          filter:
            created_at:
              start_at: 2022-04-01T00:00:00.000Z
      x-property-order:
      - query
      - cursor
      - limit
      - include
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_actions.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: SearchTerminalActionsRequest
    SearchTerminalActionsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        action:
          type: array
          description: The requested search result of `TerminalAction`s.
          items:
            $ref: '#/components/schemas/TerminalAction'
        cursor:
          type: string
          description: |-
            The pagination cursor to be used in a subsequent request. If empty,
            this is the final response.

            See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more
            information.
      example:
        action:
        - id: termapia:oBGWlAats8xWCiCE
          device_id: DEVICE_ID
          deadline_duration: PT5M
          status: IN_PROGRESS
          created_at: 2022-04-08T15:14:04.895Z
          updated_at: 2022-04-08T15:14:05.446Z
          location_id: LOCATION_ID
          type: SAVE_CARD
          app_id: APP_ID
          save_card_options:
            customer_id: CUSTOMER_ID
            reference_id: user-id-1
        - id: termapia:K2NY2YSSml3lTiCE
          device_id: DEVICE_ID
          deadline_duration: PT5M
          status: COMPLETED
          created_at: 2022-04-08T15:14:01.210Z
          updated_at: 2022-04-08T15:14:09.861Z
          location_id: LOCATION_ID
          type: SAVE_CARD
          app_id: APP_ID
          save_card_options:
            customer_id: CUSTOMER_ID
            card_id: ccof:CARD_ID
            reference_id: user-id-1
        cursor: CURSOR
      x-property-order:
      - errors
      - action
      - cursor
      - included_resources
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_actions.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: SearchTerminalActionsResponse
    SearchTerminalCheckoutsRequest:
      type: object
      properties:
        query:
          $ref: '#/components/schemas/TerminalCheckoutQuery'
        cursor:
          type: string
          description: |-
            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/basics/api101/pagination) for more information.
        limit:
          maximum: 100
          minimum: 1
          type: integer
          description: Limits the number of results returned for a single request.
      example:
        limit: 2
        query:
          filter:
            status: COMPLETED
      x-property-order:
      - query
      - cursor
      - limit
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkouts.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: SearchTerminalCheckoutsRequest
    SearchTerminalCheckoutsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        checkouts:
          type: array
          description: The requested search result of `TerminalCheckout` objects.
          items:
            $ref: '#/components/schemas/TerminalCheckout'
        cursor:
          type: string
          description: |-
            The pagination cursor to be used in a subsequent request. If empty,
            this is the final response.

            See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.
      example:
        checkouts:
        - id: tsQPvzwBpMqqO
          amount_money:
            amount: 2610
            currency: USD
          reference_id: id14467
          note: A brief note
          device_options:
            device_id: dbb5d83a-7838-11ea-bc55-0242ac130003
            tip_settings:
              allow_tipping: false
            skip_receipt_screen: false
          status: COMPLETED
          payment_ids:
          - rXnhZzywrEk4vR6pw76fPZfgvaB
          created_at: 2020-03-31T18:13:15.921Z
          updated_at: 2020-03-31T18:13:52.725Z
          app_id: APP_ID
          deadline_duration: PT10M
        - id: XlOPTgcEhrbqO
          amount_money:
            amount: 2610
            currency: USD
          reference_id: id41623
          note: A brief note
          device_options:
            device_id: dbb5d83a-7838-11ea-bc55-0242ac130003
            tip_settings:
              allow_tipping: false
            skip_receipt_screen: true
          status: COMPLETED
          payment_ids:
          - VYBF861PaoKPP7Pih0TlbZiNvaB
          created_at: 2020-03-31T18:08:31.882Z
          updated_at: 2020-03-31T18:08:41.635Z
          app_id: APP_ID
          deadline_duration: PT10M
        cursor: RiTJqBoTuXlbLmmrPvEkX9iG7XnQ4W4RjGnH
      x-property-order:
      - errors
      - checkouts
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkouts.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: SearchTerminalCheckoutsResponse
    SearchTerminalRefundsRequest:
      type: object
      properties:
        query:
          $ref: '#/components/schemas/TerminalRefundQuery'
        cursor:
          type: string
          description: |-
            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:
          maximum: 100
          minimum: 1
          type: integer
          description: Limits the number of results returned for a single request.
      example:
        limit: 1
        query:
          filter:
            status: COMPLETED
      x-property-order:
      - query
      - cursor
      - limit
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_refunds.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: SearchTerminalRefundsRequest
    SearchTerminalRefundsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        refunds:
          type: array
          description: The requested search result of `TerminalRefund` objects.
          items:
            $ref: '#/components/schemas/TerminalRefund'
        cursor:
          type: string
          description: |-
            The pagination cursor to be used in a subsequent request. If empty,
            this is the final response.

            See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.
      example:
        refunds:
        - id: 009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY
          refund_id: 5O5OvgkcNUhl7JBuINflcjKqUzXZY_43Q4iGp7sNeATiWrUruA1EYeMRUXaddXXlDDJ1EQLvb
          payment_id: 5O5OvgkcNUhl7JBuINflcjKqUzXZY
          amount_money:
            amount: 111
            currency: CAD
          reason: Returning item
          device_id: f72dfb8e-4d65-4e56-aade-ec3fb8d33291
          deadline_duration: PT5M
          status: COMPLETED
          created_at: 2020-09-29T15:21:46.771Z
          updated_at: 2020-09-29T15:21:48.675Z
          app_id: sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ
          card:
            card_brand: INTERAC
            last_4: "1111"
            exp_month: 1
            exp_year: 2022
            fingerprint: sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw
            card_type: CREDIT
            bin: "411111"
          order_id: kcuKDKreRaI4gF4TjmEgZjHk8Z7YY
          location_id: 76C9W6K8CNNQ5
      x-property-order:
      - errors
      - refunds
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_refunds.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: SearchTerminalRefundsResponse
    SubmitEvidenceRequest:
      type: object
      properties: {}
      description: Defines the parameters for a `SubmitEvidence` request.
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: SubmitEvidenceRequest
    SubmitEvidenceResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        dispute:
          $ref: '#/components/schemas/Dispute'
      description: Defines the fields in a `SubmitEvidence` response.
      example:
        dispute:
          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
          card_brand: VISA
          created_at: 2022-05-18T16:02:15.313Z
          updated_at: 2022-05-18T16:02:15.313Z
          brand_dispute_id: "100000399240"
          version: 4
          location_id: LSY8XKGSMMX94
          id: EAZoK70gX3fyvibecLwIGB
          reported_at: 2022-05-18T00:00:00.000Z
      x-property-order:
      - errors
      - dispute
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payments/marketplaces-api/src/main/proto/squareup/payments/external/disputes.proto
      x-proto-sha: a8cc733f22f24cf447697687be1c88ef333e0028
      x-object-name: SubmitEvidenceResponse
    Subscription:
      type: object
      properties:
        id:
          maxLength: 255
          type: string
          description: The Square-assigned ID of the subscription.
          readOnly: true
        location_id:
          type: string
          description: The ID of the location associated with the subscription.
          readOnly: true
        plan_id:
          type: string
          description: The ID of the subscribed-to [subscription plan](entity:CatalogSubscriptionPlan).
          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."
        charged_through_date:
          type: string
          description: |-
            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.
          readOnly: true
        status:
          $ref: '#/components/schemas/SubscriptionStatus'
        tax_percentage:
          type: string
          description: |-
            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: array
          description: |-
            The IDs of the [invoices](entity:Invoice) created for the
            subscription, listed in order when the invoices were created
            (newest invoices appear first).
          readOnly: true
          items:
            type: string
        price_override_money:
          $ref: '#/components/schemas/Money'
        version:
          type: integer
          description: |-
            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.
          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)
            used to charge for the subscription.
        paid_until_date:
          type: string
          description: |-
            The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) 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.
          readOnly: true
          x-release-status: RETIRED
        timezone:
          type: string
          description: |-
            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`).
          readOnly: true
        source:
          $ref: '#/components/schemas/SubscriptionSource'
        actions:
          type: array
          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\"]`."
          items:
            $ref: '#/components/schemas/SubscriptionAction'
          x-release-status: BETA
      description: |-
        Represents a subscription to a subscription plan by a subscriber.

        For an overview of the `Subscription` type, see
        [Subscription object](https://developer.squareup.com/docs/subscriptions-api/overview#subscription-object-overview).
      x-property-order:
      - id
      - location_id
      - plan_id
      - customer_id
      - start_date
      - canceled_date
      - charged_through_date
      - status
      - tax_percentage
      - invoice_ids
      - price_override_money
      - buyer_self_management_token
      - version
      - created_at
      - card_id
      - paid_until_date
      - timezone
      - order_template_id
      - note
      - bank_account_id
      - source
      - actions
      - billing_cycle_date
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: Subscription
    SubscriptionAction:
      type: object
      properties:
        id:
          type: string
          description: The ID of an action scoped to a subscription.
        type:
          $ref: '#/components/schemas/SubscriptionActionType'
        effective_date:
          type: string
          description: The `YYYY-MM-DD`-formatted date when the action occurs on the
            subscription.
        new_plan_id:
          type: string
          description: The target subscription plan a subscription switches to, for
            a `SWAP_PLAN` action.
      description: Represents an action as a pending change to a subscription.
      x-property-order:
      - id
      - type
      - effective_date
      - new_plan_id
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: SubscriptionAction
    SubscriptionEvent:
      required:
      - effective_date
      - id
      - plan_id
      - subscription_event_type
      type: object
      properties:
        id:
          type: string
          description: The ID of the subscription event.
        subscription_event_type:
          $ref: '#/components/schemas/SubscriptionEventSubscriptionEventType'
        effective_date:
          type: string
          description: The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) when
            the subscription event occurred.
        plan_id:
          type: string
          description: The ID of the subscription plan associated with the subscription.
        info:
          $ref: '#/components/schemas/SubscriptionEventInfo'
      description: Describes changes to a subscription and the subscription status.
      x-property-order:
      - id
      - subscription_event_type
      - effective_date
      - plan_id
      - info
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: SubscriptionEvent
    SubscriptionEventInfo:
      type: object
      properties:
        detail:
          type: string
          description: A human-readable explanation for the event.
        code:
          $ref: '#/components/schemas/SubscriptionEventInfoCode'
      description: Provides information about the subscription event.
      x-property-order:
      - detail
      - code
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: SubscriptionEventInfo
    SubscriptionSource:
      type: object
      properties:
        name:
          maxLength: 255
          type: string
          description: |-
            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.
          readOnly: true
      description: The origination details of the subscription.
      x-property-order:
      - name
      - application_name
      - application_id
      - square_product
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: SubscriptionSource
    SwapPlanRequest:
      required:
      - new_plan_id
      type: object
      properties:
        new_plan_id:
          minLength: 1
          type: string
          description: The ID of the new subscription plan.
          readOnly: true
      description: "Defines input parameters in a call to the \n[SwapPlan](api-endpoint:Subscriptions-SwapPlan)\
        \ endpoint."
      x-property-order:
      - new_plan_id
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: SwapPlanRequest
    SwapPlanResponse:
      type: object
      properties:
        errors:
          type: array
          description: Errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        subscription:
          $ref: '#/components/schemas/Subscription'
        actions:
          type: array
          description: A list of a `SWAP_PLAN` action created by the request.
          items:
            $ref: '#/components/schemas/SubscriptionAction'
      description: "Defines output parameters in a response of the \n[SwapPlan](api-endpoint:Subscriptions-SwapPlan)\
        \ endpoint."
      example:
        subscription:
          id: 9ba40961-995a-4a3d-8c53-048c40cafc13
          location_id: S8GWD5R9QB376
          plan_id: 6JHXF3B2CW3YKHDV4XEM674H
          customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G
          status: ACTIVE
          price_override_money:
            amount: 2000
            currency: USD
          version: 1594311617331
          created_at: 2021-10-20T21:53:10Z
          timezone: America/Los_Angeles
          source:
            name: My App
        actions:
        - id: f0a1dfdc-675b-3a14-a640-99f7ac1cee83
          type: SWAP_PLAN
          effective_date: 2021-11-17
          new_plan_id: DPNEOJAP33DKC3GAC5CAZG4O
      x-property-order:
      - errors
      - subscription
      - actions
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: SwapPlanResponse
    TerminalAction:
      type: object
      properties:
        id:
          maxLength: 255
          minLength: 10
          type: string
          description: A unique ID for this `TerminalAction`.
          readOnly: true
        device_id:
          type: string
          description: |-
            The unique Id of the device intended for this `TerminalAction`.
            The Id can be retrieved from /v2/devices api.
        deadline_duration:
          type: string
          description: |-
            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: string
          description: |-
            The status of the `TerminalAction`.
            Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`
          readOnly: true
        cancel_reason:
          $ref: '#/components/schemas/ActionCancelReason'
        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
        type:
          $ref: '#/components/schemas/TerminalActionActionType'
        save_card_options:
          $ref: '#/components/schemas/SaveCardOptions'
        device_metadata:
          $ref: '#/components/schemas/DeviceMetadata'
      description: Represents an action processed by the Square Terminal.
      x-property-order:
      - id
      - device_id
      - deadline_duration
      - session_id
      - autocomplete_session
      - status
      - cancel_reason
      - created_at
      - updated_at
      - app_id
      - location_id
      - metadata
      - type
      - ping_options
      - qr_code_options
      - checkout_options
      - refund_options
      - save_card_options
      - signature_options
      - confirmation_options
      - receipt_options
      - data_collection_options
      - select_options
      - stack_options
      - config_options
      - device_metadata
      - owner_token
      - target_token
      - completable
      - client_completed
      - complete_requested
      - cancel_requested
      - request_context_token
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_actions.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: TerminalAction
    TerminalActionQuery:
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/TerminalActionQueryFilter'
        sort:
          $ref: '#/components/schemas/TerminalActionQuerySort'
      example:
        query:
          filter:
            status: COMPLETED
        limit: 2
        include:
        - CUSTOMER
      x-property-order:
      - filter
      - sort
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_actions.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: TerminalActionQuery
    TerminalActionQueryFilter:
      type: object
      properties:
        device_id:
          type: string
          description: |-
            `TerminalAction`s associated with a specific device. If no device is specified then all
            `TerminalAction`s for the merchant will be displayed.
        created_at:
          $ref: '#/components/schemas/TimeRange'
        status:
          type: string
          description: |-
            Filter results with the desired status of the `TerminalAction`
            Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`
        type:
          $ref: '#/components/schemas/TerminalActionActionType'
      x-property-order:
      - device_id
      - created_at
      - status
      - type
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_actions.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: TerminalActionQueryFilter
    TerminalActionQuerySort:
      type: object
      properties:
        sort_order:
          $ref: '#/components/schemas/SortOrder'
      x-property-order:
      - sort_order
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_actions.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: TerminalActionQuerySort
    TerminalCheckout:
      required:
      - amount_money
      - device_options
      type: object
      properties:
        id:
          maxLength: 255
          minLength: 10
          type: string
          description: A unique ID for this `TerminalCheckout`.
          readOnly: true
        amount_money:
          $ref: '#/components/schemas/Money'
        reference_id:
          maxLength: 40
          type: string
          description: |-
            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:
          maxLength: 500
          type: string
          description: |-
            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:
          type: string
          description: The reference to the Square order ID for the checkout request.
            Supported only in the US.
          x-release-status: BETA
        payment_options:
          $ref: '#/components/schemas/PaymentOptions'
        device_options:
          $ref: '#/components/schemas/DeviceCheckoutOptions'
        deadline_duration:
          type: string
          description: |-
            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: string
          description: |-
            The status of the `TerminalCheckout`.
            Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`
          readOnly: true
        cancel_reason:
          $ref: '#/components/schemas/ActionCancelReason'
        payment_ids:
          type: array
          description: A list of IDs for payments created by this `TerminalCheckout`.
          readOnly: true
          items:
            type: string
        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.
          readOnly: true
        payment_type:
          $ref: '#/components/schemas/CheckoutOptionsPaymentType'
        customer_id:
          type: string
          description: An optional ID of the customer associated with the checkout.
        app_fee_money:
          $ref: '#/components/schemas/Money'
      description: Represents a checkout processed by the Square Terminal.
      x-property-order:
      - id
      - type
      - amount_money
      - reference_id
      - note
      - order_id
      - allowed_payment_methods
      - options
      - payment_options
      - device_options
      - deadline
      - deadline_duration
      - status
      - required_input
      - cancel_reason
      - payment_ids
      - created_at
      - updated_at
      - app_id
      - owner_token
      - target_token
      - metadata
      - cancel_reason_deprecated
      - location_id
      - payment_type
      - auxiliary_info
      - revenue_association_tags
      - session_id
      - autocomplete_session
      - team_member_id
      - customer_id
      - app_fee_money
      - request_context_token
      - load_gift_card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkouts.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: TerminalCheckout
    TerminalCheckoutQuery:
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/TerminalCheckoutQueryFilter'
        sort:
          $ref: '#/components/schemas/TerminalCheckoutQuerySort'
      x-property-order:
      - filter
      - sort
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkouts.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: TerminalCheckoutQuery
    TerminalCheckoutQueryFilter:
      type: object
      properties:
        device_id:
          type: string
          description: |-
            The `TerminalCheckout` objects associated with a specific device. If no device is specified, then all
            `TerminalCheckout` objects for the merchant are displayed.
        created_at:
          $ref: '#/components/schemas/TimeRange'
        status:
          type: string
          description: |-
            Filtered results with the desired status of the `TerminalCheckout`.
            Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED`
      x-property-order:
      - device_id
      - created_at
      - status
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkouts.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: TerminalCheckoutQueryFilter
    TerminalCheckoutQuerySort:
      type: object
      properties:
        sort_order:
          $ref: '#/components/schemas/SortOrder'
      x-property-order:
      - sort_order
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkouts.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: TerminalCheckoutQuerySort
    TerminalRefund:
      required:
      - amount_money
      - device_id
      - payment_id
      - reason
      type: object
      properties:
        id:
          maxLength: 255
          minLength: 10
          type: string
          description: A unique ID for this `TerminalRefund`.
          readOnly: true
        refund_id:
          type: string
          description: The reference to the payment refund created by completing this
            `TerminalRefund`.
          readOnly: true
        payment_id:
          minLength: 1
          type: string
          description: The unique ID of the payment being refunded.
        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'
        reason:
          maxLength: 192
          type: string
          description: A description of the reason for the refund.
        device_id:
          type: string
          description: |-
            The unique ID of the device intended for this `TerminalRefund`.
            The Id can be retrieved from /v2/devices api.
        deadline_duration:
          type: string
          description: |-
            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: string
          description: |-
            The status of the `TerminalRefund`.
            Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or `COMPLETED`.
          readOnly: true
        cancel_reason:
          $ref: '#/components/schemas/ActionCancelReason'
        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.
          readOnly: true
      description: Represents a payment refund processed by the Square Terminal. Only
        supports Interac (Canadian debit network) payment refunds.
      x-property-order:
      - id
      - refund_id
      - payment_id
      - card_details
      - order_id
      - amount_money
      - reason
      - device_id
      - reference_id_deprecated
      - note_deprecated
      - deadline_duration
      - status
      - cancel_reason
      - created_at
      - updated_at
      - app_id
      - metadata
      - card
      - location_id
      - session_id
      - autocomplete_session
      - return_order_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_refunds.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: TerminalRefund
    TerminalRefundQuery:
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/TerminalRefundQueryFilter'
        sort:
          $ref: '#/components/schemas/TerminalRefundQuerySort'
      x-property-order:
      - filter
      - sort
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_refunds.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: TerminalRefundQuery
    TerminalRefundQueryFilter:
      type: object
      properties:
        device_id:
          type: string
          description: |-
            `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:
          $ref: '#/components/schemas/TimeRange'
        status:
          type: string
          description: |-
            Filtered results with the desired status of the `TerminalRefund`.
            Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or `COMPLETED`.
      x-property-order:
      - device_id
      - created_at
      - status
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_refunds.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: TerminalRefundQueryFilter
    TerminalRefundQuerySort:
      type: object
      properties:
        sort_order:
          type: string
          description: |-
            The order in which results are listed.
            - `ASC` - Oldest to newest.
            - `DESC` - Newest to oldest (default).
      x-property-order:
      - sort_order
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_refunds.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: TerminalRefundQuerySort
    TipSettings:
      type: object
      properties:
        allow_tipping:
          type: boolean
          description: Indicates whether tipping is enabled for this checkout. Defaults
            to false.
        separate_tip_screen:
          type: boolean
          description: |-
            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: boolean
          description: Indicates whether custom tip amounts are allowed during the
            checkout flow. Defaults to false.
        tip_percentages:
          type: array
          description: |-
            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.
          items:
            type: integer
        smart_tipping:
          type: boolean
          description: |-
            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).
      x-property-order:
      - allow_tipping
      - separate_tip_screen
      - custom_tip_field
      - tip_percentages
      - smart_tipping
      - calculate_tip_before_taxes
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /mango/mango-proto/src/main/proto/squareup/mango/external/terminal_checkout_options.proto
      x-proto-sha: 6bbdf4243b30eab4ffb0bf4c066bbb30c5c99b71
      x-object-name: TipSettings
    UpdatePaymentRequest:
      required:
      - idempotency_key
      type: object
      properties:
        payment:
          $ref: '#/components/schemas/Payment'
        idempotency_key:
          maxLength: 45
          minLength: 1
          type: string
          description: |-
            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/basics/api101/idempotency).
      description: "Describes a request to update a payment using \n[UpdatePayment](api-endpoint:Payments-UpdatePayment)."
      example:
        idempotency_key: 956f8b13-e4ec-45d6-85e8-d1d95ef0c5de
        payment:
          amount_money:
            amount: 1000
            currency: USD
          tip_money:
            amount: 100
            currency: USD
          version_token: ODhwVQ35xwlzRuoZEwKXucfu7583sPTzK48c5zoGd0g6o
      x-property-order:
      - payment
      - idempotency_key
      - request_context_token
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: UpdatePaymentRequest
    UpdatePaymentResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        payment:
          $ref: '#/components/schemas/Payment'
      description: "Defines the response returned by \n[UpdatePayment](api-endpoint:Payments-UpdatePayment)."
      example:
        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
          status: APPROVED
          delay_duration: PT168H
          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
            statement_description: SQ *EXAMPLE TEST GOSQ.C
            card_payment_timeline:
              authorized_at: 2021-10-13T20:26:44.364Z
          location_id: L88917AVBK2S5
          order_id: nUSN9TdxpiK3SrQg3wzmf6r8LP9YY
          risk_evaluation:
            created_at: 2021-10-13T20:26:45.271Z
            risk_level: NORMAL
          note: Example Note
          customer_id: W92WH6P11H4Z77CTET0RNTGFW8
          total_money:
            amount: 1100
            currency: USD
          approved_money:
            amount: 1000
            currency: USD
          capabilities:
          - EDIT_AMOUNT_UP
          - EDIT_AMOUNT_DOWN
          - EDIT_TIP_AMOUNT_UP
          - EDIT_TIP_AMOUNT_DOWN
          receipt_number: 1Qjq
          delay_action: CANCEL
          delayed_until: 2021-10-20T20:26:44.191Z
          application_details:
            square_product: ECOMMERCE_API
            application_id: sq0ids-TcgftTEtKxJTRF1lCFJ9TA
          version_token: rDrXnqiS7fJgexccgdpzmwqTiXui1aIKCp9EchZ7trE6o
      x-property-order:
      - errors
      - payment
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /pago/pago-proto/src/main/proto/squareup/pago/external/payments_api.proto
      x-proto-sha: 495d56e2121254e62dae996ec2126fee007e4ecd
      x-object-name: UpdatePaymentResponse
    UpdateSubscriptionRequest:
      type: object
      properties:
        subscription:
          $ref: '#/components/schemas/Subscription'
      description: "Defines input parameters in a request to the \n[UpdateSubscription](api-endpoint:Subscriptions-UpdateSubscription)\
        \ endpoint."
      example:
        subscription:
          version: 1594155459464
          tax_percentage: null
          price_override_money:
            amount: 2000
            currency: USD
      x-property-order:
      - subscription
      - fields_to_clear
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: UpdateSubscriptionRequest
    UpdateSubscriptionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        subscription:
          $ref: '#/components/schemas/Subscription'
      description: |-
        Defines output parameters in a response from the
        [UpdateSubscription](api-endpoint:Subscriptions-UpdateSubscription) endpoint.
      example:
        subscription:
          id: 9ba40961-995a-4a3d-8c53-048c40cafc13
          location_id: S8GWD5R9QB376
          plan_id: 6JHXF3B2CW3YKHDV4XEM674H
          customer_id: CHFGVKYY8RSV93M5KCYTG4PN0G
          status: ACTIVE
          price_override_money:
            amount: 2000
            currency: USD
          version: 1594311617331
          created_at: 2021-10-20T21:53:10Z
          timezone: America/Los_Angeles
          source:
            name: My App
      x-property-order:
      - errors
      - subscription
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /buyer-subs/buyer-subs-proto/src/main/proto/squareup/buyersubs/external/subscriptions.proto
      x-proto-sha: 281c009ac6961548dae5ce4138d7e3c4fccd642c
      x-object-name: UpdateSubscriptionResponse
    V1CreateRefundRequest:
      required:
      - payment_id
      - reason
      - type
      type: object
      properties:
        payment_id:
          type: string
          description: |-
            The ID of the payment to refund. If you are creating a `PARTIAL`
            refund for a split tender payment, instead provide the id of the
            particular tender you want to refund.
        type:
          $ref: '#/components/schemas/V1CreateRefundRequestType'
        reason:
          type: string
          description: The reason for the refund.
        refunded_money:
          $ref: '#/components/schemas/V1Money'
        request_idempotence_key:
          type: string
          description: An optional key to ensure idempotence if you issue the same
            PARTIAL refund request more than once.
      description: V1CreateRefundRequest
      deprecated: true
      x-property-order:
      - payment_id
      - type
      - reason
      - refunded_money
      - request_idempotence_key
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-refunds.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1CreateRefundRequest
    V1ListPaymentsRequest:
      type: object
      properties:
        order:
          $ref: '#/components/schemas/SortOrder'
        begin_time:
          type: string
          description: 'The beginning of the requested reporting period, in ISO 8601
            format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z),
            this endpoint returns an error. Default value: The current time minus
            one year.'
        end_time:
          type: string
          description: 'The end of the requested reporting period, in ISO 8601 format.
            If this value is more than one year greater than begin_time, this endpoint
            returns an error. Default value: The current time.'
        limit:
          type: integer
          description: The maximum number of payments to return in a single response.
            This value cannot exceed 200.
        batch_token:
          type: string
          description: |-
            A pagination cursor to retrieve the next set of results for your
            original query to the endpoint.
        include_partial:
          type: boolean
          description: Indicates whether or not to include partial payments in the
            response. Partial payments will have the tenders collected so far, but
            the itemizations will be empty until the payment is completed.
      deprecated: true
      x-property-order:
      - order
      - begin_time
      - end_time
      - limit
      - batch_token
      - include_partial
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-payments.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1ListPaymentsRequest
    V1ListPaymentsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/V1Payment'
      deprecated: true
      x-property-order:
      - items
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-payments.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1ListPaymentsResponse
    V1ListRefundsRequest:
      type: object
      properties:
        order:
          $ref: '#/components/schemas/SortOrder'
        begin_time:
          type: string
          description: 'The beginning of the requested reporting period, in ISO 8601
            format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z),
            this endpoint returns an error. Default value: The current time minus
            one year.'
        end_time:
          type: string
          description: 'The end of the requested reporting period, in ISO 8601 format.
            If this value is more than one year greater than begin_time, this endpoint
            returns an error. Default value: The current time.'
        limit:
          type: integer
          description: 'The approximate number of refunds to return in a single response.
            Default: 100. Max: 200. Response may contain more results than the prescribed
            limit when refunds are made simultaneously to multiple tenders in a payment
            or when refunds are generated in an exchange to account for the value
            of returned goods.'
        batch_token:
          type: string
          description: |-
            A pagination cursor to retrieve the next set of results for your
            original query to the endpoint.
      deprecated: true
      x-property-order:
      - order
      - begin_time
      - end_time
      - limit
      - batch_token
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-refunds.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1ListRefundsRequest
    V1ListRefundsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/V1Refund'
      deprecated: true
      x-property-order:
      - items
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-refunds.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1ListRefundsResponse
    V1ListSettlementsRequest:
      type: object
      properties:
        order:
          $ref: '#/components/schemas/SortOrder'
        begin_time:
          type: string
          description: 'The beginning of the requested reporting period, in ISO 8601
            format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z),
            this endpoint returns an error. Default value: The current time minus
            one year.'
        end_time:
          type: string
          description: 'The end of the requested reporting period, in ISO 8601 format.
            If this value is more than one year greater than begin_time, this endpoint
            returns an error. Default value: The current time.'
        limit:
          type: integer
          description: The maximum number of settlements to return in a single response.
            This value cannot exceed 200.
        status:
          $ref: '#/components/schemas/V1ListSettlementsRequestStatus'
        batch_token:
          type: string
          description: |-
            A pagination cursor to retrieve the next set of results for your
            original query to the endpoint.
      deprecated: true
      x-property-order:
      - order
      - begin_time
      - end_time
      - limit
      - status
      - batch_token
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-settlements.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1ListSettlementsRequest
    V1ListSettlementsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/V1Settlement'
      deprecated: true
      x-property-order:
      - items
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-settlements.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1ListSettlementsResponse
    V1ListWebhooksRequest:
      type: object
      properties: {}
      description: V1ListWebhooksRequest
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1webhooks.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1ListWebhooksRequest
      x-visibility: DOC_ONLY
    V1ListWebhooksResponse:
      type: object
      properties:
        events:
          type: array
          description: |-
            A list of webhook event enums.
            See [V1WebhooksEvents](#type-v1webhooksevents) for possible values
          items:
            $ref: '#/components/schemas/V1WebhooksEvents'
      description: V1ListWebhooksResponse
      x-property-order:
      - events
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1webhooks.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1ListWebhooksResponse
      x-visibility: DOC_ONLY
    V1Money:
      type: object
      properties:
        amount:
          type: integer
          description: |-
            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:
          $ref: '#/components/schemas/Currency'
      example:
        amount: 0
        currency_code: UNKNOWN_CURRENCY
      deprecated: true
      x-property-order:
      - amount
      - currency_code
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1common.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1Money
    V1Payment:
      type: object
      properties:
        id:
          type: string
          description: The payment's unique identifier.
        merchant_id:
          type: string
          description: The unique identifier of the merchant that took the payment.
        created_at:
          type: string
          description: The time when the payment was created, in ISO 8601 format.
            Reflects the time of the first payment if the object represents an incomplete
            partial payment, and the time of the last or complete payment otherwise.
        creator_id:
          type: string
          description: The unique identifier of the Square account that took the payment.
        device:
          $ref: '#/components/schemas/Device'
        payment_url:
          type: string
          description: The URL of the payment's detail page in the merchant dashboard.
            The merchant must be signed in to the merchant dashboard to view this
            page.
        receipt_url:
          type: string
          description: |-
            The URL of the receipt for the payment. Note that for split tender
            payments, this URL corresponds to the receipt for the first tender
            listed in the payment's tender field. Each Tender object has its own
            receipt_url field you can use to get the other receipts associated with
            a split tender payment.
        inclusive_tax_money:
          $ref: '#/components/schemas/V1Money'
        additive_tax_money:
          $ref: '#/components/schemas/V1Money'
        tax_money:
          $ref: '#/components/schemas/V1Money'
        tip_money:
          $ref: '#/components/schemas/V1Money'
        discount_money:
          $ref: '#/components/schemas/V1Money'
        total_collected_money:
          $ref: '#/components/schemas/V1Money'
        processing_fee_money:
          $ref: '#/components/schemas/V1Money'
        net_total_money:
          $ref: '#/components/schemas/V1Money'
        refunded_money:
          $ref: '#/components/schemas/V1Money'
        swedish_rounding_money:
          $ref: '#/components/schemas/V1Money'
        gross_sales_money:
          $ref: '#/components/schemas/V1Money'
        net_sales_money:
          $ref: '#/components/schemas/V1Money'
        inclusive_tax:
          type: array
          description: All of the inclusive taxes associated with the payment.
          items:
            $ref: '#/components/schemas/V1PaymentTax'
        additive_tax:
          type: array
          description: All of the additive taxes associated with the payment.
          items:
            $ref: '#/components/schemas/V1PaymentTax'
        tender:
          type: array
          description: All of the tenders associated with the payment.
          items:
            $ref: '#/components/schemas/V1Tender'
        refunds:
          type: array
          description: All of the refunds applied to the payment. Note that the value
            of all refunds on a payment can exceed the value of all tenders if a merchant
            chooses to refund money to a tender after previously accepting returned
            goods as part of an exchange.
          items:
            $ref: '#/components/schemas/V1Refund'
        itemizations:
          type: array
          description: The items purchased in the payment.
          items:
            $ref: '#/components/schemas/V1PaymentItemization'
        surcharge_money:
          $ref: '#/components/schemas/V1Money'
        surcharges:
          type: array
          description: A list of all surcharges associated with the payment.
          items:
            $ref: '#/components/schemas/V1PaymentSurcharge'
        is_partial:
          type: boolean
          description: |-
            Indicates whether or not the payment is only partially paid for.
            If true, this payment will have the tenders collected so far, but the
            itemizations will be empty until the payment is completed.
      description: |-
        A payment represents a paid transaction between a Square merchant and a
        customer. Payment details are usually available from Connect API endpoints
        within a few minutes after the transaction completes.

        Each Payment object includes several fields that end in `_money`. These fields
        describe the various amounts of money that contribute to the payment total:

        <ul>
        <li>
        Monetary values are <b>positive</b> if they represent an
        <em>increase</em> in the amount of money the merchant receives (e.g.,
        <code>tax_money</code>, <code>tip_money</code>).
        </li>
        <li>
        Monetary values are <b>negative</b> if they represent an
        <em>decrease</em> in the amount of money the merchant receives (e.g.,
        <code>discount_money</code>, <code>refunded_money</code>).
        </li>
        </ul>
      example:
        payment_url: payment_url
        is_partial: true
        created_at: created_at
        merchant_id: merchant_id
        additive_tax:
        - null
        - null
        gross_sales_money: null
        refunds:
        - reason: reason
          refunded_tip_money: null
          refunded_additive_tax:
          - null
          - null
          refunded_additive_tax_money: null
          refunded_inclusive_tax_money: null
          created_at: created_at
          refunded_surcharges:
          - applied_money: null
            taxable: true
            rate: rate
            name: name
            taxes:
            - null
            - null
            amount_money: null
            type: UNKNOWN
            surcharge_id: surcharge_id
          - applied_money: null
            taxable: true
            rate: rate
            name: name
            taxes:
            - null
            - null
            amount_money: null
            type: UNKNOWN
            surcharge_id: surcharge_id
          refunded_discount_money: null
          merchant_id: merchant_id
          type: FULL
          is_exchange: true
          refunded_processing_fee_money: null
          payment_id: payment_id
          refunded_surcharge_money: null
          processed_at: processed_at
          refunded_money: null
          refunded_inclusive_tax:
          - null
          - null
          refunded_tax_money: null
        - reason: reason
          refunded_tip_money: null
          refunded_additive_tax:
          - null
          - null
          refunded_additive_tax_money: null
          refunded_inclusive_tax_money: null
          created_at: created_at
          refunded_surcharges:
          - applied_money: null
            taxable: true
            rate: rate
            name: name
            taxes:
            - null
            - null
            amount_money: null
            type: UNKNOWN
            surcharge_id: surcharge_id
          - applied_money: null
            taxable: true
            rate: rate
            name: name
            taxes:
            - null
            - null
            amount_money: null
            type: UNKNOWN
            surcharge_id: surcharge_id
          refunded_discount_money: null
          merchant_id: merchant_id
          type: FULL
          is_exchange: true
          refunded_processing_fee_money: null
          payment_id: payment_id
          refunded_surcharge_money: null
          processed_at: processed_at
          refunded_money: null
          refunded_inclusive_tax:
          - null
          - null
          refunded_tax_money: null
        receipt_url: receipt_url
        id: id
        swedish_rounding_money: null
        discount_money: null
        tender:
        - type: CREDIT_CARD
          tendered_at: tendered_at
          pan_suffix: pan_suffix
          change_back_money: null
          entry_method: MANUAL
          tendered_money: null
          is_exchange: true
          receipt_url: receipt_url
          payment_note: payment_note
          employee_id: employee_id
          name: name
          card_brand: OTHER_BRAND
          id: id
          total_money: null
          settled_at: settled_at
          refunded_money: null
        - type: CREDIT_CARD
          tendered_at: tendered_at
          pan_suffix: pan_suffix
          change_back_money: null
          entry_method: MANUAL
          tendered_money: null
          is_exchange: true
          receipt_url: receipt_url
          payment_note: payment_note
          employee_id: employee_id
          name: name
          card_brand: OTHER_BRAND
          id: id
          total_money: null
          settled_at: settled_at
          refunded_money: null
        itemizations:
        - discount_money: null
          single_quantity_money: null
          quantity: 6.027456183070403
          notes: notes
          taxes:
          - null
          - null
          modifiers:
          - applied_money: null
            name: name
            modifier_option_id: modifier_option_id
          - applied_money: null
            name: name
            modifier_option_id: modifier_option_id
          gross_sales_money: null
          item_detail:
            category_name: category_name
            item_id: item_id
            item_variation_id: item_variation_id
            sku: sku
          discounts:
          - applied_money: null
            name: name
            discount_id: discount_id
          - applied_money: null
            name: name
            discount_id: discount_id
          name: name
          itemization_type: ITEM
          item_variation_name: item_variation_name
          total_money: null
          net_sales_money: null
        - discount_money: null
          single_quantity_money: null
          quantity: 6.027456183070403
          notes: notes
          taxes:
          - null
          - null
          modifiers:
          - applied_money: null
            name: name
            modifier_option_id: modifier_option_id
          - applied_money: null
            name: name
            modifier_option_id: modifier_option_id
          gross_sales_money: null
          item_detail:
            category_name: category_name
            item_id: item_id
            item_variation_id: item_variation_id
            sku: sku
          discounts:
          - applied_money: null
            name: name
            discount_id: discount_id
          - applied_money: null
            name: name
            discount_id: discount_id
          name: name
          itemization_type: ITEM
          item_variation_name: item_variation_name
          total_money: null
          net_sales_money: null
        inclusive_tax:
        - applied_money: null
          rate: rate
          name: name
          fee_id: fee_id
          inclusion_type: ADDITIVE
          errors:
          - code: INTERNAL_SERVER_ERROR
            field: field
            detail: detail
            category: API_ERROR
          - code: INTERNAL_SERVER_ERROR
            field: field
            detail: detail
            category: API_ERROR
        - applied_money: null
          rate: rate
          name: name
          fee_id: fee_id
          inclusion_type: ADDITIVE
          errors:
          - code: INTERNAL_SERVER_ERROR
            field: field
            detail: detail
            category: API_ERROR
          - code: INTERNAL_SERVER_ERROR
            field: field
            detail: detail
            category: API_ERROR
        surcharge_money: null
        processing_fee_money: null
        net_total_money: null
        tip_money: null
        total_collected_money: null
        creator_id: creator_id
        surcharges:
        - null
        - null
        inclusive_tax_money:
          amount: 0
          currency_code: UNKNOWN_CURRENCY
        refunded_money: null
        additive_tax_money: null
        tax_money: null
        device:
          name: name
          id: id
        net_sales_money: null
      deprecated: true
      x-property-order:
      - id
      - merchant_id
      - created_at
      - creator_id
      - device
      - payment_url
      - receipt_url
      - inclusive_tax_money
      - additive_tax_money
      - tax_money
      - tip_money
      - discount_money
      - total_collected_money
      - processing_fee_money
      - net_total_money
      - refunded_money
      - swedish_rounding_money
      - gross_sales_money
      - net_sales_money
      - inclusive_tax
      - additive_tax
      - tender
      - refunds
      - itemizations
      - surcharge_money
      - surcharges
      - is_partial
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-payments.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1Payment
    V1PaymentDiscount:
      type: object
      properties:
        name:
          type: string
          description: The discount's name.
        applied_money:
          $ref: '#/components/schemas/V1Money'
        discount_id:
          type: string
          description: The ID of the applied discount, if available. Discounts applied
            in older versions of Square Register might not have an ID.
      description: V1PaymentDiscount
      example:
        applied_money: null
        name: name
        discount_id: discount_id
      deprecated: true
      x-property-order:
      - name
      - applied_money
      - discount_id
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-payments.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1PaymentDiscount
    V1PaymentItemDetail:
      type: object
      properties:
        category_name:
          type: string
          description: The name of the item's merchant-defined category, if any.
        sku:
          type: string
          description: ' The item''s merchant-defined SKU, if any.'
        item_id:
          type: string
          description: The unique ID of the item purchased, if any.
        item_variation_id:
          type: string
          description: The unique ID of the item variation purchased, if any.
      description: V1PaymentItemDetail
      example:
        category_name: category_name
        item_id: item_id
        item_variation_id: item_variation_id
        sku: sku
      deprecated: true
      x-property-order:
      - category_name
      - sku
      - item_id
      - item_variation_id
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-payments.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1PaymentItemDetail
    V1PaymentItemization:
      type: object
      properties:
        name:
          type: string
          description: The item's name.
        quantity:
          type: number
          description: The quantity of the item purchased. This can be a decimal value.
        itemization_type:
          $ref: '#/components/schemas/V1PaymentItemizationItemizationType'
        item_detail:
          $ref: '#/components/schemas/V1PaymentItemDetail'
        notes:
          type: string
          description: Notes entered by the merchant about the item at the time of
            payment, if any.
        item_variation_name:
          type: string
          description: The name of the item variation purchased, if any.
        total_money:
          $ref: '#/components/schemas/V1Money'
        single_quantity_money:
          $ref: '#/components/schemas/V1Money'
        gross_sales_money:
          $ref: '#/components/schemas/V1Money'
        discount_money:
          $ref: '#/components/schemas/V1Money'
        net_sales_money:
          $ref: '#/components/schemas/V1Money'
        taxes:
          type: array
          description: All taxes applied to this itemization.
          items:
            $ref: '#/components/schemas/V1PaymentTax'
        discounts:
          type: array
          description: All discounts applied to this itemization.
          items:
            $ref: '#/components/schemas/V1PaymentDiscount'
        modifiers:
          type: array
          description: All modifier options applied to this itemization.
          items:
            $ref: '#/components/schemas/V1PaymentModifier'
      description: |-
        Payment include an` itemizations` field that lists the items purchased,
        along with associated fees, modifiers, and discounts. Each itemization has an
        `itemization_type` field that indicates which of the following the itemization
        represents:

        <ul>
        <li>An item variation from the merchant's item library</li>
        <li>A custom monetary amount</li>
        <li>
        An action performed on a Square gift card, such as activating or
        reloading it.
        </li>
        </ul>

        *Note**: itemization information included in a `Payment` object reflects
        details collected **at the time of the payment**. Details such as the name or
        price of items might have changed since the payment was processed.
      example:
        discount_money: null
        single_quantity_money: null
        quantity: 6.027456183070403
        notes: notes
        taxes:
        - null
        - null
        modifiers:
        - applied_money: null
          name: name
          modifier_option_id: modifier_option_id
        - applied_money: null
          name: name
          modifier_option_id: modifier_option_id
        gross_sales_money: null
        item_detail:
          category_name: category_name
          item_id: item_id
          item_variation_id: item_variation_id
          sku: sku
        discounts:
        - applied_money: null
          name: name
          discount_id: discount_id
        - applied_money: null
          name: name
          discount_id: discount_id
        name: name
        itemization_type: ITEM
        item_variation_name: item_variation_name
        total_money: null
        net_sales_money: null
      deprecated: true
      x-property-order:
      - name
      - quantity
      - itemization_type
      - item_detail
      - notes
      - item_variation_name
      - total_money
      - single_quantity_money
      - gross_sales_money
      - discount_money
      - net_sales_money
      - taxes
      - discounts
      - modifiers
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-payments.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1PaymentItemization
    V1PaymentModifier:
      type: object
      properties:
        name:
          type: string
          description: The modifier option's name.
        applied_money:
          $ref: '#/components/schemas/V1Money'
        modifier_option_id:
          type: string
          description: The ID of the applied modifier option, if available. Modifier
            options applied in older versions of Square Register might not have an
            ID.
      description: V1PaymentModifier
      example:
        applied_money: null
        name: name
        modifier_option_id: modifier_option_id
      deprecated: true
      x-property-order:
      - name
      - applied_money
      - modifier_option_id
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-payments.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1PaymentModifier
    V1PaymentSurcharge:
      type: object
      properties:
        name:
          type: string
          description: The name of the surcharge.
        applied_money:
          $ref: '#/components/schemas/V1Money'
        rate:
          type: string
          description: The amount of the surcharge as a percentage. The percentage
            is provided as a string representing the decimal equivalent of the percentage.
            For example, "0.7" corresponds to a 7% surcharge. Exactly one of rate
            or amount_money should be set.
        amount_money:
          $ref: '#/components/schemas/V1Money'
        type:
          $ref: '#/components/schemas/V1PaymentSurchargeType'
        taxable:
          type: boolean
          description: Indicates whether the surcharge is taxable.
        taxes:
          type: array
          description: The list of taxes that should be applied to the surcharge.
          items:
            $ref: '#/components/schemas/V1PaymentTax'
        surcharge_id:
          type: string
          description: A Square-issued unique identifier associated with the surcharge.
      description: V1PaymentSurcharge
      example:
        applied_money: null
        taxable: true
        rate: rate
        name: name
        taxes:
        - null
        - null
        amount_money: null
        type: UNKNOWN
        surcharge_id: surcharge_id
      deprecated: true
      x-property-order:
      - name
      - applied_money
      - rate
      - amount_money
      - type
      - taxable
      - taxes
      - surcharge_id
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-payments.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1PaymentSurcharge
    V1PaymentTax:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        name:
          type: string
          description: The merchant-defined name of the tax.
        applied_money:
          $ref: '#/components/schemas/V1Money'
        rate:
          type: string
          description: The rate of the tax, as a string representation of a decimal
            number. A value of 0.07 corresponds to a rate of 7%.
        inclusion_type:
          $ref: '#/components/schemas/V1PaymentTaxInclusionType'
        fee_id:
          type: string
          description: The ID of the tax, if available. Taxes applied in older versions
            of Square Register might not have an ID.
      description: V1PaymentTax
      example:
        applied_money: null
        rate: rate
        name: name
        fee_id: fee_id
        inclusion_type: ADDITIVE
        errors:
        - code: INTERNAL_SERVER_ERROR
          field: field
          detail: detail
          category: API_ERROR
        - code: INTERNAL_SERVER_ERROR
          field: field
          detail: detail
          category: API_ERROR
      deprecated: true
      x-property-order:
      - errors
      - name
      - applied_money
      - rate
      - inclusion_type
      - fee_id
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-payments.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1PaymentTax
    V1PhoneNumber:
      required:
      - calling_code
      - number
      type: object
      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.
      description: Represents a phone number.
      deprecated: true
      x-property-order:
      - calling_code
      - number
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1common.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1PhoneNumber
    V1Refund:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/V1RefundType'
        reason:
          type: string
          description: The merchant-specified reason for the refund.
        refunded_money:
          $ref: '#/components/schemas/V1Money'
        refunded_processing_fee_money:
          $ref: '#/components/schemas/V1Money'
        refunded_tax_money:
          $ref: '#/components/schemas/V1Money'
        refunded_additive_tax_money:
          $ref: '#/components/schemas/V1Money'
        refunded_additive_tax:
          type: array
          description: All of the additive taxes associated with the refund.
          items:
            $ref: '#/components/schemas/V1PaymentTax'
        refunded_inclusive_tax_money:
          $ref: '#/components/schemas/V1Money'
        refunded_inclusive_tax:
          type: array
          description: All of the inclusive taxes associated with the refund.
          items:
            $ref: '#/components/schemas/V1PaymentTax'
        refunded_tip_money:
          $ref: '#/components/schemas/V1Money'
        refunded_discount_money:
          $ref: '#/components/schemas/V1Money'
        refunded_surcharge_money:
          $ref: '#/components/schemas/V1Money'
        refunded_surcharges:
          type: array
          description: A list of all surcharges associated with the refund.
          items:
            $ref: '#/components/schemas/V1PaymentSurcharge'
        created_at:
          type: string
          description: The time when the merchant initiated the refund for Square
            to process, in ISO 8601 format.
        processed_at:
          type: string
          description: The time when Square processed the refund on behalf of the
            merchant, in ISO 8601 format.
        payment_id:
          type: string
          description: A Square-issued ID associated with the refund. For single-tender
            refunds, payment_id is the ID of the original payment ID. For split-tender
            refunds, payment_id is the ID of the original tender. For exchange-based
            refunds (is_exchange == true), payment_id is the ID of the original payment
            ID even if the payment includes other tenders.
        merchant_id:
          type: string
        is_exchange:
          type: boolean
          description: Indicates whether or not the refund is associated with an exchange.
            If is_exchange is true, the refund reflects the value of goods returned
            in the exchange not the total money refunded.
      description: V1Refund
      example:
        reason: reason
        refunded_tip_money: null
        refunded_additive_tax:
        - null
        - null
        refunded_additive_tax_money: null
        refunded_inclusive_tax_money: null
        created_at: created_at
        refunded_surcharges:
        - applied_money: null
          taxable: true
          rate: rate
          name: name
          taxes:
          - null
          - null
          amount_money: null
          type: UNKNOWN
          surcharge_id: surcharge_id
        - applied_money: null
          taxable: true
          rate: rate
          name: name
          taxes:
          - null
          - null
          amount_money: null
          type: UNKNOWN
          surcharge_id: surcharge_id
        refunded_discount_money: null
        merchant_id: merchant_id
        type: FULL
        is_exchange: true
        refunded_processing_fee_money: null
        payment_id: payment_id
        refunded_surcharge_money: null
        processed_at: processed_at
        refunded_money: null
        refunded_inclusive_tax:
        - null
        - null
        refunded_tax_money: null
      deprecated: true
      x-property-order:
      - type
      - reason
      - refunded_money
      - refunded_processing_fee_money
      - refunded_tax_money
      - refunded_additive_tax_money
      - refunded_additive_tax
      - refunded_inclusive_tax_money
      - refunded_inclusive_tax
      - refunded_tip_money
      - refunded_discount_money
      - refunded_surcharge_money
      - refunded_surcharges
      - created_at
      - processed_at
      - payment_id
      - merchant_id
      - is_exchange
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-refunds.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1Refund
    V1RetrievePaymentRequest:
      type: object
      properties: {}
      deprecated: true
      x-property-order: []
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-payments.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1RetrievePaymentRequest
    V1RetrieveSettlementRequest:
      type: object
      properties: {}
      deprecated: true
      x-property-order: []
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-settlements.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1RetrieveSettlementRequest
    V1Settlement:
      type: object
      properties:
        id:
          type: string
          description: The settlement's unique identifier.
        status:
          $ref: '#/components/schemas/V1SettlementStatus'
        total_money:
          $ref: '#/components/schemas/V1Money'
        initiated_at:
          type: string
          description: The time when the settlement was submitted for deposit or withdrawal,
            in ISO 8601 format.
        bank_account_id:
          type: string
          description: The Square-issued unique identifier for the bank account associated
            with the settlement.
        entries:
          type: array
          description: The entries included in this settlement.
          items:
            $ref: '#/components/schemas/V1SettlementEntry'
      description: V1Settlement
      example:
        bank_account_id: bank_account_id
        entries:
        - payment_id: payment_id
          fee_money: null
          amount_money: null
          type: ADJUSTMENT
        - payment_id: payment_id
          fee_money: null
          amount_money: null
          type: ADJUSTMENT
        id: id
        total_money:
          amount: 0
          currency_code: UNKNOWN_CURRENCY
        initiated_at: initiated_at
        status: FAILED
      deprecated: true
      x-property-order:
      - id
      - status
      - total_money
      - initiated_at
      - bank_account_id
      - entries
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-settlements.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1Settlement
    V1SettlementEntry:
      type: object
      properties:
        payment_id:
          type: string
          description: The settlement's unique identifier.
        type:
          $ref: '#/components/schemas/V1SettlementEntryType'
        amount_money:
          $ref: '#/components/schemas/V1Money'
        fee_money:
          $ref: '#/components/schemas/V1Money'
      description: V1SettlementEntry
      example:
        payment_id: payment_id
        fee_money: null
        amount_money: null
        type: ADJUSTMENT
      deprecated: true
      x-property-order:
      - payment_id
      - type
      - amount_money
      - fee_money
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1transactions-settlements.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1SettlementEntry
    V1SubmitBatchRequest:
      required:
      - requests
      type: object
      properties:
        requests:
          type: array
          description: The set of API actions to perform.
          items:
            $ref: '#/components/schemas/BatchRequest'
      deprecated: true
      x-property-order:
      - requests
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1batch.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1SubmitBatchRequest
      x-visibility: DOC_ONLY
    V1SubmitBatchResponse:
      type: object
      properties:
        items:
          type: array
          description: |-
            An array of `BatchResponse` objects corresponding to requests. The
            index of each response in the array matches the index of the
            corresponding request.
          items:
            $ref: '#/components/schemas/BatchResponse'
      deprecated: true
      x-property-order:
      - items
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1batch.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1SubmitBatchResponse
      x-visibility: DOC_ONLY
    V1Tender:
      type: object
      properties:
        id:
          type: string
          description: The tender's unique ID.
        type:
          $ref: '#/components/schemas/V1TenderType'
        name:
          type: string
          description: A human-readable description of the tender.
        employee_id:
          type: string
          description: The ID of the employee that processed the tender.
        receipt_url:
          type: string
          description: The URL of the receipt for the tender.
        card_brand:
          $ref: '#/components/schemas/V1TenderCardBrand'
        pan_suffix:
          type: string
          description: The last four digits of the provided credit card's account
            number.
        entry_method:
          $ref: '#/components/schemas/V1TenderEntryMethod'
        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.'
        total_money:
          $ref: '#/components/schemas/V1Money'
        tendered_money:
          $ref: '#/components/schemas/V1Money'
        tendered_at:
          type: string
          description: The time when the tender was created, in ISO 8601 format.
        settled_at:
          type: string
          description: The time when the tender was settled, in ISO 8601 format.
        change_back_money:
          $ref: '#/components/schemas/V1Money'
        refunded_money:
          $ref: '#/components/schemas/V1Money'
        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.
      description: |-
        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.
      example:
        type: CREDIT_CARD
        tendered_at: tendered_at
        pan_suffix: pan_suffix
        change_back_money: null
        entry_method: MANUAL
        tendered_money: null
        is_exchange: true
        receipt_url: receipt_url
        payment_note: payment_note
        employee_id: employee_id
        name: name
        card_brand: OTHER_BRAND
        id: id
        total_money: null
        settled_at: settled_at
        refunded_money: null
      deprecated: true
      x-property-order:
      - id
      - type
      - name
      - employee_id
      - receipt_url
      - card_brand
      - pan_suffix
      - entry_method
      - payment_note
      - total_money
      - tendered_money
      - tendered_at
      - settled_at
      - change_back_money
      - refunded_money
      - is_exchange
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1common.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1Tender
    V1UpdateWebhooksRequest:
      type: object
      properties: {}
      description: V1UpdateWebhooksRequest
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1webhooks.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1UpdateWebhooksRequest
      x-visibility: DOC_ONLY
    V1UpdateWebhooksResponse:
      type: object
      properties:
        events:
          type: array
          description: |-
            A list of webhook event enums the location is currently subscribed to.
            See [V1WebhooksEvents](#type-v1webhooksevents) for possible values
          items:
            $ref: '#/components/schemas/V1WebhooksEvents'
      description: V1UpdateWebhooksResponse
      x-property-order:
      - events
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/XP/repos/square-public-apis/browse
      x-proto-location: /_public-v1/v1webhooks.proto
      x-proto-sha: a0426e87df447129bc3aafb78120566a0e2c470b
      x-object-name: V1UpdateWebhooksResponse
      x-visibility: DOC_ONLY
    AddGroupToCustomerRequest:
      type: object
      properties: {}
      description: |-
        Defines the fields that are included in the request body of
        a request to the [AddGroupToCustomer](api-endpoint:Customers-AddGroupToCustomer) endpoint.
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: AddGroupToCustomerRequest
    AddGroupToCustomerResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Defines the fields that are included in the response body of
        a request to the [AddGroupToCustomer](api-endpoint:Customers-AddGroupToCustomer) endpoint.
      example: {}
      x-property-order:
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: AddGroupToCustomerResponse
    CaptureTransactionRequest:
      type: object
      properties: {}
      deprecated: true
      x-property-order: []
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/transaction.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: CaptureTransactionRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/CaptureTransaction/CaptureTransactionRequest.python
        csharp: /sdk_samples/CaptureTransaction/CaptureTransactionRequest.csharp
        java: /sdk_samples/CaptureTransaction/CaptureTransactionRequest.java
        php: /sdk_samples/CaptureTransaction/CaptureTransactionRequest.php
        javascript: /sdk_samples/CaptureTransaction/CaptureTransactionRequest.javascript
        ruby: /sdk_samples/CaptureTransaction/CaptureTransactionRequest.ruby
    CaptureTransactionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Defines the fields that are included in the response body of
        a request to the [CaptureTransaction](api-endpoint:Transactions-CaptureTransaction) endpoint.
      example: {}
      deprecated: true
      x-property-order:
      - errors
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/transaction.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: CaptureTransactionResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/CaptureTransaction/CaptureTransactionResponse.python
        csharp: /sdk_samples/CaptureTransaction/CaptureTransactionResponse.csharp
        java: /sdk_samples/CaptureTransaction/CaptureTransactionResponse.java
        php: /sdk_samples/CaptureTransaction/CaptureTransactionResponse.php
        javascript: /sdk_samples/CaptureTransaction/CaptureTransactionResponse.javascript
        ruby: /sdk_samples/CaptureTransaction/CaptureTransactionResponse.ruby
    ChargeRequest:
      required:
      - amount_money
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          maxLength: 192
          minLength: 1
          type: string
          description: |-
            A value you specify that uniquely identifies this
            transaction among transactions you've created.

            If you're unsure whether a particular transaction succeeded,
            you can reattempt it with the same idempotency key without
            worrying about double-charging the buyer.

            See [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency) for more information.
        amount_money:
          $ref: '#/components/schemas/Money'
        card_nonce:
          maxLength: 192
          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
            to charge.

            The application that provides a payment token to this endpoint must be the
            _same application_ that generated the payment token with the Web Payments SDK.
            Otherwise, the nonce is invalid.

            Do not provide a value for this field if you provide a value for
            `customer_card_id`.
        customer_card_id:
          maxLength: 192
          type: string
          description: |-
            The ID of the customer card on file to charge. Do
            not provide a value for this field if you provide a value for `card_nonce`.

            If you provide this value, you _must_ also provide a value for
            `customer_id`.
        delay_capture:
          type: boolean
          description: |-
            If `true`, the request will only perform an Auth on the provided
            card. You can then later perform either a Capture (with the
            [CaptureTransaction](api-endpoint:Transactions-CaptureTransaction) endpoint) or a Void
            (with the [VoidTransaction](api-endpoint:Transactions-VoidTransaction) endpoint).

            Default value: `false`
        reference_id:
          maxLength: 40
          type: string
          description: |-
            An optional ID you can associate with the transaction for your own
            purposes (such as to associate the transaction with an entity ID in your
            own database).

            This value cannot exceed 40 characters.
        note:
          maxLength: 60
          type: string
          description: |-
            An optional note to associate with the transaction.

            This value cannot exceed 60 characters.
        customer_id:
          maxLength: 50
          type: string
          description: |-
            The ID of the customer to associate this transaction with. This field
            is required if you provide a value for `customer_card_id`, and optional
            otherwise.
        billing_address:
          $ref: '#/components/schemas/Address'
        shipping_address:
          $ref: '#/components/schemas/Address'
        buyer_email_address:
          type: string
          description: |-
            The buyer's email address, if available. This value is optional,
            but this transaction is ineligible for chargeback protection if it is not
            provided.
        order_id:
          maxLength: 192
          type: string
          description: |-
            The ID of the order to associate with this transaction.

            If you provide this value, the `amount_money` value of your request must
            __exactly match__ the value of the order's `total_money` field.
        additional_recipients:
          type: array
          description: |-
            The basic primitive of 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
            must not be more than 90% of the `amount_money` value in the charge request.
            The `location_id` must be the valid location of the app owner merchant.

            This field requires the `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission.

            This field is currently not supported in sandbox.
          items:
            $ref: '#/components/schemas/ChargeRequestAdditionalRecipient'
        verification_token:
          type: string
          description: |-
            A token generated by SqPaymentForm's verifyBuyer() that represents
            customer's device info and 3ds challenge result.
      description: |-
        Defines the parameters that can be included in the body of
        a request to the [Charge](api-endpoint:Transactions-Charge) endpoint.

        Deprecated - recommend using [CreatePayment](api-endpoint:Payments-CreatePayment)
      example:
        idempotency_key: 74ae1696-b1e3-4328-af6d-f1e04d947a13
        shipping_address:
          address_line_1: 123 Main St
          locality: San Francisco
          administrative_district_level_1: CA
          postal_code: "94114"
          country: US
        billing_address:
          address_line_1: 500 Electric Ave
          address_line_2: Suite 600
          administrative_district_level_1: NY
          locality: New York
          postal_code: "10003"
          country: US
        amount_money:
          amount: 200
          currency: USD
        additional_recipients:
        - location_id: 057P5VYJ4A5X1
          description: Application fees
          amount_money:
            amount: 20
            currency: USD
        card_nonce: card_nonce_from_square_123
        reference_id: some optional reference id
        note: some optional note
        delay_capture: false
      deprecated: true
      x-property-order:
      - idempotency_key
      - amount_money
      - card_nonce
      - customer_card_id
      - delay_capture
      - reference_id
      - note
      - customer_id
      - billing_address
      - shipping_address
      - buyer_email_address
      - order_id
      - additional_recipients
      - integration_id
      - employee_id
      - tenders
      - verification_token
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/charge.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: ChargeRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/Charge/ChargeRequest.python
        csharp: /sdk_samples/Charge/ChargeRequest.csharp
        java: /sdk_samples/Charge/ChargeRequest.java
        php: /sdk_samples/Charge/ChargeRequest.php
        javascript: /sdk_samples/Charge/ChargeRequest.javascript
        ruby: /sdk_samples/Charge/ChargeRequest.ruby
    ChargeRequestAdditionalRecipient:
      required:
      - amount_money
      - description
      - location_id
      type: object
      properties:
        location_id:
          maxLength: 50
          minLength: 1
          type: string
          description: The location ID for a recipient (other than the merchant) receiving
            a portion of the tender.
        description:
          maxLength: 100
          minLength: 1
          type: string
          description: The description of the additional recipient.
        amount_money:
          $ref: '#/components/schemas/Money'
      description: |-
        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
      deprecated: true
      x-property-order:
      - location_id
      - description
      - amount_money
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/charge.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: ChargeRequestAdditionalRecipient
    ChargeResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        transaction:
          $ref: '#/components/schemas/Transaction'
      description: |-
        Defines the fields that are included in the response body of
        a request to the [Charge](api-endpoint:Transactions-Charge) endpoint.

        One of `errors` or `transaction` is present in a given response (never both).
      example:
        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: 200
              currency: USD
            additional_recipients:
            - location_id: 057P5VYJ4A5X1
              description: Application fees
              amount_money:
                amount: 20
                currency: USD
              receivable_id: ISu5xwxJ5v0CMJTQq7RvqyMF
            type: CARD
            card_details:
              status: CAPTURED
              card:
                card_brand: VISA
                last_4: "1111"
              entry_method: KEYED
          reference_id: some optional reference id
          product: EXTERNAL_API
      deprecated: true
      x-property-order:
      - errors
      - transaction
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/charge.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: ChargeResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/Charge/ChargeResponse.python
        csharp: /sdk_samples/Charge/ChargeResponse.csharp
        java: /sdk_samples/Charge/ChargeResponse.java
        php: /sdk_samples/Charge/ChargeResponse.php
        javascript: /sdk_samples/Charge/ChargeResponse.javascript
        ruby: /sdk_samples/Charge/ChargeResponse.ruby
    CreateCustomerCardRequest:
      required:
      - card_nonce
      type: object
      properties:
        card_nonce:
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Address'
        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).
            Verification tokens encapsulate customer device information and 3-D Secure
            challenge results to indicate that Square has verified the buyer identity.
      description: |-
        Defines the fields that are included in the request body of a request
        to the `CreateCustomerCard` endpoint.
      example:
        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
      deprecated: true
      x-property-order:
      - card_nonce
      - billing_address
      - cardholder_name
      - verification_token
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CreateCustomerCardRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/CreateCustomerCard/CreateCustomerCardRequest.python
        csharp: /sdk_samples/CreateCustomerCard/CreateCustomerCardRequest.csharp
        java: /sdk_samples/CreateCustomerCard/CreateCustomerCardRequest.java
        php: /sdk_samples/CreateCustomerCard/CreateCustomerCardRequest.php
        javascript: /sdk_samples/CreateCustomerCard/CreateCustomerCardRequest.javascript
        ruby: /sdk_samples/CreateCustomerCard/CreateCustomerCardRequest.ruby
    CreateCustomerCardResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        card:
          $ref: '#/components/schemas/Card'
      description: |-
        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).
      example:
        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
            locality: New York
            administrative_district_level_1: NY
            postal_code: "10003"
            country: US
      deprecated: true
      x-property-order:
      - errors
      - card
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CreateCustomerCardResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/CreateCustomerCard/CreateCustomerCardResponse.python
        csharp: /sdk_samples/CreateCustomerCard/CreateCustomerCardResponse.csharp
        java: /sdk_samples/CreateCustomerCard/CreateCustomerCardResponse.java
        php: /sdk_samples/CreateCustomerCard/CreateCustomerCardResponse.php
        javascript: /sdk_samples/CreateCustomerCard/CreateCustomerCardResponse.javascript
        ruby: /sdk_samples/CreateCustomerCard/CreateCustomerCardResponse.ruby
    CreateCustomerGroupRequest:
      required:
      - group
      type: object
      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: |-
        Defines the body parameters that can be included in a request to the
        [CreateCustomerGroup](api-endpoint:CustomerGroups-CreateCustomerGroup) endpoint.
      example:
        group:
          name: Loyal Customers
      x-property-order:
      - idempotency_key
      - group
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CreateCustomerGroupRequest
    CreateCustomerGroupResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        group:
          $ref: '#/components/schemas/CustomerGroup'
      description: |-
        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).
      example:
        group:
          id: 2TAT3CMH4Q0A9M87XJZED0WMR3
          name: Loyal Customers
          created_at: 2020-04-13T21:54:57.863Z
          updated_at: 2020-04-13T21:54:58Z
      x-property-order:
      - errors
      - group
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CreateCustomerGroupResponse
    CreateCustomerRequest:
      type: object
      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.
        family_name:
          type: string
          description: The family name (that is, the last name) associated with the
            customer profile.
        company_name:
          type: string
          description: A business name associated with the customer profile.
        nickname:
          type: string
          description: A nickname for the customer profile.
        email_address:
          type: string
          description: The email address associated with the customer profile.
        address:
          $ref: '#/components/schemas/Address'
        phone_number:
          type: string
          description: The phone number associated with the customer profile. A phone
            number can contain 9–16 digits, with an optional `+` prefix.
        reference_id:
          type: string
          description: |-
            An optional second ID used to associate the customer profile with an
            entity in another system.
        note:
          type: string
          description: A custom note associated with the customer profile.
        birthday:
          type: string
          description: |-
            The birthday associated with the customer profile, in RFC 3339 format. The year is optional. The timezone and time are not allowed.
            For example, `0000-09-21T00:00:00-00:00` represents a birthday on September 21 and `1998-09-21T00:00:00-00:00` represents a birthday on September 21, 1998.
            You can also specify this value in `YYYY-MM-DD` format.
        tax_ids:
          $ref: '#/components/schemas/CustomerTaxIds'
      description: |-
        Defines the body parameters that can be included in a request to the
        `CreateCustomer` endpoint.
      example:
        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
      x-property-order:
      - idempotency_key
      - given_name
      - family_name
      - company_name
      - nickname
      - email_address
      - address
      - phone_number
      - reference_id
      - note
      - birthday
      - preferences
      - tax_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CreateCustomerRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/CreateCustomer/CreateCustomerRequest.python
        csharp: /sdk_samples/CreateCustomer/CreateCustomerRequest.csharp
        java: /sdk_samples/CreateCustomer/CreateCustomerRequest.java
        php: /sdk_samples/CreateCustomer/CreateCustomerRequest.php
        javascript: /sdk_samples/CreateCustomer/CreateCustomerRequest.javascript
        ruby: /sdk_samples/CreateCustomer/CreateCustomerRequest.ruby
    CreateCustomerResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        customer:
          $ref: '#/components/schemas/Customer'
      description: |-
        Defines the fields that are included in the response body of
        a request to the `CreateCustomer` endpoint.

        Either `errors` or `customer` is present in a given response (never both).
      example:
        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
          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
      x-property-order:
      - errors
      - customer
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CreateCustomerResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/CreateCustomer/CreateCustomerResponse.python
        csharp: /sdk_samples/CreateCustomer/CreateCustomerResponse.csharp
        java: /sdk_samples/CreateCustomer/CreateCustomerResponse.java
        php: /sdk_samples/CreateCustomer/CreateCustomerResponse.php
        javascript: /sdk_samples/CreateCustomer/CreateCustomerResponse.javascript
        ruby: /sdk_samples/CreateCustomer/CreateCustomerResponse.ruby
    CreateRefundRequest:
      required:
      - amount_money
      - idempotency_key
      - tender_id
      type: object
      properties:
        idempotency_key:
          maxLength: 192
          minLength: 1
          type: string
          description: |-
            A value you specify that uniquely identifies this
            refund among refunds you've created for the tender.

            If you're unsure whether a particular refund succeeded,
            you can reattempt it with the same idempotency key without
            worrying about duplicating the refund.

            See [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency) for more information.
        tender_id:
          maxLength: 192
          minLength: 1
          type: string
          description: |-
            The ID of the tender to refund.

            A [`Transaction`](entity:Transaction) has one or more `tenders` (i.e., methods
            of payment) associated with it, and you refund each tender separately with
            the Connect API.
        reason:
          maxLength: 192
          type: string
          description: |-
            A description of the reason for the refund.

            Default value: `Refund via API`
        amount_money:
          $ref: '#/components/schemas/Money'
      description: |-
        Defines the body parameters that can be included in
        a request to the [CreateRefund](api-endpoint:Transactions-CreateRefund) endpoint.

        Deprecated - recommend using [RefundPayment](api-endpoint:Refunds-RefundPayment)
      example:
        idempotency_key: 86ae1696-b1e3-4328-af6d-f1e04d947ad2
        tender_id: MtZRYYdDrYNQbOvV7nbuBvMF
        reason: a reason
        amount_money:
          amount: 100
          currency: USD
      deprecated: true
      x-property-order:
      - idempotency_key
      - tender_id
      - reason
      - amount_money
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/refund.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: CreateRefundRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/CreateRefund/CreateRefundRequest.python
        csharp: /sdk_samples/CreateRefund/CreateRefundRequest.csharp
        java: /sdk_samples/CreateRefund/CreateRefundRequest.java
        php: /sdk_samples/CreateRefund/CreateRefundRequest.php
        javascript: /sdk_samples/CreateRefund/CreateRefundRequest.javascript
        ruby: /sdk_samples/CreateRefund/CreateRefundRequest.ruby
    CreateRefundResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        refund:
          $ref: '#/components/schemas/Refund'
      description: |-
        Defines the fields that are included in the response body of
        a request to the [CreateRefund](api-endpoint:Transactions-CreateRefund) endpoint.

        One of `errors` or `refund` is present in a given response (never both).
      example:
        refund:
          id: b27436d1-7f8e-5610-45c6-417ef71434b4-SW
          location_id: 18YC4JDH91E1H
          transaction_id: KnL67ZIwXCPtzOrqj0HrkxMF
          tender_id: MtZRYYdDrYNQbOvV7nbuBvMF
          created_at: 2016-02-12T00:28:18Z
          reason: some reason
          amount_money:
            amount: 100
            currency: USD
          additional_recipients:
          - location_id: 057P5VYJ4A5X1
            description: Application fees
            amount_money:
              amount: 10
              currency: USD
            receivable_id: ISu5xwxJ5v0CMJTQq7RvqyMF
          status: PENDING
      deprecated: true
      x-property-order:
      - errors
      - refund
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/refund.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: CreateRefundResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/CreateRefund/CreateRefundResponse.python
        csharp: /sdk_samples/CreateRefund/CreateRefundResponse.csharp
        java: /sdk_samples/CreateRefund/CreateRefundResponse.java
        php: /sdk_samples/CreateRefund/CreateRefundResponse.php
        javascript: /sdk_samples/CreateRefund/CreateRefundResponse.javascript
        ruby: /sdk_samples/CreateRefund/CreateRefundResponse.ruby
    DeleteCustomerCardRequest:
      type: object
      properties: {}
      description: |-
        Defines the fields that are included in requests to the
        `DeleteCustomerCard` endpoint.
      deprecated: true
      x-property-order: []
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: DeleteCustomerCardRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/DeleteCustomerCard/DeleteCustomerCardRequest.python
        csharp: /sdk_samples/DeleteCustomerCard/DeleteCustomerCardRequest.csharp
        java: /sdk_samples/DeleteCustomerCard/DeleteCustomerCardRequest.java
        php: /sdk_samples/DeleteCustomerCard/DeleteCustomerCardRequest.php
        javascript: /sdk_samples/DeleteCustomerCard/DeleteCustomerCardRequest.javascript
        ruby: /sdk_samples/DeleteCustomerCard/DeleteCustomerCardRequest.ruby
    DeleteCustomerCardResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Defines the fields that are included in the response body of
        a request to the `DeleteCustomerCard` endpoint.
      example: {}
      deprecated: true
      x-property-order:
      - errors
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: DeleteCustomerCardResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/DeleteCustomerCard/DeleteCustomerCardResponse.python
        csharp: /sdk_samples/DeleteCustomerCard/DeleteCustomerCardResponse.csharp
        java: /sdk_samples/DeleteCustomerCard/DeleteCustomerCardResponse.java
        php: /sdk_samples/DeleteCustomerCard/DeleteCustomerCardResponse.php
        javascript: /sdk_samples/DeleteCustomerCard/DeleteCustomerCardResponse.javascript
        ruby: /sdk_samples/DeleteCustomerCard/DeleteCustomerCardResponse.ruby
    DeleteCustomerGroupRequest:
      type: object
      properties: {}
      description: |-
        Defines the fields that can be included in a request to the
        [DeleteCustomerGroup](api-endpoint:CustomerGroups-DeleteCustomerGroup) endpoint.
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: DeleteCustomerGroupRequest
    DeleteCustomerGroupResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Defines the fields that are included in the response body of
        a request to the [DeleteCustomerGroup](api-endpoint:CustomerGroups-DeleteCustomerGroup) endpoint.
      example: {}
      x-property-order:
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: DeleteCustomerGroupResponse
    DeleteCustomerRequest:
      type: object
      properties:
        version:
          type: integer
          description: |-
            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).
          format: int64
      description: |-
        Defines the fields that are included in a request to the `DeleteCustomer`
        endpoint.
      x-property-order:
      - version
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: DeleteCustomerRequest
      x-params-example: ?version=11
      x-sq-sdk-sample-code:
        python: /sdk_samples/DeleteCustomer/DeleteCustomerRequest.python
        csharp: /sdk_samples/DeleteCustomer/DeleteCustomerRequest.csharp
        java: /sdk_samples/DeleteCustomer/DeleteCustomerRequest.java
        php: /sdk_samples/DeleteCustomer/DeleteCustomerRequest.php
        javascript: /sdk_samples/DeleteCustomer/DeleteCustomerRequest.javascript
        ruby: /sdk_samples/DeleteCustomer/DeleteCustomerRequest.ruby
    DeleteCustomerResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Defines the fields that are included in the response body of
        a request to the `DeleteCustomer` endpoint.
      example: {}
      x-property-order:
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: DeleteCustomerResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/DeleteCustomer/DeleteCustomerResponse.python
        csharp: /sdk_samples/DeleteCustomer/DeleteCustomerResponse.csharp
        java: /sdk_samples/DeleteCustomer/DeleteCustomerResponse.java
        php: /sdk_samples/DeleteCustomer/DeleteCustomerResponse.php
        javascript: /sdk_samples/DeleteCustomer/DeleteCustomerResponse.javascript
        ruby: /sdk_samples/DeleteCustomer/DeleteCustomerResponse.ruby
    ListCustomerGroupsRequest:
      type: object
      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 results for your original query.

            For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
        limit:
          maximum: 50
          minimum: 1
          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.
            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).
      description: |-
        Defines the query parameters that can be included in a request to the
        [ListCustomerGroups](api-endpoint:CustomerGroups-ListCustomerGroups) endpoint.
      example: {}
      x-property-order:
      - cursor
      - limit
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: ListCustomerGroupsRequest
    ListCustomerGroupsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        groups:
          type: array
          description: A list of customer groups belonging to the current seller.
          items:
            $ref: '#/components/schemas/CustomerGroup'
        cursor:
          type: string
          description: |-
            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).
      description: |-
        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).
      example:
        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
      x-property-order:
      - errors
      - groups
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: ListCustomerGroupsResponse
    ListCustomerSegmentsRequest:
      type: object
      properties:
        cursor:
          type: string
          description: |-
            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:
          maximum: 50
          minimum: 1
          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.
            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).
      description: Defines the valid parameters for requests to the `ListCustomerSegments`
        endpoint.
      example: {}
      x-property-order:
      - cursor
      - limit
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: ListCustomerSegmentsRequest
    ListCustomerSegmentsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        segments:
          type: array
          description: The list of customer segments belonging to the associated Square
            account.
          items:
            $ref: '#/components/schemas/CustomerSegment'
        cursor:
          type: string
          description: |-
            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).
      description: |-
        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).
      example:
        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
      x-property-order:
      - errors
      - segments
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: ListCustomerSegmentsResponse
    ListCustomersRequest:
      type: object
      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 results for your original query.

            For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
        limit:
          maximum: 100
          minimum: 1
          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.
            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:
          $ref: '#/components/schemas/CustomerSortField'
        sort_order:
          $ref: '#/components/schemas/SortOrder'
      description: |-
        Defines the query parameters that can be included in a request to the
        `ListCustomers` endpoint.
      x-property-order:
      - cursor
      - limit
      - sort_field
      - sort_order
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: ListCustomersRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/ListCustomers/ListCustomersRequest.python
        csharp: /sdk_samples/ListCustomers/ListCustomersRequest.csharp
        java: /sdk_samples/ListCustomers/ListCustomersRequest.java
        php: /sdk_samples/ListCustomers/ListCustomersRequest.php
        javascript: /sdk_samples/ListCustomers/ListCustomersRequest.javascript
        ruby: /sdk_samples/ListCustomers/ListCustomersRequest.ruby
    ListCustomersResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        customers:
          type: array
          description: An array of `Customer` objects that match the provided query.
          items:
            $ref: '#/components/schemas/Customer'
        cursor:
          type: string
          description: |-
            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).
      description: |-
        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).
      example:
        customers:
        - id: JDKYHBWT1D4F8MFH63DBMEN8Y4
          created_at: 2016-03-23T20:21:54.859Z
          updated_at: 2016-03-23T20:21:55Z
          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
          group_ids:
          - 545AXB44B4XXWMVQ4W8SBT3HHF
          segment_ids:
          - 1KB9JE5EGJXCW.REACHABLE
          version: 1
      x-property-order:
      - errors
      - customers
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: ListCustomersResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/ListCustomers/ListCustomersResponse.python
        csharp: /sdk_samples/ListCustomers/ListCustomersResponse.csharp
        java: /sdk_samples/ListCustomers/ListCustomersResponse.java
        php: /sdk_samples/ListCustomers/ListCustomersResponse.php
        javascript: /sdk_samples/ListCustomers/ListCustomersResponse.javascript
        ruby: /sdk_samples/ListCustomers/ListCustomersResponse.ruby
    ListRefundsRequest:
      type: object
      properties:
        begin_time:
          type: string
          description: |-
            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: string
          description: |-
            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:
          $ref: '#/components/schemas/SortOrder'
        cursor:
          type: string
          description: |-
            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.
      description: |-
        Defines the query parameters that can be included in
        a request to the [ListRefunds](api-endpoint:Transactions-ListRefunds) endpoint.

        Deprecated - recommend using [SearchOrders](api-endpoint:Orders-SearchOrders)
      deprecated: true
      x-property-order:
      - begin_time
      - end_time
      - sort_order
      - cursor
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/refund.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: ListRefundsRequest
      x-params-example: ?begin_time=2016-01-15T00:00:00Z&end_time=2016-01-31T00:00:00Z
      x-sq-sdk-sample-code:
        python: /sdk_samples/ListRefunds/ListRefundsRequest.python
        csharp: /sdk_samples/ListRefunds/ListRefundsRequest.csharp
        java: /sdk_samples/ListRefunds/ListRefundsRequest.java
        php: /sdk_samples/ListRefunds/ListRefundsRequest.php
        javascript: /sdk_samples/ListRefunds/ListRefundsRequest.javascript
        ruby: /sdk_samples/ListRefunds/ListRefundsRequest.ruby
    ListRefundsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        refunds:
          type: array
          description: An array of refunds that match your query.
          items:
            $ref: '#/components/schemas/Refund'
        cursor:
          type: string
          description: |-
            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.
      description: |-
        Defines the fields that are included in the response body of
        a request to the [ListRefunds](api-endpoint:Transactions-ListRefunds) endpoint.

        One of `errors` or `refunds` is present in a given response (never both).
      example:
        refunds:
        - id: b27436d1-7f8e-5610-45c6-417ef71434b4-SW
          location_id: 18YC4JDH91E1H
          transaction_id: KnL67ZIwXCPtzOrqj0HrkxMF
          tender_id: MtZRYYdDrYNQbOvV7nbuBvMF
          created_at: 2016-01-20T00:28:18Z
          reason: some reason
          amount_money:
            amount: 100
            currency: USD
          additional_recipients:
          - location_id: 057P5VYJ4A5X1
            description: Application fees
            amount_money:
              amount: 10
              currency: USD
          status: APPROVED
      deprecated: true
      x-property-order:
      - errors
      - refunds
      - cursor
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/refund.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: ListRefundsResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/ListRefunds/ListRefundsResponse.python
        csharp: /sdk_samples/ListRefunds/ListRefundsResponse.csharp
        java: /sdk_samples/ListRefunds/ListRefundsResponse.java
        php: /sdk_samples/ListRefunds/ListRefundsResponse.php
        javascript: /sdk_samples/ListRefunds/ListRefundsResponse.javascript
        ruby: /sdk_samples/ListRefunds/ListRefundsResponse.ruby
    ListTransactionsRequest:
      type: object
      properties:
        begin_time:
          type: string
          description: |-
            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: string
          description: |-
            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:
          $ref: '#/components/schemas/SortOrder'
        cursor:
          type: string
          description: |-
            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.
      description: |-
        Defines the query parameters that can be included in
        a request to the [ListTransactions](api-endpoint:Transactions-ListTransactions) endpoint.

        Deprecated - recommend using [SearchOrders](api-endpoint:Orders-SearchOrders)
      deprecated: true
      x-property-order:
      - begin_time
      - end_time
      - sort_order
      - cursor
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/transaction.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: ListTransactionsRequest
      x-params-example: ?begin_time=2016-01-15T00:00:00Z&end_time=2016-01-31T00:00:00Z
      x-sq-sdk-sample-code:
        python: /sdk_samples/ListTransactions/ListTransactionsRequest.python
        csharp: /sdk_samples/ListTransactions/ListTransactionsRequest.csharp
        java: /sdk_samples/ListTransactions/ListTransactionsRequest.java
        php: /sdk_samples/ListTransactions/ListTransactionsRequest.php
        javascript: /sdk_samples/ListTransactions/ListTransactionsRequest.javascript
        ruby: /sdk_samples/ListTransactions/ListTransactionsRequest.ruby
    ListTransactionsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        transactions:
          type: array
          description: An array of transactions that match your query.
          items:
            $ref: '#/components/schemas/Transaction'
        cursor:
          type: string
          description: |-
            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.
      description: |-
        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).
      example:
        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
      deprecated: true
      x-property-order:
      - errors
      - transactions
      - cursor
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/transaction.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: ListTransactionsResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/ListTransactions/ListTransactionsResponse.python
        csharp: /sdk_samples/ListTransactions/ListTransactionsResponse.csharp
        java: /sdk_samples/ListTransactions/ListTransactionsResponse.java
        php: /sdk_samples/ListTransactions/ListTransactionsResponse.php
        javascript: /sdk_samples/ListTransactions/ListTransactionsResponse.javascript
        ruby: /sdk_samples/ListTransactions/ListTransactionsResponse.ruby
    RemoveGroupFromCustomerRequest:
      type: object
      properties: {}
      description: |-
        Defines the fields that are included in the request body of
        a request to the [RemoveGroupFromCustomer](api-endpoint:Customers-RemoveGroupFromCustomer) endpoint.
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: RemoveGroupFromCustomerRequest
    RemoveGroupFromCustomerResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Defines the fields that are included in the response body of
        a request to the [RemoveGroupFromCustomer](api-endpoint:Customers-RemoveGroupFromCustomer)
        endpoint.
      example: {}
      x-property-order:
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: RemoveGroupFromCustomerResponse
    RetrieveCustomerGroupRequest:
      type: object
      properties: {}
      description: |-
        Defines the fields that can be included in a request to the
        [RetrieveCustomerGroup](api-endpoint:CustomerGroups-RetrieveCustomerGroup) endpoint.
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: RetrieveCustomerGroupRequest
    RetrieveCustomerGroupResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        group:
          $ref: '#/components/schemas/CustomerGroup'
      description: |-
        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).
      example:
        group:
          id: 2TAT3CMH4Q0A9M87XJZED0WMR3
          name: Loyal Customers
          created_at: 2020-04-13T21:54:57.863Z
          updated_at: 2020-04-13T21:54:58Z
      x-property-order:
      - errors
      - group
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: RetrieveCustomerGroupResponse
    RetrieveCustomerRequest:
      type: object
      properties: {}
      description: |-
        Defines the fields that are included in requests to the `RetrieveCustomer`
        endpoint.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: RetrieveCustomerRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/RetrieveCustomer/RetrieveCustomerRequest.python
        csharp: /sdk_samples/RetrieveCustomer/RetrieveCustomerRequest.csharp
        java: /sdk_samples/RetrieveCustomer/RetrieveCustomerRequest.java
        php: /sdk_samples/RetrieveCustomer/RetrieveCustomerRequest.php
        javascript: /sdk_samples/RetrieveCustomer/RetrieveCustomerRequest.javascript
        ruby: /sdk_samples/RetrieveCustomer/RetrieveCustomerRequest.ruby
    RetrieveCustomerResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        customer:
          $ref: '#/components/schemas/Customer'
      description: |-
        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).
      example:
        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
          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
          group_ids:
          - 545AXB44B4XXWMVQ4W8SBT3HHF
          segment_ids:
          - 1KB9JE5EGJXCW.REACHABLE
          version: 1
      x-property-order:
      - errors
      - customer
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: RetrieveCustomerResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/RetrieveCustomer/RetrieveCustomerResponse.python
        csharp: /sdk_samples/RetrieveCustomer/RetrieveCustomerResponse.csharp
        java: /sdk_samples/RetrieveCustomer/RetrieveCustomerResponse.java
        php: /sdk_samples/RetrieveCustomer/RetrieveCustomerResponse.php
        javascript: /sdk_samples/RetrieveCustomer/RetrieveCustomerResponse.javascript
        ruby: /sdk_samples/RetrieveCustomer/RetrieveCustomerResponse.ruby
    RetrieveCustomerSegmentRequest:
      type: object
      properties: {}
      description: Defines the valid parameters for requests to the `RetrieveCustomerSegmentRequest`
        endpoint.
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: RetrieveCustomerSegmentRequest
    RetrieveCustomerSegmentResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        segment:
          $ref: '#/components/schemas/CustomerSegment'
      description: |-
        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).
      example:
        segment:
          id: GMNXRZVEXNQDF.CHURN_RISK
          name: Lapsed
          created_at: 2020-01-09T19:33:24.469Z
          updated_at: 2020-04-13T23:01:13Z
      x-property-order:
      - errors
      - segment
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: RetrieveCustomerSegmentResponse
    RetrieveTransactionRequest:
      type: object
      properties: {}
      deprecated: true
      x-property-order: []
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/transaction.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: RetrieveTransactionRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/RetrieveTransaction/RetrieveTransactionRequest.python
        csharp: /sdk_samples/RetrieveTransaction/RetrieveTransactionRequest.csharp
        java: /sdk_samples/RetrieveTransaction/RetrieveTransactionRequest.java
        php: /sdk_samples/RetrieveTransaction/RetrieveTransactionRequest.php
        javascript: /sdk_samples/RetrieveTransaction/RetrieveTransactionRequest.javascript
        ruby: /sdk_samples/RetrieveTransaction/RetrieveTransactionRequest.ruby
    RetrieveTransactionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        transaction:
          $ref: '#/components/schemas/Transaction'
      description: |-
        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).
      example:
        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
          reference_id: some optional reference id
          product: EXTERNAL_API
      deprecated: true
      x-property-order:
      - errors
      - transaction
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/transaction.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: RetrieveTransactionResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/RetrieveTransaction/RetrieveTransactionResponse.python
        csharp: /sdk_samples/RetrieveTransaction/RetrieveTransactionResponse.csharp
        java: /sdk_samples/RetrieveTransaction/RetrieveTransactionResponse.java
        php: /sdk_samples/RetrieveTransaction/RetrieveTransactionResponse.php
        javascript: /sdk_samples/RetrieveTransaction/RetrieveTransactionResponse.javascript
        ruby: /sdk_samples/RetrieveTransaction/RetrieveTransactionResponse.ruby
    SearchCustomersRequest:
      type: object
      properties:
        cursor:
          type: string
          description: |-
            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:
          maximum: 100
          minimum: 1
          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.
            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).
          format: int64
        query:
          $ref: '#/components/schemas/CustomerQuery'
      description: |-
        Defines the fields that are included in the request body of a request to the
        `SearchCustomers` endpoint.
      example:
        query:
          filter:
            email_address:
              fuzzy: example.com
            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
            group_ids:
              all:
              - 545AXB44B4XXWMVQ4W8SBT3HHF
          sort:
            field: CREATED_AT
            order: ASC
        limit: 2
      x-property-order:
      - cursor
      - limit
      - query
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: SearchCustomersRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/SearchCustomers/SearchCustomersRequest.python
        csharp: /sdk_samples/SearchCustomers/SearchCustomersRequest.csharp
        java: /sdk_samples/SearchCustomers/SearchCustomersRequest.java
        php: /sdk_samples/SearchCustomers/SearchCustomersRequest.php
        javascript: /sdk_samples/SearchCustomers/SearchCustomersRequest.javascript
        ruby: /sdk_samples/SearchCustomers/SearchCustomersRequest.ruby
    SearchCustomersResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        customers:
          type: array
          description: An array of `Customer` objects that match a query.
          items:
            $ref: '#/components/schemas/Customer'
        cursor:
          type: string
          description: |-
            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).
      description: |-
        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).
      example:
        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
          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
          reference_id: YOUR_REFERENCE_ID_2
          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
          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
          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
      x-property-order:
      - errors
      - customers
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: SearchCustomersResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/SearchCustomers/SearchCustomersResponse.python
        csharp: /sdk_samples/SearchCustomers/SearchCustomersResponse.csharp
        java: /sdk_samples/SearchCustomers/SearchCustomersResponse.java
        php: /sdk_samples/SearchCustomers/SearchCustomersResponse.php
        javascript: /sdk_samples/SearchCustomers/SearchCustomersResponse.javascript
        ruby: /sdk_samples/SearchCustomers/SearchCustomersResponse.ruby
    UpdateCustomerGroupRequest:
      required:
      - group
      type: object
      properties:
        group:
          $ref: '#/components/schemas/CustomerGroup'
      description: |-
        Defines the body parameters that can be included in a request to the
        [UpdateCustomerGroup](api-endpoint:CustomerGroups-UpdateCustomerGroup) endpoint.
      example:
        group:
          name: Loyal Customers
      x-property-order:
      - group
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: UpdateCustomerGroupRequest
    UpdateCustomerGroupResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        group:
          $ref: '#/components/schemas/CustomerGroup'
      description: |-
        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).
      example:
        group:
          id: 2TAT3CMH4Q0A9M87XJZED0WMR3
          name: Loyal Customers
          created_at: 2020-04-13T21:54:57.863Z
          updated_at: 2020-04-13T21:54:58Z
      x-property-order:
      - errors
      - group
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: UpdateCustomerGroupResponse
    UpdateCustomerRequest:
      type: object
      properties:
        given_name:
          type: string
          description: The given name (that is, the first name) associated with the
            customer profile.
        family_name:
          type: string
          description: The family name (that is, the last name) associated with the
            customer profile.
        company_name:
          type: string
          description: A business name associated with the customer profile.
        nickname:
          type: string
          description: A nickname for the customer profile.
        email_address:
          type: string
          description: The email address associated with the customer profile.
        address:
          $ref: '#/components/schemas/Address'
        phone_number:
          type: string
          description: The phone number associated with the customer profile. A phone
            number can contain 9–16 digits, with an optional `+` prefix.
        reference_id:
          type: string
          description: |-
            An optional second ID used to associate the customer profile with an
            entity in another system.
        note:
          type: string
          description: A custom note associated with the customer profile.
        birthday:
          type: string
          description: |-
            The birthday associated with the customer profile, in RFC 3339 format. The year is optional. The timezone and time are not allowed.
            For example, `0000-09-21T00:00:00-00:00` represents a birthday on September 21 and `1998-09-21T00:00:00-00:00` represents a birthday on September 21, 1998.
            You can also specify this value in `YYYY-MM-DD` format.
        version:
          type: integer
          description: |-
            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).
          format: int64
        tax_ids:
          $ref: '#/components/schemas/CustomerTaxIds'
      description: |-
        Defines the body parameters that can be included in a request to the
        `UpdateCustomer` endpoint.
      example:
        phone_number: ""
        email_address: New.Amelia.Earhart@example.com
        note: updated customer note
        version: 2
      x-property-order:
      - given_name
      - family_name
      - company_name
      - nickname
      - email_address
      - address
      - phone_number
      - reference_id
      - note
      - birthday
      - preferences
      - version
      - tax_ids
      - fields_to_clear
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: UpdateCustomerRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/UpdateCustomer/UpdateCustomerRequest.python
        csharp: /sdk_samples/UpdateCustomer/UpdateCustomerRequest.csharp
        java: /sdk_samples/UpdateCustomer/UpdateCustomerRequest.java
        php: /sdk_samples/UpdateCustomer/UpdateCustomerRequest.php
        javascript: /sdk_samples/UpdateCustomer/UpdateCustomerRequest.javascript
        ruby: /sdk_samples/UpdateCustomer/UpdateCustomerRequest.ruby
    UpdateCustomerResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        customer:
          $ref: '#/components/schemas/Customer'
      description: |-
        Defines the fields that are included in the response body of
        a request to the `UpdateCustomer` endpoint.

        Either `errors` or `customer` is present in a given response (never both).
      example:
        customer:
          id: JDKYHBWT1D4F8MFH63DBMEN8Y4
          created_at: 2016-03-23T20:21:54.859Z
          updated_at: 2016-05-15T20:21:55Z
          given_name: Amelia
          family_name: Earhart
          email_address: New.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
          reference_id: YOUR_REFERENCE_ID
          note: updated customer note
          preferences:
            email_unsubscribed: false
          creation_source: THIRD_PARTY
          version: 3
      x-property-order:
      - errors
      - customer
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: UpdateCustomerResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/UpdateCustomer/UpdateCustomerResponse.python
        csharp: /sdk_samples/UpdateCustomer/UpdateCustomerResponse.csharp
        java: /sdk_samples/UpdateCustomer/UpdateCustomerResponse.java
        php: /sdk_samples/UpdateCustomer/UpdateCustomerResponse.php
        javascript: /sdk_samples/UpdateCustomer/UpdateCustomerResponse.javascript
        ruby: /sdk_samples/UpdateCustomer/UpdateCustomerResponse.ruby
    VoidTransactionRequest:
      type: object
      properties: {}
      deprecated: true
      x-property-order: []
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/transaction.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: VoidTransactionRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/VoidTransaction/VoidTransactionRequest.python
        csharp: /sdk_samples/VoidTransaction/VoidTransactionRequest.csharp
        java: /sdk_samples/VoidTransaction/VoidTransactionRequest.java
        php: /sdk_samples/VoidTransaction/VoidTransactionRequest.php
        javascript: /sdk_samples/VoidTransaction/VoidTransactionRequest.javascript
        ruby: /sdk_samples/VoidTransaction/VoidTransactionRequest.ruby
    VoidTransactionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Defines the fields that are included in the response body of
        a request to the [VoidTransaction](api-endpoint:Transactions-VoidTransaction) endpoint.
      example: {}
      deprecated: true
      x-property-order:
      - errors
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/actions/transaction.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: VoidTransactionResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/VoidTransaction/VoidTransactionResponse.python
        csharp: /sdk_samples/VoidTransaction/VoidTransactionResponse.csharp
        java: /sdk_samples/VoidTransaction/VoidTransactionResponse.java
        php: /sdk_samples/VoidTransaction/VoidTransactionResponse.php
        javascript: /sdk_samples/VoidTransaction/VoidTransactionResponse.javascript
        ruby: /sdk_samples/VoidTransaction/VoidTransactionResponse.ruby
    AppointmentSegment:
      required:
      - team_member_id
      type: object
      properties:
        duration_minutes:
          maximum: 1500
          minimum: 0
          type: integer
          description: The time span in minutes of an appointment segment.
        service_variation_id:
          maxLength: 36
          minLength: 0
          type: string
          description: The ID of the [CatalogItemVariation](entity:CatalogItemVariation)
            object representing the service booked in this segment.
        team_member_id:
          maxLength: 32
          minLength: 1
          type: string
          description: The ID of the [TeamMember](entity:TeamMember) object representing
            the team member booked in this segment.
        service_variation_version:
          type: integer
          description: The current version of the item variation representing the
            service booked in this segment.
          format: int64
        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
          description: The IDs of the seller-accessible resources used for this appointment
            segment.
          readOnly: true
          items:
            maxLength: 65536
            minLength: 0
            type: string
      description: Defines an appointment segment of a booking.
      x-property-order:
      - duration_minutes
      - service_variation_id
      - team_member_id
      - service_variation_version
      - intermission_minutes
      - any_team_member
      - resource_ids
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: AppointmentSegment
    Availability:
      type: object
      properties:
        start_at:
          type: string
          description: The RFC 3339 timestamp specifying the beginning time of the
            slot available for booking.
        location_id:
          maxLength: 32
          minLength: 0
          type: string
          description: The ID of the location available for booking.
          readOnly: true
        appointment_segments:
          type: array
          description: The list of appointment segments available for booking
          items:
            $ref: '#/components/schemas/AppointmentSegment'
      description: Defines an appointment slot that encapsulates the appointment segments,
        location and starting time available for booking.
      x-property-order:
      - start_at
      - location_id
      - appointment_segments
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: Availability
    Booking:
      type: object
      properties:
        id:
          maxLength: 36
          minLength: 0
          type: string
          description: A unique ID of this object representing a booking.
          readOnly: true
        version:
          minimum: 0
          type: integer
          description: The revision number for the booking used for optimistic concurrency.
        status:
          $ref: '#/components/schemas/BookingStatus'
        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.
        location_id:
          maxLength: 32
          minLength: 0
          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.
        customer_id:
          maxLength: 192
          minLength: 0
          type: string
          description: The ID of the [Customer](entity:Customer) object representing
            the customer receiving the booked service.
        customer_note:
          maxLength: 4096
          minLength: 0
          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.
        seller_note:
          maxLength: 4096
          minLength: 0
          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.
            This field should not be visible to customers.
        appointment_segments:
          type: array
          description: A list of appointment segments for this booking.
          items:
            $ref: '#/components/schemas/AppointmentSegment'
        transition_time_minutes:
          type: integer
          description: |-
            Additional time at the end of a booking.
            Applications 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'
        creator_details:
          $ref: '#/components/schemas/BookingCreatorDetails'
        source:
          $ref: '#/components/schemas/BookingBookingSource'
      description: |-
        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.
      x-property-order:
      - id
      - version
      - status
      - created_at
      - updated_at
      - start_at
      - location_id
      - customer_id
      - customer_note
      - seller_note
      - appointment_segments
      - transition_time_minutes
      - all_day
      - location_type
      - creator_details
      - source
      - table_details
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: Booking
    BookingCreatorDetails:
      type: object
      properties:
        creator_type:
          $ref: '#/components/schemas/BookingCreatorDetailsCreatorType'
        team_member_id:
          maxLength: 32
          minLength: 0
          type: string
          description: |-
            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.
          readOnly: true
        customer_id:
          maxLength: 192
          minLength: 0
          type: string
          description: |-
            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.
          readOnly: true
      description: Information about a booking creator.
      x-property-order:
      - creator_type
      - team_member_id
      - customer_id
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: BookingCreatorDetails
    BusinessAppointmentSettings:
      type: object
      properties:
        location_types:
          type: array
          description: |-
            Types of the location allowed for bookings.
            See [BusinessAppointmentSettingsBookingLocationType](#type-businessappointmentsettingsbookinglocationtype) for possible values
          items:
            $ref: '#/components/schemas/BusinessAppointmentSettingsBookingLocationType'
        alignment_time:
          $ref: '#/components/schemas/BusinessAppointmentSettingsAlignmentTime'
        min_booking_lead_time_seconds:
          minimum: 0
          type: integer
          description: The minimum lead time in seconds before a service can be booked.
            Bookings must be created at least this far ahead of the booking's starting
            time.
        max_booking_lead_time_seconds:
          minimum: 0
          type: integer
          description: The maximum lead time in seconds before a service can be booked.
            Bookings must be created at most this far ahead of the booking's starting
            time.
        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
            automatically (`true`) or not (`false`).
        multiple_service_booking_enabled:
          type: boolean
          description: Indicates whether a customer can book multiple services in
            a single online booking.
        max_appointments_per_day_limit_type:
          $ref: '#/components/schemas/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType'
        max_appointments_per_day_limit:
          type: integer
          description: The maximum number of daily appointments per team member or
            per location.
        cancellation_window_seconds:
          minimum: 0
          type: integer
          description: The cut-off time in seconds for allowing clients to cancel
            or reschedule an appointment.
        cancellation_fee_money:
          $ref: '#/components/schemas/Money'
        cancellation_policy:
          $ref: '#/components/schemas/BusinessAppointmentSettingsCancellationPolicy'
        cancellation_policy_text:
          maxLength: 65536
          minLength: 0
          type: string
          description: The free-form text of the seller's cancellation policy.
        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`).
      description: The service appointment settings, including where and how the service
        is provided.
      x-property-order:
      - location_types
      - alignment_time
      - min_booking_lead_time_seconds
      - max_booking_lead_time_seconds
      - any_team_member_booking_enabled
      - multiple_service_booking_enabled
      - max_appointments_per_day_limit_type
      - max_appointments_per_day_limit
      - cancellation_window_seconds
      - cancellation_fee_money
      - cancellation_policy
      - cancellation_policy_text
      - skip_booking_flow_staff_selection
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: BusinessAppointmentSettings
    BusinessBookingProfile:
      type: object
      properties:
        seller_id:
          maxLength: 32
          minLength: 0
          type: string
          description: The ID of the seller, obtainable using the Merchants API.
        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.
        customer_timezone_choice:
          $ref: '#/components/schemas/BusinessBookingProfileCustomerTimezoneChoice'
        booking_policy:
          $ref: '#/components/schemas/BusinessBookingProfileBookingPolicy'
        allow_user_cancel:
          type: boolean
          description: Indicates whether customers can cancel or reschedule their
            own bookings (`true`) or not (`false`).
        business_appointment_settings:
          $ref: '#/components/schemas/BusinessAppointmentSettings'
        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.
      x-property-order:
      - seller_id
      - created_at
      - booking_enabled
      - customer_timezone_choice
      - booking_policy
      - allow_user_cancel
      - business_appointment_settings
      - support_seller_level_writes
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: BusinessBookingProfile
    CancelBookingRequest:
      type: object
      properties:
        idempotency_key:
          maxLength: 255
          minLength: 0
          type: string
          description: A unique key to make this request an idempotent operation.
        booking_version:
          minimum: 0
          type: integer
          description: The revision number for the booking used for optimistic concurrency.
      x-property-order:
      - idempotency_key
      - booking_version
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: CancelBookingRequest
    CancelBookingResponse:
      type: object
      properties:
        booking:
          $ref: '#/components/schemas/Booking'
        errors:
          type: array
          description: Errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        booking:
          id: zkras0xv0xwswx
          version: 1
          status: CANCELLED_BY_CUSTOMER
          created_at: 2020-10-28T15:47:41Z
          updated_at: 2020-10-28T15:49:25Z
          location_id: LEQHH0YY8B42M
          customer_id: EX2QSVGTZN4K1E5QE1CBFNVQ8M
          customer_note: ""
          seller_note: ""
          start_at: 2020-11-26T13:00:00Z
          appointment_segments:
          - duration_minutes: 60
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            team_member_id: TMXUrsBWWcHTt79t
            service_variation_version: 1599775456731
        errors: []
      x-property-order:
      - booking
      - errors
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: CancelBookingResponse
    CreateBookingRequest:
      required:
      - booking
      type: object
      properties:
        idempotency_key:
          maxLength: 255
          minLength: 0
          type: string
          description: A unique key to make this request an idempotent operation.
        booking:
          $ref: '#/components/schemas/Booking'
      x-property-order:
      - idempotency_key
      - booking
      - type
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: CreateBookingRequest
    CreateBookingResponse:
      type: object
      properties:
        booking:
          $ref: '#/components/schemas/Booking'
        errors:
          type: array
          description: Errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        booking:
          id: zkras0xv0xwswx
          version: 0
          status: ACCEPTED
          created_at: 2020-10-28T15:47:41Z
          updated_at: 2020-10-28T15:47:41Z
          location_id: LEQHH0YY8B42M
          customer_id: EX2QSVGTZN4K1E5QE1CBFNVQ8M
          customer_note: ""
          seller_note: ""
          start_at: 2020-11-26T13:00:00Z
          appointment_segments:
          - duration_minutes: 60
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            team_member_id: TMXUrsBWWcHTt79t
            service_variation_version: 1599775456731
        errors: []
      x-property-order:
      - booking
      - errors
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: CreateBookingResponse
    ListBookingsRequest:
      type: object
      properties:
        limit:
          maximum: 10000
          minimum: 1
          type: integer
          description: The maximum number of results per page to return in a paged
            response.
        cursor:
          maxLength: 65536
          minLength: 0
          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.
        team_member_id:
          maxLength: 32
          minLength: 0
          type: string
          description: The team member for whom to retrieve bookings. If this is not
            set, bookings of all members are retrieved.
        location_id:
          maxLength: 32
          minLength: 0
          type: string
          description: The location for which to retrieve bookings. If this is not
            set, all locations' bookings are retrieved.
        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.
        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.
      x-property-order:
      - limit
      - cursor
      - team_member_id
      - location_id
      - start_at_min
      - start_at_max
      - type
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: ListBookingsRequest
    ListBookingsResponse:
      type: object
      properties:
        bookings:
          type: array
          description: The list of targeted bookings.
          items:
            $ref: '#/components/schemas/Booking'
        cursor:
          maxLength: 65536
          minLength: 0
          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
          description: Errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        bookings:
        - id: zkras0xv0xwswx
          version: 1
          status: ACCEPTED
          created_at: 2020-10-28T15:47:41Z
          updated_at: 2020-10-28T15:49:25Z
          location_id: LEQHH0YY8B42M
          customer_id: EX2QSVGTZN4K1E5QE1CBFNVQ8M
          customer_note: ""
          seller_note: ""
          start_at: 2020-11-26T13:00:00Z
          appointment_segments:
          - duration_minutes: 60
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            team_member_id: TMXUrsBWWcHTt79t
            service_variation_version: 1599775456731
        errors: []
        cursor: null
      x-property-order:
      - bookings
      - cursor
      - errors
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: ListBookingsResponse
    ListTeamMemberBookingProfilesRequest:
      type: object
      properties:
        bookable_only:
          type: boolean
          description: Indicates whether to include only bookable team members in
            the returned result (`true`) or not (`false`).
        limit:
          maximum: 100
          minimum: 1
          type: integer
          description: The maximum number of results to return in a paged response.
        cursor:
          maxLength: 65536
          minLength: 0
          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.
        location_id:
          maxLength: 32
          minLength: 0
          type: string
          description: Indicates whether to include only team members enabled at the
            given location in the returned result.
      x-property-order:
      - bookable_only
      - limit
      - cursor
      - location_id
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: ListTeamMemberBookingProfilesRequest
    ListTeamMemberBookingProfilesResponse:
      type: object
      properties:
        team_member_booking_profiles:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/TeamMemberBookingProfile'
        cursor:
          maxLength: 65536
          minLength: 0
          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
          description: Errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        team_member_booking_profiles:
        - team_member_id: TMXUrsBWWcHTt79t
          display_name: Sandbox Seller
          is_bookable: true
        - team_member_id: TMaJcbiRqPIGZuS9
          display_name: Sandbox Staff
          is_bookable: true
        errors: []
      x-property-order:
      - team_member_booking_profiles
      - cursor
      - errors
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: ListTeamMemberBookingProfilesResponse
    RetrieveBookingRequest:
      type: object
      properties: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: RetrieveBookingRequest
    RetrieveBookingResponse:
      type: object
      properties:
        booking:
          $ref: '#/components/schemas/Booking'
        errors:
          type: array
          description: Errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        booking:
          id: zkras0xv0xwswx
          version: 1
          status: ACCEPTED
          created_at: 2020-10-28T15:47:41Z
          updated_at: 2020-10-28T15:49:25Z
          location_id: LEQHH0YY8B42M
          customer_id: EX2QSVGTZN4K1E5QE1CBFNVQ8M
          customer_note: ""
          seller_note: ""
          start_at: 2020-11-26T13:00:00Z
          appointment_segments:
          - duration_minutes: 60
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            team_member_id: TMXUrsBWWcHTt79t
            service_variation_version: 1599775456731
        errors: []
      x-property-order:
      - booking
      - errors
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: RetrieveBookingResponse
    RetrieveBusinessBookingProfileRequest:
      type: object
      properties: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: RetrieveBusinessBookingProfileRequest
    RetrieveBusinessBookingProfileResponse:
      type: object
      properties:
        business_booking_profile:
          $ref: '#/components/schemas/BusinessBookingProfile'
        errors:
          type: array
          description: Errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        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
            cancellation_fee_money:
              currency: USD
            cancellation_policy: CUSTOM_POLICY
            skip_booking_flow_staff_selection: false
        errors: []
      x-property-order:
      - business_booking_profile
      - errors
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: RetrieveBusinessBookingProfileResponse
    RetrieveTeamMemberBookingProfileRequest:
      type: object
      properties: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: RetrieveTeamMemberBookingProfileRequest
    RetrieveTeamMemberBookingProfileResponse:
      type: object
      properties:
        team_member_booking_profile:
          $ref: '#/components/schemas/TeamMemberBookingProfile'
        errors:
          type: array
          description: Errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        team_member_booking_profile:
          team_member_id: TMaJcbiRqPIGZuS9
          display_name: Sandbox Staff
          is_bookable: true
        errors: []
      x-property-order:
      - team_member_booking_profile
      - errors
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: RetrieveTeamMemberBookingProfileResponse
    SearchAvailabilityFilter:
      required:
      - start_at_range
      type: object
      properties:
        start_at_range:
          $ref: '#/components/schemas/TimeRange'
        location_id:
          maxLength: 32
          minLength: 0
          type: string
          description: |-
            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:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/SegmentFilter'
        booking_id:
          maxLength: 36
          minLength: 0
          type: string
          description: |-
            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.
      description: A query filter to search for buyer-accessible availabilities by.
      x-property-order:
      - start_at_range
      - location_id
      - segment_filters
      - booking_id
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: SearchAvailabilityFilter
    SearchAvailabilityQuery:
      required:
      - filter
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/SearchAvailabilityFilter'
      description: The query used to search for buyer-accessible availabilities of
        bookings.
      x-property-order:
      - filter
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: SearchAvailabilityQuery
    SearchAvailabilityRequest:
      required:
      - query
      type: object
      properties:
        query:
          $ref: '#/components/schemas/SearchAvailabilityQuery'
      x-property-order:
      - query
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: SearchAvailabilityRequest
    SearchAvailabilityResponse:
      type: object
      properties:
        availabilities:
          type: array
          description: List of appointment slots available for booking.
          items:
            $ref: '#/components/schemas/Availability'
        errors:
          type: array
          description: Errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        availabilities:
        - start_at: 2020-11-26T13:00:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMXUrsBWWcHTt79t
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        - start_at: 2020-11-26T13:30:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMXUrsBWWcHTt79t
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        - start_at: 2020-11-26T14:00:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMaJcbiRqPIGZuS9
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        - start_at: 2020-11-26T14:30:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMaJcbiRqPIGZuS9
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        - start_at: 2020-11-26T15:00:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMaJcbiRqPIGZuS9
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        - start_at: 2020-11-26T15:30:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMaJcbiRqPIGZuS9
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        - start_at: 2020-11-26T16:00:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMaJcbiRqPIGZuS9
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        - start_at: 2020-11-27T09:00:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMXUrsBWWcHTt79t
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        - start_at: 2020-11-27T09:30:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMaJcbiRqPIGZuS9
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        - start_at: 2020-11-27T10:00:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMXUrsBWWcHTt79t
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        - start_at: 2020-11-27T10:30:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMXUrsBWWcHTt79t
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        - start_at: 2020-11-27T11:00:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMXUrsBWWcHTt79t
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        - start_at: 2020-11-27T11:30:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMaJcbiRqPIGZuS9
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        - start_at: 2020-11-27T12:00:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMaJcbiRqPIGZuS9
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        - start_at: 2020-11-27T12:30:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMaJcbiRqPIGZuS9
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        - start_at: 2020-11-27T13:00:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMXUrsBWWcHTt79t
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        - start_at: 2020-11-27T13:30:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMXUrsBWWcHTt79t
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        - start_at: 2020-11-27T14:00:00Z
          location_id: LEQHH0YY8B42M
          appointment_segments:
          - duration_minutes: 60
            team_member_id: TMaJcbiRqPIGZuS9
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            service_variation_version: 1599775456731
        errors: []
      x-property-order:
      - availabilities
      - errors
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: SearchAvailabilityResponse
    SegmentFilter:
      required:
      - service_variation_id
      type: object
      properties:
        service_variation_id:
          maxLength: 36
          minLength: 1
          type: string
          description: The ID of the [CatalogItemVariation](entity:CatalogItemVariation)
            object representing the service booked in this segment.
        team_member_id_filter:
          $ref: '#/components/schemas/FilterValue'
      description: A query filter to search for buyer-accessible appointment segments
        by.
      x-property-order:
      - service_variation_id
      - team_member_id_filter
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: SegmentFilter
    TeamMemberBookingProfile:
      type: object
      properties:
        team_member_id:
          maxLength: 32
          minLength: 0
          type: string
          description: The ID of the [TeamMember](entity:TeamMember) object for the
            team member associated with the booking profile.
          readOnly: true
        description:
          maxLength: 65536
          minLength: 0
          type: string
          description: The description of the team member.
          readOnly: true
        display_name:
          maxLength: 512
          minLength: 0
          type: string
          description: The display name of the team member.
          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`).
        profile_image_url:
          maxLength: 2048
          minLength: 0
          type: string
          description: The URL of the team member's image for the bookings profile.
          readOnly: true
      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-property-order:
      - team_member_id
      - description
      - display_name
      - is_bookable
      - profile_image_url
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: TeamMemberBookingProfile
    UpdateBookingRequest:
      required:
      - booking
      type: object
      properties:
        idempotency_key:
          maxLength: 255
          minLength: 0
          type: string
          description: A unique key to make this request an idempotent operation.
        booking:
          $ref: '#/components/schemas/Booking'
      x-property-order:
      - idempotency_key
      - booking
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: UpdateBookingRequest
    UpdateBookingResponse:
      type: object
      properties:
        booking:
          $ref: '#/components/schemas/Booking'
        errors:
          type: array
          description: Errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        booking:
          id: zkras0xv0xwswx
          version: 2
          status: ACCEPTED
          created_at: 2020-10-28T15:47:41Z
          updated_at: 2020-10-28T15:49:25Z
          location_id: LEQHH0YY8B42M
          customer_id: EX2QSVGTZN4K1E5QE1CBFNVQ8M
          customer_note: I would like to sit near the window please
          seller_note: ""
          start_at: 2020-11-26T13:00:00Z
          appointment_segments:
          - duration_minutes: 60
            service_variation_id: RU3PBTZTK7DXZDQFCJHOK2MC
            team_member_id: TMXUrsBWWcHTt79t
            service_variation_version: 1599775456731
        errors: []
      x-property-order:
      - booking
      - errors
      x-release-status: PUBLIC
      x-proto-repo: appointments
      x-proto-location: /protos/squareup/appointments/api/public.proto
      x-proto-sha: 997e21095e1f8f4358d49e9666da4ed1263f733c
      x-object-name: UpdateBookingResponse
    Checkout:
      type: object
      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
            checkout is completed.
        ask_for_shipping_address:
          type: boolean
          description: |-
            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: string
          description: |-
            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: string
          description: |-
            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:
          $ref: '#/components/schemas/Address'
        redirect_url:
          type: string
          description: |-
            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:

            <pre><code>http://www.example.com/order-complete?checkoutId=xxxxxx&amp;orderId=xxxxxx&amp;referenceId=xxxxxx&amp;transactionId=xxxxxx</code></pre>

            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:
          $ref: '#/components/schemas/Order'
        created_at:
          type: string
          description: The time when the checkout was created, in RFC 3339 format.
          readOnly: true
        additional_recipients:
          type: array
          description: |-
            Additional recipients (other than the merchant) receiving a portion of this checkout.
            For example, fees assessed on the purchase by a third party integration.
          items:
            $ref: '#/components/schemas/AdditionalRecipient'
          x-release-status: DEPRECATED
      description: |-
        Square Checkout lets merchants accept online payments for supported
        payment types using a checkout workflow hosted on squareup.com.
      x-property-order:
      - id
      - checkout_page_url
      - ask_for_shipping_address
      - merchant_support_email
      - pre_populate_buyer_email
      - pre_populate_shipping_address
      - redirect_url
      - order
      - created_at
      - additional_recipients
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/checkout/resources/checkout.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: Checkout
    Coordinates:
      type: object
      properties:
        latitude:
          type: number
          description: The latitude of the coordinate expressed in degrees.
        longitude:
          type: number
          description: The longitude of the coordinate expressed in degrees.
      description: Latitude and longitude coordinates.
      x-property-order:
      - latitude
      - longitude
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/coordinates.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: Coordinates
    FilterValue:
      type: object
      properties:
        all:
          type: array
          description: A list of terms that must be present on the field of the resource.
          items:
            type: string
        any:
          type: array
          description: |-
            A list of terms where at least one of them must be present on the
            field of the resource.
          items:
            type: string
        none:
          type: array
          description: A list of terms that must not be present on the field the resource
          items:
            type: string
      description: |-
        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.
      x-property-order:
      - all
      - any
      - none
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/filters.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: FilterValue
    FloatNumberRange:
      type: object
      properties:
        start_at:
          type: string
          description: A decimal value indicating where the range starts.
        end_at:
          type: string
          description: A decimal value indicating where the range ends.
      description: Specifies a decimal number range.
      x-property-order:
      - start_at
      - end_at
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/number.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: FloatNumberRange
    MeasurementUnit:
      type: object
      properties:
        custom_unit:
          $ref: '#/components/schemas/MeasurementUnitCustom'
        area_unit:
          $ref: '#/components/schemas/MeasurementUnitArea'
        length_unit:
          $ref: '#/components/schemas/MeasurementUnitLength'
        volume_unit:
          $ref: '#/components/schemas/MeasurementUnitVolume'
        weight_unit:
          $ref: '#/components/schemas/MeasurementUnitWeight'
        generic_unit:
          $ref: '#/components/schemas/MeasurementUnitGeneric'
        time_unit:
          $ref: '#/components/schemas/MeasurementUnitTime'
        type:
          $ref: '#/components/schemas/MeasurementUnitUnitType'
      description: |-
        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`.
      x-property-order:
      - custom_unit
      - area_unit
      - length_unit
      - volume_unit
      - weight_unit
      - generic_unit
      - time_unit
      - type
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/measurement_units.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: MeasurementUnit
    MeasurementUnitCustom:
      required:
      - abbreviation
      - name
      type: object
      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
            in the cart for the Point of Sale app, and in reports.
      description: The information needed to define a custom unit, provided by the
        seller.
      x-property-order:
      - name
      - abbreviation
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/measurement_units.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: MeasurementUnitCustom
    Money:
      type: object
      properties:
        amount:
          type: integer
          description: |-
            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.
          format: int64
        currency:
          $ref: '#/components/schemas/Currency'
      description: |-
        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.
      x-property-order:
      - amount
      - currency
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/money.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: Money
    SourceApplication:
      type: object
      properties:
        product:
          $ref: '#/components/schemas/Product'
        application_id:
          type: string
          description: |-
            __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: string
          description: |-
            __Read only__ The display name of the application
            (for example, `"Custom Application"` or `"Square POS 4.74 for Android"`).
      description: Represents information about the application used to generate a
        change.
      x-property-order:
      - product
      - application_id
      - name
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/source_application.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: SourceApplication
    TimeRange:
      type: object
      properties:
        start_at:
          type: string
          description: |-
            A datetime value in RFC 3339 format indicating when the time range
            starts.
        end_at:
          type: string
          description: |-
            A datetime value in RFC 3339 format indicating when the time range
            ends.
      description: |-
        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.
      x-property-order:
      - start_at
      - end_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/common/date.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: TimeRange
    Site:
      type: object
      properties:
        id:
          maxLength: 32
          type: string
          description: The Square-assigned ID of the site.
          readOnly: true
        site_title:
          type: string
          description: The title of the site.
        domain:
          type: string
          description: The domain of the site (without the protocol). For example,
            `mysite1.square.site`.
        is_published:
          type: boolean
          description: Indicates whether the site is published.
        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
      description: Represents a Square Online site, which is an online store for a
        Square seller.
      x-property-order:
      - id
      - site_title
      - domain
      - is_published
      - created_at
      - updated_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /ecom-connect/protos/squareup/ecom_connect/resources/ecom_connect.proto
      x-proto-sha: c54c1535059f8fd72c72358b3b12e2b51e50be6a
      x-object-name: Site
    Snippet:
      required:
      - content
      type: object
      properties:
        id:
          maxLength: 48
          type: string
          description: The Square-assigned ID for the snippet.
          readOnly: true
        site_id:
          type: string
          description: The ID of the site that contains the snippet.
          readOnly: true
        content:
          maxLength: 65535
          minLength: 1
          type: string
          description: The snippet code, which can contain valid HTML, JavaScript,
            or both.
        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
      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-property-order:
      - id
      - site_id
      - content
      - created_at
      - updated_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /ecom-connect/protos/squareup/ecom_connect/resources/ecom_connect.proto
      x-proto-sha: c54c1535059f8fd72c72358b3b12e2b51e50be6a
      x-object-name: Snippet
    DeleteSnippetRequest:
      type: object
      properties: {}
      description: Represents a `DeleteSnippet` request.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /ecom-connect/protos/squareup/ecom_connect/service/delete_snippet.proto
      x-proto-sha: c54c1535059f8fd72c72358b3b12e2b51e50be6a
      x-object-name: DeleteSnippetRequest
    DeleteSnippetResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Represents a `DeleteSnippet` response.
      example: {}
      x-property-order:
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /ecom-connect/protos/squareup/ecom_connect/service/delete_snippet.proto
      x-proto-sha: c54c1535059f8fd72c72358b3b12e2b51e50be6a
      x-object-name: DeleteSnippetResponse
    ListSitesRequest:
      type: object
      properties: {}
      description: Represents a `ListSites` request.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /ecom-connect/protos/squareup/ecom_connect/service/list_sites.proto
      x-proto-sha: c54c1535059f8fd72c72358b3b12e2b51e50be6a
      x-object-name: ListSitesRequest
    ListSitesResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        sites:
          type: array
          description: The sites that belong to the seller.
          items:
            $ref: '#/components/schemas/Site'
      description: Represents a `ListSites` response. The response can include either
        `sites` or `errors`.
      example:
        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
      x-property-order:
      - errors
      - sites
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /ecom-connect/protos/squareup/ecom_connect/service/list_sites.proto
      x-proto-sha: c54c1535059f8fd72c72358b3b12e2b51e50be6a
      x-object-name: ListSitesResponse
    RetrieveSnippetRequest:
      type: object
      properties: {}
      description: Represents a `RetrieveSnippet` request.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /ecom-connect/protos/squareup/ecom_connect/service/retrieve_snippet.proto
      x-proto-sha: c54c1535059f8fd72c72358b3b12e2b51e50be6a
      x-object-name: RetrieveSnippetRequest
    RetrieveSnippetResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        snippet:
          $ref: '#/components/schemas/Snippet'
      description: Represents a `RetrieveSnippet` response. The response can include
        either `snippet` or `errors`.
      example:
        snippet:
          id: snippet_5d178150-a6c0-11eb-a9f1-437e6a2881e7
          site_id: site_278075276488921835
          content: <script>var js = 1;</script>
          created_at: 2021-03-11T25:40:09.000000Z
          updated_at: 2021-03-11T25:40:09.000000Z
      x-property-order:
      - errors
      - snippet
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /ecom-connect/protos/squareup/ecom_connect/service/retrieve_snippet.proto
      x-proto-sha: c54c1535059f8fd72c72358b3b12e2b51e50be6a
      x-object-name: RetrieveSnippetResponse
    SnippetResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        snippet:
          $ref: '#/components/schemas/Snippet'
      x-property-order:
      - errors
      - snippet
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /ecom-connect/protos/squareup/ecom_connect/service/common.proto
      x-proto-sha: c54c1535059f8fd72c72358b3b12e2b51e50be6a
      x-object-name: SnippetResponse
    UpsertSnippetRequest:
      required:
      - snippet
      type: object
      properties:
        snippet:
          $ref: '#/components/schemas/Snippet'
      description: Represents an `UpsertSnippet` request.
      example:
        snippet:
          content: <script>var js = 1;</script>
      x-property-order:
      - snippet
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /ecom-connect/protos/squareup/ecom_connect/service/upsert_snippet.proto
      x-proto-sha: c54c1535059f8fd72c72358b3b12e2b51e50be6a
      x-object-name: UpsertSnippetRequest
    UpsertSnippetResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        snippet:
          $ref: '#/components/schemas/Snippet'
      description: Represents an `UpsertSnippet` response. The response can include
        either `snippet` or `errors`.
      example:
        snippet:
          id: snippet_5d178150-a6c0-11eb-a9f1-437e6a2881e7
          site_id: site_278075276488921835
          content: <script>var js = 1;</script>
          created_at: 2021-03-11T25:40:09.000000Z
          updated_at: 2021-03-11T25:40:09.000000Z
      x-property-order:
      - errors
      - snippet
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /ecom-connect/protos/squareup/ecom_connect/service/upsert_snippet.proto
      x-proto-sha: c54c1535059f8fd72c72358b3b12e2b51e50be6a
      x-object-name: UpsertSnippetResponse
    InventoryAdjustment:
      type: object
      properties:
        id:
          maxLength: 100
          type: string
          description: |-
            A unique ID generated by Square for the
            `InventoryAdjustment`.
        reference_id:
          maxLength: 255
          type: string
          description: |-
            An optional ID provided by the application to tie the
            `InventoryAdjustment` to an external
            system.
        from_status:
          $ref: '#/components/schemas/InventoryState'
        to_status:
          $ref: '#/components/schemas/InventoryState'
        from_state:
          $ref: '#/components/schemas/InventoryState'
        to_state:
          $ref: '#/components/schemas/InventoryState'
        from_location_id:
          type: string
          description: |-
            The Square-generated ID of the [Location](entity:Location) where the related
            quantity of items is being tracked before the adjustment. Replaced by
            `from_location_id` of [InventoryTransfer](entity:InventoryTransfer).
          x-release-status: RETIRED
        to_location_id:
          type: string
          description: |-
            The Square-generated ID of the [Location](entity:Location) where the related
            quantity of items is being tracked after the adjustment. Replaced by
            `to_location_id` of [InventoryTransfer](entity:InventoryTransfer).
          x-release-status: RETIRED
        location_id:
          maxLength: 100
          type: string
          description: |-
            The Square-generated ID of the [Location](entity:Location) where the related
            quantity of items is being tracked.
        catalog_object_id:
          maxLength: 100
          type: string
          description: |-
            The Square-generated ID of the
            [CatalogObject](entity:CatalogObject) being tracked.
        catalog_object_type:
          maxLength: 14
          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."
        quantity:
          maxLength: 26
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Money'
        occurred_at:
          maxLength: 34
          type: string
          description: |-
            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:
          maxLength: 34
          type: string
          description: An RFC 3339-formatted timestamp that indicates when the inventory
            adjustment is received.
          readOnly: true
        source:
          $ref: '#/components/schemas/SourceApplication'
        employee_id:
          maxLength: 100
          type: string
          description: |-
            The Square-generated ID of the [Employee](entity:Employee) responsible for the
            inventory adjustment.
        team_member_id:
          maxLength: 100
          type: string
          description: |-
            The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the
            inventory adjustment.
        transaction_id:
          maxLength: 255
          type: string
          description: |-
            The Square-generated ID of the [Transaction](entity:Transaction) that
            caused the adjustment. Only relevant for payment-related state
            transitions.
          readOnly: true
        refund_id:
          maxLength: 255
          type: string
          description: |-
            The Square-generated ID of the [Refund](entity:Refund) that
            caused the adjustment. Only relevant for refund-related state
            transitions.
          readOnly: true
        purchase_order_id:
          maxLength: 100
          type: string
          description: |-
            The Square-generated ID of the purchase order that caused the
            adjustment. Only relevant for state transitions from the Square for Retail
            app.
          readOnly: true
        goods_receipt_id:
          maxLength: 100
          type: string
          description: |-
            The Square-generated ID of the goods receipt that caused the
            adjustment. Only relevant for state transitions from the Square for Retail
            app.
          readOnly: true
        adjustment_group:
          $ref: '#/components/schemas/InventoryAdjustmentGroup'
      description: |-
        Represents a change in state or quantity of product inventory at a
        particular time and location.
      x-property-order:
      - id
      - reference_id
      - from_status
      - to_status
      - from_state
      - to_state
      - from_location_id
      - to_location_id
      - location_id
      - catalog_object_id
      - catalog_object_type
      - quantity
      - total_cost_money
      - total_price_money
      - occurred_at
      - created_at
      - source
      - employee_id
      - team_member_id
      - transaction_id
      - refund_id
      - purchase_order_id
      - goods_receipt_id
      - adjustment_group
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/resources/inventory.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: InventoryAdjustment
    InventoryAdjustmentGroup:
      type: object
      properties:
        id:
          maxLength: 100
          type: string
          description: |-
            A unique ID generated by Square for the
            `InventoryAdjustmentGroup`.
          readOnly: true
        root_adjustment_id:
          maxLength: 100
          type: string
          description: The inventory adjustment of the composed variation.
          readOnly: true
        from_state:
          $ref: '#/components/schemas/InventoryState'
        to_state:
          $ref: '#/components/schemas/InventoryState'
      x-property-order:
      - id
      - root_adjustment_id
      - from_state
      - to_state
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/resources/inventory.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: InventoryAdjustmentGroup
    InventoryChange:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/InventoryChangeType'
        physical_count:
          $ref: '#/components/schemas/InventoryPhysicalCount'
        adjustment:
          $ref: '#/components/schemas/InventoryAdjustment'
        transfer:
          $ref: '#/components/schemas/InventoryTransfer'
        measurement_unit:
          $ref: '#/components/schemas/CatalogMeasurementUnit'
        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
      description: |-
        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.
      x-property-order:
      - type
      - physical_count
      - adjustment
      - transfer
      - availability
      - measurement_unit
      - measurement_unit_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/resources/inventory.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: InventoryChange
    InventoryCount:
      type: object
      properties:
        catalog_object_id:
          maxLength: 100
          type: string
          description: |-
            The Square-generated ID of the
            [CatalogObject](entity:CatalogObject) being tracked.
        catalog_object_type:
          maxLength: 14
          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."
        status:
          $ref: '#/components/schemas/InventoryState'
        state:
          $ref: '#/components/schemas/InventoryState'
        location_id:
          maxLength: 100
          type: string
          description: |-
            The Square-generated ID of the [Location](entity:Location) where the related
            quantity of items is being tracked.
        quantity:
          maxLength: 26
          type: string
          description: |-
            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:
          maxLength: 34
          type: string
          description: |-
            An RFC 3339-formatted timestamp that indicates when the most recent physical count or adjustment affecting
            the estimated count is received.
          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
            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).
          readOnly: true
          x-release-status: BETA
      description: |-
        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.
      x-property-order:
      - catalog_object_id
      - catalog_object_type
      - status
      - state
      - location_id
      - quantity
      - calculated_at
      - availability_state
      - is_estimated
      - sold_out_valid_until
      - quantity_committed
      - quantity_available
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/resources/inventory.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: InventoryCount
    InventoryPhysicalCount:
      type: object
      properties:
        id:
          maxLength: 100
          type: string
          description: |-
            A unique Square-generated ID for the
            [InventoryPhysicalCount](entity:InventoryPhysicalCount).
        reference_id:
          maxLength: 255
          type: string
          description: |-
            An optional ID provided by the application to tie the
            [InventoryPhysicalCount](entity:InventoryPhysicalCount) to an external
            system.
        catalog_object_id:
          maxLength: 100
          type: string
          description: |-
            The Square-generated ID of the
            [CatalogObject](entity:CatalogObject) being tracked.
        catalog_object_type:
          maxLength: 14
          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."
        status:
          $ref: '#/components/schemas/InventoryState'
        state:
          $ref: '#/components/schemas/InventoryState'
        location_id:
          maxLength: 100
          type: string
          description: |-
            The Square-generated ID of the [Location](entity:Location) where the related
            quantity of items is being tracked.
        quantity:
          maxLength: 26
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/SourceApplication'
        employee_id:
          maxLength: 100
          type: string
          description: |-
            The Square-generated ID of the [Employee](entity:Employee) responsible for the
            physical count.
        team_member_id:
          maxLength: 100
          type: string
          description: |-
            The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the
            physical count.
        occurred_at:
          maxLength: 34
          type: string
          description: |-
            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:
          maxLength: 34
          type: string
          description: An RFC 3339-formatted timestamp that indicates when the physical
            count is received.
          readOnly: true
      description: |-
        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.
      x-property-order:
      - id
      - reference_id
      - catalog_object_id
      - catalog_object_type
      - status
      - state
      - location_id
      - quantity
      - source
      - employee_id
      - team_member_id
      - occurred_at
      - created_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/resources/inventory.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: InventoryPhysicalCount
    InventoryTransfer:
      type: object
      properties:
        id:
          maxLength: 100
          type: string
          description: |-
            A unique ID generated by Square for the
            `InventoryTransfer`.
        reference_id:
          maxLength: 255
          type: string
          description: |-
            An optional ID provided by the application to tie the
            `InventoryTransfer` to an external system.
        state:
          $ref: '#/components/schemas/InventoryState'
        from_location_id:
          maxLength: 100
          type: string
          description: |-
            The Square-generated ID of the [Location](entity:Location) where the related
            quantity of items was tracked before the transfer.
        to_location_id:
          maxLength: 100
          type: string
          description: |-
            The Square-generated ID of the [Location](entity:Location) where the related
            quantity of items was tracked after the transfer.
        catalog_object_id:
          maxLength: 100
          type: string
          description: |-
            The Square-generated ID of the
            [CatalogObject](entity:CatalogObject) being tracked.
        catalog_object_type:
          maxLength: 14
          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."
        quantity:
          maxLength: 26
          type: string
          description: |-
            The number of items affected by the transfer as a decimal string.
            Can support up to 5 digits after the decimal point.
        occurred_at:
          maxLength: 34
          type: string
          description: |-
            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:
          maxLength: 34
          type: string
          description: |-
            An RFC 3339-formatted timestamp that indicates when Square
            received the transfer request.
          readOnly: true
        source:
          $ref: '#/components/schemas/SourceApplication'
        employee_id:
          maxLength: 100
          type: string
          description: |-
            The Square-generated ID of the [Employee](entity:Employee) responsible for the
            inventory transfer.
        team_member_id:
          maxLength: 100
          type: string
          description: |-
            The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the
            inventory transfer.
      description: |-
        Represents the transfer of a quantity of product inventory at a
        particular time from one location to another.
      x-property-order:
      - id
      - reference_id
      - state
      - from_location_id
      - to_location_id
      - catalog_object_id
      - catalog_object_type
      - quantity
      - occurred_at
      - created_at
      - source
      - employee_id
      - team_member_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/resources/inventory.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: InventoryTransfer
    Vendor:
      type: object
      properties:
        id:
          maxLength: 100
          type: string
          description: |-
            A unique Square-generated ID for the [Vendor](entity:Vendor).
            This field is required when attempting to update a [Vendor](entity:Vendor).
        created_at:
          maxLength: 34
          type: string
          description: |-
            An RFC 3339-formatted timestamp that indicates when the
            [Vendor](entity:Vendor) was created.
          readOnly: true
        updated_at:
          maxLength: 34
          type: string
          description: |-
            An RFC 3339-formatted timestamp that indicates when the
            [Vendor](entity:Vendor) was last updated.
          readOnly: true
        name:
          maxLength: 100
          type: string
          description: |-
            The name of the [Vendor](entity:Vendor).
            This field is required when attempting to create or update a [Vendor](entity:Vendor).
        address:
          $ref: '#/components/schemas/Address'
        contacts:
          type: array
          description: The contacts of the [Vendor](entity:Vendor).
          items:
            $ref: '#/components/schemas/VendorContact'
        account_number:
          maxLength: 100
          type: string
          description: The account number of the [Vendor](entity:Vendor).
        note:
          maxLength: 4096
          type: string
          description: A note detailing information about the [Vendor](entity:Vendor).
        version:
          minimum: 0
          type: integer
          description: The version of the [Vendor](entity:Vendor).
        status:
          $ref: '#/components/schemas/VendorStatus'
      description: Represents a supplier to a seller.
      x-property-order:
      - id
      - created_at
      - updated_at
      - name
      - address
      - contacts
      - account_number
      - note
      - version
      - status
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/resources/inventory.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: Vendor
    VendorContact:
      required:
      - ordinal
      type: object
      properties:
        id:
          maxLength: 100
          type: string
          description: |-
            A unique Square-generated ID for the [VendorContact](entity:VendorContact).
            This field is required when attempting to update a [VendorContact](entity:VendorContact).
        name:
          maxLength: 255
          type: string
          description: |-
            The name of the [VendorContact](entity:VendorContact).
            This field is required when attempting to create a [Vendor](entity:Vendor).
        email_address:
          maxLength: 255
          type: string
          description: The email address of the [VendorContact](entity:VendorContact).
        phone_number:
          maxLength: 255
          type: string
          description: The phone number of the [VendorContact](entity:VendorContact).
        removed:
          type: boolean
          description: The state of the [VendorContact](entity:VendorContact).
        ordinal:
          minimum: 0
          type: integer
          description: The ordinal of the [VendorContact](entity:VendorContact).
      description: Represents a contact of a [Vendor](entity:Vendor).
      x-property-order:
      - id
      - name
      - email_address
      - phone_number
      - removed
      - ordinal
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/resources/inventory.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: VendorContact
    BatchChangeInventoryRequest:
      required:
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          maxLength: 128
          minLength: 1
          type: string
          description: |-
            A client-supplied, universally unique identifier (UUID) for the
            request.

            See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) in the
            [API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more
            information.
        changes:
          maxItems: 100
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/InventoryChange'
        ignore_unchanged_counts:
          type: boolean
          description: |-
            Indicates whether the current physical count should be ignored if
            the quantity is unchanged since the last physical count. Default: `true`.
      example:
        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
      x-property-order:
      - idempotency_key
      - changes
      - ignore_unchanged_counts
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/batch_change_inventory.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: BatchChangeInventoryRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.python
        csharp: /sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.csharp
        java: /sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.java
        php: /sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.php
        javascript: /sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.javascript
        ruby: /sdk_samples/Inventory/BatchChangeInventory/BatchChangeInventoryRequest.ruby
    BatchChangeInventoryResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        counts:
          type: array
          description: The current counts for all objects referenced in the request.
          items:
            $ref: '#/components/schemas/InventoryCount'
        changes:
          type: array
          description: Changes created for the request.
          items:
            $ref: '#/components/schemas/InventoryChange'
          x-release-status: BETA
      example:
        errors: []
        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
      x-property-order:
      - errors
      - counts
      - changes
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/batch_change_inventory.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: BatchChangeInventoryResponse
    BatchRetrieveInventoryChangesRequest:
      type: object
      properties:
        catalog_object_ids:
          maxItems: 500
          type: array
          description: |-
            The filter to return results by `CatalogObject` ID.
            The filter is only applicable when set. The default value is null.
          items:
            type: string
        location_ids:
          type: array
          description: |-
            The filter to return results by `Location` ID.
            The filter is only applicable when set. The default value is null.
          items:
            type: string
        types:
          type: array
          description: |-
            The filter to return results by `InventoryChangeType` values other than `TRANSFER`.
            The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`.
          items:
            $ref: '#/components/schemas/InventoryChangeType'
        statuses:
          type: array
          description: |-
            The filter to return results by `InventoryState` values.
            Use the  `states` filter as its replacement.
          items:
            $ref: '#/components/schemas/InventoryState'
          x-release-status: RETIRED
        states:
          type: array
          description: |-
            The filter to return `ADJUSTMENT` query results by
            `InventoryState`. This filter is only applied when set.
            The default value is null.
          items:
            $ref: '#/components/schemas/InventoryState'
        updated_after:
          type: string
          description: |-
            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: string
          description: |-
            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: string
          description: |-
            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:
          maximum: 1000
          minimum: 1
          type: integer
          description: The number of [records](entity:InventoryChange) to return.
      example:
        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
      x-property-order:
      - catalog_object_ids
      - location_ids
      - types
      - statuses
      - states
      - updated_after
      - updated_before
      - cursor
      - limit
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/batch_retrieve_inventory_changes.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: BatchRetrieveInventoryChangesRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/Inventory/BatchRetrieveInventoryChanges/BatchRetrieveInventoryChangesRequest.python
        csharp: /sdk_samples/Inventory/BatchRetrieveInventoryChanges/BatchRetrieveInventoryChangesRequest.csharp
        java: /sdk_samples/Inventory/BatchRetrieveInventoryChanges/BatchRetrieveInventoryChangesRequest.java
        php: /sdk_samples/Inventory/BatchRetrieveInventoryChanges/BatchRetrieveInventoryChangesRequest.php
        javascript: /sdk_samples/Inventory/BatchRetrieveInventoryChanges/BatchRetrieveInventoryChangesRequest.javascript
        ruby: /sdk_samples/Inventory/BatchRetrieveInventoryChanges/BatchRetrieveInventoryChangesRequest.ruby
    BatchRetrieveInventoryChangesResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        changes:
          type: array
          description: |-
            The current calculated inventory changes for the requested objects
            and locations.
          items:
            $ref: '#/components/schemas/InventoryChange'
        cursor:
          type: string
          description: |-
            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.
      example:
        errors: []
        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
      x-property-order:
      - errors
      - changes
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/batch_retrieve_inventory_changes.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: BatchRetrieveInventoryChangesResponse
    BatchRetrieveInventoryCountsRequest:
      type: object
      properties:
        catalog_object_ids:
          maxItems: 1000
          type: array
          description: |-
            The filter to return results by `CatalogObject` ID.
            The filter is applicable only when set.  The default is null.
          items:
            type: string
        location_ids:
          type: array
          description: |-
            The filter to return results by `Location` ID.
            This filter is applicable only when set. The default is null.
          items:
            type: string
        updated_after:
          type: string
          description: |-
            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: string
          description: |-
            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: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/InventoryState'
        limit:
          maximum: 1000
          minimum: 1
          type: integer
          description: The number of [records](entity:InventoryCount) to return.
      example:
        catalog_object_ids:
        - W62UWFY35CWMYGVWK6TWJDNI
        location_ids:
        - 59TNP9SA8VGDA
        updated_after: 2016-11-16T00:00:00.000Z
      x-property-order:
      - catalog_object_ids
      - location_ids
      - updated_after
      - cursor
      - states
      - limit
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/batch_retrieve_inventory_counts.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: BatchRetrieveInventoryCountsRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/Inventory/BatchRetrieveInventoryCounts/BatchRetrieveInventoryCountsRequest.python
        csharp: /sdk_samples/Inventory/BatchRetrieveInventoryCounts/BatchRetrieveInventoryCountsRequest.csharp
        java: /sdk_samples/Inventory/BatchRetrieveInventoryCounts/BatchRetrieveInventoryCountsRequest.java
        php: /sdk_samples/Inventory/BatchRetrieveInventoryCounts/BatchRetrieveInventoryCountsRequest.php
        javascript: /sdk_samples/Inventory/BatchRetrieveInventoryCounts/BatchRetrieveInventoryCountsRequest.javascript
        ruby: /sdk_samples/Inventory/BatchRetrieveInventoryCounts/BatchRetrieveInventoryCountsRequest.ruby
    BatchRetrieveInventoryCountsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        counts:
          type: array
          description: |-
            The current calculated inventory counts for the requested objects
            and locations.
          items:
            $ref: '#/components/schemas/InventoryCount'
        cursor:
          type: string
          description: |-
            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.
      example:
        errors: []
        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
      x-property-order:
      - errors
      - counts
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/batch_retrieve_inventory_counts.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: BatchRetrieveInventoryCountsResponse
    BulkCreateVendorsRequest:
      required:
      - vendors
      type: object
      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.
      description: Represents an input to a call to [BulkCreateVendors](api-endpoint:Vendors-BulkCreateVendors).
      example:
        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
            account_number: "4025391"
            note: a vendor
        "47bb76a8-c9fb-4f33-9df8-25ce02ca4505":
          name: Annie’s Hot Sauce
          contacts:
          - name: Annie Thomas
            email_address: annie@annieshotsauce.com
            phone_number: 1-212-555-4250
      x-property-order:
      - vendors
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/bulk_create_vendors.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: BulkCreateVendorsRequest
    BulkCreateVendorsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        responses:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CreateVendorResponse'
          description: "A set of [CreateVendorResponse](entity:CreateVendorResponse)\
            \ objects encapsulating successfully created [Vendor](entity:Vendor)\n\
            objects 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."
      description: Represents an output from a call to [BulkCreateVendors](api-endpoint:Vendors-BulkCreateVendors).
      example:
        errors: []
        vendors:
          "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe":
            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
              account_number: "4025391"
              note: a vendor
              version: 0
              status: ACTIVE
        "47bb76a8-c9fb-4f33-9df8-25ce02ca4505":
          vendor:
            id: INV_V_FMCYHBWT1TPL8MFH52PBMEN92A
            created_at: 2022-03-16T10:21:54.859Z
            updated_at: 2022-03-16T10:21:54.859Z
            name: Annie’s Hot Sauce
            contacts:
            - id: INV_VC_ABYYHBWT1TPL8MFH52PBMENPJ4
              name: Annie Thomas
              email_address: annie@annieshotsauce.com
              phone_number: 1-212-555-4250
            version: 1
            status: ACTIVE
      x-property-order:
      - errors
      - responses
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/bulk_create_vendors.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: BulkCreateVendorsResponse
    BulkRetrieveVendorsRequest:
      type: object
      properties:
        vendor_ids:
          maxItems: 100
          type: array
          description: IDs of the [Vendor](entity:Vendor) objects to retrieve.
          items:
            type: string
      description: Represents an input to a call to [BulkRetrieveVendors](api-endpoint:Vendors-BulkRetrieveVendors).
      example:
        vendor_ids:
        - INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4
      x-property-order:
      - vendor_ids
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/bulk_retrieve_vendors.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: BulkRetrieveVendorsRequest
    BulkRetrieveVendorsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        responses:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RetrieveVendorResponse'
          description: "The set of [RetrieveVendorResponse](entity:RetrieveVendorResponse)\
            \ objects encapsulating successfully retrieved [Vendor](entity:Vendor)\n\
            objects or error responses for failed attempts. The set is represented\
            \ by \na collection of `Vendor`-ID/`Vendor`-object or `Vendor`-ID/error-object\
            \ pairs."
      description: Represents an output from a call to [BulkRetrieveVendors](api-endpoint:Vendors-BulkRetrieveVendors).
      example:
        errors: []
        vendors:
          INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4:
            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
              account_number: "4025391"
              note: a vendor
              version: 1
              status: ACTIVE
      x-property-order:
      - errors
      - responses
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/bulk_retrieve_vendors.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: BulkRetrieveVendorsResponse
    BulkUpdateVendorsRequest:
      required:
      - vendors
      type: object
      properties:
        vendors:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UpdateVendorRequest'
          description: |-
            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.
          x-is-sparse-update-payload: true
      description: Represents an input to a call to [BulkUpdateVendors](api-endpoint:Vendors-BulkUpdateVendors).
      example:
        vendors:
          INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4:
            note: favorite vendor
            version: 30
            status: ACTIVE
          FMCYHBWT1TPL8MFH52PBMEN92A:
            address:
              address_line_1: 202 Mill St
              locality: Moorestown
              administrative_district_level_1: NJ
              postal_code: "08057"
              country: US
            version: 10
            status: ACTIVE
      x-property-order:
      - vendors
      - fields_to_clear
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/bulk_update_vendors.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: BulkUpdateVendorsRequest
    BulkUpdateVendorsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Errors encountered when the request fails.
          items:
            $ref: '#/components/schemas/Error'
        responses:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/UpdateVendorResponse'
          description: "A set of [UpdateVendorResponse](entity:UpdateVendorResponse)\
            \ objects encapsulating successfully created [Vendor](entity:Vendor)\n\
            objects 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."
      description: Represents an output from a call to [BulkUpdateVendors](api-endpoint:Vendors-BulkUpdateVendors).
      example:
        vendors:
          INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4:
            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
          INV_V_FMCYHBWT1TPL8MFH52PBMEN92A:
            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
            contacts:
            - id: INV_VC_ABYYHBWT1TPL8MFH52PBMENPJ4
              name: Annie Thomas
              email_address: annie@annieshotsauce.com
              phone_number: 1-212-555-4250
              ordinal: 0
            address:
              address_line_1: 202 Mill St
              locality: Moorestown
              administrative_district_level_1: NJ
              postal_code: "08057"
              country: US
            version: 11
            status: ACTIVE
      x-property-order:
      - errors
      - responses
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/bulk_update_vendors.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: BulkUpdateVendorsResponse
    CreateVendorRequest:
      required:
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          maxLength: 128
          minLength: 1
          type: string
          description: |-
            A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](api-endpoint:Vendors-CreateVendor) call idempotent.

            See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) in the
            [API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more
            information.
        vendor:
          $ref: '#/components/schemas/Vendor'
      description: Represents an input to a call to [CreateVendor](api-endpoint:Vendors-CreateVendor).
      example:
        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
          account_number: "4025391"
          note: a vendor
      x-property-order:
      - idempotency_key
      - vendor
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/create_vendor.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: CreateVendorRequest
    CreateVendorResponse:
      type: object
      properties:
        errors:
          type: array
          description: Errors encountered when the request fails.
          items:
            $ref: '#/components/schemas/Error'
        vendor:
          $ref: '#/components/schemas/Vendor'
      description: Represents an output from a call to [CreateVendor](api-endpoint:Vendors-CreateVendor).
      example:
        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
          account_number: "4025391"
          note: a vendor
          version: 1
          status: ACTIVE
        errors: []
      x-property-order:
      - errors
      - vendor
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/create_vendor.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: CreateVendorResponse
    RetrieveInventoryAdjustmentRequest:
      type: object
      properties: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/retrieve_inventory_adjustment.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: RetrieveInventoryAdjustmentRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/Inventory/RetrieveInventoryAdjustment/RetrieveInventoryAdjustmentRequest.python
        csharp: /sdk_samples/Inventory/RetrieveInventoryAdjustment/RetrieveInventoryAdjustmentRequest.csharp
        java: /sdk_samples/Inventory/RetrieveInventoryAdjustment/RetrieveInventoryAdjustmentRequest.java
        php: /sdk_samples/Inventory/RetrieveInventoryAdjustment/RetrieveInventoryAdjustmentRequest.php
        javascript: /sdk_samples/Inventory/RetrieveInventoryAdjustment/RetrieveInventoryAdjustmentRequest.javascript
        ruby: /sdk_samples/Inventory/RetrieveInventoryAdjustment/RetrieveInventoryAdjustmentRequest.ruby
    RetrieveInventoryAdjustmentResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        adjustment:
          $ref: '#/components/schemas/InventoryAdjustment'
      example:
        errors: []
        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
          team_member_id: LRK57NSQ5X7PUD05
      x-property-order:
      - errors
      - adjustment
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/retrieve_inventory_adjustment.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: RetrieveInventoryAdjustmentResponse
    RetrieveInventoryChangesRequest:
      type: object
      properties:
        location_ids:
          type: string
          description: |-
            The [Location](entity:Location) IDs to look up as a comma-separated
            list. An empty list queries all locations.
        cursor:
          type: string
          description: |-
            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.
      x-property-order:
      - location_ids
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/retrieve_inventory_changes.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: RetrieveInventoryChangesRequest
      x-params-example: ?location_ids=&cursor=
      x-sq-sdk-sample-code:
        python: /sdk_samples/Inventory/RetrieveInventoryChanges/RetrieveInventoryChangesRequest.python
        csharp: /sdk_samples/Inventory/RetrieveInventoryChanges/RetrieveInventoryChangesRequest.csharp
        java: /sdk_samples/Inventory/RetrieveInventoryChanges/RetrieveInventoryChangesRequest.java
        php: /sdk_samples/Inventory/RetrieveInventoryChanges/RetrieveInventoryChangesRequest.php
        javascript: /sdk_samples/Inventory/RetrieveInventoryChanges/RetrieveInventoryChangesRequest.javascript
        ruby: /sdk_samples/Inventory/RetrieveInventoryChanges/RetrieveInventoryChangesRequest.ruby
    RetrieveInventoryChangesResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        changes:
          type: array
          description: The set of inventory changes for the requested object and locations.
          items:
            $ref: '#/components/schemas/InventoryChange'
        cursor:
          type: string
          description: |-
            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.
      example:
        errors: []
        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
      x-property-order:
      - errors
      - changes
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/retrieve_inventory_changes.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: RetrieveInventoryChangesResponse
    RetrieveInventoryCountRequest:
      type: object
      properties:
        location_ids:
          type: string
          description: |-
            The [Location](entity:Location) IDs to look up as a comma-separated
            list. An empty list queries all locations.
        cursor:
          type: string
          description: |-
            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.
      x-property-order:
      - location_ids
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/retrieve_inventory_count.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: RetrieveInventoryCountRequest
      x-params-example: ?location_ids=C6W5YS5QM06F5&cursor=
      x-sq-sdk-sample-code:
        python: /sdk_samples/Inventory/RetrieveInventoryCount/RetrieveInventoryCountRequest.python
        csharp: /sdk_samples/Inventory/RetrieveInventoryCount/RetrieveInventoryCountRequest.csharp
        java: /sdk_samples/Inventory/RetrieveInventoryCount/RetrieveInventoryCountRequest.java
        php: /sdk_samples/Inventory/RetrieveInventoryCount/RetrieveInventoryCountRequest.php
        javascript: /sdk_samples/Inventory/RetrieveInventoryCount/RetrieveInventoryCountRequest.javascript
        ruby: /sdk_samples/Inventory/RetrieveInventoryCount/RetrieveInventoryCountRequest.ruby
    RetrieveInventoryCountResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        counts:
          type: array
          description: |-
            The current calculated inventory counts for the requested object and
            locations.
          items:
            $ref: '#/components/schemas/InventoryCount'
        cursor:
          type: string
          description: |-
            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.
      example:
        errors: []
        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
      x-property-order:
      - errors
      - counts
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/retrieve_inventory_count.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: RetrieveInventoryCountResponse
    RetrieveInventoryPhysicalCountRequest:
      type: object
      properties: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/retrieve_inventory_physical_count.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: RetrieveInventoryPhysicalCountRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/Inventory/RetrieveInventoryPhysicalCount/RetrieveInventoryPhysicalCountRequest.python
        csharp: /sdk_samples/Inventory/RetrieveInventoryPhysicalCount/RetrieveInventoryPhysicalCountRequest.csharp
        java: /sdk_samples/Inventory/RetrieveInventoryPhysicalCount/RetrieveInventoryPhysicalCountRequest.java
        php: /sdk_samples/Inventory/RetrieveInventoryPhysicalCount/RetrieveInventoryPhysicalCountRequest.php
        javascript: /sdk_samples/Inventory/RetrieveInventoryPhysicalCount/RetrieveInventoryPhysicalCountRequest.javascript
        ruby: /sdk_samples/Inventory/RetrieveInventoryPhysicalCount/RetrieveInventoryPhysicalCountRequest.ruby
    RetrieveInventoryPhysicalCountResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        count:
          $ref: '#/components/schemas/InventoryPhysicalCount'
      example:
        errors: []
        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
          team_member_id: LRK57NSQ5X7PUD05
          occurred_at: 2016-11-16T22:25:24.878Z
          created_at: 2016-11-16T22:25:24.878Z
      x-property-order:
      - errors
      - count
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/retrieve_inventory_physical_count.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: RetrieveInventoryPhysicalCountResponse
    RetrieveInventoryTransferRequest:
      type: object
      properties: {}
      x-property-order: []
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/retrieve_inventory_transfer.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: RetrieveInventoryTransferRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/Inventory/RetrieveInventoryTransfer/RetrieveInventoryTransferRequest.python
        csharp: /sdk_samples/Inventory/RetrieveInventoryTransfer/RetrieveInventoryTransferRequest.csharp
        java: /sdk_samples/Inventory/RetrieveInventoryTransfer/RetrieveInventoryTransferRequest.java
        php: /sdk_samples/Inventory/RetrieveInventoryTransfer/RetrieveInventoryTransferRequest.php
        javascript: /sdk_samples/Inventory/RetrieveInventoryTransfer/RetrieveInventoryTransferRequest.javascript
        ruby: /sdk_samples/Inventory/RetrieveInventoryTransfer/RetrieveInventoryTransferRequest.ruby
    RetrieveInventoryTransferResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        transfer:
          $ref: '#/components/schemas/InventoryTransfer'
      example:
        errors: []
        transfer:
          id: UDMOEO78BG6GYWA2XDRYX3KB
          catalog_object_id: W62UWFY35CWMYGVWK6TWJDNI
          catalog_object_type: ITEM_VARIATION
          created_at: 2016-11-17T13:02:15.142Z
          team_member_id: LRK57NSQ5X7PUD05
          from_location_id: C6W5YS5QM06F5
          to_location_id: 59TNP9SA8VGDA
          occurred_at: 2016-11-16T25:44:22.837Z
          quantity: "7"
          reference_id: 4a366069-4096-47a2-99a5-0084ac879509
          source:
            product: SQUARE_POS
            application_id: 416ff29c-86c4-4feb-b58c-9705f21f3ea0
            name: Square Point of Sale 4.37
          state: IN_STOCK
      x-property-order:
      - errors
      - transfer
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/retrieve_inventory_transfer.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: RetrieveInventoryTransferResponse
    RetrieveVendorRequest:
      type: object
      properties: {}
      description: Represents an input to a call to [RetrieveVendor](api-endpoint:Vendors-RetrieveVendor).
      x-property-order: []
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/retrieve_vendor.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: RetrieveVendorRequest
    RetrieveVendorResponse:
      type: object
      properties:
        errors:
          type: array
          description: Errors encountered when the request fails.
          items:
            $ref: '#/components/schemas/Error'
        vendor:
          $ref: '#/components/schemas/Vendor'
      description: Represents an output from a call to [RetrieveVendor](api-endpoint:Vendors-RetrieveVendor).
      example:
        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
          account_number: "4025391"
          note: a vendor
          version: 1
          status: ACTIVE
        errors: []
      x-property-order:
      - errors
      - vendor
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/retrieve_vendor.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: RetrieveVendorResponse
    SearchVendorsRequest:
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/SearchVendorsRequestFilter'
        sort:
          $ref: '#/components/schemas/SearchVendorsRequestSort'
        cursor:
          type: string
          description: |-
            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.
      description: Represents an input into a call to [SearchVendors](api-endpoint:Vendors-SearchVendors).
      example:
        query:
          filter:
            name:
            - Joe's Fresh Seafood
            - Hannah's Bakery
            status:
            - ACTIVE
          sort:
            field: CREATED_AT
            order: ASC
      x-property-order:
      - filter
      - sort
      - cursor
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/search_vendors.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: SearchVendorsRequest
    SearchVendorsRequestFilter:
      type: object
      properties:
        name:
          maxItems: 100
          type: array
          description: The names of the [Vendor](entity:Vendor) objects to retrieve.
          items:
            maxLength: 100
            type: string
        status:
          maxItems: 100
          type: array
          description: |-
            The statuses of the [Vendor](entity:Vendor) objects to retrieve.
            See [VendorStatus](#type-vendorstatus) for possible values
          items:
            $ref: '#/components/schemas/VendorStatus'
      description: Defines supported query expressions to search for vendors by.
      x-property-order:
      - name
      - status
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/search_vendors.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: SearchVendorsRequestFilter
    SearchVendorsRequestSort:
      type: object
      properties:
        field:
          $ref: '#/components/schemas/SearchVendorsRequestSortField'
        order:
          $ref: '#/components/schemas/SortOrder'
      description: Defines a sorter used to sort results from [SearchVendors](api-endpoint:Vendors-SearchVendors).
      x-property-order:
      - field
      - order
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/search_vendors.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: SearchVendorsRequestSort
    SearchVendorsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Errors encountered when the request fails.
          items:
            $ref: '#/components/schemas/Error'
        vendors:
          type: array
          description: The [Vendor](entity:Vendor) objects matching the specified
            search filter.
          items:
            $ref: '#/components/schemas/Vendor'
        cursor:
          type: string
          description: |-
            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.
      description: Represents an output from a call to [SearchVendors](api-endpoint:Vendors-SearchVendors).
      example:
        errors: []
        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
          account_number: "4025391"
          note: a vendor
          version: 1
          status: ACTIVE
      x-property-order:
      - errors
      - vendors
      - cursor
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/search_vendors.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: SearchVendorsResponse
    UpdateVendorRequest:
      required:
      - vendor
      type: object
      properties:
        idempotency_key:
          maxLength: 128
          type: string
          description: |-
            A client-supplied, universally unique identifier (UUID) for the
            request.

            See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) in the
            [API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more
            information.
        vendor:
          $ref: '#/components/schemas/Vendor'
      description: Represents an input to a call to [UpdateVendor](api-endpoint:Vendors-UpdateVendor).
      example:
        idempotency_key: 8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe
        vendor:
          id: INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4
          name: Jack's Chicken Shack
          status: ACTIVE
          version: 1
      x-property-order:
      - idempotency_key
      - vendor
      - fields_to_clear
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/update_vendor.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: UpdateVendorRequest
    UpdateVendorResponse:
      type: object
      properties:
        errors:
          type: array
          description: Errors occurred when the request fails.
          items:
            $ref: '#/components/schemas/Error'
        vendor:
          $ref: '#/components/schemas/Vendor'
      description: Represents an output from a call to [UpdateVendor](api-endpoint:Vendors-UpdateVendor).
      example:
        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
            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"
          version: 2
          status: ACTIVE
        errors: []
      x-property-order:
      - errors
      - vendor
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/inventory/service/update_vendor.proto
      x-proto-sha: 1bd3bd22462b927aacf7ca28c58ebb41639dc418
      x-object-name: UpdateVendorResponse
    CatalogCategory:
      type: object
      properties:
        name:
          maxLength: 255
          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.
        image_ids:
          type: array
          description: |-
            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.
          items:
            type: string
          x-release-status: BETA
      description: A category to which a `CatalogItem` instance belongs.
      example:
        object:
          type: CATEGORY
          id: '#Beverages'
          present_at_all_locations: true
          category_data:
            name: Beverages
      x-property-order:
      - name
      - ordinal
      - abbreviation
      - label_color
      - image_ids
      - location_overrides
      - category_type
      - parent_category
      - is_top_level
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogCategory
    CatalogCustomAttributeDefinition:
      required:
      - allowed_object_types
      - name
      - type
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CatalogCustomAttributeDefinitionType'
        name:
          maxLength: 255
          minLength: 1
          type: string
          description: |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.
        description:
          maxLength: 255
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/SourceApplication'
        allowed_object_types:
          type: array
          description: |-
            The set of Catalog Object Types that this Custom Attribute may be applied to.
            Currently, only `ITEM` and `ITEM_VARIATION` are allowed. At least one type must be included.
            See [CatalogObjectType](#type-catalogobjecttype) for possible values
          items:
            $ref: '#/components/schemas/CatalogObjectType'
        seller_visibility:
          $ref: '#/components/schemas/CatalogCustomAttributeDefinitionSellerVisibility'
        app_visibility:
          $ref: '#/components/schemas/CatalogCustomAttributeDefinitionAppVisibility'
        string_config:
          $ref: '#/components/schemas/CatalogCustomAttributeDefinitionStringConfig'
        number_config:
          $ref: '#/components/schemas/CatalogCustomAttributeDefinitionNumberConfig'
        selection_config:
          $ref: '#/components/schemas/CatalogCustomAttributeDefinitionSelectionConfig'
        custom_attribute_usage_count:
          type: integer
          description: |-
            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`.
          readOnly: true
        key:
          maxLength: 60
          minLength: 1
          pattern: ^[a-zA-Z0-9_-]*$
          type: string
          description: |-
            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_-]`.
      description: |-
        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)
      x-property-order:
      - type
      - name
      - description
      - source_application
      - allowed_object_types
      - seller_visibility
      - app_visibility
      - string_config
      - number_config
      - selection_config
      - custom_attribute_usage_count
      - key
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogCustomAttributeDefinition
    CatalogCustomAttributeDefinitionNumberConfig:
      type: object
      properties:
        precision:
          maximum: 5
          minimum: 0
          type: integer
          description: |-
            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
      x-property-order:
      - precision
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogCustomAttributeDefinitionNumberConfig
    CatalogCustomAttributeDefinitionSelectionConfig:
      type: object
      properties:
        max_allowed_selections:
          maximum: 100
          type: integer
          description: |-
            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:
          maxItems: 100
          type: array
          description: |-
            The set of valid `CatalogCustomAttributeSelections`. Up to a maximum of 100
            selections can be defined. Can be modified.
          items:
            $ref: '#/components/schemas/CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection'
      description: Configuration associated with `SELECTION`-type custom attribute
        definitions.
      x-property-order:
      - max_allowed_selections
      - allowed_selections
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogCustomAttributeDefinitionSelectionConfig
    CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection:
      required:
      - name
      type: object
      properties:
        uid:
          type: string
          description: Unique ID set by Square.
        name:
          maxLength: 255
          minLength: 1
          type: string
          description: Selection name, unique within `allowed_selections`.
      description: A named selection for this `SELECTION`-type custom attribute definition.
      x-property-order:
      - uid
      - name
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection
    CatalogCustomAttributeDefinitionStringConfig:
      type: object
      properties:
        enforce_uniqueness:
          type: boolean
          description: |-
            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.
      description: Configuration associated with Custom Attribute Definitions of type
        `STRING`.
      x-property-order:
      - enforce_uniqueness
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogCustomAttributeDefinitionStringConfig
    CatalogCustomAttributeValue:
      type: object
      properties:
        name:
          type: string
          description: The name of the custom attribute.
        string_value:
          type: string
          description: The string value of the custom attribute.  Populated if `type`
            = `STRING`.
        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'
        number_value:
          type: string
          description: |-
            Populated if `type` = `NUMBER`. Contains a string
            representation of a decimal number, using a `.` as the decimal separator.
        boolean_value:
          type: boolean
          description: A `true` or `false` value. Populated if `type` = `BOOLEAN`.
        selection_uid_values:
          type: array
          description: One or more choices from `allowed_selections`. Populated if
            `type` = `SELECTION`.
          items:
            type: string
        key:
          type: string
          description: A copy of key from the associated `CatalogCustomAttributeDefinition`.
          readOnly: true
      description: |-
        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).
      x-property-order:
      - name
      - string_value
      - int_value
      - custom_attribute_definition_id
      - type
      - number_value
      - boolean_value
      - selection_uid_values
      - key
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogCustomAttributeValue
    CatalogDiscount:
      type: object
      properties:
        name:
          maxLength: 255
          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.
        discount_type:
          $ref: '#/components/schemas/CatalogDiscountType'
        percentage:
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Money'
        pin_required:
          type: boolean
          description: |-
            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: string
          description: 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:
          $ref: '#/components/schemas/CatalogDiscountModifyTaxBasis'
        maximum_amount_money:
          $ref: '#/components/schemas/Money'
      description: A discount applicable to items.
      example:
        object:
          type: DISCOUNT
          id: '#Maythe4th'
          present_at_all_locations: true
          discount_data:
            name: Welcome to the Dark(Roast) Side!
            discount_type: FIXED_PERCENTAGE
            percentage: "5.4"
            pin_required: false
            label_color: red
      x-property-order:
      - name
      - discount_type
      - percentage
      - amount_money
      - pin_required
      - label_color
      - application_method
      - comp_ordinal
      - modify_tax_basis
      - maximum_amount_money
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogDiscount
    CatalogIdMapping:
      type: object
      properties:
        client_object_id:
          type: string
          description: The client-supplied temporary `#`-prefixed ID for a new `CatalogObject`.
        object_id:
          type: string
          description: The permanent ID for the CatalogObject created by the server.
      description: |-
        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.
      x-property-order:
      - client_object_id
      - object_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogIdMapping
    CatalogImage:
      type: object
      properties:
        name:
          type: string
          description: |-
            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: string
          description: |-
            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: string
          description: |-
            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: string
          description: The immutable order ID for this image object created by the
            Photo Studio service in Square Online Store.
          x-release-status: BETA
      description: |-
        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.
      x-property-order:
      - name
      - url
      - caption
      - photo_studio_order_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogImage
    CatalogItem:
      type: object
      properties:
        name:
          maxLength: 512
          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.
        description:
          maxLength: 4096
          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`."
          x-release-status: DEPRECATED
        abbreviation:
          maxLength: 24
          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.
            This attribute is searchable, and its value length is of Unicode code points.
        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.
        available_online:
          type: boolean
          description: If `true`, the item can be added to shipping orders from the
            merchant's online store.
        available_for_pickup:
          type: boolean
          description: If `true`, the item can be added to pickup orders from the
            merchant's online store.
        available_electronically:
          type: boolean
          description: If `true`, the item can be added to electronically fulfilled
            orders from the merchant's online store.
        category_id:
          type: string
          description: The ID of the item's category, if any.
        tax_ids:
          type: array
          description: |-
            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`.
          items:
            type: string
        modifier_list_info:
          type: array
          description: |-
            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`.
          items:
            $ref: '#/components/schemas/CatalogItemModifierListInfo'
        image_url:
          type: string
          description: |-
            __Retired__. The URL of an image representing this item. Retired
            in favor of `image_id` in [CatalogObject](entity:CatalogObject).
          x-release-status: RETIRED
        variations:
          type: array
          description: |-
            A list of [CatalogItemVariation](entity:CatalogItemVariation) objects for this item. An item must have
            at least one variation.
          items:
            $ref: '#/components/schemas/CatalogObject'
        product_type:
          $ref: '#/components/schemas/CatalogItemProductType'
        skip_modifier_screen:
          type: boolean
          description: |-
            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:
          maxItems: 6
          type: array
          description: |-
            List of item options IDs for this item. Used to manage and group item
            variations in a specified order.

            Maximum: 6 item options.
          items:
            $ref: '#/components/schemas/CatalogItemOptionForItem'
          x-release-status: BETA
        ecom_uri:
          type: string
          description: hidden field
        ecom_image_uris:
          type: array
          description: hidden field
          items:
            type: string
        ecom_available:
          type: boolean
          description: hidden field
        ecom_visibility:
          type: string
          description: hidden field
        image_ids:
          type: array
          description: |-
            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.
          items:
            type: string
          x-release-status: BETA
        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.

            It is currently supported for sellers of the Japanese locale only.
          x-release-status: BETA
        description_html:
          maxLength: 65536
          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"
        description_plaintext:
          maxLength: 65536
          type: string
          description: A server-generated plaintext version of the `description_html`
            field, without formatting tags.
          readOnly: true
      description: A [CatalogObject](entity:CatalogObject) instance of the `ITEM`
        type, also referred to as an item, in the catalog.
      example:
        object:
          type: ITEM
          id: '#Cocoa'
          present_at_all_locations: true
          item_data:
            name: Cocoa
            description: Hot chocolate
            abbreviation: Ch
            visibility: PRIVATE
      x-property-order:
      - name
      - description
      - abbreviation
      - label_color
      - is_taxable
      - visibility
      - available_online
      - available_for_pickup
      - available_electronically
      - category_id
      - buyer_facing_name
      - ordinal
      - tax_ids
      - modifier_list_info
      - image_url
      - variations
      - product_type
      - skip_modifier_screen
      - item_options
      - ecom_uri
      - ecom_image_uris
      - ecom_available
      - online_store_data
      - ecom_buy_button_text
      - ecom_visibility
      - image_ids
      - legacy_tax_ids
      - sort_name
      - event
      - additional_categories
      - category
      - pickup_fulfillment_preferences_id
      - delivery_fulfillment_preferences_id
      - description_html
      - description_plaintext
      - kitchen_name
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogItem
    CatalogItemModifierListInfo:
      required:
      - modifier_list_id
      type: object
      properties:
        modifier_list_id:
          minLength: 1
          type: string
          description: The ID of the `CatalogModifierList` controlled by this `CatalogModifierListInfo`.
        modifier_overrides:
          type: array
          description: A set of `CatalogModifierOverride` objects that override whether
            a given `CatalogModifier` is enabled by default.
          items:
            $ref: '#/components/schemas/CatalogModifierOverride'
        min_selected_modifiers:
          type: integer
          description: If 0 or larger, the smallest number of `CatalogModifier`s that
            must be selected from this `CatalogModifierList`.
        max_selected_modifiers:
          type: integer
          description: If 0 or larger, the largest number of `CatalogModifier`s that
            can be selected from this `CatalogModifierList`.
        enabled:
          type: boolean
          description: If `true`, enable this `CatalogModifierList`. The default value
            is `true`.
      description: Options to control the properties of a `CatalogModifierList` applied
        to a `CatalogItem` instance.
      x-property-order:
      - modifier_list_id
      - visibility
      - modifier_overrides
      - min_selected_modifiers
      - max_selected_modifiers
      - enabled
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogItemModifierListInfo
    CatalogItemOption:
      type: object
      properties:
        name:
          type: string
          description: |-
            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: string
          description: The item option's display name for the customer. This is a
            searchable attribute for use in applicable query filters.
        description:
          type: string
          description: |-
            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: boolean
          description: If true, display colors for entries in `values` when present.
        values:
          type: array
          description: |-
            A list of CatalogObjects containing the
            `CatalogItemOptionValue`s for this item.
          items:
            $ref: '#/components/schemas/CatalogObject'
      description: A group of variations for a `CatalogItem`.
      x-property-order:
      - name
      - display_name
      - description
      - show_colors
      - values
      - item_count
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogItemOption
    CatalogItemOptionForItem:
      type: object
      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.
      description: |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.
      x-property-order:
      - item_option_id
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogItemOptionForItem
    CatalogItemOptionValue:
      type: object
      properties:
        item_option_id:
          type: string
          description: Unique ID of the associated item option.
        name:
          type: string
          description: Name of this item option value. This is a searchable attribute
            for use in applicable query filters.
        description:
          type: string
          description: A human-readable description for the option value. This is
            a searchable attribute for use in applicable query filters.
        color:
          type: string
          description: |-
            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: integer
          description: Determines where this option value appears in a list of option
            values.
      description: |-
        An enumerated value that can link a
        `CatalogItemVariation` to an item option as one of
        its item option values.
      x-property-order:
      - item_option_id
      - name
      - description
      - color
      - ordinal
      - item_variation_count
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogItemOptionValue
    CatalogItemOptionValueForItemVariation:
      type: object
      properties:
        item_option_id:
          type: string
          description: The unique id of an item option.
        item_option_value_id:
          type: string
          description: The unique id of the selected value for the item option.
      description: |-
        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".
      x-property-order:
      - item_option_id
      - item_option_value_id
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogItemOptionValueForItemVariation
    CatalogItemVariation:
      type: object
      properties:
        item_id:
          type: string
          description: The ID of the `CatalogItem` associated with this item variation.
        name:
          maxLength: 255
          type: string
          description: The item variation's name. This is a searchable attribute for
            use in applicable query filters, and its value length is of Unicode code
            points.
        sku:
          type: string
          description: The item variation's SKU, if any. This is a searchable attribute
            for use in applicable query filters.
        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.

            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: integer
          description: |-
            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.
          readOnly: true
        pricing_type:
          $ref: '#/components/schemas/CatalogPricingType'
        price_money:
          $ref: '#/components/schemas/Money'
        location_overrides:
          type: array
          description: Per-location price and inventory overrides.
          items:
            $ref: '#/components/schemas/ItemVariationLocationOverrides'
        track_inventory:
          type: boolean
          description: If `true`, inventory tracking is active for the variation.
        inventory_alert_type:
          $ref: '#/components/schemas/InventoryAlertType'
        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`
            is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard.

            This value is always an integer.
          format: int64
        user_data:
          maxLength: 255
          type: string
          description: Arbitrary user metadata to associate with the item variation.
            This attribute value length is of Unicode code points.
        service_duration:
          type: integer
          description: |-
            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).
          format: int64
        available_for_booking:
          type: boolean
          description: |-
            If the `CatalogItem` that owns this item variation is of type
            `APPOINTMENTS_SERVICE`, a bool representing whether this service is available for booking.
          x-release-status: BETA
        item_option_values:
          type: array
          description: |-
            List of item option values associated with this item variation. Listed
            in the same order as the item options of the parent item.
          items:
            $ref: '#/components/schemas/CatalogItemOptionValueForItemVariation'
          x-release-status: BETA
        measurement_unit_id:
          type: string
          description: |-
            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: 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
        stockable:
          type: boolean
          description: |-
            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.
          x-release-status: BETA
        image_ids:
          type: array
          description: |-
            The IDs of images associated with this `CatalogItemVariation` instance.
            These images will be shown to customers in Square Online Store.
          items:
            type: string
          x-release-status: BETA
        team_member_ids:
          type: array
          description: |-
            Tokens of employees that can perform the service represented by this variation. Only valid for
            variations of type `APPOINTMENTS_SERVICE`.
          items:
            type: string
          x-release-status: BETA
        stockable_conversion:
          $ref: '#/components/schemas/CatalogStockConversion'
      description: "An item variation, representing a product for sale, in the Catalog\
        \ object model. Each [item](entity:CatalogItem) must have at least one \n\
        item 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-property-order:
      - item_id
      - name
      - sku
      - upc
      - ordinal
      - pricing_type
      - price_money
      - location_overrides
      - track_inventory
      - inventory_alert_type
      - inventory_alert_threshold
      - buyer_facing_name
      - user_data
      - service_duration
      - price_description
      - available_for_booking
      - no_show_fee
      - transition_time
      - item_option_values
      - measurement_unit_id
      - intermissions
      - sellable
      - stockable
      - image_ids
      - team_member_ids
      - composition_id
      - stockable_conversion
      - subscription_product_ids
      - kitchen_name
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogItemVariation
    CatalogMeasurementUnit:
      type: object
      properties:
        measurement_unit:
          $ref: '#/components/schemas/MeasurementUnit'
        precision:
          type: integer
          description: |-
            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
      description: |-
        Represents the unit used to measure a `CatalogItemVariation` and
        specifies the precision for decimal quantities.
      x-property-order:
      - measurement_unit
      - precision
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogMeasurementUnit
    CatalogModifier:
      type: object
      properties:
        name:
          maxLength: 255
          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.
        price_money:
          $ref: '#/components/schemas/Money'
        ordinal:
          type: integer
          description: Determines where this `CatalogModifier` appears in the `CatalogModifierList`.
        modifier_list_id:
          type: string
          description: The ID of the `CatalogModifierList` associated with this modifier.
        image_ids:
          type: array
          description: |-
            The IDs of images associated with this `CatalogModifier` instance.
            Currently these images are not displayed by Square, but are free to be displayed in 3rd party applications.
          items:
            type: string
          x-release-status: BETA
      description: A modifier applicable to items at the time of sale.
      example:
        object:
          type: MODIFIER
          present_at_all_locations: true
          modifier_data:
            name: Almond Milk
            price_money:
              amount: 250
              currency: USD
      x-property-order:
      - name
      - price_money
      - on_by_default
      - ordinal
      - modifier_list_id
      - image_ids
      - location_overrides
      - kitchen_name
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogModifier
    CatalogModifierList:
      type: object
      properties:
        name:
          maxLength: 255
          type: string
          description: The name for the `CatalogModifierList` instance. This is a
            searchable attribute for use in applicable query filters, and its value
            length is of Unicode code points.
        ordinal:
          type: integer
          description: Determines where this modifier list appears in a list of `CatalogModifierList`
            values.
        selection_type:
          $ref: '#/components/schemas/CatalogModifierListSelectionType'
        modifiers:
          type: array
          description: |-
            The options included in the `CatalogModifierList`.
            You must include at least one `CatalogModifier`.
            Each CatalogObject must have type `MODIFIER` and contain
            `CatalogModifier` data.
          items:
            $ref: '#/components/schemas/CatalogObject'
        image_ids:
          type: array
          description: |-
            The IDs of images associated with this `CatalogModifierList` instance.
            Currently these images are not displayed by Square, but are free to be displayed in 3rd party applications.
          items:
            type: string
          x-release-status: BETA
      description: |-
        A list of modifiers applicable to items at the time of sale.

        For example, a "Condiments" modifier list applicable to a "Hot Dog" item
        may contain "Ketchup", "Mustard", and "Relish" modifiers.
        Use the `selection_type` field to specify whether or not multiple selections from
        the modifier list are allowed.
      example:
        type: MODIFIER_LIST
        id: '#MilkType'
        present_at_all_locations: true
        modifier_list_data:
          name: Milk Type
          selection_type: SINGLE
          modifiers:
          - type: MODIFIER
            present_at_all_locations: true
            modifier_data:
              name: Whole Milk
              price_money:
                amount: 0
                currency: USD
          - type: MODIFIER
            present_at_all_locations: true
            modifier_data:
              name: Almond Milk
              price_money:
                amount: 250
                currency: USD
          - type: MODIFIER
            present_at_all_locations: true
            modifier_data:
              name: Soy Milk
              price_money:
                amount: 250
                currency: USD
      x-property-order:
      - name
      - ordinal
      - selection_type
      - modifiers
      - image_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogModifierList
    CatalogModifierOverride:
      required:
      - modifier_id
      type: object
      properties:
        modifier_id:
          minLength: 1
          type: string
          description: The ID of the `CatalogModifier` whose default behavior is being
            overridden.
        on_by_default:
          type: boolean
          description: If `true`, this `CatalogModifier` should be selected by default
            for this `CatalogItem`.
      description: Options to control how to override the default behavior of the
        specified modifier.
      x-property-order:
      - modifier_id
      - on_by_default
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogModifierOverride
    CatalogObject:
      required:
      - id
      - type
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CatalogObjectType'
        id:
          minLength: 1
          type: string
          description: |-
            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:
          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"`
            would 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
            must 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
            being inserted. When deleted, the `updated_at` field will equal the deletion time.
        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
            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.).
          x-release-status: BETA
        catalog_v1_ids:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/CatalogV1Id'
        present_at_all_locations:
          type: boolean
          description: |-
            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: array
          description: |-
            A list of locations where the object is present, even if `present_at_all_locations` is `false`.
            This can include locations that are deactivated.
          items:
            type: string
        absent_at_location_ids:
          type: array
          description: |-
            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.
          items:
            type: string
        image_id:
          type: string
          description: Identifies the `CatalogImage` attached to this `CatalogObject`.
          x-release-status: RETIRED
        item_data:
          $ref: '#/components/schemas/CatalogItem'
        category_data:
          $ref: '#/components/schemas/CatalogCategory'
        item_variation_data:
          $ref: '#/components/schemas/CatalogItemVariation'
        tax_data:
          $ref: '#/components/schemas/CatalogTax'
        discount_data:
          $ref: '#/components/schemas/CatalogDiscount'
        modifier_list_data:
          $ref: '#/components/schemas/CatalogModifierList'
        modifier_data:
          $ref: '#/components/schemas/CatalogModifier'
        time_period_data:
          $ref: '#/components/schemas/CatalogTimePeriod'
        product_set_data:
          $ref: '#/components/schemas/CatalogProductSet'
        pricing_rule_data:
          $ref: '#/components/schemas/CatalogPricingRule'
        image_data:
          $ref: '#/components/schemas/CatalogImage'
        measurement_unit_data:
          $ref: '#/components/schemas/CatalogMeasurementUnit'
        subscription_plan_data:
          $ref: '#/components/schemas/CatalogSubscriptionPlan'
        item_option_data:
          $ref: '#/components/schemas/CatalogItemOption'
        item_option_value_data:
          $ref: '#/components/schemas/CatalogItemOptionValue'
        custom_attribute_definition_data:
          $ref: '#/components/schemas/CatalogCustomAttributeDefinition'
        quick_amounts_settings_data:
          $ref: '#/components/schemas/CatalogQuickAmountsSettings'
      description: |-
        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=<OBJECT_TYPE>`, the `CatalogObject` instance must have the `<OBJECT_TYPE>`-specific data set on the `<object_type>_data` attribute. The resulting `CatalogObject` instance is also a `Catalog<ObjectType>` 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.
      example:
        catalog_object:
          type: '{{ [ITEM | ITEM_VARIATION | MODIFIER | MODIFIER_LIST | CATEGORY |
            DISCOUNT | TAX] }}'
          id: '{{ set by Catalog during object creation }}'
          updated_at: '{{ date & time of most recent update }}'
          version: '{{ version of the CatalogObject }}'
          is_deleted: '{{ [true | false] }}'
          connect_v1_ids:
            catalog_v1_id: '{{ itemID from Catalog v1 }}'
            location_id: '{{ location where v1 ID is used }}'
          present_at_all_locations: '{{ [true | false] }}'
          present_at_location_ids:
          - '{{ LOCATIONID-1 }}'
          - '{{ LOCATIONID-N }}'
          absent_at_location_ids:
          - '{{ LOCATIONID-1 }}'
          - '{{ LOCATIONID-N }}'
          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
            }}'
          category_data: '{{ CatalogCategory object only if type=CATEGORY }}'
          discount_data: '{{ CatalogDiscount object only if type=DISCOUNT }}'
          tax_data: '{{ CatalogTax object only if type=TAX }}'
      x-property-order:
      - type
      - id
      - updated_at
      - created_at
      - version
      - is_deleted
      - DEPRECATED_custom_attributes
      - custom_attribute_values
      - catalog_v1_ids
      - present_at_all_locations
      - present_at_location_ids
      - absent_at_location_ids
      - image_id
      - item_data
      - category_data
      - item_variation_data
      - tax_data
      - discount_data
      - modifier_list_data
      - modifier_data
      - time_period_data
      - product_set_data
      - pricing_rule_data
      - image_data
      - measurement_unit_data
      - subscription_plan_data
      - item_option_data
      - item_option_value_data
      - custom_attribute_definition_data
      - quick_amounts_settings_data
      - tax_exemption_data
      - dining_option_data
      - resource_data
      - composition_data
      - component_data
      - service_charge_data
      - checkout_link_data
      - address_data
      - subscription_product_data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogObject
    CatalogObjectBatch:
      required:
      - objects
      type: object
      properties:
        objects:
          type: array
          description: A list of CatalogObjects belonging to this batch.
          items:
            $ref: '#/components/schemas/CatalogObject'
      description: A batch of catalog objects.
      x-property-order:
      - objects
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogObjectBatch
    CatalogObjectReference:
      type: object
      properties:
        object_id:
          type: string
          description: The ID of the referenced object.
        catalog_version:
          type: integer
          description: The version of the object.
          format: int64
      description: |-
        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.
      x-property-order:
      - object_id
      - catalog_version
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogObjectReference
    CatalogPricingRule:
      type: object
      properties:
        name:
          type: string
          description: |-
            User-defined name for the pricing rule. For example, "Buy one get one
            free" or "10% off".
        time_period_ids:
          type: array
          description: |-
            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.
          items:
            type: string
        discount_id:
          type: string
          description: |-
            Unique ID for the `CatalogDiscount` to take off
            the price of all matched items.
        match_products_id:
          type: string
          description: |-
            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: string
          description: |-
            __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.
          x-release-status: DEPRECATED
        exclude_products_id:
          type: string
          description: |-
            `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: string
          description: Represents the date the Pricing Rule is valid from. Represented
            in RFC 3339 full-date format (YYYY-MM-DD).
        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
            (HH:MM:SS). Partial seconds will be truncated.
        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).
        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
            (HH:MM:SS). Partial seconds will be truncated.
        exclude_strategy:
          $ref: '#/components/schemas/ExcludeStrategy'
        minimum_order_subtotal_money:
          $ref: '#/components/schemas/Money'
        customer_group_ids_any:
          type: array
          description: |-
            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.
          items:
            type: string
      description: |-
        Defines how discounts are automatically applied to a set of items that match the pricing rule
        during the active time period.
      x-property-order:
      - name
      - time_period_ids
      - discount_id
      - match_products_id
      - apply_products_id
      - stackable
      - exclude_products_id
      - valid_from_date
      - valid_from_local_time
      - valid_until_date
      - valid_until_local_time
      - exclude_strategy
      - application_mode
      - discount_target_scope
      - max_applications_per_attachment
      - minimum_order_subtotal_money
      - customer_group_ids_any
      - service_charge_target_scope
      - service_charge_id
      - enabled_pricing_sources
      - disabled_pricing_sources
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogPricingRule
    CatalogProductSet:
      type: object
      properties:
        name:
          type: string
          description: |-
            User-defined name for the product set. For example, "Clearance Items"
            or "Winter Sale Items".
        product_ids_any:
          maxItems: 500
          type: array
          description: |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.
          items:
            type: string
        product_ids_all:
          maxItems: 500
          type: array
          description: |-
            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.
          items:
            type: string
        quantity_exact:
          type: integer
          description: |-
            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`.
          format: int64
        quantity_min:
          type: integer
          description: |-
            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.
          format: int64
        quantity_max:
          type: integer
          description: |-
            If set, the pricing rule will apply to a maximum of this many items from
            `products_any` or `products_all`.
          format: int64
        all_products:
          type: boolean
          description: |-
            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.
      description: |-
        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.
      x-property-order:
      - name
      - product_ids_any
      - product_ids_all
      - quantity_exact
      - quantity_min
      - quantity_max
      - all_products
      - match_custom_amounts
      - is_product_all_tokens_been_cascade_delete
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogProductSet
    CatalogQuery:
      type: object
      properties:
        sorted_attribute_query:
          $ref: '#/components/schemas/CatalogQuerySortedAttribute'
        exact_query:
          $ref: '#/components/schemas/CatalogQueryExact'
        set_query:
          $ref: '#/components/schemas/CatalogQuerySet'
        prefix_query:
          $ref: '#/components/schemas/CatalogQueryPrefix'
        range_query:
          $ref: '#/components/schemas/CatalogQueryRange'
        text_query:
          $ref: '#/components/schemas/CatalogQueryText'
        items_for_tax_query:
          $ref: '#/components/schemas/CatalogQueryItemsForTax'
        items_for_modifier_list_query:
          $ref: '#/components/schemas/CatalogQueryItemsForModifierList'
        items_for_item_options_query:
          $ref: '#/components/schemas/CatalogQueryItemsForItemOptions'
        item_variations_for_item_option_values_query:
          $ref: '#/components/schemas/CatalogQueryItemVariationsForItemOptionValues'
      description: |-
        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.
      x-property-order:
      - sorted_attribute_query
      - exact_query
      - set_query
      - prefix_query
      - range_query
      - text_query
      - items_for_tax_query
      - items_for_modifier_list_query
      - items_for_item_options_query
      - item_variations_for_item_option_values_query
      - filtered_items_query
      - custom_attribute_usage
      - pricing_rules_for_products_query
      - pricing_objects_for_products_query
      - checkout_link_for_items
      - list_length_query
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogQuery
    CatalogQueryExact:
      required:
      - attribute_name
      - attribute_value
      type: object
      properties:
        attribute_name:
          minLength: 1
          type: string
          description: The name of the attribute to be searched. Matching of the attribute
            name is exact.
        attribute_value:
          type: string
          description: |-
            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.
      description: The query filter to return the search result by exact match of
        the specified attribute name and value.
      x-property-order:
      - attribute_name
      - attribute_value
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogQueryExact
    CatalogQueryItemVariationsForItemOptionValues:
      type: object
      properties:
        item_option_value_ids:
          type: array
          description: |-
            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.
          items:
            type: string
      description: The query filter to return the item variations containing the specified
        item option value IDs.
      x-property-order:
      - item_option_value_ids
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogQueryItemVariationsForItemOptionValues
    CatalogQueryItemsForItemOptions:
      type: object
      properties:
        item_option_ids:
          type: array
          description: |-
            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.
          items:
            type: string
      description: The query filter to return the items containing the specified item
        option IDs.
      x-property-order:
      - item_option_ids
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogQueryItemsForItemOptions
    CatalogQueryItemsForModifierList:
      required:
      - modifier_list_ids
      type: object
      properties:
        modifier_list_ids:
          type: array
          description: A set of `CatalogModifierList` IDs to be used to find associated
            `CatalogItem`s.
          items:
            type: string
      description: The query filter to return the items containing the specified modifier
        list IDs.
      x-property-order:
      - modifier_list_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogQueryItemsForModifierList
    CatalogQueryItemsForTax:
      required:
      - tax_ids
      type: object
      properties:
        tax_ids:
          type: array
          description: A set of `CatalogTax` IDs to be used to find associated `CatalogItem`s.
          items:
            type: string
      description: The query filter to return the items containing the specified tax
        IDs.
      x-property-order:
      - tax_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogQueryItemsForTax
    CatalogQueryPrefix:
      required:
      - attribute_name
      - attribute_prefix
      type: object
      properties:
        attribute_name:
          minLength: 1
          type: string
          description: The name of the attribute to be searched.
        attribute_prefix:
          minLength: 1
          type: string
          description: The desired prefix of the search attribute value.
      description: The query filter to return the search result whose named attribute
        values are prefixed by the specified attribute value.
      x-property-order:
      - attribute_name
      - attribute_prefix
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogQueryPrefix
    CatalogQueryRange:
      required:
      - attribute_name
      type: object
      properties:
        attribute_name:
          minLength: 1
          type: string
          description: The name of the attribute to be searched.
        attribute_min_value:
          type: integer
          description: The desired minimum value for the search attribute (inclusive).
          format: int64
        attribute_max_value:
          type: integer
          description: The desired maximum value for the search attribute (inclusive).
          format: int64
      description: The query filter to return the search result whose named attribute
        values fall between the specified range.
      x-property-order:
      - attribute_name
      - attribute_min_value
      - attribute_max_value
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogQueryRange
    CatalogQuerySet:
      required:
      - attribute_name
      - attribute_values
      type: object
      properties:
        attribute_name:
          minLength: 1
          type: string
          description: The name of the attribute to be searched. Matching of the attribute
            name is exact.
        attribute_values:
          type: array
          description: |-
            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.
          items:
            type: string
      description: |-
        The query filter to return the search result(s) by exact match of the specified `attribute_name` and any of
        the `attribute_values`.
      x-property-order:
      - attribute_name
      - attribute_values
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogQuerySet
    CatalogQuerySortedAttribute:
      required:
      - attribute_name
      type: object
      properties:
        attribute_name:
          minLength: 1
          type: string
          description: The attribute whose value is used as the sort key.
        initial_attribute_value:
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/SortOrder'
      description: The query expression to specify the key to sort search results.
      x-property-order:
      - attribute_name
      - initial_attribute_value
      - sort_order
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogQuerySortedAttribute
    CatalogQueryText:
      required:
      - keywords
      type: object
      properties:
        keywords:
          type: array
          description: A list of 1, 2, or 3 search keywords. Keywords with fewer than
            3 characters are ignored.
          items:
            type: string
      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-property-order:
      - keywords
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogQueryText
    CatalogQuickAmount:
      required:
      - amount
      - type
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CatalogQuickAmountType'
        amount:
          $ref: '#/components/schemas/Money'
        score:
          type: integer
          description: |-
            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.
          format: int64
        ordinal:
          type: integer
          description: The order in which this Quick Amount should be displayed.
          format: int64
      description: Represents a Quick Amount in the Catalog.
      x-property-order:
      - type
      - amount
      - score
      - ordinal
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogQuickAmount
    CatalogQuickAmountsSettings:
      required:
      - option
      type: object
      properties:
        option:
          $ref: '#/components/schemas/CatalogQuickAmountsSettingsOption'
        eligible_for_auto_amounts:
          type: boolean
          description: |-
            Represents location's eligibility for auto amounts
            The boolean should be consistent with whether there are AUTO amounts in the `amounts`.
        amounts:
          type: array
          description: Represents a set of Quick Amounts at this location.
          items:
            $ref: '#/components/schemas/CatalogQuickAmount'
      description: A parent Catalog Object model represents a set of Quick Amounts
        and the settings control the amounts.
      x-property-order:
      - option
      - eligible_for_auto_amounts
      - amounts
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogQuickAmountsSettings
    CatalogStockConversion:
      required:
      - nonstockable_quantity
      - stockable_item_variation_id
      - stockable_quantity
      type: object
      properties:
        stockable_item_variation_id:
          minLength: 1
          type: string
          description: |-
            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:
          maxLength: 16
          minLength: 1
          type: string
          description: |-
            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:
          maxLength: 16
          minLength: 1
          type: string
          description: |-
            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.
      description: |-
        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.
      x-property-order:
      - stockable_item_variation_id
      - stockable_quantity
      - nonstockable_quantity
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogStockConversion
    CatalogSubscriptionPlan:
      required:
      - name
      - phases
      type: object
      properties:
        name:
          type: string
          description: The name of the plan.
        phases:
          type: array
          description: A list of SubscriptionPhase containing the [SubscriptionPhase](entity:SubscriptionPhase)
            for this plan.
          items:
            $ref: '#/components/schemas/SubscriptionPhase'
      description: |-
        Describes a subscription plan. For more information, see
        [Set Up and Manage a Subscription Plan](https://developer.squareup.com/docs/subscriptions-api/setup-plan).
      x-property-order:
      - name
      - phases
      - tax_info
      - configuration
      - subscription_product_id
      - monthly_billing_anchor_date
      - can_prorate
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogSubscriptionPlan
    CatalogTax:
      type: object
      properties:
        name:
          maxLength: 255
          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.
        calculation_phase:
          $ref: '#/components/schemas/TaxCalculationPhase'
        inclusion_type:
          $ref: '#/components/schemas/TaxInclusionType'
        percentage:
          type: string
          description: |-
            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: boolean
          description: |-
            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: 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`).
      description: A tax applicable to an item.
      example:
        object:
          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"
            fee_applies_to_custom_amounts: true
            enabled: true
      x-property-order:
      - name
      - calculation_phase
      - inclusion_type
      - percentage
      - applies_to_custom_amounts
      - enabled
      - tax_type_id
      - tax_type_name
      - amount
      - applies_to_product_set_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogTax
    CatalogTimePeriod:
      type: object
      properties:
        event:
          type: string
          description: |-
            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.
      description: Represents a time period - either a single period or a repeating
        period.
      x-property-order:
      - event
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogTimePeriod
    CatalogV1Id:
      type: object
      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.
        location_id:
          type: string
          description: The ID of the `Location` this Connect V1 ID is associated with.
      description: A Square API V1 identifier of an item, including the object ID
        and its associated location ID.
      x-property-order:
      - catalog_v1_id
      - location_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogV1Id
    ItemVariationLocationOverrides:
      type: object
      properties:
        location_id:
          type: string
          description: The ID of the `Location`. This can include locations that are
            deactivated.
        price_money:
          $ref: '#/components/schemas/Money'
        pricing_type:
          $ref: '#/components/schemas/CatalogPricingType'
        track_inventory:
          type: boolean
          description: If `true`, inventory tracking is active for the `CatalogItemVariation`
            at this `Location`.
        inventory_alert_type:
          $ref: '#/components/schemas/InventoryAlertType'
        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`
            is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard.

            This value is always an integer.
          format: int64
        sold_out:
          type: boolean
          description: |-
            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`.
          readOnly: true
          x-release-status: BETA
        sold_out_valid_until:
          type: string
          description: |-
            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.
          readOnly: true
          x-release-status: BETA
      description: Price and inventory alerting overrides for a `CatalogItemVariation`
        at a specific `Location`.
      x-property-order:
      - location_id
      - price_money
      - pricing_type
      - track_inventory
      - inventory_alert_type
      - inventory_alert_threshold
      - price_description
      - resource_tokens
      - sold_out
      - sold_out_valid_until
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: ItemVariationLocationOverrides
    QuantityRatio:
      type: object
      properties:
        quantity:
          minimum: 0
          type: integer
          description: The whole or fractional quantity as the numerator.
        quantity_denominator:
          minimum: 0
          type: integer
          description: |-
            The whole or fractional quantity as the denominator.
            In the case of fractional quantity this field is the denominator and quantity is the numerator.
            When unspecified, the value is `1`. For example, when `quantity=3` and `quantity_donominator` is unspecified,
            the quantity ratio is `3` or `3/1`.
      description: A whole number or unreduced fractional ratio.
      x-property-order:
      - quantity
      - quantity_denominator
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: QuantityRatio
    SubscriptionPhase:
      required:
      - cadence
      type: object
      properties:
        uid:
          type: string
          description: The Square-assigned ID of the subscription phase. This field
            cannot be changed after a `SubscriptionPhase` is created.
        cadence:
          $ref: '#/components/schemas/SubscriptionCadence'
        periods:
          minimum: 0
          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.
        recurring_price_money:
          $ref: '#/components/schemas/Money'
        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
      description: |-
        Describes a phase in a subscription plan. For more information, see
        [Set Up and Manage a Subscription Plan](https://developer.squareup.com/docs/subscriptions-api/setup-plan).
      x-property-order:
      - uid
      - cadence
      - periods
      - recurring_price_money
      - ordinal
      - one_time_fee
      - pricing
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/resources/datatypes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: SubscriptionPhase
    BatchDeleteCatalogObjectsRequest:
      type: object
      properties:
        object_ids:
          type: array
          description: |-
            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.
          items:
            type: string
      example:
        object_ids:
        - W62UWFY35CWMYGVWK6TWJDNI
        - AA27W3M2GGTF3H6AVPNB77CK
      x-property-order:
      - object_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/batch-delete-catalog-obj.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: BatchDeleteCatalogObjectsRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsRequest.python
        csharp: /sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsRequest.csharp
        java: /sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsRequest.java
        php: /sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsRequest.php
        javascript: /sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsRequest.javascript
        ruby: /sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsRequest.ruby
    BatchDeleteCatalogObjectsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        deleted_object_ids:
          type: array
          description: The IDs of all CatalogObjects deleted by this request.
          items:
            type: string
        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_object_ids:
        - W62UWFY35CWMYGVWK6TWJDNI
        - AA27W3M2GGTF3H6AVPNB77CK
        deleted_at: 2016-11-16T22:25:24.878Z
      x-property-order:
      - errors
      - deleted_object_ids
      - deleted_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/batch-delete-catalog-obj.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: BatchDeleteCatalogObjectsResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsResponse.python
        csharp: /sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsResponse.csharp
        java: /sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsResponse.java
        php: /sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsResponse.php
        javascript: /sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsResponse.javascript
        ruby: /sdk_samples/Catalog/BatchDeleteCatalogObjects/BatchDeleteCatalogObjectsResponse.ruby
    BatchRetrieveCatalogObjectsRequest:
      required:
      - object_ids
      type: object
      properties:
        object_ids:
          maxItems: 1000
          type: array
          description: The IDs of the CatalogObjects to be retrieved.
          items:
            type: string
        include_related_objects:
          type: boolean
          description: |-
            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: 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
        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`.
      example:
        object_ids:
        - W62UWFY35CWMYGVWK6TWJDNI
        - AA27W3M2GGTF3H6AVPNB77CK
        include_related_objects: true
      x-property-order:
      - object_ids
      - include_related_objects
      - include_counts
      - catalog_version
      - include_deleted_objects
      - include_nested_objects
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/batch-retrieve-catalog-obj.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: BatchRetrieveCatalogObjectsRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsRequest.python
        csharp: /sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsRequest.csharp
        java: /sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsRequest.java
        php: /sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsRequest.php
        javascript: /sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsRequest.javascript
        ruby: /sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsRequest.ruby
    BatchRetrieveCatalogObjectsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        objects:
          type: array
          description: A list of [CatalogObject](entity:CatalogObject)s returned.
          items:
            $ref: '#/components/schemas/CatalogObject'
        related_objects:
          type: array
          description: A list of [CatalogObject](entity:CatalogObject)s referenced
            by the object in the `objects` field.
          items:
            $ref: '#/components/schemas/CatalogObject'
      example:
        objects:
        - type: ITEM
          id: W62UWFY35CWMYGVWK6TWJDNI
          updated_at: 2016-11-16T22:25:24.878Z
          version: 1479335124878
          is_deleted: false
          present_at_all_locations: true
          item_data:
            name: Tea
            description: Hot Leaf Juice
            category_id: BJNQCF2FJ6S6UIDT65ABHLRX
            tax_ids:
            - HURXQOOAIC4IZSI2BEXQRYFY
            variations:
            - type: ITEM_VARIATION
              id: 2TZFAOHWGG7PAK2QEXWYPZSP
              updated_at: 2016-11-16T22:25:24.878Z
              version: 1479335124878
              is_deleted: false
              present_at_all_locations: true
              item_variation_data:
                item_id: W62UWFY35CWMYGVWK6TWJDNI
                name: Mug
                ordinal: 0
                pricing_type: FIXED_PRICING
                price_money:
                  amount: 150
                  currency: USD
        - type: ITEM
          id: AA27W3M2GGTF3H6AVPNB77CK
          updated_at: 2016-11-16T22:25:24.878Z
          version: 1479335124878
          is_deleted: false
          present_at_all_locations: true
          item_data:
            name: Coffee
            description: Hot Bean Juice
            category_id: BJNQCF2FJ6S6UIDT65ABHLRX
            tax_ids:
            - HURXQOOAIC4IZSI2BEXQRYFY
            variations:
            - type: ITEM_VARIATION
              id: LBTYIHNHU52WOIHWT7SNRIYH
              updated_at: 2016-11-16T22:25:24.878Z
              version: 1479335124878
              is_deleted: false
              present_at_all_locations: true
              item_variation_data:
                item_id: AA27W3M2GGTF3H6AVPNB77CK
                name: Regular
                ordinal: 0
                pricing_type: FIXED_PRICING
                price_money:
                  amount: 250
                  currency: USD
            - type: ITEM_VARIATION
              id: PKYIC7HGGKW5CYVSCVDEIMHY
              updated_at: 2016-11-16T22:25:24.878Z
              version: 1479335124878
              is_deleted: false
              present_at_all_locations: true
              item_variation_data:
                item_id: AA27W3M2GGTF3H6AVPNB77CK
                name: Large
                ordinal: 1
                pricing_type: FIXED_PRICING
                price_money:
                  amount: 350
                  currency: USD
        related_objects:
        - type: CATEGORY
          id: BJNQCF2FJ6S6UIDT65ABHLRX
          updated_at: 2016-11-16T22:25:24.878Z
          version: 1479335124878
          is_deleted: false
          present_at_all_locations: true
          category_data:
            name: Beverages
        - type: TAX
          id: HURXQOOAIC4IZSI2BEXQRYFY
          updated_at: 2016-11-16T22:25:24.878Z
          version: 1479335124878
          is_deleted: false
          present_at_all_locations: true
          tax_data:
            name: Sales Tax
            calculation_phase: TAX_SUBTOTAL_PHASE
            inclusion_type: ADDITIVE
            percentage: "5.0"
            enabled: true
      x-property-order:
      - errors
      - objects
      - related_objects
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/batch-retrieve-catalog-obj.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: BatchRetrieveCatalogObjectsResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsResponse.python
        csharp: /sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsResponse.csharp
        java: /sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsResponse.java
        php: /sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsResponse.php
        javascript: /sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsResponse.javascript
        ruby: /sdk_samples/Catalog/BatchRetrieveCatalogObjects/BatchRetrieveCatalogObjectsResponse.ruby
    BatchUpsertCatalogObjectsRequest:
      required:
      - batches
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          minLength: 1
          type: string
          description: |-
            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/basics/api101/idempotency) for more information.
        batches:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/CatalogObjectBatch'
      example:
        idempotency_key: 789ff020-f723-43a9-b4b5-43b5dc1fa3dc
        batches:
        - objects:
          - type: ITEM
            id: '#Tea'
            present_at_all_locations: true
            item_data:
              name: Tea
              description_html: <p><strong>Hot</strong> Leaf Juice</p>
              category_id: '#Beverages'
              tax_ids:
              - '#SalesTax'
              variations:
              - type: ITEM_VARIATION
                id: '#Tea_Mug'
                present_at_all_locations: true
                item_variation_data:
                  item_id: '#Tea'
                  name: Mug
                  pricing_type: FIXED_PRICING
                  price_money:
                    amount: 150
                    currency: USD
          - type: ITEM
            id: '#Coffee'
            present_at_all_locations: true
            item_data:
              name: Coffee
              description_html: <p>Hot <em>Bean Juice</em></p>
              category_id: '#Beverages'
              tax_ids:
              - '#SalesTax'
              variations:
              - type: ITEM_VARIATION
                id: '#Coffee_Regular'
                present_at_all_locations: true
                item_variation_data:
                  item_id: '#Coffee'
                  name: Regular
                  pricing_type: FIXED_PRICING
                  price_money:
                    amount: 250
                    currency: USD
              - type: ITEM_VARIATION
                id: '#Coffee_Large'
                present_at_all_locations: true
                item_variation_data:
                  item_id: '#Coffee'
                  name: Large
                  pricing_type: FIXED_PRICING
                  price_money:
                    amount: 350
                    currency: USD
          - type: CATEGORY
            id: '#Beverages'
            present_at_all_locations: true
            category_data:
              name: Beverages
          - 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
      x-property-order:
      - idempotency_key
      - batches
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/batch-upsert-catalog-obj.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: BatchUpsertCatalogObjectsRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.python
        csharp: /sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.csharp
        java: /sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.java
        php: /sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.php
        javascript: /sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.javascript
        ruby: /sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsRequest.ruby
    BatchUpsertCatalogObjectsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        objects:
          type: array
          description: The created successfully created CatalogObjects.
          items:
            $ref: '#/components/schemas/CatalogObject'
        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
          description: The mapping between client and server IDs for this upsert.
          items:
            $ref: '#/components/schemas/CatalogIdMapping'
      example:
        objects:
        - type: ITEM
          id: ZSDZN34NAXDLC6D5ZQMNSOUM
          updated_at: 2017-05-10T18:48:39.798Z
          version: 1494442119798
          is_deleted: false
          present_at_all_locations: true
          item_data:
            name: Tea
            description: Hot Leaf Juice
            description_html: <p><strong>Hot</strong> Leaf Juice</p>
            description_plaintext: Hot Leaf Juice
            category_id: LYT72K3WGJFFCIMB63XARP3I
            tax_ids:
            - XHSHLHNWSI3HVI4BW5ZUZXI3
            variations:
            - type: ITEM_VARIATION
              id: NAYHET5R52MIYCEF34ZMAHFM
              updated_at: 2017-05-10T18:48:39.798Z
              version: 1494442119798
              is_deleted: false
              present_at_all_locations: true
              item_variation_data:
                item_id: ZSDZN34NAXDLC6D5ZQMNSOUM
                name: Mug
                ordinal: 0
                pricing_type: FIXED_PRICING
                price_money:
                  amount: 150
                  currency: USD
        - type: ITEM
          id: PJMCEBHHUS3OKDB6PYUHLCPP
          updated_at: 2017-05-10T18:48:39.798Z
          version: 1494442119798
          is_deleted: false
          present_at_all_locations: true
          item_data:
            name: Coffee
            description: Hot Bean Juice
            description_html: <p>Hot <em>Bean Juice</em></p>
            description_plaintext: Hot Bean Juice
            category_id: LYT72K3WGJFFCIMB63XARP3I
            tax_ids:
            - XHSHLHNWSI3HVI4BW5ZUZXI3
            variations:
            - type: ITEM_VARIATION
              id: OTYDX45SPG7LJQUVCBZI4INH
              updated_at: 2017-05-10T18:48:39.798Z
              version: 1494442119798
              is_deleted: false
              present_at_all_locations: true
              item_variation_data:
                item_id: PJMCEBHHUS3OKDB6PYUHLCPP
                name: Regular
                ordinal: 0
                pricing_type: FIXED_PRICING
                price_money:
                  amount: 250
                  currency: USD
            - type: ITEM_VARIATION
              id: GZDA3JB37FYVOPI4AOEBOITI
              updated_at: 2017-05-10T18:48:39.798Z
              version: 1494442119798
              is_deleted: false
              present_at_all_locations: true
              item_variation_data:
                item_id: PJMCEBHHUS3OKDB6PYUHLCPP
                name: Large
                ordinal: 1
                pricing_type: FIXED_PRICING
                price_money:
                  amount: 350
                  currency: USD
        - type: CATEGORY
          id: LYT72K3WGJFFCIMB63XARP3I
          updated_at: 2017-05-10T18:48:39.798Z
          version: 1494442119798
          is_deleted: false
          present_at_all_locations: true
          category_data:
            name: Beverages
        - type: TAX
          id: XHSHLHNWSI3HVI4BW5ZUZXI3
          updated_at: 2017-05-10T18:48:39.798Z
          version: 1494442119798
          is_deleted: false
          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
        id_mappings:
        - client_object_id: '#Tea'
          object_id: ZSDZN34NAXDLC6D5ZQMNSOUM
        - client_object_id: '#Coffee'
          object_id: PJMCEBHHUS3OKDB6PYUHLCPP
        - client_object_id: '#Beverages'
          object_id: LYT72K3WGJFFCIMB63XARP3I
        - client_object_id: '#SalesTax'
          object_id: XHSHLHNWSI3HVI4BW5ZUZXI3
        - client_object_id: '#Tea_Mug'
          object_id: NAYHET5R52MIYCEF34ZMAHFM
        - client_object_id: '#Coffee_Regular'
          object_id: OTYDX45SPG7LJQUVCBZI4INH
        - client_object_id: '#Coffee_Large'
          object_id: GZDA3JB37FYVOPI4AOEBOITI
      x-property-order:
      - errors
      - objects
      - updated_at
      - id_mappings
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/batch-upsert-catalog-obj.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: BatchUpsertCatalogObjectsResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsResponse.python
        csharp: /sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsResponse.csharp
        java: /sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsResponse.java
        php: /sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsResponse.php
        javascript: /sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsResponse.javascript
        ruby: /sdk_samples/Catalog/BatchUpsertCatalogObjects/BatchUpsertCatalogObjectsResponse.ruby
    CatalogInfoRequest:
      type: object
      properties: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/catalog-info.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogInfoRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/CatalogInfo/CatalogInfoRequest.python
        csharp: /sdk_samples/Catalog/CatalogInfo/CatalogInfoRequest.csharp
        java: /sdk_samples/Catalog/CatalogInfo/CatalogInfoRequest.java
        php: /sdk_samples/Catalog/CatalogInfo/CatalogInfoRequest.php
        javascript: /sdk_samples/Catalog/CatalogInfo/CatalogInfoRequest.javascript
        ruby: /sdk_samples/Catalog/CatalogInfo/CatalogInfoRequest.ruby
    CatalogInfoResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        limits:
          $ref: '#/components/schemas/CatalogInfoResponseLimits'
        standard_unit_description_group:
          $ref: '#/components/schemas/StandardUnitDescriptionGroup'
      example:
        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
      x-property-order:
      - errors
      - limits
      - standard_unit_description_group
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/catalog-info.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogInfoResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/CatalogInfo/CatalogInfoResponse.python
        csharp: /sdk_samples/Catalog/CatalogInfo/CatalogInfoResponse.csharp
        java: /sdk_samples/Catalog/CatalogInfo/CatalogInfoResponse.java
        php: /sdk_samples/Catalog/CatalogInfo/CatalogInfoResponse.php
        javascript: /sdk_samples/Catalog/CatalogInfo/CatalogInfoResponse.javascript
        ruby: /sdk_samples/Catalog/CatalogInfo/CatalogInfoResponse.ruby
    CatalogInfoResponseLimits:
      type: object
      properties:
        batch_upsert_max_objects_per_batch:
          type: integer
          description: |-
            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: integer
          description: |-
            The maximum number of objects that may appear across all batches in a
            `/v2/catalog/batch-upsert` request.
        batch_retrieve_max_object_ids:
          type: integer
          description: |-
            The maximum number of object IDs that may appear in a `/v2/catalog/batch-retrieve`
            request.
        search_max_page_limit:
          type: integer
          description: |-
            The maximum number of results that may be returned in a page of a
            `/v2/catalog/search` response.
        batch_delete_max_object_ids:
          type: integer
          description: |-
            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: integer
          description: |-
            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: integer
          description: |-
            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: integer
          description: |-
            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: integer
          description: |-
            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: integer
          description: |-
            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: integer
          description: |-
            The maximum number of modifier list IDs to be disabled that may be included in
            a single `/v2/catalog/update-item-modifier-lists` request.
      x-property-order:
      - batch_upsert_max_objects_per_batch
      - batch_upsert_max_total_objects
      - batch_retrieve_max_object_ids
      - search_max_page_limit
      - batch_delete_max_object_ids
      - update_item_taxes_max_item_ids
      - update_item_taxes_max_taxes_to_enable
      - update_item_taxes_max_taxes_to_disable
      - update_item_modifier_lists_max_item_ids
      - update_item_modifier_lists_max_modifier_lists_to_enable
      - update_item_modifier_lists_max_modifier_lists_to_disable
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/catalog-info.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CatalogInfoResponseLimits
    CreateCatalogImageRequest:
      required:
      - idempotency_key
      - image
      type: object
      properties:
        idempotency_key:
          minLength: 1
          type: string
          description: |-
            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/basics/api101/idempotency) for more information.
        object_id:
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/CatalogObject'
        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`.
            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`.
          x-release-status: BETA
      example:
        idempotency_key: 528dea59-7bfb-43c1-bd48-4a6bba7dd61f86
        object_id: ND6EA5AAJEO5WL3JNNIAQA32
        image:
          id: '#TEMP_ID'
          type: IMAGE
          image_data:
            caption: A picture of a cup of coffee
      x-property-order:
      - idempotency_key
      - object_id
      - image
      - is_primary
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/create-catalog-image.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CreateCatalogImageRequest
    CreateCatalogImageResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        image:
          $ref: '#/components/schemas/CatalogObject'
      example:
        image:
          id: KQLFFHA6K6J3YQAQAWDQAL57
          type: IMAGE
          image_data:
            url: https://...
            caption: A picture of a cup of coffee
      x-property-order:
      - errors
      - image
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/create-catalog-image.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CreateCatalogImageResponse
    CustomAttributeFilter:
      type: object
      properties:
        custom_attribute_definition_id:
          type: string
          description: |-
            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: string
          description: |-
            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: string
          description: |-
            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:
          $ref: '#/components/schemas/Range'
        selection_uids_filter:
          type: array
          description: |-
            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.
          items:
            type: string
        bool_filter:
          type: boolean
          description: |-
            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.
      description: |-
        Supported custom attribute query expressions for calling the
        [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems)
        endpoint to search for items or item variations.
      x-property-order:
      - custom_attribute_definition_id
      - key
      - string_filter
      - number_filter
      - selection_uids_filter
      - bool_filter
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/search-catalog-items.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: CustomAttributeFilter
    DeleteCatalogObjectRequest:
      type: object
      properties: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/delete-catalog-obj.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: DeleteCatalogObjectRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectRequest.python
        csharp: /sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectRequest.csharp
        java: /sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectRequest.java
        php: /sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectRequest.php
        javascript: /sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectRequest.javascript
        ruby: /sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectRequest.ruby
    DeleteCatalogObjectResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        deleted_object_ids:
          type: array
          description: |-
            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.
          items:
            type: string
        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_object_ids:
        - 7SB3ZQYJ5GDMVFL7JK46JCHT
        - KQLFFHA6K6J3YQAQAWDQAL57
        deleted_at: 2016-11-16T22:25:24.878Z
      x-property-order:
      - errors
      - deleted_object_ids
      - deleted_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/delete-catalog-obj.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: DeleteCatalogObjectResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectResponse.python
        csharp: /sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectResponse.csharp
        java: /sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectResponse.java
        php: /sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectResponse.php
        javascript: /sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectResponse.javascript
        ruby: /sdk_samples/Catalog/DeleteCatalogObject/DeleteCatalogObjectResponse.ruby
    ListCatalogRequest:
      type: object
      properties:
        cursor:
          type: string
          description: |-
            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/basics/api101/pagination) for more information.
        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\n\
            of 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,\n\
            SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS."
        catalog_version:
          type: integer
          description: "The specific version of the catalog objects to be included\
            \ in the response. \nThis allows you to retrieve historical\nversions\
            \ 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
      x-property-order:
      - cursor
      - types
      - include_counts
      - catalog_version
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/list-catalog.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: ListCatalogRequest
      x-params-example: ?types=category,tax
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/ListCatalog/ListCatalogRequest.python
        csharp: /sdk_samples/Catalog/ListCatalog/ListCatalogRequest.csharp
        java: /sdk_samples/Catalog/ListCatalog/ListCatalogRequest.java
        php: /sdk_samples/Catalog/ListCatalog/ListCatalogRequest.php
        javascript: /sdk_samples/Catalog/ListCatalog/ListCatalogRequest.javascript
        ruby: /sdk_samples/Catalog/ListCatalog/ListCatalogRequest.ruby
    ListCatalogResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        cursor:
          type: string
          description: |-
            The pagination cursor to be used in a subsequent request. If unset, this is the final response.
            See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.
        objects:
          type: array
          description: The CatalogObjects returned.
          items:
            $ref: '#/components/schemas/CatalogObject'
      example:
        objects:
        - type: CATEGORY
          id: 5ZYQZZ2IECPVJ2IJ5KQPRDC3
          updated_at: 2017-02-21T14:50:26.495Z
          version: 1487688626495
          is_deleted: false
          present_at_all_locations: true
          category_data:
            name: Beverages
        - type: TAX
          id: L5R47DGBZOOVKCAFIXC56AEN
          updated_at: 2017-02-21T14:50:26.495Z
          version: 1487688626495
          is_deleted: false
          present_at_all_locations: true
          tax_data:
            name: Sales Tax
            calculation_phase: TAX_SUBTOTAL_PHASE
            inclusion_type: ADDITIVE
            percentage: "5.0"
            enabled: true
      x-property-order:
      - errors
      - cursor
      - objects
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/list-catalog.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: ListCatalogResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/ListCatalog/ListCatalogResponse.python
        csharp: /sdk_samples/Catalog/ListCatalog/ListCatalogResponse.csharp
        java: /sdk_samples/Catalog/ListCatalog/ListCatalogResponse.java
        php: /sdk_samples/Catalog/ListCatalog/ListCatalogResponse.php
        javascript: /sdk_samples/Catalog/ListCatalog/ListCatalogResponse.javascript
        ruby: /sdk_samples/Catalog/ListCatalog/ListCatalogResponse.ruby
    Range:
      type: object
      properties:
        min:
          type: string
          description: |-
            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: string
          description: |-
            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.
      description: The range of a number value between the specified lower and upper
        bounds.
      x-property-order:
      - min
      - max
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/search-catalog-items.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: Range
    RetrieveCatalogObjectRequest:
      type: object
      properties:
        include_related_objects:
          type: boolean
          description: |-
            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: integer
          description: |-
            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.
          format: int64
          x-release-status: BETA
      x-property-order:
      - include_related_objects
      - include_counts
      - catalog_version
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/retrieve-catalog-obj.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: RetrieveCatalogObjectRequest
      x-params-example: ?include_related_objects=true
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectRequest.python
        csharp: /sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectRequest.csharp
        java: /sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectRequest.java
        php: /sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectRequest.php
        javascript: /sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectRequest.javascript
        ruby: /sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectRequest.ruby
    RetrieveCatalogObjectResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        object:
          $ref: '#/components/schemas/CatalogObject'
        related_objects:
          type: array
          description: A list of `CatalogObject`s referenced by the object in the
            `object` field.
          items:
            $ref: '#/components/schemas/CatalogObject'
      example:
        object:
          type: ITEM
          id: W62UWFY35CWMYGVWK6TWJDNI
          updated_at: 2016-11-16T22:25:24.878Z
          version: 1479335124878
          is_deleted: false
          present_at_all_locations: true
          item_data:
            name: Tea
            description: Hot Leaf Juice
            category_id: BJNQCF2FJ6S6UIDT65ABHLRX
            tax_ids:
            - HURXQOOAIC4IZSI2BEXQRYFY
            variations:
            - type: ITEM_VARIATION
              id: 2TZFAOHWGG7PAK2QEXWYPZSP
              updated_at: 2016-11-16T22:25:24.878Z
              version: 1479335124878
              is_deleted: false
              present_at_all_locations: true
              item_variation_data:
                item_id: W62UWFY35CWMYGVWK6TWJDNI
                name: Mug
                ordinal: 0
                pricing_type: FIXED_PRICING
                price_money:
                  amount: 150
                  currency: USD
        related_objects:
        - type: CATEGORY
          id: BJNQCF2FJ6S6UIDT65ABHLRX
          updated_at: 2016-11-16T22:25:24.878Z
          version: 1479335124878
          is_deleted: false
          present_at_all_locations: true
          category_data:
            name: Beverages
        - type: TAX
          id: HURXQOOAIC4IZSI2BEXQRYFY
          updated_at: 2016-11-16T22:25:24.878Z
          version: 1479335124878
          is_deleted: false
          present_at_all_locations: true
          tax_data:
            name: Sales Tax
            calculation_phase: TAX_SUBTOTAL_PHASE
            inclusion_type: ADDITIVE
            percentage: "5.0"
            enabled: true
      x-property-order:
      - errors
      - object
      - related_objects
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/retrieve-catalog-obj.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: RetrieveCatalogObjectResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectResponse.python
        csharp: /sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectResponse.csharp
        java: /sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectResponse.java
        php: /sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectResponse.php
        javascript: /sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectResponse.javascript
        ruby: /sdk_samples/Catalog/RetrieveCatalogObject/RetrieveCatalogObjectResponse.ruby
    SearchCatalogItemsRequest:
      type: object
      properties:
        text_filter:
          type: string
          description: |-
            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: array
          description: The category id query expression to return items containing
            the specified category IDs.
          items:
            type: string
        stock_levels:
          type: array
          description: |-
            The stock-level query expression to return item variations with the specified stock levels.
            See [SearchCatalogItemsRequestStockLevel](#type-searchcatalogitemsrequeststocklevel) for possible values
          items:
            $ref: '#/components/schemas/SearchCatalogItemsRequestStockLevel'
        enabled_location_ids:
          type: array
          description: The enabled-location query expression to return items and item
            variations having specified enabled locations.
          items:
            type: string
        cursor:
          type: string
          description: The pagination token, returned in the previous response, used
            to fetch the next batch of pending results.
        limit:
          maximum: 100
          type: integer
          description: The maximum number of results to return per page. The default
            value is 100.
        sort_order:
          $ref: '#/components/schemas/SortOrder'
        product_types:
          type: array
          description: The product types query expression to return items or item
            variations having the specified product types.
          items:
            $ref: '#/components/schemas/CatalogItemProductType'
        custom_attribute_filters:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/CustomAttributeFilter'
      description: Defines the request body for the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems)
        endpoint.
      example:
        sort_order: ASC
        product_types:
        - REGULAR
        category_ids:
        - WINE_CATEGORY_ID
        enabled_location_ids:
        - ATL_LOCATION_ID
        text_filter: red
        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: 2017
            max: 2018
        - custom_attribute_definition_id: VARIETAL_DEFINITION_ID
          selection_ids_filter: MERLOT_SELECTION_ID
        stock_levels:
        - OUT
        - LOW
        limit: 100
      x-property-order:
      - text_filter
      - category_ids
      - stock_levels
      - enabled_location_ids
      - vendor_ids
      - cursor
      - limit
      - sort_order
      - product_types
      - null_field_filters
      - has_vendor_code
      - sellable_filter
      - stockable_filter
      - custom_attribute_filters
      - sold_out
      - include_nested_objects
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/search-catalog-items.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: SearchCatalogItemsRequest
    SearchCatalogItemsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        items:
          type: array
          description: Returned items matching the specified query expressions.
          items:
            $ref: '#/components/schemas/CatalogObject'
        cursor:
          type: string
          description: Pagination token used in the next request to return more of
            the search result.
        matched_variation_ids:
          type: array
          description: Ids of returned item variations matching the specified query
            expression.
          items:
            type: string
      description: Defines the response body returned from the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems)
        endpoint.
      example:
        items:
        - type: ITEM
          id: GPOKJPTV2KDLVKCADJ7I77EZ
          updated_at: 2020-06-18T17:55:56.646Z
          version: 1592502956646
          is_deleted: false
          present_at_all_locations: true
          custom_attribute_values:
            VINTAGE:
              name: Vintage
              custom_attribute_definition_id: EI7IJQDUKYSHULREPIPH6HNU
              type: NUMBER
              number_value: 2018
              key: VINTAGE
            VARIETAL:
              name: Varietal
              custom_attribute_definition_id: VARIETAL_DEFINITION_ID
              type: SELECTION
              selection_uid_values:
              - MERLOT_SELECTION_ID
              - null
              key: VARIETAL
            BRAND:
              name: Brand
              custom_attribute_definition_id: BRAND_DEFINITION_ID
              type: STRING
              string_value: Dark Horse
              key: BRAND
          item_data:
            name: Dark Horse Merlot 2018
            product_type: REGULAR
            description: A nice red wine
            variations:
            - type: ITEM_VARIATION
              id: VBJNPHCOKDFECR6VU25WRJUD
              updated_at: 2020-06-18T17:55:56.646Z
              version: 1592502956646
              is_deleted: false
              present_at_all_locations: true
              item_variation_data:
                item_id: GPOKJPTV2KDLVKCADJ7I77EZ
                name: 750 mL
                ordinal: 0
                pricing_type: FIXED_PRICING
                price_money:
                  amount: 1000
                  currency: USD
        matched_variation_ids:
        - VBJNPHCOKDFECR6VU25WRJUD
      x-property-order:
      - errors
      - items
      - cursor
      - matched_variation_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/search-catalog-items.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: SearchCatalogItemsResponse
    SearchCatalogObjectsRequest:
      type: object
      properties:
        cursor:
          type: string
          description: |-
            The pagination cursor returned in the previous response. Leave unset for an initial request.
            See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.
        object_types:
          type: array
          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."
          items:
            $ref: '#/components/schemas/CatalogObjectType'
        include_deleted_objects:
          type: boolean
          description: |-
            If `true`, deleted objects will be included in the results. Deleted objects will have their
            `is_deleted` field set to `true`.
        include_related_objects:
          type: boolean
          description: |-
            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: string
          description: |-
            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:
          $ref: '#/components/schemas/CatalogQuery'
        limit:
          type: integer
          description: |-
            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.
      example:
        object_types:
        - ITEM
        query:
          prefix_query:
            attribute_name: name
            attribute_prefix: tea
        limit: 100
      x-property-order:
      - cursor
      - object_types
      - include_deleted_objects
      - include_related_objects
      - begin_time
      - query
      - limit
      - end_time
      - include_counts
      - catalog_version
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/search-catalog-obj.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: SearchCatalogObjectsRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.python
        csharp: /sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.csharp
        java: /sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.java
        php: /sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.php
        javascript: /sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.javascript
        ruby: /sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsRequest.ruby
    SearchCatalogObjectsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        cursor:
          type: string
          description: |-
            The pagination cursor to be used in a subsequent request. If unset, this is the final response.
            See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.
        objects:
          type: array
          description: The CatalogObjects returned.
          items:
            $ref: '#/components/schemas/CatalogObject'
        related_objects:
          type: array
          description: A list of CatalogObjects referenced by the objects in the `objects`
            field.
          items:
            $ref: '#/components/schemas/CatalogObject'
        latest_time:
          type: string
          description: |-
            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.
          x-release-status: BETA
      example:
        objects:
        - type: ITEM
          id: X5DZ5NWWAQ44CKBLKIFQGOWK
          updated_at: 2017-10-26T15:41:32.337Z
          version: 1509032492337
          is_deleted: false
          present_at_all_locations: true
          item_data:
            name: Tea - Black
            description: A delicious blend of black tea.
            category_id: E7CLE5RZZ744BHWVQQEAHI2C
            product_type: REGULAR
            tax_ids:
            - ZXITPM6RWHZ7GZ7EIP3YKECM
            variations:
            - type: ITEM_VARIATION
              id: 5GSZPX6EU7MM75S57OONG3V5
              updated_at: 2017-10-26T15:27:31.626Z
              version: 1509031651626
              is_deleted: false
              present_at_all_locations: true
              item_variation_data:
                item_id: X5DZ5NWWAQ44CKBLKIFQGOWK
                name: Regular
                ordinal: 1
                price_money:
                  amount: 150
                  currency: USD
                pricing_type: FIXED_PRICING
            - type: ITEM_VARIATION
              id: XVLBN7DU6JTWHJTG5F265B43
              updated_at: 2017-10-26T15:27:31.626Z
              version: 1509031651626
              is_deleted: false
              present_at_all_locations: true
              item_variation_data:
                item_id: X5DZ5NWWAQ44CKBLKIFQGOWK
                name: Large
                ordinal: 2
                price_money:
                  amount: 225
                  currency: USD
                pricing_type: FIXED_PRICING
            visibility: PRIVATE
        - type: ITEM
          id: NNNEM3LA656Q46NXLWCNI7S5
          updated_at: 2017-10-26T15:41:23.232Z
          version: 1509032483232
          is_deleted: false
          present_at_all_locations: true
          item_data:
            name: Tea - Green
            description: Relaxing green herbal tea.
            category_id: E7CLE5RZZ744BHWVQQEAHI2C
            product_type: REGULAR
            tax_ids:
            - ZXITPM6RWHZ7GZ7EIP3YKECM
            variations:
            - type: ITEM_VARIATION
              id: FHYBVIA6NVBCSOVETA62WEA4
              updated_at: 2017-10-26T15:29:00.524Z
              version: 1509031740524
              is_deleted: false
              present_at_all_locations: true
              item_variation_data:
                item_id: NNNEM3LA656Q46NXLWCNI7S5
                name: Regular
                ordinal: 1
                price_money:
                  amount: 150
                  currency: USD
                pricing_type: FIXED_PRICING
            visibility: PRIVATE
      x-property-order:
      - errors
      - cursor
      - objects
      - related_objects
      - latest_time
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/search-catalog-obj.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: SearchCatalogObjectsResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsResponse.python
        csharp: /sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsResponse.csharp
        java: /sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsResponse.java
        php: /sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsResponse.php
        javascript: /sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsResponse.javascript
        ruby: /sdk_samples/Catalog/SearchCatalogObjects/SearchCatalogObjectsResponse.ruby
    StandardUnitDescription:
      type: object
      properties:
        unit:
          $ref: '#/components/schemas/MeasurementUnit'
        name:
          type: string
          description: UI display name of the measurement unit. For example, 'Pound'.
        abbreviation:
          type: string
          description: UI display abbreviation for the measurement unit. For example,
            'lb'.
      description: Contains the name and abbreviation for standard measurement unit.
      x-property-order:
      - unit
      - name
      - abbreviation
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/catalog-info.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: StandardUnitDescription
    StandardUnitDescriptionGroup:
      type: object
      properties:
        standard_unit_descriptions:
          type: array
          description: List of standard (non-custom) measurement units in this description
            group.
          items:
            $ref: '#/components/schemas/StandardUnitDescription'
        language_code:
          type: string
          description: IETF language tag.
      description: Group of standard measurement units.
      x-property-order:
      - standard_unit_descriptions
      - language_code
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/catalog-info.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: StandardUnitDescriptionGroup
    UpdateCatalogImageRequest:
      required:
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          minLength: 1
          type: string
          description: |-
            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/basics/api101/idempotency) for more information.
      example:
        idempotency_key: 528dea59-7bfb-43c1-bd48-4a6bba7dd61f86
        object_id: ND6EA5AAJEO5WL3JNNIAQA32
        image:
          type: IMAGE
          image_data:
            name: Coffee
            caption: A picture of a cup of coffee
      x-property-order:
      - idempotency_key
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/update-catalog-image.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: UpdateCatalogImageRequest
    UpdateCatalogImageResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        image:
          $ref: '#/components/schemas/CatalogObject'
      example:
        image:
          id: L52QOQN2SW3M5QTF9JOCQKNB
          type: IMAGE
          image_data:
            name: Coffee
            url: https://...
            caption: A picture of a cup of coffee
      x-property-order:
      - errors
      - image
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/update-catalog-image.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: UpdateCatalogImageResponse
    UpdateItemModifierListsRequest:
      required:
      - item_ids
      type: object
      properties:
        item_ids:
          maxItems: 1000
          type: array
          description: The IDs of the catalog items associated with the CatalogModifierList
            objects being updated.
          items:
            type: string
        modifier_lists_to_enable:
          maxItems: 1000
          type: array
          description: |-
            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.
          items:
            type: string
        modifier_lists_to_disable:
          maxItems: 1000
          type: array
          description: |-
            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.
          items:
            type: string
      example:
        item_ids:
        - H42BRLUJ5KTZTTMPVSLFAACQ
        - 2JXOBJIHCWBQ4NZ3RIXQGJA6
        modifier_lists_to_enable:
        - H42BRLUJ5KTZTTMPVSLFAACQ
        - 2JXOBJIHCWBQ4NZ3RIXQGJA6
        modifier_lists_to_disable:
        - 7WRC16CJZDVLSNDQ35PP6YAD
      x-property-order:
      - item_ids
      - modifier_lists_to_enable
      - modifier_lists_to_disable
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/update-item-modifier-lists.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: UpdateItemModifierListsRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsRequest.python
        csharp: /sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsRequest.csharp
        java: /sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsRequest.java
        php: /sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsRequest.php
        javascript: /sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsRequest.javascript
        ruby: /sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsRequest.ruby
    UpdateItemModifierListsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        updated_at:
          type: string
          description: The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-date)
            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-property-order:
      - errors
      - updated_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/update-item-modifier-lists.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: UpdateItemModifierListsResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsResponse.python
        csharp: /sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsResponse.csharp
        java: /sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsResponse.java
        php: /sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsResponse.php
        javascript: /sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsResponse.javascript
        ruby: /sdk_samples/Catalog/UpdateItemModifierLists/UpdateItemModifierListsResponse.ruby
    UpdateItemTaxesRequest:
      required:
      - item_ids
      type: object
      properties:
        item_ids:
          maxItems: 1000
          type: array
          description: |-
            IDs for the CatalogItems associated with the CatalogTax objects being updated.
            No more than 1,000 IDs may be provided.
          items:
            type: string
        taxes_to_enable:
          maxItems: 1000
          type: array
          description: |-
            IDs of the CatalogTax objects to enable.
            At least one of `taxes_to_enable` or `taxes_to_disable` must be specified.
          items:
            type: string
        taxes_to_disable:
          maxItems: 1000
          type: array
          description: |-
            IDs of the CatalogTax objects to disable.
            At least one of `taxes_to_enable` or `taxes_to_disable` must be specified.
          items:
            type: string
      example:
        item_ids:
        - H42BRLUJ5KTZTTMPVSLFAACQ
        - 2JXOBJIHCWBQ4NZ3RIXQGJA6
        taxes_to_enable:
        - 4WRCNHCJZDVLSNDQ35PP6YAD
        taxes_to_disable:
        - AQCEGCEBBQONINDOHRGZISEX
      x-property-order:
      - item_ids
      - taxes_to_enable
      - taxes_to_disable
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/update-item-taxes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: UpdateItemTaxesRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesRequest.python
        csharp: /sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesRequest.csharp
        java: /sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesRequest.java
        php: /sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesRequest.php
        javascript: /sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesRequest.javascript
        ruby: /sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesRequest.ruby
    UpdateItemTaxesResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        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-property-order:
      - errors
      - updated_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/update-item-taxes.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: UpdateItemTaxesResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesResponse.python
        csharp: /sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesResponse.csharp
        java: /sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesResponse.java
        php: /sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesResponse.php
        javascript: /sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesResponse.javascript
        ruby: /sdk_samples/Catalog/UpdateItemTaxes/UpdateItemTaxesResponse.ruby
    UpsertCatalogObjectRequest:
      required:
      - idempotency_key
      - object
      type: object
      properties:
        idempotency_key:
          minLength: 1
          type: string
          description: |-
            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/basics/api101/idempotency) for more information.
        object:
          $ref: '#/components/schemas/CatalogObject'
      example:
        idempotency_key: af3d1afc-7212-4300-b463-0bfc5314a5ae
        object:
          id: '#Cocoa'
          type: ITEM
          item_data:
            abbreviation: Ch
            description_html: <p><strong>Hot</strong> Chocolate</p>
            name: Cocoa
            variations:
            - id: '#Small'
              type: ITEM_VARIATION
              item_variation_data:
                item_id: '#Cocoa'
                name: Small
                pricing_type: VARIABLE_PRICING
            - id: '#Large'
              type: ITEM_VARIATION
              item_variation_data:
                item_id: '#Cocoa'
                name: Large
                pricing_type: FIXED_PRICING
                price_money:
                  amount: 400
                  currency: USD
      x-property-order:
      - idempotency_key
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/upsert-catalog-object.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: UpsertCatalogObjectRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.python
        csharp: /sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.csharp
        java: /sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.java
        php: /sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.php
        javascript: /sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.javascript
        ruby: /sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectRequest.ruby
    UpsertCatalogObjectResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        catalog_object:
          $ref: '#/components/schemas/CatalogObject'
        id_mappings:
          type: array
          description: The mapping between client and server IDs for this upsert.
          items:
            $ref: '#/components/schemas/CatalogIdMapping'
      example:
        catalog_object:
          type: ITEM
          id: R2TA2FOBUGCJZNIWJSOSNAI4
          updated_at: 2021-06-14T15:51:39.021Z
          version: 1623685899021
          is_deleted: false
          present_at_all_locations: true
          item_data:
            name: Cocoa
            description: Hot Chocolate
            description_html: <p><strong>Hot</strong> Chocolate</p>
            description_plaintext: Hot Chocolate
            abbreviation: Ch
            variations:
            - type: ITEM_VARIATION
              id: QRT53UP4LITLWGOGBZCUWP63
              updated_at: 2021-06-14T15:51:39.021Z
              version: 1623685899021
              is_deleted: false
              present_at_all_locations: true
              item_variation_data:
                item_id: R2TA2FOBUGCJZNIWJSOSNAI4
                name: Small
                ordinal: 0
                pricing_type: VARIABLE_PRICING
                stockable: true
            - type: ITEM_VARIATION
              id: NS77DKEIQ3AEQTCP727DSA7U
              updated_at: 2021-06-14T15:51:39.021Z
              version: 1623685899021
              is_deleted: false
              present_at_all_locations: true
              item_variation_data:
                item_id: R2TA2FOBUGCJZNIWJSOSNAI4
                name: Large
                ordinal: 1
                pricing_type: FIXED_PRICING
                price_money:
                  amount: 400
                  currency: USD
                stockable: true
            product_type: REGULAR
        id_mappings:
        - client_object_id: '#Cocoa'
          object_id: R2TA2FOBUGCJZNIWJSOSNAI4
        - client_object_id: '#Small'
          object_id: QRT53UP4LITLWGOGBZCUWP63
        - client_object_id: '#Large'
          object_id: NS77DKEIQ3AEQTCP727DSA7U
      x-property-order:
      - errors
      - catalog_object
      - id_mappings
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/catalog/interfaces/upsert-catalog-object.proto
      x-proto-sha: 32daf8eb9cffd0b4bb203b0088a414a113a5c813
      x-object-name: UpsertCatalogObjectResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectResponse.python
        csharp: /sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectResponse.csharp
        java: /sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectResponse.java
        php: /sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectResponse.php
        javascript: /sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectResponse.javascript
        ruby: /sdk_samples/Catalog/UpsertCatalogObject/UpsertCatalogObjectResponse.ruby
    AcceptedPaymentMethods:
      type: object
      properties:
        apple_pay:
          type: boolean
          description: Whether Apple Pay is accepted at checkout.
        google_pay:
          type: boolean
          description: Whether Google Pay is accepted at checkout.
        cash_app_pay:
          type: boolean
          description: Whether Cash App Pay is accepted at checkout.
        afterpay_clearpay:
          type: boolean
          description: Whether Afterpay/Clearpay is accepted at checkout.
      x-property-order:
      - apple_pay
      - google_pay
      - cash_app_pay
      - afterpay_clearpay
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/resources/payment_link.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: AcceptedPaymentMethods
    CheckoutOptions:
      type: object
      properties:
        allow_tipping:
          type: boolean
          description: Indicates whether the payment allows tipping.
        custom_fields:
          maxItems: 2
          type: array
          description: The custom fields requesting information from the buyer.
          items:
            $ref: '#/components/schemas/CustomField'
        subscription_plan_id:
          maxLength: 255
          type: string
          description: |-
            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:
          maxLength: 2048
          type: string
          description: The confirmation page URL to redirect the buyer to after Square
            processes the payment.
        merchant_support_email:
          maxLength: 256
          type: string
          description: The email address that buyers can use to contact the seller.
        ask_for_shipping_address:
          type: boolean
          description: Indicates whether to include the address fields in the payment
            form.
        accepted_payment_methods:
          $ref: '#/components/schemas/AcceptedPaymentMethods'
        app_fee_money:
          $ref: '#/components/schemas/Money'
        shipping_fee:
          $ref: '#/components/schemas/ShippingFee'
      x-property-order:
      - allow_tipping
      - custom_fields
      - subscription_plan_id
      - redirect_url
      - merchant_support_email
      - ask_for_shipping_address
      - accepted_payment_methods
      - app_fee_money
      - shipping_fee
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/resources/payment_link.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: CheckoutOptions
    CustomField:
      required:
      - title
      type: object
      properties:
        title:
          maxLength: 50
          minLength: 1
          type: string
          description: The title of the custom field.
      description: |-
        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).
      x-property-order:
      - title
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/resources/payment_link.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: CustomField
    PaymentLink:
      required:
      - version
      type: object
      properties:
        id:
          type: string
          description: The Square-assigned ID of the payment link.
          readOnly: true
        version:
          maximum: 65535
          minimum: 0
          type: integer
          description: The Square-assigned version number, which is incremented each
            time an update is committed to the payment link.
        description:
          maxLength: 4096
          type: string
          description: |-
            The optional description of the `payment_link` object.
            It is primarily for use by your application and is not used anywhere.
        order_id:
          maxLength: 192
          type: string
          description: The ID of the order associated with the payment link.
          readOnly: true
        checkout_options:
          $ref: '#/components/schemas/CheckoutOptions'
        pre_populated_data:
          $ref: '#/components/schemas/PrePopulatedData'
        url:
          maxLength: 255
          type: string
          description: The URL of the payment link.
          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:
          maxLength: 500
          type: string
          description: |-
            An optional note. After Square processes the payment, this note is added to the
            resulting `Payment`.
      x-property-order:
      - id
      - version
      - description
      - order_id
      - checkout_options
      - pre_populated_data
      - url
      - created_at
      - updated_at
      - payment_note
      - app_owner_token
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/resources/payment_link.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: PaymentLink
    PaymentLinkRelatedResources:
      type: object
      properties:
        orders:
          type: array
          description: The order associated with the payment link.
          items:
            $ref: '#/components/schemas/Order'
        subscription_plans:
          type: array
          description: The subscription plan associated with the payment link.
          items:
            $ref: '#/components/schemas/CatalogObject'
      x-property-order:
      - orders
      - subscription_plans
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/resources/payment_link_related_resources.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: PaymentLinkRelatedResources
    PrePopulatedData:
      type: object
      properties:
        buyer_email:
          maxLength: 256
          type: string
          description: The buyer email to prepopulate in the payment form.
        buyer_phone_number:
          maxLength: 17
          type: string
          description: The buyer phone number to prepopulate in the payment form.
        buyer_address:
          $ref: '#/components/schemas/Address'
      description: |-
        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).
      x-property-order:
      - buyer_email
      - buyer_phone_number
      - buyer_address
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/resources/payment_link.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: PrePopulatedData
    ShippingFee:
      required:
      - charge
      type: object
      properties:
        name:
          type: string
          description: The name for the shipping fee.
        charge:
          $ref: '#/components/schemas/Money'
      x-property-order:
      - name
      - charge
      - service_charge_uid
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/resources/payment_link.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: ShippingFee
    CreatePaymentLinkRequest:
      type: object
      properties:
        idempotency_key:
          maxLength: 192
          type: string
          description: |-
            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:
          maxLength: 4096
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/QuickPay'
        order:
          $ref: '#/components/schemas/Order'
        checkout_options:
          $ref: '#/components/schemas/CheckoutOptions'
        pre_populated_data:
          $ref: '#/components/schemas/PrePopulatedData'
        payment_note:
          maxLength: 500
          type: string
          description: A note for the payment. After processing the payment, Square
            adds this note to the resulting `Payment`.
      example:
        idempotency_key: cd9e25dc-d9f2-4430-aedb-61605070e95f
        quick_pay:
          name: Auto Detailing
          price_money:
            amount: 10000
            currency: USD
          location_id: A9Y43N9ABXZBP
      x-property-order:
      - idempotency_key
      - description
      - quick_pay
      - order
      - checkout_options
      - pre_populated_data
      - source
      - payment_note
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/service/payment-links-api/create_payment_link.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: CreatePaymentLinkRequest
    CreatePaymentLinkResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        payment_link:
          $ref: '#/components/schemas/PaymentLink'
        related_resources:
          $ref: '#/components/schemas/PaymentLinkRelatedResources'
      example:
        payment_link:
          id: PKVT6XGJZXYUP3NZ
          version: 1
          order_id: o4b7saqp4HzhNttf5AJxC0Srjd4F
          url: https://square.link/u/EXAMPLE
          created_at: 2022-04-25T23:58:01Z
        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: DIGITAL
              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
      x-property-order:
      - errors
      - payment_link
      - related_resources
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/service/payment-links-api/create_payment_link.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: CreatePaymentLinkResponse
    DeletePaymentLinkRequest:
      type: object
      properties: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/service/payment-links-api/delete_payment_link.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: DeletePaymentLinkRequest
    DeletePaymentLinkResponse:
      type: object
      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
            the `state` (of the order that the checkout link created) to CANCELED.
      example:
        id: MQASNYL6QB6DFCJ3
        cancelled_order_id: asx8LgZ6MRzD0fObfkJ6obBmSh4F
      x-property-order:
      - errors
      - id
      - cancelled_order_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/service/payment-links-api/delete_payment_link.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: DeletePaymentLinkResponse
    ListPaymentLinksRequest:
      type: object
      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 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/basics/api101/pagination).
        limit:
          type: integer
          description: |-
            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`
      x-property-order:
      - cursor
      - limit
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/service/payment-links-api/list_payment_link.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: ListPaymentLinksRequest
    ListPaymentLinksResponse:
      type: object
      properties:
        errors:
          type: array
          description: Errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        payment_links:
          type: array
          description: The list of payment links.
          items:
            $ref: '#/components/schemas/PaymentLink'
        cursor:
          type: string
          description: |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/basics/api101/pagination).
      example:
        payment_links:
        - id: TN4BWEDJ9AI5MBIV
          version: 2
          order_id: Qqc6yppGvxVwc46Cch4zHTaJqc4F
          checkout_options:
            ask_for_shipping_address: true
          url: https://square.link/u/EXAMPLE
          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
          created_at: 2022-04-11T23:14:59Z
        cursor: MTY1NQ==
      x-property-order:
      - errors
      - payment_links
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/service/payment-links-api/list_payment_link.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: ListPaymentLinksResponse
    QuickPay:
      required:
      - location_id
      - name
      - price_money
      type: object
      properties:
        name:
          maxLength: 255
          minLength: 1
          type: string
          description: The ad hoc item name. In the resulting `Order`, this name appears
            as the line item name.
        price_money:
          $ref: '#/components/schemas/Money'
        location_id:
          type: string
          description: The ID of the business location the checkout is associated
            with.
      description: |-
        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).
      x-property-order:
      - name
      - price_money
      - location_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/service/payment-links-api/create_payment_link.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: QuickPay
    RetrievePaymentLinkRequest:
      type: object
      properties: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/service/payment-links-api/retrieve_payment_link.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: RetrievePaymentLinkRequest
    RetrievePaymentLinkResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        payment_link:
          $ref: '#/components/schemas/PaymentLink'
      example:
        payment_link:
          id: LLO5Q3FRCFICDB4B
          version: 1
          order_id: 4uKASDATqSd1QQ9jV86sPhMdVEbSJc4F
          url: https://square.link/u/EXAMPLE
          created_at: 2022-04-26T00:10:29Z
      x-property-order:
      - errors
      - payment_link
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/service/payment-links-api/retrieve_payment_link.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: RetrievePaymentLinkResponse
    UpdatePaymentLinkRequest:
      required:
      - payment_link
      type: object
      properties:
        payment_link:
          $ref: '#/components/schemas/PaymentLink'
      example:
        payment_link:
          version: 1
          checkout_options:
            ask_for_shipping_address: true
      x-property-order:
      - payment_link
      - fields_to_clear
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/service/payment-links-api/update_payment_link.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: UpdatePaymentLinkRequest
    UpdatePaymentLinkResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred when updating the payment link.
          items:
            $ref: '#/components/schemas/Error'
        payment_link:
          $ref: '#/components/schemas/PaymentLink'
      example:
        payment_link:
          id: TY4BWEDJ6AI5MBIV
          version: 2
          order_id: Qqc8ypQGvxVwc46Cch4zHTaJqc4F
          checkout_options:
            ask_for_shipping_address: true
          url: https://square.link/u/EXAMPLE
          created_at: 2022-04-26T00:15:15Z
          updated_at: 2022-04-26T00:18:24Z
          payment_note: test
      x-property-order:
      - errors
      - payment_link
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /online-checkout/protos/squareup/online-checkout/service/payment-links-api/update_payment_link.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: UpdatePaymentLinkResponse
    AdditionalRecipient:
      required:
      - amount_money
      - location_id
      type: object
      properties:
        location_id:
          maxLength: 50
          minLength: 1
          type: string
          description: The location ID for a recipient (other than the merchant) receiving
            a portion of this tender.
        description:
          maxLength: 100
          type: string
          description: The description of the additional recipient.
        amount_money:
          $ref: '#/components/schemas/Money'
        receivable_id:
          maxLength: 192
          type: string
          description: The unique ID for the RETIRED `AdditionalRecipientReceivable`
            object. This field should be empty for any `AdditionalRecipient` objects
            created after the retirement.
      description: Represents an additional recipient (other than the merchant) receiving
        a portion of this tender.
      deprecated: true
      x-property-order:
      - location_id
      - description
      - amount_money
      - receivable_id
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/additional_recipient.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: AdditionalRecipient
    Address:
      type: object
      properties:
        address_line_1:
          type: string
          description: |-
            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: string
          description: The second line of the address, if any.
        address_line_3:
          type: string
          description: The third line of the address, if any.
        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).
        sublocality:
          type: string
          description: A civil region within the address's `locality`, if any.
        sublocality_2:
          type: string
          description: A civil region within the address's `sublocality`, if any.
        sublocality_3:
          type: string
          description: A civil region within the address's `sublocality_2`, if any.
        administrative_district_level_1:
          type: string
          description: |-
            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: string
          description: |-
            A civil entity within the address's `administrative_district_level_1`.
            In the US, this is the county.
        administrative_district_level_3:
          type: string
          description: |-
            A civil entity within the address's `administrative_district_level_2`,
            if any.
        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).
        country:
          $ref: '#/components/schemas/Country'
        first_name:
          type: string
          description: Optional first name when it's representing recipient.
        last_name:
          type: string
          description: Optional last name when it's representing recipient.
      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-property-order:
      - address_line_1
      - address_line_2
      - address_line_3
      - locality
      - sublocality
      - sublocality_2
      - sublocality_3
      - administrative_district_level_1
      - administrative_district_level_2
      - administrative_district_level_3
      - postal_code
      - country
      - first_name
      - last_name
      - organization
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/address.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: Address
    BusinessHours:
      type: object
      properties:
        periods:
          type: array
          description: The list of time periods during which the business is open.
            There can be at most 10 periods per day.
          items:
            $ref: '#/components/schemas/BusinessHoursPeriod'
      description: The hours of operation for a location.
      x-property-order:
      - periods
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/location.proto
      x-proto-sha: 8239a09bf9fffc9b344c259c62b98d688ef2d107
      x-object-name: BusinessHours
    BusinessHoursPeriod:
      type: object
      properties:
        day_of_week:
          $ref: '#/components/schemas/DayOfWeek'
        start_local_time:
          type: string
          description: |-
            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: string
          description: |-
            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.
      description: Represents a period of time during which a business location is
        open.
      x-property-order:
      - day_of_week
      - start_local_time
      - end_local_time
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/location.proto
      x-proto-sha: 8239a09bf9fffc9b344c259c62b98d688ef2d107
      x-object-name: BusinessHoursPeriod
    Card:
      type: object
      properties:
        id:
          maxLength: 64
          type: string
          description: Unique ID for this card. Generated by Square.
          readOnly: true
        card_brand:
          $ref: '#/components/schemas/CardBrand'
        last_4:
          maxLength: 4
          type: string
          description: The last 4 digits of the card number.
          readOnly: true
        exp_month:
          type: integer
          description: The expiration month of the associated card as an integer between
            1 and 12.
          format: int64
        exp_year:
          type: integer
          description: The four-digit year of the card's expiration date.
          format: int64
        cardholder_name:
          maxLength: 96
          type: string
          description: The name of the cardholder.
        billing_address:
          $ref: '#/components/schemas/Address'
        fingerprint:
          maxLength: 255
          type: string
          description: |-
            Intended as a Square-assigned identifier, based
            on the card number, to identify the card across multiple locations within a
            single application.
          readOnly: true
        customer_id:
          type: string
          description: '**Required** The ID of a customer created using the Customers
            API to be associated with the card.'
        merchant_id:
          type: string
          description: The ID of the merchant associated with the card.
          readOnly: true
        reference_id:
          maxLength: 128
          type: string
          description: |-
            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:
          type: boolean
          description: Indicates whether or not a card can be used for payments.
          readOnly: true
        card_type:
          $ref: '#/components/schemas/CardType'
        prepaid_type:
          $ref: '#/components/schemas/CardPrepaidType'
        bin:
          maxLength: 6
          type: string
          description: |-
            The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API
            returns this field.
          readOnly: true
        version:
          type: integer
          description: |-
            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.
          format: int64
        card_co_brand:
          $ref: '#/components/schemas/CardCoBrand'
      description: |-
        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.
      x-property-order:
      - id
      - card_brand
      - last_4
      - exp_month
      - exp_year
      - cardholder_name
      - billing_address
      - fingerprint
      - customer_id
      - buyer_id
      - merchant_id
      - reference_id
      - enabled
      - card_type
      - prepaid_type
      - bin
      - created_at
      - disabled_at
      - version
      - product_history
      - fidelius_token
      - payment_account_reference
      - pan_sequence_number
      - verification_payment_id
      - terminal_action_id
      - card_co_brand
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/card.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: Card
    Customer:
      type: object
      properties:
        id:
          type: string
          description: "A unique Square-assigned ID for the customer profile.\n\n\
            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)\
            \ \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
        cards:
          type: array
          description: "Payment details of the credit, debit, and gift cards stored\
            \ on file for the customer profile. \n\nDEPRECATED at version 2021-06-16.\
            \ Replaced by calling [ListCards](api-endpoint:Cards-ListCards) (for credit\
            \ and debit cards on file) \nor [ListGiftCards](api-endpoint:GiftCards-ListGiftCards)\
            \ (for gift cards on file) and including the `customer_id` query parameter.\
            \ \nFor more information, see [Migration notes](https://developer.squareup.com/docs/customers-api/what-it-does#migrate-customer-cards)."
          items:
            $ref: '#/components/schemas/Card'
          x-release-status: DEPRECATED
        given_name:
          type: string
          description: The given name (that is, the first name) associated with the
            customer profile.
        family_name:
          type: string
          description: The family name (that is, the last name) associated with the
            customer profile.
        nickname:
          type: string
          description: A nickname for the customer profile.
        company_name:
          type: string
          description: A business name associated with the customer profile.
        email_address:
          type: string
          description: The email address associated with the customer profile.
        address:
          $ref: '#/components/schemas/Address'
        phone_number:
          type: string
          description: The phone number associated with the customer profile. A phone
            number can contain 9–16 digits, with an optional `+` prefix.
        birthday:
          type: string
          description: |-
            The birthday associated with the customer profile, in RFC 3339 format. The year is optional. The timezone and time are not allowed.
            For example, `0000-09-21T00:00:00-00:00` represents a birthday on September 21 and `1998-09-21T00:00:00-00:00` represents a birthday on September 21, 1998.
        reference_id:
          type: string
          description: |-
            An optional second ID used to associate the customer profile with an
            entity in another system.
        note:
          type: string
          description: A custom note associated with the customer profile.
        preferences:
          $ref: '#/components/schemas/CustomerPreferences'
        groups:
          type: array
          description: The customer groups and segments the customer belongs to. This
            deprecated field has been replaced with  the dedicated `group_ids` for
            customer groups and the dedicated `segment_ids` field for customer segments.
            You can retrieve information about a given customer group and segment
            respectively using the Customer Groups API and Customer Segments API.
          items:
            $ref: '#/components/schemas/CustomerGroupInfo'
          x-release-status: RETIRED
        creation_source:
          $ref: '#/components/schemas/CustomerCreationSource'
        group_ids:
          type: array
          description: The IDs of customer groups the customer belongs to.
          items:
            type: string
        segment_ids:
          type: array
          description: The IDs of segments the customer belongs to.
          items:
            type: string
        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
            and cards on file.
          format: int64
        tax_ids:
          $ref: '#/components/schemas/CustomerTaxIds'
      description: Represents a Square customer profile in the Customer Directory
        of a Square seller.
      x-property-order:
      - id
      - created_at
      - updated_at
      - cards
      - given_name
      - family_name
      - nickname
      - company_name
      - email_address
      - address
      - phone_number
      - birthday
      - reference_id
      - note
      - preferences
      - groups
      - creation_source
      - group_ids
      - segment_ids
      - version
      - tax_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: Customer
    CustomerGroupInfo:
      required:
      - id
      - name
      type: object
      properties:
        id:
          type: string
          description: The ID of the Customer Group.
        name:
          type: string
          description: The name of the Customer Group.
      description: Contains some brief information about a Customer Group with its
        identifier included.
      x-property-order:
      - id
      - name
      x-release-status: RETIRED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CustomerGroupInfo
    CustomerPreferences:
      type: object
      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.
      description: Represents communication preferences for the customer profile.
      x-property-order:
      - email_unsubscribed
      - marketing_subscription_status
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CustomerPreferences
    CustomerTaxIds:
      type: object
      properties:
        eu_vat:
          maxLength: 20
          type: string
          description: The EU VAT identification number for the customer. For example,
            `IE3426675K`. The ID can contain alphanumeric characters only.
      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-property-order:
      - eu_vat
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CustomerTaxIds
    CustomerAddressFilter:
      type: object
      properties:
        postal_code:
          $ref: '#/components/schemas/CustomerTextFilter'
        country:
          $ref: '#/components/schemas/Country'
      description: |-
        The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](entity:CustomerCustomAttributeFilterValue) filter when
        searching by an `Address`-type custom attribute.
      x-property-order:
      - postal_code
      - country
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CustomerAddressFilter
    CustomerCreationSourceFilter:
      type: object
      properties:
        values:
          type: array
          description: |-
            The list of creation sources used as filtering criteria.
            See [CustomerCreationSource](#type-customercreationsource) for possible values
          items:
            $ref: '#/components/schemas/CustomerCreationSource'
        rule:
          $ref: '#/components/schemas/CustomerInclusionExclusion'
      description: |-
        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.
      x-property-order:
      - values
      - rule
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CustomerCreationSourceFilter
    CustomerCustomAttributeFilter:
      required:
      - key
      type: object
      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
            (and the corresponding custom attribute definition) and can be retrieved using the [Customer Custom Attributes API](api:CustomerCustomAttributes).
        filter:
          $ref: '#/components/schemas/CustomerCustomAttributeFilterValue'
        updated_at:
          $ref: '#/components/schemas/TimeRange'
      description: |-
        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).
      x-property-order:
      - key
      - filter
      - updated_at
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CustomerCustomAttributeFilter
    CustomerCustomAttributeFilterValue:
      type: object
      properties:
        email:
          $ref: '#/components/schemas/CustomerTextFilter'
        phone:
          $ref: '#/components/schemas/CustomerTextFilter'
        text:
          $ref: '#/components/schemas/CustomerTextFilter'
        selection:
          $ref: '#/components/schemas/FilterValue'
        date:
          $ref: '#/components/schemas/TimeRange'
        number:
          $ref: '#/components/schemas/FloatNumberRange'
        boolean:
          type: boolean
          description: A filter for a query based on the value of a `Boolean`-type
            custom attribute.
        address:
          $ref: '#/components/schemas/CustomerAddressFilter'
      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-property-order:
      - email
      - phone
      - text
      - selection
      - date
      - number
      - boolean
      - address
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CustomerCustomAttributeFilterValue
    CustomerCustomAttributeFilters:
      type: object
      properties:
        filters:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/CustomerCustomAttributeFilter'
      description: |-
        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).
      x-property-order:
      - filters
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CustomerCustomAttributeFilters
    CustomerFilter:
      type: object
      properties:
        creation_source:
          $ref: '#/components/schemas/CustomerCreationSourceFilter'
        created_at:
          $ref: '#/components/schemas/TimeRange'
        updated_at:
          $ref: '#/components/schemas/TimeRange'
        email_address:
          $ref: '#/components/schemas/CustomerTextFilter'
        phone_number:
          $ref: '#/components/schemas/CustomerTextFilter'
        reference_id:
          $ref: '#/components/schemas/CustomerTextFilter'
        group_ids:
          $ref: '#/components/schemas/FilterValue'
        custom_attribute:
          $ref: '#/components/schemas/CustomerCustomAttributeFilters'
      description: |-
        Represents a set of `CustomerQuery` filters used to limit the set of
        customers returned by the [SearchCustomers](api-endpoint:Customers-SearchCustomers) endpoint.
      x-property-order:
      - creation_source
      - created_at
      - updated_at
      - email_address
      - phone_number
      - reference_id
      - group_ids
      - search_query
      - custom_attribute
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CustomerFilter
    CustomerGroup:
      required:
      - name
      type: object
      properties:
        id:
          maxLength: 255
          type: string
          description: A unique Square-generated ID for the customer group.
          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
      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-property-order:
      - id
      - name
      - created_at
      - updated_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer_group.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CustomerGroup
    CustomerQuery:
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/CustomerFilter'
        sort:
          $ref: '#/components/schemas/CustomerSort'
      description: |-
        Represents a query (including filtering criteria, sorting criteria, or both) used to search
        for customer profiles.
      x-property-order:
      - filter
      - sort
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CustomerQuery
    CustomerSegment:
      required:
      - name
      type: object
      properties:
        id:
          maxLength: 255
          type: string
          description: A unique Square-generated ID for the segment.
          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
      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-property-order:
      - id
      - name
      - created_at
      - updated_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer_segment.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CustomerSegment
    CustomerSort:
      type: object
      properties:
        field:
          $ref: '#/components/schemas/CustomerSortField'
        order:
          $ref: '#/components/schemas/SortOrder'
      description: Specifies how searched customers profiles are sorted, including
        the sort key and sort order.
      x-property-order:
      - field
      - order
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CustomerSort
    CustomerTextFilter:
      type: object
      properties:
        exact:
          type: string
          description: Use the exact filter to select customers whose attributes match
            exactly the specified query.
        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."
      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-property-order:
      - exact
      - fuzzy
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/customer.proto
      x-proto-sha: 0cf8852bd7fa472f8be157b14b97d9fa1d1e8762
      x-object-name: CustomerTextFilter
    Error:
      required:
      - category
      - code
      type: object
      properties:
        category:
          $ref: '#/components/schemas/ErrorCategory'
        code:
          $ref: '#/components/schemas/ErrorCode'
        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
            the error pertains to.
      description: |-
        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.
      example:
        code: INTERNAL_SERVER_ERROR
        field: field
        detail: detail
        category: API_ERROR
      x-property-order:
      - category
      - code
      - detail
      - field
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/error.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: Error
    Location:
      type: object
      properties:
        id:
          maxLength: 32
          type: string
          description: A short generated string of letters and numbers that uniquely
            identifies this location instance.
          readOnly: true
        name:
          maxLength: 255
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Address'
        timezone:
          maxLength: 30
          type: string
          description: |-
            The [IANA time zone](https://www.iana.org/time-zones) identifier for
            the time zone of the location. For example, `America/Los_Angeles`.
        capabilities:
          type: array
          description: |-
            The Square features that are enabled for the location.
            See [LocationCapability](entity:LocationCapability) for possible values.
            See [LocationCapability](#type-locationcapability) for possible values
          readOnly: true
          items:
            $ref: '#/components/schemas/LocationCapability'
        status:
          $ref: '#/components/schemas/LocationStatus'
        created_at:
          maxLength: 25
          minLength: 20
          type: string
          description: |-
            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).
          readOnly: true
        merchant_id:
          maxLength: 32
          type: string
          description: The ID of the merchant that owns the location.
          readOnly: true
        country:
          $ref: '#/components/schemas/Country'
        language_code:
          maxLength: 5
          minLength: 2
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Currency'
        phone_number:
          maxLength: 17
          type: string
          description: The phone number of the location. For example, `+1 855-700-6000`.
        business_name:
          maxLength: 255
          type: string
          description: The name of the location's overall business. This name is present
            on receipts and other customer-facing branding.
        type:
          $ref: '#/components/schemas/LocationType'
        website_url:
          maxLength: 255
          type: string
          description: The website URL of the location.  For example, `https://squareup.com`.
        business_hours:
          $ref: '#/components/schemas/BusinessHours'
        business_email:
          maxLength: 255
          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.
        description:
          maxLength: 1024
          type: string
          description: The description of the location. For example, `Main Street
            location`.
        twitter_username:
          maxLength: 15
          minLength: 1
          type: string
          description: The Twitter username of the location without the '@' symbol.
            For example, `Square`.
        instagram_username:
          maxLength: 30
          minLength: 1
          type: string
          description: The Instagram username of the location without the '@' symbol.
            For example, `square`.
        facebook_url:
          maxLength: 255
          type: string
          description: The Facebook profile URL of the location. The URL should begin
            with 'facebook.com/'. For example, `https://www.facebook.com/square`.
        coordinates:
          $ref: '#/components/schemas/Coordinates'
        logo_url:
          maxLength: 255
          type: string
          description: |-
            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.
          readOnly: true
        pos_background_url:
          maxLength: 255
          type: string
          description: The URL of the Point of Sale background image for the location.
          readOnly: true
        mcc:
          maxLength: 4
          minLength: 4
          type: string
          description: |-
            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.
          x-release-status: BETA
        full_format_logo_url:
          type: string
          description: |-
            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.
          readOnly: true
        tax_ids:
          $ref: '#/components/schemas/TaxIds'
      description: Represents one of a business' [locations](https://developer.squareup.com/docs/locations-api).
      x-property-order:
      - id
      - name
      - address
      - timezone
      - capabilities
      - status
      - created_at
      - merchant_id
      - country
      - language_code
      - currency
      - phone_number
      - business_name
      - type
      - website_url
      - business_hours
      - special_hours
      - business_email
      - description
      - twitter_username
      - instagram_username
      - facebook_url
      - coordinates
      - logo_url
      - pos_background_url
      - mcc
      - full_format_logo_url
      - tax_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/location.proto
      x-proto-sha: 8239a09bf9fffc9b344c259c62b98d688ef2d107
      x-object-name: Location
    Refund:
      required:
      - amount_money
      - id
      - location_id
      - reason
      - status
      - tender_id
      type: object
      properties:
        id:
          maxLength: 255
          type: string
          description: The refund's unique ID.
        location_id:
          maxLength: 50
          type: string
          description: The ID of the refund's associated location.
        transaction_id:
          maxLength: 192
          type: string
          description: The ID of the transaction that the refunded tender is part
            of.
        tender_id:
          maxLength: 192
          type: string
          description: The ID of the refunded tender.
        created_at:
          maxLength: 32
          type: string
          description: The timestamp for when the refund was created, in RFC 3339
            format.
          readOnly: true
        reason:
          maxLength: 192
          type: string
          description: The reason for the refund being issued.
        amount_money:
          $ref: '#/components/schemas/Money'
        status:
          $ref: '#/components/schemas/RefundStatus'
        processing_fee_money:
          $ref: '#/components/schemas/Money'
        additional_recipients:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/AdditionalRecipient'
          x-release-status: DEPRECATED
      description: Represents a refund processed for a Square transaction.
      x-property-order:
      - id
      - location_id
      - transaction_id
      - tender_id
      - created_at
      - reason
      - amount_money
      - status
      - processing_fee_money
      - additional_recipients
      - refund_type
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/refund.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: Refund
    TaxIds:
      type: object
      properties:
        eu_vat:
          type: string
          description: |-
            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:
          type: string
          description: |-
            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:
          type: string
          description: |-
            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:
          type: string
          description: |-
            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`.
      description: Identifiers for the location used by various governments for tax
        purposes.
      x-property-order:
      - eu_vat
      - fr_siret
      - fr_naf
      - es_nif
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/location.proto
      x-proto-sha: 8239a09bf9fffc9b344c259c62b98d688ef2d107
      x-object-name: TaxIds
    Tender:
      required:
      - type
      type: object
      properties:
        id:
          maxLength: 192
          type: string
          description: The tender's unique ID. It is the associated payment ID.
        location_id:
          maxLength: 50
          type: string
          description: The ID of the transaction's associated location.
        transaction_id:
          maxLength: 192
          type: string
          description: The ID of the tender's associated transaction.
        created_at:
          maxLength: 32
          type: string
          description: The timestamp for when the tender was created, in RFC 3339
            format.
          readOnly: true
        note:
          maxLength: 500
          type: string
          description: An optional note associated with the tender at the time of
            payment.
        amount_money:
          $ref: '#/components/schemas/Money'
        tip_money:
          $ref: '#/components/schemas/Money'
        processing_fee_money:
          $ref: '#/components/schemas/Money'
        customer_id:
          maxLength: 191
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/TenderType'
        card_details:
          $ref: '#/components/schemas/TenderCardDetails'
        cash_details:
          $ref: '#/components/schemas/TenderCashDetails'
        additional_recipients:
          type: array
          description: |-
            Additional recipients (other than the merchant) receiving a portion of this tender.
            For example, fees assessed on the purchase by a third party integration.
          items:
            $ref: '#/components/schemas/AdditionalRecipient'
          x-release-status: DEPRECATED
        payment_id:
          maxLength: 192
          type: string
          description: |-
            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.
      description: Represents a tender (i.e., a method of payment) used in a Square
        transaction.
      x-property-order:
      - id
      - uid
      - location_id
      - transaction_id
      - created_at
      - note
      - amount_money
      - tip_money
      - processing_fee_money
      - customer_id
      - type
      - card_details
      - cash_details
      - bank_account_details
      - wallet_details
      - buy_now_pay_later_details
      - square_account_details
      - additional_recipients
      - source
      - risk_evaluation
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/tender.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: Tender
    TenderCardDetails:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/TenderCardDetailsStatus'
        card:
          $ref: '#/components/schemas/Card'
        entry_method:
          $ref: '#/components/schemas/TenderCardDetailsEntryMethod'
      description: Represents additional details of a tender with `type` `CARD` or
        `SQUARE_GIFT_CARD`
      x-property-order:
      - status
      - card
      - entry_method
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/tender.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: TenderCardDetails
    TenderCashDetails:
      type: object
      properties:
        buyer_tendered_money:
          $ref: '#/components/schemas/Money'
        change_back_money:
          $ref: '#/components/schemas/Money'
      description: Represents the details of a tender with `type` `CASH`.
      x-property-order:
      - buyer_tendered_money
      - change_back_money
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/resources/tender.proto
      x-proto-sha: 0dc06ead30b08ce7dca3c13fb793c722ee6d5160
      x-object-name: TenderCashDetails
    Transaction:
      type: object
      properties:
        id:
          maxLength: 192
          type: string
          description: The transaction's unique ID, issued by Square payments servers.
        location_id:
          maxLength: 50
          type: string
          description: The ID of the transaction's associated location.
        created_at:
          maxLength: 32
          type: string
          description: The timestamp for when the transaction was created, in RFC
            3339 format.
        tenders:
          type: array
          description: The tenders used to pay in the transaction.
          items:
            $ref: '#/components/schemas/Tender'
        refunds:
          type: array
          description: Refunds that have been applied to any tender in the transaction.
          items:
            $ref: '#/components/schemas/Refund'
        reference_id:
          maxLength: 40
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/TransactionProduct'
        client_id:
          maxLength: 192
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Address'
        order_id:
          maxLength: 192
          type: string
          description: The order_id is an identifier for the order associated with
            this transaction, if any.
      description: |-
        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.
      deprecated: true
      x-property-order:
      - id
      - location_id
      - created_at
      - tenders
      - refunds
      - reference_id
      - product
      - client_id
      - order
      - shipping_address
      - order_id
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /xp/connect-public-protos/protos/squareup/connect/v2/transaction/resources/transaction.proto
      x-proto-sha: e56b63fb850df6da385a3ab6d96bce89faa0e6e4
      x-object-name: Transaction
    BankAccountCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the target location associated with the event.
        type:
          type: string
          description: The type of event this represents, `"bank_account.created"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/BankAccountCreatedWebhookData'
      description: |-
        Published when you link an external bank account to a Square
        account in the Seller Dashboard. Square sets the initial status to
        `VERIFICATION_IN_PROGRESS` and publishes the event.
      example:
        merchant_id: 6SSW7HV8K2ST5
        location_id: S8GWD5DBJ3HF3
        type: bank_account.created
        event_id: d214f854-adb1-4f56-b078-4b8697a3187a
        created_at: 2020-02-15T04:38:13Z
        data:
          type: bank_account
          id: bact:cgvL1yv43VFjexample
          object:
            bank_account:
              id: bact:cgvL1yv43VFjexample
              account_number_suffix: "526"
              country: US
              currency: USD
              account_type: CHECKING
              holder_name: John Doe
              primary_bank_identification_number: "101211111"
              location_id: S8GWD5DBJ3HF3
              status: VERIFICATION_IN_PROGRESS
              creditable: true
              debitable: true
              version: 1
              bank_name: Bank Name
      x-property-order:
      - merchant_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/bank-accounts/bank-account-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: BankAccountCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: bank_account.created
        scopes:
        - BANK_ACCOUNTS_READ
      x-api: '#/components/x-apis/BankAccounts'
      x-since: 2020-02-26
      x-contains-pii: true
    BankAccountCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"bank_account"`.
        id:
          type: string
          description: ID of the affected bank account.
        object:
          $ref: '#/components/schemas/BankAccountCreatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/bank-accounts/bank-account-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: BankAccountCreatedWebhookData
      x-visibility: DOC_ONLY
    BankAccountCreatedWebhookObject:
      type: object
      properties:
        bank_account:
          $ref: '#/components/schemas/BankAccount'
      x-property-order:
      - bank_account
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/bank-accounts/bank-account-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: BankAccountCreatedWebhookObject
      x-visibility: DOC_ONLY
    BankAccountDisabledWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the target location associated with the event.
        type:
          type: string
          description: The type of event this represents, `"bank_account.disabled"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was disabled, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/BankAccountDisabledWebhookData'
      description: |-
        Published when Square sets the status of a
        [BankAccount](entity:BankAccount) to `DISABLED`.
      example:
        merchant_id: 6SSW7HV8K2ST5
        location_id: S8GWD5DBJ3HF3
        type: bank_account.disabled
        event_id: 43e8b5c7-706f-49bf-8e2a-90fbe96af93e
        created_at: 2020-02-15T04:38:13Z
        data:
          type: bank_account
          id: bact:cgvL1yv43VFjexample
          object:
            bank_account:
              id: bact:cgvL1yv43VFjexample
              account_number_suffix: "526"
              country: US
              currency: USD
              account_type: CHECKING
              holder_name: John Doe
              primary_bank_identification_number: "101211111"
              location_id: S8GWD5DBJ3HF3
              status: DISABLED
              creditable: true
              debitable: true
              version: 5
              bank_name: Bank Name
      x-property-order:
      - merchant_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/bank-accounts/bank-account-disabled-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: BankAccountDisabledWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: bank_account.disabled
        scopes:
        - BANK_ACCOUNTS_READ
      x-api: '#/components/x-apis/BankAccounts'
      x-since: 2020-02-26
      x-contains-pii: true
    BankAccountDisabledWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"bank_account"`.
        id:
          type: string
          description: ID of the affected bank account.
        object:
          $ref: '#/components/schemas/BankAccountDisabledWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/bank-accounts/bank-account-disabled-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: BankAccountDisabledWebhookData
      x-visibility: DOC_ONLY
    BankAccountDisabledWebhookObject:
      type: object
      properties:
        bank_account:
          $ref: '#/components/schemas/BankAccount'
      x-property-order:
      - bank_account
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/bank-accounts/bank-account-disabled-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: BankAccountDisabledWebhookObject
      x-visibility: DOC_ONLY
    BankAccountVerifiedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the target location associated with the event.
        type:
          type: string
          description: The type of event this represents, `"bank_account.verified"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was verified, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/BankAccountVerifiedWebhookData'
      description: |-
        Published when Square sets the status of a
        [BankAccount](entity:BankAccount) to `VERIFIED`.
      example:
        merchant_id: 6SSW7HV8K2ST5
        location_id: S8GWD5DBJ3HF3
        type: bank_account.verified
        event_id: 4166853c-0e4c-4202-8fd8-7e65a8f42389
        created_at: 2020-02-15T04:38:13Z
        data:
          type: bank_account
          id: bact:cgvL1yv43VFjexample
          object:
            bank_account:
              id: bact:cgvL1yv43VFjexample
              account_number_suffix: "526"
              country: US
              currency: USD
              account_type: CHECKING
              holder_name: John Doe
              primary_bank_identification_number: "101211111"
              location_id: S8GWD5DBJ3HF3
              status: VERIFIED
              creditable: true
              debitable: true
              version: 4
              bank_name: Bank Name
      x-property-order:
      - merchant_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/bank-accounts/bank-account-verified-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: BankAccountVerifiedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: bank_account.verified
        scopes:
        - BANK_ACCOUNTS_READ
      x-api: '#/components/x-apis/BankAccounts'
      x-since: 2020-02-26
      x-contains-pii: true
    BankAccountVerifiedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"bank_account"`.
        id:
          type: string
          description: ID of the affected bank account.
        object:
          $ref: '#/components/schemas/BankAccountVerifiedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/bank-accounts/bank-account-verified-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: BankAccountVerifiedWebhookData
      x-visibility: DOC_ONLY
    BankAccountVerifiedWebhookObject:
      type: object
      properties:
        bank_account:
          $ref: '#/components/schemas/BankAccount'
      x-property-order:
      - bank_account
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/bank-accounts/bank-account-verified-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: BankAccountVerifiedWebhookObject
      x-visibility: DOC_ONLY
    BookingCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target seller associated with the event.
        type:
          type: string
          description: The type of this event. The value is `"booking.created"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: The timestamp of when the webhook event was created, in RFC
            3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/BookingCreatedWebhookData'
      description: "Published when a booking is created.\n\nTo receive this event\
        \ with buyer-level permissions, you must have `APPOINTMENTS_READ` set for\
        \ the OAuth scope.  \nTo receive this event with seller-level permissions,\
        \ you must have `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` set for the\
        \ OAuth scope."
      example:
        merchant_id: GQQWA3J6A3AEZ
        location_id: L9R0X9X5SGDBJ
        type: booking.created
        event_id: 76193e8a-db85-53c6-b538-1837519cbc12
        created_at: 2020-12-08T19:56:53Z
        data:
          type: booking
          id: i2id2g3enyspi7:0
          object:
            booking:
              id: i2id2g3enyspi7
              status: ACCEPTED
              customer_note: ""
              seller_note: ""
              start_at: 2020-12-17T16:00:00Z
              created_at: 2020-12-08T19:56:53Z
              updated_at: 2020-12-08T19:56:53Z
              version: 0
              appointment_segments:
              - service_variation_id: T3WUWYFJOVW2EU6XGRU5YG4A
                duration_minutes: 30
                service_variation_version: 1605808735978
                team_member_id: _4GsfYnqGHyurOwzWdKj
              customer_id: SSKBT02ECWZXK6W3VWYC78E52R
              location_id: L9R0X9X5SGDBJ
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/bookings/booking-created-webhook.proto
      x-proto-sha: 572f62b2b04f385818f8d6f3affa760c9eef1e58
      x-object-name: BookingCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: booking.created
        scopes:
        - APPOINTMENTS_READ
      x-api: '#/components/x-apis/Bookings'
      x-since: 2020-12-16
      x-contains-pii: true
    BookingCreatedWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: The type of the event data object. The value is `"booking"`.
        id:
          maxLength: 192
          type: string
          description: The ID of the event data object.
        object:
          $ref: '#/components/schemas/BookingCreatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/bookings/booking-created-webhook.proto
      x-proto-sha: 572f62b2b04f385818f8d6f3affa760c9eef1e58
      x-object-name: BookingCreatedWebhookData
      x-visibility: DOC_ONLY
    BookingCreatedWebhookObject:
      type: object
      properties:
        booking:
          $ref: '#/components/schemas/Booking'
      x-property-order:
      - booking
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/bookings/booking-created-webhook.proto
      x-proto-sha: 572f62b2b04f385818f8d6f3affa760c9eef1e58
      x-object-name: BookingCreatedWebhookObject
      x-visibility: DOC_ONLY
    BookingUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target seller associated with the event.
        type:
          type: string
          description: The type of this event. The value is `"booking.updated"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: The timestamp of when the webhook event was created, in RFC
            3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/BookingUpdatedWebhookData'
      description: "Published when a booking is updated or cancelled.\n\nTo receive\
        \ this event with buyer-level permissions, you must have `APPOINTMENTS_READ`\
        \ set for the OAuth scope.  \nTo receive this event with seller-level permissions,\
        \ you must have `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` set for the\
        \ OAuth scope."
      example:
        merchant_id: GQQWA3J6A3AEZ
        location_id: L9R0X9X5SGDBJ
        type: booking.updated
        event_id: d954ea4e-a393-52d4-bda6-bfd10cbd571f
        created_at: 2020-12-08T20:05:00Z
        data:
          type: booking
          id: i2id2g3enyspi7:1
          object:
            booking:
              id: i2id2g3enyspi7
              status: ACCEPTED
              customer_note: I would like to sit near the window please
              seller_note: ""
              start_at: 2020-12-17T16:00:00Z
              created_at: 2020-12-08T19:56:53Z
              updated_at: 2020-12-08T20:05:00Z
              version: 1
              appointment_segments:
              - service_variation_id: T3WUWYFJOVW2EU6XGRU5YG4A
                duration_minutes: 30
                service_variation_version: 1605808735978
                team_member_id: _4GsfYnqGHyurOwzWdKj
              customer_id: SSKBT02ECWZXK6W3VWYC78E52R
              location_id: L9R0X9X5SGDBJ
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/bookings/booking-updated-webhook.proto
      x-proto-sha: 572f62b2b04f385818f8d6f3affa760c9eef1e58
      x-object-name: BookingUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: booking.updated
        scopes:
        - APPOINTMENTS_READ
      x-api: '#/components/x-apis/Bookings'
      x-since: 2020-12-16
      x-contains-pii: true
    BookingUpdatedWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: The type of the event data object. The value is `"booking"`.
        id:
          maxLength: 192
          type: string
          description: The ID of the event data object.
        object:
          $ref: '#/components/schemas/BookingUpdatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/bookings/booking-updated-webhook.proto
      x-proto-sha: 572f62b2b04f385818f8d6f3affa760c9eef1e58
      x-object-name: BookingUpdatedWebhookData
      x-visibility: DOC_ONLY
    BookingUpdatedWebhookObject:
      type: object
      properties:
        booking:
          $ref: '#/components/schemas/Booking'
      x-property-order:
      - booking
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/bookings/booking-updated-webhook.proto
      x-proto-sha: 572f62b2b04f385818f8d6f3affa760c9eef1e58
      x-object-name: BookingUpdatedWebhookObject
      x-visibility: DOC_ONLY
    CardAutomaticallyUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target seller associated with the event.
        type:
          type: string
          description: The type of this event. The value is `"card.automatically_updated"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: The timestamp of when the webhook event was created, in RFC
            3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CardAutomaticallyUpdatedWebhookData'
      description: Published when a Card's expiration information or pan is automatically
        updated.
      example:
        merchant_id: 6SSW7HV8K2ST5
        type: card.automatically_updated
        event_id: d214f854-adb1-4f56-b078-4b8697a3187a
        created_at: 2020-02-15T04:38:13Z
        data:
          type: card
          id: ccof:uIbfJXhXETSP197M3GB
          object:
            card:
              id: ccof:uIbfJXhXETSP197M3GB
              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
              bin: "411111"
              card_brand: VISA
              card_type: CREDIT
              cardholder_name: Amelia Earhart
              customer_id: VDKXEEKPJN48QDG3BGGFAK05P8
              enabled: true
              exp_month: 11
              exp_year: 2022
              last_4: "1111"
              merchant_id: 6SSW7HV8K2ST5
              prepaid_type: NOT_PREPAID
              reference_id: user-id-2
              version: 2
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/cards/card-automatically-updated-webhook.proto
      x-proto-sha: 52aa79354be3e232deedcb9c3f1dee08327e4c24
      x-object-name: CardAutomaticallyUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: card.automatically_updated
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Cards'
      x-since: 2021-06-16
      x-contains-pii: true
    CardAutomaticallyUpdatedWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: The type of the event data object. The value is `"card"`.
        id:
          maxLength: 192
          type: string
          description: The ID of the event data object.
        object:
          $ref: '#/components/schemas/CardAutomaticallyUpdatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/cards/card-automatically-updated-webhook.proto
      x-proto-sha: 52aa79354be3e232deedcb9c3f1dee08327e4c24
      x-object-name: CardAutomaticallyUpdatedWebhookData
      x-visibility: DOC_ONLY
    CardAutomaticallyUpdatedWebhookObject:
      type: object
      properties:
        card:
          $ref: '#/components/schemas/Card'
      x-property-order:
      - card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/cards/card-automatically-updated-webhook.proto
      x-proto-sha: 52aa79354be3e232deedcb9c3f1dee08327e4c24
      x-object-name: CardAutomaticallyUpdatedWebhookObject
      x-visibility: DOC_ONLY
    CardCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target seller associated with the event.
        type:
          type: string
          description: The type of this event. The value is `"card.created"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: The timestamp of when the webhook event was created, in RFC
            3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CardCreatedWebhookData'
      description: Published when a Card is created or imported.
      example:
        merchant_id: 6SSW7HV8K2ST5
        type: card.created
        event_id: d214f854-adb1-4f56-b078-4b8697a3187a
        created_at: 2020-02-15T04:38:13Z
        data:
          type: card
          id: ccof:uIbfJXhXETSP197M3GB
          object:
            card:
              id: ccof:uIbfJXhXETSP197M3GB
              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
              bin: "411111"
              card_brand: VISA
              card_type: CREDIT
              cardholder_name: Amelia Earhart
              customer_id: VDKXEEKPJN48QDG3BGGFAK05P8
              enabled: true
              exp_month: 11
              exp_year: 2022
              last_4: "1111"
              merchant_id: 6SSW7HV8K2ST5
              prepaid_type: NOT_PREPAID
              reference_id: user-id-1
              version: 1
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/cards/card-created-webhook.proto
      x-proto-sha: 52aa79354be3e232deedcb9c3f1dee08327e4c24
      x-object-name: CardCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: card.created
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Cards'
      x-since: 2021-06-16
      x-contains-pii: true
    CardCreatedWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: The type of the event data object. The value is `"card"`.
        id:
          maxLength: 192
          type: string
          description: The ID of the event data object.
        object:
          $ref: '#/components/schemas/CardCreatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/cards/card-created-webhook.proto
      x-proto-sha: 52aa79354be3e232deedcb9c3f1dee08327e4c24
      x-object-name: CardCreatedWebhookData
      x-visibility: DOC_ONLY
    CardCreatedWebhookObject:
      type: object
      properties:
        card:
          $ref: '#/components/schemas/Card'
      x-property-order:
      - card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/cards/card-created-webhook.proto
      x-proto-sha: 52aa79354be3e232deedcb9c3f1dee08327e4c24
      x-object-name: CardCreatedWebhookObject
      x-visibility: DOC_ONLY
    CardDisabledWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target seller associated with the event.
        type:
          type: string
          description: The type of this event. The value is `"card.disabled"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: The timestamp of when the webhook event was created, in RFC
            3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CardDisabledWebhookData'
      description: Published when a Card is disabled.
      example:
        merchant_id: 6SSW7HV8K2ST5
        type: card.disabled
        event_id: d214f854-adb1-4f56-b078-4b8697a3187a
        created_at: 2020-02-15T04:38:13Z
        data:
          type: card
          id: ccof:uIbfJXhXETSP197M3GB
          object:
            card:
              id: ccof:uIbfJXhXETSP197M3GB
              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
              bin: "411111"
              card_brand: VISA
              card_type: CREDIT
              cardholder_name: Amelia Earhart
              customer_id: VDKXEEKPJN48QDG3BGGFAK05P8
              enabled: false
              exp_month: 11
              exp_year: 2022
              last_4: "1111"
              merchant_id: 6SSW7HV8K2ST5
              prepaid_type: NOT_PREPAID
              reference_id: user-id-1
              version: 2
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/cards/card-disabled-webhook.proto
      x-proto-sha: 52aa79354be3e232deedcb9c3f1dee08327e4c24
      x-object-name: CardDisabledWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: card.disabled
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Cards'
      x-since: 2021-06-16
      x-contains-pii: true
    CardDisabledWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: The type of the event data object. The value is `"card"`.
        id:
          maxLength: 192
          type: string
          description: The ID of the event data object.
        object:
          $ref: '#/components/schemas/CardDisabledWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/cards/card-disabled-webhook.proto
      x-proto-sha: 52aa79354be3e232deedcb9c3f1dee08327e4c24
      x-object-name: CardDisabledWebhookData
      x-visibility: DOC_ONLY
    CardDisabledWebhookObject:
      type: object
      properties:
        card:
          $ref: '#/components/schemas/Card'
      x-property-order:
      - card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/cards/card-disabled-webhook.proto
      x-proto-sha: 52aa79354be3e232deedcb9c3f1dee08327e4c24
      x-object-name: CardDisabledWebhookObject
      x-visibility: DOC_ONLY
    CardForgottenWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target seller associated with the event.
        type:
          type: string
          description: The type of this event. The value is `"card.forgotten"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: The timestamp of when the webhook event was created, in RFC
            3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CardForgottenWebhookData'
      description: Published when a Card is GDPR forgotten/vaulted.
      example:
        merchant_id: 6SSW7HV8K2ST5
        type: card.forgotten
        event_id: d214f854-adb1-4f56-b078-4b8697a3187a
        created_at: 2020-02-15T04:38:13Z
        data:
          type: card_forgotten
          id: ccof:uIbfJXhXETSP197M3GB
          object:
            card:
              id: ccof:uIbfJXhXETSP197M3GB
              customer_id: VDKXEEKPJN48QDG3BGGFAK05P8
              enabled: false
              merchant_id: 6SSW7HV8K2ST5
              reference_id: user-id-1
              version: 2
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/cards/card-forgotten-webhook.proto
      x-proto-sha: 52aa79354be3e232deedcb9c3f1dee08327e4c24
      x-object-name: CardForgottenWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: card.forgotten
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Cards'
      x-since: 2021-06-16
      x-contains-pii: true
    CardForgottenWebhookCard:
      type: object
      properties:
        id:
          maxLength: 64
          type: string
          description: Unique ID for this card. Generated by Square.
          readOnly: true
        customer_id:
          type: string
          description: The ID of a customer created using the Customers API associated
            with the card.
        enabled:
          type: boolean
          description: Indicates whether or not a card can be used for payments.
        reference_id:
          type: string
          description: |-
            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.
        version:
          type: integer
          description: |-
            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.
          format: int64
        merchant_id:
          type: string
          description: The ID of the merchant associated with the card.
      x-property-order:
      - id
      - customer_id
      - enabled
      - reference_id
      - version
      - merchant_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/cards/card-forgotten-webhook.proto
      x-proto-sha: 52aa79354be3e232deedcb9c3f1dee08327e4c24
      x-object-name: CardForgottenWebhookCard
      x-visibility: DOC_ONLY
    CardForgottenWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: The type of the event data object. The value is `"card"`.
        id:
          maxLength: 192
          type: string
          description: The ID of the event data object.
        object:
          $ref: '#/components/schemas/CardForgottenWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/cards/card-forgotten-webhook.proto
      x-proto-sha: 52aa79354be3e232deedcb9c3f1dee08327e4c24
      x-object-name: CardForgottenWebhookData
      x-visibility: DOC_ONLY
    CardForgottenWebhookObject:
      type: object
      properties:
        card:
          $ref: '#/components/schemas/CardForgottenWebhookCard'
      x-property-order:
      - card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/cards/card-forgotten-webhook.proto
      x-proto-sha: 52aa79354be3e232deedcb9c3f1dee08327e4c24
      x-object-name: CardForgottenWebhookObject
      x-visibility: DOC_ONLY
    CardUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target seller associated with the event.
        type:
          type: string
          description: The type of this event. The value is `"card.updated"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: The timestamp of when the webhook event was created, in RFC
            3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CardUpdatedWebhookData'
      description: Published when a Card is updated by the developer using the UpdateCard
        endpoint.
      example:
        merchant_id: 6SSW7HV8K2ST5
        type: card.updated
        event_id: d214f854-adb1-4f56-b078-4b8697a3187a
        created_at: 2020-02-15T04:38:13Z
        data:
          type: card
          id: ccof:uIbfJXhXETSP197M3GB
          object:
            card:
              id: ccof:uIbfJXhXETSP197M3GB
              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
              bin: "411111"
              card_brand: VISA
              card_type: CREDIT
              cardholder_name: Amelia Earhart
              customer_id: VDKXEEKPJN48QDG3BGGFAK05P8
              enabled: true
              exp_month: 11
              exp_year: 2022
              last_4: "1111"
              merchant_id: 6SSW7HV8K2ST5
              prepaid_type: NOT_PREPAID
              reference_id: user-id-2
              version: 2
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/cards/card-updated-webhook.proto
      x-proto-sha: 52aa79354be3e232deedcb9c3f1dee08327e4c24
      x-object-name: CardUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: card.updated
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Cards'
      x-since: 2021-06-16
      x-contains-pii: true
    CardUpdatedWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: The type of the event data object. The value is `"card"`.
        id:
          maxLength: 192
          type: string
          description: The ID of the event data object.
        object:
          $ref: '#/components/schemas/Card'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/cards/card-updated-webhook.proto
      x-proto-sha: 52aa79354be3e232deedcb9c3f1dee08327e4c24
      x-object-name: CardUpdatedWebhookData
      x-visibility: DOC_ONLY
    CardUpdatedWebhookObject:
      type: object
      properties:
        card:
          $ref: '#/components/schemas/Card'
      x-property-order:
      - card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/cards/card-updated-webhook.proto
      x-proto-sha: 52aa79354be3e232deedcb9c3f1dee08327e4c24
      x-object-name: CardUpdatedWebhookObject
      x-visibility: DOC_ONLY
    CatalogVersionUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CatalogVersionUpdatedWebhookData'
      description: Published when the catalog is updated.
      example:
        merchant_id: 6SSW7HV8K2ST5
        type: catalog.version.updated
        event_id: aeaaa5f6-c4fd-4e93-b688-71b50706266f
        created_at: 2019-10-29T17:26:16.808603647Z
        data:
          type: catalog
          id: 732b6677-1acb-4d81-b09c-5a3a49399d8f
          object:
            catalog_version:
              updated_at: 2019-10-29T17:26:16.53Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/catalog/catalog-version-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: CatalogVersionUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: catalog.version.updated
        scopes:
        - ITEMS_READ
      x-api: '#/components/x-apis/Catalog'
      x-since: 2019-09-25
      x-contains-pii: false
    CatalogVersionUpdatedWebhookCatalogVersion:
      type: object
      properties:
        updated_at:
          type: string
          description: Last modification timestamp in RFC 3339 format.
          readOnly: true
      x-property-order:
      - updated_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/catalog/catalog-version-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: CatalogVersionUpdatedWebhookCatalogVersion
      x-visibility: DOC_ONLY
    CatalogVersionUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type.
        id:
          type: string
          description: ID of the affected object.
        object:
          $ref: '#/components/schemas/CatalogVersionUpdatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/catalog/catalog-version-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: CatalogVersionUpdatedWebhookData
      x-visibility: DOC_ONLY
    CatalogVersionUpdatedWebhookObject:
      type: object
      properties:
        catalog_version:
          $ref: '#/components/schemas/CatalogVersionUpdatedWebhookCatalogVersion'
      x-property-order:
      - catalog_version
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/catalog/catalog-version-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: CatalogVersionUpdatedWebhookObject
      x-visibility: DOC_ONLY
    CustomAttributeDefinitionWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: The type of the event data object. The value is `"custom_attribute_definition"`.
        id:
          maxLength: 192
          type: string
          description: The ID of the event data object.
        object:
          $ref: '#/components/schemas/CustomAttributeDefinitionWebhookDataObject'
      description: "Represents an object in the CustomAttributeDefintion event notification\
        \ \npayload that contains the affected custom attribute definition."
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/ca-objects.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomAttributeDefinitionWebhookData
      x-visibility: DOC_ONLY
    CustomAttributeDefinitionWebhookDataObject:
      type: object
      properties:
        custom_attribute_definition:
          $ref: '#/components/schemas/CustomAttributeDefinition'
      x-property-order:
      - custom_attribute_definition
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/ca-objects.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomAttributeDefinitionWebhookDataObject
      x-visibility: DOC_ONLY
    CustomAttributeWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: The type of the event data object. The value is `"custom_attribute"`.
        id:
          maxLength: 192
          type: string
          description: The ID of the event data object.
        object:
          $ref: '#/components/schemas/CustomAttributeWebhookDataObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/ca-objects.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomAttributeWebhookData
      x-visibility: DOC_ONLY
    CustomAttributeWebhookDataObject:
      type: object
      properties:
        custom_attribute:
          $ref: '#/components/schemas/CustomAttribute'
      x-property-order:
      - custom_attribute
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/ca-objects.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomAttributeWebhookDataObject
      x-visibility: DOC_ONLY
    CustomerCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event.
        type:
          type: string
          description: The type of event. For this object, the value is `customer.created`.
        event_id:
          type: string
          description: The unique ID of the event, which is used for [idempotency
            support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices).
        created_at:
          type: string
          description: The timestamp of when the event was created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomerCreatedWebhookData'
      description: |-
        Published when a [customer](entity:Customer) is created. Subscribe to this event to track customer profiles affected by a merge operation.
        For more information, see [Use Customer Webhooks](https://developer.squareup.com/docs/customers-api/use-the-api/customer-webhooks).

        The `customer` object in the event notification does not include the following fields: `cards` (deprecated) and `segment_ids`.
      example:
        merchant_id: G7MMEBVW021Q4
        type: customer.created
        event_id: e12b5591-e0b6-4967-810a-307c7efcb1a7
        created_at: 2020-11-09T21:23:25Z
        data:
          type: customer
          id: QPTXM8PQNX3Q726ZYHPMNP46XC
          object:
            customer:
              address:
                address_line_1: 1018 40th Street
                administrative_district_level_1: CA
                locality: Oakland
                postal_code: "94608"
              birthday: 1962-03-04T00:00:00-00:00
              created_at: 2020-11-09T21:23:25.519Z
              creation_source: DIRECTORY
              email_address: jenkins+smorly@squareup.com
              family_name: Smorly
              given_name: Jenkins
              group_ids:
              - JGJCW9S0G68NE.APPOINTMENTS
              id: QPTXM8PQNX3Q726ZYHPMNP46XC
              phone_number: +12126668929
              preferences:
                email_unsubscribed: false
              updated_at: 2020-11-09T21:23:25Z
              version: 0
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/customers/customer-created-webhook.proto
      x-proto-sha: 96be9ab0a77d6d8531726368ee8653c772bcd7c7
      x-object-name: CustomerCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.created
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/Customers'
      x-since: 2021-02-26
      x-contains-pii: true
    CustomerCreatedWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: The type of object affected by the event. For this event, the
            value is `customer`.
        id:
          maxLength: 192
          type: string
          description: The ID of the new customer.
        object:
          $ref: '#/components/schemas/CustomerCreatedWebhookObject'
      description: The data associated with the webhook event.
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/customers/customer-created-webhook.proto
      x-proto-sha: 96be9ab0a77d6d8531726368ee8653c772bcd7c7
      x-object-name: CustomerCreatedWebhookData
      x-visibility: DOC_ONLY
    CustomerCreatedWebhookEventContext:
      type: object
      properties:
        merge:
          $ref: '#/components/schemas/CustomerCreatedWebhookEventContextMerge'
      description: Information about the change that triggered the event.
      x-property-order:
      - merge
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/customers/customer-created-webhook.proto
      x-proto-sha: 96be9ab0a77d6d8531726368ee8653c772bcd7c7
      x-object-name: CustomerCreatedWebhookEventContext
      x-visibility: DOC_ONLY
    CustomerCreatedWebhookEventContextMerge:
      type: object
      properties:
        from_customer_ids:
          type: array
          description: The IDs of the existing customers that were merged and then
            deleted.
          items:
            type: string
        to_customer_id:
          type: string
          description: The ID of the new customer created by the merge.
      description: Information about a merge operation, which creates a new customer
        using aggregated properties from two or more existing customers.
      x-property-order:
      - from_customer_ids
      - to_customer_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/customers/customer-created-webhook.proto
      x-proto-sha: 96be9ab0a77d6d8531726368ee8653c772bcd7c7
      x-object-name: CustomerCreatedWebhookEventContextMerge
      x-visibility: DOC_ONLY
    CustomerCreatedWebhookObject:
      type: object
      properties:
        customer:
          $ref: '#/components/schemas/Customer'
        event_context:
          $ref: '#/components/schemas/CustomerCreatedWebhookEventContext'
      description: An object that contains the customer associated with the webhook
        event.
      x-property-order:
      - customer
      - event_context
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/customers/customer-created-webhook.proto
      x-proto-sha: 96be9ab0a77d6d8531726368ee8653c772bcd7c7
      x-object-name: CustomerCreatedWebhookObject
      x-visibility: DOC_ONLY
    CustomerCustomAttributeDefinitionCreatedPublicWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute_definition.public.created"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeDefinitionWebhookData'
      description: "Published when a customer [custom attribute definition](entity:CustomAttributeDefinition)\n\
        that is visible to all applications is created. A notification is sent when\
        \ any application creates a custom\nattribute definition whose `visibility`\
        \ is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.\n\nThis event\
        \ is replaced by \n[customer.custom_attribute_definition.visible.created](webhook:customer.custom_attribute_definition.visible.created),\n\
        which applies to custom attribute definitions that are visible to the subscribing\
        \ application."
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute_definition.public.created
        event_id: f679dc4f-3619-4764-a4de-94a54735cd32
        created_at: 2022-04-21T21:40:49.943Z
        data:
          type: custom_attribute_definition
          id: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size
          object:
            created_at: 2022-04-21T21:40:49Z
            description: The customer's shirt size
            key: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size
            name: Shirt Size
            schema:
              type: array
              items:
                names:
                - Small
                - Medium
                - Large
                enum:
                - 9492bdda-ab4d-4eeb-8496-0986c8f78499
                - 6b96fba7-d8a5-ae72-48f4-8c3ee875633f
                - 4032c1a2-d749-4c75-9c30-be6472cd2e08
              maxItems: 1
              uniqueItems: true
            updated_at: 2022-04-21T21:40:49Z
            version: 1
            visibility: VISIBILITY_READ_WRITE_VALUES
      deprecated: true
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-definition-created-webhook-public.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeDefinitionCreatedPublicWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute_definition.public.created
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-05-12
      x-contains-pii: false
    CustomerCustomAttributeDefinitionCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute_definition.created"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeDefinitionWebhookData'
      description: "Published when a customer [custom attribute definition](entity:CustomAttributeDefinition)\
        \ \nis created by the subscribing application.\n\nThis event is replaced by\
        \ \n[customer.custom_attribute_definition.owned.created](webhook:customer.custom_attribute_definition.owned.created)."
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute_definition.created
        event_id: 347ab320-c0ba-48f5-959a-4e147b9aefcf
        created_at: 2022-04-21T21:40:49.943Z
        data:
          type: custom_attribute_definition
          id: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink
          object:
            created_at: 2022-04-21T21:40:49Z
            description: The customer's favorite drink
            key: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink
            name: Favorite Drink
            schema:
              $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String
            updated_at: 2022-04-21T21:40:49Z
            version: 1
            visibility: VISIBILITY_READ_WRITE_VALUES
      deprecated: true
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-definition-created-webhook.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeDefinitionCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute_definition.created
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-05-12
      x-contains-pii: false
    CustomerCustomAttributeDefinitionDeletedPublicWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute_definition.public.deleted"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeDefinitionWebhookData'
      description: "Published when a customer [custom attribute definition](entity:CustomAttributeDefinition)\n\
        that is visible to all applications is deleted. A notification is sent when\
        \ any application deletes a custom\nattribute definition whose `visibility`\
        \ is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.\n\nThis event\
        \ is replaced by \n[customer.custom_attribute_definition.visible.deleted](webhook:customer.custom_attribute_definition.visible.deleted),\n\
        which applies to custom attribute definitions that are visible to the subscribing\
        \ application."
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute_definition.public.deleted
        event_id: 81c10a07-c329-4943-af20-7d70a300c7e6
        created_at: 2022-04-26T01:22:29Z
        data:
          type: custom_attribute_definition
          id: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size
          deleted: true
          object:
            created_at: 2022-04-21T21:40:49Z
            description: The customer's t-shirt size
            key: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size
            name: T-Shirt Size
            schema:
              type: array
              items:
                names:
                - Small
                - Medium
                - Large
                - Extra Large
                - Extra Small
                enum:
                - 9492bdda-ab4d-4eeb-8496-0986c8f78499
                - 6b96fba7-d8a5-ae72-48f4-8c3ee875633f
                - 4032c1a2-d749-4c75-9c30-be6472cd2e08
                - 89ca2c01-e4e3-43d6-b846-1495c4e8f97b
                - 4f985a76-08fc-44b1-9ec4-b1904685c3a5
              maxItems: 1
              uniqueItems: true
            updated_at: 2022-04-27T11:31:29Z
            version: 3
            visibility: VISIBILITY_READ_WRITE_VALUES
      deprecated: true
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-definition-deleted-webhook-public.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeDefinitionDeletedPublicWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute_definition.public.deleted
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-05-12
      x-contains-pii: false
    CustomerCustomAttributeDefinitionDeletedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute_definition.deleted"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeDefinitionWebhookData'
      description: "Published when a customer [custom attribute definition](entity:CustomAttributeDefinition)\n\
        created by the subscribing application is deleted. A custom attribute definition\
        \ can only be deleted by\nthe application that created it.\n\nThis event is\
        \ replaced by \n[customer.custom_attribute_definition.owned.deleted](webhook:customer.custom_attribute_definition.owned.deleted)."
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute_definition.deleted
        event_id: 49363646-7ae7-49b5-aaa0-296610883c61
        created_at: 2022-04-26T01:22:29Z
        data:
          type: custom_attribute_definition
          id: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink
          deleted: true
          object:
            created_at: 2022-04-21T21:40:49Z
            description: The customer's favorite drink
            key: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink
            name: Favorite Drink
            schema:
              $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String
            updated_at: 2022-04-27T11:31:29Z
            version: 3
            visibility: VISIBILITY_READ_ONLY
      deprecated: true
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-definition-deleted-webhook.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeDefinitionDeletedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute_definition.deleted
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-05-12
      x-contains-pii: false
    CustomerCustomAttributeDefinitionOwnedCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute_definition.owned.created"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeDefinitionWebhookData'
      description: "Published when a customer [custom attribute definition](entity:CustomAttributeDefinition)\
        \ \nis created by the subscribing application."
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute_definition.owned.created
        event_id: 347ab320-c0ba-48f5-959a-4e147b9aefcf
        created_at: 2022-04-21T21:40:49.943Z
        data:
          type: custom_attribute_definition
          id: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink
          object:
            created_at: 2022-04-21T21:40:49Z
            description: The customer's favorite drink
            key: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink
            name: Favorite Drink
            schema:
              $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String
            updated_at: 2022-04-21T21:40:49Z
            version: 1
            visibility: VISIBILITY_READ_WRITE_VALUES
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-definition-created-webhook-owned.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeDefinitionOwnedCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute_definition.owned.created
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-08-17
      x-contains-pii: false
    CustomerCustomAttributeDefinitionOwnedDeletedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute_definition.owned.deleted"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeDefinitionWebhookData'
      description: |-
        Published when a customer [custom attribute definition](entity:CustomAttributeDefinition)
        created by the subscribing application is deleted. A custom attribute definition can only be deleted by
        the application that created it.
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute_definition.owned.deleted
        event_id: 49363646-7ae7-49b5-aaa0-296610883c61
        created_at: 2022-04-26T01:22:29Z
        data:
          type: custom_attribute_definition
          id: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink
          deleted: true
          object:
            created_at: 2022-04-21T21:40:49Z
            description: The customer's favorite drink
            key: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink
            name: Favorite Drink
            schema:
              $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String
            updated_at: 2022-04-27T11:31:29Z
            version: 3
            visibility: VISIBILITY_READ_ONLY
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-definition-deleted-webhook-owned.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeDefinitionOwnedDeletedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute_definition.owned.deleted
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-08-17
      x-contains-pii: false
    CustomerCustomAttributeDefinitionOwnedUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute_definition.owned.updated"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeDefinitionWebhookData'
      description: |-
        Published when a customer [custom attribute definition](entity:CustomAttributeDefinition)
        created by the subscribing application is updated. A custom attribute definition can only be updated by
        the application that created it.
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute_definition.owned.updated
        event_id: d914e6ef-9e37-4bca-a663-ecc55f5d98d3
        created_at: 2022-04-26T01:22:29Z
        data:
          type: custom_attribute_definition
          id: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink
          object:
            created_at: 2022-04-21T21:57:39Z
            description: The customer's favorite drink
            key: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink
            name: Favorite Drink
            schema:
              $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String
            updated_at: 2022-04-26T01:22:29Z
            version: 2
            visibility: VISIBILITY_READ_ONLY
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-definition-updated-webhook-owned.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeDefinitionOwnedUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute_definition.owned.updated
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-08-17
      x-contains-pii: false
    CustomerCustomAttributeDefinitionUpdatedPublicWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute_definition.public.updated"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeDefinitionWebhookData'
      description: "Published when a customer [custom attribute definition](entity:CustomAttributeDefinition)\n\
        that is visible to all applications is updated. A notification is sent when\
        \ any application updates a custom\nattribute definition whose `visibility`\
        \ is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.\n\nThis event\
        \ is replaced by \n[customer.custom_attribute_definition.visible.updated](webhook:customer.custom_attribute_definition.visible.updated),\n\
        which applies to custom attribute definitions that are visible to the subscribing\
        \ application."
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute_definition.public.updated
        event_id: ae376c21-d360-4694-96c7-1b27830f07d7
        created_at: 2022-04-26T01:22:29Z
        data:
          type: custom_attribute_definition
          id: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size
          object:
            created_at: 2022-04-21T21:57:39Z
            description: The customer's t-shirt size
            key: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size
            name: T-Shirt Size
            schema:
              type: array
              items:
                names:
                - Small
                - Medium
                - Large
                - Extra Large
                - Extra Small
                enum:
                - 9492bdda-ab4d-4eeb-8496-0986c8f78499
                - 6b96fba7-d8a5-ae72-48f4-8c3ee875633f
                - 4032c1a2-d749-4c75-9c30-be6472cd2e08
                - 89ca2c01-e4e3-43d6-b846-1495c4e8f97b
                - 4f985a76-08fc-44b1-9ec4-b1904685c3a5
              maxItems: 1
              uniqueItems: true
            updated_at: 2022-04-26T01:22:29Z
            version: 2
            visibility: VISIBILITY_READ_WRITE_VALUES
      deprecated: true
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-definition-updated-webhook-public.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeDefinitionUpdatedPublicWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute_definition.public.updated
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-05-12
      x-contains-pii: false
    CustomerCustomAttributeDefinitionUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute_definition.updated"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeDefinitionWebhookData'
      description: "Published when a customer [custom attribute definition](entity:CustomAttributeDefinition)\n\
        created by the subscribing application is updated. A custom attribute definition\
        \ can only be updated by\nthe application that created it.\n\nThis event is\
        \ replaced by \n[customer.custom_attribute_definition.owned.updated](webhook:customer.custom_attribute_definition.owned.updated)."
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute_definition.updated
        event_id: d914e6ef-9e37-4bca-a663-ecc55f5d98d3
        created_at: 2022-04-26T01:22:29Z
        data:
          type: custom_attribute_definition
          id: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink
          object:
            created_at: 2022-04-21T21:57:39Z
            description: The customer's favorite drink
            key: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink
            name: Favorite Drink
            schema:
              $ref: https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String
            updated_at: 2022-04-26T01:22:29Z
            version: 2
            visibility: VISIBILITY_READ_ONLY
      deprecated: true
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-definition-updated-webhook.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeDefinitionUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute_definition.updated
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-05-12
      x-contains-pii: false
    CustomerCustomAttributeDefinitionVisibleCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute_definition.visible.created"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeDefinitionWebhookData'
      description: |-
        Published when a customer [custom attribute definition](entity:CustomAttributeDefinition)
        that is visible to the subscribing application is created. A notification is sent when your application
        creates a custom attribute definition or another application creates a custom attribute definition whose
        `visibility` is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute_definition.visible.created
        event_id: f679dc4f-3619-4764-a4de-94a54735cd32
        created_at: 2022-04-21T21:40:49.943Z
        data:
          type: custom_attribute_definition
          id: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size
          object:
            created_at: 2022-04-21T21:40:49Z
            description: The customer's shirt size
            key: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size
            name: Shirt Size
            schema:
              type: array
              items:
                names:
                - Small
                - Medium
                - Large
                enum:
                - 9492bdda-ab4d-4eeb-8496-0986c8f78499
                - 6b96fba7-d8a5-ae72-48f4-8c3ee875633f
                - 4032c1a2-d749-4c75-9c30-be6472cd2e08
              maxItems: 1
              uniqueItems: true
            updated_at: 2022-04-21T21:40:49Z
            version: 1
            visibility: VISIBILITY_READ_WRITE_VALUES
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-definition-created-webhook-visible.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeDefinitionVisibleCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute_definition.visible.created
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-08-17
      x-contains-pii: false
    CustomerCustomAttributeDefinitionVisibleDeletedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute_definition.visible.deleted"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeDefinitionWebhookData'
      description: |-
        Published when a customer [custom attribute definition](entity:CustomAttributeDefinition)
        that is visible to the subscribing application is deleted. A custom attribute definition can only be deleted
        by the application that created it. A notification is sent when your application deletes a custom attribute
        definition or when another application deletes a custom attribute definition whose `visibility` is
        `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute_definition.visible.deleted
        event_id: 81c10a07-c329-4943-af20-7d70a300c7e6
        created_at: 2022-04-26T01:22:29Z
        data:
          type: custom_attribute_definition
          id: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size
          deleted: true
          object:
            created_at: 2022-04-21T21:40:49Z
            description: The customer's t-shirt size
            key: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size
            name: T-Shirt Size
            schema:
              type: array
              items:
                names:
                - Small
                - Medium
                - Large
                - Extra Large
                - Extra Small
                enum:
                - 9492bdda-ab4d-4eeb-8496-0986c8f78499
                - 6b96fba7-d8a5-ae72-48f4-8c3ee875633f
                - 4032c1a2-d749-4c75-9c30-be6472cd2e08
                - 89ca2c01-e4e3-43d6-b846-1495c4e8f97b
                - 4f985a76-08fc-44b1-9ec4-b1904685c3a5
              maxItems: 1
              uniqueItems: true
            updated_at: 2022-04-27T11:31:29Z
            version: 3
            visibility: VISIBILITY_READ_WRITE_VALUES
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-definition-deleted-webhook-visible.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeDefinitionVisibleDeletedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute_definition.visible.deleted
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-08-17
      x-contains-pii: false
    CustomerCustomAttributeDefinitionVisibleUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute_definition.visible.updated"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeDefinitionWebhookData'
      description: |-
        Published when a customer [custom attribute definition](entity:CustomAttributeDefinition)
        that is visible to the subscribing application is updated. A custom attribute definition can only be updated
        by the application that created it. A notification is sent when your application updates a custom
        attribute definition or when another application updates a custom attribute definition whose `visibility` is
        `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute_definition.visible.updated
        event_id: ae376c21-d360-4694-96c7-1b27830f07d7
        created_at: 2022-04-26T01:22:29Z
        data:
          type: custom_attribute_definition
          id: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size
          object:
            created_at: 2022-04-21T21:57:39Z
            description: The customer's t-shirt size
            key: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size
            name: T-Shirt Size
            schema:
              type: array
              items:
                names:
                - Small
                - Medium
                - Large
                - Extra Large
                - Extra Small
                enum:
                - 9492bdda-ab4d-4eeb-8496-0986c8f78499
                - 6b96fba7-d8a5-ae72-48f4-8c3ee875633f
                - 4032c1a2-d749-4c75-9c30-be6472cd2e08
                - 89ca2c01-e4e3-43d6-b846-1495c4e8f97b
                - 4f985a76-08fc-44b1-9ec4-b1904685c3a5
              maxItems: 1
              uniqueItems: true
            updated_at: 2022-04-26T01:22:29Z
            version: 2
            visibility: VISIBILITY_READ_WRITE_VALUES
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-definition-updated-webhook-visible.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeDefinitionVisibleUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute_definition.visible.updated
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-08-17
      x-contains-pii: false
    CustomerCustomAttributeDeletedPublicWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute.public.deleted"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeWebhookData'
      description: "Published when a customer [custom attribute](entity:CustomAttribute)\
        \ that is visible\nto all applications is deleted. A notification is sent\
        \ when any application deletes a custom attribute\nwhose `visibility` is `VISIBILITY_READ_ONLY`\
        \ or `VISIBILITY_READ_WRITE_VALUES`.\n\nThis event is replaced by \n[customer.custom_attribute.visible.deleted](webhook:customer.custom_attribute.visible.deleted),\n\
        which applies to custom attributes that are visible to the subscribing application."
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute.public.deleted
        event_id: 18ef5adc-2efc-4ad9-9b1a-b274a607da3e
        created_at: 2022-04-26T01:22:29Z
        data:
          type: custom_attribute
          id: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size:CUSTOMER:TNQC0TYTWMRSFFQ157KK4V7MVR
          deleted: true
          object:
            created_at: 2022-04-21T21:58:59Z
            key: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size
            updated_at: 2022-04-27T11:31:29Z
            value:
            - 4032c1a2-d749-4c75-9c30-be6472cd2e08
            version: 3
            visibility: VISIBILITY_READ_WRITE_VALUES
      deprecated: true
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-deleted-webhook-public.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeDeletedPublicWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute.public.deleted
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-05-12
      x-contains-pii: true
    CustomerCustomAttributeDeletedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute.deleted"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeWebhookData'
      description: "Published when a customer [custom attribute](entity:CustomAttribute)\
        \ owned by the\nsubscribing application is deleted. Custom attributes are\
        \ owned by the application that created the\ncorresponding [custom attribute\
        \ definition](entity:CustomAttributeDefinition). Custom attributes whose\n\
        `visibility` is `VISIBILITY_READ_WRITE_VALUES` can be deleted by any application.\n\
        \nThis event is replaced by \n[customer.custom_attribute.owned.deleted](webhook:customer.custom_attribute.owned.deleted)."
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute.deleted
        event_id: f57b27d4-a4d6-43de-9e58-bc6ff90525f1
        created_at: 2022-04-26T01:22:29Z
        data:
          type: custom_attribute
          id: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink:CUSTOMER:TNQC0TYTWMRSFFQ157KK4V7MVR
          deleted: true
          object:
            created_at: 2022-04-21T21:58:59Z
            key: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink
            updated_at: 2022-04-27T11:31:29Z
            value: Medium coffee, 2 sugars
            version: 3
            visibility: VISIBILITY_READ_ONLY
      deprecated: true
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-deleted-webhook.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeDeletedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute.deleted
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-05-12
      x-contains-pii: true
    CustomerCustomAttributeOwnedDeletedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute.owned.deleted"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeWebhookData'
      description: |-
        Published when a customer [custom attribute](entity:CustomAttribute) owned by the
        subscribing application is deleted. Custom attributes are owned by the application that created the
        corresponding [custom attribute definition](entity:CustomAttributeDefinition). Custom attributes whose
        `visibility` is `VISIBILITY_READ_WRITE_VALUES` can be deleted by any application.
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute.owned.deleted
        event_id: f57b27d4-a4d6-43de-9e58-bc6ff90525f1
        created_at: 2022-04-26T01:22:29Z
        data:
          type: custom_attribute
          id: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink:CUSTOMER:TNQC0TYTWMRSFFQ157KK4V7MVR
          deleted: true
          object:
            created_at: 2022-04-21T21:58:59Z
            key: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink
            updated_at: 2022-04-27T11:31:29Z
            value: Medium coffee, 2 sugars
            version: 3
            visibility: VISIBILITY_READ_ONLY
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-deleted-webhook-owned.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeOwnedDeletedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute.owned.deleted
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-08-17
      x-contains-pii: true
    CustomerCustomAttributeOwnedUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute.owned.updated"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeWebhookData'
      description: |-
        Published when a customer [custom attribute](entity:CustomAttribute) owned by the
        subscribing application is created or updated. Custom attributes are owned by the application that created
        the corresponding [custom attribute definition](entity:CustomAttributeDefinition). Custom attributes whose
        `visibility` is `VISIBILITY_READ_WRITE_VALUES` can be created or updated by any application.
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute.owned.updated
        event_id: e26ca6f2-97f8-426a-b4bf-873044617e94
        created_at: 2022-04-21T21:40:54Z
        data:
          type: custom_attribute
          id: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink:CUSTOMER:TNQC0TYTWMRSFFQ157KK4V7MVR
          object:
            created_at: 2022-04-21T21:40:54Z
            key: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink
            updated_at: 2022-04-21T21:40:54Z
            value: Double-shot breve
            version: 1
            visibility: VISIBILITY_READ_ONLY
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-updated-webhook-owned.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeOwnedUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute.owned.updated
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-08-17
      x-contains-pii: true
    CustomerCustomAttributeUpdatedPublicWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute.public.updated"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeWebhookData'
      description: "Published when a customer [custom attribute](entity:CustomAttribute)\
        \ that is visible\nto all applications is created or updated. A notification\
        \ is sent when any application creates or updates\na custom attribute whose\
        \ `visibility` is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.\n\
        \nThis event is replaced by \n[customer.custom_attribute.visible.updated](webhook:customer.custom_attribute.visible.updated),\n\
        which applies to custom attributes that are visible to the subscribing application."
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute.public.updated
        event_id: 1cc2925c-f6e2-4fb6-a597-07c198de59e1
        created_at: 2022-04-26T01:22:29Z
        data:
          type: custom_attribute
          id: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size:CUSTOMER:TNQC0TYTWMRSFFQ157KK4V7MVR
          object:
            created_at: 2022-04-21T21:40:54Z
            key: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size
            updated_at: 2022-04-26T01:22:29Z
            value:
            - 4032c1a2-d749-4c75-9c30-be6472cd2e08
            version: 2
            visibility: VISIBILITY_READ_WRITE_VALUES
      deprecated: true
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-updated-webhook-public.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeUpdatedPublicWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute.public.updated
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-05-12
      x-contains-pii: true
    CustomerCustomAttributeUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute.updated"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeWebhookData'
      description: "Published when a customer [custom attribute](entity:CustomAttribute)\
        \ owned by the\nsubscribing application is created or updated. Custom attributes\
        \ are owned by the application that created\nthe corresponding [custom attribute\
        \ definition](entity:CustomAttributeDefinition). Custom attributes whose\n\
        `visibility` is `VISIBILITY_READ_WRITE_VALUES` can be created or updated by\
        \ any application.\n\nThis event is replaced by \n[customer.custom_attribute.owned.updated](webhook:customer.custom_attribute.owned.updated)."
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute.updated
        event_id: e26ca6f2-97f8-426a-b4bf-873044617e94
        created_at: 2022-04-21T21:40:54Z
        data:
          type: custom_attribute
          id: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink:CUSTOMER:TNQC0TYTWMRSFFQ157KK4V7MVR
          object:
            created_at: 2022-04-21T21:40:54Z
            key: sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:favorite-drink
            updated_at: 2022-04-21T21:40:54Z
            value: Double-shot breve
            version: 1
            visibility: VISIBILITY_READ_ONLY
      deprecated: true
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-updated-webhook.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute.updated
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-05-12
      x-contains-pii: true
    CustomerCustomAttributeVisibleDeletedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute.visible.deleted"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeWebhookData'
      description: |-
        Published when a customer [custom attribute](entity:CustomAttribute) that is visible to the
        subscribing application is deleted. A notification is sent when:
        - Your application deletes a custom attribute owned by your application, regardless of the `visibility` setting.
        - Any application deletes a custom attribute whose `visibility` is `VISIBILITY_READ_ONLY`
        or `VISIBILITY_READ_WRITE_VALUES`.

        Custom attributes set to `VISIBILITY_READ_WRITE_VALUES` can be deleted by any application, but those set to
        `VISIBILITY_READ_ONLY` or `VISIBILITY_HIDDEN` can only be deleted by the owner. Custom attributes are owned
        by the application that created the corresponding [custom attribute definition](entity:CustomAttributeDefinition).
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute.visible.deleted
        event_id: 18ef5adc-2efc-4ad9-9b1a-b274a607da3e
        created_at: 2022-04-26T01:22:29Z
        data:
          type: custom_attribute
          id: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size:CUSTOMER:TNQC0TYTWMRSFFQ157KK4V7MVR
          deleted: true
          object:
            created_at: 2022-04-21T21:58:59Z
            key: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size
            updated_at: 2022-04-27T11:31:29Z
            value:
            - 4032c1a2-d749-4c75-9c30-be6472cd2e08
            version: 3
            visibility: VISIBILITY_READ_WRITE_VALUES
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-deleted-webhook-visible.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeVisibleDeletedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute.visible.deleted
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-08-17
      x-contains-pii: true
    CustomerCustomAttributeVisibleUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event that triggered
            the event notification.
        type:
          type: string
          description: The type of this event. The value is `"customer.custom_attribute.visible.updated"`.
        event_id:
          type: string
          description: A unique ID for the event notification.
        created_at:
          type: string
          description: The timestamp that indicates when the event notification was
            created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomAttributeWebhookData'
      description: |-
        Published when a customer [custom attribute](entity:CustomAttribute) that is visible to the
        subscribing application is created or updated. A notification is sent when:
        - Your application creates or updates a custom attribute owned by your application, regardless of the `visibility` setting.
        - Any application creates or updates a custom attribute whose `visibility` is `VISIBILITY_READ_ONLY`
        or `VISIBILITY_READ_WRITE_VALUES`.

        Custom attributes set to `VISIBILITY_READ_WRITE_VALUES` can be created or updated by any application, but those set to
        `VISIBILITY_READ_ONLY` or `VISIBILITY_HIDDEN` can only be created or updated by the owner. Custom attributes are owned
        by the application that created the corresponding [custom attribute definition](entity:CustomAttributeDefinition).
      example:
        merchant_id: DM7VKY8Q63GNP
        type: customer.custom_attribute.visible.updated
        event_id: 1cc2925c-f6e2-4fb6-a597-07c198de59e1
        created_at: 2022-04-26T01:22:29Z
        data:
          type: custom_attribute
          id: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size:CUSTOMER:TNQC0TYTWMRSFFQ157KK4V7MVR
          object:
            created_at: 2022-04-21T21:40:54Z
            key: sq0idp-BushoY39o1X-GPxRRUWc0A:shirt-size
            updated_at: 2022-04-26T01:22:29Z
            value:
            - 4032c1a2-d749-4c75-9c30-be6472cd2e08
            version: 2
            visibility: VISIBILITY_READ_WRITE_VALUES
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devs-custom-attributes/customers/customer-ca-updated-webhook-visible.proto
      x-proto-sha: 68ca34e47c4eda321646dacad298edbb0353071b
      x-object-name: CustomerCustomAttributeVisibleUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.custom_attribute.visible.updated
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/CustomerCustomAttributes'
      x-since: 2022-08-17
      x-contains-pii: true
    CustomerDeletedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event.
        type:
          type: string
          description: The type of event. For this object, the value is `customer.deleted`.
        event_id:
          type: string
          description: The unique ID of the event, which is used for [idempotency
            support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices).
        created_at:
          type: string
          description: The timestamp of when the event was created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomerDeletedWebhookData'
      description: |-
        Published when a [customer](entity:Customer) is deleted.  For more information, see [Use Customer Webhooks](https://developer.squareup.com/docs/customers-api/use-the-api/customer-webhooks).

        The `customer` object in the event notification does not include the following fields: `cards` (deprecated), `group_ids`, and `segment_ids`.
      example:
        merchant_id: G7MMEBVW021Q4
        type: customer.deleted
        event_id: 8e84fec8-f04b-46f0-b66d-dbb8b59590fa
        created_at: 2020-11-09T21:26:50Z
        data:
          type: customer
          id: QPTXM8PQNX3Q726ZYHPMNP46XC
          deleted: true
          object:
            customer:
              address:
                address_line_1: 1018 1st Street
                administrative_district_level_1: NY
                locality: Brooklyn
                postal_code: "11215"
              birthday: 1962-03-04T00:00:00-00:00
              creation_source: IMPORT
              email_address: jenkins+smorly@squareup.com
              family_name: Smiley
              given_name: Jenkins
              id: QPTXM8PQNX3Q726ZYHPMNP46XC
              phone_number: +12126668929
              preferences:
                email_unsubscribed: false
              version: 3
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/customers/customer-deleted-webhook.proto
      x-proto-sha: 96be9ab0a77d6d8531726368ee8653c772bcd7c7
      x-object-name: CustomerDeletedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.deleted
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/Customers'
      x-since: 2021-02-26
      x-contains-pii: true
    CustomerDeletedWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: The type of object affected by the event. For this event, the
            value is `customer`.
        id:
          maxLength: 192
          type: string
          description: The ID of the deleted customer.
        object:
          $ref: '#/components/schemas/CustomerDeletedWebhookObject'
      description: The data associated with the webhook event.
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/customers/customer-deleted-webhook.proto
      x-proto-sha: 96be9ab0a77d6d8531726368ee8653c772bcd7c7
      x-object-name: CustomerDeletedWebhookData
      x-visibility: DOC_ONLY
    CustomerDeletedWebhookEventContext:
      type: object
      properties:
        merge:
          $ref: '#/components/schemas/CustomerDeletedWebhookEventContextMerge'
      description: Information about the change that triggered the event.
      x-property-order:
      - merge
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/customers/customer-deleted-webhook.proto
      x-proto-sha: 96be9ab0a77d6d8531726368ee8653c772bcd7c7
      x-object-name: CustomerDeletedWebhookEventContext
      x-visibility: DOC_ONLY
    CustomerDeletedWebhookEventContextMerge:
      type: object
      properties:
        from_customer_ids:
          type: array
          description: The IDs of the existing customers that were merged and then
            deleted.
          items:
            type: string
        to_customer_id:
          type: string
          description: The ID of the new customer created by the merge.
      description: Information about a merge operation, which creates a new customer
        using aggregated properties from two or more existing customers.
      x-property-order:
      - from_customer_ids
      - to_customer_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/customers/customer-deleted-webhook.proto
      x-proto-sha: 96be9ab0a77d6d8531726368ee8653c772bcd7c7
      x-object-name: CustomerDeletedWebhookEventContextMerge
      x-visibility: DOC_ONLY
    CustomerDeletedWebhookObject:
      type: object
      properties:
        customer:
          $ref: '#/components/schemas/Customer'
        event_context:
          $ref: '#/components/schemas/CustomerDeletedWebhookEventContext'
      description: An object that contains the customer associated with the webhook
        event.
      x-property-order:
      - customer
      - event_context
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/customers/customer-deleted-webhook.proto
      x-proto-sha: 96be9ab0a77d6d8531726368ee8653c772bcd7c7
      x-object-name: CustomerDeletedWebhookObject
      x-visibility: DOC_ONLY
    CustomerUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the seller associated with the event.
        type:
          type: string
          description: The type of event. For this object, the value is `customer.updated`.
        event_id:
          type: string
          description: The unique ID of the event, which is used for [idempotency
            support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices).
        created_at:
          type: string
          description: The timestamp of when the event was created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/CustomerUpdatedWebhookData'
      description: |-
        Published when a [customer](entity:Customer) is updated. For more information, see [Use Customer Webhooks](https://developer.squareup.com/docs/customers-api/use-the-api/customer-webhooks).

        Updates to the following customer fields do not invoke a `customer.updated` event: `cards` (deprecated) and `segment_ids`. In addition, the `customer` object in the event notification does not include these fields.
      example:
        merchant_id: G7MMEBVW021Q4
        type: customer.updated
        event_id: b4ce4698-00de-4b5d-a771-4941b3913b34
        created_at: 2020-11-09T21:38:29Z
        data:
          type: customer
          id: A0AP25A6SCVTH8JES9BX01GXM4
          object:
            customer:
              created_at: 2020-07-09T18:23:01.795Z
              creation_source: THIRD_PARTY
              email_address: jenkins+smorly@squareup.com
              family_name: Smorly
              given_name: Jenkins
              id: A0AP25A6SCVTH8JES9BX01GXM4
              phone_number: +13477947111
              preferences:
                email_unsubscribed: false
              updated_at: 2020-11-09T21:38:30Z
              version: 1
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/customers/customer-updated-webhook.proto
      x-proto-sha: 96be9ab0a77d6d8531726368ee8653c772bcd7c7
      x-object-name: CustomerUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: customer.updated
        scopes:
        - CUSTOMERS_READ
      x-api: '#/components/x-apis/Customers'
      x-since: 2021-02-26
      x-contains-pii: true
    CustomerUpdatedWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: The type of object affected by the event. For this event, the
            value is `customer`.
        id:
          maxLength: 192
          type: string
          description: The ID of the updated customer.
        object:
          $ref: '#/components/schemas/CustomerUpdatedWebhookObject'
      description: The data associated with the webhook event.
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/customers/customer-updated-webhook.proto
      x-proto-sha: 96be9ab0a77d6d8531726368ee8653c772bcd7c7
      x-object-name: CustomerUpdatedWebhookData
      x-visibility: DOC_ONLY
    CustomerUpdatedWebhookObject:
      type: object
      properties:
        customer:
          $ref: '#/components/schemas/Customer'
      description: An object that contains the customer associated with the webhook
        event.
      x-property-order:
      - customer
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/customers/customer-updated-webhook.proto
      x-proto-sha: 96be9ab0a77d6d8531726368ee8653c772bcd7c7
      x-object-name: CustomerUpdatedWebhookObject
      x-visibility: DOC_ONLY
    DeviceCodePairedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the target location associated with the event.
        type:
          type: string
          description: The type of event this represents, `"device.code.paired"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: RFC 3339 timestamp of when the webhook event was created.
          readOnly: true
        data:
          $ref: '#/components/schemas/DeviceCodePairedWebhookData'
      description: |-
        Published when a Square Terminal has been paired with a
        Terminal API client and the device_id of the paired Square Terminal is
        available.
      example:
        merchant_id: 7NZR58EPNGNPC
        location_id: AR63EC48VXVBN
        type: device.code.paired
        event_id: 84ccdb8a-da90-4b14-b6b0-c5a5abbccfe6
        created_at: 2020-04-10T14:41:58.036Z
        data:
          type: device.code
          id: 05NK80TRSC2ZF
          object:
            device_code:
              code: ABCDEF
              created_at: 2020-04-10T14:41:20.000Z
              device_id: 907CS13101300122
              id: 05NK80TRSC2ZF
              location_id: AR63EC48VXVBN
              name: Terminal API Device created on Apr 10, 2020
              paired_at: 2020-04-10T14:41:50.000Z
              product_type: TERMINAL_API
              status: PAIRED
              status_changed_at: 2020-04-10T14:41:50.000Z
      x-property-order:
      - merchant_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devices/device-code-paired-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DeviceCodePairedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: device.code.paired
        scopes:
        - DEVICE_CREDENTIAL_MANAGEMENT
      x-api: '#/components/x-apis/Devices'
      x-since: 2020-04-22
      x-contains-pii: true
    DeviceCodePairedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the paired object’s type, `"device.code"`.
        id:
          type: string
          description: ID of the paired device code.
        object:
          $ref: '#/components/schemas/DeviceCodePairedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devices/device-code-paired-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DeviceCodePairedWebhookData
      x-visibility: DOC_ONLY
    DeviceCodePairedWebhookObject:
      type: object
      properties:
        device_code:
          $ref: '#/components/schemas/DeviceCode'
      x-property-order:
      - device_code
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/devices/device-code-paired-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DeviceCodePairedWebhookObject
      x-visibility: DOC_ONLY
    DisputeCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the target location associated with the event.
        type:
          type: string
          description: The type of event this represents.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/DisputeCreatedWebhookData'
      description: Published when a [Dispute](entity:Dispute) is created.
      example:
        merchant_id: 0HPGX5JYE6EE1
        location_id: VJDQQP3CG14EY
        type: dispute.created
        event_id: ce8464b5-6628-4ac2-9264-e06c34df3e82
        created_at: 2020-02-19T21:24:53.258Z
        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
              id: ORSEVtZAJxb37RA1EiGw
              disputed_payment:
                payment_id: fbmsaEOpoARDKxiSGH1fqPuqoqFZY
              due_at: 2020-03-04T00:00:00.000Z
              location_id: VJDQQP3CG14EY
              reason: AMOUNT_DIFFERS
              reported_at: 2020-02-19T00:00:00.000Z
              state: EVIDENCE_REQUIRED
              updated_at: 2020-02-19T21:24:53.258Z
              version: 1
      x-property-order:
      - merchant_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: dispute.created
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Disputes'
      x-since: 2020-02-26
      x-contains-pii: false
    DisputeCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected dispute's type.
        id:
          type: string
          description: ID of the affected dispute.
        object:
          $ref: '#/components/schemas/DisputeCreatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeCreatedWebhookData
      x-visibility: DOC_ONLY
    DisputeCreatedWebhookObject:
      type: object
      properties:
        object:
          $ref: '#/components/schemas/Dispute'
      x-property-order:
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeCreatedWebhookObject
      x-visibility: DOC_ONLY
    DisputeEvidenceAddedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the target location associated with the event.
        type:
          type: string
          description: The type of event this represents.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/DisputeEvidenceAddedWebhookData'
      description: |-
        Published when evidence is added to a [Dispute](entity:Dispute)
        from the Disputes Dashboard in the Seller Dashboard, the Square Point of Sale app,
        or by calling either [CreateDisputeEvidenceFile](api-endpoint:Disputes-CreateDisputeEvidenceFile) or [CreateDisputeEvidenceText](api-endpoint:Disputes-CreateDisputeEvidenceText).
      example:
        merchant_id: 0HPGX5JYE6EE1
        location_id: VJDQQP3CG14EY
        type: dispute.evidence.added
        event_id: 6f606f30-53d0-495a-87f0-958576fc954f
        created_at: 2020-02-19T21:27:28.851Z
        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
              dispute_id: ORSEVtZAJxb37RA1EiGw
              disputed_payment:
                payment_id: fbmsaEOpoARDKxiSGH1fqPuqoqFZY
              due_at: 2020-03-04T00:00:00.000Z
              evidence_ids:
              - oThqMsDS9bM0LdjZzVB4qB
              location_id: VJDQQP3CG14EY
              reason: AMOUNT_DIFFERS
              reported_date: 2020-02-19T00:00:00.000Z
              state: EVIDENCE_REQUIRED
              updated_at: 2020-02-19T21:27:28.851Z
              version: 2
      deprecated: true
      x-property-order:
      - merchant_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-evidence-added-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeEvidenceAddedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: dispute.evidence.added
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Disputes'
      x-since: 2020-02-26
      x-contains-pii: false
    DisputeEvidenceAddedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected dispute's type.
        id:
          type: string
          description: ID of the affected dispute.
        object:
          $ref: '#/components/schemas/DisputeEvidenceAddedWebhookObject'
      deprecated: true
      x-property-order:
      - type
      - id
      - object
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-evidence-added-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeEvidenceAddedWebhookData
      x-visibility: DOC_ONLY
    DisputeEvidenceAddedWebhookObject:
      type: object
      properties:
        object:
          $ref: '#/components/schemas/Dispute'
      deprecated: true
      x-property-order:
      - object
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-evidence-added-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeEvidenceAddedWebhookObject
      x-visibility: DOC_ONLY
    DisputeEvidenceCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the target location associated with the event.
        type:
          type: string
          description: The type of event this represents.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/DisputeEvidenceCreatedWebhookData'
      description: |-
        Published when evidence is added to a [Dispute](entity:Dispute)
        from the Disputes Dashboard in the Seller Dashboard, the Square Point of Sale app,
        or by calling either [CreateDisputeEvidenceFile](api-endpoint:Disputes-CreateDisputeEvidenceFile) or [CreateDisputeEvidenceText](api-endpoint:Disputes-CreateDisputeEvidenceText).
      example:
        merchant_id: 0HPGX5JYE6EE1
        location_id: VJDQQP3CG14EY
        type: dispute.evidence.created
        event_id: 6f606f30-53d0-495a-87f0-958576fc954f
        created_at: 2020-02-19T21:27:28.851Z
        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
              id: ORSEVtZAJxb37RA1EiGw
              disputed_payment:
                payment_id: fbmsaEOpoARDKxiSGH1fqPuqoqFZY
              due_at: 2020-03-04T00:00:00.000Z
              location_id: VJDQQP3CG14EY
              reason: AMOUNT_DIFFERS
              reported_at: 2020-02-19T00:00:00.000Z
              state: EVIDENCE_REQUIRED
              updated_at: 2020-02-19T21:27:28.851Z
              version: 2
      x-property-order:
      - merchant_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-evidence-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeEvidenceCreatedWebhook
      x-webhook:
        event: dispute.evidence.created
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Disputes'
      x-since: 2021-06-16
      x-contains-pii: false
    DisputeEvidenceCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected dispute's type.
        id:
          type: string
          description: ID of the affected dispute.
        object:
          $ref: '#/components/schemas/DisputeEvidenceCreatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-evidence-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeEvidenceCreatedWebhookData
    DisputeEvidenceCreatedWebhookObject:
      type: object
      properties:
        object:
          $ref: '#/components/schemas/Dispute'
      x-property-order:
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-evidence-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeEvidenceCreatedWebhookObject
    DisputeEvidenceDeletedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the target location associated with the event.
        type:
          type: string
          description: The type of event this represents.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/DisputeEvidenceDeletedWebhookData'
      description: |-
        Published when evidence is removed from a [Dispute](entity:Dispute)
        from the Disputes Dashboard in the Seller Dashboard, the Square Point of Sale app,
        or by calling [DeleteDisputeEvidence](api-endpoint:Disputes-DeleteDisputeEvidence).
      example:
        merchant_id: 0HPGX5JYE6EE1
        location_id: VJDQQP3CG14EY
        type: dispute.evidence.deleted
        event_id: e3fd10cc-953b-4f97-83cd-d5b7fa799a8c
        created_at: 2020-02-19T21:31:55.186Z
        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
              id: ORSEVtZAJxb37RA1EiGw
              disputed_payment:
                payment_id: fbmsaEOpoARDKxiSGH1fqPuqoqFZY
              due_at: 2020-03-04T00:00:00.000Z
              location_id: VJDQQP3CG14EY
              reason: AMOUNT_DIFFERS
              reported_at: 2020-02-19T00:00:00.000Z
              state: EVIDENCE_REQUIRED
              updated_at: 2020-02-19T21:31:55.186Z
              version: 3
      x-property-order:
      - merchant_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-evidence-deleted-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeEvidenceDeletedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: dispute.evidence.deleted
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Disputes'
      x-since: 2021-06-16
      x-contains-pii: false
    DisputeEvidenceDeletedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected dispute's type.
        id:
          type: string
          description: ID of the affected dispute.
        object:
          $ref: '#/components/schemas/DisputeEvidenceDeletedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-evidence-deleted-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeEvidenceDeletedWebhookData
      x-visibility: DOC_ONLY
    DisputeEvidenceDeletedWebhookObject:
      type: object
      properties:
        object:
          $ref: '#/components/schemas/Dispute'
      x-property-order:
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-evidence-deleted-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeEvidenceDeletedWebhookObject
      x-visibility: DOC_ONLY
    DisputeEvidenceRemovedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the target location associated with the event.
        type:
          type: string
          description: The type of event this represents.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/DisputeEvidenceRemovedWebhookData'
      description: |-
        Published when evidence is removed from a [Dispute](entity:Dispute)
        from the Disputes Dashboard in the Seller Dashboard, the Square Point of Sale app,
        or by calling [DeleteDisputeEvidence](api-endpoint:Disputes-DeleteDisputeEvidence).
      example:
        merchant_id: 0HPGX5JYE6EE1
        location_id: VJDQQP3CG14EY
        type: dispute.evidence.removed
        event_id: e3fd10cc-953b-4f97-83cd-d5b7fa799a8c
        created_at: 2020-02-19T21:31:55.186Z
        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
              dispute_id: ORSEVtZAJxb37RA1EiGw
              disputed_payment:
                payment_id: fbmsaEOpoARDKxiSGH1fqPuqoqFZY
              due_at: 2020-03-04T00:00:00.000Z
              location_id: VJDQQP3CG14EY
              reason: AMOUNT_DIFFERS
              reported_date: 2020-02-19T00:00:00.000Z
              state: EVIDENCE_REQUIRED
              updated_at: 2020-02-19T21:31:55.186Z
              version: 3
      deprecated: true
      x-property-order:
      - merchant_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-evidence-removed-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeEvidenceRemovedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: dispute.evidence.removed
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Disputes'
      x-since: 2020-02-26
      x-contains-pii: false
    DisputeEvidenceRemovedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected dispute's type.
        id:
          type: string
          description: ID of the affected dispute.
        object:
          $ref: '#/components/schemas/DisputeEvidenceRemovedWebhookObject'
      deprecated: true
      x-property-order:
      - type
      - id
      - object
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-evidence-removed-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeEvidenceRemovedWebhookData
      x-visibility: DOC_ONLY
    DisputeEvidenceRemovedWebhookObject:
      type: object
      properties:
        object:
          $ref: '#/components/schemas/Dispute'
      deprecated: true
      x-property-order:
      - object
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-evidence-removed-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeEvidenceRemovedWebhookObject
      x-visibility: DOC_ONLY
    DisputeStateChangedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the target location associated with the event.
        type:
          type: string
          description: The type of event this represents.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/DisputeStateChangedWebhookData'
      description: |-
        Published when the state of a [Dispute](entity:Dispute) changes.
        This includes the dispute resolution (WON, LOST) reported by the bank. The event
        data includes details of what changed.
      example:
        merchant_id: 0HPGX5JYE6EE1
        location_id: VJDQQP3CG14EY
        type: dispute.state.changed
        event_id: e89ff114-1972-4be0-9481-a621f2385fff
        created_at: 2020-02-19T21:34:41.851Z
        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
              dispute_id: ORSEVtZAJxb37RA1EiGw
              disputed_payment:
                payment_id: fbmsaEOpoARDKxiSGH1fqPuqoqFZY
              due_at: 2020-03-04T00:00:00.000Z
              evidence_ids:
              - Vjq6LG8b95cnnq1AoG5bP
              location_id: VJDQQP3CG14EY
              reason: AMOUNT_DIFFERS
              reported_date: 2020-02-19T00:00:00.000Z
              state: WON
              updated_at: 2020-02-19T21:34:41.851Z
              version: 6
      deprecated: true
      x-property-order:
      - merchant_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-state-changed-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeStateChangedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: dispute.state.changed
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Disputes'
      x-since: 2020-02-26
      x-contains-pii: false
    DisputeStateChangedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected dispute's type.
        id:
          type: string
          description: ID of the affected dispute.
        object:
          $ref: '#/components/schemas/DisputeStateChangedWebhookObject'
      deprecated: true
      x-property-order:
      - type
      - id
      - object
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-state-changed-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeStateChangedWebhookData
      x-visibility: DOC_ONLY
    DisputeStateChangedWebhookObject:
      type: object
      properties:
        object:
          $ref: '#/components/schemas/Dispute'
      deprecated: true
      x-property-order:
      - object
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-state-changed-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeStateChangedWebhookObject
      x-visibility: DOC_ONLY
    DisputeStateUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the target location associated with the event.
        type:
          type: string
          description: The type of event this represents.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/DisputeStateUpdatedWebhookData'
      description: |-
        Published when the state of a [Dispute](entity:Dispute) changes.
        This includes the dispute resolution (WON, LOST) reported by the bank. The event
        data includes details of what changed.
      example:
        merchant_id: 0HPGX5JYE6EE1
        location_id: VJDQQP3CG14EY
        type: dispute.state.updated
        event_id: e89ff114-1972-4be0-9481-a621f2385fff
        created_at: 2020-02-19T21:34:41.851Z
        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
              id: ORSEVtZAJxb37RA1EiGw
              disputed_payment:
                payment_id: fbmsaEOpoARDKxiSGH1fqPuqoqFZY
              due_at: 2020-03-04T00:00:00.000Z
              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
      x-property-order:
      - merchant_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-state-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeStateUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: dispute.state.updated
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Disputes'
      x-since: 2021-06-16
      x-contains-pii: false
    DisputeStateUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected dispute's type.
        id:
          type: string
          description: ID of the affected dispute.
        object:
          $ref: '#/components/schemas/DisputeStateUpdatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-state-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeStateUpdatedWebhookData
      x-visibility: DOC_ONLY
    DisputeStateUpdatedWebhookObject:
      type: object
      properties:
        object:
          $ref: '#/components/schemas/Dispute'
      x-property-order:
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/disputes/dispute-state-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: DisputeStateUpdatedWebhookObject
      x-visibility: DOC_ONLY
    GiftCardActivityCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the Square seller associated with the event.
        type:
          type: string
          description: The type of event. For this event, the value is `gift_card.activity.created`.
        event_id:
          type: string
          description: "The unique ID of the event, which is used for \n[idempotency\
            \ support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices)."
        created_at:
          type: string
          description: The timestamp of when the event was created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/GiftCardActivityCreatedWebhookData'
      description: Published when a [gift card activity](entity:GiftCardActivity)
        is created.
      example:
        merchant_id: C337NFWQT2A6W
        type: gift_card.activity.created
        event_id: 875f2038-6015-492e-9f29-d040b3809e49
        created_at: 2020-12-17T03:41:35.157Z
        data:
          type: gift_card.activity
          id: gcact_c8f8cbf1f24b448d8ecf39ed03f97864
          object:
            gift_card_activity:
              id: gcact_c8f8cbf1f24b448d8ecf39ed03f97864
              gift_card_id: gftc:00113070ba5745f0b2377c1b9570cb03
              gift_card_gan: "7783320007480908"
              type: ACTIVATE
              gift_card_balance_money:
                amount: 1000
                currency: USD
              location_id: 81FN9BNFZTKS4
              activate_activity_details:
                amount_money:
                  amount: 1000
                  currency: USD
                order_id: jJNGHm4gLI6XkFbwtiSLqK72KkAZY
                line_item_uid: eIWl7X0nMuO9Ewbh0ChIx
              created_at: 2020-12-17T01:41:35.157Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-activity-created-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardActivityCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: gift_card.activity.created
        scopes:
        - GIFTCARDS_READ
      x-api: '#/components/x-apis/GiftCardActivities'
      x-since: 2021-06-16
      x-contains-pii: false
    GiftCardActivityCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: The type of object affected by the event. For this event, the
            value is `gift_card.activity`.
        id:
          type: string
          description: The ID of the new gift card activity.
        object:
          $ref: '#/components/schemas/GiftCardActivityCreatedWebhookObject'
      description: Represents the data associated with a `gift_card.activity.created`
        webhook event.
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-activity-created-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardActivityCreatedWebhookData
      x-visibility: DOC_ONLY
    GiftCardActivityCreatedWebhookObject:
      type: object
      properties:
        gift_card_activity:
          $ref: '#/components/schemas/GiftCardActivity'
      description: "An object that contains the gift card activity associated with\
        \ a \n`gift_card.activity.created` webhook event."
      x-property-order:
      - gift_card_activity
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-activity-created-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardActivityCreatedWebhookObject
      x-visibility: DOC_ONLY
    GiftCardActivityUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the Square seller associated with the event.
        type:
          type: string
          description: The type of event. For this event, the value is `gift_card.activity.updated`.
        event_id:
          type: string
          description: "The unique ID of the event, which is used for \n[idempotency\
            \ support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices)."
        created_at:
          type: string
          description: The timestamp of when the event was created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/GiftCardActivityUpdatedWebhookData'
      description: "Published when a [gift card activity](entity:GiftCardActivity)\
        \ is updated. \nSubscribe to this webhook to be notified about the following\
        \ changes:\n- An update to the `REDEEM` activity for a gift card redemption\
        \ made from a Square product (such as Square Point of Sale). \nThese redemptions\
        \ are initially assigned a `PENDING` state, but then change to a `COMPLETED`\
        \ or `CANCELED` state.\n- An update to the `IMPORT` activity for an imported\
        \ gift card when the balance is later adjusted by Square."
      example:
        merchant_id: C337NFWQT2A6W
        type: gift_card.activity.updated
        event_id: 875f2038-6015-492e-9f29-d040b3809e49
        created_at: 2020-12-17T03:41:35.157Z
        data:
          type: gift_card.activity
          id: gcact_c8f8cbf1f24b448d8ecf39ed03f97864
          object:
            gift_card_activity:
              id: gcact_c8f8cbf1f24b448d8ecf39ed03f97864
              gift_card_id: gftc:00113070ba5745f0b2377c1b9570cb03
              gift_card_gan: "7783320007480908"
              type: IMPORT
              gift_card_balance_money:
                amount: 1500
                currency: USD
              location_id: 81FN9BNFZTKS4
              import_activity_details:
                amount_money:
                  amount: 1500
                  currency: USD
              created_at: 2020-12-17T01:41:35.157Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-activity-updated-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardActivityUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: gift_card.activity.updated
        scopes:
        - GIFTCARDS_READ
      x-api: '#/components/x-apis/GiftCardActivities'
      x-since: 2022-06-16
      x-contains-pii: false
    GiftCardActivityUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: The type of object affected by the event. For this event, the
            value is `gift_card.activity`.
        id:
          type: string
          description: The ID of the updated gift card activity.
        object:
          $ref: '#/components/schemas/GiftCardActivityUpdatedWebhookObject'
      description: The data associated with a `gift_card.activity.updated` webhook
        event.
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-activity-updated-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardActivityUpdatedWebhookData
      x-visibility: DOC_ONLY
    GiftCardActivityUpdatedWebhookObject:
      type: object
      properties:
        gift_card_activity:
          $ref: '#/components/schemas/GiftCardActivity'
      description: "An object that contains the gift card activity associated with\
        \ a \n`gift_card.activity.updated` webhook event."
      x-property-order:
      - gift_card_activity
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-activity-updated-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardActivityUpdatedWebhookObject
      x-visibility: DOC_ONLY
    GiftCardCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the Square seller associated with the event.
        type:
          type: string
          description: The type of event. For this event, the value is `gift_card.created`.
        event_id:
          type: string
          description: "The unique ID of the event, which is used for \n[idempotency\
            \ support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices)."
        created_at:
          type: string
          description: The timestamp of when the event was created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/GiftCardCreatedWebhookData'
      description: Published when a [gift card](entity:GiftCard) is created.
      example:
        merchant_id: C337NFWQT2A6W
        type: gift_card.created
        event_id: 875f2038-6015-492e-9f29-d040b3809e49
        created_at: 2020-12-17T01:41:35.157Z
        data:
          type: gift_card
          id: gftc:00113070ba5745f0b2377c1b9570cb03
          object:
            gift_card:
              id: gftc:00113070ba5745f0b2377c1b9570cb03
              type: DIGITAL
              gan_source: SQUARE
              state: NOT_ACTIVE
              balance_money:
                amount: 0
                currency: USD
              gan: "7783320007480908"
              created_at: 2020-12-17T01:41:35.157Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-created-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: gift_card.created
        scopes:
        - GIFTCARDS_READ
      x-api: '#/components/x-apis/GiftCards'
      x-since: 2021-06-16
      x-contains-pii: false
    GiftCardCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: The type of object affected by the event. For this event, the
            value is `gift_card`.
        id:
          type: string
          description: The ID of the new gift card.
        object:
          $ref: '#/components/schemas/GiftCardCreatedWebhookObject'
      description: The data associated with a `gift_card.created` webhook event.
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-created-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardCreatedWebhookData
      x-visibility: DOC_ONLY
    GiftCardCreatedWebhookObject:
      type: object
      properties:
        gift_card:
          $ref: '#/components/schemas/GiftCard'
      description: An object that contains the gift card associated with a `gift_card.created`
        webhook event.
      x-property-order:
      - gift_card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-created-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardCreatedWebhookObject
      x-visibility: DOC_ONLY
    GiftCardCustomerLinkedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the Square seller associated with the event.
        type:
          type: string
          description: The type of event. For this event, the value is `gift_card.customer_linked`.
        event_id:
          type: string
          description: "The unique ID of the event, which is used for \n[idempotency\
            \ support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices)."
        created_at:
          type: string
          description: The timestamp of when the event was created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/GiftCardCustomerLinkedWebhookData'
      description: Published when a [customer](entity:Customer) is linked to a [gift
        card](entity:GiftCard).
      example:
        merchant_id: C337NFWQT2A6W
        type: gift_card.customer_linked
        event_id: 875f2038-6015-492e-9f29-d040b3809e49
        created_at: 2020-12-17T03:41:35.157Z
        data:
          type: gift_card
          id: gftc:00113070ba5745f0b2377c1b9570cb03
          object:
            gift_card:
              id: gftc:00113070ba5745f0b2377c1b9570cb03
              type: DIGITAL
              gan_source: SQUARE
              state: ACTIVE
              balance_money:
                amount: 1500
                currency: USD
              gan: "7783320007480908"
              customer_ids:
              - QPTXM8PQNX3Q726ZYHPMNP46XC
              created_at: 2020-12-17T01:41:35.157Z
            linked_customer_id: QPTXM8PQNX3Q726ZYHPMNP46XC
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-customer-linked-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardCustomerLinkedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: gift_card.customer_linked
        scopes:
        - GIFTCARDS_READ
      x-api: '#/components/x-apis/GiftCards'
      x-since: 2021-06-16
      x-contains-pii: false
    GiftCardCustomerLinkedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: The type of object affected by the event. For this event, the
            value is `gift_card`.
        id:
          type: string
          description: The ID of the updated gift card.
        object:
          $ref: '#/components/schemas/GiftCardCustomerLinkedWebhookObject'
      description: The data associated with a `gift_card.customer_linked` webhook
        event.
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-customer-linked-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardCustomerLinkedWebhookData
      x-visibility: DOC_ONLY
    GiftCardCustomerLinkedWebhookObject:
      type: object
      properties:
        gift_card:
          $ref: '#/components/schemas/GiftCard'
        linked_customer_id:
          type: string
          description: The ID of the linked [customer](entity:Customer).
      description: "An object that contains the gift card and customer ID associated\
        \ with a \n`gift_card.customer_linked` webhook event."
      x-property-order:
      - gift_card
      - linked_customer_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-customer-linked-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardCustomerLinkedWebhookObject
      x-visibility: DOC_ONLY
    GiftCardCustomerUnlinkedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the Square seller associated with the event.
        type:
          type: string
          description: The type of event. For this event, the value is `gift_card.customer_unlinked`.
        event_id:
          type: string
          description: "The unique ID of the event, which is used for \n[idempotency\
            \ support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices)."
        created_at:
          type: string
          description: The timestamp of when the event was created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/GiftCardCustomerUnlinkedWebhookData'
      description: Published when a [customer](entity:Customer) is unlinked from a
        [gift card](entity:GiftCard).
      example:
        merchant_id: C337NFWQT2A6W
        type: gift_card.customer_unlinked
        event_id: 875f2038-6015-492e-9f29-d040b3809e49
        created_at: 2020-12-17T03:41:35.157Z
        data:
          type: gift_card
          id: gftc:00113070ba5745f0b2377c1b9570cb03
          object:
            gift_card:
              id: gftc:00113070ba5745f0b2377c1b9570cb03
              type: DIGITAL
              gan_source: SQUARE
              state: ACTIVE
              balance_money:
                amount: 1500
                currency: USD
              gan: "7783320007480908"
              created_at: 2020-12-17T01:41:35.157Z
            unlinked_customer_id: QPTXM8PQNX3Q726ZYHPMNP46XC
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-customer-unlinked-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardCustomerUnlinkedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: gift_card.customer_unlinked
        scopes:
        - GIFTCARDS_READ
      x-api: '#/components/x-apis/GiftCards'
      x-since: 2021-06-16
      x-contains-pii: false
    GiftCardCustomerUnlinkedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: The type of object affected by the event. For this event, the
            value is `gift_card`.
        id:
          type: string
          description: The ID of the updated gift card.
        object:
          $ref: '#/components/schemas/GiftCardCustomerUnlinkedWebhookObject'
      description: The data associated with a `gift_card.customer_unlinked` webhook
        event.
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-customer-unlinked-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardCustomerUnlinkedWebhookData
      x-visibility: DOC_ONLY
    GiftCardCustomerUnlinkedWebhookObject:
      type: object
      properties:
        gift_card:
          $ref: '#/components/schemas/GiftCard'
        unlinked_customer_id:
          type: string
          description: The ID of the unlinked [customer](entity:Customer).
      description: "An object that contains the gift card and the customer ID associated\
        \ with a \n`gift_card.customer_linked` webhook event."
      x-property-order:
      - gift_card
      - unlinked_customer_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-customer-unlinked-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardCustomerUnlinkedWebhookObject
      x-visibility: DOC_ONLY
    GiftCardUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the Square seller associated with the event.
        type:
          type: string
          description: The type of this event. For this event, the value is `gift_card.updated`.
        event_id:
          type: string
          description: "The unique ID of the event, which is used for \n[idempotency\
            \ support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices)."
        created_at:
          type: string
          description: The timestamp of when the event was created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/GiftCardUpdatedWebhookData'
      description: |-
        Published when a [gift card](entity:GiftCard) is updated. This includes
        changes to the state, balance, and customer association.
      example:
        merchant_id: C337NFWQT2A6W
        type: gift_card.updated
        event_id: 875f2038-6015-492e-9f29-d040b3809e49
        created_at: 2020-12-17T02:41:35.157Z
        data:
          type: gift_card
          id: gftc:00113070ba5745f0b2377c1b9570cb03
          object:
            gift_card:
              id: gftc:00113070ba5745f0b2377c1b9570cb03
              type: DIGITAL
              gan_source: SQUARE
              state: ACTIVE
              balance_money:
                amount: 3000
                currency: USD
              gan: "7783320007480908"
              created_at: 2020-12-17T01:41:35.157Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-updated-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: gift_card.updated
        scopes:
        - GIFTCARDS_READ
      x-api: '#/components/x-apis/GiftCards'
      x-since: 2021-06-16
      x-contains-pii: false
    GiftCardUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: The type of object affected by the event. For this event, the
            value is `gift_card`.
        id:
          type: string
          description: The ID of the updated gift card.
        object:
          $ref: '#/components/schemas/GiftCardUpdatedWebhookObject'
      description: The data associated with a `gift_card.updated` webhook event.
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-updated-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardUpdatedWebhookData
      x-visibility: DOC_ONLY
    GiftCardUpdatedWebhookObject:
      type: object
      properties:
        gift_card:
          $ref: '#/components/schemas/GiftCard'
      description: An object that contains the gift card associated with a `gift_card.updated`
        webhook event.
      x-property-order:
      - gift_card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/gift-cards/gift-card-updated-webhook.proto
      x-proto-sha: 00d06eb730b9978cf69dc98776534ebfaa606db8
      x-object-name: GiftCardUpdatedWebhookObject
      x-visibility: DOC_ONLY
    InventoryCountUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/InventoryCountUpdatedWebhookData'
      description: |-
        Published when the quantity is updated for a
        [CatalogItemVariation](entity:CatalogItemVariation).
      example:
        merchant_id: 6SSW7HV8K2ST5
        type: inventory.count.updated
        event_id: df5f3813-a913-45a1-94e9-fdc3f7d5e3b6
        created_at: 2019-10-29T18:38:45.455006797Z
        data:
          type: inventory
          id: 84e4ac73-d605-4dbd-a9e5-ffff794ddb9d
          object:
            inventory_counts:
            - calculated_at: 2019-10-29T18:38:45.10296Z
              catalog_object_id: FGQ5JJWT2PYTHF35CKZ2DSKP
              catalog_object_type: ITEM_VARIATION
              location_id: YYQR03DGCTXA4
              quantity: "10"
              state: IN_STOCK
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/inventory/inventory-count-updated-webhook.proto
      x-proto-sha: a67ca34456c709110577d62f998cbabba55c83f4
      x-object-name: InventoryCountUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: inventory.count.updated
        scopes:
        - INVENTORY_READ
      x-api: '#/components/x-apis/Inventory'
      x-since: 2019-06-12
      x-contains-pii: false
    InventoryCountUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type.
        id:
          type: string
          description: ID of the affected object.
        object:
          $ref: '#/components/schemas/InventoryCountUpdatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/inventory/inventory-count-updated-webhook.proto
      x-proto-sha: a67ca34456c709110577d62f998cbabba55c83f4
      x-object-name: InventoryCountUpdatedWebhookData
      x-visibility: DOC_ONLY
    InventoryCountUpdatedWebhookObject:
      type: object
      properties:
        inventory_counts:
          type: array
          description: The inventory counts.
          items:
            $ref: '#/components/schemas/InventoryCount'
      x-property-order:
      - inventory_counts
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/inventory/inventory-count-updated-webhook.proto
      x-proto-sha: a67ca34456c709110577d62f998cbabba55c83f4
      x-object-name: InventoryCountUpdatedWebhookObject
      x-visibility: DOC_ONLY
    InvoiceCanceledWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"invoice.canceled"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/InvoiceCanceledWebhookData'
      description: Published when an [Invoice](entity:Invoice) is canceled.
      example:
        merchant_id: 031FEV2Q6VMPK
        location_id: ES0RJRZYEC39A
        type: invoice.canceled
        event_id: 742ef00c-446b-4fca-b3d5-f177d816ee54
        created_at: 2020-06-18T18:23:11Z
        data:
          type: invoice
          id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
          object:
            invoice:
              id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
              version: 1
              location_id: ES0RJRZYEC39A
              order_id: CAISENgvlJ6jLWAzERDzjyHVybY
              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
              invoice_number: inv-100
              title: Event Planning Services
              description: We appreciate your business!
              delivery_method: EMAIL
              scheduled_at: 2030-01-13T10:00:00Z
              status: CANCELED
              timezone: America/Los_Angeles
              created_at: 2020-06-18T17:45:13Z
              updated_at: 2020-06-18T18:23:11Z
              primary_recipient:
                customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
                given_name: Amelia
                family_name: Earhart
                email_address: Amelia.Earhart@example.com
                phone_number: 1-212-555-4240
              accepted_payment_methods:
                card: true
                square_gift_card: false
                bank_account: 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
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-canceled-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoiceCanceledWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: invoice.canceled
        scopes:
        - INVOICES_READ
      x-api: '#/components/x-apis/Invoices'
      x-since: 2020-07-22
      x-contains-pii: true
    InvoiceCanceledWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"invoice"`.
        id:
          type: string
          description: ID of the affected invoice.
        object:
          $ref: '#/components/schemas/InvoiceCanceledWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-canceled-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoiceCanceledWebhookData
      x-visibility: DOC_ONLY
    InvoiceCanceledWebhookObject:
      type: object
      properties:
        invoice:
          $ref: '#/components/schemas/Invoice'
      x-property-order:
      - invoice
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-canceled-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoiceCanceledWebhookObject
      x-visibility: DOC_ONLY
    InvoiceCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"invoice.created"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/InvoiceCreatedWebhookData'
      description: Published when an [Invoice](entity:Invoice) is created.
      example:
        merchant_id: 031FEV2Q6VMPK
        location_id: ES0RJRZYEC39A
        type: invoice.created
        event_id: 012c1bfa-c239-4fc0-b16d-5809928b54fe
        created_at: 2020-06-18T17:45:13Z
        data:
          type: invoice
          id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
          object:
            invoice:
              id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
              version: 0
              location_id: ES0RJRZYEC39A
              order_id: CAISENgvlJ6jLWAzERDzjyHVybY
              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
              invoice_number: inv-100
              title: Event Planning Services
              description: We appreciate your business!
              delivery_method: EMAIL
              scheduled_at: 2030-01-13T10:00:00Z
              status: DRAFT
              timezone: America/Los_Angeles
              created_at: 2020-06-18T17:45:13Z
              updated_at: 2020-06-18T17:45:13Z
              primary_recipient:
                customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
                given_name: Amelia
                family_name: Earhart
                email_address: Amelia.Earhart@example.com
                phone_number: 1-212-555-4240
              accepted_payment_methods:
                card: true
                square_gift_card: false
                bank_account: 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
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-created-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoiceCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: invoice.created
        scopes:
        - INVOICES_READ
      x-api: '#/components/x-apis/Invoices'
      x-since: 2020-07-22
      x-contains-pii: true
    InvoiceCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"invoice"`.
        id:
          type: string
          description: ID of the affected invoice.
        object:
          $ref: '#/components/schemas/InvoiceCreatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-created-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoiceCreatedWebhookData
      x-visibility: DOC_ONLY
    InvoiceCreatedWebhookObject:
      type: object
      properties:
        invoice:
          $ref: '#/components/schemas/Invoice'
      x-property-order:
      - invoice
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-created-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoiceCreatedWebhookObject
      x-visibility: DOC_ONLY
    InvoiceDeletedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"invoice.deleted"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/InvoiceDeletedWebhookData'
      description: Published when a draft [Invoice](entity:Invoice) is deleted.
      example:
        merchant_id: 031FEV2Q6VMPK
        location_id: ES0RJRZYEC39A
        type: invoice.deleted
        event_id: 742ef00c-446b-4fca-b3d5-f177d816ee54
        created_at: 2020-06-18T18:23:11Z
        data:
          type: invoice
          id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
          deleted: true
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-deleted-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoiceDeletedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: invoice.deleted
        scopes:
        - INVOICES_READ
      x-api: '#/components/x-apis/Invoices'
      x-since: 2020-07-22
      x-contains-pii: false
    InvoiceDeletedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"invoice"`.
        id:
          type: string
          description: ID of the affected invoice.
        deleted:
          type: boolean
          description: Indicates that the invoice was deleted.
      x-property-order:
      - type
      - id
      - deleted
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-deleted-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoiceDeletedWebhookData
      x-visibility: DOC_ONLY
    InvoicePaymentMadeWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"invoice.payment_made"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/InvoicePaymentMadeWebhookData'
      description: Published when a payment that is associated with an [Invoice](entity:Invoice)
        is completed.
      example:
        merchant_id: 031FEV2Q6VMPK
        location_id: ES0RJRZYEC39A
        type: invoice.payment_made
        event_id: 891e3589-462f-4215-9b61-f6df2d4432b7
        created_at: 2020-06-18T18:23:11Z
        data:
          type: invoice
          id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
          object:
            invoice:
              id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
              version: 3
              location_id: ES0RJRZYEC39A
              order_id: CAISENgvlJ6jLWAzERDzjyHVybY
              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: 10000
                  currency: USD
              invoice_number: inv-100
              title: Event Planning Services
              description: We appreciate your business!
              delivery_method: EMAIL
              status: PAID
              timezone: America/Los_Angeles
              created_at: 2020-06-18T17:45:13Z
              updated_at: 2020-06-18T18:23:11Z
              primary_recipient:
                customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
                given_name: Amelia
                family_name: Earhart
                email_address: Amelia.Earhart@example.com
                phone_number: 1-212-555-4240
              accepted_payment_methods:
                card: true
                square_gift_card: false
                bank_account: 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
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-payment_made-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoicePaymentMadeWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: invoice.payment_made
        scopes:
        - INVOICES_READ
      x-api: '#/components/x-apis/Invoices'
      x-since: 2020-07-22
      x-contains-pii: true
    InvoicePaymentMadeWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"invoice"`.
        id:
          type: string
          description: ID of the affected invoice.
        object:
          $ref: '#/components/schemas/InvoicePaymentMadeWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-payment_made-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoicePaymentMadeWebhookData
      x-visibility: DOC_ONLY
    InvoicePaymentMadeWebhookObject:
      type: object
      properties:
        invoice:
          $ref: '#/components/schemas/Invoice'
      x-property-order:
      - invoice
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-payment_made-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoicePaymentMadeWebhookObject
      x-visibility: DOC_ONLY
    InvoicePublishedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"invoice.published"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/InvoicePublishedWebhookData'
      description: Published when an [Invoice](entity:Invoice) transitions from a
        draft to a non-draft status.
      example:
        merchant_id: 031FEV2Q6VMPK
        location_id: ES0RJRZYEC39A
        type: invoice.published
        event_id: 52246644-98ba-411a-874c-ba35ccdb831c
        created_at: 2020-06-18T18:23:11Z
        data:
          type: invoice
          id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
          object:
            invoice:
              id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
              version: 1
              location_id: ES0RJRZYEC39A
              order_id: CAISENgvlJ6jLWAzERDzjyHVybY
              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
              invoice_number: inv-100
              title: Event Planning Services
              description: We appreciate your business!
              delivery_method: EMAIL
              scheduled_at: 2030-01-13T10:00:00Z
              status: SCHEDULED
              timezone: America/Los_Angeles
              created_at: 2020-06-18T17:45:13Z
              updated_at: 2020-06-18T18:23:11Z
              primary_recipient:
                customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
                given_name: Amelia
                family_name: Earhart
                email_address: Amelia.Earhart@example.com
                phone_number: 1-212-555-4240
              accepted_payment_methods:
                card: true
                square_gift_card: false
                bank_account: 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
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-published-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoicePublishedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: invoice.published
        scopes:
        - INVOICES_READ
      x-api: '#/components/x-apis/Invoices'
      x-since: 2020-07-22
      x-contains-pii: true
    InvoicePublishedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"invoice"`.
        id:
          type: string
          description: ID of the affected invoice.
        object:
          $ref: '#/components/schemas/InvoicePublishedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-published-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoicePublishedWebhookData
      x-visibility: DOC_ONLY
    InvoicePublishedWebhookObject:
      type: object
      properties:
        invoice:
          $ref: '#/components/schemas/Invoice'
      x-property-order:
      - invoice
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-published-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoicePublishedWebhookObject
      x-visibility: DOC_ONLY
    InvoiceRefundedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"invoice.refunded"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/InvoiceRefundedWebhookData'
      description: Published when a refund is applied towards a payment of an [Invoice](entity:Invoice).
      example:
        merchant_id: 031FEV2Q6VMPK
        location_id: ES0RJRZYEC39A
        type: invoice.refunded
        event_id: aedeb1fb-6c7d-4484-8106-866d97652388
        created_at: 2020-06-18T18:23:11Z
        data:
          type: invoice
          id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
          object:
            invoice:
              id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
              version: 4
              location_id: ES0RJRZYEC39A
              order_id: CAISENgvlJ6jLWAzERDzjyHVybY
              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: 10000
                  currency: USD
              invoice_number: inv-100
              title: Event Planning Services
              description: We appreciate your business!
              delivery_method: EMAIL
              status: REFUNDED
              timezone: America/Los_Angeles
              created_at: 2020-06-18T17:45:13Z
              updated_at: 2020-06-18T18:23:11Z
              primary_recipient:
                customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
                given_name: Amelia
                family_name: Earhart
                email_address: Amelia.Earhart@example.com
                phone_number: 1-212-555-4240
              accepted_payment_methods:
                card: true
                square_gift_card: false
                bank_account: 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
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-refunded-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoiceRefundedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: invoice.refunded
        scopes:
        - INVOICES_READ
      x-api: '#/components/x-apis/Invoices'
      x-since: 2020-07-22
      x-contains-pii: true
    InvoiceRefundedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"invoice"`.
        id:
          type: string
          description: ID of the affected invoice.
        object:
          $ref: '#/components/schemas/InvoiceRefundedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-refunded-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoiceRefundedWebhookData
      x-visibility: DOC_ONLY
    InvoiceRefundedWebhookObject:
      type: object
      properties:
        invoice:
          $ref: '#/components/schemas/Invoice'
      x-property-order:
      - invoice
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-refunded-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoiceRefundedWebhookObject
      x-visibility: DOC_ONLY
    InvoiceScheduledChargeFailedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"invoice.scheduled_charge_failed"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/InvoiceScheduledChargeFailedWebhookData'
      description: Published when an automatic scheduled payment for an [Invoice](entity:Invoice)
        has failed.
      example:
        merchant_id: 031FEV2Q6VMPK
        location_id: ES0RJRZYEC39A
        type: invoice.scheduled_charge_failed
        event_id: 3cabb64e-16ba-40c2-b605-5c51a06ec794
        created_at: 2020-06-18T18:23:11Z
        data:
          type: invoice
          id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
          object:
            invoice:
              id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
              version: 4
              location_id: ES0RJRZYEC39A
              order_id: CAISENgvlJ6jLWAzERDzjyHVybY
              payment_requests:
              - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355
                request_type: BALANCE
                due_date: 2030-01-24
                tipping_enabled: false
                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
              invoice_number: inv-100
              title: Event Planning Services
              description: We appreciate your business!
              delivery_method: EMAIL
              scheduled_at: 2030-01-13T10:00:00Z
              status: UNPAID
              timezone: America/Los_Angeles
              created_at: 2020-06-18T17:45:13Z
              updated_at: 2020-06-18T18:23:11Z
              primary_recipient:
                customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
                given_name: Amelia
                family_name: Earhart
                email_address: Amelia.Earhart@example.com
                phone_number: 1-212-555-4240
              accepted_payment_methods:
                card: true
                square_gift_card: false
                bank_account: 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
              next_payment_amount_money:
                amount: 10000
                currency: USD
              sale_or_service_date: 2030-01-24
              store_payment_method_enabled: false
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-scheduled_charge_failed-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoiceScheduledChargeFailedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: invoice.scheduled_charge_failed
        scopes:
        - INVOICES_READ
      x-api: '#/components/x-apis/Invoices'
      x-since: 2020-07-22
      x-contains-pii: true
    InvoiceScheduledChargeFailedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"invoice"`.
        id:
          type: string
          description: ID of the affected invoice.
        object:
          $ref: '#/components/schemas/InvoiceScheduledChargeFailedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-scheduled_charge_failed-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoiceScheduledChargeFailedWebhookData
      x-visibility: DOC_ONLY
    InvoiceScheduledChargeFailedWebhookObject:
      type: object
      properties:
        invoice:
          $ref: '#/components/schemas/Invoice'
      x-property-order:
      - invoice
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-scheduled_charge_failed-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoiceScheduledChargeFailedWebhookObject
      x-visibility: DOC_ONLY
    InvoiceUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"invoice.updated"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/InvoiceUpdatedWebhookData'
      description: Published when an [Invoice](entity:Invoice) is updated.
      example:
        merchant_id: 031FEV2Q6VMPK
        location_id: ES0RJRZYEC39A
        type: invoice.updated
        event_id: 0312a8c5-af0f-49f4-ba29-291ef08dcd7e
        created_at: 2020-06-18T18:23:11Z
        data:
          type: invoice
          id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
          object:
            invoice:
              id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
              version: 2
              location_id: ES0RJRZYEC39A
              order_id: CAISENgvlJ6jLWAzERDzjyHVybY
              payment_requests:
              - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355
                request_type: BALANCE
                due_date: 2030-01-24
                tipping_enabled: false
                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
              invoice_number: inv-100
              title: Event Planning Services
              description: We appreciate your business!
              delivery_method: EMAIL
              scheduled_at: 2030-01-13T10:00:00Z
              status: UNPAID
              timezone: America/Los_Angeles
              created_at: 2020-06-18T17:45:13Z
              updated_at: 2020-06-18T18:23:11Z
              primary_recipient:
                customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
                given_name: Amelia
                family_name: Earhart
                email_address: Amelia.Earhart@example.com
                phone_number: 1-212-555-4240
              accepted_payment_methods:
                card: true
                square_gift_card: false
                bank_account: 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
              next_payment_amount_money:
                amount: 10000
                currency: USD
              sale_or_service_date: 2030-01-24
              store_payment_method_enabled: false
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-updated-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoiceUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: invoice.updated
        scopes:
        - INVOICES_READ
      x-api: '#/components/x-apis/Invoices'
      x-since: 2020-07-22
      x-contains-pii: true
    InvoiceUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"invoice"`.
        id:
          type: string
          description: ID of the affected invoice.
        object:
          $ref: '#/components/schemas/InvoiceUpdatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-updated-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoiceUpdatedWebhookData
      x-visibility: DOC_ONLY
    InvoiceUpdatedWebhookObject:
      type: object
      properties:
        invoice:
          $ref: '#/components/schemas/Invoice'
      x-property-order:
      - invoice
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/invoices/invoice-updated-webhook.proto
      x-proto-sha: 3ba9d9bf1a4f11d1f74f52ef8a51f98aa3afa041
      x-object-name: InvoiceUpdatedWebhookObject
      x-visibility: DOC_ONLY
    LaborShiftCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/LaborShiftCreatedWebhookData'
      description: Published when a worker starts a [Shift](entity:Shift).
      example:
        merchant_id: 6SSW7HV8K2ST5
        type: labor.shift.created
        event_id: aeaaa5f6-c4fd-4e93-b688-71b50706266f
        created_at: 2019-10-29T17:26:16.808603647Z
        data:
          type: labor
          id: PY4YSMVKXFY9E
          object:
            shift:
              id: PY4YSMVKXFY9E
              employee_id: AnuhZhsN95oT8f-eCn9D
              team_member_id: AnuhZhsN95oT8f-eCn9D
              location_id: NAQ1FHV6ZJ8YV
              timezone: Etc/UTC
              start_at: 2019-01-25T08:11:00Z
              end_at: 2019-01-25T18:11:00Z
              wage:
                title: Barista
                hourly_rate:
                  amount: 1100
                  currency: USD
              status: OPEN
              version: 1
              created_at: 2019-11-06T19:14:55Z
              updated_at: 2019-11-06T19:14:55Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/labor/labor-shift-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: LaborShiftCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: labor.shift.created
        scopes:
        - TIMECARDS_READ
      x-api: '#/components/x-apis/Labor'
      x-since: 2019-11-20
      x-contains-pii: false
    LaborShiftCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type.
        id:
          type: string
          description: ID of the affected object.
        object:
          $ref: '#/components/schemas/LaborShiftCreatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/labor/labor-shift-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: LaborShiftCreatedWebhookData
      x-visibility: DOC_ONLY
    LaborShiftCreatedWebhookObject:
      type: object
      properties:
        shift:
          $ref: '#/components/schemas/Shift'
      x-property-order:
      - shift
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/labor/labor-shift-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: LaborShiftCreatedWebhookObject
      x-visibility: DOC_ONLY
    LaborShiftDeletedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/LaborShiftDeletedWebhookData'
      description: Published when a [Shift](entity:Shift) is deleted.
      example:
        merchant_id: 6SSW7HV8K2ST5
        type: labor.shift.deleted
        event_id: aeaaa5f6-c4fd-4e93-b688-71b50706266f
        created_at: 2019-10-29T17:26:16.808603647Z
        data:
          type: labor
          id: PY4YSMVKXFY9E
          deleted: true
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/labor/labor-shift-deleted-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: LaborShiftDeletedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: labor.shift.deleted
        scopes:
        - TIMECARDS_READ
      x-api: '#/components/x-apis/Labor'
      x-since: 2019-11-20
      x-contains-pii: false
    LaborShiftDeletedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type.
        id:
          type: string
          description: ID of the affected object.
        deleted:
          type: boolean
          description: Is true if the affected object was deleted. Otherwise absent.
      x-property-order:
      - type
      - id
      - deleted
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/labor/labor-shift-deleted-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: LaborShiftDeletedWebhookData
      x-visibility: DOC_ONLY
    LaborShiftUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/LaborShiftUpdatedWebhookData'
      description: Published when a [Shift](entity:Shift) is updated.
      example:
        merchant_id: 6SSW7HV8K2ST5
        type: labor.shift.updated
        event_id: aeaaa5f6-c4fd-4e93-b688-71b50706266f
        created_at: 2019-10-29T17:26:16.808603647Z
        data:
          type: labor
          id: PY4YSMVKXFY9E
          object:
            shift:
              id: PY4YSMVKXFY9E
              employee_id: AnuhZhsN95oT8f-eCn9D
              team_member_id: AnuhZhsN95oT8f-eCn9D
              location_id: NAQ1FHV6ZJ8YV
              timezone: Etc/UTC
              start_at: 2019-01-25T08:11:00Z
              end_at: 2019-01-25T18:11:00Z
              wage:
                title: Barista
                hourly_rate:
                  amount: 1100
                  currency: USD
              breaks:
              - id: 0EGK74E8BJF62
                start_at: 2019-01-25T11:11:00Z
                end_at: 2019-01-25T11:16:00Z
                break_type_id: REGS1EQR1TPZ5
                name: Tea Break
                expected_duration: PT5M
                is_paid: true
              status: CLOSED
              version: 1
              created_at: 2019-11-06T19:14:55Z
              updated_at: 2019-11-06T19:14:55Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/labor/labor-shift-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: LaborShiftUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: labor.shift.updated
        scopes:
        - TIMECARDS_READ
      x-api: '#/components/x-apis/Labor'
      x-since: 2019-11-20
      x-contains-pii: false
    LaborShiftUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type.
        id:
          type: string
          description: ID of the affected object.
        object:
          $ref: '#/components/schemas/LaborShiftUpdatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/labor/labor-shift-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: LaborShiftUpdatedWebhookData
      x-visibility: DOC_ONLY
    LaborShiftUpdatedWebhookObject:
      type: object
      properties:
        shift:
          $ref: '#/components/schemas/Shift'
      x-property-order:
      - shift
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/labor/labor-shift-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: LaborShiftUpdatedWebhookObject
      x-visibility: DOC_ONLY
    LocationCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the [Location](entity:Location) associated with the
            event.
        type:
          type: string
          description: The type of event this represents, `"location.created"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/LocationCreatedWebhookData'
      description: Published when a [Location](entity:Location) is created.
      example:
        merchant_id: 6SSW7HV8K2ST5
        location_id: S8GWD5DBJ3HF3
        type: location.created
        event_id: de45d351-8ad2-400a-97af-e9f89da3d19d
        created_at: 2020-02-06T21:27:34.308Z
        data:
          type: Location
          id: S8GWD5DBJ3HF3
      x-property-order:
      - merchant_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/locations/location-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: LocationCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: location.created
        scopes:
        - MERCHANT_PROFILE_READ
      x-api: '#/components/x-apis/Locations'
      x-since: 2020-10-28
      x-contains-pii: true
    LocationCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"location"`.
        id:
          type: string
          description: ID of the updated [Location](entity:Location).
      x-property-order:
      - type
      - id
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/locations/location-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: LocationCreatedWebhookData
      x-visibility: DOC_ONLY
    LocationUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the [Location](entity:Location) associated with the
            event.
        type:
          type: string
          description: The type of event this represents, `"location.updated"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/LocationUpdatedWebhookData'
      description: Published when a [Location](entity:Location) is updated.
      example:
        merchant_id: 6SSW7HV8K2ST5
        location_id: S8GWD5DBJ3HF3
        type: location.updated
        event_id: de45d351-8ad2-400a-97af-e9f89da3d19d
        created_at: 2020-02-06T21:27:34.308Z
        data:
          type: Location
          id: S8GWD5DBJ3HF3
      x-property-order:
      - merchant_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/locations/location-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: LocationUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: location.updated
        scopes:
        - MERCHANT_PROFILE_READ
      x-api: '#/components/x-apis/Locations'
      x-since: 2020-10-28
      x-contains-pii: true
    LocationUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"location"`.
        id:
          type: string
          description: ID of the updated [Location](entity:Location).
      x-property-order:
      - type
      - id
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/locations/location-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: LocationUpdatedWebhookData
      x-visibility: DOC_ONLY
    LoyaltyAccountCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the Square seller associated with the event.
        type:
          type: string
          description: The type of event. For this event, the value is `loyalty.account.created`.
        event_id:
          type: string
          description: |-
            The unique ID for the event, which is used for
            [idempotency support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices).
        created_at:
          type: string
          description: The timestamp of when the webhook event was created, in RFC
            3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/LoyaltyAccountCreatedWebhookData'
      description: Published when a [loyalty account](entity:LoyaltyAccount) is created.
      example:
        merchant_id: C337NFWQT2A6W
        type: loyalty.account.created
        event_id: 875f2038-6015-492e-9f29-d040b3809e49
        created_at: 2020-05-13T01:41:35.157Z
        data:
          type: loyalty
          id: ba2f8ab6-e131-46d9-9882-17714404eb49
          object:
            loyalty_account:
              id: ba2f8ab6-e131-46d9-9882-17714404eb49
              program_id: 5216e8b2-d43e-41e2-9ed8-eccf3e892aef
              balance: 0
              lifetime_points: 0
              mapping:
                created_at: 2020-05-13T01:41:34Z
                id: 664c22ba-9460-45a5-8917-381ae72dcfdc
                phone_number: +14155551234
              customer_id: QPTXM8PQNX3Q726ZYHPMNP46XC
              enrolled_at: 2020-05-13T01:41:34Z
              created_at: 2020-05-13T01:41:34Z
              updated_at: 2020-05-13T01:41:34Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/loyalty/loyalty-account-created-webhook.proto
      x-proto-sha: 7001993db131fffee10de86140dd24c499b4f3ee
      x-object-name: LoyaltyAccountCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: loyalty.account.created
        scopes:
        - LOYALTY_READ
      x-api: '#/components/x-apis/Loyalty'
      x-since: 2020-05-28
      x-contains-pii: true
    LoyaltyAccountCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: The type of object affected by the event. For this event, the
            value is `loyalty.account`.
        id:
          type: string
          description: The ID of the affected loyalty account.
        object:
          $ref: '#/components/schemas/LoyaltyAccount'
      description: The data associated with a `loyalty.account.created` webhook event.
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/loyalty/loyalty-account-created-webhook.proto
      x-proto-sha: 7001993db131fffee10de86140dd24c499b4f3ee
      x-object-name: LoyaltyAccountCreatedWebhookData
      x-visibility: DOC_ONLY
    LoyaltyAccountDeletedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the Square seller associated with the event.
        type:
          type: string
          description: The type of event. For this event, the value is `loyalty.account.deleted`.
        event_id:
          type: string
          description: |-
            The unique ID for the event, which is used for
            [idempotency support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices).
        created_at:
          type: string
          description: The timestamp of when the webhook event was created, in RFC
            3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/LoyaltyAccountDeletedWebhookData'
      description: Published when a [loyalty account](entity:LoyaltyAccount) is deleted.
      example:
        merchant_id: C337NFWQT2A6W
        type: loyalty.account.deleted
        event_id: 7c365846-a64b-40ba-a406-8a0354a63d79
        created_at: 2020-05-13T01:50:45.656Z
        data:
          type: loyalty
          id: ba2f8ab6-e131-46d9-9882-17714404eb49
          object:
            loyalty_account:
              id: ba2f8ab6-e131-46d9-9882-17714404eb49
              program_id: 5216e8b2-d43e-41e2-9ed8-eccf3e892aef
              balance: 10
              lifetime_points: 10
              mapping:
                created_at: 2020-05-13T01:41:34Z
                id: 664c22ba-9460-45a5-8917-381ae72dcfdc
                phone_number: +14155551234
              customer_id: QPTXM8PQNX3Q726ZYHPMNP46XC
              enrolled_at: 2020-05-13T01:41:34Z
              created_at: 2020-05-13T01:41:34Z
              updated_at: 2020-05-13T01:41:34Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/loyalty/loyalty-account-deleted-webhook.proto
      x-proto-sha: 7001993db131fffee10de86140dd24c499b4f3ee
      x-object-name: LoyaltyAccountDeletedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: loyalty.account.deleted
        scopes:
        - LOYALTY_READ
      x-api: '#/components/x-apis/Loyalty'
      x-since: 2020-05-28
      x-contains-pii: true
    LoyaltyAccountDeletedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: The type of object affected by the event. For this event, the
            value is `loyalty.account`.
        id:
          type: string
          description: The ID of the affected loyalty account.
        object:
          $ref: '#/components/schemas/LoyaltyAccount'
      description: The data associated with a `loyalty.account.deleted` webhook event.
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/loyalty/loyalty-account-deleted-webhook.proto
      x-proto-sha: 7001993db131fffee10de86140dd24c499b4f3ee
      x-object-name: LoyaltyAccountDeletedWebhookData
      x-visibility: DOC_ONLY
    LoyaltyAccountUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the Square seller associated with the event.
        type:
          type: string
          description: The type of event. For this event, the value is `loyalty.account.updated`.
        event_id:
          type: string
          description: |-
            The unique ID for the event, which is used for
            [idempotency support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices).
        created_at:
          type: string
          description: The timestamp of when the webhook event was created, in RFC
            3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/LoyaltyAccountUpdatedWebhookData'
      description: Published when a [loyalty account](entity:LoyaltyAccount) is updated.
      example:
        merchant_id: C337NFWQT2A6W
        type: loyalty.account.updated
        event_id: 3ca83966-230e-4a61-8484-22ea749ea765
        created_at: 2020-05-13T01:46:58.794Z
        data:
          type: loyalty
          id: ba2f8ab6-e131-46d9-9882-17714404eb49
          object:
            loyalty_account:
              id: ba2f8ab6-e131-46d9-9882-17714404eb49
              program_id: 5216e8b2-d43e-41e2-9ed8-eccf3e892aef
              balance: 10
              lifetime_points: 10
              mapping:
                created_at: 2020-05-13T01:41:34Z
                id: 664c22ba-9460-45a5-8917-381ae72dcfdc
                phone_number: +14155551234
              customer_id: QPTXM8PQNX3Q726ZYHPMNP46XC
              enrolled_at: 2020-05-13T01:41:34Z
              created_at: 2020-05-13T01:41:34Z
              updated_at: 2020-05-13T01:41:34Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/loyalty/loyalty-account-updated-webhook.proto
      x-proto-sha: 7001993db131fffee10de86140dd24c499b4f3ee
      x-object-name: LoyaltyAccountUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: loyalty.account.updated
        scopes:
        - LOYALTY_READ
      x-api: '#/components/x-apis/Loyalty'
      x-since: 2020-05-28
      x-contains-pii: true
    LoyaltyAccountUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: The type of object affected by the event. For this event, the
            value is `loyalty.account`.
        id:
          type: string
          description: The ID of the affected loyalty account.
        object:
          $ref: '#/components/schemas/LoyaltyAccount'
      description: The data associated with a `loyalty.account.updated` webhook event.
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/loyalty/loyalty-account-updated-webhook.proto
      x-proto-sha: 7001993db131fffee10de86140dd24c499b4f3ee
      x-object-name: LoyaltyAccountUpdatedWebhookData
      x-visibility: DOC_ONLY
    LoyaltyEventCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the Square seller associated with the event.
        type:
          type: string
          description: The type of event. For this event, the value is `loyalty.event.created`.
        event_id:
          type: string
          description: |-
            The unique ID for the event, which is used for
            [idempotency support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices).
        created_at:
          type: string
          description: The timestamp of when the webhook event was created, in RFC
            3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/LoyaltyEventCreatedWebhookData'
      description: Published when a [loyalty event](entity:LoyaltyEvent) is created.
      example:
        merchant_id: C337NFWQT2A6W
        type: loyalty.event.created
        event_id: f151e2c6-9340-4cca-9d37-1bcd1c2d6a0d
        created_at: 2020-05-13T01:46:58.783Z
        data:
          type: loyalty
          id: iirpaae81f66e-a7ea-4fcf-a04f-f0d29fdc60e6
          object:
            loyalty_event:
              id: d0bd89a5-3d04-389e-a54b-4e509658fe41
              location_id: 2Z3BMKQB939X0
              loyalty_account_id: ba2f8ab6-e131-46d9-9882-17714404eb49
              source: SQUARE
              type: ADJUST_POINTS
              adjust_points:
                loyalty_program_id: 5216e8b2-d43e-41e2-9ed8-eccf3e892aef
                points: 10
              created_at: 2020-05-13T01:46:58Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/loyalty/loyalty-event-created-webhook.proto
      x-proto-sha: 7001993db131fffee10de86140dd24c499b4f3ee
      x-object-name: LoyaltyEventCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: loyalty.event.created
        scopes:
        - LOYALTY_READ
      x-api: '#/components/x-apis/Loyalty'
      x-since: 2020-05-28
      x-contains-pii: false
    LoyaltyEventCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: The type of object affected by the event. For this event, the
            value is `loyalty.event`.
        id:
          type: string
          description: ID of the affected loyalty event.
        object:
          $ref: '#/components/schemas/LoyaltyEvent'
      description: The data associated with a `loyalty.event.created` webhook event.
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/loyalty/loyalty-event-created-webhook.proto
      x-proto-sha: 7001993db131fffee10de86140dd24c499b4f3ee
      x-object-name: LoyaltyEventCreatedWebhookData
      x-visibility: DOC_ONLY
    LoyaltyProgramCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the Square seller associated with the event.
        type:
          type: string
          description: The type of event. For this event, the value is `loyalty.program.created`.
        event_id:
          type: string
          description: |-
            The unique ID for the event, which is used for
            [idempotency support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices).
        created_at:
          type: string
          description: The timestamp of when the webhook event was created, in RFC
            3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/LoyaltyProgramCreatedWebhookData'
      description: Published when a [loyalty program](entity:LoyaltyProgram) is created.
      example:
        merchant_id: C337NFWQT2A6W
        type: loyalty.program.created
        event_id: b10404b2-08c4-4c66-9299-c11feceb43dd
        created_at: 2020-05-13T01:38:42.785Z
        data:
          type: loyalty
          id: 5216e8b2-d43e-41e2-9ed8-eccf3e892aef
          object:
            loyalty_program:
              id: 5216e8b2-d43e-41e2-9ed8-eccf3e892aef
              location_ids:
              - 2Z3BMKQB939X0
              status: ACTIVE
              terminology:
                one: Point
                other: Points
              accrual_rules:
              - accrual_type: SPEND
                points: 1
                spend_data:
                  amount_money:
                    amount: 100
                    currency: USD
                  tax_mode: BEFORE_TAX
              reward_tiers:
              - id: 927cab58-09cd-410f-aa68-a44015d8bbbb
                name: 5% off entire sale
                points: 5
                definition:
                  discount_type: FIXED_PERCENTAGE
                  percentage_discount: "5"
                  scope: ORDER
                created_at: 2019-08-19T18:22:45Z
                pricing_rule_reference:
                  object_id: ZKFKBH5IINTZLY3VA2OWIFX3
                  catalog_version: "1603960067138"
              - id: aa5373ef-191d-4cb5-b122-8e8de41ab32f
                name: 20% off entire sale
                points: 15
                definition:
                  discount_type: FIXED_PERCENTAGE
                  percentage_discount: "20"
                  scope: ORDER
                created_at: 2020-05-13T01:38:40Z
                pricing_rule_reference:
                  object_id: 74C4JSHESNLTB2A7ITO5HO6F
                  catalog_version: "1605486402527"
              created_at: 2019-08-19T18:22:46Z
              updated_at: 2020-05-13T01:38:40Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/loyalty/loyalty-program-created-webhook.proto
      x-proto-sha: 7001993db131fffee10de86140dd24c499b4f3ee
      x-object-name: LoyaltyProgramCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: loyalty.program.created
        scopes:
        - LOYALTY_READ
      x-api: '#/components/x-apis/Loyalty'
      x-since: 2021-04-21
      x-contains-pii: false
    LoyaltyProgramCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: The type of object affected by the event. For this event, the
            value is `loyalty.program`.
        id:
          type: string
          description: The ID of the created loyalty program.
        object:
          $ref: '#/components/schemas/LoyaltyProgramCreatedWebhookObject'
      description: The data associated with a `loyalty.program.created` webhook event.
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/loyalty/loyalty-program-created-webhook.proto
      x-proto-sha: 7001993db131fffee10de86140dd24c499b4f3ee
      x-object-name: LoyaltyProgramCreatedWebhookData
      x-visibility: DOC_ONLY
    LoyaltyProgramCreatedWebhookObject:
      type: object
      properties:
        loyalty_program:
          $ref: '#/components/schemas/LoyaltyProgram'
      description: An object that contains the loyalty program associated with a `loyalty.program.created`
        webhook event.
      x-property-order:
      - loyalty_program
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/loyalty/loyalty-program-created-webhook.proto
      x-proto-sha: 7001993db131fffee10de86140dd24c499b4f3ee
      x-object-name: LoyaltyProgramCreatedWebhookObject
      x-visibility: DOC_ONLY
    LoyaltyProgramUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the Square seller associated with the event.
        type:
          type: string
          description: The type of event. For this event, the value is `loyalty.program.updated`.
        event_id:
          type: string
          description: |-
            The unique ID for the event, which is used for
            [idempotency support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices).
        created_at:
          type: string
          description: The timestamp of when the webhook event was created, in RFC
            3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/LoyaltyProgramUpdatedWebhookData'
      description: Published when a [loyalty program](entity:LoyaltyProgram) is updated.
      example:
        merchant_id: C337NFWQT2A6W
        type: loyalty.program.updated
        event_id: b10404b2-08c4-4c66-9299-c11feceb43dd
        created_at: 2020-05-13T01:38:42.785Z
        data:
          type: loyalty
          id: 5216e8b2-d43e-41e2-9ed8-eccf3e892aef
          object:
            loyalty_program:
              id: 5216e8b2-d43e-41e2-9ed8-eccf3e892aef
              location_ids:
              - 2Z3BMKQB939X0
              status: ACTIVE
              terminology:
                one: Point
                other: Points
              accrual_rules:
              - accrual_type: SPEND
                points: 1
                spend_data:
                  amount_money:
                    amount: 100
                    currency: USD
                  tax_mode: BEFORE_TAX
              reward_tiers:
              - id: 927cab58-09cd-410f-aa68-a44015d8bbbb
                name: 5% off entire sale
                points: 5
                definition:
                  discount_type: FIXED_PERCENTAGE
                  percentage_discount: "5"
                  scope: ORDER
                created_at: 2019-08-19T18:22:45Z
                pricing_rule_reference:
                  object_id: ZKFKBH5IINTZLY3VA2OWIFX3
                  catalog_version: "1603960067138"
              - id: aa5373ef-191d-4cb5-b122-8e8de41ab32f
                name: 20% off entire sale
                points: 15
                definition:
                  discount_type: FIXED_PERCENTAGE
                  percentage_discount: "20"
                  scope: ORDER
                created_at: 2020-05-13T01:38:40Z
                pricing_rule_reference:
                  object_id: 74C4JSHESNLTB2A7ITO5HO6F
                  catalog_version: "1605486402527"
              created_at: 2019-08-19T18:22:46Z
              updated_at: 2020-05-13T01:38:40Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/loyalty/loyalty-program-updated-webhook.proto
      x-proto-sha: 7001993db131fffee10de86140dd24c499b4f3ee
      x-object-name: LoyaltyProgramUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: loyalty.program.updated
        scopes:
        - LOYALTY_READ
      x-api: '#/components/x-apis/Loyalty'
      x-since: 2020-05-28
      x-contains-pii: false
    LoyaltyProgramUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: The type of object affected by the event. For this event, the
            value is `loyalty.program`.
        id:
          type: string
          description: The ID of the affected loyalty program.
        object:
          $ref: '#/components/schemas/LoyaltyProgram'
      description: The data associated with a `loyalty.program.updated` webhook event.
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/loyalty/loyalty-program-updated-webhook.proto
      x-proto-sha: 7001993db131fffee10de86140dd24c499b4f3ee
      x-object-name: LoyaltyProgramUpdatedWebhookData
      x-visibility: DOC_ONLY
    LoyaltyPromotionCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the Square seller associated with the event.
        type:
          type: string
          description: The type of event. For this event, the value is `loyalty.promotion.created`.
        event_id:
          type: string
          description: |-
            The unique ID for the event, which is used for
            [idempotency support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices).
        created_at:
          type: string
          description: The timestamp of when the webhook event was created, in RFC
            3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/LoyaltyPromotionCreatedWebhookData'
      description: Published when a [loyalty promotion](entity:LoyaltyPromotion) is
        created.
      example:
        merchant_id: C337NFWQT2A6W
        type: loyalty.promotion.created
        event_id: 875f2038-6015-492e-9f29-d040b3809e49
        created_at: 2022-06-03T01:41:34Z
        data:
          type: loyalty.promotion
          id: ba2f8ab6-e131-46d9-9882-17714404eb49
          object:
            loyalty_promotion:
              id: loypromo_ba2f8ab6-e131-46d9-9882-17714404eb49
              name: Happy Hour
              incentive:
                type: POINTS_ADDITION
                points_addition_data:
                  points_addition: 5
              available_time:
                start_date: 2022-06-06
                time_periods:
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220612T090000
                  DURATION:PT8H
                  RRULE:FREQ=WEEKLY;BYDAY=SU
                  END:VEVENT
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220606T090000
                  DURATION:PT8H
                  RRULE:FREQ=WEEKLY;BYDAY=MO
                  END:VEVENT
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220607T090000
                  DURATION:PT8H
                  RRULE:FREQ=WEEKLY;BYDAY=TU
                  END:VEVENT
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220608T090000
                  DURATION:PT8H
                  RRULE:FREQ=WEEKLY;BYDAY=WE
                  END:VEVENT
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220609T090000
                  DURATION:PT8H
                  RRULE:FREQ=WEEKLY;BYDAY=TH
                  END:VEVENT
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220610T090000
                  DURATION:PT8H
                  RRULE:FREQ=WEEKLY;BYDAY=FR
                  END:VEVENT
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220611T090000
                  DURATION:PT8H
                  RRULE:FREQ=WEEKLY;BYDAY=SA
                  END:VEVENT
              status: SCHEDULED
              created_at: 2022-06-03T01:41:34Z
              updated_at: 2022-06-03T01:41:34Z
              loyalty_program_id: 5216e8b2-d43e-41e2-9ed8-eccf3e892aef
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/loyalty/loyalty-promotion-created-webhook.proto
      x-proto-sha: 7001993db131fffee10de86140dd24c499b4f3ee
      x-object-name: LoyaltyPromotionCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: loyalty.promotion.created
        scopes:
        - LOYALTY_READ
      x-api: '#/components/x-apis/Loyalty'
      x-since: 2022-08-17
      x-contains-pii: false
    LoyaltyPromotionCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: The type of object affected by the event. For this event, the
            value is `loyalty.promotion`.
        id:
          type: string
          description: The ID of the affected loyalty promotion.
        object:
          $ref: '#/components/schemas/LoyaltyPromotion'
      description: The data associated with a `loyalty.promotion.created` webhook
        event.
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/loyalty/loyalty-promotion-created-webhook.proto
      x-proto-sha: 7001993db131fffee10de86140dd24c499b4f3ee
      x-object-name: LoyaltyPromotionCreatedWebhookData
      x-visibility: DOC_ONLY
    LoyaltyPromotionUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the Square seller associated with the event.
        type:
          type: string
          description: The type of event. For this event, the value is `loyalty.promotion.updated`.
        event_id:
          type: string
          description: |-
            The unique ID for the event, which is used for
            [idempotency support](https://developer.squareup.com/docs/webhooks/step4manage#webhooks-best-practices).
        created_at:
          type: string
          description: The timestamp of when the event was created, in RFC 3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/LoyaltyPromotionUpdatedWebhookData'
      description: |-
        Published when a [loyalty promotion](entity:LoyaltyPromotion) is updated. This event is
        invoked only when a loyalty promotion is canceled.
      example:
        merchant_id: C337NFWQT2A6W
        type: loyalty.promotion.updated
        event_id: 875f2038-6015-492e-9f29-d040b3809e49
        created_at: 2022-07-14T01:23:45Z
        data:
          type: loyalty.promotion
          id: ba2f8ab6-e131-46d9-9882-17714404eb49
          object:
            loyalty_promotion:
              id: loypromo_ba2f8ab6-e131-46d9-9882-17714404eb49
              name: Happy Hour
              incentive:
                type: POINTS_ADDITION
                points_addition_data:
                  points_addition: 5
              available_time:
                start_date: 2022-06-06
                time_periods:
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220612T090000
                  DURATION:PT8H
                  RRULE:FREQ=WEEKLY;BYDAY=SU
                  END:VEVENT
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220606T090000
                  DURATION:PT8H
                  RRULE:FREQ=WEEKLY;BYDAY=MO
                  END:VEVENT
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220607T090000
                  DURATION:PT8H
                  RRULE:FREQ=WEEKLY;BYDAY=TU
                  END:VEVENT
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220608T090000
                  DURATION:PT8H
                  RRULE:FREQ=WEEKLY;BYDAY=WE
                  END:VEVENT
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220609T090000
                  DURATION:PT8H
                  RRULE:FREQ=WEEKLY;BYDAY=TH
                  END:VEVENT
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220610T090000
                  DURATION:PT8H
                  RRULE:FREQ=WEEKLY;BYDAY=FR
                  END:VEVENT
                - |-
                  BEGIN:VEVENT
                  DTSTART:20220611T090000
                  DURATION:PT8H
                  RRULE:FREQ=WEEKLY;BYDAY=SA
                  END:VEVENT
              status: CANCELED
              created_at: 2022-06-03T01:41:34Z
              canceled_at: 2022-07-14T01:23:45Z
              updated_at: 2022-07-14T01:23:45Z
              loyalty_program_id: 5216e8b2-d43e-41e2-9ed8-eccf3e892aef
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/loyalty/loyalty-promotion-updated-webhook.proto
      x-proto-sha: 7001993db131fffee10de86140dd24c499b4f3ee
      x-object-name: LoyaltyPromotionUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: loyalty.promotion.updated
        scopes:
        - LOYALTY_READ
      x-api: '#/components/x-apis/Loyalty'
      x-since: 2022-08-17
      x-contains-pii: false
    LoyaltyPromotionUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: The type of object affected by the event. For this event, the
            value is `loyalty.promotion`.
        id:
          type: string
          description: The ID of the affected loyalty promotion.
        object:
          $ref: '#/components/schemas/LoyaltyPromotion'
      description: The data associated with a `loyalty.promotion.updated` webhook
        event.
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/loyalty/loyalty-promotion-updated-webhook.proto
      x-proto-sha: 7001993db131fffee10de86140dd24c499b4f3ee
      x-object-name: LoyaltyPromotionUpdatedWebhookData
      x-visibility: DOC_ONLY
    OauthAuthorizationRevokedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"oauth.authorization.revoked"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/OauthAuthorizationRevokedWebhookData'
      description: Published when a merchant/application revokes all access tokens
        and refresh tokens granted to an application.
      example:
        merchant_id: J9Z30SF99NPFJ
        type: oauth.authorization.revoked
        event_id: e1d6ae37-5aa9-45a5-b525-b12caf819fdb
        created_at: 2020-08-14T15:51:04.246373287Z
        data:
          type: revocation
          id: 415641cf-eba2-4dfa-88cc-c4be1301fdc6
          object:
            revocation:
              revoked_at: 2020-08-14T15:51:00.246373287Z
              revoker_type: MERCHANT
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/oauth/oauth-authorization-revoked-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: OauthAuthorizationRevokedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: oauth.authorization.revoked
      x-api: '#/components/x-apis/OAuth'
      x-since: 2020-08-26
      x-contains-pii: false
    OauthAuthorizationRevokedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"revocation"`.
        id:
          type: string
          description: Not applicable, revocation is not an object
        object:
          $ref: '#/components/schemas/OauthAuthorizationRevokedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/oauth/oauth-authorization-revoked-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: OauthAuthorizationRevokedWebhookData
      x-visibility: DOC_ONLY
    OauthAuthorizationRevokedWebhookObject:
      type: object
      properties:
        revocation:
          $ref: '#/components/schemas/OauthAuthorizationRevokedWebhookRevocationObject'
      x-property-order:
      - revocation
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/oauth/oauth-authorization-revoked-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: OauthAuthorizationRevokedWebhookObject
      x-visibility: DOC_ONLY
    OauthAuthorizationRevokedWebhookRevocationObject:
      type: object
      properties:
        revoked_at:
          type: string
          description: Timestamp of when the revocation event occurred, in RFC 3339
            format.
        revoker_type:
          $ref: '#/components/schemas/OauthAuthorizationRevokedWebhookRevokerType'
      x-property-order:
      - revoked_at
      - revoker_type
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/oauth/oauth-authorization-revoked-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: OauthAuthorizationRevokedWebhookRevocationObject
      x-visibility: DOC_ONLY
    OrderCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"order.created"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/OrderCreatedWebhookData'
      description: |-
        Published when an [Order](entity:Order) is created. This event is
        triggered only by the [CreateOrder](api-endpoint:Orders-CreateOrder) endpoint call.

        Creating an order in the Point of Sale app will **not** publish this event.
      example:
        merchant_id: 5S9MXCS9Y99KK
        type: order.created
        event_id: 116038d3-2948-439f-8679-fc86dbf80f69
        created_at: 2020-04-16T23:14:26.129Z
        data:
          type: order
          id: eA3vssLHKJrv9H0IdJCM3gNqfdcZY
          object:
            order_created:
              created_at: 2020-04-16T23:14:26.129Z
              location_id: FPYCBCHYMXFK1
              order_id: eA3vssLHKJrv9H0IdJCM3gNqfdcZY
              state: OPEN
              version: 1
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/orders/order-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: OrderCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: order.created
        scopes:
        - ORDERS_READ
      x-api: '#/components/x-apis/Orders'
      x-since: 2020-04-22
      x-contains-pii: false
    OrderCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"order"`.
        id:
          type: string
          description: ID of the affected order.
        object:
          $ref: '#/components/schemas/OrderCreatedObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/orders/order-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: OrderCreatedWebhookData
      x-visibility: DOC_ONLY
    OrderFulfillmentUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"order.fulfillment.updated"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/OrderFulfillmentUpdatedWebhookData'
      description: |-
        Published when an [OrderFulfillment](entity:OrderFulfillment)
        is created or updated. This event is triggered only by the
        [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint call.
      example:
        merchant_id: 5S9MXCS9Y99KK
        type: order.fulfillment.updated
        event_id: b3adf364-4937-436e-a833-49c72b4baee8
        created_at: 2020-04-16T23:16:30.789Z
        data:
          type: order
          id: eA3vssLHKJrv9H0IdJCM3gNqfdcZY
          object:
            order_fulfillment_updated:
              created_at: 2020-04-16T23:14:26.129Z
              fulfillment_update:
              - fulfillment_uid: VWJ1N9leLqjSDLvF2hvYjD
                new_state: RESERVED
                old_state: PROPOSED
              location_id: FPYCBCHYMXFK1
              order_id: eA3vssLHKJrv9H0IdJCM3gNqfdcZY
              state: OPEN
              updated_at: 2020-04-16T23:16:30.789Z
              version: 6
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/orders/order-fulfillment-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: OrderFulfillmentUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: order.fulfillment.updated
        scopes:
        - ORDERS_READ
      x-api: '#/components/x-apis/Orders'
      x-since: 2020-04-22
      x-contains-pii: false
    OrderFulfillmentUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"order"`.
        id:
          type: string
          description: ID of the affected order.
        object:
          $ref: '#/components/schemas/OrderFulfillmentUpdatedObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/orders/order-fulfillment-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: OrderFulfillmentUpdatedWebhookData
      x-visibility: DOC_ONLY
    OrderUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"order.updated"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/OrderUpdatedWebhookData'
      description: |-
        Published when an [Order](entity:Order) is updated. This
        event is triggered only by the [UpdateOrder](api-endpoint:Orders-CreateOrder)
        endpoint call.
      example:
        merchant_id: 5S9MXCS9Y99KK
        type: order.updated
        event_id: 4b8e5c91-9f17-4cf1-900a-4a0629f81add
        created_at: 2020-04-16T23:14:26.359Z
        data:
          type: order
          id: eA3vssLHKJrv9H0IdJCM3gNqfdcZY
          object:
            order_updated:
              created_at: 2020-04-16T23:14:26.129Z
              location_id: FPYCBCHYMXFK1
              order_id: eA3vssLHKJrv9H0IdJCM3gNqfdcZY
              state: OPEN
              updated_at: 2020-04-16T23:14:26.359Z
              version: 2
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/orders/order-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: OrderUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: order.updated
        scopes:
        - ORDERS_READ
      x-api: '#/components/x-apis/Orders'
      x-since: 2020-04-22
      x-contains-pii: false
    OrderUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"order"`.
        id:
          type: string
          description: ID of the affected order.
        object:
          $ref: '#/components/schemas/OrderUpdatedObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/orders/order-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: OrderUpdatedWebhookData
      x-visibility: DOC_ONLY
    PaymentCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"payment.created"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/PaymentCreatedWebhookData'
      description: Published when a [Payment](entity:Payment) is created.
      example:
        merchant_id: 6SSW7HV8K2ST5
        type: payment.created
        event_id: 13b867cf-db3d-4b1c-90b6-2f32a9d78124
        created_at: 2020-02-06T21:27:30.792Z
        data:
          type: payment
          id: KkAkhdMsgzn59SM8A89WgKwekxLZY
          object:
            payment:
              id: hYy9pRFVxpDsO1FB05SunFWUe9JZY
              created_at: 2020-11-22T21:16:51.086Z
              updated_at: 2020-11-22T21:16:51.198Z
              amount_money:
                amount: 100
                currency: USD
              status: APPROVED
              delay_duration: PT168H
              source_type: CARD
              card_details:
                status: AUTHORIZED
                card:
                  card_brand: MASTERCARD
                  last_4: "9029"
                  exp_month: 11
                  exp_year: 2022
                  fingerprint: sq-1-Tvruf3vPQxlvI6n0IcKYfBukrcv6IqWr8UyBdViWXU2yzGn5VMJvrsHMKpINMhPmVg
                  card_type: CREDIT
                  prepaid_type: NOT_PREPAID
                  bin: "540988"
                entry_method: KEYED
                cvv_status: CVV_ACCEPTED
                avs_status: AVS_ACCEPTED
                statement_description: SQ *DEFAULT TEST ACCOUNT
                card_payment_timeline:
                  authorized_at: 2020-11-22T21:16:51.198Z
              location_id: S8GWD5R9QB376
              order_id: 03O3USaPaAaFnI6kkwB1JxGgBsUZY
              risk_evaluation:
                created_at: 2020-11-22T21:16:51.198Z
                risk_level: NORMAL
              total_money:
                amount: 100
                currency: USD
              approved_money:
                amount: 100
                currency: USD
              capabilities:
              - EDIT_TIP_AMOUNT
              - EDIT_TIP_AMOUNT_UP
              - EDIT_TIP_AMOUNT_DOWN
              receipt_number: hYy9
              delay_action: CANCEL
              delayed_until: 2020-11-29T21:16:51.086Z
              version_token: FfQhQJf9r3VSQIgyWBk1oqhIwiznLwVwJbVVA0bdyEv6o
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/payments/payment-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: PaymentCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: payment.created
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Payments'
      x-since: 2020-02-26
      x-contains-pii: true
    PaymentCreatedWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: Name of the affected object’s type, `"payment"`.
        id:
          maxLength: 192
          type: string
          description: ID of the affected payment.
        object:
          $ref: '#/components/schemas/PaymentCreatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/payments/payment-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: PaymentCreatedWebhookData
      x-visibility: DOC_ONLY
    PaymentCreatedWebhookObject:
      type: object
      properties:
        payment:
          $ref: '#/components/schemas/Payment'
      x-property-order:
      - payment
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/payments/payment-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: PaymentCreatedWebhookObject
      x-visibility: DOC_ONLY
    PaymentUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"payment.updated"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/PaymentUpdatedWebhookData'
      description: |-
        Published when a [Payment](entity:Payment) is updated.
        Typically the `payment.status`, or `card_details.status` fields are updated
        as a payment is canceled, authorized, or completed.
      example:
        merchant_id: 6SSW7HV8K2ST5
        type: payment.updated
        event_id: 6a8f5f28-54a1-4eb0-a98a-3111513fd4fc
        created_at: 2020-02-06T21:27:34.308Z
        data:
          type: payment
          id: KkAkhdMsgzn59SM8A89WgKwekxLZY
          object:
            payment:
              id: hYy9pRFVxpDsO1FB05SunFWUe9JZY
              created_at: 2020-11-22T21:16:51.086Z
              updated_at: 2020-11-22T21:19:00.831Z
              amount_money:
                amount: 100
                currency: USD
              status: COMPLETED
              delay_duration: PT168H
              source_type: CARD
              card_details:
                status: CAPTURED
                card:
                  card_brand: MASTERCARD
                  last_4: "9029"
                  exp_month: 11
                  exp_year: 2022
                  fingerprint: sq-1-Tvruf3vPQxlvI6n0IcKYfBukrcv6IqWr8UyBdViWXU2yzGn5VMJvrsHMKpINMhPmVg
                  card_type: CREDIT
                  prepaid_type: NOT_PREPAID
                  bin: "540988"
                entry_method: KEYED
                cvv_status: CVV_ACCEPTED
                avs_status: AVS_ACCEPTED
                statement_description: SQ *DEFAULT TEST ACCOUNT
                card_payment_timeline:
                  authorized_at: 2020-11-22T21:16:51.198Z
                  captured_at: 2020-11-22T21:19:00.832Z
              location_id: S8GWD5R9QB376
              order_id: 03O3USaPaAaFnI6kkwB1JxGgBsUZY
              risk_evaluation:
                created_at: 2020-11-22T21:16:51.198Z
                risk_level: NORMAL
              total_money:
                amount: 100
                currency: USD
              approved_money:
                amount: 100
                currency: USD
              receipt_number: hYy9
              receipt_url: https://squareup.com/receipt/preview/hYy9pRFVxpDsO1FB05SunFWU11111
              delay_action: CANCEL
              delayed_until: 2020-11-29T21:16:51.086Z
              version_token: bhC3b8qKJvNDdxqKzXaeDsAjS1oMFuAKxGgT32HbE6S6o
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/payments/payment-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: PaymentUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: payment.updated
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Payments'
      x-since: 2020-02-26
      x-contains-pii: true
    PaymentUpdatedWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: Name of the affected object’s type, `"payment"`.
        id:
          maxLength: 192
          type: string
          description: ID of the affected payment.
        object:
          $ref: '#/components/schemas/PaymentUpdatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/payments/payment-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: PaymentUpdatedWebhookData
      x-visibility: DOC_ONLY
    PaymentUpdatedWebhookObject:
      type: object
      properties:
        payment:
          $ref: '#/components/schemas/Payment'
      x-property-order:
      - payment
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/payments/payment-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: PaymentUpdatedWebhookObject
      x-visibility: DOC_ONLY
    PayoutFailedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the target location associated with the event.
        type:
          type: string
          description: The type of event that this represents, `payout.failed`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: The timestamp of when the webhook event was verified, in RFC
            3339 format.
          readOnly: true
        data:
          $ref: '#/components/schemas/PayoutFailedWebhookData'
      description: Published when a [Payout](entity:Payout) has failed.
      example:
        merchant_id: MLEWJTMNJN37Z
        location_id: LRJNZCB190DTQ
        type: payout.failed
        event_id: 7116e4a4-7622-42b0-b16c-c164d7ec7302
        created_at: 1970-01-01T00:20:28.481Z
        data:
          type: payout
          id: po_070431e4-e351-11eb-a8bb-02420a140009
          object:
            payout:
              amount_money:
                amount: 457
                currency_code: EUR
              arrival_date: 2021-07-13
              created_at: 2021-07-12T20:37:51Z
              destination:
                id: bact:c164d7ec7302
                type: BANK_ACCOUNT
              id: po_070431e4-e351-11eb-a8bb-02420a140009
              location_id: LRJNZCB190DTQ
              status: FAILED
              type: BATCH
              updated_at: 1970-01-01T00:20:28.481Z
              version: 2
      x-property-order:
      - merchant_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/payouts/payout-failed-webhook.proto
      x-proto-sha: 6d6f3fa7a7ad599d43224ff934a9f5d75d047dd8
      x-object-name: PayoutFailedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: payout.failed
        scopes:
        - PAYOUTS_READ
        - SETTLEMENTS_READ
      x-api: '#/components/x-apis/Payouts'
      x-since: 2022-04-20
      x-contains-pii: false
    PayoutFailedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: The name of the affected object's type, `payout`.
        id:
          type: string
          description: The ID of the failed payout.
        object:
          $ref: '#/components/schemas/PayoutFailedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/payouts/payout-failed-webhook.proto
      x-proto-sha: 6d6f3fa7a7ad599d43224ff934a9f5d75d047dd8
      x-object-name: PayoutFailedWebhookData
      x-visibility: DOC_ONLY
    PayoutFailedWebhookObject:
      type: object
      properties:
        payout:
          $ref: '#/components/schemas/Payout'
      x-property-order:
      - payout
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/payouts/payout-failed-webhook.proto
      x-proto-sha: 6d6f3fa7a7ad599d43224ff934a9f5d75d047dd8
      x-object-name: PayoutFailedWebhookObject
      x-visibility: DOC_ONLY
    PayoutPaidWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the target location associated with the event.
        type:
          type: string
          description: The type of event this represents, `"payout.paid"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was verified, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/PayoutPaidWebhookData'
      description: Published when a [Payout](entity:Payout) is complete.
      example:
        merchant_id: MLEWJTMNJN37Z
        location_id: LRJNZCB190DTQ
        type: payout.paid
        event_id: 7116e4a4-7622-42b0-b16c-c164d7ec7302
        created_at: 1970-01-01T00:20:28.481Z
        data:
          type: payout
          id: po_070431e4-e351-11eb-a8bb-02420a140009
          object:
            payout:
              amount_money:
                amount: 457
                currency_code: EUR
              arrival_date: 2021-07-13
              created_at: 2021-07-12T20:37:51Z
              destination:
                id: bact:c164d7ec7302
                type: BANK_ACCOUNT
              id: po_070431e4-e351-11eb-a8bb-02420a140009
              location_id: LRJNZCB190DTQ
              status: PAID
              type: BATCH
              updated_at: 1970-01-01T00:20:28.481Z
              version: 2
      x-property-order:
      - merchant_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/payouts/payout-paid-webhook.proto
      x-proto-sha: 6d6f3fa7a7ad599d43224ff934a9f5d75d047dd8
      x-object-name: PayoutPaidWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: payout.paid
        scopes:
        - PAYOUTS_READ
        - SETTLEMENTS_READ
      x-api: '#/components/x-apis/Payouts'
      x-since: 2022-04-20
      x-contains-pii: false
    PayoutPaidWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"payout"`.
        id:
          type: string
          description: ID of the completed payout.
        object:
          $ref: '#/components/schemas/PayoutPaidWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/payouts/payout-paid-webhook.proto
      x-proto-sha: 6d6f3fa7a7ad599d43224ff934a9f5d75d047dd8
      x-object-name: PayoutPaidWebhookData
      x-visibility: DOC_ONLY
    PayoutPaidWebhookObject:
      type: object
      properties:
        payout:
          $ref: '#/components/schemas/Payout'
      x-property-order:
      - payout
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/payouts/payout-paid-webhook.proto
      x-proto-sha: 6d6f3fa7a7ad599d43224ff934a9f5d75d047dd8
      x-object-name: PayoutPaidWebhookObject
      x-visibility: DOC_ONLY
    PayoutSentWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        location_id:
          type: string
          description: The ID of the target location associated with the event.
        type:
          type: string
          description: The type of event this represents, `"payout.sent"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was verified, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/PayoutSentWebhookData'
      description: Published when a [Payout](entity:Payout) is sent.
      example:
        merchant_id: MLEWJTMNJN37Z
        location_id: LRJNZCB190DTQ
        type: payout.sent
        event_id: 7116e4a4-7622-42b0-b16c-c164d7ec7302
        created_at: 1970-01-01T00:20:28.481Z
        data:
          type: payout
          id: po_070431e4-e351-11eb-a8bb-02420a140009
          object:
            payout:
              amount_money:
                amount: 457
                currency_code: EUR
              arrival_date: 2021-07-13
              created_at: 2021-07-12T20:37:51Z
              destination:
                id: bact:c164d7ec7302
                type: BANK_ACCOUNT
              id: po_070431e4-e351-11eb-a8bb-02420a140009
              location_id: LRJNZCB190DTQ
              status: SENT
              type: BATCH
              updated_at: 1970-01-01T00:20:28.481Z
              version: 1
      x-property-order:
      - merchant_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/payouts/payout-sent-webhook.proto
      x-proto-sha: 6d6f3fa7a7ad599d43224ff934a9f5d75d047dd8
      x-object-name: PayoutSentWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: payout.sent
        scopes:
        - PAYOUTS_READ
        - SETTLEMENTS_READ
      x-api: '#/components/x-apis/Payouts'
      x-since: 2022-04-20
      x-contains-pii: false
    PayoutSentWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"payout"`.
        id:
          type: string
          description: ID of the sent payout.
        object:
          $ref: '#/components/schemas/PayoutSentWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/payouts/payout-sent-webhook.proto
      x-proto-sha: 6d6f3fa7a7ad599d43224ff934a9f5d75d047dd8
      x-object-name: PayoutSentWebhookData
      x-visibility: DOC_ONLY
    PayoutSentWebhookObject:
      type: object
      properties:
        payout:
          $ref: '#/components/schemas/Payout'
      x-property-order:
      - payout
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/payouts/payout-sent-webhook.proto
      x-proto-sha: 6d6f3fa7a7ad599d43224ff934a9f5d75d047dd8
      x-object-name: PayoutSentWebhookObject
      x-visibility: DOC_ONLY
    RefundCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"refund.created"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/RefundCreatedWebhookData'
      description: Published when a [Refund](entity:PaymentRefund) is created.
      example:
        merchant_id: 6SSW7HV8K2ST5
        type: refund.created
        event_id: bc316346-6691-4243-88ed-6d651a0d0c47
        created_at: 2020-02-06T21:27:41.852Z
        data:
          type: refund
          id: KkAkhdMsgzn59SM8A89WgKwekxLZY_ptNBVqHYxt5gAdfcobBe4u1AZsXhoz06KTtuq9Ls24P
          object:
            refund:
              id: KkAkhdMsgzn59SM8A89WgKwekxLZY_ptNBVqHYxt5gAdfcobBe4u1AZsXhoz06KTtuq9Ls24P
              created_at: 2020-02-06T21:27:41.836Z
              updated_at: 2020-02-06T21:27:41.846Z
              amount_money:
                amount: 1000
                currency: USD
              status: PENDING
              location_id: NAQ1FHV6ZJ8YV
              order_id: haOyDuHiqtAXMk0d8pDKXpL7Jg4F
              payment_id: KkAkhdMsgzn59SM8A89WgKwekxLZY
              version: 7
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/refunds/refund-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: RefundCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: refund.created
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Refunds'
      x-since: 2020-02-26
      x-contains-pii: true
    RefundCreatedWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: Name of the affected object’s type, `"refund"`.
        id:
          maxLength: 255
          type: string
          description: ID of the affected refund.
        object:
          $ref: '#/components/schemas/RefundCreatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/refunds/refund-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: RefundCreatedWebhookData
      x-visibility: DOC_ONLY
    RefundCreatedWebhookObject:
      type: object
      properties:
        refund:
          $ref: '#/components/schemas/PaymentRefund'
      x-property-order:
      - refund
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/refunds/refund-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: RefundCreatedWebhookObject
      x-visibility: DOC_ONLY
    RefundUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"refund.updated"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/RefundUpdatedWebhookData'
      description: |-
        Published when a [Refund](entity:PaymentRefund) is updated.
        Typically the `refund.status` changes when a refund is completed.
      example:
        merchant_id: 6SSW7HV8K2ST5
        type: refund.updated
        event_id: bc316346-6691-4243-88ed-6d651a0d0c47
        created_at: 2020-02-06T22:14:16.421Z
        data:
          type: refund
          id: KkAkhdMsgzn59SM8A89WgKwekxLZY_ptNBVqHYxt5gAdfcobBe4u1AZsXhoz06KTtuq9Ls24P
          object:
            refund:
              id: KkAkhdMsgzn59SM8A89WgKwekxLZY_ptNBVqHYxt5gAdfcobBe4u1AZsXhoz06KTtuq9Ls24P
              created_at: 2020-02-06T21:27:41.836Z
              updated_at: 2020-02-06T22:14:16.381Z
              amount_money:
                amount: 1000
                currency: USD
              status: COMPLETED
              processing_fee:
              - effective_at: 2020-02-06T23:27:31.000Z
                type: INITIAL
                amount_money:
                  amount: -59
                  currency: USD
              location_id: NAQ1FHV6ZJ8YV
              order_id: haOyDuHiqtAXMk0d8pDKXpL7Jg4F
              payment_id: KkAkhdMsgzn59SM8A89WgKwekxLZY
              version: 10
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/refunds/refund-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: RefundUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: refund.updated
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Refunds'
      x-since: 2020-02-26
      x-contains-pii: true
    RefundUpdatedWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: Name of the affected object’s type, `"refund"`.
        id:
          maxLength: 255
          type: string
          description: ID of the affected refund.
        object:
          $ref: '#/components/schemas/RefundUpdatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/refunds/refund-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: RefundUpdatedWebhookData
      x-visibility: DOC_ONLY
    RefundUpdatedWebhookObject:
      type: object
      properties:
        refund:
          $ref: '#/components/schemas/PaymentRefund'
      x-property-order:
      - refund
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/refunds/refund-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: RefundUpdatedWebhookObject
      x-visibility: DOC_ONLY
    SubscriptionCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"subscription.created"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/SubscriptionCreatedWebhookData'
      description: Published when a [Subscription](entity:Subscription) is created.
      example:
        merchant_id: VSE65BA53PXCC
        type: subscription.created
        event_id: 65bc2e81-bcdc-4add-abfd-7a012b8f3d2a
        created_at: 2020-07-15T05:14:11.002Z
        data:
          type: subscription
          id: 592b9720-d2ef-4ee4-b3fd-9d98e4f829d2
          object:
            subscription:
              id: 592b9720-d2ef-4ee4-b3fd-9d98e4f829d2
              created_date: 2020-07-15
              customer_id: QX2XG9GMQS2BVBJKPG8CJ8JKCR
              location_id: EZHGJ7SNVAJ19
              plan_id: CRUUZUK5W6PIIM6H54242NV6
              start_date: 2020-07-15
              status: ACTIVE
              tax_percentage: "5"
              timezone: America/New_York
              version: 1594790050754
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/subscriptions/subscription-created-webhook.proto
      x-proto-sha: 1e5caae96e403cd32f3995e098ceab6c9bfafc7a
      x-object-name: SubscriptionCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: subscription.created
        scopes:
        - SUBSCRIPTIONS_READ
      x-api: '#/components/x-apis/Subscriptions'
      x-since: 2020-08-12
      x-contains-pii: true
    SubscriptionCreatedWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: Name of the affected object’s type, `"subscription"`.
        id:
          maxLength: 255
          type: string
          description: ID of the affected subscription.
        object:
          $ref: '#/components/schemas/SubscriptionCreatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/subscriptions/subscription-created-webhook.proto
      x-proto-sha: 1e5caae96e403cd32f3995e098ceab6c9bfafc7a
      x-object-name: SubscriptionCreatedWebhookData
      x-visibility: DOC_ONLY
    SubscriptionCreatedWebhookObject:
      type: object
      properties:
        subscription:
          $ref: '#/components/schemas/Subscription'
      x-property-order:
      - subscription
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/subscriptions/subscription-created-webhook.proto
      x-proto-sha: 1e5caae96e403cd32f3995e098ceab6c9bfafc7a
      x-object-name: SubscriptionCreatedWebhookObject
      x-visibility: DOC_ONLY
    SubscriptionUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"subscription.updated"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/SubscriptionUpdatedWebhookData'
      description: |-
        Published when a [Subscription](entity:Subscription) is updated.
        Typically the `subscription.status` is updated as subscriptions become active
        or cancelled.
      example:
        merchant_id: VSE65BA53PXCC
        type: subscription.updated
        event_id: c0b40cc0-7cb2-4aa1-81ce-0893b9b0b9b8
        created_at: 2020-07-15T05:14:11.213Z
        data:
          type: subscription
          id: 592b9720-d2ef-4ee4-b3fd-9d98e4f829d2
          object:
            subscription:
              id: 592b9720-d2ef-4ee4-b3fd-9d98e4f829d2
              created_date: 2020-07-15
              customer_id: QX2XG9GMQS2BVBJKPG8CJ8JKCR
              location_id: EZHGJ7SNVAJ19
              plan_id: CRUUZUK5W6PIIM6H54242NV6
              start_date: 2020-07-15
              status: ACTIVE
              tax_percentage: "5"
              timezone: America/New_York
              version: 1594790050754
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/subscriptions/subscription-updated-webhook.proto
      x-proto-sha: 1e5caae96e403cd32f3995e098ceab6c9bfafc7a
      x-object-name: SubscriptionUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: subscription.updated
        scopes:
        - SUBSCRIPTIONS_READ
      x-api: '#/components/x-apis/Subscriptions'
      x-since: 2020-08-12
      x-contains-pii: true
    SubscriptionUpdatedWebhookData:
      type: object
      properties:
        type:
          maxLength: 50
          type: string
          description: Name of the affected object’s type, `"subscription"`.
        id:
          maxLength: 255
          type: string
          description: ID of the affected subscription.
        object:
          $ref: '#/components/schemas/SubscriptionUpdatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/subscriptions/subscription-updated-webhook.proto
      x-proto-sha: 1e5caae96e403cd32f3995e098ceab6c9bfafc7a
      x-object-name: SubscriptionUpdatedWebhookData
      x-visibility: DOC_ONLY
    SubscriptionUpdatedWebhookObject:
      type: object
      properties:
        subscription:
          $ref: '#/components/schemas/Subscription'
      x-property-order:
      - subscription
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/subscriptions/subscription-updated-webhook.proto
      x-proto-sha: 1e5caae96e403cd32f3995e098ceab6c9bfafc7a
      x-object-name: SubscriptionUpdatedWebhookObject
      x-visibility: DOC_ONLY
    TeamMemberCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"team_member.created"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/TeamMemberCreatedWebhookData'
      description: Published when a Team Member is created.
      example:
        merchant_id: 0JV5BGNW4EG9R
        type: team_member.created
        event_id: 91484f7e-63bc-4253-a86d-18e7ea0b0cfb
        created_at: 2021-03-11T01:16:04.253Z
        data:
          type: team_member
          id: TMfCNDbg_wwJvUJY
          object:
            team_member:
              assigned_locations:
                assignment_type: EXPLICIT_LOCATIONS
              created_at: 2021-03-11T01:16:03.697Z
              email_address: amelia.earhart@example.com
              family_name: Earhart
              given_name: Amelia
              id: TMfCNDbg_wwJvUJY
              is_owner: false
              phone_number: +12125554240
              reference_id: example-reference-id
              status: ACTIVE
              updated_at: 2021-03-11T01:16:03.697Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/team/team-member-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: TeamMemberCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: team_member.created
        scopes:
        - EMPLOYEES_READ
      x-api: '#/components/x-apis/Team'
      x-since: 2021-04-21
      x-contains-pii: true
    TeamMemberCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"team_member"`.
        id:
          type: string
          description: ID of the created team member.
        object:
          $ref: '#/components/schemas/TeamMemberCreatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/team/team-member-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: TeamMemberCreatedWebhookData
      x-visibility: DOC_ONLY
    TeamMemberCreatedWebhookObject:
      type: object
      properties:
        team_member:
          $ref: '#/components/schemas/TeamMember'
      x-property-order:
      - team_member
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/team/team-member-created-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: TeamMemberCreatedWebhookObject
      x-visibility: DOC_ONLY
    TeamMemberUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"team_member.updated"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/TeamMemberUpdatedWebhookData'
      description: Published when a Team Member is updated.
      example:
        merchant_id: 0JV5BGNW4EG9R
        type: team_member.updated
        event_id: 86c18838-51a7-4bdd-a6ff-3ffd2c1c5eb9
        created_at: 2021-03-11T01:16:04.254Z
        data:
          type: team_member
          id: TMfCNDbg_wwJvUJY
          object:
            team_member:
              assigned_locations:
                assignment_type: EXPLICIT_LOCATIONS
              created_at: 2021-03-11T01:16:03.697Z
              email_address: amelia.earhart@example.com
              family_name: Earhart
              given_name: Amelia
              id: TMfCNDbg_wwJvUJY
              is_owner: false
              phone_number: +12125554240
              reference_id: example-reference-id
              status: ACTIVE
              updated_at: 2021-03-11T01:16:03.697Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/team/team-member-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: TeamMemberUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: team_member.updated
        scopes:
        - EMPLOYEES_READ
      x-api: '#/components/x-apis/Team'
      x-since: 2021-04-21
      x-contains-pii: true
    TeamMemberUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"team_member"`.
        id:
          type: string
          description: ID of the affected team member.
        object:
          $ref: '#/components/schemas/TeamMemberUpdatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/team/team-member-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: TeamMemberUpdatedWebhookData
      x-visibility: DOC_ONLY
    TeamMemberUpdatedWebhookObject:
      type: object
      properties:
        team_member:
          $ref: '#/components/schemas/TeamMember'
      x-property-order:
      - team_member
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/team/team-member-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: TeamMemberUpdatedWebhookObject
      x-visibility: DOC_ONLY
    TeamMemberWageSettingUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"team_member.wage_setting.updated"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/TeamMemberWageSettingUpdatedWebhookData'
      description: Published when a Wage Setting is updated.
      example:
        merchant_id: 0JV5BGNW4EG9R
        type: team_member.wage_setting.updated
        event_id: 22ce9c01-d5bc-50ca-85f5-f97140537837
        created_at: 2021-03-11T01:17:03Z
        data:
          type: wage_setting
          id: TMfCNDbg_wwJvUJY
          object:
            wage_setting:
              created_at: 2021-03-11T01:17:02+00:00
              is_overtime_exempt: true
              job_assignments:
              - hourly_rate:
                  amount: 800
                  currency: USD
                job_title: Barista
                pay_type: HOURLY
              team_member_id: TMfCNDbg_wwJvUJY
              updated_at: 2021-03-11T01:17:03+00:00
              version: 1
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/team/team-member-wage-setting-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: TeamMemberWageSettingUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: team_member.wage_setting.updated
        scopes:
        - EMPLOYEES_READ
      x-api: '#/components/x-apis/Team'
      x-since: 2021-04-21
      x-contains-pii: true
    TeamMemberWageSettingUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type, `"wage_setting"`.
        id:
          type: string
          description: ID of the updated team member wage setting.
        object:
          $ref: '#/components/schemas/TeamMemberWageSettingUpdatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/team/team-member-wage-setting-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: TeamMemberWageSettingUpdatedWebhookData
      x-visibility: DOC_ONLY
    TeamMemberWageSettingUpdatedWebhookObject:
      type: object
      properties:
        wage_setting:
          $ref: '#/components/schemas/WageSetting'
      x-property-order:
      - wage_setting
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/team/team-member-wage-setting-updated-webhook.proto
      x-proto-sha: a576bdc78fff96c70dd33b68bf793fa7bb39f309
      x-object-name: TeamMemberWageSettingUpdatedWebhookObject
      x-visibility: DOC_ONLY
    TerminalActionCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"terminal.action.created"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: RFC 3339 timestamp of when the webhook event was created.
          readOnly: true
        data:
          $ref: '#/components/schemas/TerminalActionCreatedWebhookData'
      description: Published when a TerminalAction is created.
      example:
        merchant_id: MERCHANT_ID
        type: terminal.action.created
        event_id: 7229a692-def5-4a7e-b4f3-80638aa2f24d
        created_at: 2021-03-10T14:43:55.262Z
        data:
          type: action.event
          id: dhgENdnFOPXqO
          object:
            action:
              app_id: APP_ID
              created_at: 2021-03-10T14:43:55.262Z
              deadline_duration: PT5M
              device_id: DEVICE_ID
              id: termapia:jveJIAkkAjILHkdCE
              save_card_options:
                customer_id: CUSTOMER_ID
                reference_id: user-id-1
              status: PENDING
              type: SAVE_CARD
              updated_at: 2020-04-10T14:43:55.262Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-action-created-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalActionCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: terminal.action.created
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Terminal'
      x-since: 2022-05-12
      x-contains-pii: true
    TerminalActionCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the created object’s type, `"terminal.action"`.
        id:
          type: string
          description: ID of the created terminal action.
        object:
          $ref: '#/components/schemas/TerminalActionCreatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-action-created-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalActionCreatedWebhookData
      x-visibility: DOC_ONLY
    TerminalActionCreatedWebhookObject:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/TerminalAction'
      x-property-order:
      - action
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-action-created-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalActionCreatedWebhookObject
      x-visibility: DOC_ONLY
    TerminalActionUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"terminal.action.updated"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: RFC 3339 timestamp of when the webhook event was created.
          readOnly: true
        data:
          $ref: '#/components/schemas/TerminalActionUpdatedWebhookData'
      description: Published when a TerminalAction is updated.
      example:
        merchant_id: MERCHANT_ID
        type: terminal.action.updated
        event_id: 1c3ef831-670d-4f4c-b59c-f0bb2d2fc872
        created_at: 2021-03-10T14:44:06.039Z
        data:
          type: action.event
          id: dhgENdnFOPXqO
          object:
            action:
              app_id: APP_ID
              created_at: 2021-03-10T14:43:55.262Z
              deadline_duration: PT5M
              device_id: DEVICE_ID
              id: termapia:RZDei5nMuO0rMmCE
              save_card_options:
                customer_id: CUSTOMER_ID
                reference_id: user-id-1
                card_id: ccof:CARD_ID
              status: COMPLETED
              type: SAVE_CARD
              updated_at: 2021-03-10T14:44:55.262Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-action-updated-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalActionUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: terminal.action.updated
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Terminal'
      x-since: 2022-05-12
      x-contains-pii: true
    TerminalActionUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the updated object’s type, `"terminal.action"`.
        id:
          type: string
          description: ID of the updated terminal action.
        object:
          $ref: '#/components/schemas/TerminalActionUpdatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-action-updated-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalActionUpdatedWebhookData
      x-visibility: DOC_ONLY
    TerminalActionUpdatedWebhookObject:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/TerminalAction'
      x-property-order:
      - action
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-action-updated-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalActionUpdatedWebhookObject
      x-visibility: DOC_ONLY
    TerminalCheckoutCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"terminal.checkout.created"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: RFC 3339 timestamp of when the webhook event was created.
          readOnly: true
        data:
          $ref: '#/components/schemas/TerminalCheckoutCreatedWebhookData'
      description: Published when a [TerminalCheckout](entity:TerminalCheckout) is
        created.
      example:
        merchant_id: 7NZR58EPNGNPC
        type: terminal.checkout.created
        event_id: 7229a692-def5-4a7e-b4f3-80638aa2f24d
        created_at: 2020-04-10T14:43:55.262Z
        data:
          type: checkout.event
          id: dhgENdnFOPXqO
          object:
            checkout:
              amount_money:
                amount: 111
                currency: USD
              app_id: sq0idp-734Md5EcFjFmwpaR0Snm6g
              created_at: 2020-04-10T14:43:55.262Z
              deadline_duration: PT5M
              device_options:
                device_id: 907CS13101300122
                skip_receipt_screen: false
                tip_settings:
                  allow_tipping: false
              id: dhgENdnFOPXqO
              note: A simple note
              reference_id: id72709
              status: PENDING
              updated_at: 2020-04-10T14:43:55.262Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-checkout-created-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalCheckoutCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: terminal.checkout.created
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Terminal'
      x-since: 2020-04-22
      x-contains-pii: true
    TerminalCheckoutCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the created object’s type, `"terminal.checkout"`.
        id:
          maxLength: 255
          minLength: 10
          type: string
          description: ID of the created terminal checkout.
        object:
          $ref: '#/components/schemas/TerminalCheckoutCreatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-checkout-created-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalCheckoutCreatedWebhookData
      x-visibility: DOC_ONLY
    TerminalCheckoutCreatedWebhookObject:
      type: object
      properties:
        checkout:
          $ref: '#/components/schemas/TerminalCheckout'
      x-property-order:
      - checkout
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-checkout-created-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalCheckoutCreatedWebhookObject
      x-visibility: DOC_ONLY
    TerminalCheckoutUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"terminal.checkout.updated"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: RFC 3339 timestamp of when the webhook event was created.
          readOnly: true
        data:
          $ref: '#/components/schemas/TerminalCheckoutUpdatedWebhookData'
      description: Published when a [TerminalCheckout](entity:TerminalCheckout) is
        updated.
      example:
        merchant_id: 7NZR58EPNGNPC
        type: terminal.checkout.updated
        event_id: 1c3ef831-670d-4f4c-b59c-f0bb2d2fc872
        created_at: 2020-04-10T14:44:06.039Z
        data:
          type: checkout.event
          id: dhgENdnFOPXqO
          object:
            checkout:
              amount_money:
                amount: 111
                currency: USD
              app_id: sq0idp-734Md5EcFjFmwpaR0Snm6g
              created_at: 2020-04-10T14:43:55.262Z
              deadline_duration: PT5M
              device_options:
                device_id: 907CS13101300122
                skip_receipt_screen: false
                tip_settings:
                  allow_tipping: false
              id: dhgENdnFOPXqO
              note: A simple note
              payment_ids:
              - dgzrZTeIeVuOGwYgekoTHsPouaB
              reference_id: id72709
              status: COMPLETED
              updated_at: 2020-04-10T14:44:06.039Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-checkout-updated-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalCheckoutUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: terminal.checkout.updated
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Terminal'
      x-since: 2020-04-22
      x-contains-pii: true
    TerminalCheckoutUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the updated object’s type, `"terminal.checkout"`.
        id:
          maxLength: 255
          minLength: 10
          type: string
          description: ID of the updated terminal checkout.
        object:
          $ref: '#/components/schemas/TerminalCheckoutUpdatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-checkout-updated-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalCheckoutUpdatedWebhookData
      x-visibility: DOC_ONLY
    TerminalCheckoutUpdatedWebhookObject:
      type: object
      properties:
        checkout:
          $ref: '#/components/schemas/TerminalCheckout'
      x-property-order:
      - checkout
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-checkout-updated-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalCheckoutUpdatedWebhookObject
      x-visibility: DOC_ONLY
    TerminalRefundCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"terminal.refund.created"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: RFC 3339 timestamp of when the webhook event was created.
          readOnly: true
        data:
          $ref: '#/components/schemas/TerminalRefundCreatedWebhookData'
      description: Published when a Terminal API refund is created.
      example:
        merchant_id: 7NZR58EPNGNPC
        type: terminal.refund.created
        event_id: 9232cde1-6e72-4356-8b08-bd2af7bb87a2
        created_at: 2020-09-22T14:29:19.459Z
        data:
          type: refund.event
          id: S67MS3HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY
          object:
            refund:
              amount_money:
                amount: 100
                currency: CAD
              app_id: sq0idp-734Md5EcFjFmwpaR0Snm6g
              card:
                bin: "411111"
                card_brand: INTERAC
                card_type: CREDIT
                exp_month: 12
                exp_year: 2020
                fingerprint: sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw
                last_4: "1111"
              card_details:
                avs_status: AVS_NOT_CHECKED
                card:
                  bin: "411111"
                  card_brand: INTERAC
                  card_type: CREDIT
                  exp_month: 12
                  exp_year: 2020
                  fingerprint: sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw
                  last_4: "1111"
                cvv_status: CVV_NOT_CHECKED
                entry_method: EMV
                statement_description: SQ *DEFAULT TEST ACCOUNT
                status: CAPTURED
              created_at: 2020-09-22T14:29:19.459Z
              deadline_duration: PT5M
              device_id: 907CS13101300122
              id: S67MS3HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY
              location_id: A6SYFRSV4WAFW
              order_id: 9VeViC6PeooYw4GVAgiuEMseV
              payment_id: 5O5OvgkcNUhl7JBuINflcjKqUzXZY
              reason: Refund reason
              status: PENDING
              updated_at: 2020-09-22T14:29:19.459Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-refund-created-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalRefundCreatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: terminal.refund.created
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Terminal'
      x-since: 2020-10-28
      x-contains-pii: true
    TerminalRefundCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the created object’s type, `"terminal.refund"`.
        id:
          type: string
          description: ID of the created terminal refund.
        object:
          $ref: '#/components/schemas/TerminalRefundCreatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-refund-created-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalRefundCreatedWebhookData
      x-visibility: DOC_ONLY
    TerminalRefundCreatedWebhookObject:
      type: object
      properties:
        refund:
          $ref: '#/components/schemas/TerminalRefund'
      x-property-order:
      - refund
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-refund-created-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalRefundCreatedWebhookObject
      x-visibility: DOC_ONLY
    TerminalRefundUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        type:
          type: string
          description: The type of event this represents, `"terminal.refund.updated"`.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: RFC 3339 timestamp of when the webhook event was created.
          readOnly: true
        data:
          $ref: '#/components/schemas/TerminalRefundUpdatedWebhookData'
      description: Published when a Terminal API refund is updated.
      example:
        merchant_id: ET1TXH00Q2X3B
        type: terminal.refund.updated
        event_id: d15cfe13-f02c-4155-b381-ef36dd5be92f
        created_at: 2020-09-22T14:34:40.334Z
        data:
          type: refund.event
          id: S67MS3HD-rbh7ygmmPfnEsP6OcuOEFL9FuaB
          object:
            refund:
              amount_money:
                amount: 100
                currency: CAD
              app_id: sq0idp-734Md5EcFjFmwpaR0Snm6g
              card:
                bin: "411111"
                card_brand: INTERAC
                card_type: CREDIT
                exp_month: 12
                exp_year: 2020
                fingerprint: sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw
                last_4: "1111"
              card_details:
                avs_status: AVS_NOT_CHECKED
                card:
                  bin: "411111"
                  card_brand: INTERAC
                  card_type: CREDIT
                  exp_month: 12
                  exp_year: 2020
                  fingerprint: sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw
                  last_4: "1111"
                cvv_status: CVV_NOT_CHECKED
                entry_method: EMV
                statement_description: SQ *DEFAULT TEST ACCOUNT
                status: CAPTURED
              created_at: 2020-09-22T14:29:19.459Z
              deadline_duration: PT5M
              device_id: 907CS13101300122
              id: S67MS3HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY
              location_id: A6SYFRSV4WAFW
              order_id: 9VeViC6PeooYw4GVAgiuEMseV
              payment_id: 5O5OvgkcNUhl7JBuINflcjKqUzXZY
              reason: Refund reason
              status: IN PROGRESS
              updated_at: 2020-09-22T14:34:40.334Z
      x-property-order:
      - merchant_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-refund-updated-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalRefundUpdatedWebhook
      x-visibility: DOC_ONLY
      x-webhook:
        event: terminal.refund.updated
        scopes:
        - PAYMENTS_READ
      x-api: '#/components/x-apis/Terminal'
      x-since: 2020-10-28
      x-contains-pii: true
    TerminalRefundUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the updated object’s type, `"terminal.refund"`.
        id:
          type: string
          description: ID of the updated terminal refund.
        object:
          $ref: '#/components/schemas/TerminalRefundUpdatedWebhookObject'
      x-property-order:
      - type
      - id
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-refund-updated-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalRefundUpdatedWebhookData
      x-visibility: DOC_ONLY
    TerminalRefundUpdatedWebhookObject:
      type: object
      properties:
        refund:
          $ref: '#/components/schemas/TerminalRefund'
      x-property-order:
      - refund
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/terminal/terminal-refund-updated-webhook.proto
      x-proto-sha: 63714af9b65691c0b8ebd3a7181b202f304ee073
      x-object-name: TerminalRefundUpdatedWebhookObject
      x-visibility: DOC_ONLY
    VendorCreatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of a seller associated with this webhook event.
        account_id:
          type: string
          description: The ID of a target platform account associated with this webhook
            event, if the event is associated with the platform account.
        location_id:
          type: string
          description: The ID of a location associated with the webhook event, if
            the event is associated with the location of the seller.
        type:
          type: string
          description: The type of this webhook event. The value is `"vendor.created".`
        event_id:
          type: string
          description: A unique ID for this webhoook event.
        created_at:
          type: string
          description: The RFC 3339-formatted time when the underlying webhook event
            data object is created.
          readOnly: true
        data:
          $ref: '#/components/schemas/VendorCreatedWebhookData'
      description: Published when a [Vendor](entity:Vendor) is created.
      example:
        merchant_id: ETCE****QDYP
        type: vendor.created
        event_id: 4edd919d-ed19-492d-bcb0-1a1ef65dda1a
        created_at: 2022-03-16T01:04:37.308555597Z
        data:
          type: vendor
          id: 5b041563-c3fa-4989-baaf-dec90e81de0b
          object:
            operation: CREATED
            vendor:
              address:
                administrative_district_level_1: NY
                country: US
                locality: New York
                postal_code: "10003"
              contacts:
              - email_address: joe@joesfreshseafood.com
                id: W43ANBJLR5UAV7WT
                name: Joe Burrow
                ordinal: 0
                phone_number: 1-212-555-4250
              created_at: 2022-03-16T01:04:12.581Z
              id: BXIDSDOUIU34VY2V
              name: A vendor
              status: ACTIVE
              updated_at: 2022-03-16T01:04:12.581Z
              version: 1
      x-property-order:
      - merchant_id
      - account_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/inventory/inventory-vendor-created-webhook.proto
      x-proto-sha: a67ca34456c709110577d62f998cbabba55c83f4
      x-object-name: VendorCreatedWebhook
      x-visibility: DOC_ONLY
      x-feature-flag: inventory/enable_vendor_webhooks
      x-webhook:
        event: vendor.created
        scopes:
        - VENDOR_READ
      x-api: '#/components/x-apis/Vendors'
      x-since: 2022-03-16
      x-contains-pii: false
    VendorCreatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: The type of the event data object. The value is `vendor`
        id:
          type: string
          description: The ID of the webhook event data object.
        object:
          $ref: '#/components/schemas/VendorCreatedWebhookObject'
      description: Defines the `vendor.created` webhook event data structure.
      x-property-order:
      - type
      - id
      - object
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/inventory/inventory-vendor-created-webhook.proto
      x-proto-sha: a67ca34456c709110577d62f998cbabba55c83f4
      x-object-name: VendorCreatedWebhookData
      x-visibility: DOC_ONLY
    VendorCreatedWebhookObject:
      type: object
      properties:
        operation:
          $ref: '#/components/schemas/VendorCreatedWebhookObjectOperation'
        vendor:
          $ref: '#/components/schemas/Vendor'
      x-property-order:
      - operation
      - vendor
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/inventory/inventory-vendor-created-webhook.proto
      x-proto-sha: a67ca34456c709110577d62f998cbabba55c83f4
      x-object-name: VendorCreatedWebhookObject
      x-visibility: DOC_ONLY
    VendorUpdatedWebhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of a seller associated with this webhook event.
        account_id:
          type: string
          description: The ID of a target platform account associated with this webhook
            event, if the event is associated with the platform account.
        location_id:
          type: string
          description: The ID of a seller location associated with this webhook event,
            if the event is associated with the location.
        type:
          type: string
          description: The type of this webhook event. The value is `"vendor.updated".`
        event_id:
          type: string
          description: A unique ID for this webhoook event.
        created_at:
          type: string
          description: The RFC 3339-formatted time when the underlying webhook event
            data object is created.
          readOnly: true
        data:
          $ref: '#/components/schemas/VendorUpdatedWebhookData'
      description: Published when a [Vendor](entity:Vendor) is updated.
      example:
        merchant_id: ETCE****QDYP
        type: vendor.updated
        event_id: 1ae8cc43-bf73-48f6-a767-90bdfa197421
        created_at: 2022-03-16T01:15:35.780283073Z
        data:
          type: vendor
          id: 1e8d9885-21dc-41b9-8a8f-6ccf64da5462
          object:
            operation: UPDATED
            vendor:
              address:
                administrative_district_level_1: NY
                country: US
                locality: New York
                postal_code: "10003"
              contacts:
              - email_address: joe@joesfreshseafood.com
                id: W43ANBJLR5UAV7WT
                name: Joe Burrow
                ordinal: 0
                phone_number: 1-212-555-4250
              created_at: 2022-03-16T01:04:12.581Z
              id: BXIDSDOUIU34VY2V
              name: Macro Brewing
              note: Preferred beer supplier
              status: ACTIVE
              updated_at: 2022-03-16T01:15:35.774Z
              version: 2
      x-property-order:
      - merchant_id
      - account_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/inventory/inventory-vendor-updated-webhook.proto
      x-proto-sha: a67ca34456c709110577d62f998cbabba55c83f4
      x-object-name: VendorUpdatedWebhook
      x-visibility: DOC_ONLY
      x-feature-flag: inventory/enable_vendor_webhooks
      x-webhook:
        event: vendor.updated
        scopes:
        - VENDOR_READ
      x-api: '#/components/x-apis/Vendors'
      x-since: 2022-03-16
      x-contains-pii: false
    VendorUpdatedWebhookData:
      type: object
      properties:
        type:
          type: string
          description: The type of the event data object. The value is `vendor`.
        id:
          type: string
          description: The ID of the event data object.
        object:
          $ref: '#/components/schemas/VendorUpdatedWebhookObject'
      description: Defines the `vendor.updated` webhook event data structure.
      x-property-order:
      - type
      - id
      - object
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/inventory/inventory-vendor-updated-webhook.proto
      x-proto-sha: a67ca34456c709110577d62f998cbabba55c83f4
      x-object-name: VendorUpdatedWebhookData
      x-visibility: DOC_ONLY
    VendorUpdatedWebhookObject:
      type: object
      properties:
        operation:
          $ref: '#/components/schemas/VendorUpdatedWebhookObjectOperation'
        vendor:
          $ref: '#/components/schemas/Vendor'
      x-property-order:
      - operation
      - vendor
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/inventory/inventory-vendor-updated-webhook.proto
      x-proto-sha: a67ca34456c709110577d62f998cbabba55c83f4
      x-object-name: VendorUpdatedWebhookObject
      x-visibility: DOC_ONLY
    Webhook:
      type: object
      properties:
        merchant_id:
          type: string
          description: The ID of the target merchant associated with the event.
        account_id:
          type: string
          description: The ID of the target platform account associated with the event.
        location_id:
          type: string
          description: The ID of the location associated with the event.
        type:
          type: string
          description: The type of event this represents.
        event_id:
          type: string
          description: A unique ID for the webhook event.
        created_at:
          type: string
          description: Timestamp of when the webhook event was created, in RFC 3339
            format.
          readOnly: true
        data:
          $ref: '#/components/schemas/WebhookData'
      x-property-order:
      - merchant_id
      - account_id
      - location_id
      - type
      - event_id
      - created_at
      - data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/webhook.proto
      x-proto-sha: 9ceebf229b238b6ae58bda05cdf037c3261de3ea
      x-object-name: Webhook
      x-visibility: DOC_ONLY
    WebhookData:
      type: object
      properties:
        type:
          type: string
          description: Name of the affected object’s type.
        id:
          type: string
          description: ID of the affected object.
        deleted:
          type: boolean
          description: Is true if the affected object was deleted. Otherwise absent.
        object:
          type: object
          description: An object containing fields and values relevant to the event.
            Is absent if affected object was deleted.
      x-property-order:
      - type
      - id
      - deleted
      - object
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/public/webhook.proto
      x-proto-sha: 9ceebf229b238b6ae58bda05cdf037c3261de3ea
      x-object-name: WebhookData
      x-visibility: DOC_ONLY
    CreateDeviceCodeRequest:
      required:
      - device_code
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          maxLength: 128
          minLength: 1
          type: string
          description: |-
            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/basics/api101/idempotency) for more information.
        device_code:
          $ref: '#/components/schemas/DeviceCode'
      example:
        idempotency_key: 01bb00a6-0c86-4770-94ed-f5fca973cd56
        device_code:
          name: Counter 1
          location_id: B5E4484SHHNYH
          product_type: TERMINAL_API
      x-property-order:
      - idempotency_key
      - device_code
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /device-settings/device-settings-proto/src/main/proto/squareup/devicesettings/external/device_code_create.proto
      x-proto-sha: c26abe92e5379e8660778fe30b38f9165df7fabc
      x-object-name: CreateDeviceCodeRequest
    CreateDeviceCodeResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        device_code:
          $ref: '#/components/schemas/DeviceCode'
      example:
        device_code:
          id: B3Z6NAMYQSMTM
          name: Counter 1
          code: EBCARJ
          product_type: TERMINAL_API
          location_id: B5E4484SHHNYH
          created_at: 2020-02-06T18:44:33.000Z
          pair_by: 2020-02-06T18:49:33.000Z
          status: UNPAIRED
          status_changed_at: 2020-02-06T18:44:33.000Z
      x-property-order:
      - errors
      - device_code
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /device-settings/device-settings-proto/src/main/proto/squareup/devicesettings/external/device_code_create.proto
      x-proto-sha: c26abe92e5379e8660778fe30b38f9165df7fabc
      x-object-name: CreateDeviceCodeResponse
    DeviceCode:
      required:
      - product_type
      type: object
      properties:
        id:
          type: string
          description: The unique id for this device code.
          readOnly: true
        name:
          maxLength: 128
          type: string
          description: An optional user-defined name for the device code.
        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'
        location_id:
          maxLength: 50
          type: string
          description: The location assigned to this code.
        status:
          $ref: '#/components/schemas/DeviceCodeStatus'
        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
      x-property-order:
      - id
      - name
      - code
      - device_id
      - product_type
      - location_id
      - status
      - pair_by
      - created_at
      - status_changed_at
      - paired_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /device-settings/device-settings-proto/src/main/proto/squareup/devicesettings/external/device_code.proto
      x-proto-sha: c26abe92e5379e8660778fe30b38f9165df7fabc
      x-object-name: DeviceCode
    GetDeviceCodeRequest:
      type: object
      properties: {}
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /device-settings/device-settings-proto/src/main/proto/squareup/devicesettings/external/device_code_get.proto
      x-proto-sha: c26abe92e5379e8660778fe30b38f9165df7fabc
      x-object-name: GetDeviceCodeRequest
    GetDeviceCodeResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        device_code:
          $ref: '#/components/schemas/DeviceCode'
      example:
        device_code:
          id: B3Z6NAMYQSMTM
          name: Counter 1
          code: EBCARJ
          product_type: TERMINAL_API
          location_id: B5E4484SHHNYH
          created_at: 2020-02-06T18:44:33.000Z
          pair_by: 2020-02-06T18:49:33.000Z
          status: PAIRED
          device_id: 907CS13101300122
          status_changed_at: 2020-02-06T18:47:28.000Z
      x-property-order:
      - errors
      - device_code
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /device-settings/device-settings-proto/src/main/proto/squareup/devicesettings/external/device_code_get.proto
      x-proto-sha: c26abe92e5379e8660778fe30b38f9165df7fabc
      x-object-name: GetDeviceCodeResponse
    ListDeviceCodesRequest:
      type: object
      properties:
        cursor:
          type: string
          description: |-
            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: string
          description: |-
            If specified, only returns DeviceCodes of the specified location.
            Returns DeviceCodes of all locations if empty.
        product_type:
          $ref: '#/components/schemas/ProductType'
        status:
          type: array
          description: |-
            If specified, returns DeviceCodes with the specified statuses.
            Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty.
            See [DeviceCodeStatus](#type-devicecodestatus) for possible values
          items:
            $ref: '#/components/schemas/DeviceCodeStatus'
      example: {}
      x-property-order:
      - cursor
      - location_id
      - product_type
      - status
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /device-settings/device-settings-proto/src/main/proto/squareup/devicesettings/external/device_code_list.proto
      x-proto-sha: c26abe92e5379e8660778fe30b38f9165df7fabc
      x-object-name: ListDeviceCodesRequest
    ListDeviceCodesResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        device_codes:
          type: array
          description: The queried DeviceCode.
          items:
            $ref: '#/components/schemas/DeviceCode'
        cursor:
          type: string
          description: |-
            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.
      example:
        device_codes:
        - id: B3Z6NAMYQSMTM
          name: Counter 1
          code: EBCARJ
          product_type: TERMINAL_API
          location_id: B5E4484SHHNYH
          created_at: 2020-02-06T18:44:33.000Z
          pair_by: 2020-02-06T18:49:33.000Z
          status: PAIRED
          device_id: 907CS13101300122
          status_changed_at: 2020-02-06T18:47:28.000Z
        - id: YKGMJMYK8H4PQ
          name: Unused device code
          code: GVXNYN
          product_type: TERMINAL_API
          location_id: A6SYFRSV4WAFW
          pair_by: 2020-02-07T20:00:04.000Z
          created_at: 2020-02-07T19:55:04.000Z
          status: UNPAIRED
          status_changed_at: 2020-02-07T19:55:04.000Z
      x-property-order:
      - errors
      - device_codes
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /device-settings/device-settings-proto/src/main/proto/squareup/devicesettings/external/device_code_list.proto
      x-proto-sha: c26abe92e5379e8660778fe30b38f9165df7fabc
      x-object-name: ListDeviceCodesResponse
    CustomAttribute:
      type: object
      properties:
        key:
          minLength: 1
          pattern: ^([a-zA-Z0-9\._-]+:)?[a-zA-Z0-9\._-]{1,60}$
          type: string
          description: |-
            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:
          description: |-
            The value assigned to the custom attribute. It is validated against the custom
            attribute definition's schema on write operations. For more information about custom
            attribute values,
            see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview).
        version:
          type: integer
          description: |-
            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:
          $ref: '#/components/schemas/CustomAttributeDefinitionVisibility'
        definition:
          $ref: '#/components/schemas/CustomAttributeDefinition'
        updated_at:
          type: string
          description: |-
            The timestamp that indicates when the custom attribute was created or was most recently
            updated, 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
      description: |-
        A custom attribute value. Each custom attribute value has a corresponding
        `CustomAttributeDefinition` object.
      x-property-order:
      - definition_id
      - key
      - value
      - version
      - parent_resource
      - visibility
      - definition
      - updated_at
      - created_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /devs-custom-attr/devs-custom-attr-proto/src/main/proto/squareup/devscustomattr/datatypes.proto
      x-proto-sha: 0d940eef0bc6b41096b9965c2a9d595202f7c8b3
      x-object-name: CustomAttribute
    CustomAttributeDefinition:
      type: object
      properties:
        key:
          minLength: 1
          pattern: ^([a-zA-Z0-9\._-]+:)?[a-zA-Z0-9\._-]{1,60}$
          type: string
          description: |-
            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:
          type: object
          description: |-
            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:
          maxLength: 255
          type: string
          description: |-
            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:
          maxLength: 255
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/CustomAttributeDefinitionVisibility'
        version:
          type: integer
          description: |-
            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: string
          description: |-
            The timestamp that indicates when the custom attribute definition was created or most recently updated,
            in 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
      description: |-
        Represents a definition for custom attribute values. A custom attribute definition
        specifies the key, visibility, schema, and other properties for a custom attribute.
      x-property-order:
      - id
      - key
      - schema
      - name
      - description
      - source_application
      - visibility
      - version
      - parent_resource_config
      - merchant_token
      - updated_at
      - created_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /devs-custom-attr/devs-custom-attr-proto/src/main/proto/squareup/devscustomattr/datatypes.proto
      x-proto-sha: 0d940eef0bc6b41096b9965c2a9d595202f7c8b3
      x-object-name: CustomAttributeDefinition
    CreateGiftCardActivityRequest:
      required:
      - gift_card_activity
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          maxLength: 128
          minLength: 1
          type: string
          description: A unique string that identifies the `CreateGiftCardActivity`
            request.
        gift_card_activity:
          $ref: '#/components/schemas/GiftCardActivity'
      description: A request to create a gift card activity.
      example:
        idempotency_key: U16kfr-kA70er-q4Rsym-7U7NnY
        gift_card_activity:
          gift_card_id: gftc:6d55a72470d940c6ba09c0ab8ad08d20
          type: ACTIVATE
          location_id: 81FN9BNFZTKS4
          activate_activity_details:
            order_id: jJNGHm4gLI6XkFbwtiSLqK72KkAZY
            line_item_uid: eIWl7X0nMuO9Ewbh0ChIx
      x-property-order:
      - idempotency_key
      - gift_card_activity
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/create-giftcard-activity.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: CreateGiftCardActivityRequest
    CreateGiftCardActivityResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        gift_card_activity:
          $ref: '#/components/schemas/GiftCardActivity'
      description: |-
        A response that contains a `GiftCardActivity` that was created.
        The response might contain a set of `Error` objects if the request resulted in errors.
      example:
        gift_card_activity:
          id: gcact_c8f8cbf1f24b448d8ecf39ed03f97864
          gift_card_id: gftc:6d55a72470d940c6ba09c0ab8ad08d20
          gift_card_gan: "7783320002929081"
          type: ACTIVATE
          gift_card_balance_money:
            amount: 1000
            currency: USD
          location_id: 81FN9BNFZTKS4
          created_at: 2021-05-20T22:26:54.000Z
          activate_activity_details:
            amount_money:
              amount: 1000
              currency: USD
            order_id: jJNGHm4gLI6XkFbwtiSLqK72KkAZY
            line_item_uid: eIWl7X0nMuO9Ewbh0ChIx
      x-property-order:
      - errors
      - gift_card_activity
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/create-giftcard-activity.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: CreateGiftCardActivityResponse
    CreateGiftCardRequest:
      required:
      - gift_card
      - idempotency_key
      - location_id
      type: object
      properties:
        idempotency_key:
          maxLength: 128
          minLength: 1
          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)."
        location_id:
          minLength: 1
          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."
        gift_card:
          $ref: '#/components/schemas/GiftCard'
      description: Represents a [CreateGiftCard](api-endpoint:GiftCards-CreateGiftCard)
        request.
      example:
        idempotency_key: NC9Tm69EjbjtConu
        location_id: 81FN9BNFZTKS4
        gift_card:
          type: DIGITAL
      x-property-order:
      - idempotency_key
      - location_id
      - gift_card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/create-giftcard.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: CreateGiftCardRequest
    CreateGiftCardResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        gift_card:
          $ref: '#/components/schemas/GiftCard'
      description: |-
        A response that contains a `GiftCard`. The response might contain a set of `Error` objects if the request
        resulted in errors.
      example:
        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
      x-property-order:
      - errors
      - gift_card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/create-giftcard.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: CreateGiftCardResponse
    LinkCustomerToGiftCardRequest:
      required:
      - customer_id
      type: object
      properties:
        customer_id:
          maxLength: 191
          minLength: 1
          type: string
          description: The ID of the customer to link to the gift card.
      description: A request to link a customer to a gift card.
      example:
        customer_id: GKY0FZ3V717AH8Q2D821PNT2ZW
      x-property-order:
      - customer_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/link-customer-to-giftcard.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: LinkCustomerToGiftCardRequest
      x-params-example: ?gift_card_id=gftc:71ea002277a34f8a945e284b04822edb
    LinkCustomerToGiftCardResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        gift_card:
          $ref: '#/components/schemas/GiftCard'
      description: "A response that contains the linked `GiftCard` object. If the\
        \ request resulted in errors, \nthe response contains a set of `Error` objects."
      example:
        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
      x-property-order:
      - errors
      - gift_card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/link-customer-to-giftcard.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: LinkCustomerToGiftCardResponse
    ListGiftCardActivitiesRequest:
      type: object
      properties:
        gift_card_id:
          maxLength: 50
          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."
        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."
        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."
        begin_time:
          type: string
          description: |-
            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: string
          description: |-
            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:
          maximum: 100
          minimum: 1
          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)."
        cursor:
          type: string
          description: |-
            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: string
          description: |-
            The order in which the endpoint returns the activities, based on `created_at`.
            - `ASC` - Oldest to newest.
            - `DESC` - Newest to oldest (default).
      description: |-
        Returns a list of gift card activities. You can optionally specify a filter to retrieve a
        subset of activites.
      example: {}
      x-property-order:
      - gift_card_id
      - type
      - location_id
      - begin_time
      - end_time
      - limit
      - cursor
      - sort_order
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/list-giftcard-activities.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: ListGiftCardActivitiesRequest
    ListGiftCardActivitiesResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        gift_card_activities:
          type: array
          description: The requested gift card activities or an empty object if none
            are found.
          items:
            $ref: '#/components/schemas/GiftCardActivity'
        cursor:
          type: string
          description: |-
            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).
      description: "A response that contains a list of `GiftCardActivity` objects.\
        \ If the request resulted in errors, \nthe response contains a set of `Error`\
        \ objects."
      example:
        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
          payment_id: dEv2eksNPy6GqdYiLe4ZBNk6HqXZY
          status: COMPLETED
        - 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
      x-property-order:
      - errors
      - gift_card_activities
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/list-giftcard-activities.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: ListGiftCardActivitiesResponse
    ListGiftCardsRequest:
      type: object
      properties:
        type:
          type: string
          description: |-
            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: string
          description: |-
            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:
          maximum: 50
          minimum: 1
          type: integer
          description: |-
            If a limit is provided, the endpoint returns only the specified number of results per page.
            The maximum value is 50. The default value is 30.
            For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
        cursor:
          type: string
          description: "A pagination cursor returned by a previous call to this endpoint.\n\
            Provide 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)."
        customer_id:
          maxLength: 191
          type: string
          description: If a customer ID is provided, the endpoint returns only the
            gift cards linked to the specified customer.
      description: "A request to list gift cards. You can optionally specify a filter\
        \ to retrieve a subset of \ngift cards."
      x-property-order:
      - type
      - state
      - limit
      - cursor
      - customer_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/list-giftcards.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: ListGiftCardsRequest
      x-params-example: ?type=DIGITAL&state=ACTIVE&cursor=Jj0rA9-rrDW5k-PsorOq-m4BiGf
    ListGiftCardsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        gift_cards:
          type: array
          description: The requested gift cards or an empty object if none are found.
          items:
            $ref: '#/components/schemas/GiftCard'
        cursor:
          type: string
          description: |-
            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).
      description: "A response that contains a list of `GiftCard` objects. If the\
        \ request resulted in errors, \nthe response contains a set of `Error` objects."
      example:
        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
        - 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
        cursor: JbFmyvUpaNKsfC1hoLSA4WlqkgkZXTWeKuStajR5BkP7OE0ETAbeWSi6U6u7sH
      x-property-order:
      - errors
      - gift_cards
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/list-giftcards.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: ListGiftCardsResponse
    RetrieveGiftCardFromGANRequest:
      required:
      - gan
      type: object
      properties:
        gan:
          maxLength: 255
          minLength: 1
          type: string
          description: |-
            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.
      description: A request to retrieve gift cards by their GANs.
      example:
        gan: "7783320001001635"
      x-property-order:
      - gan
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/retrieve-giftcard-from-gan.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: RetrieveGiftCardFromGANRequest
    RetrieveGiftCardFromGANResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        gift_card:
          $ref: '#/components/schemas/GiftCard'
      description: |-
        A response that contains a `GiftCard`. This response might contain a set of `Error` objects
        if the request resulted in errors.
      example:
        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
      x-property-order:
      - errors
      - gift_card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/retrieve-giftcard-from-gan.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: RetrieveGiftCardFromGANResponse
    RetrieveGiftCardFromNonceRequest:
      required:
      - nonce
      type: object
      properties:
        nonce:
          minLength: 1
          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."
      description: A request to retrieve a gift card by using a payment token.
      example:
        nonce: cnon:7783322135245171
      x-property-order:
      - nonce
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/retrieve-giftcard-from-nonce.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: RetrieveGiftCardFromNonceRequest
    RetrieveGiftCardFromNonceResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        gift_card:
          $ref: '#/components/schemas/GiftCard'
      description: "A response that contains a `GiftCard` object. If the request resulted\
        \ in errors, \nthe response contains a set of `Error` objects."
      example:
        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
      x-property-order:
      - errors
      - gift_card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/retrieve-giftcard-from-nonce.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: RetrieveGiftCardFromNonceResponse
    RetrieveGiftCardRequest:
      type: object
      properties: {}
      description: A request to retrieve digital gift cards.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/retrieve-giftcard.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: RetrieveGiftCardRequest
      x-params-example: ?id=gftc:00113070ba5745f0b2377c1b9570cb03
    RetrieveGiftCardResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        gift_card:
          $ref: '#/components/schemas/GiftCard'
      description: |-
        A response that contains a `GiftCard`. The response might contain a set of `Error` objects
        if the request resulted in errors.
      example:
        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
      x-property-order:
      - errors
      - gift_card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/retrieve-giftcard.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: RetrieveGiftCardResponse
    UnlinkCustomerFromGiftCardRequest:
      required:
      - customer_id
      type: object
      properties:
        customer_id:
          maxLength: 191
          minLength: 1
          type: string
          description: The ID of the customer to unlink from the gift card.
      description: A request to unlink a customer from a gift card.
      example:
        customer_id: GKY0FZ3V717AH8Q2D821PNT2ZW
      x-property-order:
      - customer_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/unlink-customer-from-giftcard.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: UnlinkCustomerFromGiftCardRequest
      x-params-example: ?gift_card_id=gftc:71ea002277a34f8a945e284b04822edb
    UnlinkCustomerFromGiftCardResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        gift_card:
          $ref: '#/components/schemas/GiftCard'
      description: "A response that contains the unlinked `GiftCard` object. If the\
        \ request resulted in errors, \nthe response contains a set of `Error` objects."
      example:
        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
      x-property-order:
      - errors
      - gift_card
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/interfaces/unlink-customer-from-giftcard.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: UnlinkCustomerFromGiftCardResponse
    GiftCard:
      required:
      - type
      type: object
      properties:
        id:
          type: string
          description: The Square-assigned ID of the gift card.
          readOnly: true
        type:
          $ref: '#/components/schemas/GiftCardType'
        gan_source:
          $ref: '#/components/schemas/GiftCardGANSource'
        state:
          $ref: '#/components/schemas/GiftCardStatus'
        balance_money:
          $ref: '#/components/schemas/Money'
        gan:
          type: string
          description: "The gift card account number (GAN). Buyers can use the GAN\
            \ to make purchases or check \nthe gift card balance."
        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
          description: The IDs of the [customer profiles](entity:Customer) to whom
            this gift card is linked.
          readOnly: true
          items:
            maxLength: 191
            type: string
      description: Represents a Square gift card.
      x-property-order:
      - id
      - type
      - gan_source
      - state
      - balance_money
      - gan
      - created_at
      - customer_ids
      - first_party_fidelius_token
      - third_party_fidelius_token
      - merchant_token
      - theme_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCard
    GiftCardActivity:
      required:
      - location_id
      - type
      type: object
      properties:
        id:
          type: string
          description: The Square-assigned ID of the gift card activity.
          readOnly: true
        type:
          $ref: '#/components/schemas/GiftCardActivityType'
        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."
        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."
        gift_card_balance_money:
          $ref: '#/components/schemas/Money'
        load_activity_details:
          $ref: '#/components/schemas/GiftCardActivityLoad'
        activate_activity_details:
          $ref: '#/components/schemas/GiftCardActivityActivate'
        redeem_activity_details:
          $ref: '#/components/schemas/GiftCardActivityRedeem'
        clear_balance_activity_details:
          $ref: '#/components/schemas/GiftCardActivityClearBalance'
        deactivate_activity_details:
          $ref: '#/components/schemas/GiftCardActivityDeactivate'
        adjust_increment_activity_details:
          $ref: '#/components/schemas/GiftCardActivityAdjustIncrement'
        adjust_decrement_activity_details:
          $ref: '#/components/schemas/GiftCardActivityAdjustDecrement'
        refund_activity_details:
          $ref: '#/components/schemas/GiftCardActivityRefund'
        unlinked_activity_refund_activity_details:
          $ref: '#/components/schemas/GiftCardActivityUnlinkedActivityRefund'
        import_activity_details:
          $ref: '#/components/schemas/GiftCardActivityImport'
        block_activity_details:
          $ref: '#/components/schemas/GiftCardActivityBlock'
        unblock_activity_details:
          $ref: '#/components/schemas/GiftCardActivityUnblock'
        import_reversal_activity_details:
          $ref: '#/components/schemas/GiftCardActivityImportReversal'
      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-property-order:
      - id
      - type
      - location_id
      - created_at
      - gift_card_id
      - gift_card_gan
      - gift_card_balance_money
      - load_activity_details
      - activate_activity_details
      - redeem_activity_details
      - clear_balance_activity_details
      - deactivate_activity_details
      - adjust_increment_activity_details
      - adjust_decrement_activity_details
      - refund_activity_details
      - unlinked_activity_refund_activity_details
      - import_activity_details
      - other_activity_details
      - block_activity_details
      - unblock_activity_details
      - import_reversal_activity_details
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivity
    GiftCardActivityActivate:
      type: object
      properties:
        amount_money:
          $ref: '#/components/schemas/Money'
        order_id:
          type: string
          description: |-
            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: string
          description: |-
            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: 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."
        buyer_payment_instrument_ids:
          type: array
          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."
          items:
            type: string
      description: Represents details about an `ACTIVATE` [gift card activity type](entity:GiftCardActivityType).
      x-property-order:
      - amount_money
      - order_id
      - line_item_uid
      - reference_id
      - buyer_payment_instrument_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-activate.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityActivate
    GiftCardActivityAdjustDecrement:
      required:
      - amount_money
      - reason
      type: object
      properties:
        amount_money:
          $ref: '#/components/schemas/Money'
        reason:
          $ref: '#/components/schemas/GiftCardActivityAdjustDecrementReason'
      description: Represents details about an `ADJUST_DECREMENT` [gift card activity
        type](entity:GiftCardActivityType).
      x-property-order:
      - amount_money
      - reason
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-adjust-decrement.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityAdjustDecrement
    GiftCardActivityAdjustIncrement:
      required:
      - amount_money
      - reason
      type: object
      properties:
        amount_money:
          $ref: '#/components/schemas/Money'
        reason:
          $ref: '#/components/schemas/GiftCardActivityAdjustIncrementReason'
      description: Represents details about an `ADJUST_INCREMENT` [gift card activity
        type](entity:GiftCardActivityType).
      x-property-order:
      - amount_money
      - reason
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-adjust-increment.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityAdjustIncrement
    GiftCardActivityBlock:
      required:
      - reason
      type: object
      properties:
        reason:
          $ref: '#/components/schemas/GiftCardActivityBlockReason'
      description: Represents details about a `BLOCK` [gift card activity type](entity:GiftCardActivityType).
      x-property-order:
      - reason
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-block.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityBlock
    GiftCardActivityClearBalance:
      required:
      - reason
      type: object
      properties:
        reason:
          $ref: '#/components/schemas/GiftCardActivityClearBalanceReason'
      description: Represents details about a `CLEAR_BALANCE` [gift card activity
        type](entity:GiftCardActivityType).
      x-property-order:
      - reason
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-clear-balance.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityClearBalance
    GiftCardActivityDeactivate:
      required:
      - reason
      type: object
      properties:
        reason:
          $ref: '#/components/schemas/GiftCardActivityDeactivateReason'
      description: Represents details about a `DEACTIVATE` [gift card activity type](entity:GiftCardActivityType).
      x-property-order:
      - reason
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-deactivate.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityDeactivate
    GiftCardActivityImport:
      required:
      - amount_money
      type: object
      properties:
        amount_money:
          $ref: '#/components/schemas/Money'
      description: "Represents details about an `IMPORT` [gift card activity type](entity:GiftCardActivityType).\n\
        This 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-property-order:
      - amount_money
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-import.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityImport
    GiftCardActivityImportReversal:
      required:
      - amount_money
      type: object
      properties:
        amount_money:
          $ref: '#/components/schemas/Money'
      description: Represents details about an `IMPORT_REVERSAL` [gift card activity
        type](entity:GiftCardActivityType).
      x-property-order:
      - amount_money
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-import-reversal.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityImportReversal
    GiftCardActivityLoad:
      type: object
      properties:
        amount_money:
          $ref: '#/components/schemas/Money'
        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."
        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.

            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: 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."
        buyer_payment_instrument_ids:
          type: array
          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\n\
            Applications 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."
          items:
            type: string
      description: Represents details about a `LOAD` [gift card activity type](entity:GiftCardActivityType).
      x-property-order:
      - amount_money
      - order_id
      - line_item_uid
      - reference_id
      - buyer_payment_instrument_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-load.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityLoad
    GiftCardActivityRedeem:
      required:
      - amount_money
      type: object
      properties:
        amount_money:
          $ref: '#/components/schemas/Money'
        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\n\
            related to an order or payment."
        status:
          $ref: '#/components/schemas/GiftCardActivityRedeemStatus'
      description: Represents details about a `REDEEM` [gift card activity type](entity:GiftCardActivityType).
      x-property-order:
      - amount_money
      - payment_id
      - reference_id
      - status
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-redeem.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityRedeem
    GiftCardActivityRefund:
      type: object
      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 redemption made by the same gift card. Note that\
            \ you must use `RefundPayment` \nto refund a gift card payment to the\
            \ same gift card if the payment was processed by Square.\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."
        amount_money:
          $ref: '#/components/schemas/Money'
        reference_id:
          type: string
          description: A client-specified ID that associates the gift card activity
            with an entity in another system.
        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 and one of the\
            \ following conditions is true:\n\n- The Refunds API is used to refund\
            \ a gift card payment to the same gift card.\n- A seller initiated the\
            \ refund from Square Point of Sale or the Seller Dashboard. The payment\
            \ source can be the \nsame gift card or a cross-tender payment from a\
            \ credit card or a different gift card."
          readOnly: true
      description: Represents details about a `REFUND` [gift card activity type](entity:GiftCardActivityType).
      x-property-order:
      - redeem_activity_id
      - amount_money
      - reference_id
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-refund.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityRefund
    GiftCardActivityUnblock:
      required:
      - reason
      type: object
      properties:
        reason:
          $ref: '#/components/schemas/GiftCardActivityUnblockReason'
      description: Represents details about an `UNBLOCK` [gift card activity type](entity:GiftCardActivityType).
      x-property-order:
      - reason
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-unblock.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityUnblock
    GiftCardActivityUnlinkedActivityRefund:
      required:
      - amount_money
      type: object
      properties:
        amount_money:
          $ref: '#/components/schemas/Money'
        reference_id:
          type: string
          description: A client-specified ID that associates the gift card activity
            with an entity in another system.
        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
      description: Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card
        activity type](entity:GiftCardActivityType).
      x-property-order:
      - amount_money
      - reference_id
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /giftcard/api/src/main/proto/squareup/giftcard/connect-api/proto/squareup/giftcard/giftcard_api/models/gift-card-activity-unlinked-activity-refund.proto
      x-proto-sha: f8678187707e89f4555fad67a4ebf7c52a98b362
      x-object-name: GiftCardActivityUnlinkedActivityRefund
    CancelInvoiceRequest:
      required:
      - version
      type: object
      properties:
        version:
          minimum: 0
          type: integer
          description: "The version of the [invoice](entity:Invoice) to cancel.\n\
            If you do not know the version, you can call \n[GetInvoice](api-endpoint:Invoices-GetInvoice)\
            \ or [ListInvoices](api-endpoint:Invoices-ListInvoices)."
      description: Describes a `CancelInvoice` request.
      example:
        version: 0
      x-property-order:
      - version
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/cancel_invoice.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: CancelInvoiceRequest
    CancelInvoiceResponse:
      type: object
      properties:
        invoice:
          $ref: '#/components/schemas/Invoice'
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: The response returned by the `CancelInvoice` request.
      example:
        invoice:
          id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
          version: 1
          location_id: ES0RJRZYEC39A
          order_id: CAISENgvlJ6jLWAzERDzjyHVybY
          payment_requests:
          - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355
            request_type: BALANCE
            due_date: 2030-01-24
            tipping_enabled: true
            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
            automatic_payment_source: NONE
          invoice_number: inv-100
          title: Event Planning Services
          description: We appreciate your business!
          scheduled_at: 2030-01-13T10:00:00Z
          status: CANCELED
          timezone: America/Los_Angeles
          created_at: 2020-06-18T17:45:13Z
          updated_at: 2020-06-18T18:23:11Z
          primary_recipient:
            customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
            given_name: Amelia
            family_name: Earhart
            email_address: Amelia.Earhart@example.com
            phone_number: 1-212-555-4240
          accepted_payment_methods:
            card: true
            square_gift_card: false
            bank_account: 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
          delivery_method: EMAIL
          sale_or_service_date: 2030-01-24
          store_payment_method_enabled: false
        errors: []
      x-property-order:
      - invoice
      - errors
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/cancel_invoice.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: CancelInvoiceResponse
    CreateInvoiceRequest:
      required:
      - invoice
      type: object
      properties:
        invoice:
          $ref: '#/components/schemas/Invoice'
        idempotency_key:
          maxLength: 128
          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\n\
            For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency)."
      description: Describes a `CreateInvoice` request.
      example:
        idempotency_key: ce3748f9-5fc1-4762-aa12-aae5e843f1f4
        invoice:
          location_id: ES0RJRZYEC39A
          order_id: CAISENgvlJ6jLWAzERDzjyHVybY
          scheduled_at: 2030-01-13T10:00:00Z
          primary_recipient:
            customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
          delivery_method: EMAIL
          payment_requests:
          - request_type: BALANCE
            due_date: 2030-01-24
            tipping_enabled: true
            automatic_payment_source: NONE
            reminders:
            - message: Your invoice is due tomorrow
              relative_scheduled_days: -1
          invoice_number: inv-100
          title: Event Planning Services
          description: We appreciate your business!
          accepted_payment_methods:
            card: true
            square_gift_card: false
            bank_account: 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
      x-property-order:
      - invoice
      - idempotency_key
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/create_invoice.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: CreateInvoiceRequest
    CreateInvoiceResponse:
      type: object
      properties:
        invoice:
          $ref: '#/components/schemas/Invoice'
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: The response returned by the `CreateInvoice` request.
      example:
        invoice:
          id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
          version: 0
          location_id: ES0RJRZYEC39A
          order_id: CAISENgvlJ6jLWAzERDzjyHVybY
          payment_requests:
          - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355
            request_type: BALANCE
            due_date: 2030-01-24
            tipping_enabled: true
            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
            automatic_payment_source: NONE
          invoice_number: inv-100
          title: Event Planning Services
          description: We appreciate your business!
          scheduled_at: 2030-01-13T10:00:00Z
          status: DRAFT
          timezone: America/Los_Angeles
          created_at: 2020-06-18T17:45:13Z
          updated_at: 2020-06-18T17:45:13Z
          primary_recipient:
            customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
            given_name: Amelia
            family_name: Earhart
            email_address: Amelia.Earhart@example.com
            phone_number: 1-212-555-4240
          accepted_payment_methods:
            card: true
            square_gift_card: false
            bank_account: 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
          delivery_method: EMAIL
          sale_or_service_date: 2030-01-24
          store_payment_method_enabled: false
        errors: []
      x-property-order:
      - invoice
      - errors
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/create_invoice.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: CreateInvoiceResponse
    DeleteInvoiceRequest:
      type: object
      properties:
        version:
          minimum: 0
          type: integer
          description: "The version of the [invoice](entity:Invoice) to delete.\n\
            If you do not know the version, you can call [GetInvoice](api-endpoint:Invoices-GetInvoice)\
            \ or \n[ListInvoices](api-endpoint:Invoices-ListInvoices)."
      description: Describes a `DeleteInvoice` request.
      x-property-order:
      - version
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/delete_invoice.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: DeleteInvoiceRequest
    DeleteInvoiceResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Describes a `DeleteInvoice` response.
      example:
        errors: []
      x-property-order:
      - errors
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/delete_invoice.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: DeleteInvoiceResponse
    GetInvoiceRequest:
      type: object
      properties: {}
      description: Describes a `GetInvoice` request.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/get_invoice.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: GetInvoiceRequest
    GetInvoiceResponse:
      type: object
      properties:
        invoice:
          $ref: '#/components/schemas/Invoice'
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Describes a `GetInvoice` response.
      example:
        invoice:
          id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
          version: 0
          location_id: ES0RJRZYEC39A
          order_id: CAISENgvlJ6jLWAzERDzjyHVybY
          payment_requests:
          - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355
            request_type: BALANCE
            due_date: 2030-01-24
            tipping_enabled: true
            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
            automatic_payment_source: NONE
          invoice_number: inv-100
          title: Event Planning Services
          description: We appreciate your business!
          scheduled_at: 2030-01-13T10:00:00Z
          status: DRAFT
          timezone: America/Los_Angeles
          created_at: 2020-06-18T17:45:13Z
          updated_at: 2020-06-18T17:45:13Z
          primary_recipient:
            customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
            given_name: Amelia
            family_name: Earhart
            email_address: Amelia.Earhart@example.com
            phone_number: 1-212-555-4240
          accepted_payment_methods:
            card: true
            square_gift_card: false
            bank_account: 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
          delivery_method: EMAIL
          sale_or_service_date: 2030-01-24
          store_payment_method_enabled: false
        errors: []
      x-property-order:
      - invoice
      - errors
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/get_invoice.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: GetInvoiceResponse
    Invoice:
      type: object
      properties:
        id:
          type: string
          description: The Square-assigned ID of the invoice.
          readOnly: true
        version:
          minimum: 0
          type: integer
          description: The Square-assigned version number, which is incremented each
            time an update is committed to the invoice.
        location_id:
          maxLength: 255
          minLength: 1
          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."
        order_id:
          maxLength: 255
          minLength: 1
          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."
        primary_recipient:
          $ref: '#/components/schemas/InvoiceRecipient'
        payment_requests:
          maxItems: 13
          minItems: 1
          type: array
          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)."
          items:
            $ref: '#/components/schemas/InvoicePaymentRequest'
        delivery_method:
          $ref: '#/components/schemas/InvoiceDeliveryMethod'
        invoice_number:
          maxLength: 191
          minLength: 1
          type: string
          description: |-
            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:
          maxLength: 255
          minLength: 1
          type: string
          description: The title of the invoice, which is displayed on the invoice.
        description:
          maxLength: 65536
          minLength: 1
          type: string
          description: The description of the invoice, which is displayed on the invoice.
        scheduled_at:
          type: string
          description: |-
            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: string
          description: |-
            The URL of the Square-hosted invoice page.
            After you publish the invoice using the `PublishInvoice` endpoint, Square hosts the invoice
            page and returns the page URL in the response.
          readOnly: true
        next_payment_amount_money:
          $ref: '#/components/schemas/Money'
        status:
          $ref: '#/components/schemas/InvoiceStatus'
        timezone:
          type: string
          description: |-
            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).
          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'
        custom_fields:
          maxItems: 2
          type: array
          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"
          items:
            $ref: '#/components/schemas/InvoiceCustomField'
        subscription_id:
          type: string
          description: |-
            The ID of the [subscription](entity:Subscription) associated with the invoice.
            This 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.
            This field can be used to specify a past or future date which is displayed on the invoice.
        payment_conditions:
          maxLength: 2000
          minLength: 1
          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."
        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
            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`.
      description: |-
        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).
      x-property-order:
      - id
      - version
      - location_id
      - order_id
      - primary_recipient
      - payment_requests
      - delivery_method
      - invoice_number
      - title
      - description
      - scheduled_at
      - public_url
      - next_payment_amount_money
      - status
      - timezone
      - created_at
      - updated_at
      - accepted_payment_methods
      - custom_fields
      - subscription_id
      - linked_subscription_id
      - sale_or_service_date
      - payment_conditions
      - store_payment_method_enabled
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/model/invoice.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: Invoice
    InvoiceAcceptedPaymentMethods:
      type: object
      properties:
        card:
          type: boolean
          description: Indicates whether credit card or debit card payments are accepted.
            The default value is `false`.
        square_gift_card:
          type: boolean
          description: Indicates whether Square gift card payments are accepted. The
            default value is `false`.
        bank_account:
          type: boolean
          description: |-
            Indicates whether bank transfer payments are accepted. The default value is `false`.

            This option is allowed only for invoices that have a single payment request of type `BALANCE`.
      description: The payment methods that customers can use to pay an invoice on
        the Square-hosted invoice page.
      x-property-order:
      - card
      - square_gift_card
      - bank_account
      - buy_now_pay_later
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/model/accepted_payment_methods.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: InvoiceAcceptedPaymentMethods
    InvoiceCustomField:
      type: object
      properties:
        label:
          maxLength: 30
          type: string
          description: The label or title of the custom field. This field is required
            for a custom field.
        value:
          maxLength: 2000
          type: string
          description: The text of the custom field. If omitted, only the label is
            rendered.
        placement:
          $ref: '#/components/schemas/InvoiceCustomFieldPlacement'
      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-property-order:
      - label
      - value
      - placement
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/model/custom_fields.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: InvoiceCustomField
    InvoiceFilter:
      required:
      - location_ids
      type: object
      properties:
        location_ids:
          maxItems: 1
          minItems: 1
          type: array
          description: "Limits the search to the specified locations. A location is\
            \ required. \nIn the current implementation, only one location can be\
            \ specified."
          items:
            type: string
        customer_ids:
          maxItems: 1
          minItems: 1
          type: array
          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."
          items:
            type: string
      description: Describes query filters to apply.
      x-property-order:
      - location_ids
      - customer_ids
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/search_invoices.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: InvoiceFilter
    InvoicePaymentReminder:
      type: object
      properties:
        uid:
          type: string
          description: |-
            A Square-assigned ID that uniquely identifies the reminder within the
            `InvoicePaymentRequest`.
          readOnly: true
        relative_scheduled_days:
          maximum: 32767
          minimum: -32767
          type: integer
          description: |-
            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:
          maxLength: 1000
          minLength: 1
          type: string
          description: The reminder message.
        status:
          $ref: '#/components/schemas/InvoicePaymentReminderStatus'
        sent_at:
          type: string
          description: If sent, the timestamp when the reminder was sent, in RFC 3339
            format.
          readOnly: true
      description: |-
        Describes a payment request reminder (automatic notification) that Square sends
        to the customer. You configure a reminder relative to the payment request
        `due_date`.
      x-property-order:
      - uid
      - relative_scheduled_days
      - message
      - status
      - sent_at
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/model/payment_reminder.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: InvoicePaymentReminder
    InvoicePaymentRequest:
      type: object
      properties:
        uid:
          maxLength: 255
          minLength: 1
          type: string
          description: The Square-generated ID of the payment request in an [invoice](entity:Invoice).
        request_method:
          $ref: '#/components/schemas/InvoiceRequestMethod'
        request_type:
          $ref: '#/components/schemas/InvoiceRequestType'
        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
            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:
          $ref: '#/components/schemas/Money'
        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."
        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`."
        automatic_payment_source:
          $ref: '#/components/schemas/InvoiceAutomaticPaymentSource'
        card_id:
          maxLength: 255
          minLength: 1
          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,
            call [ListCards](api-endpoint:Cards-ListCards) and include the `customer_id` of the invoice recipient.
        reminders:
          type: array
          description: A list of one or more reminders to send for the payment request.
          items:
            $ref: '#/components/schemas/InvoicePaymentReminder'
        computed_amount_money:
          $ref: '#/components/schemas/Money'
        total_completed_amount_money:
          $ref: '#/components/schemas/Money'
        rounding_adjustment_included_money:
          $ref: '#/components/schemas/Money'
      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-property-order:
      - uid
      - request_method
      - request_type
      - due_date
      - fixed_amount_requested_money
      - percentage_requested
      - tipping_enabled
      - automatic_payment_source
      - card_id
      - reminders
      - computed_amount_money
      - total_completed_amount_money
      - rounding_adjustment_included_money
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/model/payment_request.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: InvoicePaymentRequest
    InvoiceQuery:
      required:
      - filter
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/InvoiceFilter'
        sort:
          $ref: '#/components/schemas/InvoiceSort'
      description: Describes query criteria for searching invoices.
      x-property-order:
      - filter
      - sort
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/search_invoices.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: InvoiceQuery
    InvoiceRecipient:
      type: object
      properties:
        customer_id:
          maxLength: 255
          minLength: 1
          type: string
          description: "The ID of the customer. This is the customer profile ID that\
            \ \nyou provide when creating a draft invoice."
        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'
        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: "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-property-order:
      - customer_id
      - given_name
      - family_name
      - email_address
      - address
      - phone_number
      - company_name
      - tax_ids
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/model/recipient.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: InvoiceRecipient
    InvoiceRecipientTaxIds:
      type: object
      properties:
        eu_vat:
          type: string
          description: The EU VAT identification number for the invoice recipient.
            For example, `IE3426675K`.
          readOnly: true
      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-property-order:
      - eu_vat
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/model/recipient_tax_ids.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: InvoiceRecipientTaxIds
    InvoiceSort:
      required:
      - field
      type: object
      properties:
        field:
          $ref: '#/components/schemas/InvoiceSortField'
        order:
          $ref: '#/components/schemas/SortOrder'
      description: Identifies the sort field and sort order.
      x-property-order:
      - field
      - order
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/search_invoices.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: InvoiceSort
    ListInvoicesRequest:
      required:
      - location_id
      type: object
      properties:
        location_id:
          maxLength: 255
          minLength: 1
          type: string
          description: The ID of the location for which to list 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/working-with-apis/pagination)."
        limit:
          minimum: 0
          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."
      description: Describes a `ListInvoice` request.
      x-property-order:
      - location_id
      - cursor
      - limit
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/list_invoices.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: ListInvoicesRequest
      x-params-example: ?location_id=ES0RJRZYEC39A&limit=2
    ListInvoicesResponse:
      type: object
      properties:
        invoices:
          type: array
          description: The invoices retrieved.
          items:
            $ref: '#/components/schemas/Invoice'
        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/working-with-apis/pagination)."
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Describes a `ListInvoice` response.
      example:
        invoices:
        - id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
          version: 0
          location_id: ES0RJRZYEC39A
          order_id: CAISENgvlJ6jLWAzERDzjyHVybY
          payment_requests:
          - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355
            request_type: BALANCE
            due_date: 2030-01-24
            tipping_enabled: true
            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
            automatic_payment_source: NONE
          invoice_number: inv-100
          title: Event Planning Services
          description: We appreciate your business!
          scheduled_at: 2030-01-13T10:00:00Z
          status: DRAFT
          timezone: America/Los_Angeles
          created_at: 2020-06-18T17:45:13Z
          updated_at: 2020-06-18T17:45:13Z
          primary_recipient:
            customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
            given_name: Amelia
            family_name: Earhart
            email_address: Amelia.Earhart@example.com
            phone_number: 1-212-555-4240
          accepted_payment_methods:
            card: true
            square_gift_card: false
            bank_account: 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
          delivery_method: EMAIL
          sale_or_service_date: 2030-01-24
          store_payment_method_enabled: false
        - id: inv:0-ChC366qAfskpGrBI_1bozs9mEA3
          version: 3
          location_id: ES0RJRZYEC39A
          order_id: a65jnS8NXbfprvGJzY9F4fQTuaB
          payment_requests:
          - uid: 66c3bdfd-5090-4ff9-a8a0-c1e1a2ffa176
            request_type: DEPOSIT
            due_date: 2021-01-23
            percentage_requested: "25"
            tipping_enabled: false
            card_id: ccof:IkWfpLj4tNHMyFii3GB
            computed_amount_money:
              amount: 1000
              currency: USD
            total_completed_amount_money:
              amount: 1000
              currency: USD
            automatic_payment_source: CARD_ON_FILE
            reminders: []
          - uid: 120c5e18-4f80-4f6b-b159-774cb9bf8f99
            request_type: BALANCE
            due_date: 2021-06-15
            tipping_enabled: false
            card_id: ccof:IkWfpLj4tNHMyFii3GB
            computed_amount_money:
              amount: 3000
              currency: USD
            total_completed_amount_money:
              amount: 0
              currency: USD
            automatic_payment_source: CARD_ON_FILE
          invoice_number: inv-455
          public_url: https://squareup.com/pay-invoice/h9sfsfTGTSnYEhISUDBhEQ
          status: PARTIALLY_PAID
          timezone: America/Los_Angeles
          created_at: 2021-01-23T15:29:12Z
          updated_at: 2021-01-23T15:29:56Z
          primary_recipient:
            customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
            given_name: Amelia
            family_name: Earhart
            email_address: Amelia.Earhart@example.com
            phone_number: 1-212-555-4240
          next_payment_amount_money:
            amount: 3000
            currency: USD
          accepted_payment_methods:
            card: true
            square_gift_card: true
            bank_account: false
          delivery_method: EMAIL
          sale_or_service_date: 2030-01-24
          custom_fields: []
          store_payment_method_enabled: false
        cursor: ChoIDhIWVm54ZVRhLXhySFBOejBBM2xJb2daUQoFCI4IGAE
        errors: []
      x-property-order:
      - invoices
      - cursor
      - errors
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/list_invoices.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: ListInvoicesResponse
    PublishInvoiceRequest:
      required:
      - version
      type: object
      properties:
        version:
          minimum: 0
          type: integer
          description: |-
            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:
          maxLength: 128
          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\n\
            For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency)."
      description: Describes a `PublishInvoice` request.
      example:
        version: 1
        idempotency_key: 32da42d0-1997-41b0-826b-f09464fc2c2e
      x-property-order:
      - version
      - idempotency_key
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/publish_invoice.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: PublishInvoiceRequest
    PublishInvoiceResponse:
      type: object
      properties:
        invoice:
          $ref: '#/components/schemas/Invoice'
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Describes a `PublishInvoice` response.
      example:
        invoice:
          id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
          version: 1
          location_id: ES0RJRZYEC39A
          order_id: CAISENgvlJ6jLWAzERDzjyHVybY
          payment_requests:
          - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355
            request_type: BALANCE
            due_date: 2030-01-24
            tipping_enabled: true
            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
            automatic_payment_source: NONE
          invoice_number: inv-100
          title: Event Planning Services
          description: We appreciate your business!
          scheduled_at: 2030-01-13T10:00:00Z
          status: SCHEDULED
          timezone: America/Los_Angeles
          created_at: 2020-06-18T17:45:13Z
          updated_at: 2020-06-18T18:23:11Z
          primary_recipient:
            customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
            given_name: Amelia
            family_name: Earhart
            email_address: Amelia.Earhart@example.com
            phone_number: 1-212-555-4240
          public_url: https://squareup.com/pay-invoice/inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
          accepted_payment_methods:
            card: true
            square_gift_card: false
            bank_account: 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
          delivery_method: EMAIL
          sale_or_service_date: 2030-01-24
          store_payment_method_enabled: false
        errors: []
      x-property-order:
      - invoice
      - errors
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/publish_invoice.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: PublishInvoiceResponse
    SearchInvoicesRequest:
      required:
      - query
      type: object
      properties:
        query:
          $ref: '#/components/schemas/InvoiceQuery'
        limit:
          minimum: 0
          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/working-with-apis/pagination)."
      description: Describes a `SearchInvoices` request.
      example:
        query:
          filter:
            location_ids:
            - ES0RJRZYEC39A
            customer_ids:
            - JDKYHBWT1D4F8MFH63DBMEN8Y4
          sort:
            field: INVOICE_SORT_DATE
            order: DESC
          limit: 100
      x-property-order:
      - query
      - limit
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/search_invoices.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: SearchInvoicesRequest
    SearchInvoicesResponse:
      type: object
      properties:
        invoices:
          type: array
          description: The list of invoices returned by the search.
          items:
            $ref: '#/components/schemas/Invoice'
        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/working-with-apis/pagination)."
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Describes a `SearchInvoices` response.
      example:
        invoices:
        - id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
          version: 0
          location_id: ES0RJRZYEC39A
          order_id: CAISENgvlJ6jLWAzERDzjyHVybY
          payment_requests:
          - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355
            request_type: BALANCE
            due_date: 2030-01-24
            tipping_enabled: true
            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
            automatic_payment_source: NONE
          invoice_number: inv-100
          title: Event Planning Services
          description: We appreciate your business!
          scheduled_at: 2030-01-13T10:00:00Z
          status: DRAFT
          timezone: America/Los_Angeles
          created_at: 2020-06-18T17:45:13Z
          updated_at: 2020-06-18T17:45:13Z
          primary_recipient:
            customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
            given_name: Amelia
            family_name: Earhart
            email_address: Amelia.Earhart@example.com
            phone_number: 1-212-555-4240
          accepted_payment_methods:
            card: true
            square_gift_card: false
            bank_account: 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
          delivery_method: EMAIL
          sale_or_service_date: 2030-01-24
          store_payment_method_enabled: false
        - id: inv:0-ChC366qAfskpGrBI_1bozs9mEA3
          version: 3
          location_id: ES0RJRZYEC39A
          order_id: a65jnS8NXbfprvGJzY9F4fQTuaB
          payment_requests:
          - uid: 66c3bdfd-5090-4ff9-a8a0-c1e1a2ffa176
            request_type: DEPOSIT
            due_date: 2021-01-23
            percentage_requested: "25"
            tipping_enabled: false
            card_id: ccof:IkWfpLj4tNHMyFii3GB
            computed_amount_money:
              amount: 1000
              currency: USD
            total_completed_amount_money:
              amount: 1000
              currency: USD
            automatic_payment_source: CARD_ON_FILE
            reminders: []
          - uid: 120c5e18-4f80-4f6b-b159-774cb9bf8f99
            request_type: BALANCE
            due_date: 2021-06-15
            tipping_enabled: false
            card_id: ccof:IkWfpLj4tNHMyFii3GB
            computed_amount_money:
              amount: 3000
              currency: USD
            total_completed_amount_money:
              amount: 0
              currency: USD
            automatic_payment_source: CARD_ON_FILE
            reminders: []
          invoice_number: inv-455
          public_url: https://squareup.com/pay-invoice/h9sfsfTGTSnYEhISUDBhEQ
          status: PARTIALLY_PAID
          timezone: America/Los_Angeles
          created_at: 2021-01-23T15:29:12Z
          updated_at: 2021-01-23T15:29:56Z
          primary_recipient:
            customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
            given_name: Amelia
            family_name: Earhart
            email_address: Amelia.Earhart@example.com
            phone_number: 1-212-555-4240
          next_payment_amount_money:
            amount: 3000
            currency: USD
          accepted_payment_methods:
            card: true
            square_gift_card: true
            bank_account: false
          delivery_method: EMAIL
          sale_or_service_date: 2030-01-24
          custom_fields: []
          store_payment_method_enabled: false
        cursor: ChoIDhIWVm54ZVRhLXhySFBOejBBM2xJb2daUQoFCI4IGAE
        errors: []
      x-property-order:
      - invoices
      - cursor
      - errors
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/search_invoices.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: SearchInvoicesResponse
    UpdateInvoiceRequest:
      required:
      - invoice
      type: object
      properties:
        invoice:
          $ref: '#/components/schemas/Invoice'
        idempotency_key:
          maxLength: 128
          type: string
          description: |-
            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/working-with-apis/idempotency).
        fields_to_clear:
          type: array
          description: |-
            The list of fields to clear.
            For examples, see [Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices).
          items:
            minLength: 1
            type: string
      description: Describes a `UpdateInvoice` request.
      example:
        idempotency_key: 4ee82288-0910-499e-ab4c-5d0071dad1be
        invoice:
          payment_requests:
          - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355
            tipping_enabled: false
          version: 1
        fields_to_clear:
        - payments_requests[2da7964f-f3d2-4f43-81e8-5aa220bf3355].reminders
      x-property-order:
      - invoice
      - idempotency_key
      - fields_to_clear
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/update_invoice.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: UpdateInvoiceRequest
    UpdateInvoiceResponse:
      type: object
      properties:
        invoice:
          $ref: '#/components/schemas/Invoice'
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Describes a `UpdateInvoice` response.
      example:
        invoice:
          id: inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
          version: 2
          location_id: ES0RJRZYEC39A
          order_id: CAISENgvlJ6jLWAzERDzjyHVybY
          payment_requests:
          - uid: 2da7964f-f3d2-4f43-81e8-5aa220bf3355
            request_type: BALANCE
            due_date: 2030-01-24
            tipping_enabled: false
            computed_amount_money:
              amount: 10000
              currency: USD
            total_completed_amount_money:
              amount: 0
              currency: USD
            automatic_payment_source: NONE
            reminders: []
          invoice_number: inv-100
          title: Event Planning Services
          description: We appreciate your business!
          scheduled_at: 2030-01-13T10:00:00Z
          status: UNPAID
          timezone: America/Los_Angeles
          created_at: 2020-06-18T17:45:13Z
          updated_at: 2020-06-18T18:23:11Z
          primary_recipient:
            customer_id: JDKYHBWT1D4F8MFH63DBMEN8Y4
            given_name: Amelia
            family_name: Earhart
            email_address: Amelia.Earhart@example.com
            phone_number: 1-212-555-4240
          next_payment_amount_money:
            amount: 10000
            currency: USD
          accepted_payment_methods:
            card: true
            square_gift_card: false
            bank_account: 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
          delivery_method: EMAIL
          sale_or_service_date: 2030-01-24
          store_payment_method_enabled: false
        errors: []
      x-property-order:
      - invoice
      - errors
      x-release-status: PUBLIC
      x-proto-repo: clinton
      x-proto-location: /protos/squareup/invoiceapi/message/update_invoice.proto
      x-proto-sha: 07d054318f5b8b1c2b2c16dd0049e383b48cdfa4
      x-object-name: UpdateInvoiceResponse
    Break:
      required:
      - break_type_id
      - expected_duration
      - is_paid
      - name
      - start_at
      type: object
      properties:
        id:
          type: string
          description: The UUID for this object.
        start_at:
          minLength: 1
          type: string
          description: |-
            RFC 3339; follows the same timezone information as `Shift`. Precision up to
            the minute is respected; seconds are truncated.
        end_at:
          type: string
          description: |-
            RFC 3339; follows the same timezone information as `Shift`. Precision up to
            the minute is respected; seconds are truncated.
        break_type_id:
          minLength: 1
          type: string
          description: The `BreakType` that this `Break` was templated on.
        name:
          minLength: 1
          type: string
          description: A human-readable name.
        expected_duration:
          minLength: 1
          type: string
          description: |-
            Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of
            the break.
        is_paid:
          type: boolean
          description: |-
            Whether this break counts towards time worked for compensation
            purposes.
      description: A record of an employee's break during a shift.
      x-property-order:
      - id
      - start_at
      - end_at
      - break_type_id
      - name
      - expected_duration
      - is_paid
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/resources/datatypes.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: Break
    BreakType:
      required:
      - break_name
      - expected_duration
      - is_paid
      - location_id
      type: object
      properties:
        id:
          maxLength: 255
          type: string
          description: The UUID for this object.
        location_id:
          minLength: 1
          type: string
          description: The ID of the business location this type of break applies
            to.
        break_name:
          minLength: 1
          type: string
          description: |-
            A human-readable name for this type of break. The name is displayed to
            employees in Square products.
        expected_duration:
          minLength: 1
          type: string
          description: |-
            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.
        is_paid:
          type: boolean
          description: |-
            Whether this break counts towards time worked for compensation
            purposes.
        version:
          minimum: 0
          type: integer
          description: |-
            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: 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
      description: |-
        A defined break template that sets an expectation for possible `Break`
        instances on a `Shift`.
      x-property-order:
      - id
      - location_id
      - break_name
      - expected_duration
      - is_paid
      - version
      - created_at
      - updated_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/resources/datatypes.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: BreakType
    CreateBreakTypeRequest:
      required:
      - break_type
      type: object
      properties:
        idempotency_key:
          maxLength: 128
          type: string
          description: A unique string value to ensure the idempotency of the operation.
        break_type:
          $ref: '#/components/schemas/BreakType'
      description: A request to create a new `BreakType`.
      example:
        idempotency_key: PAD3NG5KSN2GL
        break_type:
          location_id: CGJN03P1D08GF
          break_name: Lunch Break
          expected_duration: PT30M
          is_paid: true
      x-property-order:
      - idempotency_key
      - break_type
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/create-break-type.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: CreateBreakTypeRequest
    CreateBreakTypeResponse:
      type: object
      properties:
        break_type:
          $ref: '#/components/schemas/BreakType'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        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.
      example:
        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
      x-property-order:
      - break_type
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/create-break-type.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: CreateBreakTypeResponse
    CreateShiftRequest:
      required:
      - shift
      type: object
      properties:
        idempotency_key:
          maxLength: 128
          type: string
          description: A unique string value to ensure the idempotency of the operation.
        shift:
          $ref: '#/components/schemas/Shift'
      description: Represents a request to create a `Shift`.
      example:
        idempotency_key: HIDSNG5KS478L
        shift:
          team_member_id: ormj0jJJZ5OZIzxrZYJI
          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
          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
      x-property-order:
      - idempotency_key
      - shift
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/create-shift.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: CreateShiftRequest
    CreateShiftResponse:
      type: object
      properties:
        shift:
          $ref: '#/components/schemas/Shift'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        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.
      example:
        shift:
          id: K0YH4CV5462JB
          team_member_id: ormj0jJJZ5OZIzxrZYJI
          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
          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
      x-property-order:
      - shift
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/create-shift.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: CreateShiftResponse
    DateRange:
      type: object
      properties:
        start_date:
          type: string
          description: |-
            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: string
          description: |-
            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).
      description: |-
        A range defined by two dates. Used for filtering a query for Connect v2
        objects that have date properties.
      x-property-order:
      - start_date
      - end_date
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/resources/datatypes.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: DateRange
    DeleteBreakTypeRequest:
      type: object
      properties: {}
      description: A request to delete a `BreakType`.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/delete-break-type.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: DeleteBreakTypeRequest
    DeleteBreakTypeResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      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."
      example: {}
      x-property-order:
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/delete-break-type.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: DeleteBreakTypeResponse
    DeleteShiftRequest:
      type: object
      properties: {}
      description: A request to delete a `Shift`.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/delete-shift.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: DeleteShiftRequest
    DeleteShiftResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      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."
      example: {}
      x-property-order:
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/delete-shift.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: DeleteShiftResponse
    EmployeeWage:
      type: object
      properties:
        id:
          type: string
          description: The UUID for this object.
        employee_id:
          type: string
          description: The `Employee` that this wage is assigned to.
        title:
          type: string
          description: The job title that this wage relates to.
        hourly_rate:
          $ref: '#/components/schemas/Money'
      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` instead.
      deprecated: true
      x-property-order:
      - id
      - employee_id
      - title
      - hourly_rate
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/resources/datatypes.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: EmployeeWage
    GetBreakTypeRequest:
      type: object
      properties: {}
      description: A request to get a `BreakType` by ID.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/get-break-type.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: GetBreakTypeRequest
    GetBreakTypeResponse:
      type: object
      properties:
        break_type:
          $ref: '#/components/schemas/BreakType'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        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.
      example:
        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
      x-property-order:
      - break_type
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/get-break-type.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: GetBreakTypeResponse
    GetEmployeeWageRequest:
      type: object
      properties: {}
      description: A request to get an `EmployeeWage`.
      deprecated: true
      x-property-order: []
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/get-employee-wage.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: GetEmployeeWageRequest
    GetEmployeeWageResponse:
      type: object
      properties:
        employee_wage:
          $ref: '#/components/schemas/EmployeeWage'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        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.
      example:
        employee_wage:
          id: pXS3qCv7BERPnEGedM4S8mhm
          employee_id: 33fJchumvVdJwxV0H6L9
          title: Manager
          hourly_rate:
            amount: 2000
            currency: USD
      deprecated: true
      x-property-order:
      - employee_wage
      - errors
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/get-employee-wage.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: GetEmployeeWageResponse
    GetShiftRequest:
      type: object
      properties: {}
      description: A request to get a `Shift` by ID.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/get-shift.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: GetShiftRequest
    GetShiftResponse:
      type: object
      properties:
        shift:
          $ref: '#/components/schemas/Shift'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        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.
      example:
        shift:
          id: T35HMQSN89SV4
          team_member_id: D71KRMQof6cXGUW0aAv7
          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
          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
      x-property-order:
      - shift
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/get-shift.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: GetShiftResponse
    GetTeamMemberWageRequest:
      type: object
      properties: {}
      description: A request to get a `TeamMemberWage`.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/get-team-member-wage.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: GetTeamMemberWageRequest
    GetTeamMemberWageResponse:
      type: object
      properties:
        team_member_wage:
          $ref: '#/components/schemas/TeamMemberWage'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        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.
      example:
        team_member_wage:
          id: pXS3qCv7BERPnEGedM4S8mhm
          team_member_id: 33fJchumvVdJwxV0H6L9
          title: Manager
          hourly_rate:
            amount: 2000
            currency: USD
      x-property-order:
      - team_member_wage
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/get-team-member-wage.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: GetTeamMemberWageResponse
    ListBreakTypesRequest:
      type: object
      properties:
        location_id:
          type: string
          description: |-
            Filter the returned `BreakType` results to only those that are associated with the
            specified location.
        limit:
          maximum: 200
          minimum: 1
          type: integer
          description: |-
            The maximum number of `BreakType` results to return per page. The number can range between 1
            and 200. The default is 200.
        cursor:
          type: string
          description: A pointer to the next page of `BreakType` results to fetch.
      description: A request for a filtered set of `BreakType` objects.
      x-property-order:
      - location_id
      - limit
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/list-break-types.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: ListBreakTypesRequest
      x-params-example: ?location_id=PAA1RJZZKXBFG&limit=2&cursor=s4R0Z6ecFTzTC4jz8sUDBQTudX3KE313OT9fCt3VUgsXM4sMgED
    ListBreakTypesResponse:
      type: object
      properties:
        break_types:
          type: array
          description: ' A page of `BreakType` results.'
          items:
            $ref: '#/components/schemas/BreakType'
        cursor:
          type: string
          description: |-
            The value supplied in the subsequent request to fetch the next page
            of `BreakType` results.
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        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.
      example:
        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
      x-property-order:
      - break_types
      - cursor
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/list-break-types.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: ListBreakTypesResponse
    ListEmployeeWagesRequest:
      type: object
      properties:
        employee_id:
          type: string
          description: Filter the returned wages to only those that are associated
            with the specified employee.
        limit:
          maximum: 200
          minimum: 1
          type: integer
          description: |-
            The maximum number of `EmployeeWage` results to return per page. The number can range between
            1 and 200. The default is 200.
        cursor:
          type: string
          description: A pointer to the next page of `EmployeeWage` results to fetch.
      description: A request for a set of `EmployeeWage` objects.
      deprecated: true
      x-property-order:
      - employee_id
      - limit
      - cursor
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/list-employee-wages.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: ListEmployeeWagesRequest
      x-params-example: ?employee_id=33fJchumvVdJwxV0H6L9&limit=4&cursor=s4R0Z6ecFTzTC4jz8sUDBQTudX3KE313OT9fCt3VUgsXM4sMgED
    ListEmployeeWagesResponse:
      type: object
      properties:
        employee_wages:
          type: array
          description: A page of `EmployeeWage` results.
          items:
            $ref: '#/components/schemas/EmployeeWage'
        cursor:
          type: string
          description: |-
            The value supplied in the subsequent request to fetch the next page
            of `EmployeeWage` results.
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        The response to a request for a set of `EmployeeWage` objects. The response contains
        a set of `EmployeeWage` objects.
      example:
        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
      deprecated: true
      x-property-order:
      - employee_wages
      - cursor
      - errors
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/list-employee-wages.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: ListEmployeeWagesResponse
    ListTeamMemberWagesRequest:
      type: object
      properties:
        team_member_id:
          type: string
          description: |-
            Filter the returned wages to only those that are associated with the
            specified team member.
        limit:
          maximum: 200
          minimum: 1
          type: integer
          description: |-
            The maximum number of `TeamMemberWage` results to return per page. The number can range between
            1 and 200. The default is 200.
        cursor:
          type: string
          description: A pointer to the next page of `EmployeeWage` results to fetch.
      description: A request for a set of `TeamMemberWage` objects.
      x-property-order:
      - team_member_id
      - limit
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/list-team-member-wages.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: ListTeamMemberWagesRequest
      x-params-example: ?team_member_id=33fJchumvVdJwxV0H6L9&limit=4&cursor=s4R0Z6ecFTzTC4jz8sUDBQTudX3KE313OT9fCt3VUgsXM4sMgED
    ListTeamMemberWagesResponse:
      type: object
      properties:
        team_member_wages:
          type: array
          description: A page of `TeamMemberWage` results.
          items:
            $ref: '#/components/schemas/TeamMemberWage'
        cursor:
          type: string
          description: |-
            The value supplied in the subsequent request to fetch the next page
            of `TeamMemberWage` results.
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        The response to a request for a set of `TeamMemberWage` objects. The response contains
        a set of `TeamMemberWage` objects.
      example:
        team_member_wages:
        - id: pXS3qCv7BERPnEGedM4S8mhm
          team_member_id: 33fJchumvVdJwxV0H6L9
          title: Manager
          hourly_rate:
            amount: 3250
            currency: USD
        - id: rZduCkzYDUVL3ovh1sQgbue6
          team_member_id: 33fJchumvVdJwxV0H6L9
          title: Cook
          hourly_rate:
            amount: 2600
            currency: USD
        - id: FxLbs5KpPUHa8wyt5ctjubDX
          team_member_id: 33fJchumvVdJwxV0H6L9
          title: Barista
          hourly_rate:
            amount: 1600
            currency: USD
        - id: vD1wCgijMDR3cX5TPnu7VXto
          team_member_id: 33fJchumvVdJwxV0H6L9
          title: Cashier
          hourly_rate:
            amount: 1700
            currency: USD
        cursor: 2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED
      x-property-order:
      - team_member_wages
      - cursor
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/list-team-member-wages.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: ListTeamMemberWagesResponse
    ListWorkweekConfigsRequest:
      type: object
      properties:
        limit:
          minimum: 0
          type: integer
          description: The maximum number of `WorkweekConfigs` results to return per
            page.
        cursor:
          type: string
          description: A pointer to the next page of `WorkweekConfig` results to fetch.
      description: A request for a set of `WorkweekConfig` objects.
      x-property-order:
      - limit
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/list-workweek-configs.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: ListWorkweekConfigsRequest
      x-params-example: ?limit=1&cursor=s4R0Z6ecFTzTC4jz8sUDBQTudX3KE313OT9fCt3VUgsXM4sMgED
    ListWorkweekConfigsResponse:
      type: object
      properties:
        workweek_configs:
          type: array
          description: A page of `WorkweekConfig` results.
          items:
            $ref: '#/components/schemas/WorkweekConfig'
        cursor:
          type: string
          description: |-
            The value supplied in the subsequent request to fetch the next page of
            `WorkweekConfig` results.
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        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.
      example:
        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
      x-property-order:
      - workweek_configs
      - cursor
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/list-workweek-configs.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: ListWorkweekConfigsResponse
    SearchShiftsRequest:
      type: object
      properties:
        query:
          $ref: '#/components/schemas/ShiftQuery'
        limit:
          maximum: 200
          minimum: 1
          type: integer
          description: The number of resources in a page (200 by default).
        cursor:
          type: string
          description: An opaque cursor for fetching the next page.
      description: A request for a filtered and sorted set of `Shift` objects.
      example:
        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
      x-property-order:
      - query
      - limit
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/search-shifts.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: SearchShiftsRequest
    SearchShiftsResponse:
      type: object
      properties:
        shifts:
          type: array
          description: Shifts.
          items:
            $ref: '#/components/schemas/Shift'
        cursor:
          type: string
          description: An opaque cursor for fetching the next page.
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        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.
      example:
        shifts:
        - id: X714F3HA6D1PT
          team_member_id: ormj0jJJZ5OZIzxrZYJI
          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
          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
        - id: GDHYBZYWK0P2V
          team_member_id: 33fJchumvVdJwxV0H6L9
          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
          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
      x-property-order:
      - shifts
      - cursor
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/search-shifts.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: SearchShiftsResponse
    Shift:
      required:
      - start_at
      type: object
      properties:
        id:
          maxLength: 255
          type: string
          description: The UUID for this object.
        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
        location_id:
          type: string
          description: |-
            The ID of the location this shift occurred at. The location should be based on
            where the employee clocked in.
        timezone:
          type: string
          description: |-
            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:
          minLength: 1
          type: string
          description: |-
            RFC 3339; shifted to the location timezone + offset. Precision up to the
            minute is respected; seconds are truncated.
        end_at:
          type: string
          description: |-
            RFC 3339; shifted to the timezone + offset. Precision up to the minute is
            respected; seconds are truncated.
        wage:
          $ref: '#/components/schemas/ShiftWage'
        breaks:
          type: array
          description: A list of all the paid or unpaid breaks that were taken during
            this shift.
          items:
            $ref: '#/components/schemas/Break'
        status:
          $ref: '#/components/schemas/ShiftStatus'
        version:
          minimum: 0
          type: integer
          description: |-
            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: 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".
      description: |-
        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.
      x-property-order:
      - id
      - employee_id
      - location_id
      - timezone
      - start_at
      - end_at
      - wage
      - breaks
      - status
      - version
      - created_at
      - updated_at
      - team_member_id
      - tip_eligible
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/resources/datatypes.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: Shift
    ShiftFilter:
      type: object
      properties:
        location_ids:
          type: array
          description: Fetch shifts for the specified location.
          items:
            minLength: 1
            type: string
        employee_ids:
          type: array
          description: Fetch shifts for the specified employees. DEPRECATED at version
            2020-08-26. Use `team_member_ids` instead.
          items:
            type: string
          x-release-status: DEPRECATED
        status:
          $ref: '#/components/schemas/ShiftFilterStatus'
        start:
          $ref: '#/components/schemas/TimeRange'
        end:
          $ref: '#/components/schemas/TimeRange'
        workday:
          $ref: '#/components/schemas/ShiftWorkday'
        team_member_ids:
          type: array
          description: Fetch shifts for the specified team members. Replaced `employee_ids`
            at version "2020-08-26".
          items:
            minLength: 1
            type: string
      description: |-
        Defines a filter used in a search for `Shift` records. `AND` logic is
        used by Square's servers to apply each filter property specified.
      x-property-order:
      - location_ids
      - employee_ids
      - status
      - start
      - end
      - workday
      - location_id
      - employee_id
      - team_member_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/resources/datatypes.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: ShiftFilter
    ShiftQuery:
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/ShiftFilter'
        sort:
          $ref: '#/components/schemas/ShiftSort'
      description: The parameters of a `Shift` search query, which includes filter
        and sort options.
      x-property-order:
      - filter
      - sort
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/resources/datatypes.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: ShiftQuery
    ShiftSort:
      type: object
      properties:
        field:
          $ref: '#/components/schemas/ShiftSortField'
        order:
          $ref: '#/components/schemas/SortOrder'
      description: Sets the sort order of search results.
      x-property-order:
      - field
      - order
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/resources/datatypes.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: ShiftSort
    ShiftWage:
      type: object
      properties:
        title:
          type: string
          description: |-
            The name of the job performed during this shift. Square
            labor-reporting UIs might group shifts together by title.
        hourly_rate:
          $ref: '#/components/schemas/Money'
      description: The hourly wage rate used to compensate an employee for this shift.
      x-property-order:
      - title
      - hourly_rate
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/resources/datatypes.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: ShiftWage
    ShiftWorkday:
      type: object
      properties:
        date_range:
          $ref: '#/components/schemas/DateRange'
        match_shifts_by:
          $ref: '#/components/schemas/ShiftWorkdayMatcher'
        default_timezone:
          type: string
          description: |-
            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.
      description: |-
        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.
      x-property-order:
      - date_range
      - match_shifts_by
      - default_timezone
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/resources/datatypes.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: ShiftWorkday
    TeamMemberWage:
      type: object
      properties:
        id:
          type: string
          description: The UUID for this object.
        team_member_id:
          type: string
          description: The `TeamMember` that this wage is assigned to.
        title:
          type: string
          description: The job title that this wage relates to.
        hourly_rate:
          $ref: '#/components/schemas/Money'
      description: |-
        The hourly wage rate that a team member earns on a `Shift` for doing the job
        specified by the `title` property of this object.
      x-property-order:
      - id
      - team_member_id
      - title
      - hourly_rate
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/resources/datatypes.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: TeamMemberWage
    UpdateBreakTypeRequest:
      required:
      - break_type
      type: object
      properties:
        break_type:
          $ref: '#/components/schemas/BreakType'
      description: A request to update a `BreakType`.
      example:
        break_type:
          location_id: 26M7H24AZ9N6R
          break_name: Lunch
          expected_duration: PT50M
          is_paid: true
          version: 1
      x-property-order:
      - break_type
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/update-break-type.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: UpdateBreakTypeRequest
    UpdateBreakTypeResponse:
      type: object
      properties:
        break_type:
          $ref: '#/components/schemas/BreakType'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        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.
      example:
        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
      x-property-order:
      - break_type
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/update-break-type.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: UpdateBreakTypeResponse
    UpdateShiftRequest:
      required:
      - shift
      type: object
      properties:
        shift:
          $ref: '#/components/schemas/Shift'
      description: A request to update a `Shift` object.
      example:
        shift:
          team_member_id: ormj0jJJZ5OZIzxrZYJI
          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
          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
      x-property-order:
      - shift
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/update-shift.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: UpdateShiftRequest
    UpdateShiftResponse:
      type: object
      properties:
        shift:
          $ref: '#/components/schemas/Shift'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        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.
      example:
        shift:
          id: K0YH4CV5462JB
          team_member_id: ormj0jJJZ5OZIzxrZYJI
          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
          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
      x-property-order:
      - shift
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/update-shift.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: UpdateShiftResponse
    UpdateWorkweekConfigRequest:
      required:
      - workweek_config
      type: object
      properties:
        workweek_config:
          $ref: '#/components/schemas/WorkweekConfig'
      description: A request to update a `WorkweekConfig` object.
      example:
        workweek_config:
          start_of_week: MON
          start_of_day_local_time: 10:00
          version: 10
      x-property-order:
      - workweek_config
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/update-workweek-config.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: UpdateWorkweekConfigRequest
    UpdateWorkweekConfigResponse:
      type: object
      properties:
        workweek_config:
          $ref: '#/components/schemas/WorkweekConfig'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        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.
      example:
        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
      x-property-order:
      - workweek_config
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/interfaces/update-workweek-config.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: UpdateWorkweekConfigResponse
    WorkweekConfig:
      required:
      - start_of_day_local_time
      - start_of_week
      type: object
      properties:
        id:
          type: string
          description: The UUID for this object.
        start_of_week:
          $ref: '#/components/schemas/Weekday'
        start_of_day_local_time:
          minLength: 1
          type: string
          description: |-
            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:
          minimum: 0
          type: integer
          description: |-
            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: 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
      description: |-
        Sets the day of the week and hour of the day that a business starts a
        workweek. This is used to calculate overtime pay.
      x-property-order:
      - id
      - start_of_week
      - start_of_day_local_time
      - version
      - created_at
      - updated_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /timecards/timecards-proto/src/main/proto/squareup/labor_api/resources/datatypes.proto
      x-proto-sha: 5a25e3412f70d7dcf989dea839e82f432dd713e6
      x-object-name: WorkweekConfig
    AuthorizeRequest:
      required:
      - client_id
      type: object
      properties:
        client_id:
          maxLength: 191
          type: string
          description: "The Square-issued ID for your application, available from\
            \ \nthe OAuth page for your application on the Developer Dashboard."
        scope:
          type: array
          description: |-
            A space-separated list of the permissions that the application is requesting.
            Default: "`MERCHANT_PROFILE_READ PAYMENTS_READ SETTLEMENTS_READ BANK_ACCOUNTS_READ`"
            See [OAuthPermission](#type-oauthpermission) for possible values
          items:
            $ref: '#/components/schemas/OAuthPermission'
        locale:
          maxLength: 32
          minLength: 2
          type: string
          description: |-
            The locale to present the permission request form in. Square detects
            the appropriate locale automatically. Only provide this value if the
            application can definitively determine the preferred locale.

            Currently supported values: `en-IE`, `en-US`, `en-CA`, `es-US`, `fr-CA`, and
            `ja-JP`.
        session:
          type: boolean
          description: |-
            If `false`, the user must log in to their Square account to
            view the Permission Request form, even if they already have a valid user
            session. This value has no effect in Sandbox.
            Default: `true`
        state:
          maxLength: 2048
          minLength: 0
          type: string
          description: |-
            When provided, `state` is passed to the configured redirect URL after
            the Permission Request form is submitted. You can include `state` and verify
            its value to help protect against cross-site request forgery.
        code_challenge:
          type: string
          description: |-
            When provided, the oauth flow will use PKCE to authorize. The `code_challenge` will be associated
            with the authorization_code and a `code_verifier` will need to passed in to obtain the access token.
          x-release-status: BETA
      example:
        scope: PAYMENTS_WRITE PAYMENTS_READ CUSTOMERS_WRITE CUSTOMERS_READ
      x-property-order:
      - client_id
      - scope
      - locale
      - session
      - state
      - code_challenge
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /oauth/protos/squareup/oauth/v1/api.proto
      x-proto-sha: f1c3dbfadb8bfd89be4dd98d020e639b81a15b72
      x-object-name: AuthorizeRequest
      x-visibility: DOC_ONLY
    AuthorizeResponse:
      type: object
      properties:
        code:
          maxLength: 191
          type: string
          description: |-
            A valid authorization code. Authorization codes are exchanged
            for OAuth access tokens with the `ObtainToken` endpoint.
        state:
          maxLength: 2048
          minLength: 1
          type: string
          description: The same value specified in the request.
      example:
        code: code
        state: state
      x-property-order:
      - code
      - state
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /oauth/protos/squareup/oauth/v1/api.proto
      x-proto-sha: f1c3dbfadb8bfd89be4dd98d020e639b81a15b72
      x-object-name: AuthorizeResponse
      x-visibility: DOC_ONLY
    CreateMobileAuthorizationCodeRequest:
      type: object
      properties:
        location_id:
          maxLength: 191
          minLength: 1
          type: string
          description: The Square location ID that the authorization code should be
            tied to.
      description: |-
        Defines the body parameters that can be provided in a request to the
        `CreateMobileAuthorizationCode` endpoint.
      example:
        location_id: YOUR_LOCATION_ID
      x-property-order:
      - location_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /oauth/protos/squareup/oauth/v1/api.proto
      x-proto-sha: f1c3dbfadb8bfd89be4dd98d020e639b81a15b72
      x-object-name: CreateMobileAuthorizationCodeRequest
    CreateMobileAuthorizationCodeResponse:
      type: object
      properties:
        authorization_code:
          maxLength: 191
          minLength: 0
          type: string
          description: |-
            The generated authorization code that connects a mobile application instance
            to a Square account.
        expires_at:
          maxLength: 48
          minLength: 20
          type: string
          description: |-
            The timestamp when `authorization_code` expires, in
            [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, "2016-09-04T23:59:33.123Z").
        error:
          $ref: '#/components/schemas/Error'
      description: |-
        Defines the fields that are included in the response body of
        a request to the `CreateMobileAuthorizationCode` endpoint.
      example:
        authorization_code: YOUR_MOBILE_AUTHORIZATION_CODE
        expires_at: 2019-01-10T19:42:08Z
      x-property-order:
      - authorization_code
      - expires_at
      - error
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /oauth/protos/squareup/oauth/v1/api.proto
      x-proto-sha: f1c3dbfadb8bfd89be4dd98d020e639b81a15b72
      x-object-name: CreateMobileAuthorizationCodeResponse
    ObtainTokenRequest:
      required:
      - client_id
      - grant_type
      type: object
      properties:
        client_id:
          maxLength: 191
          type: string
          description: |-
            The Square-issued ID of your application, which is available in the OAuth page in the
            [Developer Dashboard](https://developer.squareup.com/apps).
        client_secret:
          maxLength: 1024
          minLength: 2
          type: string
          description: "The Square-issued application secret for your application,\
            \ which is available in the OAuth page\nin the [Developer Dashboard](https://developer.squareup.com/apps).\
            \ This parameter is only required when you are not using the [OAuth PKCE\
            \ (Proof Key for Code Exchange) flow](https://developer.squareup.com/docs/oauth-api/overview#pkce-flow).\
            \ \nThe PKCE flow requires a `code_verifier` instead of a `client_secret`."
        code:
          maxLength: 191
          minLength: 0
          type: string
          description: |-
            The authorization code to exchange.
            This code is required if `grant_type` is set to `authorization_code` to indicate that
            the application wants to exchange an authorization code for an OAuth access token.
        redirect_uri:
          maxLength: 2048
          minLength: 0
          type: string
          description: The redirect URL assigned in the OAuth page for your application
            in the [Developer Dashboard](https://developer.squareup.com/apps).
        grant_type:
          maxLength: 20
          minLength: 10
          type: string
          description: |-
            Specifies the method to request an OAuth access token.
            Valid values are `authorization_code`, `refresh_token`, and `migration_token`.
        refresh_token:
          maxLength: 1024
          minLength: 2
          type: string
          description: |-
            A valid refresh token for generating a new OAuth access token.

            A valid refresh token is required if `grant_type` is set to `refresh_token`
            to indicate that the application wants a replacement for an expired OAuth access token.
        migration_token:
          maxLength: 1024
          minLength: 2
          type: string
          description: |-
            A legacy OAuth access token obtained using a Connect API version prior
            to 2019-03-13. This parameter is required if `grant_type` is set to
            `migration_token` to indicate that the application wants to get a replacement
            OAuth access token. The response also returns a refresh token.
            For more information, see [Migrate to Using Refresh Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens).
        scopes:
          type: array
          description: |-
            A JSON list of strings representing the permissions that the application is requesting.
            For example, "`["MERCHANT_PROFILE_READ","PAYMENTS_READ","BANK_ACCOUNTS_READ"]`".

            The access token returned in the response is granted the permissions
            that comprise the intersection between the requested list of permissions and those
            that belong to the provided refresh token.
          items:
            type: string
        short_lived:
          type: boolean
          description: |-
            A Boolean indicating a request for a short-lived access token.

            The short-lived access token returned in the response expires in 24 hours.
        code_verifier:
          type: string
          description: |-
            Must be provided when using PKCE OAuth flow. The `code_verifier` will be used to verify against the
            `code_challenge` associated with the `authorization_code`.
          x-release-status: BETA
      example:
        client_id: APPLICATION_ID
        client_secret: APPLICATION_SECRET
        code: CODE_FROM_AUTHORIZE
        grant_type: authorization_code
      x-property-order:
      - client_id
      - client_secret
      - code
      - redirect_uri
      - grant_type
      - refresh_token
      - migration_token
      - scopes
      - short_lived
      - code_verifier
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /oauth/protos/squareup/oauth/v1/api.proto
      x-proto-sha: f1c3dbfadb8bfd89be4dd98d020e639b81a15b72
      x-object-name: ObtainTokenRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/ObtainToken/ObtainTokenRequest.python
        csharp: /sdk_samples/ObtainToken/ObtainTokenRequest.csharp
        java: /sdk_samples/ObtainToken/ObtainTokenRequest.java
        php: /sdk_samples/ObtainToken/ObtainTokenRequest.php
        javascript: /sdk_samples/ObtainToken/ObtainTokenRequest.javascript
        ruby: /sdk_samples/ObtainToken/ObtainTokenRequest.ruby
    ObtainTokenResponse:
      type: object
      properties:
        access_token:
          maxLength: 1024
          minLength: 2
          type: string
          description: |-
            A valid OAuth access token. OAuth access tokens are 64 bytes long.
            Provide the access token in a header with every request to Connect API
            endpoints. For more information, see [OAuth API: Walkthrough](https://developer.squareup.com/docs/oauth-api/walkthrough).
        token_type:
          maxLength: 10
          minLength: 2
          type: string
          description: This value is always _bearer_.
        expires_at:
          maxLength: 48
          minLength: 20
          type: string
          description: The date when the `access_token` expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm)
            format.
        merchant_id:
          maxLength: 191
          minLength: 8
          type: string
          description: The ID of the authorizing merchant's business.
        subscription_id:
          type: string
          description: |-
            __LEGACY FIELD__. The ID of a subscription plan the merchant signed up
            for. The ID is only present if the merchant signed up for a subscription plan during authorization.
        plan_id:
          type: string
          description: |-
            __LEGACY FIELD__. 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: string
          description: |-
            The OpenID token belonging to this person. This token is only present if the
            OPENID scope is included in the authorization request.
          x-release-status: DEPRECATED
        refresh_token:
          maxLength: 1024
          minLength: 2
          type: string
          description: |-
            A refresh token. OAuth refresh tokens are 64 bytes long.
            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:
          type: boolean
          description: |-
            A Boolean indicating that the access token is a short-lived access token.
            The short-lived access token returned in the response expires in 24 hours.
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        refresh_token_expires_at:
          maxLength: 48
          minLength: 20
          type: string
          description: The date when the `refresh_token` expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm)
            format.
      example:
        access_token: ACCESS_TOKEN
        token_type: bearer
        expires_at: 2006-01-02T15:04:05Z
        merchant_id: MERCHANT_ID
        refresh_token: REFRESH_TOKEN
      x-property-order:
      - access_token
      - token_type
      - expires_at
      - merchant_id
      - subscription_id
      - plan_id
      - id_token
      - refresh_token
      - short_lived
      - errors
      - refresh_token_expires_at
      - app_subscription_id
      - app_plan_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /oauth/protos/squareup/oauth/v1/api.proto
      x-proto-sha: f1c3dbfadb8bfd89be4dd98d020e639b81a15b72
      x-object-name: ObtainTokenResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/ObtainToken/ObtainTokenResponse.python
        csharp: /sdk_samples/ObtainToken/ObtainTokenResponse.csharp
        java: /sdk_samples/ObtainToken/ObtainTokenResponse.java
        php: /sdk_samples/ObtainToken/ObtainTokenResponse.php
        javascript: /sdk_samples/ObtainToken/ObtainTokenResponse.javascript
        ruby: /sdk_samples/ObtainToken/ObtainTokenResponse.ruby
    RenewTokenRequest:
      type: object
      properties:
        access_token:
          maxLength: 1024
          minLength: 2
          type: string
          description: The token you want to renew.
      example:
        access_token: ACCESS_TOKEN
      deprecated: true
      x-property-order:
      - access_token
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /oauth/protos/squareup/oauth/v1/api.proto
      x-proto-sha: f1c3dbfadb8bfd89be4dd98d020e639b81a15b72
      x-object-name: RenewTokenRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/RenewToken/RenewTokenRequest.python
        csharp: /sdk_samples/RenewToken/RenewTokenRequest.csharp
        java: /sdk_samples/RenewToken/RenewTokenRequest.java
        php: /sdk_samples/RenewToken/RenewTokenRequest.php
        javascript: /sdk_samples/RenewToken/RenewTokenRequest.javascript
        ruby: /sdk_samples/RenewToken/RenewTokenRequest.ruby
    RenewTokenResponse:
      type: object
      properties:
        access_token:
          maxLength: 1024
          minLength: 2
          type: string
          description: |-
            The renewed access token.
            This value might be different from the `access_token` you provided in your request.
            You provide this token in a header with every request to Connect API endpoints.
            See [Request and response headers](https://developer.squareup.com/docs/api/connect/v2/#requestandresponseheaders) for the format of this header.
        token_type:
          maxLength: 10
          minLength: 2
          type: string
          description: This value is always _bearer_.
        expires_at:
          maxLength: 48
          minLength: 20
          type: string
          description: The date when the `access_token` expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm)
            format.
        merchant_id:
          maxLength: 191
          minLength: 8
          type: string
          description: The ID of the authorizing merchant's business.
        subscription_id:
          type: string
          description: |-
            __LEGACY FIELD__. The ID of the merchant subscription associated with
            the authorization. The ID is only present if the merchant signed up for a subscription
            during authorization.
        plan_id:
          type: string
          description: |-
            __LEGACY FIELD__. 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.
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        access_token: ACCESS_TOKEN
        token_type: bearer
        expires_at: 2006-01-02T15:04:05Z
        merchant_id: MERCHANT_ID
      deprecated: true
      x-property-order:
      - access_token
      - token_type
      - expires_at
      - merchant_id
      - subscription_id
      - plan_id
      - errors
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /oauth/protos/squareup/oauth/v1/api.proto
      x-proto-sha: f1c3dbfadb8bfd89be4dd98d020e639b81a15b72
      x-object-name: RenewTokenResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/RenewToken/RenewTokenResponse.python
        csharp: /sdk_samples/RenewToken/RenewTokenResponse.csharp
        java: /sdk_samples/RenewToken/RenewTokenResponse.java
        php: /sdk_samples/RenewToken/RenewTokenResponse.php
        javascript: /sdk_samples/RenewToken/RenewTokenResponse.javascript
        ruby: /sdk_samples/RenewToken/RenewTokenResponse.ruby
    RevokeTokenRequest:
      type: object
      properties:
        client_id:
          maxLength: 191
          type: string
          description: |-
            The Square-issued ID for your application, which is available in the OAuth page in the
            [Developer Dashboard](https://developer.squareup.com/apps).
        access_token:
          maxLength: 1024
          minLength: 2
          type: string
          description: |-
            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:
          type: string
          description: |-
            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: boolean
          description: |-
            If `true`, terminate the given single access token, but do not
            terminate the entire authorization.
            Default: `false`
      example:
        access_token: ACCESS_TOKEN
        client_id: CLIENT_ID
      x-property-order:
      - client_id
      - access_token
      - merchant_id
      - revoke_only_access_token
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /oauth/protos/squareup/oauth/v1/api.proto
      x-proto-sha: f1c3dbfadb8bfd89be4dd98d020e639b81a15b72
      x-object-name: RevokeTokenRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/RevokeToken/RevokeTokenRequest.python
        csharp: /sdk_samples/RevokeToken/RevokeTokenRequest.csharp
        java: /sdk_samples/RevokeToken/RevokeTokenRequest.java
        php: /sdk_samples/RevokeToken/RevokeTokenRequest.php
        javascript: /sdk_samples/RevokeToken/RevokeTokenRequest.javascript
        ruby: /sdk_samples/RevokeToken/RevokeTokenRequest.ruby
    RevokeTokenResponse:
      type: object
      properties:
        success:
          type: boolean
          description: If the request is successful, this is `true`.
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        success: true
      x-property-order:
      - success
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /oauth/protos/squareup/oauth/v1/api.proto
      x-proto-sha: f1c3dbfadb8bfd89be4dd98d020e639b81a15b72
      x-object-name: RevokeTokenResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/RevokeToken/RevokeTokenResponse.python
        csharp: /sdk_samples/RevokeToken/RevokeTokenResponse.csharp
        java: /sdk_samples/RevokeToken/RevokeTokenResponse.java
        php: /sdk_samples/RevokeToken/RevokeTokenResponse.php
        javascript: /sdk_samples/RevokeToken/RevokeTokenResponse.javascript
        ruby: /sdk_samples/RevokeToken/RevokeTokenResponse.ruby
    BatchRetrieveOrdersRequest:
      required:
      - order_ids
      type: object
      properties:
        location_id:
          type: string
          description: |-
            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:
          type: array
          description: The IDs of the orders to retrieve. A maximum of 100 orders
            can be retrieved per request.
          items:
            minLength: 1
            type: string
      description: |-
        Defines the fields that are included in requests to the
        `BatchRetrieveOrders` endpoint.
      example:
        location_id: 057P5VYJ4A5X1
        order_ids:
        - CAISEM82RcpmcFBM0TfOyiHV3es
        - CAISENgvlJ6jLWAzERDzjyHVybY
      x-property-order:
      - location_id
      - order_ids
      - merchant_id
      - resolve_returns
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: BatchRetrieveOrdersRequest
    BatchRetrieveOrdersResponse:
      type: object
      properties:
        orders:
          type: array
          description: The requested orders. This will omit any requested orders that
            do not exist.
          items:
            $ref: '#/components/schemas/Order'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Defines the fields that are included in the response body of
        a request to the `BatchRetrieveOrders` endpoint.
      example:
        orders:
        - id: CAISEM82RcpmcFBM0TfOyiHV3es
          location_id: 057P5VYJ4A5X1
          reference_id: my-order-001
          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
          total_money:
            amount: 7599
            currency: USD
      x-property-order:
      - orders
      - errors
      - unconvertible_transaction_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: BatchRetrieveOrdersResponse
    CalculateOrderRequest:
      required:
      - order
      type: object
      properties:
        order:
          $ref: '#/components/schemas/Order'
        proposed_rewards:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/OrderReward'
      example:
        idempotency_key: b3e98fe3-b8de-471c-82f1-545f371e637c
        order:
          location_id: D7AVYMEAPJ3A3
          discounts:
          - name: 50% Off
            percentage: "50"
            scope: ORDER
          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
      x-property-order:
      - order
      - proposed_discount_codes
      - proposed_rewards
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: CalculateOrderRequest
    CalculateOrderResponse:
      type: object
      properties:
        order:
          $ref: '#/components/schemas/Order'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        order:
          location_id: D7AVYMEAPJ3A3
          line_items:
          - uid: ULkg0tQTRK2bkU9fNv3IJD
            quantity: "1"
            name: Item 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: 250
              currency: USD
            total_money:
              amount: 250
              currency: USD
            variation_total_price_money:
              amount: 500
              currency: USD
            applied_discounts:
            - uid: 9zr9S4dxvPAixvn0lpa1VC
              discount_uid: zGsRZP69aqSSR9lq9euSPB
              applied_money:
                amount: 250
                currency: USD
          - uid: mumY8Nun4BC5aKe2yyx5a
            quantity: "2"
            name: Item 2
            base_price_money:
              amount: 300
              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
            variation_total_price_money:
              amount: 600
              currency: USD
            applied_discounts:
            - uid: qa8LwwZK82FgSEkQc2HYVC
              discount_uid: zGsRZP69aqSSR9lq9euSPB
              applied_money:
                amount: 300
                currency: USD
          discounts:
          - uid: zGsRZP69aqSSR9lq9euSPB
            name: 50% Off
            percentage: "50"
            applied_money:
              amount: 550
              currency: USD
            type: FIXED_PERCENTAGE
            scope: ORDER
          created_at: 2020-05-18T16:30:49.614Z
          updated_at: 2020-05-18T16:30:49.614Z
          state: OPEN
          version: 1
          total_tax_money:
            amount: 0
            currency: USD
          total_discount_money:
            amount: 550
            currency: USD
          total_tip_money:
            amount: 0
            currency: USD
          total_money:
            amount: 550
            currency: USD
          total_service_charge_money:
            amount: 0
            currency: USD
          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
      x-property-order:
      - order
      - errors
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: CalculateOrderResponse
    CloneOrderRequest:
      required:
      - order_id
      type: object
      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\n\
            If 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.

            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/basics/api101/idempotency).
      description: |-
        Defines the fields that are included in requests to the
        [CloneOrder](api-endpoint:Orders-CloneOrder) endpoint.
      example:
        order_id: ZAISEM52YcpmcWAzERDOyiWS123
        version: 3
        idempotency_key: UNIQUE_STRING
      x-property-order:
      - order_id
      - version
      - idempotency_key
      - merchant_id
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: CloneOrderRequest
    CloneOrderResponse:
      type: object
      properties:
        order:
          $ref: '#/components/schemas/Order'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Defines the fields that are included in the response body of
        a request to the [CloneOrder](api-endpoint:Orders-CloneOrder) endpoint.
      example:
        order:
          id: CAISENgvlJ6jLWAzERDzjyHVybY
          location_id: 057P5VYJ4A5X1
          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
            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
            variation_total_price_money:
              amount: 1599
              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
            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
            variation_total_price_money:
              amount: 4400
              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
          created_at: 2020-01-17T20:47:53.293Z
          updated_at: 2020-01-17T20:47:53.293Z
          state: DRAFT
          version: 1
          reference_id: my-order-001
          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
          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
          source:
            name: My App
      x-property-order:
      - order
      - errors
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: CloneOrderResponse
    CreateOrderRequest:
      type: object
      properties:
        order:
          $ref: '#/components/schemas/Order'
        idempotency_key:
          maxLength: 192
          type: string
          description: |-
            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/basics/api101/idempotency).
      example:
        idempotency_key: 8193148c-9586-11e6-99f9-28cfe92138cf
        order:
          reference_id: my-order-001
          location_id: 057P5VYJ4A5X1
          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
      x-property-order:
      - order
      - location_id
      - idempotency_key
      - reference_id
      - line_items
      - taxes
      - discounts
      - fulfillments
      - precalculated_order
      - creation_processing_mode
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/create_order.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: CreateOrderRequest
    CreateOrderResponse:
      type: object
      properties:
        order:
          $ref: '#/components/schemas/Order'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        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.
      example:
        order:
          id: CAISENgvlJ6jLWAzERDzjyHVybY
          location_id: 057P5VYJ4A5X1
          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
            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
            variation_total_price_money:
              amount: 1599
              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
            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
            variation_total_price_money:
              amount: 4400
              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
          created_at: 2020-01-17T20:47:53.293Z
          updated_at: 2020-01-17T20:47:53.293Z
          state: OPEN
          version: 1
          reference_id: my-order-001
          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
          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
          source:
            name: My App
      x-property-order:
      - order
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/create_order.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: CreateOrderResponse
    OrderEntry:
      type: object
      properties:
        order_id:
          type: string
          description: The ID of the order.
        version:
          type: integer
          description: |-
            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)
          readOnly: true
          x-release-status: BETA
        location_id:
          type: string
          description: The location ID the order belongs to.
      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-property-order:
      - order_id
      - version
      - location_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/order_entry.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderEntry
    PayOrderRequest:
      required:
      - idempotency_key
      type: object
      properties:
        idempotency_key:
          maxLength: 192
          minLength: 1
          type: string
          description: |-
            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:
          type: integer
          description: The version of the order being paid. If not supplied, the latest
            version will be paid.
        payment_ids:
          type: array
          description: |-
            The IDs of the [payments](entity:Payment) to collect.
            The payment total must match the order total.
          items:
            type: string
      description: |-
        Defines the fields that are included in requests to the
        [PayOrder](api-endpoint:Orders-PayOrder) endpoint.
      example:
        idempotency_key: c043a359-7ad9-4136-82a9-c3f1d66dcbff
        payment_ids:
        - EnZdNAlWCmfh6Mt5FMNST1o7taB
        - 0LRiVlbXVwe8ozu4KbZxd12mvaB
      x-property-order:
      - idempotency_key
      - order_version
      - payment_ids
      - delay_completion
      - completion_processing_mode
      - payment_type
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: PayOrderRequest
    PayOrderResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        order:
          $ref: '#/components/schemas/Order'
      description: |-
        Defines the fields that are included in the response body of a request to the
        [PayOrder](api-endpoint:Orders-PayOrder) endpoint.
      example:
        order:
          id: lgwOlEityYPJtcuvKTVKT1pA986YY
          location_id: P3CCK6HSNDAS7
          line_items:
          - uid: QW6kofLHJK7JEKMjlSVP5C
            quantity: "1"
            name: Item 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
          - uid: zhw8MNfRGdFQMI2WE1UBJD
            quantity: "2"
            name: Item 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
          created_at: 2019-08-06T02:47:35.693Z
          updated_at: 2019-08-06T02:47:37.140Z
          version: 4
          total_tax_money:
            amount: 0
            currency: USD
          total_discount_money:
            amount: 0
            currency: USD
          total_money:
            amount: 2000
            currency: USD
          closed_at: 2019-08-06T02:47:37.140Z
          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
          total_service_charge_money:
            amount: 0
            currency: USD
          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
          source:
            name: Source Name
          state: COMPLETED
      x-property-order:
      - errors
      - order
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: PayOrderResponse
    RetrieveOrderRequest:
      type: object
      properties: {}
      example: {}
      x-property-order:
      - resolve_returns
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: RetrieveOrderRequest
    RetrieveOrderResponse:
      type: object
      properties:
        order:
          $ref: '#/components/schemas/Order'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        order:
          id: CAISENgvlJ6jLWAzERDzjyHVybY
          location_id: D7AVYMEAPJ3A3
          line_items:
          - uid: ULkg0tQTRK2bkU9fNv3IJD
            quantity: "1"
            name: Item 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: 250
              currency: USD
            total_money:
              amount: 250
              currency: USD
            variation_total_price_money:
              amount: 500
              currency: USD
            applied_discounts:
            - uid: 9zr9S4dxvPAixvn0lpa1VC
              discount_uid: zGsRZP69aqSSR9lq9euSPB
              applied_money:
                amount: 250
                currency: USD
          - uid: mumY8Nun4BC5aKe2yyx5a
            quantity: "2"
            name: Item 2
            base_price_money:
              amount: 300
              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
            variation_total_price_money:
              amount: 600
              currency: USD
            applied_discounts:
            - uid: qa8LwwZK82FgSEkQc2HYVC
              discount_uid: zGsRZP69aqSSR9lq9euSPB
              applied_money:
                amount: 300
                currency: USD
          discounts:
          - uid: zGsRZP69aqSSR9lq9euSPB
            name: 50% Off
            percentage: "50"
            applied_money:
              amount: 550
              currency: USD
            type: FIXED_PERCENTAGE
            scope: ORDER
          created_at: 2020-05-18T16:30:49.614Z
          updated_at: 2020-05-18T16:30:49.614Z
          state: OPEN
          version: 1
          total_tax_money:
            amount: 0
            currency: USD
          total_discount_money:
            amount: 550
            currency: USD
          total_tip_money:
            amount: 0
            currency: USD
          total_money:
            amount: 550
            currency: USD
          total_service_charge_money:
            amount: 0
            currency: USD
          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
      x-property-order:
      - order
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: RetrieveOrderResponse
    SearchOrdersCustomerFilter:
      type: object
      properties:
        customer_ids:
          maxItems: 10
          type: array
          description: |-
            A list of customer IDs to filter by.

            Max: 10 customer IDs.
          items:
            type: string
      description: |-
        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:OrderFulfillmentRecipient) `customer_id`.
      x-property-order:
      - customer_ids
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/search_orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: SearchOrdersCustomerFilter
    SearchOrdersDateTimeFilter:
      type: object
      properties:
        created_at:
          $ref: '#/components/schemas/TimeRange'
        updated_at:
          $ref: '#/components/schemas/TimeRange'
        closed_at:
          $ref: '#/components/schemas/TimeRange'
      description: |-
        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#important-note-on-filtering-orders-by-time-range)
      x-property-order:
      - created_at
      - updated_at
      - closed_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/search_orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: SearchOrdersDateTimeFilter
    SearchOrdersFilter:
      type: object
      properties:
        state_filter:
          $ref: '#/components/schemas/SearchOrdersStateFilter'
        date_time_filter:
          $ref: '#/components/schemas/SearchOrdersDateTimeFilter'
        fulfillment_filter:
          $ref: '#/components/schemas/SearchOrdersFulfillmentFilter'
        source_filter:
          $ref: '#/components/schemas/SearchOrdersSourceFilter'
        customer_filter:
          $ref: '#/components/schemas/SearchOrdersCustomerFilter'
      description: |-
        Filtering criteria to use for a `SearchOrders` request. Multiple filters
        are ANDed together.
      x-property-order:
      - workflow_filter
      - state_filter
      - reference_id_filter
      - date_time_filter
      - fulfillment_filter
      - source_filter
      - customer_filter
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/search_orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: SearchOrdersFilter
    SearchOrdersFulfillmentFilter:
      type: object
      properties:
        fulfillment_types:
          type: array
          description: |-
            A list of [fulfillment types](entity:OrderFulfillmentType) to filter
            for. The list returns orders if any of its fulfillments match any of the fulfillment types
            listed in this field.
            See [OrderFulfillmentType](#type-orderfulfillmenttype) for possible values
          items:
            $ref: '#/components/schemas/OrderFulfillmentType'
        fulfillment_states:
          type: array
          description: |-
            A list of [fulfillment states](entity:OrderFulfillmentState) to filter
            for. The list returns orders if any of its fulfillments match any of the
            fulfillment states listed in this field.
            See [OrderFulfillmentState](#type-orderfulfillmentstate) for possible values
          items:
            $ref: '#/components/schemas/OrderFulfillmentState'
      description: Filter based on [order fulfillment](entity:OrderFulfillment) information.
      x-property-order:
      - fulfillment_types
      - fulfillment_states
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/search_orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: SearchOrdersFulfillmentFilter
    SearchOrdersQuery:
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/SearchOrdersFilter'
        sort:
          $ref: '#/components/schemas/SearchOrdersSort'
      description: Contains query criteria for the search.
      x-property-order:
      - filter
      - sort
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/search_orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: SearchOrdersQuery
    SearchOrdersRequest:
      type: object
      properties:
        location_ids:
          type: array
          description: |-
            The location IDs for the orders to query. All locations must belong to
            the same merchant.

            Min: 1 location ID.

            Max: 10 location IDs.
          items:
            type: string
        cursor:
          type: string
          description: |-
            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/basics/api101/pagination).
        query:
          $ref: '#/components/schemas/SearchOrdersQuery'
        limit:
          minimum: 1
          type: integer
          description: |-
            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.

            Default: `500`
        return_entries:
          type: boolean
          description: |-
            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`.
      description: |-
        The request does not have any required fields. When given no query criteria,
        `SearchOrders` returns all results for all of the seller's locations. When retrieving additional
        pages using a `cursor`, the `query` must be equal to the `query` used to retrieve the first page of
        results.
      example:
        return_entries: true
        limit: 3
        location_ids:
        - 057P5VYJ4A5X1
        - 18YC4JDH91E1H
        query:
          filter:
            date_time_filter:
              closed_at:
                start_at: 2018-03-03T20:00:00+00:00
                end_at: 2019-03-04T21:54:45+00:00
            state_filter:
              states:
              - COMPLETED
          sort:
            sort_field: CLOSED_AT
            sort_order: DESC
      x-property-order:
      - location_ids
      - merchant_id
      - cursor
      - query
      - limit
      - return_entries
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/search_orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: SearchOrdersRequest
    SearchOrdersResponse:
      type: object
      properties:
        order_entries:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/OrderEntry'
        orders:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/Order'
        cursor:
          type: string
          description: |-
            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/basics/api101/pagination).
        errors:
          type: array
          description: '[Errors](entity:Error) encountered during the search.'
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Either the `order_entries` or `orders` field is set, depending on whether
        `return_entries` is set on the [SearchOrdersRequest](api-endpoint:Orders-SearchOrders).
      example:
        order_entries:
        - order_id: CAISEM82RcpmcFBM0TfOyiHV3es
          location_id: 057P5VYJ4A5X1
          version: 1
        - order_id: CAISENgvlJ6jLWAzERDzjyHVybY
          location_id: 18YC4JDH91E1H
        - order_id: CAISEM52YcpmcWAzERDOyiWS3ty
          location_id: 057P5VYJ4A5X1
        cursor: "123"
      x-property-order:
      - order_entries
      - orders
      - cursor
      - errors
      - unconvertible_transaction_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/search_orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: SearchOrdersResponse
    SearchOrdersSort:
      required:
      - sort_field
      type: object
      properties:
        sort_field:
          $ref: '#/components/schemas/SearchOrdersSortField'
        sort_order:
          $ref: '#/components/schemas/SortOrder'
      description: |-
        Sorting criteria for a `SearchOrders` request. Results can only be sorted
        by a timestamp field.
      x-property-order:
      - sort_field
      - sort_order
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/search_orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: SearchOrdersSort
    SearchOrdersSourceFilter:
      type: object
      properties:
        source_names:
          maxItems: 10
          type: array
          description: |-
            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.
          items:
            type: string
      description: A filter based on order `source` information.
      x-property-order:
      - source_names
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/search_orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: SearchOrdersSourceFilter
    SearchOrdersStateFilter:
      required:
      - states
      type: object
      properties:
        states:
          type: array
          description: |-
            States to filter for.
            See [OrderState](#type-orderstate) for possible values
          items:
            $ref: '#/components/schemas/OrderState'
      description: Filter by the current order `state`.
      x-property-order:
      - states
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/search_orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: SearchOrdersStateFilter
    UpdateOrderRequest:
      type: object
      properties:
        order:
          $ref: '#/components/schemas/Order'
        fields_to_clear:
          type: array
          description: |-
            The [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot-notation)
            fields to clear. For example, `line_items[uid].note`.
            For more information, see [Deleting fields](https://developer.squareup.com/docs/orders-api/manage-orders#delete-fields).
          items:
            type: string
        idempotency_key:
          maxLength: 192
          type: string
          description: |-
            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/basics/api101/idempotency).
      description: |-
        Defines the fields that are included in requests to the
        [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint.
      example:
        idempotency_key: UNIQUE_STRING
        order:
          version: 1
          line_items:
          - uid: cookie_uid
            quantity: "2"
            name: COOKIE
            base_price_money:
              amount: 200
              currency: USD
        fields_to_clear:
        - discounts
      x-property-order:
      - order
      - fields_to_clear
      - order_locks_for_update
      - idempotency_key
      - precalculated_order
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: UpdateOrderRequest
    UpdateOrderResponse:
      type: object
      properties:
        order:
          $ref: '#/components/schemas/Order'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Defines the fields that are included in the response body of
        a request to the [UpdateOrder](api-endpoint:Orders-UpdateOrder) endpoint.
      example:
        order:
          version: 2
          total_money:
            currency: USD
            amount: 900
          source:
            name: Cookies
          line_items:
          - total_tax_money:
              currency: USD
              amount: 0
            total_money:
              amount: 500
              currency: USD
            gross_sales_money:
              amount: 500
              currency: USD
            base_price_money:
              amount: 500
              currency: USD
            quantity: "1"
            total_discount_money:
              currency: USD
              amount: 0
            name: Small Coffee
            uid: EuYkakhmu3ksHIds5Hiot
            variation_total_price_money:
              amount: 500
              currency: USD
          - total_money:
              amount: 400
              currency: USD
            gross_sales_money:
              currency: USD
              amount: 400
            total_tax_money:
              currency: USD
              amount: 0
            variation_total_price_money:
              currency: USD
              amount: 400
            name: COOKIE
            uid: cookie_uid
            base_price_money:
              amount: 200
              currency: USD
            quantity: "2"
            total_discount_money:
              amount: 0
              currency: USD
          state: OPEN
          total_service_charge_money:
            amount: 0
            currency: USD
          id: DREk7wJcyXNHqULq8JJ2iPAsluJZY
          location_id: MXVQSVNDGN3C8
          total_tax_money:
            amount: 0
            currency: USD
          created_at: 2019-08-23T18:26:18.243Z
          total_discount_money:
            amount: 0
            currency: USD
          net_amounts:
            service_charge_money:
              currency: USD
              amount: 0
            total_money:
              amount: 900
              currency: USD
            discount_money:
              currency: USD
              amount: 0
            tax_money:
              currency: USD
              amount: 0
          updated_at: 2019-08-23T18:33:47.523Z
      x-property-order:
      - order
      - errors
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-service-proto/src/main/proto/squareup/omg/service.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: UpdateOrderResponse
    Order:
      required:
      - location_id
      type: object
      properties:
        id:
          type: string
          description: The order's unique ID.
          readOnly: true
        location_id:
          minLength: 1
          type: string
          description: The ID of the seller location that this order is associated
            with.
        reference_id:
          maxLength: 40
          type: string
          description: |-
            A client-specified ID to associate an entity in another system
            with this order.
        source:
          $ref: '#/components/schemas/OrderSource'
        customer_id:
          maxLength: 191
          type: string
          description: |-
            The ID of the [customer](entity:Customer) associated with the order.

            __IMPORTANT:__ You should specify a `customer_id` if you want the corresponding payment transactions
            to be explicitly linked to the customer in the Seller Dashboard. If this field is omitted, the
            `customer_id` assigned to any underlying `Payment` objects is ignored and might result in the
            creation of new [instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).
          x-release-status: BETA
        line_items:
          type: array
          description: The line items included in the order.
          items:
            $ref: '#/components/schemas/OrderLineItem'
        taxes:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/OrderLineItemTax'
        discounts:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/OrderLineItemDiscount'
        service_charges:
          type: array
          description: A list of service charges applied to the order.
          items:
            $ref: '#/components/schemas/OrderServiceCharge'
        fulfillments:
          type: array
          description: |-
            Details about order fulfillment.

            Orders can only be created with at most one fulfillment. However, orders returned
            by the API might contain multiple fulfillments.
          items:
            $ref: '#/components/schemas/OrderFulfillment'
        returns:
          type: array
          description: |-
            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.
          readOnly: true
          items:
            $ref: '#/components/schemas/OrderReturn'
          x-release-status: BETA
        return_amounts:
          $ref: '#/components/schemas/OrderMoneyAmounts'
        net_amounts:
          $ref: '#/components/schemas/OrderMoneyAmounts'
        rounding_adjustment:
          $ref: '#/components/schemas/OrderRoundingAdjustment'
        tenders:
          type: array
          description: The tenders that were used to pay for the order.
          readOnly: true
          items:
            $ref: '#/components/schemas/Tender'
          x-release-status: BETA
        refunds:
          type: array
          description: The refunds that are part of this order.
          readOnly: true
          items:
            $ref: '#/components/schemas/Refund'
          x-release-status: BETA
        metadata:
          type: object
          additionalProperties:
            type: string
          description: |-
            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).
          x-release-status: BETA
        created_at:
          type: string
          description: The timestamp for when the order was created, 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, 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'
        version:
          type: integer
          description: |-
            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).
          x-release-status: BETA
        total_money:
          $ref: '#/components/schemas/Money'
        total_tax_money:
          $ref: '#/components/schemas/Money'
        total_discount_money:
          $ref: '#/components/schemas/Money'
        total_tip_money:
          $ref: '#/components/schemas/Money'
        total_service_charge_money:
          $ref: '#/components/schemas/Money'
        ticket_name:
          maxLength: 30
          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)."
          x-release-status: BETA
        pricing_options:
          $ref: '#/components/schemas/OrderPricingOptions'
        rewards:
          type: array
          description: A set-like list of Rewards that have been added to the Order.
          readOnly: true
          items:
            $ref: '#/components/schemas/OrderReward'
          x-release-status: BETA
        net_amount_due_money:
          $ref: '#/components/schemas/Money'
      description: |-
        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.
      x-property-order:
      - id
      - location_id
      - reference_id
      - creator_app_id
      - source
      - customer_id
      - name
      - merchant_id
      - line_items
      - taxes
      - discounts
      - service_charges
      - tips
      - fulfillments
      - returns
      - return_amounts
      - net_amounts
      - rounding_adjustment
      - tenders_finalized
      - tenders
      - payment_groups
      - refunds
      - refund_groups
      - metadata
      - old_metadata_map
      - created_at
      - updated_at
      - closed_at
      - state
      - substatus
      - version
      - workflow
      - workflow_version
      - total_money
      - total_tax_money
      - total_discount_money
      - total_tip_money
      - total_service_charge_money
      - short_reference_id
      - ticket_name
      - pricing_options
      - discount_codes
      - rewards
      - voids
      - comps
      - note
      - sequential_number
      - vaulted_data
      - order_extensions
      - returned_quantities
      - net_amount_due_money
      - dining_option
      - processing_modes
      - tax_exemptions
      - api_reference_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: Order
    OrderFulfillment:
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID that identifies the fulfillment only within this
            order.
          x-release-status: BETA
        type:
          $ref: '#/components/schemas/OrderFulfillmentType'
        state:
          $ref: '#/components/schemas/OrderFulfillmentState'
        line_item_application:
          $ref: '#/components/schemas/OrderFulfillmentFulfillmentLineItemApplication'
        entries:
          type: array
          description: |-
            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.
          readOnly: true
          items:
            $ref: '#/components/schemas/OrderFulfillmentFulfillmentEntry'
          x-release-status: BETA
        metadata:
          type: object
          additionalProperties:
            type: string
          description: |-
            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).
          x-release-status: BETA
        pickup_details:
          $ref: '#/components/schemas/OrderFulfillmentPickupDetails'
        shipment_details:
          $ref: '#/components/schemas/OrderFulfillmentShipmentDetails'
      description: Contains details about how to fulfill this order.
      x-property-order:
      - uid
      - type
      - state
      - line_item_application
      - entries
      - metadata
      - pickup_details
      - managed_delivery_details
      - shipment_details
      - digital_details
      - delivery_details
      - simple_details
      - location_id
      - created_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderFulfillment
    OrderFulfillmentFulfillmentEntry:
      required:
      - line_item_uid
      - quantity
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID that identifies the fulfillment entry only within
            this order.
        line_item_uid:
          minLength: 1
          type: string
          description: The `uid` from the order line item.
        quantity:
          maxLength: 12
          minLength: 1
          type: string
          description: |-
            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:
          type: object
          additionalProperties:
            type: string
          description: |-
            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).
      description: |-
        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.
      x-property-order:
      - uid
      - line_item_uid
      - quantity
      - metadata
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderFulfillmentFulfillmentEntry
    OrderFulfillmentPickupDetails:
      type: object
      properties:
        recipient:
          $ref: '#/components/schemas/OrderFulfillmentRecipient'
        expires_at:
          type: string
          description: |-
            The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
            indicating when this fulfillment expires if it is not accepted. 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, this pickup fulfillment is automatically accepted when
            placed.
        auto_complete_duration:
          type: string
          description: |-
            The duration of time after which an open and accepted 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 accepted until it is canceled or completed.
        schedule_type:
          $ref: '#/components/schemas/OrderFulfillmentPickupDetailsScheduleType'
        pickup_at:
          type: string
          description: |-
            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: string
          description: |-
            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: string
          description: |-
            The duration of time it takes to prepare this fulfillment.
            The duration must be in RFC 3339 format (for example, "P1W3D").
        note:
          maxLength: 500
          type: string
          description: |-
            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:
          type: string
          description: |-
            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").
          readOnly: true
        accepted_at:
          type: string
          description: |-
            The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
            indicating when the fulfillment was accepted. The 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)
            indicating when the fulfillment was rejected. The 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)
            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").
          readOnly: true
        expired_at:
          type: string
          description: |-
            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").
          readOnly: true
        picked_up_at:
          type: string
          description: |-
            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").
          readOnly: true
        canceled_at:
          type: string
          description: |-
            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").
          readOnly: true
        cancel_reason:
          maxLength: 100
          type: string
          description: 'A description of why the pickup was canceled. The maximum
            length: 100 characters.'
        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
        curbside_pickup_details:
          $ref: '#/components/schemas/OrderFulfillmentPickupDetailsCurbsidePickupDetails'
      description: Contains details necessary to fulfill a pickup order.
      x-property-order:
      - recipient
      - expires_at
      - auto_complete_duration
      - schedule_type
      - pickup_at
      - pickup_window_duration
      - prep_time_duration
      - note
      - placed_at
      - accepted_at
      - acceptance_acknowledged_at
      - rejected_at
      - ready_at
      - expired_at
      - picked_up_at
      - canceled_at
      - cancel_reason
      - is_curbside_pickup
      - curbside_pickup_details
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderFulfillmentPickupDetails
    OrderFulfillmentPickupDetailsCurbsidePickupDetails:
      type: object
      properties:
        curbside_details:
          maxLength: 250
          type: string
          description: Specific details for curbside pickup, such as parking number
            and vehicle model.
        buyer_arrived_at:
          type: string
          description: |-
            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").
      description: Specific details for curbside pickup.
      x-property-order:
      - curbside_details
      - buyer_arrived_at
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderFulfillmentPickupDetailsCurbsidePickupDetails
    OrderFulfillmentRecipient:
      type: object
      properties:
        customer_id:
          maxLength: 191
          type: string
          description: |-
            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:
          maxLength: 255
          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`."
        email_address:
          maxLength: 255
          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`."
        phone_number:
          maxLength: 17
          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`."
        address:
          $ref: '#/components/schemas/Address'
      description: Information about the fulfillment recipient.
      x-property-order:
      - customer_id
      - display_name
      - email_address
      - phone_number
      - address
      - vaulted_data
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderFulfillmentRecipient
    OrderFulfillmentShipmentDetails:
      type: object
      properties:
        recipient:
          $ref: '#/components/schemas/OrderFulfillmentRecipient'
        carrier:
          maxLength: 50
          type: string
          description: The shipping carrier being used to ship this fulfillment (such
            as UPS, FedEx, or USPS).
        shipping_note:
          maxLength: 500
          type: string
          description: A note with additional information for the shipping carrier.
        shipping_type:
          maxLength: 50
          type: string
          description: |-
            A description of the type of shipping product purchased from the carrier
            (such as First Class, Priority, or Express).
        tracking_number:
          maxLength: 100
          type: string
          description: The reference number provided by the carrier to track the shipment's
            progress.
        tracking_url:
          maxLength: 2000
          type: string
          description: A link to the tracking webpage on the carrier's website.
        placed_at:
          type: string
          description: |-
            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").
          readOnly: true
        in_progress_at:
          type: string
          description: |-
            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").
          readOnly: true
        packaged_at:
          type: string
          description: |-
            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").
          readOnly: true
        expected_shipped_at:
          type: string
          description: |-
            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: string
          description: |-
            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").
          readOnly: true
        canceled_at:
          type: string
          description: |-
            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:
          maxLength: 100
          type: string
          description: A description of why the shipment was canceled.
        failed_at:
          type: string
          description: |-
            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").
          readOnly: true
        failure_reason:
          maxLength: 100
          type: string
          description: A description of why the shipment failed to be completed.
      description: Contains the details necessary to fulfill a shipment order.
      x-property-order:
      - recipient
      - carrier
      - shipping_note
      - shipping_type
      - tracking_number
      - tracking_url
      - placed_at
      - in_progress_at
      - packaged_at
      - expected_shipped_at
      - shipped_at
      - expected_delivered_at
      - delivered_at
      - canceled_at
      - cancel_reason
      - failed_at
      - failure_reason
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderFulfillmentShipmentDetails
    OrderLineItem:
      required:
      - quantity
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID that identifies the line item only within this
            order.
          x-release-status: BETA
        name:
          maxLength: 512
          type: string
          description: The name of the line item.
        quantity:
          maxLength: 12
          minLength: 1
          type: string
          description: |-
            The quantity purchased, formatted as a decimal number.
            For example, `"3"`.

            Line items with a quantity of `"0"` are automatically removed
            when paying for or otherwise completing the order.

            Line items with a `quantity_unit` can have non-integer quantities.
            For example, `"1.70000"`.
        quantity_unit:
          $ref: '#/components/schemas/OrderQuantityUnit'
        note:
          maxLength: 2000
          type: string
          description: The note of the line item.
        catalog_object_id:
          maxLength: 192
          type: string
          description: The [CatalogItemVariation](entity:CatalogItemVariation) ID
            applied to this line item.
        catalog_version:
          type: integer
          description: The version of the catalog object that this line item references.
          format: int64
        variation_name:
          maxLength: 400
          type: string
          description: The name of the variation applied to this line item.
        item_type:
          $ref: '#/components/schemas/OrderLineItemItemType'
        metadata:
          type: object
          additionalProperties:
            type: string
          description: |-
            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).
          x-release-status: BETA
        modifiers:
          type: array
          description: The [CatalogModifier](entity:CatalogModifier)s applied to this
            line item.
          items:
            $ref: '#/components/schemas/OrderLineItemModifier'
        applied_taxes:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/OrderLineItemAppliedTax'
          x-release-status: BETA
        applied_discounts:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/OrderLineItemAppliedDiscount'
          x-release-status: BETA
        base_price_money:
          $ref: '#/components/schemas/Money'
        variation_total_price_money:
          $ref: '#/components/schemas/Money'
        gross_sales_money:
          $ref: '#/components/schemas/Money'
        total_tax_money:
          $ref: '#/components/schemas/Money'
        total_discount_money:
          $ref: '#/components/schemas/Money'
        total_money:
          $ref: '#/components/schemas/Money'
        pricing_blocklists:
          $ref: '#/components/schemas/OrderLineItemPricingBlocklists'
      description: |-
        Represents a line item in an order. Each line item describes a different
        product to purchase, with its own quantity and price details.
      x-property-order:
      - uid
      - name
      - quantity
      - quantity_unit
      - note
      - catalog_object_id
      - catalog_version
      - variation_name
      - catalog_item_id
      - catalog_category_id
      - item_type
      - sku
      - category_name
      - metadata
      - modifiers
      - taxes
      - discounts
      - applied_taxes
      - applied_discounts
      - applied_service_charges
      - base_price_money
      - variation_total_price_money
      - gross_sales_money
      - total_tax_money
      - total_discount_money
      - total_money
      - pricing_blocklists
      - quantity_entry_type
      - tax_category
      - returned_quantities
      - line_item_extensions
      - dining_option
      - total_service_charge_money
      - api_reference_ids
      - applied_tax_exemptions
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderLineItem
    OrderLineItemAppliedDiscount:
      required:
      - discount_uid
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID that identifies the applied discount only within
            this order.
        discount_uid:
          maxLength: 60
          minLength: 1
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Money'
      description: |-
        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.
      x-property-order:
      - uid
      - discount_uid
      - applied_money
      - quantity
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderLineItemAppliedDiscount
    OrderLineItemAppliedTax:
      required:
      - tax_uid
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID that identifies the applied tax only within this
            order.
        tax_uid:
          maxLength: 60
          minLength: 1
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Money'
      description: |-
        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.
      x-property-order:
      - uid
      - tax_uid
      - applied_money
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderLineItemAppliedTax
    OrderLineItemDiscount:
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID that identifies the discount only within this order.
          x-release-status: BETA
        catalog_object_id:
          maxLength: 192
          type: string
          description: The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).
        catalog_version:
          type: integer
          description: The version of the catalog object that this discount references.
          format: int64
        name:
          maxLength: 255
          type: string
          description: The discount's name.
        type:
          $ref: '#/components/schemas/OrderLineItemDiscountType'
        percentage:
          maxLength: 10
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Money'
        applied_money:
          $ref: '#/components/schemas/Money'
        metadata:
          type: object
          additionalProperties:
            type: string
          description: |-
            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).
          x-release-status: BETA
        scope:
          $ref: '#/components/schemas/OrderLineItemDiscountScope'
        reward_ids:
          type: array
          description: |-
            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.
          readOnly: true
          items:
            type: string
          x-release-status: BETA
        pricing_rule_id:
          type: string
          description: |-
            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.
          readOnly: true
      description: |-
        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.
      x-property-order:
      - uid
      - catalog_object_id
      - catalog_version
      - name
      - type
      - percentage
      - amount_money
      - applied_money
      - metadata
      - scope
      - discount_code_ids
      - reward_ids
      - pricing_rule_id
      - pricing_rule_version
      - quantity
      - maximum_amount_money
      - modify_tax_basis
      - apply_per_quantity
      - application_method
      - discount_extensions
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderLineItemDiscount
    OrderLineItemModifier:
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID that identifies the modifier only within this order.
          x-release-status: BETA
        catalog_object_id:
          maxLength: 192
          type: string
          description: The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).
        catalog_version:
          type: integer
          description: The version of the catalog object that this modifier references.
          format: int64
        name:
          maxLength: 255
          type: string
          description: The name of the item modifier.
        quantity:
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Money'
        total_price_money:
          $ref: '#/components/schemas/Money'
        metadata:
          type: object
          additionalProperties:
            type: string
          description: |-
            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).
          x-release-status: BETA
      description: A [CatalogModifier](entity:CatalogModifier).
      x-property-order:
      - uid
      - catalog_object_id
      - catalog_version
      - name
      - quantity
      - base_price_money
      - total_price_money
      - metadata
      - modifier_extensions
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderLineItemModifier
    OrderLineItemPricingBlocklists:
      type: object
      properties:
        blocked_discounts:
          type: array
          description: |-
            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).
          items:
            $ref: '#/components/schemas/OrderLineItemPricingBlocklistsBlockedDiscount'
        blocked_taxes:
          type: array
          description: |-
            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).
          items:
            $ref: '#/components/schemas/OrderLineItemPricingBlocklistsBlockedTax'
      description: |-
        Describes pricing adjustments that are blocked from manual and
        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).
      x-property-order:
      - blocked_discounts
      - blocked_taxes
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderLineItemPricingBlocklists
    OrderLineItemPricingBlocklistsBlockedDiscount:
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID of the `BlockedDiscount` within the order.
        discount_uid:
          maxLength: 60
          type: string
          description: |-
            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:
          maxLength: 192
          type: string
          description: |-
            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.
      description: |-
        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.
      x-property-order:
      - uid
      - discount_uid
      - discount_catalog_object_id
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderLineItemPricingBlocklistsBlockedDiscount
    OrderLineItemPricingBlocklistsBlockedTax:
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID of the `BlockedTax` within the order.
        tax_uid:
          maxLength: 60
          type: string
          description: |-
            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:
          maxLength: 192
          type: string
          description: |-
            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.
      description: |-
        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.
      x-property-order:
      - uid
      - tax_uid
      - tax_catalog_object_id
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderLineItemPricingBlocklistsBlockedTax
    OrderLineItemTax:
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID that identifies the tax only within this order.
          x-release-status: BETA
        catalog_object_id:
          maxLength: 192
          type: string
          description: The catalog object ID referencing [CatalogTax](entity:CatalogTax).
        catalog_version:
          type: integer
          description: The version of the catalog object that this tax references.
          format: int64
        name:
          maxLength: 255
          type: string
          description: The tax's name.
        type:
          $ref: '#/components/schemas/OrderLineItemTaxType'
        percentage:
          maxLength: 10
          type: string
          description: |-
            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:
          type: object
          additionalProperties:
            type: string
          description: |-
            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).
          x-release-status: BETA
        applied_money:
          $ref: '#/components/schemas/Money'
        scope:
          $ref: '#/components/schemas/OrderLineItemTaxScope'
        auto_applied:
          type: boolean
          description: |-
            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).
          readOnly: true
          x-release-status: BETA
      description: |-
        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.
      x-property-order:
      - uid
      - catalog_object_id
      - catalog_version
      - name
      - type
      - percentage
      - calculation_phase
      - metadata
      - applied_money
      - scope
      - auto_applied
      - tax_extensions
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderLineItemTax
    OrderMoneyAmounts:
      type: object
      properties:
        total_money:
          $ref: '#/components/schemas/Money'
        tax_money:
          $ref: '#/components/schemas/Money'
        discount_money:
          $ref: '#/components/schemas/Money'
        tip_money:
          $ref: '#/components/schemas/Money'
        service_charge_money:
          $ref: '#/components/schemas/Money'
      description: A collection of various money amounts.
      x-property-order:
      - total_money
      - tax_money
      - discount_money
      - tip_money
      - service_charge_money
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderMoneyAmounts
    OrderPricingOptions:
      type: object
      properties:
        auto_apply_discounts:
          type: boolean
          description: |-
            The option to determine whether pricing rule-based
            discounts are automatically applied to an order.
        auto_apply_taxes:
          type: boolean
          description: |-
            The option to determine whether rule-based taxes are automatically
            applied to an order when the criteria of the corresponding rules are met.
          x-release-status: BETA
      description: |-
        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).
      x-property-order:
      - auto_apply_discounts
      - auto_apply_taxes
      - automatic_tax_source
      - auto_apply_service_charges
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderPricingOptions
    OrderQuantityUnit:
      type: object
      properties:
        measurement_unit:
          $ref: '#/components/schemas/MeasurementUnit'
        precision:
          type: integer
          description: |-
            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: string
          description: |-
            The catalog object ID referencing the
            [CatalogMeasurementUnit](entity:CatalogMeasurementUnit).

            This field is set when this is a catalog-backed measurement unit.
        catalog_version:
          type: integer
          description: |-
            The version of the catalog object that this measurement unit references.

            This field is set when this is a catalog-backed measurement unit.
          format: int64
      description: |-
        Contains the measurement unit for a quantity and a precision that
        specifies the number of digits after the decimal point for decimal quantities.
      x-property-order:
      - measurement_unit
      - precision
      - catalog_object_id
      - catalog_version
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderQuantityUnit
    OrderReturn:
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID that identifies the return only within this order.
        source_order_id:
          type: string
          description: |-
            An order that contains the original sale of these return line items. This is unset
            for unlinked returns.
        return_line_items:
          type: array
          description: A collection of line items that are being returned.
          items:
            $ref: '#/components/schemas/OrderReturnLineItem'
        return_service_charges:
          type: array
          description: A collection of service charges that are being returned.
          readOnly: true
          items:
            $ref: '#/components/schemas/OrderReturnServiceCharge'
        return_taxes:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/OrderReturnTax'
        return_discounts:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/OrderReturnDiscount'
        rounding_adjustment:
          $ref: '#/components/schemas/OrderRoundingAdjustment'
        return_amounts:
          $ref: '#/components/schemas/OrderMoneyAmounts'
      description: The set of line items, service charges, taxes, discounts, tips,
        and other items being returned in an order.
      x-property-order:
      - uid
      - source_order_id
      - return_line_items
      - return_service_charges
      - return_taxes
      - return_discounts
      - return_tips
      - rounding_adjustment
      - return_amounts
      - return_type
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderReturn
    OrderReturnDiscount:
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID that identifies the returned discount only within
            this order.
        source_discount_uid:
          maxLength: 60
          type: string
          description: The discount `uid` from the order that contains the original
            application of this discount.
        catalog_object_id:
          maxLength: 192
          type: string
          description: The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).
        catalog_version:
          type: integer
          description: The version of the catalog object that this discount references.
          format: int64
        name:
          maxLength: 255
          type: string
          description: The discount's name.
        type:
          $ref: '#/components/schemas/OrderLineItemDiscountType'
        percentage:
          maxLength: 10
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Money'
        applied_money:
          $ref: '#/components/schemas/Money'
        scope:
          $ref: '#/components/schemas/OrderLineItemDiscountScope'
      description: |-
        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.
      x-property-order:
      - uid
      - source_discount_uid
      - catalog_object_id
      - catalog_version
      - name
      - type
      - percentage
      - amount_money
      - applied_money
      - scope
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderReturnDiscount
    OrderReturnLineItem:
      required:
      - quantity
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID for this return line-item entry.
        source_line_item_uid:
          maxLength: 60
          type: string
          description: The `uid` of the line item in the original sale order.
        name:
          maxLength: 512
          type: string
          description: The name of the line item.
        quantity:
          maxLength: 12
          minLength: 1
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/OrderQuantityUnit'
        note:
          maxLength: 2000
          type: string
          description: The note of the return line item.
        catalog_object_id:
          maxLength: 192
          type: string
          description: The [CatalogItemVariation](entity:CatalogItemVariation) ID
            applied to this return line item.
        catalog_version:
          type: integer
          description: The version of the catalog object that this line item references.
          format: int64
        variation_name:
          maxLength: 400
          type: string
          description: The name of the variation applied to this return line item.
        item_type:
          $ref: '#/components/schemas/OrderLineItemItemType'
        return_modifiers:
          type: array
          description: The [CatalogModifier](entity:CatalogModifier)s applied to this
            line item.
          items:
            $ref: '#/components/schemas/OrderReturnLineItemModifier'
        applied_taxes:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/OrderLineItemAppliedTax'
        applied_discounts:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/OrderLineItemAppliedDiscount'
        base_price_money:
          $ref: '#/components/schemas/Money'
        variation_total_price_money:
          $ref: '#/components/schemas/Money'
        gross_return_money:
          $ref: '#/components/schemas/Money'
        total_tax_money:
          $ref: '#/components/schemas/Money'
        total_discount_money:
          $ref: '#/components/schemas/Money'
        total_money:
          $ref: '#/components/schemas/Money'
      description: The line item being returned in an order.
      x-property-order:
      - uid
      - source_line_item_uid
      - name
      - quantity
      - quantity_unit
      - note
      - catalog_object_id
      - catalog_version
      - variation_name
      - catalog_item_id
      - catalog_category_id
      - item_type
      - sku
      - category_name
      - return_modifiers
      - return_taxes
      - return_discounts
      - applied_taxes
      - applied_discounts
      - base_price_money
      - variation_total_price_money
      - gross_return_money
      - total_tax_money
      - total_discount_money
      - total_money
      - restock_type
      - applied_service_charges
      - total_service_charge_money
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderReturnLineItem
    OrderReturnLineItemModifier:
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID that identifies the return modifier only within
            this order.
        source_modifier_uid:
          maxLength: 60
          type: string
          description: |-
            The modifier `uid` from the order's line item that contains the
            original sale of this line item modifier.
        catalog_object_id:
          maxLength: 192
          type: string
          description: The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).
        catalog_version:
          type: integer
          description: The version of the catalog object that this line item modifier
            references.
          format: int64
        name:
          maxLength: 255
          type: string
          description: The name of the item modifier.
        base_price_money:
          $ref: '#/components/schemas/Money'
        total_price_money:
          $ref: '#/components/schemas/Money'
      description: A line item modifier being returned.
      x-property-order:
      - uid
      - source_modifier_uid
      - catalog_object_id
      - catalog_version
      - name
      - base_price_money
      - total_price_money
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderReturnLineItemModifier
    OrderReturnServiceCharge:
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID that identifies the return service charge only
            within this order.
          x-release-status: BETA
        source_service_charge_uid:
          maxLength: 60
          type: string
          description: |-
            The service charge `uid` from the order containing the original
            service charge. `source_service_charge_uid` is `null` for
            unlinked returns.
        name:
          maxLength: 255
          type: string
          description: The name of the service charge.
        catalog_object_id:
          maxLength: 192
          type: string
          description: The catalog object ID of the associated [OrderServiceCharge](entity:OrderServiceCharge).
        catalog_version:
          type: integer
          description: The version of the catalog object that this service charge
            references.
          format: int64
        percentage:
          maxLength: 10
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Money'
        applied_money:
          $ref: '#/components/schemas/Money'
        total_money:
          $ref: '#/components/schemas/Money'
        total_tax_money:
          $ref: '#/components/schemas/Money'
        calculation_phase:
          $ref: '#/components/schemas/OrderServiceChargeCalculationPhase'
        taxable:
          type: boolean
          description: |-
            Indicates whether the surcharge can be taxed. Service charges
            calculated in the `TOTAL_PHASE` cannot be marked as taxable.
        applied_taxes:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/OrderLineItemAppliedTax'
          x-release-status: BETA
      description: Represents the service charge applied to the original order.
      x-property-order:
      - uid
      - source_service_charge_uid
      - name
      - catalog_object_id
      - catalog_version
      - percentage
      - amount_money
      - applied_money
      - total_money
      - total_tax_money
      - calculation_phase
      - taxable
      - return_taxes
      - applied_taxes
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderReturnServiceCharge
    OrderReturnTax:
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID that identifies the returned tax only within this
            order.
        source_tax_uid:
          maxLength: 60
          type: string
          description: The tax `uid` from the order that contains the original tax
            charge.
        catalog_object_id:
          maxLength: 192
          type: string
          description: The catalog object ID referencing [CatalogTax](entity:CatalogTax).
        catalog_version:
          type: integer
          description: The version of the catalog object that this tax references.
          format: int64
        name:
          maxLength: 255
          type: string
          description: The tax's name.
        type:
          $ref: '#/components/schemas/OrderLineItemTaxType'
        percentage:
          maxLength: 10
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Money'
        scope:
          $ref: '#/components/schemas/OrderLineItemTaxScope'
      description: |-
        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.
      x-property-order:
      - uid
      - source_tax_uid
      - catalog_object_id
      - catalog_version
      - name
      - type
      - percentage
      - calculation_phase
      - applied_money
      - scope
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderReturnTax
    OrderReward:
      required:
      - id
      - reward_tier_id
      type: object
      properties:
        id:
          minLength: 1
          type: string
          description: The identifier of the reward.
        reward_tier_id:
          minLength: 1
          type: string
          description: The identifier of the reward tier corresponding to this reward.
      description: |-
        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.
      x-property-order:
      - id
      - reward_tier_id
      - pricing_rule_id
      - pricing_rule_reference
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderReward
    OrderRoundingAdjustment:
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID that identifies the rounding adjustment only within
            this order.
        name:
          type: string
          description: The name of the rounding adjustment from the original sale
            order.
        amount_money:
          $ref: '#/components/schemas/Money'
      description: |-
        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.
      x-property-order:
      - uid
      - name
      - amount_money
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderRoundingAdjustment
    OrderServiceCharge:
      type: object
      properties:
        uid:
          maxLength: 60
          type: string
          description: A unique ID that identifies the service charge only within
            this order.
          x-release-status: BETA
        name:
          maxLength: 512
          type: string
          description: The name of the service charge.
        catalog_object_id:
          maxLength: 192
          type: string
          description: The catalog object ID referencing the service charge [CatalogObject](entity:CatalogObject).
        catalog_version:
          type: integer
          description: The version of the catalog object that this service charge
            references.
          format: int64
        percentage:
          maxLength: 10
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Money'
        applied_money:
          $ref: '#/components/schemas/Money'
        total_money:
          $ref: '#/components/schemas/Money'
        total_tax_money:
          $ref: '#/components/schemas/Money'
        calculation_phase:
          $ref: '#/components/schemas/OrderServiceChargeCalculationPhase'
        taxable:
          type: boolean
          description: |-
            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: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/OrderLineItemAppliedTax'
          x-release-status: BETA
        metadata:
          type: object
          additionalProperties:
            type: string
          description: |-
            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).
          x-release-status: BETA
        type:
          $ref: '#/components/schemas/OrderServiceChargeType'
      description: Represents a service charge applied to an order.
      x-property-order:
      - uid
      - name
      - catalog_object_id
      - catalog_version
      - percentage
      - amount_money
      - applied_money
      - total_money
      - total_tax_money
      - calculation_phase
      - taxable
      - taxes
      - applied_taxes
      - metadata
      - type
      - treatment_type
      - pricing_rule_id
      - pricing_rule_version
      - application_method
      - scope
      - service_charge_extensions
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderServiceCharge
    OrderSource:
      type: object
      properties:
        name:
          type: string
          description: |-
            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.
      description: Represents the origination details of an order.
      x-property-order:
      - name
      - application_name
      - application_id
      - client_ou
      - square_product
      - appears_in_order_manager
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /orders/orders-proto/src/main/proto/squareup/omg/model/orders.proto
      x-proto-sha: 43aa42a4f8fcf3322b75483e78a370f2133aaf14
      x-object-name: OrderSource
    CreateCheckoutRequest:
      required:
      - idempotency_key
      - order
      type: object
      properties:
        idempotency_key:
          maxLength: 192
          minLength: 1
          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\n\
            you are working in to generate strings for your idempotency keys.\n\n\
            For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency)."
        order:
          $ref: '#/components/schemas/CreateOrderRequest'
        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:
          maxLength: 254
          type: string
          description: |-
            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:
          maxLength: 254
          type: string
          description: |-
            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:
          $ref: '#/components/schemas/Address'
        redirect_url:
          maxLength: 800
          type: string
          description: |-
            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&amp;referenceId=xxxxxx&amp;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:
          type: array
          description: |-
            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.
          items:
            $ref: '#/components/schemas/ChargeRequestAdditionalRecipient'
        note:
          maxLength: 60
          type: string
          description: |-
            An optional note to associate with the `checkout` object.

            This value cannot exceed 60 characters.
      description: |-
        Defines the parameters that can be included in the body of
        a request to the `CreateCheckout` endpoint.
      example:
        idempotency_key: 86ae1696-b1e3-4328-af6d-f1e04d947ad6
        redirect_url: https://merchant.website.com/order-confirm
        order:
          idempotency_key: 12ae1696-z1e3-4328-af6d-f1e04d947gd4
          order:
            location_id: location_id
            customer_id: customer_id
            reference_id: reference_id
            line_items:
            - name: Printed T Shirt
              quantity: "2"
              base_price_money:
                amount: 1500
                currency: USD
              applied_discounts:
              - discount_uid: 56ae1696-z1e3-9328-af6d-f1e04d947gd4
              applied_taxes:
              - tax_uid: 38ze1696-z1e3-5628-af6d-f1e04d947fg3
            - 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
              scope: LINE_ITEM
              amount_money:
                amount: 100
                currency: USD
        additional_recipients:
        - location_id: 057P5VYJ4A5X1
          description: Application fees
          amount_money:
            amount: 60
            currency: USD
        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
      x-property-order:
      - idempotency_key
      - order
      - ask_for_shipping_address
      - merchant_support_email
      - pre_populate_buyer_email
      - pre_populate_shipping_address
      - redirect_url
      - additional_recipients
      - note
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /payapi-checkouts/protos/squareup/payapi/actions/checkout.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: CreateCheckoutRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/CreateCheckout/CreateCheckoutRequest.python
        csharp: /sdk_samples/CreateCheckout/CreateCheckoutRequest.csharp
        java: /sdk_samples/CreateCheckout/CreateCheckoutRequest.java
        php: /sdk_samples/CreateCheckout/CreateCheckoutRequest.php
        javascript: /sdk_samples/CreateCheckout/CreateCheckoutRequest.javascript
        ruby: /sdk_samples/CreateCheckout/CreateCheckoutRequest.ruby
    CreateCheckoutResponse:
      type: object
      properties:
        checkout:
          $ref: '#/components/schemas/Checkout'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Defines the fields that are included in the response body of
        a request to the `CreateCheckout` endpoint.
      example:
        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
            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
          order:
            location_id: location_id
            customer_id: customer_id
            reference_id: reference_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
              scope: LINE_ITEM
              amount_money:
                amount: 100
                currency: USD
              applied_money:
                amount: 100
                currency: USD
            total_money:
              amount: 14503
              currency: USD
            total_tax_money:
              amount: 103
              currency: USD
            total_discount_money:
              amount: 100
              currency: USD
          created_at: 2017-06-16T22:25:35Z
          version: 1
          additional_recipients:
          - location_id: 057P5VYJ4A5X1
            description: Application fees
            amount_money:
              amount: 60
              currency: USD
      x-property-order:
      - checkout
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /payapi-checkouts/protos/squareup/payapi/actions/checkout.proto
      x-proto-sha: e1591f52993ecfc8152ded3dbb3fb6b47593b7a6
      x-object-name: CreateCheckoutResponse
    RegisterDomainRequest:
      required:
      - domain_name
      type: object
      properties:
        domain_name:
          maxLength: 255
          minLength: 1
          type: string
          description: A domain name as described in RFC-1034 that will be registered
            with ApplePay.
      description: |-
        Defines the parameters that can be included in the body of
        a request to the [RegisterDomain](api-endpoint:ApplePay-RegisterDomain) endpoint.
      example:
        domain_name: example.com
      x-property-order:
      - domain_name
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /payapi-wallets/protos/squareup/payapi_wallets/actions/apple_pay_domain_service_actions.proto
      x-proto-sha: 5a571cd674a882679027661caa0270c3d59161a9
      x-object-name: RegisterDomainRequest
      x-sq-sdk-sample-code:
        python: /sdk_samples/ApplePay/RegisterDomain/RegisterDomainRequest.python
        csharp: /sdk_samples/ApplePay/RegisterDomain/RegisterDomainRequest.csharp
        java: /sdk_samples/ApplePay/RegisterDomain/RegisterDomainRequest.java
        php: /sdk_samples/ApplePay/RegisterDomain/RegisterDomainRequest.php
        javascript: /sdk_samples/ApplePay/RegisterDomain/RegisterDomainRequest.javascript
        ruby: /sdk_samples/ApplePay/RegisterDomain/RegisterDomainRequest.ruby
    RegisterDomainResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        status:
          $ref: '#/components/schemas/RegisterDomainResponseStatus'
      description: |-
        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).
      example:
        status: VERIFIED
      x-property-order:
      - errors
      - status
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /payapi-wallets/protos/squareup/payapi_wallets/actions/apple_pay_domain_service_actions.proto
      x-proto-sha: 5a571cd674a882679027661caa0270c3d59161a9
      x-object-name: RegisterDomainResponse
      x-sq-sdk-sample-code:
        python: /sdk_samples/ApplePay/RegisterDomain/RegisterDomainResponse.python
        csharp: /sdk_samples/ApplePay/RegisterDomain/RegisterDomainResponse.csharp
        java: /sdk_samples/ApplePay/RegisterDomain/RegisterDomainResponse.java
        php: /sdk_samples/ApplePay/RegisterDomain/RegisterDomainResponse.php
        javascript: /sdk_samples/ApplePay/RegisterDomain/RegisterDomainResponse.javascript
        ruby: /sdk_samples/ApplePay/RegisterDomain/RegisterDomainResponse.ruby
    PaymentBalanceActivityAutomaticSavingsDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
        payout_id:
          type: string
          description: The ID of the payout associated with this activity.
      x-property-order:
      - payment_id
      - payout_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityAutomaticSavingsDetail
    PaymentBalanceActivityAutomaticSavingsReversedDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
        payout_id:
          type: string
          description: The ID of the payout associated with this activity.
      x-property-order:
      - payment_id
      - payout_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityAutomaticSavingsReversedDetail
    PaymentBalanceActivityChargeDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
      description: DESCRIPTION OF PaymentBalanceActivityChargeDetail
      x-property-order:
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityChargeDetail
    PaymentBalanceActivityDepositFeeDetail:
      type: object
      properties:
        payout_id:
          type: string
          description: The ID of the payout that triggered this deposit fee activity.
      x-property-order:
      - payout_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityDepositFeeDetail
    PaymentBalanceActivityDisputeDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
        dispute_id:
          type: string
          description: The ID of the dispute associated with this activity.
      x-property-order:
      - payment_id
      - dispute_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityDisputeDetail
    PaymentBalanceActivityFeeDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
      x-property-order:
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityFeeDetail
    PaymentBalanceActivityFreeProcessingDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
      x-property-order:
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityFreeProcessingDetail
    PaymentBalanceActivityHoldAdjustmentDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
      x-property-order:
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityHoldAdjustmentDetail
    PaymentBalanceActivityOpenDisputeDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
        dispute_id:
          type: string
          description: The ID of the dispute associated with this activity.
      x-property-order:
      - payment_id
      - dispute_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityOpenDisputeDetail
    PaymentBalanceActivityOtherAdjustmentDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
      x-property-order:
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityOtherAdjustmentDetail
    PaymentBalanceActivityOtherDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
      x-property-order:
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityOtherDetail
    PaymentBalanceActivityRefundDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
        refund_id:
          type: string
          description: The ID of the refund associated with this activity.
      x-property-order:
      - payment_id
      - refund_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityRefundDetail
    PaymentBalanceActivityReleaseAdjustmentDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
      x-property-order:
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityReleaseAdjustmentDetail
    PaymentBalanceActivityReserveHoldDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
      x-property-order:
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityReserveHoldDetail
    PaymentBalanceActivityReserveReleaseDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
      x-property-order:
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityReserveReleaseDetail
    PaymentBalanceActivitySquareCapitalPaymentDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
      x-property-order:
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivitySquareCapitalPaymentDetail
    PaymentBalanceActivitySquareCapitalReversedPaymentDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
      x-property-order:
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivitySquareCapitalReversedPaymentDetail
    PaymentBalanceActivityTaxOnFeeDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
      x-property-order:
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityTaxOnFeeDetail
    PaymentBalanceActivityThirdPartyFeeDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
      x-property-order:
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityThirdPartyFeeDetail
    PaymentBalanceActivityThirdPartyFeeRefundDetail:
      type: object
      properties:
        payment_id:
          type: string
          description: The ID of the payment associated with this activity.
      x-property-order:
      - payment_id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payment-balances/payment-balances-proto/src/main/proto/squareup/paymentbalances/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PaymentBalanceActivityThirdPartyFeeRefundDetail
    Destination:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/DestinationType'
        id:
          type: string
          description: Square issued unique ID (also known as the instrument ID) associated
            with this destination.
      description: Information about the destination against which the payout was
        made.
      x-property-order:
      - type
      - id
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payouts/payouts-proto/src/main/proto/squareup/payouts/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: Destination
    Payout:
      required:
      - id
      - location_id
      type: object
      properties:
        id:
          minLength: 1
          type: string
          description: A unique ID for the payout.
        status:
          $ref: '#/components/schemas/PayoutStatus'
        location_id:
          minLength: 1
          type: string
          description: The ID of the location associated with the payout.
        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'
        destination:
          $ref: '#/components/schemas/Destination'
        version:
          type: integer
          description: |-
            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:
          $ref: '#/components/schemas/PayoutType'
        payout_fee:
          type: array
          description: A list of transfer fees and any taxes on the fees assessed
            by Square for this payout.
          items:
            $ref: '#/components/schemas/PayoutFee'
        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.
      description: |-
        An accounting of the amount owed the seller and record of the actual transfer to their
        external bank account or to the Square balance.
      x-property-order:
      - id
      - status
      - location_id
      - created_at
      - updated_at
      - amount_money
      - destination
      - version
      - type
      - payout_fee
      - arrival_date
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payouts/payouts-proto/src/main/proto/squareup/payouts/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: Payout
    PayoutEntry:
      required:
      - id
      - payout_id
      type: object
      properties:
        id:
          minLength: 1
          type: string
          description: A unique ID for the payout entry.
        payout_id:
          minLength: 1
          type: string
          description: The ID of the payout entries’ associated payout.
        effective_at:
          type: string
          description: The timestamp of when the payout entry affected the balance,
            in RFC 3339 format.
        type:
          $ref: '#/components/schemas/ActivityType'
        gross_amount_money:
          $ref: '#/components/schemas/Money'
        fee_amount_money:
          $ref: '#/components/schemas/Money'
        net_amount_money:
          $ref: '#/components/schemas/Money'
        type_automatic_savings_details:
          $ref: '#/components/schemas/PaymentBalanceActivityAutomaticSavingsDetail'
        type_automatic_savings_reversed_details:
          $ref: '#/components/schemas/PaymentBalanceActivityAutomaticSavingsReversedDetail'
        type_charge_details:
          $ref: '#/components/schemas/PaymentBalanceActivityChargeDetail'
        type_deposit_fee_details:
          $ref: '#/components/schemas/PaymentBalanceActivityDepositFeeDetail'
        type_dispute_details:
          $ref: '#/components/schemas/PaymentBalanceActivityDisputeDetail'
        type_fee_details:
          $ref: '#/components/schemas/PaymentBalanceActivityFeeDetail'
        type_free_processing_details:
          $ref: '#/components/schemas/PaymentBalanceActivityFreeProcessingDetail'
        type_hold_adjustment_details:
          $ref: '#/components/schemas/PaymentBalanceActivityHoldAdjustmentDetail'
        type_open_dispute_details:
          $ref: '#/components/schemas/PaymentBalanceActivityOpenDisputeDetail'
        type_other_details:
          $ref: '#/components/schemas/PaymentBalanceActivityOtherDetail'
        type_other_adjustment_details:
          $ref: '#/components/schemas/PaymentBalanceActivityOtherAdjustmentDetail'
        type_refund_details:
          $ref: '#/components/schemas/PaymentBalanceActivityRefundDetail'
        type_release_adjustment_details:
          $ref: '#/components/schemas/PaymentBalanceActivityReleaseAdjustmentDetail'
        type_reserve_hold_details:
          $ref: '#/components/schemas/PaymentBalanceActivityReserveHoldDetail'
        type_reserve_release_details:
          $ref: '#/components/schemas/PaymentBalanceActivityReserveReleaseDetail'
        type_square_capital_payment_details:
          $ref: '#/components/schemas/PaymentBalanceActivitySquareCapitalPaymentDetail'
        type_square_capital_reversed_payment_details:
          $ref: '#/components/schemas/PaymentBalanceActivitySquareCapitalReversedPaymentDetail'
        type_tax_on_fee_details:
          $ref: '#/components/schemas/PaymentBalanceActivityTaxOnFeeDetail'
        type_third_party_fee_details:
          $ref: '#/components/schemas/PaymentBalanceActivityThirdPartyFeeDetail'
        type_third_party_fee_refund_details:
          $ref: '#/components/schemas/PaymentBalanceActivityThirdPartyFeeRefundDetail'
      description: |-
        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
      x-property-order:
      - id
      - payout_id
      - effective_at
      - type
      - gross_amount_money
      - fee_amount_money
      - net_amount_money
      - payment_id
      - type_automatic_savings_details
      - type_automatic_savings_reversed_details
      - type_charge_details
      - type_deposit_fee_details
      - type_dispute_details
      - type_fee_details
      - type_free_processing_details
      - type_hold_adjustment_details
      - type_open_dispute_details
      - type_other_details
      - type_other_adjustment_details
      - type_refund_details
      - type_release_adjustment_details
      - type_reserve_hold_details
      - type_reserve_release_details
      - type_square_capital_payment_details
      - type_square_capital_reversed_payment_details
      - type_tax_on_fee_details
      - type_third_party_fee_details
      - type_third_party_fee_refund_details
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payouts/payouts-proto/src/main/proto/squareup/payouts/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PayoutEntry
    PayoutFee:
      type: object
      properties:
        amount_money:
          $ref: '#/components/schemas/Money'
        effective_at:
          type: string
          description: The timestamp of when the fee takes effect, in RFC 3339 format.
        type:
          $ref: '#/components/schemas/PayoutFeeType'
      description: Represents a payout fee that can incur as part of a payout.
      x-property-order:
      - amount_money
      - effective_at
      - type
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payouts/payouts-proto/src/main/proto/squareup/payouts/model.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: PayoutFee
    GetPayoutRequest:
      type: object
      properties: {}
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payouts/payouts-proto/src/main/proto/squareup/payouts/service.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: GetPayoutRequest
    GetPayoutResponse:
      type: object
      properties:
        payout:
          $ref: '#/components/schemas/Payout'
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        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_code: USD
          destination:
            type: BANK_ACCOUNT
            id: bact:ZPp3oedR3AeEUNd3z7
          version: 1
          type: BATCH
          arrival_date: 2022-03-24
      x-property-order:
      - payout
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payouts/payouts-proto/src/main/proto/squareup/payouts/service.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: GetPayoutResponse
    ListPayoutEntriesRequest:
      type: object
      properties:
        sort_order:
          $ref: '#/components/schemas/SortOrder'
        cursor:
          type: string
          description: |-
            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/basics/api101/pagination).
            If request parameters change between requests, subsequent results may contain duplicates or missing records.
        limit:
          type: integer
          description: |-
            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`
      example: {}
      x-property-order:
      - sort_order
      - cursor
      - limit
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payouts/payouts-proto/src/main/proto/squareup/payouts/service.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: ListPayoutEntriesRequest
    ListPayoutEntriesResponse:
      type: object
      properties:
        payout_entries:
          type: array
          description: The requested list of payout entries, ordered with the given
            or default sort order.
          items:
            $ref: '#/components/schemas/PayoutEntry'
        cursor:
          type: string
          description: |-
            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/basics/api101/pagination).
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: The response to retrieve payout records entries.
      example:
        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
            currency_code: USD
          fee_amount_money:
            amount: -2
            currency_code: USD
          net_amount_money:
            amount: -48
            currency_code: USD
          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
            currency_code: USD
          fee_amount_money:
            amount: 19
            currency_code: USD
          net_amount_money:
            amount: 81
            currency_code: USD
          type_charge_details:
            payment_id: HVdG62H5K3291d0SGJS6IWd4cSi8YY
        cursor: TbfI80z98Xc2LdApCyZ2NvCYLpkPurYLR16GRIttpMJ55mrSIMzHgtkcRQdT0mOnTtfHO
      x-property-order:
      - payout_entries
      - cursor
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payouts/payouts-proto/src/main/proto/squareup/payouts/service.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: ListPayoutEntriesResponse
    ListPayoutsRequest:
      type: object
      properties:
        location_id:
          maxLength: 255
          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."
        status:
          $ref: '#/components/schemas/PayoutStatus'
        begin_time:
          type: string
          description: |-
            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: string
          description: |-
            The timestamp for the end of the payout creation time, in RFC 3339 format.
            Default: The current time.
        sort_order:
          $ref: '#/components/schemas/SortOrder'
        cursor:
          type: string
          description: |-
            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/basics/api101/pagination).
            If request parameters change between requests, subsequent results may contain duplicates or missing records.
        limit:
          type: integer
          description: |-
            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`
      description: A request to retrieve payout records.
      example: {}
      x-property-order:
      - location_id
      - status
      - begin_time
      - end_time
      - sort_order
      - cursor
      - limit
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payouts/payouts-proto/src/main/proto/squareup/payouts/service.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: ListPayoutsRequest
    ListPayoutsResponse:
      type: object
      properties:
        payouts:
          type: array
          description: The requested list of payouts.
          items:
            $ref: '#/components/schemas/Payout'
        cursor:
          type: string
          description: |-
            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/basics/api101/pagination).
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: The response to retrieve payout records entries.
      example:
        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
            currency_code: USD
          destination:
            type: CARD
            id: ccof:ZPp3oedR3AeEUNd3z7
          version: 2
          type: BATCH
          payout_fee:
          - amount_money:
              amount: 95
              currency_code: USD
            effective_at: 2022-03-29T16:12:31Z
            type: TRANSFER_FEE
          arrival_date: 2022-03-29
        - 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_code: USD
          destination:
            type: BANK_ACCOUNT
            id: bact:ZPp3oedR3AeEUNd3z7
          version: 1
          type: BATCH
          arrival_date: 2022-03-24
        cursor: EMPCyStibo64hS8wLayZPp3oedR3AeEUNd3z7u6zphi72LQZFIEMbkKVvot9eefpU
      x-property-order:
      - payouts
      - cursor
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /payouts/payouts-proto/src/main/proto/squareup/payouts/service.proto
      x-proto-sha: 63e5a6095134dbb40e75b7c133622fb29aa6e1e2
      x-object-name: ListPayoutsResponse
    CreateLocationRequest:
      type: object
      properties:
        location:
          $ref: '#/components/schemas/Location'
      description: The request object for the [CreateLocation](api-endpoint:Locations-CreateLocation)
        endpoint.
      example:
        location:
          name: Midtown
          description: Midtown Atlanta store
          address:
            address_line_1: 1234 Peachtree St. NE
            locality: Atlanta
            administrative_district_level_1: GA
            postal_code: "30309"
      x-property-order:
      - location
      - fields_to_clear
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/location.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: CreateLocationRequest
    CreateLocationResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about [errors](https://developer.squareup.com/docs/build-basics/handling-errors)
            encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        location:
          $ref: '#/components/schemas/Location'
      description: The response object returned by the [CreateLocation](api-endpoint:Locations-CreateLocation)
        endpoint.
      example:
        location:
          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
          type: PHYSICAL
          description: Midtown Atlanta store
          coordinates:
            latitude: 33.7889
            longitude: -84.3841
          business_name: Jet Fuel Coffee
          mcc: "7299"
      x-property-order:
      - errors
      - location
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/location.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: CreateLocationResponse
    Employee:
      type: object
      properties:
        id:
          type: string
          description: UUID for this object.
        first_name:
          type: string
          description: The employee's first name.
        last_name:
          type: string
          description: The employee's last name.
        email:
          type: string
          description: The employee's email address
        phone_number:
          type: string
          description: The employee's phone number in E.164 format, i.e. "+12125554250"
        location_ids:
          type: array
          description: A list of location IDs where this employee has access to.
          items:
            type: string
        status:
          $ref: '#/components/schemas/EmployeeStatus'
        is_owner:
          type: boolean
          description: |-
            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: 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
      description: An employee object that is used by the external API.
      example:
        updated_at: updated_at
        location_ids:
        - location_ids
        - location_ids
        is_owner: true
        last_name: last_name
        created_at: created_at
        phone_number: phone_number
        id: id
        first_name: first_name
        email: email
        status: DO_NOT_USE
      deprecated: true
      x-property-order:
      - id
      - first_name
      - last_name
      - email
      - phone_number
      - location_ids
      - status
      - is_owner
      - created_at
      - updated_at
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/employee.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: Employee
    ListEmployeesRequest:
      type: object
      properties:
        location_id:
          type: string
        status:
          $ref: '#/components/schemas/EmployeeStatus'
        limit:
          type: integer
          description: The number of employees to be returned on each page.
        cursor:
          type: string
          description: The token required to retrieve the specified page of results.
      deprecated: true
      x-property-order:
      - location_id
      - status
      - limit
      - cursor
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/employee.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: ListEmployeesRequest
    ListEmployeesResponse:
      type: object
      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
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        cursor: cursor
        employees:
        - updated_at: updated_at
          location_ids:
          - location_ids
          - location_ids
          is_owner: true
          last_name: last_name
          created_at: created_at
          phone_number: phone_number
          id: id
          first_name: first_name
          email: email
          status: DO_NOT_USE
        - updated_at: updated_at
          location_ids:
          - location_ids
          - location_ids
          is_owner: true
          last_name: last_name
          created_at: created_at
          phone_number: phone_number
          id: id
          first_name: first_name
          email: email
          status: DO_NOT_USE
        errors:
        - code: INTERNAL_SERVER_ERROR
          field: field
          detail: detail
          category: API_ERROR
        - code: INTERNAL_SERVER_ERROR
          field: field
          detail: detail
          category: API_ERROR
      deprecated: true
      x-property-order:
      - employees
      - cursor
      - errors
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/employee.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: ListEmployeesResponse
    ListLocationsRequest:
      type: object
      properties: {}
      description: |-
        Defines the fields that are included in requests to the
        [ListLocations](api-endpoint:Locations-ListLocations) endpoint.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/location.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: ListLocationsRequest
    ListLocationsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
        locations:
          type: array
          description: The business locations.
          items:
            $ref: '#/components/schemas/Location'
      description: |-
        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).
      example:
        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
        - 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
          type: PHYSICAL
          description: Midtown Atlanta store
          coordinates:
            latitude: 33.7889
            longitude: -84.3841
          business_name: Jet Fuel Coffee
          mcc: "7299"
      x-property-order:
      - errors
      - locations
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/location.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: ListLocationsResponse
    ListMerchantsRequest:
      type: object
      properties:
        cursor:
          type: integer
          description: The cursor generated by the previous response.
      description: Request object for the [ListMerchant](api-endpoint:Merchants-ListMerchants)
        endpoint.
      x-property-order:
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/merchant.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: ListMerchantsRequest
    ListMerchantsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        merchant:
          type: array
          description: The requested `Merchant` entities.
          items:
            $ref: '#/components/schemas/Merchant'
        cursor:
          type: integer
          description: If the  response is truncated, the cursor to use in next  request
            to fetch next set of objects.
      description: The response object returned by the [ListMerchant](api-endpoint:Merchants-ListMerchants)
        endpoint.
      example:
        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
      x-property-order:
      - errors
      - merchant
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/merchant.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: ListMerchantsResponse
    Merchant:
      required:
      - country
      type: object
      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.
        country:
          $ref: '#/components/schemas/Country'
        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`.
        currency:
          $ref: '#/components/schemas/Currency'
        status:
          $ref: '#/components/schemas/MerchantStatus'
        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.
        created_at:
          type: string
          description: |-
            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).
          readOnly: true
      description: Represents a business that sells with Square.
      x-property-order:
      - id
      - business_name
      - country
      - language_code
      - currency
      - status
      - main_location_id
      - owner_email
      - capabilities
      - created_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/merchant.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: Merchant
    RetrieveEmployeeRequest:
      type: object
      properties: {}
      deprecated: true
      x-property-order: []
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/employee.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: RetrieveEmployeeRequest
    RetrieveEmployeeResponse:
      type: object
      properties:
        employee:
          $ref: '#/components/schemas/Employee'
        errors:
          type: array
          description: Any errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      example:
        employee:
          updated_at: updated_at
          location_ids:
          - location_ids
          - location_ids
          is_owner: true
          last_name: last_name
          created_at: created_at
          phone_number: phone_number
          id: id
          first_name: first_name
          email: email
          status: DO_NOT_USE
        errors:
        - code: INTERNAL_SERVER_ERROR
          field: field
          detail: detail
          category: API_ERROR
        - code: INTERNAL_SERVER_ERROR
          field: field
          detail: detail
          category: API_ERROR
      deprecated: true
      x-property-order:
      - employee
      - errors
      x-release-status: DEPRECATED
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/employee.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: RetrieveEmployeeResponse
    RetrieveLocationRequest:
      type: object
      properties: {}
      description: |-
        Defines the fields that are included in the request body for the
        [RetrieveLocation](api-endpoint:Locations-RetrieveLocation) endpoint.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/location.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: RetrieveLocationRequest
    RetrieveLocationResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        location:
          $ref: '#/components/schemas/Location'
      description: |-
        Defines the fields that the [RetrieveLocation](api-endpoint:Locations-RetrieveLocation)
        endpoint returns in a response.
      example:
        location:
          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
      x-property-order:
      - errors
      - location
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/location.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: RetrieveLocationResponse
    RetrieveMerchantRequest:
      type: object
      properties: {}
      description: Request object for the [RetrieveMerchant](api-endpoint:Merchants-RetrieveMerchant)
        endpoint.
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/merchant.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: RetrieveMerchantRequest
    RetrieveMerchantResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        merchant:
          $ref: '#/components/schemas/Merchant'
      description: The response object returned by the [RetrieveMerchant](api-endpoint:Merchants-RetrieveMerchant)
        endpoint.
      example:
        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
      x-property-order:
      - errors
      - merchant
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/merchant.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: RetrieveMerchantResponse
    UpdateLocationRequest:
      type: object
      properties:
        location:
          $ref: '#/components/schemas/Location'
      description: The request object for the [UpdateLocation](api-endpoint:Locations-UpdateLocation)
        endpoint.
      example:
        location:
          description: Midtown Atlanta store - Open weekends
          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
      x-property-order:
      - location
      - fields_to_clear
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/location.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: UpdateLocationRequest
    UpdateLocationResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information about errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        location:
          $ref: '#/components/schemas/Location'
      description: The response object returned by the [UpdateLocation](api-endpoint:Locations-UpdateLocation)
        endpoint.
      example:
        location:
          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
          type: PHYSICAL
          description: Midtown Atlanta store - Open weekends
          coordinates:
            latitude: 33.7889
            longitude: -84.3841
          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_name: Jet Fuel Coffee
          mcc: "7299"
      x-property-order:
      - errors
      - location
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /roster/frontend/api/src/main/proto/squareup/roster/frontend/external/location.proto
      x-proto-sha: 11ffb68a94888890036e716f133f695e495ad962
      x-object-name: UpdateLocationResponse
    BulkCreateTeamMembersRequest:
      required:
      - team_members
      type: object
      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`.
      description: Represents a bulk create request for `TeamMember` objects.
      example:
        team_members:
          idempotency-key-1:
            team_member:
              given_name: Joe
              family_name: Doe
              email_address: joe_doe@gmail.com
              reference_id: reference_id_1
              phone_number: +14159283333
              assigned_locations:
                location_ids:
                - YSGH2WBKG94QZ
                - GA2Y9HSJ8KRYT
                assignment_type: EXPLICIT_LOCATIONS
          idempotency-key-2:
            team_member:
              given_name: Jane
              family_name: Smith
              email_address: jane_smith@gmail.com
              reference_id: reference_id_2
              phone_number: +14159223334
              assigned_locations:
                assignment_type: ALL_CURRENT_AND_FUTURE_LOCATIONS
      x-property-order:
      - team_members
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/bulk-create-team-members.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: BulkCreateTeamMembersRequest
    BulkCreateTeamMembersResponse:
      type: object
      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
          description: The errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Represents a response from a bulk create request containing the
        created `TeamMember` objects or error messages.
      example:
        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
          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
      x-property-order:
      - team_members
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/bulk-create-team-members.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: BulkCreateTeamMembersResponse
    BulkUpdateTeamMembersRequest:
      required:
      - team_members
      type: object
      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`.
          x-is-sparse-update-payload: true
      description: Represents a bulk update request for `TeamMember` objects.
      example:
        team_members:
          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:
                location_ids:
                - YSGH2WBKG94QZ
                - GA2Y9HSJ8KRYT
                assignment_type: EXPLICIT_LOCATIONS
          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
      x-property-order:
      - team_members
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/bulk-update-team-members.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: BulkUpdateTeamMembersRequest
    BulkUpdateTeamMembersResponse:
      type: object
      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
          description: The errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Represents a response from a bulk update request containing the
        updated `TeamMember` objects or error messages.
      example:
        team_members:
          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
          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
      x-property-order:
      - team_members
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/bulk-update-team-members.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: BulkUpdateTeamMembersResponse
    CreateTeamMemberRequest:
      type: object
      properties:
        idempotency_key:
          type: string
          description: |-
            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/basics/api101/idempotency).

            The minimum length is 1 and the maximum length is 45.
        team_member:
          $ref: '#/components/schemas/TeamMember'
      description: Represents a create request for a `TeamMember` object.
      example:
        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:
            location_ids:
            - YSGH2WBKG94QZ
            - GA2Y9HSJ8KRYT
            assignment_type: EXPLICIT_LOCATIONS
      x-property-order:
      - idempotency_key
      - team_member
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/create-team-member.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: CreateTeamMemberRequest
    CreateTeamMemberResponse:
      type: object
      properties:
        team_member:
          $ref: '#/components/schemas/TeamMember'
        errors:
          type: array
          description: The errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Represents a response from a create request containing the created
        `TeamMember` object or error messages.
      example:
        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
      x-property-order:
      - team_member
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/create-team-member.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: CreateTeamMemberResponse
    JobAssignment:
      required:
      - job_title
      - pay_type
      type: object
      properties:
        job_title:
          minLength: 1
          type: string
          description: The title of the job.
        pay_type:
          $ref: '#/components/schemas/JobAssignmentPayType'
        hourly_rate:
          $ref: '#/components/schemas/Money'
        annual_rate:
          $ref: '#/components/schemas/Money'
        weekly_hours:
          minimum: 0
          type: integer
          description: The planned hours per week for the job. Set if the job `PayType`
            is `SALARY`.
      description: An object describing a job that a team member is assigned to.
      x-property-order:
      - job_title
      - pay_type
      - hourly_rate
      - annual_rate
      - weekly_hours
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/resources/datatypes.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: JobAssignment
    RetrieveTeamMemberRequest:
      type: object
      properties: {}
      description: Represents a retrieve request for a `TeamMember` object.
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/retrieve-team-member.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: RetrieveTeamMemberRequest
    RetrieveTeamMemberResponse:
      type: object
      properties:
        team_member:
          $ref: '#/components/schemas/TeamMember'
        errors:
          type: array
          description: The errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Represents a response from a retrieve request containing a `TeamMember`
        object or error messages.
      example:
        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
      x-property-order:
      - team_member
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/retrieve-team-member.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: RetrieveTeamMemberResponse
    RetrieveWageSettingRequest:
      type: object
      properties: {}
      description: Represents a retrieve request for the wage setting of a team member.
      example: {}
      x-property-order: []
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/retrieve-wage-setting.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: RetrieveWageSettingRequest
    RetrieveWageSettingResponse:
      type: object
      properties:
        wage_setting:
          $ref: '#/components/schemas/WageSetting'
        errors:
          type: array
          description: The errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Represents a response from a retrieve request containing the specified
        `WageSetting` object or error messages.
      example:
        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
      x-property-order:
      - wage_setting
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/retrieve-wage-setting.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: RetrieveWageSettingResponse
    SearchTeamMembersFilter:
      type: object
      properties:
        location_ids:
          type: array
          description: |-
            When present, filters by team members assigned to the specified locations.
            When empty, includes team members assigned to any location.
          items:
            type: string
        status:
          $ref: '#/components/schemas/TeamMemberStatus'
        is_owner:
          type: boolean
          description: When present and set to true, returns the team member who is
            the owner of the Square account.
      description: |-
        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".
      x-property-order:
      - location_ids
      - status
      - email_address
      - is_owner
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/search-team-members.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: SearchTeamMembersFilter
    SearchTeamMembersQuery:
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/SearchTeamMembersFilter'
      description: Represents the parameters in a search for `TeamMember` objects.
      x-property-order:
      - filter
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/search-team-members.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: SearchTeamMembersQuery
    SearchTeamMembersRequest:
      type: object
      properties:
        query:
          $ref: '#/components/schemas/SearchTeamMembersQuery'
        limit:
          maximum: 200
          minimum: 1
          type: integer
          description: The maximum number of `TeamMember` objects in a page (100 by
            default).
        cursor:
          type: string
          description: |-
            The opaque cursor for fetching the next page. For more information, see
            [pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
      description: Represents a search request for a filtered list of `TeamMember`
        objects.
      example:
        query:
          filter:
            location_ids:
            - 0G5P3VGACMMQZ
            status: ACTIVE
        limit: 10
      x-property-order:
      - query
      - limit
      - cursor
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/search-team-members.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: SearchTeamMembersRequest
    SearchTeamMembersResponse:
      type: object
      properties:
        team_members:
          type: array
          description: The filtered list of `TeamMember` objects.
          items:
            $ref: '#/components/schemas/TeamMember'
        cursor:
          type: string
          description: |-
            The opaque cursor for fetching the next page. For more information, see
            [pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
        errors:
          type: array
          description: The errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Represents a response from a search request containing a filtered
        list of `TeamMember` objects.
      example:
        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
          created_at: 2019-07-10T17:26:48Z
          updated_at: 2020-04-28T21:49:28Z
          assigned_locations:
            assignment_type: ALL_CURRENT_AND_FUTURE_LOCATIONS
        - id: 1AVJj0DjkzbmbJw5r4KK
          reference_id: abcded
          is_owner: false
          status: ACTIVE
          given_name: Lombard
          family_name: Smith
          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
        - id: 2JCmiJol_KKFs9z2Evim
          is_owner: false
          status: ACTIVE
          given_name: Monica
          family_name: Sway
          created_at: 2020-03-24T01:09:25Z
          updated_at: 2020-03-24T01:11:25Z
          assigned_locations:
            assignment_type: ALL_CURRENT_AND_FUTURE_LOCATIONS
        - id: 4uXcJQSLtbk3F0UQHFNQ
          is_owner: false
          status: ACTIVE
          given_name: Elton
          family_name: Ipsum
          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
          is_owner: false
          status: ACTIVE
          given_name: Steven
          family_name: Lo
          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
          is_owner: false
          status: ACTIVE
          given_name: Patrick
          family_name: Steward
          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
        - id: 7F5ZxsfRnkexhu1PTbfh
          is_owner: false
          status: ACTIVE
          given_name: Ivy
          family_name: Manny
          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
          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
          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
          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
        cursor: N:9UglUjOXQ13-hMFypCft
      x-property-order:
      - team_members
      - cursor
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/search-team-members.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: SearchTeamMembersResponse
    TeamMember:
      type: object
      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.
        is_owner:
          type: boolean
          description: Whether the team member is the owner of the Square account.
          readOnly: true
        status:
          $ref: '#/components/schemas/TeamMemberStatus'
        given_name:
          type: string
          description: The given name (that is, the first name) associated with the
            team member.
        family_name:
          type: string
          description: The family name (that is, the last name) associated with the
            team member.
        email_address:
          type: string
          description: The email address associated with the team member.
        phone_number:
          type: string
          description: |-
            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: string
          description: |-
            The timestamp, in RFC 3339 format, describing when the team member was created.
            For example, "2018-10-04T04:00:00-07:00" or "2019-02-05T12:00:00Z".
          readOnly: true
        updated_at:
          type: string
          description: |-
            The timestamp, in RFC 3339 format, describing when the team member was last updated.
            For example, "2018-10-04T04:00:00-07:00" or "2019-02-05T12:00:00Z".
          readOnly: true
        assigned_locations:
          $ref: '#/components/schemas/TeamMemberAssignedLocations'
      description: A record representing an individual team member for a business.
      x-property-order:
      - id
      - person_id
      - reference_id
      - is_owner
      - status
      - given_name
      - family_name
      - email_address
      - phone_number
      - created_at
      - updated_at
      - assigned_locations
      - permission_set_id
      - is_authorized_representative
      - badge_pairing
      - invitation_status
      - has_passcode
      - can_be_managed
      - initials
      - job_template_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/resources/datatypes.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: TeamMember
    TeamMemberAssignedLocations:
      type: object
      properties:
        assignment_type:
          $ref: '#/components/schemas/TeamMemberAssignedLocationsAssignmentType'
        location_ids:
          type: array
          description: The locations that the team member is assigned to.
          items:
            type: string
      description: An object that represents a team member's assignment to locations.
      x-property-order:
      - assignment_type
      - location_ids
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/resources/datatypes.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: TeamMemberAssignedLocations
    UpdateTeamMemberRequest:
      type: object
      properties:
        team_member:
          $ref: '#/components/schemas/TeamMember'
      description: Represents an update request for a `TeamMember` object.
      example:
        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:
            location_ids:
            - YSGH2WBKG94QZ
            - GA2Y9HSJ8KRYT
            assignment_type: EXPLICIT_LOCATIONS
      x-property-order:
      - team_member
      - fields_to_clear
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/update-team-member.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: UpdateTeamMemberRequest
    UpdateTeamMemberResponse:
      type: object
      properties:
        team_member:
          $ref: '#/components/schemas/TeamMember'
        errors:
          type: array
          description: The errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: Represents a response from an update request containing the updated
        `TeamMember` object or error messages.
      example:
        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
      x-property-order:
      - team_member
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/update-team-member.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: UpdateTeamMemberResponse
    UpdateWageSettingRequest:
      required:
      - wage_setting
      type: object
      properties:
        wage_setting:
          $ref: '#/components/schemas/WageSetting'
      description: Represents an update request for the `WageSetting` object describing
        a `TeamMember`.
      example:
        wage_setting:
          is_overtime_exempt: true
          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: 1200
              currency: USD
      x-property-order:
      - wage_setting
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/update-wage-setting.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: UpdateWageSettingRequest
    UpdateWageSettingResponse:
      type: object
      properties:
        wage_setting:
          $ref: '#/components/schemas/WageSetting'
        errors:
          type: array
          description: The errors that occurred during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Represents a response from an update request containing the updated `WageSetting` object
        or error messages.
      example:
        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: 1200
              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
      x-property-order:
      - wage_setting
      - errors
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/endpoints/update-wage-setting.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: UpdateWageSettingResponse
    WageSetting:
      type: object
      properties:
        team_member_id:
          type: string
          description: The unique ID of the `TeamMember` whom this wage setting describes.
        job_assignments:
          type: array
          description: |-
            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.

            The minimum length is 1 and the maximum length is 12.
          items:
            $ref: '#/components/schemas/JobAssignment'
        is_overtime_exempt:
          type: boolean
          description: Whether the team member is exempt from the overtime rules of
            the seller's country.
        version:
          minimum: 0
          type: integer
          description: |-
            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: string
          description: |-
            The timestamp, in RFC 3339 format, describing when the wage setting object was created.
            For example, "2018-10-04T04:00:00-07:00" or "2019-02-05T12:00:00Z".
          readOnly: true
        updated_at:
          type: string
          description: |-
            The timestamp, in RFC 3339 format, describing when the wage setting object was last updated.
            For example, "2018-10-04T04:00:00-07:00" or "2019-02-05T12:00:00Z".
          readOnly: true
      description: An object representing a team member's wage information.
      x-property-order:
      - team_member_id
      - job_assignments
      - is_overtime_exempt
      - version
      - created_at
      - updated_at
      x-release-status: PUBLIC
      x-proto-repo: https://git.sqcorp.co/projects/SQ/repos/java/browse
      x-proto-location: /team-members/team-members-proto/src/main/proto/squareup/team_api/resources/datatypes.proto
      x-proto-sha: f3766492c993a50d8349996e214e394b765f7f3f
      x-object-name: WageSetting
    CreateWebhookSubscriptionRequest:
      required:
      - subscription
      type: object
      properties:
        idempotency_key:
          maxLength: 45
          type: string
          description: A unique string that identifies the [CreateWebhookSubscription](api-endpoint:WebhookSubscriptions-CreateWebhookSubscription)
            request.
        subscription:
          $ref: '#/components/schemas/WebhookSubscription'
      description: Creates a [Subscription](entity:WebhookSubscription).
      example:
        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
      x-property-order:
      - idempotency_key
      - subscription
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/actions/create_webhook_subscription.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: CreateWebhookSubscriptionRequest
    CreateWebhookSubscriptionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        subscription:
          $ref: '#/components/schemas/WebhookSubscription'
      description: |-
        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.
      example:
        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
      x-property-order:
      - errors
      - subscription
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/actions/create_webhook_subscription.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: CreateWebhookSubscriptionResponse
    DeleteWebhookSubscriptionRequest:
      type: object
      properties: {}
      description: Deletes a [Subscription](entity:WebhookSubscription).
      x-property-order: []
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/actions/delete_webhook_subscription.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: DeleteWebhookSubscriptionRequest
    DeleteWebhookSubscriptionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
      description: |-
        Defines the fields that are included in the response body of
        a request to the [DeleteWebhookSubscription](api-endpoint:WebhookSubscriptions-DeleteWebhookSubscription) endpoint.
      example: {}
      x-property-order:
      - errors
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/actions/delete_webhook_subscription.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: DeleteWebhookSubscriptionResponse
    EventTypeMetadata:
      type: object
      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
      description: Contains the metadata of a webhook event type.
      x-property-order:
      - event_type
      - api_version_introduced
      - release_status
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/resources/event_type_metadata.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: EventTypeMetadata
    ListWebhookEventTypesRequest:
      type: object
      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.
      description: Lists all webhook event types that can be subscribed to.
      x-property-order:
      - api_version
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/actions/list_webhook_event_types.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: ListWebhookEventTypesRequest
    ListWebhookEventTypesResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        event_types:
          type: array
          description: The list of event types.
          items:
            type: string
        metadata:
          type: array
          description: Contains the metadata of a webhook event type. For more information,
            see [EventTypeMetadata](entity:EventTypeMetadata).
          items:
            $ref: '#/components/schemas/EventTypeMetadata'
      description: |-
        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.
      example:
        event_types:
        - inventory.count.updated
        metadata:
        - event_type: inventory.count.updated
          api_version_introduced: 2018-07-12
          release_status: PUBLIC
      x-property-order:
      - errors
      - event_types
      - metadata
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/actions/list_webhook_event_types.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: ListWebhookEventTypesResponse
    ListWebhookSubscriptionsRequest:
      type: object
      properties:
        cursor:
          maxLength: 256
          type: string
          description: |-
            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/basics/api101/pagination).
        include_disabled:
          type: boolean
          description: |-
            Includes disabled [Subscription](entity:WebhookSubscription)s.
            By default, all enabled [Subscription](entity:WebhookSubscription)s are returned.
        sort_order:
          $ref: '#/components/schemas/SortOrder'
        limit:
          maximum: 100
          minimum: 1
          type: integer
          description: |-
            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
      description: Lists all [Subscription](entity:WebhookSubscription)s owned by
        your application.
      x-property-order:
      - cursor
      - include_disabled
      - sort_order
      - limit
      - application_id
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/actions/list_webhook_subscriptions.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: ListWebhookSubscriptionsRequest
    ListWebhookSubscriptionsResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        subscriptions:
          type: array
          description: The requested list of [Subscription](entity:WebhookSubscription)s.
          items:
            $ref: '#/components/schemas/WebhookSubscription'
        cursor:
          type: string
          description: |-
            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/basics/api101/pagination).
      description: |-
        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.
      example:
        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
          created_at: 2022-01-10 23:29:48 +0000 UTC
          updated_at: 2022-01-10 23:29:48 +0000 UTC
      x-property-order:
      - errors
      - subscriptions
      - cursor
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/actions/list_webhook_subscriptions.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: ListWebhookSubscriptionsResponse
    RetrieveWebhookSubscriptionRequest:
      type: object
      properties: {}
      description: Retrieves a [Subscription](entity:WebhookSubscription) using its
        id.
      x-property-order: []
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/actions/retrieve_webhook_subscription.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: RetrieveWebhookSubscriptionRequest
    RetrieveWebhookSubscriptionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        subscription:
          $ref: '#/components/schemas/WebhookSubscription'
      description: |-
        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.
      example:
        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
      x-property-order:
      - errors
      - subscription
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/actions/retrieve_webhook_subscription.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: RetrieveWebhookSubscriptionResponse
    SubscriptionTestResult:
      type: object
      properties:
        id:
          maxLength: 64
          type: string
          description: A Square-generated unique ID for the subscription test result.
          readOnly: true
        status_code:
          type: integer
          description: The status code returned by the subscription notification URL.
        payload:
          type: string
          description: An object containing the payload of the test event. For example,
            a `payment.created` event.
        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".
            Because a subscription test result is unique, this field is the same as the `created_at` field.
          readOnly: true
      description: |-
        Represents the details of a webhook subscription, including notification URL,
        event types, and signature key.
      x-property-order:
      - id
      - status_code
      - payload
      - created_at
      - updated_at
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/resources/subscription_test_result.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: SubscriptionTestResult
    TestWebhookSubscriptionRequest:
      type: object
      properties:
        event_type:
          type: string
          description: |-
            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).
      description: Tests a [Subscription](entity:WebhookSubscription) by sending a
        test event to its notification URL.
      example:
        event_type: payment.created
      x-property-order:
      - event_type
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/actions/test_webhook_subscription.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: TestWebhookSubscriptionRequest
    TestWebhookSubscriptionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        subscription_test_result:
          $ref: '#/components/schemas/SubscriptionTestResult'
      description: |-
        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.
      example:
        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
      x-property-order:
      - errors
      - subscription_test_result
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/actions/test_webhook_subscription.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: TestWebhookSubscriptionResponse
    UpdateWebhookSubscriptionRequest:
      type: object
      properties:
        subscription:
          $ref: '#/components/schemas/WebhookSubscription'
      description: Updates a [Subscription](entity:WebhookSubscription).
      example:
        subscription:
          name: Updated Example Webhook Subscription
          enabled: false
      x-property-order:
      - subscription
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/actions/update_webhook_subscription.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: UpdateWebhookSubscriptionRequest
    UpdateWebhookSubscriptionResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        subscription:
          $ref: '#/components/schemas/WebhookSubscription'
      description: |-
        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.
      example:
        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
          created_at: 2022-01-10 23:29:48 +0000 UTC
          updated_at: 2022-01-10 23:45:51 +0000 UTC
      x-property-order:
      - errors
      - subscription
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/actions/update_webhook_subscription.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: UpdateWebhookSubscriptionResponse
    UpdateWebhookSubscriptionSignatureKeyRequest:
      type: object
      properties:
        idempotency_key:
          maxLength: 45
          type: string
          description: A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey)
            request.
      description: Updates a [Subscription](entity:WebhookSubscription) by replacing
        the existing signature key with a new one.
      example:
        idempotency_key: ed80ae6b-0654-473b-bbab-a39aee89a60d
      x-property-order:
      - idempotency_key
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/actions/update_webhook_subscription_signature_key.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: UpdateWebhookSubscriptionSignatureKeyRequest
    UpdateWebhookSubscriptionSignatureKeyResponse:
      type: object
      properties:
        errors:
          type: array
          description: Information on errors encountered during the request.
          items:
            $ref: '#/components/schemas/Error'
        signature_key:
          type: string
          description: The new Square-generated signature key used to validate the
            origin of the webhook event.
          readOnly: true
      description: |-
        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.
      example:
        signature_key: 1k9bIJKCeTmSQwyagtNRLg
      x-property-order:
      - errors
      - signature_key
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/actions/update_webhook_subscription_signature_key.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: UpdateWebhookSubscriptionSignatureKeyResponse
    WebhookSubscription:
      type: object
      properties:
        id:
          maxLength: 64
          type: string
          description: A Square-generated unique ID for the subscription.
          readOnly: true
        name:
          maxLength: 64
          type: string
          description: The name of this subscription.
        enabled:
          type: boolean
          description: Indicates whether the subscription is enabled (`true`) or not
            (`false`).
        event_types:
          type: array
          description: The event types associated with this subscription.
          items:
            type: string
        notification_url:
          type: string
          description: The URL to which webhooks are sent.
        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."
        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.
            For example, "2016-09-04T23:59:33.123Z".
          readOnly: true
      description: |-
        Represents the details of a webhook subscription, including notification URL,
        event types, and signature key.
      x-property-order:
      - id
      - application_id
      - name
      - enabled
      - event_types
      - notification_url
      - api_version
      - signature_key
      - created_at
      - updated_at
      x-release-status: BETA
      x-proto-repo: https://git.sqcorp.co/projects/GO/repos/square/browse
      x-proto-location: /webhooks/protos/squareup/webhooks/api/subscriptions/resources/subscription.proto
      x-proto-sha: 2983a8e9fdc7d15474ba07f7e1e75fd2314099c7
      x-object-name: WebhookSubscription
    body:
      type: object
      properties:
        request:
          $ref: '#/components/schemas/CreateCatalogImageRequest'
        image_file:
          type: string
          format: binary
    body_1:
      type: object
      properties:
        request:
          $ref: '#/components/schemas/UpdateCatalogImageRequest'
        image_file:
          type: string
          format: binary
    body_2:
      type: object
      properties:
        request:
          $ref: '#/components/schemas/CreateDisputeEvidenceFileRequest'
        image_file:
          type: string
          format: binary
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://connect.squareup.com/oauth2/authorize
          tokenUrl: https://connect.squareup.com/oauth2/token
          scopes:
            BANK_ACCOUNTS_READ: |-
              __HTTP Method__: `GET`

              Grants read access to bank account information associated with the targeted
              Square account. For example, to call the Connect v1 ListBankAccounts endpoint.
            CASH_DRAWER_READ: |-
              __HTTP Method__: `GET`

              Grants read access to cash drawer shift information. For example, to call the
              ListCashDrawerShifts endpoint.
            CUSTOMERS_READ: |-
              __HTTP Method__: `GET`

              Grants read access to customer information. For example, to call the
              ListCustomers endpoint.
            CUSTOMERS_WRITE: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Grants write access to customer information. For example, to create and update
              customer profiles.
            DEVICE_CREDENTIAL_MANAGEMENT: |-
              __HTTP Method__: `POST`, `GET`

              Grants read/write access to device credentials information. For example, to
              call the CreateDeviceCode endpoint.
            EMPLOYEES_READ: |-
              __HTTP Method__: `GET`

              Grants read access to employee profile information. For example, to call the
              Connect v1 Employees API.
            EMPLOYEES_WRITE: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Grants write access to employee profile information. For example, to create
              and modify employee profiles.
            INVENTORY_READ: |-
              __HTTP Method__: `GET`

              Grants read access to inventory information. For example, to call the
              RetrieveInventoryCount endpoint.
            INVENTORY_WRITE: |-
              __HTTP Method__:  `POST`, `PUT`, `DELETE`

              Grants write access to inventory information. For example, to call the
              BatchChangeInventory endpoint.
            ITEMS_READ: |-
              __HTTP Method__: `GET`

              Grants read access to business and location information. For example, to
              obtain a location ID for subsequent activity.
            ITEMS_WRITE: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Grants write access to product catalog information. For example, to modify or
              add to a product catalog.
            LOYALTY_READ: |-
              __HTTP Method__: `GET`

              Grants read access to loyalty information. For example, to call the
              ListLoyaltyPrograms endpoint.
            LOYALTY_WRITE: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Grants write access to loyalty information. For example, to call the
              CreateLoyaltyAccount endpoint.
            MERCHANT_PROFILE_READ: |-
              __HTTP Method__: `GET`

              Grants read access to business and location information. For example, to
              obtain a location ID for subsequent activity.
            ORDERS_READ: |-
              __HTTP Method__: `GET`

              Grants read access to order information. For example, to call the
              BatchRetrieveOrders endpoint.
            ORDERS_WRITE: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Grants write access to order information. For example, to call the
              CreateCheckout endpoint.
            PAYMENTS_READ: |-
              __HTTP Method__: `GET`

              Grants read access to transaction and refund information. For example, to call
              the RetrieveTransaction endpoint.
            PAYMENTS_WRITE: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Grants write access to transaction and refunds information. For example, to
              process payments with the Payments or Checkout API.
            PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Allow third party applications to deduct a portion of each transaction amount.
              __Required__ to use multiparty transaction functionality with the Payments
              API.
            PAYMENTS_WRITE_IN_PERSON: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Grants write access to payments and refunds information. For example, to
              process in-person payments.
            SETTLEMENTS_READ: |-
              __HTTP Method__: `GET`

              Grants read access to settlement (deposit) information. For example, to call
              the Connect v1 ListSettlements endpoint.
            TIMECARDS_READ: |-
              __HTTP Method__: `GET`

              Grants read access to employee timecard information. For example, to call the
              Connect v2 SearchShifts endpoint.
            TIMECARDS_WRITE: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Grants write access to employee shift information. For example, to create
              and modify employee shifts.
            TIMECARDS_SETTINGS_READ: |-
              __HTTP Method__: `GET`

              Grants read access to employee timecard settings information. For example, to
              call the GetBreakType endpoint.
            TIMECARDS_SETTINGS_WRITE: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Grants write access to employee timecard settings information. For example, to
              call the UpdateBreakType endpoint.
            APPOINTMENTS_READ: |-
              __HTTP Method__: `GET`, `POST`

              Grants read access to booking information. For example, to call the
              RetrieveBooking endpoint.
            APPOINTMENTS_WRITE: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Grants write access to booking information. For example, to call the CreateBooking endpoint.
            APPOINTMENTS_BUSINESS_SETTINGS_READ: |-
              __HTTP Method__: `GET`

              Grants read access to booking business settings. For example, to call the
              ListTeamMemberBookingProfiles endpoint.
            INVOICES_READ: |-
              __HTTP Method__: `GET`, `POST`

              Grants read access to invoice information. For example, to call the ListInvoices endpoint.
            INVOICES_WRITE: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Grants write access to invoice information. For example, to call the CreateInvoice endpoint.
            SUBSCRIPTIONS_READ: |-
              __HTTP Method__: `GET`, `POST`

              Grants read access to subscription information. For example, to call the RetrieveSubscription
              endpoint.
            SUBSCRIPTIONS_WRITE: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Grants write access to subscription information. For example, to call the CreateSubscription
              endpoint.
            DISPUTES_READ: |-
              __HTTP Method__: `GET`

              Grants read access to dispute information. For example, to call the RetrieveDispute
              endpoint.
            DISPUTES_WRITE: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Grants write access to dispute information. For example, to call the SubmitEvidence
              endpoint.
            GIFTCARDS_READ: |-
              __HTTP Method__: `GET`, `POST`

              Grants read access to gift card information. For example, to call the RetrieveGiftCard
              endpoint.
            GIFTCARDS_WRITE: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Grants write access to gift card information. For example, to call the CreateGiftCard
              endpoint.
            ONLINE_STORE_SNIPPETS_WRITE: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Write access to ECOM online store snippets on published websites.
            ONLINE_STORE_SNIPPETS_READ: |-
              __HTTP Method__: `GET`, `POST`

              Read access to ECOM online store snippets on published websites.
            ONLINE_STORE_SITE_READ: |-
              __HTTP Method__: `GET`, `POST`

              Read access to ECOM online store site details.
            PAYMENTS_WRITE_SHARED_ONFILE: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Allows the developer to process payments on behalf of a seller using a shared on file payment method.
            APPOINTMENTS_ALL_READ: |-
              __HTTP Method__: `GET`, `POST`

              Grants read access to all of a seller's booking information, calendar, and business details.
              This permission must be accompanied by the `APPOINTMENTS_READ` permission.
            APPOINTMENTS_ALL_WRITE: |-
              __HTTP Method__: `POST`, `PUT`, `DELETE`

              Grants write access to all booking details, including double-booking a seller.
              This permission must be accompanied by the `APPOINTMENTS_WRITE` permission.
            MERCHANT_PROFILE_WRITE: |-
              __HTTP Method__: `POST`, `PUT`

              Grants write access to business and location information. For example, to create a new location or
              update the business hours at an existing location.
            VENDOR_READ: |-
              __HTTP Method__: `GET`, `POST`

              Grants read access to vendor information, for example, when calling the
              `RetrieveVendor` endpoint.
            VENDOR_WRITE: |-
              __HTTP Method__:  `POST`, `PUT`, `DELETE`

              Grants write access to vendor information, for example, when calling the
              `BulkUpdateVendors` endpoint.
            PAYOUTS_READ: |-
              __HTTP Method__: `GET`

              Grants read access to payouts and payout entries information. For example,
              to call the Connect v2 `ListPayouts` endpoint.
            RESERVATIONS_READ: |-
              __HTTP Method__: `GET`

              Grants read access to reservation information, for example, when calling the
              `RetrieveReservation` endpoint.
            RESERVATIONS_WRITE: |-
              __HTTP Method__:  `POST`, `PUT`, `DELETE`

              Grants write access to reservation information, for example, when calling the
              `CreateReservation` endpoint.
      x-additional-headers:
      - name: Square-Version
        description: Square Connect API versions
        schema:
          default: 2022-09-21
    oauth2ClientSecret:
      type: apiKey
      name: Authorization
      in: header
  x-apis:
    Orders:
      name: Orders
      summary: Get sales data for a Square seller, itemize payments, push orders to
        POS, and more.
      description: |2-

        The Orders API is your one-stop shop for adding rich functionality to payments. You can itemize
        payments using custom line items or catalog objects, send orders to physical Point of Sale devices
        to be fulfilled, attach a customer to a payment, and more.

        In addition, the Orders API lets you search through all of a seller's past sales and returns itemization
        data, customer references, and other details from sales made using POS or online.

        If 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)
      x-namespace: ""
      externalDocsList:
      - description: Orders
        url: https://developer.squareup.com/docs/orders-api/what-it-does
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
    Labor:
      name: Labor
      summary: Manage shifts, breaks, and wages for employees in Square Point of Sale.
      description: |2-

        The Labor API allows you to see when employees clocked in and out, how much they worked during different
        periods, and how many breaks they took. You can also call the API to register a past break, adjust a shift,
        or update a wage.

        This API is best used in conjunction with the Team API.
      x-namespace: ""
      externalDocsList:
      - description: Labor
        url: https://developer.squareup.com/docs/labor-api/what-it-does
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
    CustomerCustomAttributes:
      name: Customer Custom Attributes
      summary: Create and manage customer-related custom attribute definitions and
        custom attributes.
      description: |2

        Use 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.
      x-namespace: ""
      externalDocsList:
      - description: Customer Custom Attributes
        url: https://developer.squareup.com/docs/customer-custom-attributes-api/overview
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
    Invoices:
      name: Invoices
      summary: Create and manage invoices.
      description: |2

        The Invoices API lets you 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 sends the invoice to the customer or automatically charges a card on file. Square also hosts each invoice on a web page where customers can easily pay for it.
      x-namespace: ""
      externalDocsList:
      - description: Invoices
        url: https://developer.squareup.com/docs/invoices-api/overview
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
    Disputes:
      name: Disputes
      summary: Use the Disputes API to manage disputes (chargebacks).
      description: |2-

        A seller has the following options to process a dispute:

        - 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.
        - Challenge the dispute using the [SubmitEvidence](/reference/square/disputes-api/submit-evidence) endpoint. If the payment was valid, you can contest the disputed payment.
        You submit supporting evidence you have about the transaction, such as receipts, invoices, email correspondence, proof of delivery, or photos.
        You upload evidence using the [CreateDisputeEvidenceFile](/reference/square/disputes-api/create-dispute-evidence-file) endpoint.

        The Disputes API also supports other endpoints useful in dispute management.
      x-namespace: ""
      externalDocsList:
      - description: Disputes
        url: https://developer.squareup.com/docs/disputes-api/overview
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
    Inventory:
      name: Inventory
      summary: Programmatically manages a Square seller’s inventory of catalog items.
      description: |2+

        The Inventory API allows you to programmatically manage inventory counts and inventory changes of products or services.

      x-namespace: ""
      externalDocsList:
      - description: Inventory
        url: https://developer.squareup.com/docs/inventory-api/what-it-does
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
    Catalog:
      name: Catalog
      summary: Programmatically catalogs a Square seller’s products for sale and services
        for hire.
      description: |2-

        The Catalog API allows you to programmatically catalog products or services, including items, variations, categories, discounts, taxes, modifiers, and more.
      x-namespace: ""
      externalDocsList:
      - description: Catalog
        url: https://developer.squareup.com/docs/catalog-api/what-it-does
      - description: Webhooks
        url: 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: |2-

        The Payouts API allows you to see a complete list of payouts made to a seller's banking destination,
        with a list of payout entries that describe the payments associated with each payout. It can be paired with the
        Bank Accounts API to add detail about which bank account each payout was made to.
      x-namespace: ""
      externalDocsList:
      - description: Payouts
        url: https://developer.squareup.com/docs/payouts/overview
    Team:
      name: Team
      summary: Pull employee data into accounting and payroll systems with the Team
        API.
      description: |2-

        The Team API allows applications to retrieve a roster of team members registered in the Square Point
        of Sale system, which can be useful in payroll and account contexts.

        The Team API is best used in conjunction with the Labor API, where you provide team member IDs to
        manage shifts, breaks, and wages.
      x-namespace: ""
      externalDocsList:
      - description: Team
        url: https://developer.squareup.com/docs/team/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. "
      x-namespace: ""
      externalDocsList:
      - description: Checkout
        url: https://developer.squareup.com/docs/checkout-api-overview
    Employees:
      name: Employees
      summary: Pull employee data into accounting and payroll systems with the Employees
        API.
      description: |2-

        The Employees API allows applications to retrieve a roster of employees registered in the Square Point
        of Sale system, which can be useful in payroll and account contexts.

        The Employees API is best used in conjunction with the Labor API, where you provide employee IDs to
        manage shifts, breaks, and wages.
      x-namespace: ""
    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\n"
      x-namespace: ""
      externalDocsList:
      - description: Subscriptions
        url: https://developer.squareup.com/docs/subscriptions/overview
      - description: Webhooks
        url: 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"
      x-namespace: ""
      externalDocsList:
      - description: Refunds
        url: https://developer.squareup.com/docs/payments-api/overview
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
    Terminal:
      name: Terminal
      summary: Requests a checkout from a paired Square Terminal.
      description: |2

        The 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.
      x-namespace: ""
      externalDocsList:
      - description: Terminal
        url: https://developer.squareup.com/docs/terminal-api/overview
      - description: Webhooks
        url: 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\n"
      x-namespace: ""
      externalDocsList:
      - description: Customer Groups
        url: https://developer.squareup.com/docs/customer-groups-api/what-it-does
    Reporting:
      name: Reporting
      summary: Deprecated - Use the Orders and Payments APIs instead.
      description: |2-

        Prior to 2019/08/15, the Reporting API was the way to review multi-party payments taken with the Transactions
        API. The Payments API now includes an "application fee" parameter you can use to replace this functionality.
      x-namespace: ""
    OAuth:
      name: OAuth
      summary: Allow your application to gain programmatic access to other seller
        accounts.
      description: |2-

        The Square OAuth API lets applications request and obtain permission from a Square account to make API
        calls on behalf of that account. Applications can request individual permissions so that users do not need
        to grant full access to their Square accounts.
      x-namespace: ""
      externalDocsList:
      - description: OAuth
        url: https://developer.squareup.com/docs/oauth-api/overview
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
    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."
      x-namespace: ""
      externalDocsList:
      - description: Customer Segments
        url: https://developer.squareup.com/docs/customer-segments-api/what-it-does
    Loyalty:
      name: Loyalty
      summary: Create and manage loyalty accounts for buyers.
      description: |2

        The Loyalty API lets you create and manage loyalty accounts in a Square loyalty program and allow buyers to earn points and redeem points for discounts.
      x-namespace: ""
      externalDocsList:
      - description: Loyalty
        url: https://developer.squareup.com/docs/loyalty-api/overview
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
    BankAccounts:
      name: Bank Accounts
      summary: Get a list of a seller's bank accounts.
      description: |2-

        The Bank Accounts API allows you to get basic details about a seller's bank account, such as the
        last few digits of the account number and the routing number. It can be paired with the Settlements API to understand the
        pattern of deposits and withdrawals from a seller's bank account.
      x-namespace: ""
      externalDocsList:
      - description: Bank Accounts
        url: https://developer.squareup.com/docs/bank-accounts-api
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
    Merchants:
      name: Merchants
      summary: Retrieve information about an organization that sells with Square.
      description: |2-

        The 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.
      x-namespace: ""
      externalDocsList:
      - description: Merchants
        url: https://developer.squareup.com/docs/merchants-api
    Devices:
      name: Devices
      summary: Manages a pairing between a third-party Point of Sale application and
        a Square Terminal in a seller location.
      description: ""
      x-namespace: ""
      externalDocsList:
      - description: Devices
        url: https://developer.squareup.com/docs/terminal-api/overview
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
    Customers:
      name: Customers
      summary: Create and manage customer profiles and sync CRM systems with Square.
      description: |2

        The 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.
      x-namespace: ""
      externalDocsList:
      - description: Customers
        url: https://developer.squareup.com/docs/customers-api/what-it-does
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
    CashDrawers:
      name: Cash Drawers
      summary: Get details about cash drawer shifts.
      description: |2-

        Cash drawer shifts track cash transactions so that the total money in the cash drawers can be reconciled for a
        specific period of time (a cash drawer shift), for a particular device, in a particular location. The Cash Drawer Shifts API
        enables you to list and retrieve information about cash drawer shifts.
      x-namespace: ""
      externalDocsList:
      - description: Cash Drawer Shifts
        url: https://developer.squareup.com/docs/cashdrawershift-api/reporting
    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.   \n"
      x-namespace: ""
      externalDocsList:
      - description: Webhook Subscriptions
        url: https://developer.squareup.com/docs/webhooks/webhook-subscriptions-api
    Settlements:
      name: Settlements
      summary: Get a list of deposits and withdrawals from a seller's bank accounts.
      description: |2-

        __The V1 Settlements API has been deprecated__. The Settlements API allows you to see a complete list of settlements made to a seller's bank account,
        with a list of settlement entries that describe the payments associated with each settlement. It can be paired with the
        Bank Accounts API to add detail about which bank account each settlement was made to.
      x-namespace: ""
    Locations:
      name: Locations
      summary: Get a list of all a seller's locations.
      description: |2-

        Many sellers use multiple locations to track where they make sales. The Locations API allows you to
        get data about those locations, such as their addresses, names, and business hours.
      x-namespace: ""
      externalDocsList:
      - description: Locations
        url: https://developer.squareup.com/docs/locations-api
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
    Snippets:
      name: Snippets
      summary: Manage snippets for Square Online sites.
      description: |2

        The 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.

         __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-namespace: ""
      externalDocsList:
      - description: Snippets
        url: https://developer.squareup.com/docs/snippets-api/overview
    Sites:
      name: Sites
      summary: Get details about Square Online sites that belong to Square sellers.
      description: |2-

        Square 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.

         __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-namespace: ""
      externalDocsList:
      - description: Sites
        url: https://developer.squareup.com/docs/sites-api/overview
    Bookings:
      name: Bookings
      displayName: Bookings
      summary: Create and manage bookings for Square sellers.
      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"
      x-namespace: ""
      externalDocsList:
      - description: Bookings
        url: https://developer.squareup.com/docs/bookings-api/what-it-is
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
    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.
      x-namespace: ""
      externalDocsList:
      - description: Vendors
        url: https://developer.squareup.com/docs/vendors-api/overview
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
    ApplePay:
      name: Apple Pay
      summary: Apple Pay support APIs
      description: |2-

        The Apple Pay APIs provides an easy way for platform developers
        to bulk activate Web Apple Pay with Square for merchants using their platform.
      x-namespace: ""
      externalDocsList:
      - description: Web Payments SDK
        url: https://developer.squareup.com/docs/web-payments/apple-pay
      - description: In-App Payments SDK
        url: https://developer.squareup.com/docs/in-app-payments-sdk/add-digital-wallets/apple-pay
    Webhooks:
      name: Webhooks
      summary: Subscribe to V1 Webhook events for a seller.
      description: |2-

        If you are working with V1 webhooks, you use the Webhooks API to subscribe to events for each seller you are interested in receiving events for. Learn how to subscribe to [V1 webhooks](/docs/webhooks-api/subscribe-to-events-v1).

        If you are working with V2 webhooks, you do not need to use this API. instead, you subscribe to events using the [Developer Dashboard](/apps). Learn how to subscribe to [V2 webhooks](/docs/webhooks-api/subscribe-to-events).
      x-namespace: ""
    Cards:
      name: Cards
      summary: Use the Cards API to save a credit or debit card on file.
      description: |2-

        You can use the [CreateCard](/reference/square/cards-api/create-card) endpoint to save a credit or debit card to a Square account.
        Developers can integrate the Cards API in their application to let Square sellers:

        - **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.
        - **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.

        The Cards API also supports other endpoints to manage the cards.
      x-namespace: ""
      externalDocsList:
      - description: Cards
        url: https://developer.squareup.com/docs/cards-api/overview
      - description: Webhooks
        url: 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."
      x-namespace: ""
    GiftCards:
      name: Gift Cards
      summary: Create and access gift cards and link customers to gift cards.
      description: "\nSquare gift cards enable sellers to boost sales and attract\
        \ new customers. Sellers can easily sell, redeem, track, and reload Square\
        \ gift cards. \n\nDevelopers can use the Gift Cards API to integrate Square\
        \ gift cards into third-party applications. In addition, developers can use\
        \ the Gift Card Activities API to create gift card activities, such as activate\
        \ a gift card, add funds to a gift card, and redeem a gift card."
      x-namespace: ""
      externalDocsList:
      - description: Gift Cards
        url: https://developer.squareup.com/docs/gift-cards/using-gift-cards-api
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
    GiftCardActivities:
      name: Gift Card Activities
      summary: Create and retrieve gift card activities.
      description: |2

        Developers can use the Gift Cards API to create and access gift cards and use the Gift Card Activities API to create gift card activities, such as activate a gift card, add funds to a gift card, and redeem a gift card.
      x-namespace: ""
      externalDocsList:
      - description: Gift Card Activities
        url: https://developer.squareup.com/docs/gift-cards/using-gift-cards-api
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
    MobileAuthorization:
      name: Mobile Authorization
      summary: Authorize Reader SDK applications to take in-person payments.
      description: |2-

        The Mobile Authorization API accepts an account credential (an OAuth token or a personal access token) and a
        location ID and returns an authorization code that custom mobile applications can use to initialize Square mobile
        solutions, like Reader SDK, to accept payments using Square hardware.
      x-namespace: ""
      externalDocsList:
      - description: Mobile Authorization
        url: https://developer.squareup.com/docs/mobile-authz/what-it-does
    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"
      x-namespace: ""
      externalDocsList:
      - description: Payments
        url: https://developer.squareup.com/docs/payments-api/overview
      - description: Webhooks
        url: https://developer.squareup.com/docs/webhooks-overview
  x-categories:
    Orders:
      name: Orders
      summary: Itemize payments, issue refunds, and push orders into Square of Sale
      description: |2-

        Square's Payment APIs make it easy for you to take itemize payments, fulfill
        orders at physical locations, and report on a merchant's sales.
      x-namespace: ""
      apis:
      - '#/components/x-apis/Orders'
    Invoices:
      name: Invoices
      summary: Create and manage invoices.
      description: " \nUse the Invoices API to create, configure, and publish invoices\
        \ for orders that were created using the Orders API."
      x-namespace: ""
      apis:
      - '#/components/x-apis/Invoices'
    Inventory:
      name: Inventory
      summary: The Square Inventory API lets you programmatically manage the product
        inventory for a Square seller.
      description: "\nWith the Square Inventory API, you can create an application\
        \ to keep track of quantities of salable product items, inspect inventory\
        \ changes, and update the inventory states for Square sellers. "
      x-namespace: ""
      apis:
      - '#/components/x-apis/Inventory'
    Catalog:
      name: Catalog
      summary: 'The Square Catalog API lets you programmatically catalog product items
        for sale or services for hire for a Square seller. '
      description: |2-

        With the Square Catalog API, you can build an application to catalog products or services for a Square seller, search for the resulting catalog, and retrieve specified catalog objects.
      x-namespace: ""
      apis:
      - '#/components/x-apis/Catalog'
    Team:
      name: Team
      summary: Manage your team of employees.
      description: |2-

        Use the Team and Labor APIs to keep track of who works at your business and
        when they clock in and clock out.
      x-namespace: ""
      apis:
      - '#/components/x-apis/Team'
      - '#/components/x-apis/Labor'
    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. "
      x-namespace: ""
      apis:
      - '#/components/x-apis/Subscriptions'
    Terminal:
      name: Terminal
      summary: Manage checkouts and Interac refunds on a Square Terminal.
      description: |2-

        Use the Terminal API to connect to a Square Terminal and create Terminal checkouts and Terminal Interac refunds.
      x-namespace: ""
      apis:
      - '#/components/x-apis/Terminal'
    Financials:
      name: Financials
      summary: Get details about the deposits and bank accounts for your business.
      description: ""
      x-namespace: ""
      apis:
      - '#/components/x-apis/BankAccounts'
      - '#/components/x-apis/Settlements'
    Business:
      name: Business
      summary: Manage a seller's core business information, devices used for business,
        and suppliers.
      description: "\nUse the Locations and Merchants APIs to keep track of a seller's\
        \ core business details, such as addresses and business hours. \n\nUse the\
        \ Devices API and Cash Drawer Shifts API to keep track of the\npoint of sale\
        \ devices and cash drawer shift activity in a business.\n\nUse the Vendors\
        \ API to keep track of a seller's suppliers.\n"
      x-namespace: ""
      apis:
      - '#/components/x-apis/Merchants'
      - '#/components/x-apis/Locations'
      - '#/components/x-apis/Devices'
      - '#/components/x-apis/Cash Drawers'
      - '#/components/x-apis/Vendors'
    Loyalty:
      name: Loyalty
      summary: 'Create and manage loyalty accounts in Square loyalty programs. '
      description: |2-

        Use the Loyalty API to create and manage loyalty accounts for buyers, which includes allowing buyers to earn points and redeem points for discounts.
      x-namespace: ""
      apis:
      - '#/components/x-apis/Loyalty'
    Customers:
      name: Customers
      summary: Work with customer profiles, customer-related custom attributes, customer
        groups, and customer segments.
      description: |2

        Use the Customers API to create and manage customer profiles (including group membership), search customer profiles, and sync custom CRM systems with Square. Use the Customer Custom Attributes API to create and manage custom attributes for customer profiles. Use the Customer Groups API to create and manage customer groups and the Customer Segments API to retrieve information about customer segments.
      x-namespace: ""
      apis:
      - '#/components/x-apis/Customers'
      - '#/components/x-apis/CustomerCustomAttributes'
      - '#/components/x-apis/CustomerGroups'
      - '#/components/x-apis/CustomerSegments'
    Webhook Subscriptions:
      name: Webhook Subscriptions
      summary: Create and manage webhook subscriptions.
      description: |2-

        The Webhook Subscriptions API allows you to create, retrieve, update, and delete webhook subscriptions.
      x-namespace: ""
      apis:
      - '#/components/x-apis/WebhookSubscriptions'
    Bookings:
      name: Bookings
      summary: 'Create and manage bookings for Square sellers.  '
      description: "\nCreate and manage bookings for Square sellers.\n\n "
      x-namespace: ""
      apis:
      - '#/components/x-apis/Bookings'
    Auth:
      name: Auth
      summary: Manage access to Square seller accounts.
      description: |2-

        Use OAuth to gain programmatic access to other Square sellers. Use  the
        Mobile Authorization API to grant access to the Reader SDK to take payments.
      x-namespace: ""
      apis:
      - '#/components/x-apis/OAuth'
      - '#/components/x-apis/MobileAuthorization'
    Online:
      name: Online
      summary: Manage snippets for Square Online sites.
      description: " \nUse the Snippets API and Sites API to insert snippets into\
        \ Square Online sites."
      x-namespace: ""
      apis:
      - '#/components/x-apis/Sites'
      - '#/components/x-apis/Snippets'
    Gift Cards:
      name: Gift Cards
      summary: 'Create and access gift cards and link  customers to gift cards. '
      description: |2+

      x-namespace: ""
      apis:
      - '#/components/x-apis/GiftCards'
      - '#/components/x-apis/GiftCardActivities'
    Payments:
      name: Payments
      summary: Take payments and issue refunds.
      description: |2-

        Square's Payment APIs make it easy for you to take payments, manage refunds,
        and help customers checkout online.
      x-namespace: ""
      apis:
      - '#/components/x-apis/Payments'
      - '#/components/x-apis/Refunds'
      - '#/components/x-apis/Disputes'
      - '#/components/x-apis/Checkout'
      - '#/components/x-apis/ApplePay'
      - '#/components/x-apis/Reporting'
      - '#/components/x-apis/Transactions'
      - '#/components/x-apis/Cards'
      - '#/components/x-apis/Payouts'
  x-categories-order:
  - Payments
  - Terminal
  - Orders
  - Subscriptions
  - Invoices
  - Catalog
  - Inventory
  - Customers
  - Loyalty
  - Gift Cards
  - Bookings
  - Business
  - Team
  - Financials
  - Online
  - Auth
  - Webhook Subscriptions
  x-v1-api-mappings:
    V1Employees:
      V1ListCashDrawerShifts: CashDrawers
      V1RetrieveCashDrawerShift: CashDrawers
      V1CreateEmployee: Employees
      V1CreateEmployeeRole: Employees
      V1ListEmployees: Employees
      V1ListEmployeeRoles: Employees
      V1RetrieveEmployee: Employees
      V1RetrieveEmployeeRole: Employees
      V1UpdateEmployee: Employees
      V1UpdateEmployeeRole: Employees
      V1CreateTimecard: Labor
      V1DeleteTimecard: Labor
      V1ListTimecards: Labor
      V1ListTimecardEvents: Labor
      V1RetrieveTimecard: Labor
      V1UpdateTimecard: Labor
    V1Items:
      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
      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
      V1AdjustInventory: Inventory
      V1ListInventory: Inventory
    V1Locations:
      V1ListLocations: Locations
      V1RetrieveBusiness: Merchants
    V1Transactions:
      V1ListBankAccounts: BankAccounts
      V1RetrieveBankAccount: BankAccounts
      V1ListPayments: Payments
      V1RetrievePayment: Payments
      V1CreateRefund: Refunds
      V1ListRefunds: Refunds
      V1ListSettlements: Settlements
      V1RetrieveSettlement: Settlements
    V1Webhooks:
      V1ListWebhooks: Webhooks
      V1UpdateWebhooks: Webhooks