From 874a6871fc9177c2d4e2a2dc4bd7eb91acc3905f Mon Sep 17 00:00:00 2001 From: autobot Date: Wed, 18 Sep 2024 16:15:23 +0000 Subject: [PATCH] Generated PR for Release: 39.1.0.20240919 --- doc/api/apple-pay.md | 2 +- doc/api/bank-accounts.md | 6 ++-- doc/api/booking-custom-attributes.md | 26 +++++++------- doc/api/bookings.md | 28 +++++++-------- doc/api/cards.md | 10 +++--- doc/api/cash-drawers.md | 6 ++-- doc/api/catalog.md | 32 ++++++++--------- doc/api/checkout.md | 20 +++++------ doc/api/customer-custom-attributes.md | 24 ++++++------- doc/api/customer-groups.md | 10 +++--- doc/api/customer-segments.md | 4 +-- doc/api/customers.md | 30 ++++++++-------- doc/api/devices.md | 10 +++--- doc/api/disputes.md | 18 +++++----- doc/api/employees.md | 4 +-- doc/api/events.md | 8 ++--- doc/api/gift-card-activities.md | 4 +-- doc/api/gift-cards.md | 14 ++++---- doc/api/inventory.md | 26 +++++++------- doc/api/invoices.md | 20 +++++------ doc/api/labor.md | 32 ++++++++--------- doc/api/location-custom-attributes.md | 26 +++++++------- doc/api/locations.md | 8 ++--- doc/api/loyalty.md | 36 +++++++++---------- doc/api/merchant-custom-attributes.md | 26 +++++++------- doc/api/merchants.md | 4 +-- doc/api/mobile-authorization.md | 2 +- doc/api/o-auth.md | 6 ++-- doc/api/order-custom-attributes.md | 26 +++++++------- doc/api/orders.md | 16 ++++----- doc/api/payments.md | 16 ++++----- doc/api/payouts.md | 6 ++-- doc/api/refunds.md | 6 ++-- doc/api/sites.md | 2 +- doc/api/snippets.md | 6 ++-- doc/api/subscriptions.md | 24 ++++++------- doc/api/team.md | 16 ++++----- doc/api/terminal.md | 30 ++++++++-------- doc/api/transactions.md | 8 ++--- doc/api/v1-transactions.md | 6 ++-- doc/api/vendors.md | 14 ++++---- doc/api/webhook-subscriptions.md | 18 +++++----- doc/client.md | 9 +++-- doc/models/booking.md | 1 + doc/models/customer.md | 2 +- doc/models/payment.md | 1 + doc/models/update-booking-response.md | 8 +++++ lib/square/api/apple_pay_api.rb | 2 +- lib/square/api/bank_accounts_api.rb | 6 ++-- lib/square/api/base_api.rb | 2 +- .../api/booking_custom_attributes_api.rb | 22 ++++++------ lib/square/api/bookings_api.rb | 26 +++++++------- lib/square/api/cards_api.rb | 8 ++--- lib/square/api/cash_drawers_api.rb | 6 ++-- lib/square/api/catalog_api.rb | 28 +++++++-------- lib/square/api/checkout_api.rb | 20 +++++------ .../api/customer_custom_attributes_api.rb | 20 +++++------ lib/square/api/customer_groups_api.rb | 10 +++--- lib/square/api/customer_segments_api.rb | 4 +-- lib/square/api/customers_api.rb | 28 +++++++-------- lib/square/api/devices_api.rb | 10 +++--- lib/square/api/disputes_api.rb | 18 +++++----- lib/square/api/employees_api.rb | 4 +-- lib/square/api/events_api.rb | 8 ++--- lib/square/api/gift_card_activities_api.rb | 4 +-- lib/square/api/gift_cards_api.rb | 14 ++++---- lib/square/api/inventory_api.rb | 26 +++++++------- lib/square/api/invoices_api.rb | 20 +++++------ lib/square/api/labor_api.rb | 32 ++++++++--------- .../api/location_custom_attributes_api.rb | 22 ++++++------ lib/square/api/locations_api.rb | 8 ++--- lib/square/api/loyalty_api.rb | 36 +++++++++---------- .../api/merchant_custom_attributes_api.rb | 22 ++++++------ lib/square/api/merchants_api.rb | 4 +-- lib/square/api/mobile_authorization_api.rb | 2 +- lib/square/api/o_auth_api.rb | 6 ++-- lib/square/api/order_custom_attributes_api.rb | 22 ++++++------ lib/square/api/orders_api.rb | 16 ++++----- lib/square/api/payments_api.rb | 14 ++++---- lib/square/api/payouts_api.rb | 6 ++-- lib/square/api/refunds_api.rb | 6 ++-- lib/square/api/sites_api.rb | 2 +- lib/square/api/snippets_api.rb | 6 ++-- lib/square/api/subscriptions_api.rb | 24 ++++++------- lib/square/api/team_api.rb | 16 ++++----- lib/square/api/terminal_api.rb | 30 ++++++++-------- lib/square/api/transactions_api.rb | 8 ++--- lib/square/api/v1_transactions_api.rb | 6 ++-- lib/square/api/vendors_api.rb | 14 ++++---- lib/square/api/webhook_subscriptions_api.rb | 16 ++++----- lib/square/client.rb | 4 +-- lib/square/configuration.rb | 2 +- square.gemspec | 2 +- 93 files changed, 641 insertions(+), 628 deletions(-) diff --git a/doc/api/apple-pay.md b/doc/api/apple-pay.md index ec2be280..6130fe42 100644 --- a/doc/api/apple-pay.md +++ b/doc/api/apple-pay.md @@ -38,7 +38,7 @@ def register_domain(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Register Domain Response Hash`](../../doc/models/register-domain-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Register Domain Response Hash`](../../doc/models/register-domain-response.md). ## Example Usage diff --git a/doc/api/bank-accounts.md b/doc/api/bank-accounts.md index aa0a988e..940799ad 100644 --- a/doc/api/bank-accounts.md +++ b/doc/api/bank-accounts.md @@ -35,7 +35,7 @@ def list_bank_accounts(cursor: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Bank Accounts Response Hash`](../../doc/models/list-bank-accounts-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Bank Accounts Response Hash`](../../doc/models/list-bank-accounts-response.md). ## Example Usage @@ -66,7 +66,7 @@ def get_bank_account_by_v1_id(v1_bank_account_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Bank Account by V1 Id Response Hash`](../../doc/models/get-bank-account-by-v1-id-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Bank Account by V1 Id Response Hash`](../../doc/models/get-bank-account-by-v1-id-response.md). ## Example Usage @@ -101,7 +101,7 @@ def get_bank_account(bank_account_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Bank Account Response Hash`](../../doc/models/get-bank-account-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Bank Account Response Hash`](../../doc/models/get-bank-account-response.md). ## Example Usage diff --git a/doc/api/booking-custom-attributes.md b/doc/api/booking-custom-attributes.md index 32b68d6a..ac784d6c 100644 --- a/doc/api/booking-custom-attributes.md +++ b/doc/api/booking-custom-attributes.md @@ -44,7 +44,7 @@ def list_booking_custom_attribute_definitions(limit: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Booking Custom Attribute Definitions Response Hash`](../../doc/models/list-booking-custom-attribute-definitions-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Booking Custom Attribute Definitions Response Hash`](../../doc/models/list-booking-custom-attribute-definitions-response.md). ## Example Usage @@ -81,7 +81,7 @@ def create_booking_custom_attribute_definition(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Booking Custom Attribute Definition Response Hash`](../../doc/models/create-booking-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Booking Custom Attribute Definition Response Hash`](../../doc/models/create-booking-custom-attribute-definition-response.md). ## Example Usage @@ -123,7 +123,7 @@ def delete_booking_custom_attribute_definition(key:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Booking Custom Attribute Definition Response Hash`](../../doc/models/delete-booking-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Booking Custom Attribute Definition Response Hash`](../../doc/models/delete-booking-custom-attribute-definition-response.md). ## Example Usage @@ -162,7 +162,7 @@ def retrieve_booking_custom_attribute_definition(key:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Booking Custom Attribute Definition Response Hash`](../../doc/models/retrieve-booking-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Booking Custom Attribute Definition Response Hash`](../../doc/models/retrieve-booking-custom-attribute-definition-response.md). ## Example Usage @@ -204,7 +204,7 @@ def update_booking_custom_attribute_definition(key:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Booking Custom Attribute Definition Response Hash`](../../doc/models/update-booking-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Booking Custom Attribute Definition Response Hash`](../../doc/models/update-booking-custom-attribute-definition-response.md). ## Example Usage @@ -251,7 +251,7 @@ def bulk_delete_booking_custom_attributes(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Delete Booking Custom Attributes Response Hash`](../../doc/models/bulk-delete-booking-custom-attributes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Delete Booking Custom Attributes Response Hash`](../../doc/models/bulk-delete-booking-custom-attributes-response.md). ## Example Usage @@ -302,7 +302,7 @@ def bulk_upsert_booking_custom_attributes(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Upsert Booking Custom Attributes Response Hash`](../../doc/models/bulk-upsert-booking-custom-attributes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Upsert Booking Custom Attributes Response Hash`](../../doc/models/bulk-upsert-booking-custom-attributes-response.md). ## Example Usage @@ -352,11 +352,11 @@ def list_booking_custom_attributes(booking_id:, | `booking_id` | `String` | Template, Required | The ID of the target [booking](entity:Booking). | | `limit` | `Integer` | Query, Optional | 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` | `String` | Query, Optional | 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` | `TrueClass \| FalseClass` | Query, Optional | 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`. | +| `with_definitions` | `TrueClass \| FalseClass` | Query, Optional | 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`.
**Default**: `false` | ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Booking Custom Attributes Response Hash`](../../doc/models/list-booking-custom-attributes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Booking Custom Attributes Response Hash`](../../doc/models/list-booking-custom-attributes-response.md). ## Example Usage @@ -403,7 +403,7 @@ def delete_booking_custom_attribute(booking_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Booking Custom Attribute Response Hash`](../../doc/models/delete-booking-custom-attribute-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Booking Custom Attribute Response Hash`](../../doc/models/delete-booking-custom-attribute-response.md). ## Example Usage @@ -446,12 +446,12 @@ def retrieve_booking_custom_attribute(booking_id:, | --- | --- | --- | --- | | `booking_id` | `String` | Template, Required | The ID of the target [booking](entity:Booking). | | `key` | `String` | Template, Required | The key of the custom attribute to retrieve. This key must match the `key` of a custom
attribute definition in the Square seller account. If the requesting application is not the
definition owner, you must use the qualified key. | -| `with_definition` | `TrueClass \| FalseClass` | Query, Optional | 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`. | +| `with_definition` | `TrueClass \| FalseClass` | Query, Optional | 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`.
**Default**: `false` | | `version` | `Integer` | Query, Optional | The current version of the custom attribute, which is used for strongly consistent reads to
guarantee that you receive the most up-to-date data. When included in the request, Square
returns the specified version or a higher version if one exists. If the specified version is
higher than the current version, Square returns a `BAD_REQUEST` error. | ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Booking Custom Attribute Response Hash`](../../doc/models/retrieve-booking-custom-attribute-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Booking Custom Attribute Response Hash`](../../doc/models/retrieve-booking-custom-attribute-response.md). ## Example Usage @@ -503,7 +503,7 @@ def upsert_booking_custom_attribute(booking_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Upsert Booking Custom Attribute Response Hash`](../../doc/models/upsert-booking-custom-attribute-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Upsert Booking Custom Attribute Response Hash`](../../doc/models/upsert-booking-custom-attribute-response.md). ## Example Usage diff --git a/doc/api/bookings.md b/doc/api/bookings.md index 98e21579..d25da43a 100644 --- a/doc/api/bookings.md +++ b/doc/api/bookings.md @@ -56,7 +56,7 @@ def list_bookings(limit: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Bookings Response Hash`](../../doc/models/list-bookings-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Bookings Response Hash`](../../doc/models/list-bookings-response.md). ## Example Usage @@ -101,7 +101,7 @@ def create_booking(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Booking Response Hash`](../../doc/models/create-booking-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Booking Response Hash`](../../doc/models/create-booking-response.md). ## Example Usage @@ -140,7 +140,7 @@ def search_availability(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Availability Response Hash`](../../doc/models/search-availability-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Availability Response Hash`](../../doc/models/search-availability-response.md). ## Example Usage @@ -183,7 +183,7 @@ def bulk_retrieve_bookings(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Retrieve Bookings Response Hash`](../../doc/models/bulk-retrieve-bookings-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Retrieve Bookings Response Hash`](../../doc/models/bulk-retrieve-bookings-response.md). ## Example Usage @@ -217,7 +217,7 @@ def retrieve_business_booking_profile ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Business Booking Profile Response Hash`](../../doc/models/retrieve-business-booking-profile-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Business Booking Profile Response Hash`](../../doc/models/retrieve-business-booking-profile-response.md). ## Example Usage @@ -250,7 +250,7 @@ def list_location_booking_profiles(limit: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Location Booking Profiles Response Hash`](../../doc/models/list-location-booking-profiles-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Location Booking Profiles Response Hash`](../../doc/models/list-location-booking-profiles-response.md). ## Example Usage @@ -281,7 +281,7 @@ def retrieve_location_booking_profile(location_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Location Booking Profile Response Hash`](../../doc/models/retrieve-location-booking-profile-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Location Booking Profile Response Hash`](../../doc/models/retrieve-location-booking-profile-response.md). ## Example Usage @@ -314,14 +314,14 @@ def list_team_member_booking_profiles(bookable_only: false, | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `bookable_only` | `TrueClass \| FalseClass` | Query, Optional | Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`). | +| `bookable_only` | `TrueClass \| FalseClass` | Query, Optional | Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`).
**Default**: `false` | | `limit` | `Integer` | Query, Optional | The maximum number of results to return in a paged response. | | `cursor` | `String` | Query, Optional | 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` | `String` | Query, Optional | Indicates whether to include only team members enabled at the given location in the returned result. | ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Team Member Booking Profiles Response Hash`](../../doc/models/list-team-member-booking-profiles-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Team Member Booking Profiles Response Hash`](../../doc/models/list-team-member-booking-profiles-response.md). ## Example Usage @@ -355,7 +355,7 @@ def bulk_retrieve_team_member_booking_profiles(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Retrieve Team Member Booking Profiles Response Hash`](../../doc/models/bulk-retrieve-team-member-booking-profiles-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Retrieve Team Member Booking Profiles Response Hash`](../../doc/models/bulk-retrieve-team-member-booking-profiles-response.md). ## Example Usage @@ -395,7 +395,7 @@ def retrieve_team_member_booking_profile(team_member_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Team Member Booking Profile Response Hash`](../../doc/models/retrieve-team-member-booking-profile-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Team Member Booking Profile Response Hash`](../../doc/models/retrieve-team-member-booking-profile-response.md). ## Example Usage @@ -432,7 +432,7 @@ def retrieve_booking(booking_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Booking Response Hash`](../../doc/models/retrieve-booking-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Booking Response Hash`](../../doc/models/retrieve-booking-response.md). ## Example Usage @@ -474,7 +474,7 @@ def update_booking(booking_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Booking Response Hash`](../../doc/models/update-booking-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Booking Response Hash`](../../doc/models/update-booking-response.md). ## Example Usage @@ -523,7 +523,7 @@ def cancel_booking(booking_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Booking Response Hash`](../../doc/models/cancel-booking-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Booking Response Hash`](../../doc/models/cancel-booking-response.md). ## Example Usage diff --git a/doc/api/cards.md b/doc/api/cards.md index 58536c13..28d7810d 100644 --- a/doc/api/cards.md +++ b/doc/api/cards.md @@ -35,13 +35,13 @@ def list_cards(cursor: nil, | --- | --- | --- | --- | | `cursor` | `String` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this to retrieve the next set of results for your original query.

See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. | | `customer_id` | `String` | Query, Optional | Limit results to cards associated with the customer supplied.
By default, all cards owned by the merchant are returned. | -| `include_disabled` | `TrueClass \| FalseClass` | Query, Optional | Includes disabled cards.
By default, all enabled cards owned by the merchant are returned. | +| `include_disabled` | `TrueClass \| FalseClass` | Query, Optional | Includes disabled cards.
By default, all enabled cards owned by the merchant are returned.
**Default**: `false` | | `reference_id` | `String` | Query, Optional | Limit results to cards associated with the reference_id supplied. | | `sort_order` | [`String (Sort Order)`](../../doc/models/sort-order.md) | Query, Optional | Sorts the returned list by when the card was created with the specified order.
This field defaults to ASC. | ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Cards Response Hash`](../../doc/models/list-cards-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Cards Response Hash`](../../doc/models/list-cards-response.md). ## Example Usage @@ -75,7 +75,7 @@ def create_card(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Card Response Hash`](../../doc/models/create-card-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Card Response Hash`](../../doc/models/create-card-response.md). ## Example Usage @@ -125,7 +125,7 @@ def retrieve_card(card_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Card Response Hash`](../../doc/models/retrieve-card-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Card Response Hash`](../../doc/models/retrieve-card-response.md). ## Example Usage @@ -160,7 +160,7 @@ def disable_card(card_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Disable Card Response Hash`](../../doc/models/disable-card-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Disable Card Response Hash`](../../doc/models/disable-card-response.md). ## Example Usage diff --git a/doc/api/cash-drawers.md b/doc/api/cash-drawers.md index 7bf49970..c0bda6af 100644 --- a/doc/api/cash-drawers.md +++ b/doc/api/cash-drawers.md @@ -42,7 +42,7 @@ def list_cash_drawer_shifts(location_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Cash Drawer Shifts Response Hash`](../../doc/models/list-cash-drawer-shifts-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Cash Drawer Shifts Response Hash`](../../doc/models/list-cash-drawer-shifts-response.md). ## Example Usage @@ -79,7 +79,7 @@ def retrieve_cash_drawer_shift(location_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Cash Drawer Shift Response Hash`](../../doc/models/retrieve-cash-drawer-shift-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Cash Drawer Shift Response Hash`](../../doc/models/retrieve-cash-drawer-shift-response.md). ## Example Usage @@ -124,7 +124,7 @@ def list_cash_drawer_shift_events(location_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Cash Drawer Shift Events Response Hash`](../../doc/models/list-cash-drawer-shift-events-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Cash Drawer Shift Events Response Hash`](../../doc/models/list-cash-drawer-shift-events-response.md). ## Example Usage diff --git a/doc/api/catalog.md b/doc/api/catalog.md index fd670355..eadf8e09 100644 --- a/doc/api/catalog.md +++ b/doc/api/catalog.md @@ -55,7 +55,7 @@ def batch_delete_catalog_objects(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Delete Catalog Objects Response Hash`](../../doc/models/batch-delete-catalog-objects-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Delete Catalog Objects Response Hash`](../../doc/models/batch-delete-catalog-objects-response.md). ## Example Usage @@ -99,7 +99,7 @@ def batch_retrieve_catalog_objects(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Retrieve Catalog Objects Response Hash`](../../doc/models/batch-retrieve-catalog-objects-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Retrieve Catalog Objects Response Hash`](../../doc/models/batch-retrieve-catalog-objects-response.md). ## Example Usage @@ -151,7 +151,7 @@ def batch_upsert_catalog_objects(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Upsert Catalog Objects Response Hash`](../../doc/models/batch-upsert-catalog-objects-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Upsert Catalog Objects Response Hash`](../../doc/models/batch-upsert-catalog-objects-response.md). ## Example Usage @@ -301,7 +301,7 @@ def create_catalog_image(request: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Catalog Image Response Hash`](../../doc/models/create-catalog-image-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Catalog Image Response Hash`](../../doc/models/create-catalog-image-response.md). ## Example Usage @@ -352,7 +352,7 @@ def update_catalog_image(image_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Catalog Image Response Hash`](../../doc/models/update-catalog-image-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Catalog Image Response Hash`](../../doc/models/update-catalog-image-response.md). ## Example Usage @@ -388,7 +388,7 @@ def catalog_info ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Catalog Info Response Hash`](../../doc/models/catalog-info-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Catalog Info Response Hash`](../../doc/models/catalog-info-response.md). ## Example Usage @@ -430,7 +430,7 @@ def list_catalog(cursor: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Catalog Response Hash`](../../doc/models/list-catalog-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Catalog Response Hash`](../../doc/models/list-catalog-response.md). ## Example Usage @@ -465,7 +465,7 @@ def upsert_catalog_object(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Upsert Catalog Object Response Hash`](../../doc/models/upsert-catalog-object-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Upsert Catalog Object Response Hash`](../../doc/models/upsert-catalog-object-response.md). ## Example Usage @@ -543,7 +543,7 @@ def delete_catalog_object(object_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Catalog Object Response Hash`](../../doc/models/delete-catalog-object-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Catalog Object Response Hash`](../../doc/models/delete-catalog-object-response.md). ## Example Usage @@ -583,13 +583,13 @@ def retrieve_catalog_object(object_id:, | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `object_id` | `String` | Template, Required | The object ID of any type of catalog objects to be retrieved. | -| `include_related_objects` | `TrueClass \| FalseClass` | Query, Optional | 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` | +| `include_related_objects` | `TrueClass \| FalseClass` | Query, Optional | 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`
**Default**: `false` | | `catalog_version` | `Integer` | Query, Optional | 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](../../doc/models/catalog-object.md)s. If not included, results will
be from the current version of the catalog. | -| `include_category_path_to_root` | `TrueClass \| FalseClass` | Query, Optional | Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists
of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category
and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned
in the response payload. | +| `include_category_path_to_root` | `TrueClass \| FalseClass` | Query, Optional | Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists
of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category
and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned
in the response payload.
**Default**: `false` | ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Catalog Object Response Hash`](../../doc/models/retrieve-catalog-object-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Catalog Object Response Hash`](../../doc/models/retrieve-catalog-object-response.md). ## Example Usage @@ -640,7 +640,7 @@ def search_catalog_objects(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Catalog Objects Response Hash`](../../doc/models/search-catalog-objects-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Catalog Objects Response Hash`](../../doc/models/search-catalog-objects-response.md). ## Example Usage @@ -694,7 +694,7 @@ def search_catalog_items(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Catalog Items Response Hash`](../../doc/models/search-catalog-items-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Catalog Items Response Hash`](../../doc/models/search-catalog-items-response.md). ## Example Usage @@ -767,7 +767,7 @@ def update_item_modifier_lists(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Item Modifier Lists Response Hash`](../../doc/models/update-item-modifier-lists-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Item Modifier Lists Response Hash`](../../doc/models/update-item-modifier-lists-response.md). ## Example Usage @@ -815,7 +815,7 @@ def update_item_taxes(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Item Taxes Response Hash`](../../doc/models/update-item-taxes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Item Taxes Response Hash`](../../doc/models/update-item-taxes-response.md). ## Example Usage diff --git a/doc/api/checkout.md b/doc/api/checkout.md index f13c79a2..11821a3e 100644 --- a/doc/api/checkout.md +++ b/doc/api/checkout.md @@ -47,7 +47,7 @@ def create_checkout(location_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Checkout Response Hash`](../../doc/models/create-checkout-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Checkout Response Hash`](../../doc/models/create-checkout-response.md). ## Example Usage @@ -175,7 +175,7 @@ def retrieve_location_settings(location_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Location Settings Response Hash`](../../doc/models/retrieve-location-settings-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Location Settings Response Hash`](../../doc/models/retrieve-location-settings-response.md). ## Example Usage @@ -211,7 +211,7 @@ def update_location_settings(location_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Location Settings Response Hash`](../../doc/models/update-location-settings-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Location Settings Response Hash`](../../doc/models/update-location-settings-response.md). ## Example Usage @@ -246,7 +246,7 @@ def retrieve_merchant_settings ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Merchant Settings Response Hash`](../../doc/models/retrieve-merchant-settings-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Merchant Settings Response Hash`](../../doc/models/retrieve-merchant-settings-response.md). ## Example Usage @@ -277,7 +277,7 @@ def update_merchant_settings(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Merchant Settings Response Hash`](../../doc/models/update-merchant-settings-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Merchant Settings Response Hash`](../../doc/models/update-merchant-settings-response.md). ## Example Usage @@ -315,7 +315,7 @@ def list_payment_links(cursor: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Payment Links Response Hash`](../../doc/models/list-payment-links-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Payment Links Response Hash`](../../doc/models/list-payment-links-response.md). ## Example Usage @@ -346,7 +346,7 @@ def create_payment_link(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Payment Link Response Hash`](../../doc/models/create-payment-link-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Payment Link Response Hash`](../../doc/models/create-payment-link-response.md). ## Example Usage @@ -390,7 +390,7 @@ def delete_payment_link(id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Payment Link Response Hash`](../../doc/models/delete-payment-link-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Payment Link Response Hash`](../../doc/models/delete-payment-link-response.md). ## Example Usage @@ -424,7 +424,7 @@ def retrieve_payment_link(id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Payment Link Response Hash`](../../doc/models/retrieve-payment-link-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Payment Link Response Hash`](../../doc/models/retrieve-payment-link-response.md). ## Example Usage @@ -462,7 +462,7 @@ def update_payment_link(id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Payment Link Response Hash`](../../doc/models/update-payment-link-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Payment Link Response Hash`](../../doc/models/update-payment-link-response.md). ## Example Usage diff --git a/doc/api/customer-custom-attributes.md b/doc/api/customer-custom-attributes.md index 338722ba..03d8e5fe 100644 --- a/doc/api/customer-custom-attributes.md +++ b/doc/api/customer-custom-attributes.md @@ -45,7 +45,7 @@ def list_customer_custom_attribute_definitions(limit: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Customer Custom Attribute Definitions Response Hash`](../../doc/models/list-customer-custom-attribute-definitions-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Customer Custom Attribute Definitions Response Hash`](../../doc/models/list-customer-custom-attribute-definitions-response.md). ## Example Usage @@ -86,7 +86,7 @@ def create_customer_custom_attribute_definition(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Customer Custom Attribute Definition Response Hash`](../../doc/models/create-customer-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Customer Custom Attribute Definition Response Hash`](../../doc/models/create-customer-custom-attribute-definition-response.md). ## Example Usage @@ -132,7 +132,7 @@ def delete_customer_custom_attribute_definition(key:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Customer Custom Attribute Definition Response Hash`](../../doc/models/delete-customer-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Customer Custom Attribute Definition Response Hash`](../../doc/models/delete-customer-custom-attribute-definition-response.md). ## Example Usage @@ -172,7 +172,7 @@ def retrieve_customer_custom_attribute_definition(key:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Customer Custom Attribute Definition Response Hash`](../../doc/models/retrieve-customer-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Customer Custom Attribute Definition Response Hash`](../../doc/models/retrieve-customer-custom-attribute-definition-response.md). ## Example Usage @@ -214,7 +214,7 @@ def update_customer_custom_attribute_definition(key:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Customer Custom Attribute Definition Response Hash`](../../doc/models/update-customer-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Customer Custom Attribute Definition Response Hash`](../../doc/models/update-customer-custom-attribute-definition-response.md). ## Example Usage @@ -271,7 +271,7 @@ def bulk_upsert_customer_custom_attributes(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Upsert Customer Custom Attributes Response Hash`](../../doc/models/bulk-upsert-customer-custom-attributes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Upsert Customer Custom Attributes Response Hash`](../../doc/models/bulk-upsert-customer-custom-attributes-response.md). ## Example Usage @@ -325,11 +325,11 @@ def list_customer_custom_attributes(customer_id:, | `customer_id` | `String` | Template, Required | The ID of the target [customer profile](entity:Customer). | | `limit` | `Integer` | Query, Optional | 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` | `String` | Query, Optional | 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` | `TrueClass \| FalseClass` | Query, Optional | 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`. | +| `with_definitions` | `TrueClass \| FalseClass` | Query, Optional | 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`.
**Default**: `false` | ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Customer Custom Attributes Response Hash`](../../doc/models/list-customer-custom-attributes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Customer Custom Attributes Response Hash`](../../doc/models/list-customer-custom-attributes-response.md). ## Example Usage @@ -374,7 +374,7 @@ def delete_customer_custom_attribute(customer_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Customer Custom Attribute Response Hash`](../../doc/models/delete-customer-custom-attribute-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Customer Custom Attribute Response Hash`](../../doc/models/delete-customer-custom-attribute-response.md). ## Example Usage @@ -421,12 +421,12 @@ def retrieve_customer_custom_attribute(customer_id:, | --- | --- | --- | --- | | `customer_id` | `String` | Template, Required | The ID of the target [customer profile](entity:Customer). | | `key` | `String` | Template, Required | The key of the custom attribute to retrieve. This key must match the `key` of a custom
attribute definition in the Square seller account. If the requesting application is not the
definition owner, you must use the qualified key. | -| `with_definition` | `TrueClass \| FalseClass` | Query, Optional | 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`. | +| `with_definition` | `TrueClass \| FalseClass` | Query, Optional | 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`.
**Default**: `false` | | `version` | `Integer` | Query, Optional | The current version of the custom attribute, which is used for strongly consistent reads to
guarantee that you receive the most up-to-date data. When included in the request, Square
returns the specified version or a higher version if one exists. If the specified version is
higher than the current version, Square returns a `BAD_REQUEST` error. | ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Customer Custom Attribute Response Hash`](../../doc/models/retrieve-customer-custom-attribute-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Customer Custom Attribute Response Hash`](../../doc/models/retrieve-customer-custom-attribute-response.md). ## Example Usage @@ -480,7 +480,7 @@ def upsert_customer_custom_attribute(customer_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Upsert Customer Custom Attribute Response Hash`](../../doc/models/upsert-customer-custom-attribute-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Upsert Customer Custom Attribute Response Hash`](../../doc/models/upsert-customer-custom-attribute-response.md). ## Example Usage diff --git a/doc/api/customer-groups.md b/doc/api/customer-groups.md index 5aaf05c0..e2a83e3a 100644 --- a/doc/api/customer-groups.md +++ b/doc/api/customer-groups.md @@ -35,7 +35,7 @@ def list_customer_groups(cursor: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Customer Groups Response Hash`](../../doc/models/list-customer-groups-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Customer Groups Response Hash`](../../doc/models/list-customer-groups-response.md). ## Example Usage @@ -68,7 +68,7 @@ def create_customer_group(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Customer Group Response Hash`](../../doc/models/create-customer-group-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Customer Group Response Hash`](../../doc/models/create-customer-group-response.md). ## Example Usage @@ -106,7 +106,7 @@ def delete_customer_group(group_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Customer Group Response Hash`](../../doc/models/delete-customer-group-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Customer Group Response Hash`](../../doc/models/delete-customer-group-response.md). ## Example Usage @@ -140,7 +140,7 @@ def retrieve_customer_group(group_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Customer Group Response Hash`](../../doc/models/retrieve-customer-group-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Customer Group Response Hash`](../../doc/models/retrieve-customer-group-response.md). ## Example Usage @@ -176,7 +176,7 @@ def update_customer_group(group_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Customer Group Response Hash`](../../doc/models/update-customer-group-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Customer Group Response Hash`](../../doc/models/update-customer-group-response.md). ## Example Usage diff --git a/doc/api/customer-segments.md b/doc/api/customer-segments.md index 19b928e1..f94ba056 100644 --- a/doc/api/customer-segments.md +++ b/doc/api/customer-segments.md @@ -32,7 +32,7 @@ def list_customer_segments(cursor: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Customer Segments Response Hash`](../../doc/models/list-customer-segments-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Customer Segments Response Hash`](../../doc/models/list-customer-segments-response.md). ## Example Usage @@ -63,7 +63,7 @@ def retrieve_customer_segment(segment_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Customer Segment Response Hash`](../../doc/models/retrieve-customer-segment-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Customer Segment Response Hash`](../../doc/models/retrieve-customer-segment-response.md). ## Example Usage diff --git a/doc/api/customers.md b/doc/api/customers.md index 3ee3d8d5..d456b375 100644 --- a/doc/api/customers.md +++ b/doc/api/customers.md @@ -50,11 +50,11 @@ def list_customers(cursor: nil, | `limit` | `Integer` | Query, Optional | 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` | [`String (Customer Sort Field)`](../../doc/models/customer-sort-field.md) | Query, Optional | Indicates how customers should be sorted.

The default value is `DEFAULT`. | | `sort_order` | [`String (Sort Order)`](../../doc/models/sort-order.md) | Query, Optional | Indicates whether customers should be sorted in ascending (`ASC`) or
descending (`DESC`) order.

The default value is `ASC`. | -| `count` | `TrueClass \| FalseClass` | Query, Optional | Indicates whether to return the total count of customers in the `count` field of the response.

The default value is `false`. | +| `count` | `TrueClass \| FalseClass` | Query, Optional | Indicates whether to return the total count of customers in the `count` field of the response.

The default value is `false`.
**Default**: `false` | ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Customers Response Hash`](../../doc/models/list-customers-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Customers Response Hash`](../../doc/models/list-customers-response.md). ## Example Usage @@ -97,7 +97,7 @@ def create_customer(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Customer Response Hash`](../../doc/models/create-customer-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Customer Response Hash`](../../doc/models/create-customer-response.md). ## Example Usage @@ -156,7 +156,7 @@ def bulk_create_customers(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Create Customers Response Hash`](../../doc/models/bulk-create-customers-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Create Customers Response Hash`](../../doc/models/bulk-create-customers-response.md). ## Example Usage @@ -227,7 +227,7 @@ def bulk_delete_customers(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Delete Customers Response Hash`](../../doc/models/bulk-delete-customers-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Delete Customers Response Hash`](../../doc/models/bulk-delete-customers-response.md). ## Example Usage @@ -269,7 +269,7 @@ def bulk_retrieve_customers(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Retrieve Customers Response Hash`](../../doc/models/bulk-retrieve-customers-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Retrieve Customers Response Hash`](../../doc/models/bulk-retrieve-customers-response.md). ## Example Usage @@ -313,7 +313,7 @@ def bulk_update_customers(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Update Customers Response Hash`](../../doc/models/bulk-update-customers-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Update Customers Response Hash`](../../doc/models/bulk-update-customers-response.md). ## Example Usage @@ -369,7 +369,7 @@ def search_customers(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Customers Response Hash`](../../doc/models/search-customers-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Customers Response Hash`](../../doc/models/search-customers-response.md). ## Example Usage @@ -435,7 +435,7 @@ def delete_customer(customer_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Customer Response Hash`](../../doc/models/delete-customer-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Customer Response Hash`](../../doc/models/delete-customer-response.md). ## Example Usage @@ -469,7 +469,7 @@ def retrieve_customer(customer_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Customer Response Hash`](../../doc/models/retrieve-customer-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Customer Response Hash`](../../doc/models/retrieve-customer-response.md). ## Example Usage @@ -510,7 +510,7 @@ def update_customer(customer_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Customer Response Hash`](../../doc/models/update-customer-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Customer Response Hash`](../../doc/models/update-customer-response.md). ## Example Usage @@ -562,7 +562,7 @@ def create_customer_card(customer_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Customer Card Response Hash`](../../doc/models/create-customer-card-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Customer Card Response Hash`](../../doc/models/create-customer-card-response.md). ## Example Usage @@ -616,7 +616,7 @@ def delete_customer_card(customer_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Customer Card Response Hash`](../../doc/models/delete-customer-card-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Customer Card Response Hash`](../../doc/models/delete-customer-card-response.md). ## Example Usage @@ -660,7 +660,7 @@ def remove_group_from_customer(customer_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Remove Group From Customer Response Hash`](../../doc/models/remove-group-from-customer-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Remove Group From Customer Response Hash`](../../doc/models/remove-group-from-customer-response.md). ## Example Usage @@ -704,7 +704,7 @@ def add_group_to_customer(customer_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Add Group to Customer Response Hash`](../../doc/models/add-group-to-customer-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Add Group to Customer Response Hash`](../../doc/models/add-group-to-customer-response.md). ## Example Usage diff --git a/doc/api/devices.md b/doc/api/devices.md index d0bfba5d..6eec49d5 100644 --- a/doc/api/devices.md +++ b/doc/api/devices.md @@ -40,7 +40,7 @@ def list_devices(cursor: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Devices Response Hash`](../../doc/models/list-devices-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Devices Response Hash`](../../doc/models/list-devices-response.md). ## Example Usage @@ -77,7 +77,7 @@ def list_device_codes(cursor: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Device Codes Response Hash`](../../doc/models/list-device-codes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Device Codes Response Hash`](../../doc/models/list-device-codes-response.md). ## Example Usage @@ -109,7 +109,7 @@ def create_device_code(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Device Code Response Hash`](../../doc/models/create-device-code-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Device Code Response Hash`](../../doc/models/create-device-code-response.md). ## Example Usage @@ -150,7 +150,7 @@ def get_device_code(id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Device Code Response Hash`](../../doc/models/get-device-code-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Device Code Response Hash`](../../doc/models/get-device-code-response.md). ## Example Usage @@ -184,7 +184,7 @@ def get_device(device_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Device Response Hash`](../../doc/models/get-device-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Device Response Hash`](../../doc/models/get-device-response.md). ## Example Usage diff --git a/doc/api/disputes.md b/doc/api/disputes.md index 01128503..33471289 100644 --- a/doc/api/disputes.md +++ b/doc/api/disputes.md @@ -41,7 +41,7 @@ def list_disputes(cursor: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Disputes Response Hash`](../../doc/models/list-disputes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Disputes Response Hash`](../../doc/models/list-disputes-response.md). ## Example Usage @@ -72,7 +72,7 @@ def retrieve_dispute(dispute_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Dispute Response Hash`](../../doc/models/retrieve-dispute-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Dispute Response Hash`](../../doc/models/retrieve-dispute-response.md). ## Example Usage @@ -110,7 +110,7 @@ def accept_dispute(dispute_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Accept Dispute Response Hash`](../../doc/models/accept-dispute-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Accept Dispute Response Hash`](../../doc/models/accept-dispute-response.md). ## Example Usage @@ -146,7 +146,7 @@ def list_dispute_evidence(dispute_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Dispute Evidence Response Hash`](../../doc/models/list-dispute-evidence-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Dispute Evidence Response Hash`](../../doc/models/list-dispute-evidence-response.md). ## Example Usage @@ -185,7 +185,7 @@ def create_dispute_evidence_file(dispute_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Dispute Evidence File Response Hash`](../../doc/models/create-dispute-evidence-file-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Dispute Evidence File Response Hash`](../../doc/models/create-dispute-evidence-file-response.md). ## Example Usage @@ -221,7 +221,7 @@ def create_dispute_evidence_text(dispute_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Dispute Evidence Text Response Hash`](../../doc/models/create-dispute-evidence-text-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Dispute Evidence Text Response Hash`](../../doc/models/create-dispute-evidence-text-response.md). ## Example Usage @@ -267,7 +267,7 @@ def delete_dispute_evidence(dispute_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Dispute Evidence Response Hash`](../../doc/models/delete-dispute-evidence-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Dispute Evidence Response Hash`](../../doc/models/delete-dispute-evidence-response.md). ## Example Usage @@ -310,7 +310,7 @@ def retrieve_dispute_evidence(dispute_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Dispute Evidence Response Hash`](../../doc/models/retrieve-dispute-evidence-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Dispute Evidence Response Hash`](../../doc/models/retrieve-dispute-evidence-response.md). ## Example Usage @@ -355,7 +355,7 @@ def submit_evidence(dispute_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Submit Evidence Response Hash`](../../doc/models/submit-evidence-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Submit Evidence Response Hash`](../../doc/models/submit-evidence-response.md). ## Example Usage diff --git a/doc/api/employees.md b/doc/api/employees.md index 591f85ad..45b70d40 100644 --- a/doc/api/employees.md +++ b/doc/api/employees.md @@ -36,7 +36,7 @@ def list_employees(location_id: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Employees Response Hash`](../../doc/models/list-employees-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Employees Response Hash`](../../doc/models/list-employees-response.md). ## Example Usage @@ -67,7 +67,7 @@ def retrieve_employee(id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Employee Response Hash`](../../doc/models/retrieve-employee-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Employee Response Hash`](../../doc/models/retrieve-employee-response.md). ## Example Usage diff --git a/doc/api/events.md b/doc/api/events.md index 5bcc7a8f..8ba3e43d 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -32,7 +32,7 @@ def search_events(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Events Response Hash`](../../doc/models/search-events-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Events Response Hash`](../../doc/models/search-events-response.md). ## Example Usage @@ -62,7 +62,7 @@ def disable_events ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Disable Events Response Hash`](../../doc/models/disable-events-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Disable Events Response Hash`](../../doc/models/disable-events-response.md). ## Example Usage @@ -87,7 +87,7 @@ def enable_events ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Enable Events Response Hash`](../../doc/models/enable-events-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Enable Events Response Hash`](../../doc/models/enable-events-response.md). ## Example Usage @@ -118,7 +118,7 @@ def list_event_types(api_version: nil) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Event Types Response Hash`](../../doc/models/list-event-types-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Event Types Response Hash`](../../doc/models/list-event-types-response.md). ## Example Usage diff --git a/doc/api/gift-card-activities.md b/doc/api/gift-card-activities.md index 4a23fba2..37773897 100644 --- a/doc/api/gift-card-activities.md +++ b/doc/api/gift-card-activities.md @@ -47,7 +47,7 @@ def list_gift_card_activities(gift_card_id: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Gift Card Activities Response Hash`](../../doc/models/list-gift-card-activities-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Gift Card Activities Response Hash`](../../doc/models/list-gift-card-activities-response.md). ## Example Usage @@ -79,7 +79,7 @@ def create_gift_card_activity(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Gift Card Activity Response Hash`](../../doc/models/create-gift-card-activity-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Gift Card Activity Response Hash`](../../doc/models/create-gift-card-activity-response.md). ## Example Usage diff --git a/doc/api/gift-cards.md b/doc/api/gift-cards.md index 3e298830..ce113800 100644 --- a/doc/api/gift-cards.md +++ b/doc/api/gift-cards.md @@ -44,7 +44,7 @@ def list_gift_cards(type: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Gift Cards Response Hash`](../../doc/models/list-gift-cards-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Gift Cards Response Hash`](../../doc/models/list-gift-cards-response.md). ## Example Usage @@ -79,7 +79,7 @@ def create_gift_card(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Gift Card Response Hash`](../../doc/models/create-gift-card-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Gift Card Response Hash`](../../doc/models/create-gift-card-response.md). ## Example Usage @@ -119,7 +119,7 @@ def retrieve_gift_card_from_gan(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Gift Card From GAN Response Hash`](../../doc/models/retrieve-gift-card-from-gan-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Gift Card From GAN Response Hash`](../../doc/models/retrieve-gift-card-from-gan-response.md). ## Example Usage @@ -155,7 +155,7 @@ def retrieve_gift_card_from_nonce(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Gift Card From Nonce Response Hash`](../../doc/models/retrieve-gift-card-from-nonce-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Gift Card From Nonce Response Hash`](../../doc/models/retrieve-gift-card-from-nonce-response.md). ## Example Usage @@ -193,7 +193,7 @@ def link_customer_to_gift_card(gift_card_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Link Customer to Gift Card Response Hash`](../../doc/models/link-customer-to-gift-card-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Link Customer to Gift Card Response Hash`](../../doc/models/link-customer-to-gift-card-response.md). ## Example Usage @@ -236,7 +236,7 @@ def unlink_customer_from_gift_card(gift_card_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Unlink Customer From Gift Card Response Hash`](../../doc/models/unlink-customer-from-gift-card-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Unlink Customer From Gift Card Response Hash`](../../doc/models/unlink-customer-from-gift-card-response.md). ## Example Usage @@ -277,7 +277,7 @@ def retrieve_gift_card(id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Gift Card Response Hash`](../../doc/models/retrieve-gift-card-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Gift Card Response Hash`](../../doc/models/retrieve-gift-card-response.md). ## Example Usage diff --git a/doc/api/inventory.md b/doc/api/inventory.md index 525d8463..27cd5083 100644 --- a/doc/api/inventory.md +++ b/doc/api/inventory.md @@ -44,7 +44,7 @@ def deprecated_retrieve_inventory_adjustment(adjustment_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Inventory Adjustment Response Hash`](../../doc/models/retrieve-inventory-adjustment-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Inventory Adjustment Response Hash`](../../doc/models/retrieve-inventory-adjustment-response.md). ## Example Usage @@ -79,7 +79,7 @@ def retrieve_inventory_adjustment(adjustment_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Inventory Adjustment Response Hash`](../../doc/models/retrieve-inventory-adjustment-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Inventory Adjustment Response Hash`](../../doc/models/retrieve-inventory-adjustment-response.md). ## Example Usage @@ -116,7 +116,7 @@ def deprecated_batch_change_inventory(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Change Inventory Response Hash`](../../doc/models/batch-change-inventory-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Change Inventory Response Hash`](../../doc/models/batch-change-inventory-response.md). ## Example Usage @@ -170,7 +170,7 @@ def deprecated_batch_retrieve_inventory_changes(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Retrieve Inventory Changes Response Hash`](../../doc/models/batch-retrieve-inventory-changes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Retrieve Inventory Changes Response Hash`](../../doc/models/batch-retrieve-inventory-changes-response.md). ## Example Usage @@ -222,7 +222,7 @@ def deprecated_batch_retrieve_inventory_counts(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Retrieve Inventory Counts Response Hash`](../../doc/models/batch-retrieve-inventory-counts-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Retrieve Inventory Counts Response Hash`](../../doc/models/batch-retrieve-inventory-counts-response.md). ## Example Usage @@ -268,7 +268,7 @@ def batch_change_inventory(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Change Inventory Response Hash`](../../doc/models/batch-change-inventory-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Change Inventory Response Hash`](../../doc/models/batch-change-inventory-response.md). ## Example Usage @@ -326,7 +326,7 @@ def batch_retrieve_inventory_changes(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Retrieve Inventory Changes Response Hash`](../../doc/models/batch-retrieve-inventory-changes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Retrieve Inventory Changes Response Hash`](../../doc/models/batch-retrieve-inventory-changes-response.md). ## Example Usage @@ -385,7 +385,7 @@ def batch_retrieve_inventory_counts(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Retrieve Inventory Counts Response Hash`](../../doc/models/batch-retrieve-inventory-counts-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Retrieve Inventory Counts Response Hash`](../../doc/models/batch-retrieve-inventory-counts-response.md). ## Example Usage @@ -430,7 +430,7 @@ def deprecated_retrieve_inventory_physical_count(physical_count_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Inventory Physical Count Response Hash`](../../doc/models/retrieve-inventory-physical-count-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Inventory Physical Count Response Hash`](../../doc/models/retrieve-inventory-physical-count-response.md). ## Example Usage @@ -465,7 +465,7 @@ def retrieve_inventory_physical_count(physical_count_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Inventory Physical Count Response Hash`](../../doc/models/retrieve-inventory-physical-count-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Inventory Physical Count Response Hash`](../../doc/models/retrieve-inventory-physical-count-response.md). ## Example Usage @@ -500,7 +500,7 @@ def retrieve_inventory_transfer(transfer_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Inventory Transfer Response Hash`](../../doc/models/retrieve-inventory-transfer-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Inventory Transfer Response Hash`](../../doc/models/retrieve-inventory-transfer-response.md). ## Example Usage @@ -541,7 +541,7 @@ def retrieve_inventory_count(catalog_object_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Inventory Count Response Hash`](../../doc/models/retrieve-inventory-count-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Inventory Count Response Hash`](../../doc/models/retrieve-inventory-count-response.md). ## Example Usage @@ -593,7 +593,7 @@ def retrieve_inventory_changes(catalog_object_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Inventory Changes Response Hash`](../../doc/models/retrieve-inventory-changes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Inventory Changes Response Hash`](../../doc/models/retrieve-inventory-changes-response.md). ## Example Usage diff --git a/doc/api/invoices.md b/doc/api/invoices.md index f63a971a..ef395fd8 100644 --- a/doc/api/invoices.md +++ b/doc/api/invoices.md @@ -44,7 +44,7 @@ def list_invoices(location_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Invoices Response Hash`](../../doc/models/list-invoices-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Invoices Response Hash`](../../doc/models/list-invoices-response.md). ## Example Usage @@ -82,7 +82,7 @@ def create_invoice(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Invoice Response Hash`](../../doc/models/create-invoice-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Invoice Response Hash`](../../doc/models/create-invoice-response.md). ## Example Usage @@ -171,7 +171,7 @@ def search_invoices(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Invoices Response Hash`](../../doc/models/search-invoices-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Invoices Response Hash`](../../doc/models/search-invoices-response.md). ## Example Usage @@ -224,7 +224,7 @@ def delete_invoice(invoice_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Invoice Response Hash`](../../doc/models/delete-invoice-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Invoice Response Hash`](../../doc/models/delete-invoice-response.md). ## Example Usage @@ -258,7 +258,7 @@ def get_invoice(invoice_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Invoice Response Hash`](../../doc/models/get-invoice-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Invoice Response Hash`](../../doc/models/get-invoice-response.md). ## Example Usage @@ -297,7 +297,7 @@ def update_invoice(invoice_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Invoice Response Hash`](../../doc/models/update-invoice-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Invoice Response Hash`](../../doc/models/update-invoice-response.md). ## Example Usage @@ -361,7 +361,7 @@ def create_invoice_attachment(invoice_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Invoice Attachment Response Hash`](../../doc/models/create-invoice-attachment-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Invoice Attachment Response Hash`](../../doc/models/create-invoice-attachment-response.md). ## Example Usage @@ -406,7 +406,7 @@ def delete_invoice_attachment(invoice_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Invoice Attachment Response Hash`](../../doc/models/delete-invoice-attachment-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Invoice Attachment Response Hash`](../../doc/models/delete-invoice-attachment-response.md). ## Example Usage @@ -450,7 +450,7 @@ def cancel_invoice(invoice_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Invoice Response Hash`](../../doc/models/cancel-invoice-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Invoice Response Hash`](../../doc/models/cancel-invoice-response.md). ## Example Usage @@ -506,7 +506,7 @@ def publish_invoice(invoice_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Publish Invoice Response Hash`](../../doc/models/publish-invoice-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Publish Invoice Response Hash`](../../doc/models/publish-invoice-response.md). ## Example Usage diff --git a/doc/api/labor.md b/doc/api/labor.md index 038009c7..693d4976 100644 --- a/doc/api/labor.md +++ b/doc/api/labor.md @@ -48,7 +48,7 @@ def list_break_types(location_id: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Break Types Response Hash`](../../doc/models/list-break-types-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Break Types Response Hash`](../../doc/models/list-break-types-response.md). ## Example Usage @@ -92,7 +92,7 @@ def create_break_type(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Break Type Response Hash`](../../doc/models/create-break-type-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Break Type Response Hash`](../../doc/models/create-break-type-response.md). ## Example Usage @@ -136,7 +136,7 @@ def delete_break_type(id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Break Type Response Hash`](../../doc/models/delete-break-type-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Break Type Response Hash`](../../doc/models/delete-break-type-response.md). ## Example Usage @@ -170,7 +170,7 @@ def get_break_type(id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Break Type Response Hash`](../../doc/models/get-break-type-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Break Type Response Hash`](../../doc/models/get-break-type-response.md). ## Example Usage @@ -206,7 +206,7 @@ def update_break_type(id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Break Type Response Hash`](../../doc/models/update-break-type-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Break Type Response Hash`](../../doc/models/update-break-type-response.md). ## Example Usage @@ -259,7 +259,7 @@ def list_employee_wages(employee_id: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Employee Wages Response Hash`](../../doc/models/list-employee-wages-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Employee Wages Response Hash`](../../doc/models/list-employee-wages-response.md). ## Example Usage @@ -292,7 +292,7 @@ def get_employee_wage(id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Employee Wage Response Hash`](../../doc/models/get-employee-wage-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Employee Wage Response Hash`](../../doc/models/get-employee-wage-response.md). ## Example Usage @@ -344,7 +344,7 @@ def create_shift(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Shift Response Hash`](../../doc/models/create-shift-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Shift Response Hash`](../../doc/models/create-shift-response.md). ## Example Usage @@ -423,7 +423,7 @@ def search_shifts(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Shifts Response Hash`](../../doc/models/search-shifts-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Shifts Response Hash`](../../doc/models/search-shifts-response.md). ## Example Usage @@ -471,7 +471,7 @@ def delete_shift(id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Shift Response Hash`](../../doc/models/delete-shift-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Shift Response Hash`](../../doc/models/delete-shift-response.md). ## Example Usage @@ -505,7 +505,7 @@ def get_shift(id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Shift Response Hash`](../../doc/models/get-shift-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Shift Response Hash`](../../doc/models/get-shift-response.md). ## Example Usage @@ -547,7 +547,7 @@ def update_shift(id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Shift Response Hash`](../../doc/models/update-shift-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Shift Response Hash`](../../doc/models/update-shift-response.md). ## Example Usage @@ -621,7 +621,7 @@ def list_team_member_wages(team_member_id: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Team Member Wages Response Hash`](../../doc/models/list-team-member-wages-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Team Member Wages Response Hash`](../../doc/models/list-team-member-wages-response.md). ## Example Usage @@ -652,7 +652,7 @@ def get_team_member_wage(id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Team Member Wage Response Hash`](../../doc/models/get-team-member-wage-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Team Member Wage Response Hash`](../../doc/models/get-team-member-wage-response.md). ## Example Usage @@ -688,7 +688,7 @@ def list_workweek_configs(limit: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Workweek Configs Response Hash`](../../doc/models/list-workweek-configs-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Workweek Configs Response Hash`](../../doc/models/list-workweek-configs-response.md). ## Example Usage @@ -721,7 +721,7 @@ def update_workweek_config(id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Workweek Config Response Hash`](../../doc/models/update-workweek-config-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Workweek Config Response Hash`](../../doc/models/update-workweek-config-response.md). ## Example Usage diff --git a/doc/api/location-custom-attributes.md b/doc/api/location-custom-attributes.md index bee69442..d70a46bd 100644 --- a/doc/api/location-custom-attributes.md +++ b/doc/api/location-custom-attributes.md @@ -46,7 +46,7 @@ def list_location_custom_attribute_definitions(visibility_filter: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Location Custom Attribute Definitions Response Hash`](../../doc/models/list-location-custom-attribute-definitions-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Location Custom Attribute Definitions Response Hash`](../../doc/models/list-location-custom-attribute-definitions-response.md). ## Example Usage @@ -83,7 +83,7 @@ def create_location_custom_attribute_definition(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Location Custom Attribute Definition Response Hash`](../../doc/models/create-location-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Location Custom Attribute Definition Response Hash`](../../doc/models/create-location-custom-attribute-definition-response.md). ## Example Usage @@ -127,7 +127,7 @@ def delete_location_custom_attribute_definition(key:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Location Custom Attribute Definition Response Hash`](../../doc/models/delete-location-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Location Custom Attribute Definition Response Hash`](../../doc/models/delete-location-custom-attribute-definition-response.md). ## Example Usage @@ -165,7 +165,7 @@ def retrieve_location_custom_attribute_definition(key:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Location Custom Attribute Definition Response Hash`](../../doc/models/retrieve-location-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Location Custom Attribute Definition Response Hash`](../../doc/models/retrieve-location-custom-attribute-definition-response.md). ## Example Usage @@ -204,7 +204,7 @@ def update_location_custom_attribute_definition(key:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Location Custom Attribute Definition Response Hash`](../../doc/models/update-location-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Location Custom Attribute Definition Response Hash`](../../doc/models/update-location-custom-attribute-definition-response.md). ## Example Usage @@ -250,7 +250,7 @@ def bulk_delete_location_custom_attributes(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Delete Location Custom Attributes Response Hash`](../../doc/models/bulk-delete-location-custom-attributes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Delete Location Custom Attributes Response Hash`](../../doc/models/bulk-delete-location-custom-attributes-response.md). ## Example Usage @@ -305,7 +305,7 @@ def bulk_upsert_location_custom_attributes(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Upsert Location Custom Attributes Response Hash`](../../doc/models/bulk-upsert-location-custom-attributes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Upsert Location Custom Attributes Response Hash`](../../doc/models/bulk-upsert-location-custom-attributes-response.md). ## Example Usage @@ -359,11 +359,11 @@ def list_location_custom_attributes(location_id:, | `visibility_filter` | [`String (Visibility Filter)`](../../doc/models/visibility-filter.md) | Query, Optional | Filters the `CustomAttributeDefinition` results by their `visibility` values. | | `limit` | `Integer` | Query, Optional | 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` | `String` | Query, Optional | 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` | `TrueClass \| FalseClass` | Query, Optional | 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`. | +| `with_definitions` | `TrueClass \| FalseClass` | Query, Optional | 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`.
**Default**: `false` | ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Location Custom Attributes Response Hash`](../../doc/models/list-location-custom-attributes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Location Custom Attributes Response Hash`](../../doc/models/list-location-custom-attributes-response.md). ## Example Usage @@ -406,7 +406,7 @@ def delete_location_custom_attribute(location_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Location Custom Attribute Response Hash`](../../doc/models/delete-location-custom-attribute-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Location Custom Attribute Response Hash`](../../doc/models/delete-location-custom-attribute-response.md). ## Example Usage @@ -450,12 +450,12 @@ def retrieve_location_custom_attribute(location_id:, | --- | --- | --- | --- | | `location_id` | `String` | Template, Required | The ID of the target [location](entity:Location). | | `key` | `String` | Template, Required | The key of the custom attribute to retrieve. This key must match the `key` of a custom
attribute definition in the Square seller account. If the requesting application is not the
definition owner, you must use the qualified key. | -| `with_definition` | `TrueClass \| FalseClass` | Query, Optional | 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`. | +| `with_definition` | `TrueClass \| FalseClass` | Query, Optional | 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`.
**Default**: `false` | | `version` | `Integer` | Query, Optional | The current version of the custom attribute, which is used for strongly consistent reads to
guarantee that you receive the most up-to-date data. When included in the request, Square
returns the specified version or a higher version if one exists. If the specified version is
higher than the current version, Square returns a `BAD_REQUEST` error. | ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Location Custom Attribute Response Hash`](../../doc/models/retrieve-location-custom-attribute-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Location Custom Attribute Response Hash`](../../doc/models/retrieve-location-custom-attribute-response.md). ## Example Usage @@ -506,7 +506,7 @@ def upsert_location_custom_attribute(location_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Upsert Location Custom Attribute Response Hash`](../../doc/models/upsert-location-custom-attribute-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Upsert Location Custom Attribute Response Hash`](../../doc/models/upsert-location-custom-attribute-response.md). ## Example Usage diff --git a/doc/api/locations.md b/doc/api/locations.md index ba3d8bc5..35a00e73 100644 --- a/doc/api/locations.md +++ b/doc/api/locations.md @@ -27,7 +27,7 @@ def list_locations ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Locations Response Hash`](../../doc/models/list-locations-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Locations Response Hash`](../../doc/models/list-locations-response.md). ## Example Usage @@ -64,7 +64,7 @@ def create_location(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Location Response Hash`](../../doc/models/create-location-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Location Response Hash`](../../doc/models/create-location-response.md). ## Example Usage @@ -110,7 +110,7 @@ def retrieve_location(location_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Location Response Hash`](../../doc/models/retrieve-location-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Location Response Hash`](../../doc/models/retrieve-location-response.md). ## Example Usage @@ -146,7 +146,7 @@ def update_location(location_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Location Response Hash`](../../doc/models/update-location-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Location Response Hash`](../../doc/models/update-location-response.md). ## Example Usage diff --git a/doc/api/loyalty.md b/doc/api/loyalty.md index 0a5d6adf..34f1c3ba 100644 --- a/doc/api/loyalty.md +++ b/doc/api/loyalty.md @@ -46,7 +46,7 @@ def create_loyalty_account(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Loyalty Account Response Hash`](../../doc/models/create-loyalty-account-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Loyalty Account Response Hash`](../../doc/models/create-loyalty-account-response.md). ## Example Usage @@ -92,7 +92,7 @@ def search_loyalty_accounts(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Loyalty Accounts Response Hash`](../../doc/models/search-loyalty-accounts-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Loyalty Accounts Response Hash`](../../doc/models/search-loyalty-accounts-response.md). ## Example Usage @@ -135,7 +135,7 @@ def retrieve_loyalty_account(account_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Loyalty Account Response Hash`](../../doc/models/retrieve-loyalty-account-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Loyalty Account Response Hash`](../../doc/models/retrieve-loyalty-account-response.md). ## Example Usage @@ -184,7 +184,7 @@ def accumulate_loyalty_points(account_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Accumulate Loyalty Points Response Hash`](../../doc/models/accumulate-loyalty-points-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Accumulate Loyalty Points Response Hash`](../../doc/models/accumulate-loyalty-points-response.md). ## Example Usage @@ -235,7 +235,7 @@ def adjust_loyalty_points(account_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Adjust Loyalty Points Response Hash`](../../doc/models/adjust-loyalty-points-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Adjust Loyalty Points Response Hash`](../../doc/models/adjust-loyalty-points-response.md). ## Example Usage @@ -287,7 +287,7 @@ def search_loyalty_events(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Loyalty Events Response Hash`](../../doc/models/search-loyalty-events-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Loyalty Events Response Hash`](../../doc/models/search-loyalty-events-response.md). ## Example Usage @@ -329,7 +329,7 @@ def list_loyalty_programs ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Loyalty Programs Response Hash`](../../doc/models/list-loyalty-programs-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Loyalty Programs Response Hash`](../../doc/models/list-loyalty-programs-response.md). ## Example Usage @@ -362,7 +362,7 @@ def retrieve_loyalty_program(program_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Loyalty Program Response Hash`](../../doc/models/retrieve-loyalty-program-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Loyalty Program Response Hash`](../../doc/models/retrieve-loyalty-program-response.md). ## Example Usage @@ -412,7 +412,7 @@ def calculate_loyalty_points(program_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Calculate Loyalty Points Response Hash`](../../doc/models/calculate-loyalty-points-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Calculate Loyalty Points Response Hash`](../../doc/models/calculate-loyalty-points-response.md). ## Example Usage @@ -461,7 +461,7 @@ def list_loyalty_promotions(program_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Loyalty Promotions Response Hash`](../../doc/models/list-loyalty-promotions-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Loyalty Promotions Response Hash`](../../doc/models/list-loyalty-promotions-response.md). ## Example Usage @@ -502,7 +502,7 @@ def create_loyalty_promotion(program_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Loyalty Promotion Response Hash`](../../doc/models/create-loyalty-promotion-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Loyalty Promotion Response Hash`](../../doc/models/create-loyalty-promotion-response.md). ## Example Usage @@ -570,7 +570,7 @@ def retrieve_loyalty_promotion(promotion_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Loyalty Promotion Response Hash`](../../doc/models/retrieve-loyalty-promotion-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Loyalty Promotion Response Hash`](../../doc/models/retrieve-loyalty-promotion-response.md). ## Example Usage @@ -616,7 +616,7 @@ def cancel_loyalty_promotion(promotion_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Loyalty Promotion Response Hash`](../../doc/models/cancel-loyalty-promotion-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Loyalty Promotion Response Hash`](../../doc/models/cancel-loyalty-promotion-response.md). ## Example Usage @@ -662,7 +662,7 @@ def create_loyalty_reward(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Loyalty Reward Response Hash`](../../doc/models/create-loyalty-reward-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Loyalty Reward Response Hash`](../../doc/models/create-loyalty-reward-response.md). ## Example Usage @@ -709,7 +709,7 @@ def search_loyalty_rewards(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Loyalty Rewards Response Hash`](../../doc/models/search-loyalty-rewards-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Loyalty Rewards Response Hash`](../../doc/models/search-loyalty-rewards-response.md). ## Example Usage @@ -756,7 +756,7 @@ def delete_loyalty_reward(reward_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Loyalty Reward Response Hash`](../../doc/models/delete-loyalty-reward-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Loyalty Reward Response Hash`](../../doc/models/delete-loyalty-reward-response.md). ## Example Usage @@ -790,7 +790,7 @@ def retrieve_loyalty_reward(reward_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Loyalty Reward Response Hash`](../../doc/models/retrieve-loyalty-reward-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Loyalty Reward Response Hash`](../../doc/models/retrieve-loyalty-reward-response.md). ## Example Usage @@ -836,7 +836,7 @@ def redeem_loyalty_reward(reward_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Redeem Loyalty Reward Response Hash`](../../doc/models/redeem-loyalty-reward-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Redeem Loyalty Reward Response Hash`](../../doc/models/redeem-loyalty-reward-response.md). ## Example Usage diff --git a/doc/api/merchant-custom-attributes.md b/doc/api/merchant-custom-attributes.md index 645ddf47..3d6b0d6f 100644 --- a/doc/api/merchant-custom-attributes.md +++ b/doc/api/merchant-custom-attributes.md @@ -46,7 +46,7 @@ def list_merchant_custom_attribute_definitions(visibility_filter: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Merchant Custom Attribute Definitions Response Hash`](../../doc/models/list-merchant-custom-attribute-definitions-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Merchant Custom Attribute Definitions Response Hash`](../../doc/models/list-merchant-custom-attribute-definitions-response.md). ## Example Usage @@ -83,7 +83,7 @@ def create_merchant_custom_attribute_definition(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Merchant Custom Attribute Definition Response Hash`](../../doc/models/create-merchant-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Merchant Custom Attribute Definition Response Hash`](../../doc/models/create-merchant-custom-attribute-definition-response.md). ## Example Usage @@ -127,7 +127,7 @@ def delete_merchant_custom_attribute_definition(key:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Merchant Custom Attribute Definition Response Hash`](../../doc/models/delete-merchant-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Merchant Custom Attribute Definition Response Hash`](../../doc/models/delete-merchant-custom-attribute-definition-response.md). ## Example Usage @@ -165,7 +165,7 @@ def retrieve_merchant_custom_attribute_definition(key:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Merchant Custom Attribute Definition Response Hash`](../../doc/models/retrieve-merchant-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Merchant Custom Attribute Definition Response Hash`](../../doc/models/retrieve-merchant-custom-attribute-definition-response.md). ## Example Usage @@ -204,7 +204,7 @@ def update_merchant_custom_attribute_definition(key:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Merchant Custom Attribute Definition Response Hash`](../../doc/models/update-merchant-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Merchant Custom Attribute Definition Response Hash`](../../doc/models/update-merchant-custom-attribute-definition-response.md). ## Example Usage @@ -250,7 +250,7 @@ def bulk_delete_merchant_custom_attributes(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Delete Merchant Custom Attributes Response Hash`](../../doc/models/bulk-delete-merchant-custom-attributes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Delete Merchant Custom Attributes Response Hash`](../../doc/models/bulk-delete-merchant-custom-attributes-response.md). ## Example Usage @@ -302,7 +302,7 @@ def bulk_upsert_merchant_custom_attributes(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Upsert Merchant Custom Attributes Response Hash`](../../doc/models/bulk-upsert-merchant-custom-attributes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Upsert Merchant Custom Attributes Response Hash`](../../doc/models/bulk-upsert-merchant-custom-attributes-response.md). ## Example Usage @@ -356,11 +356,11 @@ def list_merchant_custom_attributes(merchant_id:, | `visibility_filter` | [`String (Visibility Filter)`](../../doc/models/visibility-filter.md) | Query, Optional | Filters the `CustomAttributeDefinition` results by their `visibility` values. | | `limit` | `Integer` | Query, Optional | 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` | `String` | Query, Optional | 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` | `TrueClass \| FalseClass` | Query, Optional | 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`. | +| `with_definitions` | `TrueClass \| FalseClass` | Query, Optional | 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`.
**Default**: `false` | ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Merchant Custom Attributes Response Hash`](../../doc/models/list-merchant-custom-attributes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Merchant Custom Attributes Response Hash`](../../doc/models/list-merchant-custom-attributes-response.md). ## Example Usage @@ -403,7 +403,7 @@ def delete_merchant_custom_attribute(merchant_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Merchant Custom Attribute Response Hash`](../../doc/models/delete-merchant-custom-attribute-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Merchant Custom Attribute Response Hash`](../../doc/models/delete-merchant-custom-attribute-response.md). ## Example Usage @@ -447,12 +447,12 @@ def retrieve_merchant_custom_attribute(merchant_id:, | --- | --- | --- | --- | | `merchant_id` | `String` | Template, Required | The ID of the target [merchant](entity:Merchant). | | `key` | `String` | Template, Required | The key of the custom attribute to retrieve. This key must match the `key` of a custom
attribute definition in the Square seller account. If the requesting application is not the
definition owner, you must use the qualified key. | -| `with_definition` | `TrueClass \| FalseClass` | Query, Optional | 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`. | +| `with_definition` | `TrueClass \| FalseClass` | Query, Optional | 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`.
**Default**: `false` | | `version` | `Integer` | Query, Optional | The current version of the custom attribute, which is used for strongly consistent reads to
guarantee that you receive the most up-to-date data. When included in the request, Square
returns the specified version or a higher version if one exists. If the specified version is
higher than the current version, Square returns a `BAD_REQUEST` error. | ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Merchant Custom Attribute Response Hash`](../../doc/models/retrieve-merchant-custom-attribute-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Merchant Custom Attribute Response Hash`](../../doc/models/retrieve-merchant-custom-attribute-response.md). ## Example Usage @@ -503,7 +503,7 @@ def upsert_merchant_custom_attribute(merchant_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Upsert Merchant Custom Attribute Response Hash`](../../doc/models/upsert-merchant-custom-attribute-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Upsert Merchant Custom Attribute Response Hash`](../../doc/models/upsert-merchant-custom-attribute-response.md). ## Example Usage diff --git a/doc/api/merchants.md b/doc/api/merchants.md index 5c6bc5ba..26a7fa6d 100644 --- a/doc/api/merchants.md +++ b/doc/api/merchants.md @@ -39,7 +39,7 @@ def list_merchants(cursor: nil) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Merchants Response Hash`](../../doc/models/list-merchants-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Merchants Response Hash`](../../doc/models/list-merchants-response.md). ## Example Usage @@ -70,7 +70,7 @@ def retrieve_merchant(merchant_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Merchant Response Hash`](../../doc/models/retrieve-merchant-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Merchant Response Hash`](../../doc/models/retrieve-merchant-response.md). ## Example Usage diff --git a/doc/api/mobile-authorization.md b/doc/api/mobile-authorization.md index 91350c60..b5ea847a 100644 --- a/doc/api/mobile-authorization.md +++ b/doc/api/mobile-authorization.md @@ -36,7 +36,7 @@ def create_mobile_authorization_code(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Mobile Authorization Code Response Hash`](../../doc/models/create-mobile-authorization-code-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Mobile Authorization Code Response Hash`](../../doc/models/create-mobile-authorization-code-response.md). ## Example Usage diff --git a/doc/api/o-auth.md b/doc/api/o-auth.md index d92c36e4..ce8d66f2 100644 --- a/doc/api/o-auth.md +++ b/doc/api/o-auth.md @@ -48,7 +48,7 @@ def revoke_token(body:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Revoke Token Response Hash`](../../doc/models/revoke-token-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Revoke Token Response Hash`](../../doc/models/revoke-token-response.md). ## Example Usage @@ -108,7 +108,7 @@ def obtain_token(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Obtain Token Response Hash`](../../doc/models/obtain-token-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Obtain Token Response Hash`](../../doc/models/obtain-token-response.md). ## Example Usage @@ -154,7 +154,7 @@ def retrieve_token_status ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Token Status Response Hash`](../../doc/models/retrieve-token-status-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Token Status Response Hash`](../../doc/models/retrieve-token-status-response.md). ## Example Usage diff --git a/doc/api/order-custom-attributes.md b/doc/api/order-custom-attributes.md index 857f0fa7..6f49b787 100644 --- a/doc/api/order-custom-attributes.md +++ b/doc/api/order-custom-attributes.md @@ -48,7 +48,7 @@ def list_order_custom_attribute_definitions(visibility_filter: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Order Custom Attribute Definitions Response Hash`](../../doc/models/list-order-custom-attribute-definitions-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Order Custom Attribute Definitions Response Hash`](../../doc/models/list-order-custom-attribute-definitions-response.md). ## Example Usage @@ -83,7 +83,7 @@ def create_order_custom_attribute_definition(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Order Custom Attribute Definition Response Hash`](../../doc/models/create-order-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Order Custom Attribute Definition Response Hash`](../../doc/models/create-order-custom-attribute-definition-response.md). ## Example Usage @@ -127,7 +127,7 @@ def delete_order_custom_attribute_definition(key:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Order Custom Attribute Definition Response Hash`](../../doc/models/delete-order-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Order Custom Attribute Definition Response Hash`](../../doc/models/delete-order-custom-attribute-definition-response.md). ## Example Usage @@ -167,7 +167,7 @@ def retrieve_order_custom_attribute_definition(key:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Order Custom Attribute Definition Response Hash`](../../doc/models/retrieve-order-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Order Custom Attribute Definition Response Hash`](../../doc/models/retrieve-order-custom-attribute-definition-response.md). ## Example Usage @@ -205,7 +205,7 @@ def update_order_custom_attribute_definition(key:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Order Custom Attribute Definition Response Hash`](../../doc/models/update-order-custom-attribute-definition-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Order Custom Attribute Definition Response Hash`](../../doc/models/update-order-custom-attribute-definition-response.md). ## Example Usage @@ -264,7 +264,7 @@ def bulk_delete_order_custom_attributes(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Delete Order Custom Attributes Response Hash`](../../doc/models/bulk-delete-order-custom-attributes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Delete Order Custom Attributes Response Hash`](../../doc/models/bulk-delete-order-custom-attributes-response.md). ## Example Usage @@ -322,7 +322,7 @@ def bulk_upsert_order_custom_attributes(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Upsert Order Custom Attributes Response Hash`](../../doc/models/bulk-upsert-order-custom-attributes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Upsert Order Custom Attributes Response Hash`](../../doc/models/bulk-upsert-order-custom-attributes-response.md). ## Example Usage @@ -378,11 +378,11 @@ def list_order_custom_attributes(order_id:, | `visibility_filter` | [`String (Visibility Filter)`](../../doc/models/visibility-filter.md) | Query, Optional | Requests that all of the custom attributes be returned, or only those that are read-only or read-write. | | `cursor` | `String` | Query, Optional | The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). | | `limit` | `Integer` | Query, Optional | The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). | -| `with_definitions` | `TrueClass \| FalseClass` | Query, Optional | 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`. | +| `with_definitions` | `TrueClass \| FalseClass` | Query, Optional | 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`.
**Default**: `false` | ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Order Custom Attributes Response Hash`](../../doc/models/list-order-custom-attributes-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Order Custom Attributes Response Hash`](../../doc/models/list-order-custom-attributes-response.md). ## Example Usage @@ -427,7 +427,7 @@ def delete_order_custom_attribute(order_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Order Custom Attribute Response Hash`](../../doc/models/delete-order-custom-attribute-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Order Custom Attribute Response Hash`](../../doc/models/delete-order-custom-attribute-response.md). ## Example Usage @@ -475,11 +475,11 @@ def retrieve_order_custom_attribute(order_id:, | `order_id` | `String` | Template, Required | The ID of the target [order](entity:Order). | | `custom_attribute_key` | `String` | Template, Required | The key of the custom attribute to retrieve. This key must match the key of an
existing custom attribute definition. | | `version` | `Integer` | Query, Optional | To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)
control, include this optional field and specify the current version of the custom attribute. | -| `with_definition` | `TrueClass \| FalseClass` | Query, Optional | 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`. | +| `with_definition` | `TrueClass \| FalseClass` | Query, Optional | 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`.
**Default**: `false` | ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Order Custom Attribute Response Hash`](../../doc/models/retrieve-order-custom-attribute-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Order Custom Attribute Response Hash`](../../doc/models/retrieve-order-custom-attribute-response.md). ## Example Usage @@ -533,7 +533,7 @@ def upsert_order_custom_attribute(order_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Upsert Order Custom Attribute Response Hash`](../../doc/models/upsert-order-custom-attribute-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Upsert Order Custom Attribute Response Hash`](../../doc/models/upsert-order-custom-attribute-response.md). ## Example Usage diff --git a/doc/api/orders.md b/doc/api/orders.md index 91804743..3d4cbfb6 100644 --- a/doc/api/orders.md +++ b/doc/api/orders.md @@ -42,7 +42,7 @@ def create_order(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Order Response Hash`](../../doc/models/create-order-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Order Response Hash`](../../doc/models/create-order-response.md). ## Example Usage @@ -138,7 +138,7 @@ def batch_retrieve_orders(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Retrieve Orders Response Hash`](../../doc/models/batch-retrieve-orders-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Batch Retrieve Orders Response Hash`](../../doc/models/batch-retrieve-orders-response.md). ## Example Usage @@ -178,7 +178,7 @@ def calculate_order(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Calculate Order Response Hash`](../../doc/models/calculate-order-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Calculate Order Response Hash`](../../doc/models/calculate-order-response.md). ## Example Usage @@ -242,7 +242,7 @@ def clone_order(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Clone Order Response Hash`](../../doc/models/clone-order-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Clone Order Response Hash`](../../doc/models/clone-order-response.md). ## Example Usage @@ -296,7 +296,7 @@ def search_orders(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Orders Response Hash`](../../doc/models/search-orders-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Orders Response Hash`](../../doc/models/search-orders-response.md). ## Example Usage @@ -356,7 +356,7 @@ def retrieve_order(order_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Order Response Hash`](../../doc/models/retrieve-order-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Order Response Hash`](../../doc/models/retrieve-order-response.md). ## Example Usage @@ -406,7 +406,7 @@ def update_order(order_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Order Response Hash`](../../doc/models/update-order-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Order Response Hash`](../../doc/models/update-order-response.md). ## Example Usage @@ -460,7 +460,7 @@ def pay_order(order_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Pay Order Response Hash`](../../doc/models/pay-order-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Pay Order Response Hash`](../../doc/models/pay-order-response.md). ## Example Usage diff --git a/doc/api/payments.md b/doc/api/payments.md index 1f3b72fd..d1f69fc6 100644 --- a/doc/api/payments.md +++ b/doc/api/payments.md @@ -56,13 +56,13 @@ def list_payments(begin_time: nil, | `last_4` | `String` | Query, Optional | The last four digits of a payment card. | | `card_brand` | `String` | Query, Optional | The brand of the payment card (for example, VISA). | | `limit` | `Integer` | Query, Optional | The maximum number of results to be returned in a single page.
It is possible to receive fewer results than the specified limit on a given page.

The default value of 100 is also the maximum allowed value. If the provided value is
greater than 100, it is ignored and the default value is used instead.

Default: `100` | -| `is_offline_payment` | `TrueClass \| FalseClass` | Query, Optional | Whether the payment was taken offline or not. | +| `is_offline_payment` | `TrueClass \| FalseClass` | Query, Optional | Whether the payment was taken offline or not.
**Default**: `false` | | `offline_begin_time` | `String` | Query, Optional | Indicates the start of the time range for which to retrieve offline payments, in RFC 3339
format for timestamps. The range is determined using the
`offline_payment_details.client_created_at` field for each Payment. If set, payments without a
value set in `offline_payment_details.client_created_at` will not be returned.

Default: The current time. | | `offline_end_time` | `String` | Query, Optional | Indicates the end of the time range for which to retrieve offline payments, in RFC 3339
format for timestamps. The range is determined using the
`offline_payment_details.client_created_at` field for each Payment. If set, payments without a
value set in `offline_payment_details.client_created_at` will not be returned.

Default: The current time. | ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Payments Response Hash`](../../doc/models/list-payments-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Payments Response Hash`](../../doc/models/list-payments-response.md). ## Example Usage @@ -103,7 +103,7 @@ def create_payment(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Payment Response Hash`](../../doc/models/create-payment-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Payment Response Hash`](../../doc/models/create-payment-response.md). ## Example Usage @@ -163,7 +163,7 @@ def cancel_payment_by_idempotency_key(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Payment by Idempotency Key Response Hash`](../../doc/models/cancel-payment-by-idempotency-key-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Payment by Idempotency Key Response Hash`](../../doc/models/cancel-payment-by-idempotency-key-response.md). ## Example Usage @@ -199,7 +199,7 @@ def get_payment(payment_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Payment Response Hash`](../../doc/models/get-payment-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Payment Response Hash`](../../doc/models/get-payment-response.md). ## Example Usage @@ -236,7 +236,7 @@ def update_payment(payment_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Payment Response Hash`](../../doc/models/update-payment-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Payment Response Hash`](../../doc/models/update-payment-response.md). ## Example Usage @@ -289,7 +289,7 @@ def cancel_payment(payment_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Payment Response Hash`](../../doc/models/cancel-payment-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Payment Response Hash`](../../doc/models/cancel-payment-response.md). ## Example Usage @@ -328,7 +328,7 @@ def complete_payment(payment_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Complete Payment Response Hash`](../../doc/models/complete-payment-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Complete Payment Response Hash`](../../doc/models/complete-payment-response.md). ## Example Usage diff --git a/doc/api/payouts.md b/doc/api/payouts.md index bf6a2a7c..131dde2e 100644 --- a/doc/api/payouts.md +++ b/doc/api/payouts.md @@ -45,7 +45,7 @@ def list_payouts(location_id: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Payouts Response Hash`](../../doc/models/list-payouts-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Payouts Response Hash`](../../doc/models/list-payouts-response.md). ## Example Usage @@ -77,7 +77,7 @@ def get_payout(payout_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Payout Response Hash`](../../doc/models/get-payout-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Payout Response Hash`](../../doc/models/get-payout-response.md). ## Example Usage @@ -118,7 +118,7 @@ def list_payout_entries(payout_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Payout Entries Response Hash`](../../doc/models/list-payout-entries-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Payout Entries Response Hash`](../../doc/models/list-payout-entries-response.md). ## Example Usage diff --git a/doc/api/refunds.md b/doc/api/refunds.md index 8241cae7..d85226b8 100644 --- a/doc/api/refunds.md +++ b/doc/api/refunds.md @@ -50,7 +50,7 @@ def list_payment_refunds(begin_time: nil, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Payment Refunds Response Hash`](../../doc/models/list-payment-refunds-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Payment Refunds Response Hash`](../../doc/models/list-payment-refunds-response.md). ## Example Usage @@ -84,7 +84,7 @@ def refund_payment(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Refund Payment Response Hash`](../../doc/models/refund-payment-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Refund Payment Response Hash`](../../doc/models/refund-payment-response.md). ## Example Usage @@ -130,7 +130,7 @@ def get_payment_refund(refund_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Payment Refund Response Hash`](../../doc/models/get-payment-refund-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Payment Refund Response Hash`](../../doc/models/get-payment-refund-response.md). ## Example Usage diff --git a/doc/api/sites.md b/doc/api/sites.md index 0527c747..19635f74 100644 --- a/doc/api/sites.md +++ b/doc/api/sites.md @@ -21,7 +21,7 @@ def list_sites ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Sites Response Hash`](../../doc/models/list-sites-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Sites Response Hash`](../../doc/models/list-sites-response.md). ## Example Usage diff --git a/doc/api/snippets.md b/doc/api/snippets.md index fbb904e8..283e81dd 100644 --- a/doc/api/snippets.md +++ b/doc/api/snippets.md @@ -35,7 +35,7 @@ def delete_snippet(site_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Snippet Response Hash`](../../doc/models/delete-snippet-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Snippet Response Hash`](../../doc/models/delete-snippet-response.md). ## Example Usage @@ -73,7 +73,7 @@ def retrieve_snippet(site_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Snippet Response Hash`](../../doc/models/retrieve-snippet-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Snippet Response Hash`](../../doc/models/retrieve-snippet-response.md). ## Example Usage @@ -114,7 +114,7 @@ def upsert_snippet(site_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Upsert Snippet Response Hash`](../../doc/models/upsert-snippet-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Upsert Snippet Response Hash`](../../doc/models/upsert-snippet-response.md). ## Example Usage diff --git a/doc/api/subscriptions.md b/doc/api/subscriptions.md index 24cd21f6..bc7c0b96 100644 --- a/doc/api/subscriptions.md +++ b/doc/api/subscriptions.md @@ -47,7 +47,7 @@ def create_subscription(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Subscription Response Hash`](../../doc/models/create-subscription-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Subscription Response Hash`](../../doc/models/create-subscription-response.md). ## Example Usage @@ -99,7 +99,7 @@ def bulk_swap_plan(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Swap Plan Response Hash`](../../doc/models/bulk-swap-plan-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Swap Plan Response Hash`](../../doc/models/bulk-swap-plan-response.md). ## Example Usage @@ -150,7 +150,7 @@ def search_subscriptions(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Subscriptions Response Hash`](../../doc/models/search-subscriptions-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Subscriptions Response Hash`](../../doc/models/search-subscriptions-response.md). ## Example Usage @@ -200,7 +200,7 @@ def retrieve_subscription(subscription_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Subscription Response Hash`](../../doc/models/retrieve-subscription-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Subscription Response Hash`](../../doc/models/retrieve-subscription-response.md). ## Example Usage @@ -237,7 +237,7 @@ def update_subscription(subscription_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Subscription Response Hash`](../../doc/models/update-subscription-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Subscription Response Hash`](../../doc/models/update-subscription-response.md). ## Example Usage @@ -283,7 +283,7 @@ def delete_subscription_action(subscription_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Subscription Action Response Hash`](../../doc/models/delete-subscription-action-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Subscription Action Response Hash`](../../doc/models/delete-subscription-action-response.md). ## Example Usage @@ -325,7 +325,7 @@ def change_billing_anchor_date(subscription_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Change Billing Anchor Date Response Hash`](../../doc/models/change-billing-anchor-date-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Change Billing Anchor Date Response Hash`](../../doc/models/change-billing-anchor-date-response.md). ## Example Usage @@ -368,7 +368,7 @@ def cancel_subscription(subscription_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Subscription Response Hash`](../../doc/models/cancel-subscription-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Subscription Response Hash`](../../doc/models/cancel-subscription-response.md). ## Example Usage @@ -406,7 +406,7 @@ def list_subscription_events(subscription_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Subscription Events Response Hash`](../../doc/models/list-subscription-events-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Subscription Events Response Hash`](../../doc/models/list-subscription-events-response.md). ## Example Usage @@ -442,7 +442,7 @@ def pause_subscription(subscription_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Pause Subscription Response Hash`](../../doc/models/pause-subscription-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Pause Subscription Response Hash`](../../doc/models/pause-subscription-response.md). ## Example Usage @@ -483,7 +483,7 @@ def resume_subscription(subscription_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Resume Subscription Response Hash`](../../doc/models/resume-subscription-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Resume Subscription Response Hash`](../../doc/models/resume-subscription-response.md). ## Example Usage @@ -525,7 +525,7 @@ def swap_plan(subscription_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Swap Plan Response Hash`](../../doc/models/swap-plan-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Swap Plan Response Hash`](../../doc/models/swap-plan-response.md). ## Example Usage diff --git a/doc/api/team.md b/doc/api/team.md index e4dd5c95..7c7f08cd 100644 --- a/doc/api/team.md +++ b/doc/api/team.md @@ -42,7 +42,7 @@ def create_team_member(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Team Member Response Hash`](../../doc/models/create-team-member-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Team Member Response Hash`](../../doc/models/create-team-member-response.md). ## Example Usage @@ -98,7 +98,7 @@ def bulk_create_team_members(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Create Team Members Response Hash`](../../doc/models/bulk-create-team-members-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Create Team Members Response Hash`](../../doc/models/bulk-create-team-members-response.md). ## Example Usage @@ -167,7 +167,7 @@ def bulk_update_team_members(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Update Team Members Response Hash`](../../doc/models/bulk-update-team-members-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Update Team Members Response Hash`](../../doc/models/bulk-update-team-members-response.md). ## Example Usage @@ -240,7 +240,7 @@ def search_team_members(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Team Members Response Hash`](../../doc/models/search-team-members-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Team Members Response Hash`](../../doc/models/search-team-members-response.md). ## Example Usage @@ -285,7 +285,7 @@ def retrieve_team_member(team_member_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Team Member Response Hash`](../../doc/models/retrieve-team-member-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Team Member Response Hash`](../../doc/models/retrieve-team-member-response.md). ## Example Usage @@ -322,7 +322,7 @@ def update_team_member(team_member_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Team Member Response Hash`](../../doc/models/update-team-member-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Team Member Response Hash`](../../doc/models/update-team-member-response.md). ## Example Usage @@ -379,7 +379,7 @@ def retrieve_wage_setting(team_member_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Wage Setting Response Hash`](../../doc/models/retrieve-wage-setting-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Wage Setting Response Hash`](../../doc/models/retrieve-wage-setting-response.md). ## Example Usage @@ -419,7 +419,7 @@ def update_wage_setting(team_member_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Wage Setting Response Hash`](../../doc/models/update-wage-setting-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Wage Setting Response Hash`](../../doc/models/update-wage-setting-response.md). ## Example Usage diff --git a/doc/api/terminal.md b/doc/api/terminal.md index 77e1cc66..fc5a3100 100644 --- a/doc/api/terminal.md +++ b/doc/api/terminal.md @@ -43,7 +43,7 @@ def create_terminal_action(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Terminal Action Response Hash`](../../doc/models/create-terminal-action-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Terminal Action Response Hash`](../../doc/models/create-terminal-action-response.md). ## Example Usage @@ -88,7 +88,7 @@ def search_terminal_actions(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Terminal Actions Response Hash`](../../doc/models/search-terminal-actions-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Terminal Actions Response Hash`](../../doc/models/search-terminal-actions-response.md). ## Example Usage @@ -134,7 +134,7 @@ def get_terminal_action(action_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Terminal Action Response Hash`](../../doc/models/get-terminal-action-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Terminal Action Response Hash`](../../doc/models/get-terminal-action-response.md). ## Example Usage @@ -168,7 +168,7 @@ def cancel_terminal_action(action_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Terminal Action Response Hash`](../../doc/models/cancel-terminal-action-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Terminal Action Response Hash`](../../doc/models/cancel-terminal-action-response.md). ## Example Usage @@ -204,7 +204,7 @@ def dismiss_terminal_action(action_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Dismiss Terminal Action Response Hash`](../../doc/models/dismiss-terminal-action-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Dismiss Terminal Action Response Hash`](../../doc/models/dismiss-terminal-action-response.md). ## Example Usage @@ -239,7 +239,7 @@ def create_terminal_checkout(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Terminal Checkout Response Hash`](../../doc/models/create-terminal-checkout-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Terminal Checkout Response Hash`](../../doc/models/create-terminal-checkout-response.md). ## Example Usage @@ -286,7 +286,7 @@ def search_terminal_checkouts(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Terminal Checkouts Response Hash`](../../doc/models/search-terminal-checkouts-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Terminal Checkouts Response Hash`](../../doc/models/search-terminal-checkouts-response.md). ## Example Usage @@ -327,7 +327,7 @@ def get_terminal_checkout(checkout_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Terminal Checkout Response Hash`](../../doc/models/get-terminal-checkout-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Terminal Checkout Response Hash`](../../doc/models/get-terminal-checkout-response.md). ## Example Usage @@ -361,7 +361,7 @@ def cancel_terminal_checkout(checkout_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Terminal Checkout Response Hash`](../../doc/models/cancel-terminal-checkout-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Terminal Checkout Response Hash`](../../doc/models/cancel-terminal-checkout-response.md). ## Example Usage @@ -395,7 +395,7 @@ def dismiss_terminal_checkout(checkout_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Dismiss Terminal Checkout Response Hash`](../../doc/models/dismiss-terminal-checkout-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Dismiss Terminal Checkout Response Hash`](../../doc/models/dismiss-terminal-checkout-response.md). ## Example Usage @@ -429,7 +429,7 @@ def create_terminal_refund(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Terminal Refund Response Hash`](../../doc/models/create-terminal-refund-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Terminal Refund Response Hash`](../../doc/models/create-terminal-refund-response.md). ## Example Usage @@ -474,7 +474,7 @@ def search_terminal_refunds(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Terminal Refunds Response Hash`](../../doc/models/search-terminal-refunds-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Terminal Refunds Response Hash`](../../doc/models/search-terminal-refunds-response.md). ## Example Usage @@ -515,7 +515,7 @@ def get_terminal_refund(terminal_refund_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Terminal Refund Response Hash`](../../doc/models/get-terminal-refund-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Get Terminal Refund Response Hash`](../../doc/models/get-terminal-refund-response.md). ## Example Usage @@ -549,7 +549,7 @@ def cancel_terminal_refund(terminal_refund_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Terminal Refund Response Hash`](../../doc/models/cancel-terminal-refund-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Cancel Terminal Refund Response Hash`](../../doc/models/cancel-terminal-refund-response.md). ## Example Usage @@ -583,7 +583,7 @@ def dismiss_terminal_refund(terminal_refund_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Dismiss Terminal Refund Response Hash`](../../doc/models/dismiss-terminal-refund-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Dismiss Terminal Refund Response Hash`](../../doc/models/dismiss-terminal-refund-response.md). ## Example Usage diff --git a/doc/api/transactions.md b/doc/api/transactions.md index fdaa33cf..7bd9d6c5 100644 --- a/doc/api/transactions.md +++ b/doc/api/transactions.md @@ -47,7 +47,7 @@ def list_transactions(location_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Transactions Response Hash`](../../doc/models/list-transactions-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Transactions Response Hash`](../../doc/models/list-transactions-response.md). ## Example Usage @@ -85,7 +85,7 @@ def retrieve_transaction(location_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Transaction Response Hash`](../../doc/models/retrieve-transaction-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Transaction Response Hash`](../../doc/models/retrieve-transaction-response.md). ## Example Usage @@ -132,7 +132,7 @@ def capture_transaction(location_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Capture Transaction Response Hash`](../../doc/models/capture-transaction-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Capture Transaction Response Hash`](../../doc/models/capture-transaction-response.md). ## Example Usage @@ -179,7 +179,7 @@ def void_transaction(location_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Void Transaction Response Hash`](../../doc/models/void-transaction-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Void Transaction Response Hash`](../../doc/models/void-transaction-response.md). ## Example Usage diff --git a/doc/api/v1-transactions.md b/doc/api/v1-transactions.md index 2cc7d448..00ef7260 100644 --- a/doc/api/v1-transactions.md +++ b/doc/api/v1-transactions.md @@ -39,7 +39,7 @@ def v1_list_orders(location_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Array`](../../doc/models/v1-order.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Array`](../../doc/models/v1-order.md). ## Example Usage @@ -77,7 +77,7 @@ def v1_retrieve_order(location_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`V1 Order Hash`](../../doc/models/v1-order.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`V1 Order Hash`](../../doc/models/v1-order.md). ## Example Usage @@ -122,7 +122,7 @@ def v1_update_order(location_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`V1 Order Hash`](../../doc/models/v1-order.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`V1 Order Hash`](../../doc/models/v1-order.md). ## Example Usage diff --git a/doc/api/vendors.md b/doc/api/vendors.md index 03200337..29e40818 100644 --- a/doc/api/vendors.md +++ b/doc/api/vendors.md @@ -35,7 +35,7 @@ def bulk_create_vendors(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Create Vendors Response Hash`](../../doc/models/bulk-create-vendors-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Create Vendors Response Hash`](../../doc/models/bulk-create-vendors-response.md). ## Example Usage @@ -74,7 +74,7 @@ def bulk_retrieve_vendors(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Retrieve Vendors Response Hash`](../../doc/models/bulk-retrieve-vendors-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Retrieve Vendors Response Hash`](../../doc/models/bulk-retrieve-vendors-response.md). ## Example Usage @@ -112,7 +112,7 @@ def bulk_update_vendors(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Update Vendors Response Hash`](../../doc/models/bulk-update-vendors-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Bulk Update Vendors Response Hash`](../../doc/models/bulk-update-vendors-response.md). ## Example Usage @@ -155,7 +155,7 @@ def create_vendor(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Vendor Response Hash`](../../doc/models/create-vendor-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Vendor Response Hash`](../../doc/models/create-vendor-response.md). ## Example Usage @@ -191,7 +191,7 @@ def search_vendors(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Vendors Response Hash`](../../doc/models/search-vendors-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Search Vendors Response Hash`](../../doc/models/search-vendors-response.md). ## Example Usage @@ -225,7 +225,7 @@ def retrieve_vendor(vendor_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Vendor Response Hash`](../../doc/models/retrieve-vendor-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Vendor Response Hash`](../../doc/models/retrieve-vendor-response.md). ## Example Usage @@ -261,7 +261,7 @@ def update_vendor(body:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Vendor Response Hash`](../../doc/models/update-vendor-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Vendor Response Hash`](../../doc/models/update-vendor-response.md). ## Example Usage diff --git a/doc/api/webhook-subscriptions.md b/doc/api/webhook-subscriptions.md index 0583009c..86c10705 100644 --- a/doc/api/webhook-subscriptions.md +++ b/doc/api/webhook-subscriptions.md @@ -36,7 +36,7 @@ def list_webhook_event_types(api_version: nil) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Webhook Event Types Response Hash`](../../doc/models/list-webhook-event-types-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Webhook Event Types Response Hash`](../../doc/models/list-webhook-event-types-response.md). ## Example Usage @@ -67,13 +67,13 @@ def list_webhook_subscriptions(cursor: nil, | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `cursor` | `String` | Query, Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this to retrieve the next set of results for your original query.

For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | -| `include_disabled` | `TrueClass \| FalseClass` | Query, Optional | Includes disabled [Subscription](entity:WebhookSubscription)s.
By default, all enabled [Subscription](entity:WebhookSubscription)s are returned. | +| `include_disabled` | `TrueClass \| FalseClass` | Query, Optional | Includes disabled [Subscription](entity:WebhookSubscription)s.
By default, all enabled [Subscription](entity:WebhookSubscription)s are returned.
**Default**: `false` | | `sort_order` | [`String (Sort Order)`](../../doc/models/sort-order.md) | Query, Optional | Sorts the returned list by when the [Subscription](entity:WebhookSubscription) was created with the specified order.
This field defaults to ASC. | | `limit` | `Integer` | Query, Optional | The maximum number of results to be returned in a single page.
It is possible to receive fewer results than the specified limit on a given page.
The default value of 100 is also the maximum allowed value.

Default: 100 | ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Webhook Subscriptions Response Hash`](../../doc/models/list-webhook-subscriptions-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`List Webhook Subscriptions Response Hash`](../../doc/models/list-webhook-subscriptions-response.md). ## Example Usage @@ -107,7 +107,7 @@ def create_webhook_subscription(body:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Webhook Subscription Response Hash`](../../doc/models/create-webhook-subscription-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Create Webhook Subscription Response Hash`](../../doc/models/create-webhook-subscription-response.md). ## Example Usage @@ -152,7 +152,7 @@ def delete_webhook_subscription(subscription_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Webhook Subscription Response Hash`](../../doc/models/delete-webhook-subscription-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Delete Webhook Subscription Response Hash`](../../doc/models/delete-webhook-subscription-response.md). ## Example Usage @@ -186,7 +186,7 @@ def retrieve_webhook_subscription(subscription_id:) ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Webhook Subscription Response Hash`](../../doc/models/retrieve-webhook-subscription-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Retrieve Webhook Subscription Response Hash`](../../doc/models/retrieve-webhook-subscription-response.md). ## Example Usage @@ -222,7 +222,7 @@ def update_webhook_subscription(subscription_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Webhook Subscription Response Hash`](../../doc/models/update-webhook-subscription-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Webhook Subscription Response Hash`](../../doc/models/update-webhook-subscription-response.md). ## Example Usage @@ -268,7 +268,7 @@ def update_webhook_subscription_signature_key(subscription_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Webhook Subscription Signature Key Response Hash`](../../doc/models/update-webhook-subscription-signature-key-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Update Webhook Subscription Signature Key Response Hash`](../../doc/models/update-webhook-subscription-signature-key-response.md). ## Example Usage @@ -311,7 +311,7 @@ def test_webhook_subscription(subscription_id:, ## Response Type -This method returns a `\ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Test Webhook Subscription Response Hash`](../../doc/models/test-webhook-subscription-response.md). +This method returns a `ApiResponse` instance. The `data` property in this instance returns the response data which is of type [`Test Webhook Subscription Response Hash`](../../doc/models/test-webhook-subscription-response.md). ## Example Usage diff --git a/doc/client.md b/doc/client.md index 4f16f4bd..fc9ee52a 100644 --- a/doc/client.md +++ b/doc/client.md @@ -5,7 +5,7 @@ The following parameters are configurable for the API Client: | Parameter | Type | Description | | --- | --- | --- | -| `square_version` | `String` | Square Connect API versions
*Default*: `'2024-08-21'` | +| `square_version` | `String` | Square Connect API versions
*Default*: `'2024-09-19'` | | `custom_url` | `String` | Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
*Default*: `'https://connect.squareup.com'` | | `environment` | `string` | The API environment.
**Default: `production`** | | `connection` | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests | @@ -25,7 +25,7 @@ The API client can be initialized as follows: ```ruby client = Square::Client.new( - square_version: '2024-08-21', + square_version: '2024-09-19', bearer_auth_credentials: BearerAuthCredentials.new( access_token: 'AccessToken' ), @@ -55,9 +55,12 @@ require 'square' include Square client = Square::Client.new( + square_version: '2024-09-19', bearer_auth_credentials: BearerAuthCredentials.new( access_token: 'AccessToken' - ) + ), + environment: 'production', + custom_url: 'https://connect.squareup.com' ) result = client.locations.list_locations diff --git a/doc/models/booking.md b/doc/models/booking.md index 0bb5866a..c8b56115 100644 --- a/doc/models/booking.md +++ b/doc/models/booking.md @@ -28,6 +28,7 @@ at a given location to a requesting customer in one or more appointment segments | `location_type` | [`String (Business Appointment Settings Booking Location Type)`](../../doc/models/business-appointment-settings-booking-location-type.md) | Optional | Supported types of location where service is provided. | | `creator_details` | [`Booking Creator Details Hash`](../../doc/models/booking-creator-details.md) | Optional | Information about a booking creator. | | `source` | [`String (Booking Booking Source)`](../../doc/models/booking-booking-source.md) | Optional | Supported sources a booking was created from. | +| `address` | [`Address Hash`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | ## Example (as JSON) diff --git a/doc/models/customer.md b/doc/models/customer.md index a5725e42..79624513 100644 --- a/doc/models/customer.md +++ b/doc/models/customer.md @@ -14,7 +14,7 @@ Represents a Square customer profile in the Customer Directory of a Square selle | `id` | `String` | Optional | A unique Square-assigned ID for the customer profile.

If you need this ID for an API request, use the ID returned when you created the customer profile or call the [SearchCustomers](api-endpoint:Customers-SearchCustomers)
or [ListCustomers](api-endpoint:Customers-ListCustomers) endpoint. | | `created_at` | `String` | Optional | The timestamp when the customer profile was created, in RFC 3339 format. | | `updated_at` | `String` | Optional | The timestamp when the customer profile was last updated, in RFC 3339 format. | -| `cards` | [`Array`](../../doc/models/card.md) | Optional | Payment details of the credit, debit, and gift cards stored on file for the customer profile.

DEPRECATED at version 2021-06-16. Replaced by calling [ListCards](api-endpoint:Cards-ListCards) (for credit and debit cards on file)
or [ListGiftCards](api-endpoint:GiftCards-ListGiftCards) (for gift cards on file) and including the `customer_id` query parameter.
For more information, see [Migration notes](https://developer.squareup.com/docs/customers-api/what-it-does#migrate-customer-cards). | +| `cards` | [`Array`](../../doc/models/card.md) | Optional | Payment details of the credit, debit, and gift cards stored on file for the customer profile.

DEPRECATED at version 2021-06-16 and will be RETIRED at version 2024-12-18. Replaced by calling [ListCards](api-endpoint:Cards-ListCards) (for credit and debit cards on file)
or [ListGiftCards](api-endpoint:GiftCards-ListGiftCards) (for gift cards on file) and including the `customer_id` query parameter.
For more information, see [Migration notes](https://developer.squareup.com/docs/customers-api/what-it-does#migrate-customer-cards). | | `given_name` | `String` | Optional | The given name (that is, the first name) associated with the customer profile. | | `family_name` | `String` | Optional | The family name (that is, the last name) associated with the customer profile. | | `nickname` | `String` | Optional | A nickname for the customer profile. | diff --git a/doc/models/payment.md b/doc/models/payment.md index ea639ca5..08b5d071 100644 --- a/doc/models/payment.md +++ b/doc/models/payment.md @@ -41,6 +41,7 @@ Represents a payment processed by the Square API. | `team_member_id` | `String` | Optional | An optional ID of the [TeamMember](entity:TeamMember) associated with taking the payment.
**Constraints**: *Maximum Length*: `192` | | `refund_ids` | `Array` | Optional | A list of `refund_id`s identifying refunds for the payment. | | `risk_evaluation` | [`Risk Evaluation Hash`](../../doc/models/risk-evaluation.md) | Optional | 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). | +| `terminal_checkout_id` | `String` | Optional | An optional ID for a Terminal checkout that is associated with the payment. | | `buyer_email_address` | `String` | Optional | The buyer's email address.
**Constraints**: *Maximum Length*: `255` | | `billing_address` | [`Address Hash`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | | `shipping_address` | [`Address Hash`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | diff --git a/doc/models/update-booking-response.md b/doc/models/update-booking-response.md index 1e240fd7..2be7df26 100644 --- a/doc/models/update-booking-response.md +++ b/doc/models/update-booking-response.md @@ -17,6 +17,13 @@ ```json { "booking": { + "address": { + "address_line_1": "1955 Broadway", + "address_line_2": "Suite 600", + "administrative_district_level_1": "CA", + "locality": "Oakland", + "postal_code": "94612" + }, "appointment_segments": [ { "duration_minutes": 60, @@ -30,6 +37,7 @@ "customer_note": "I would like to sit near the window please", "id": "zkras0xv0xwswx", "location_id": "LEQHH0YY8B42M", + "location_type": "CUSTOMER_LOCATION", "seller_note": "", "start_at": "2020-11-26T13:00:00Z", "status": "ACCEPTED", diff --git a/lib/square/api/apple_pay_api.rb b/lib/square/api/apple_pay_api.rb index f7b7b82f..a7322bb6 100644 --- a/lib/square/api/apple_pay_api.rb +++ b/lib/square/api/apple_pay_api.rb @@ -26,7 +26,7 @@ class ApplePayApi < BaseApi # @param [RegisterDomainRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [RegisterDomainResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def register_domain(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, diff --git a/lib/square/api/bank_accounts_api.rb b/lib/square/api/bank_accounts_api.rb index 1f14a1c4..46277918 100644 --- a/lib/square/api/bank_accounts_api.rb +++ b/lib/square/api/bank_accounts_api.rb @@ -15,7 +15,7 @@ class BankAccountsApi < BaseApi # @param [String] location_id Optional parameter: Location ID. You can # specify this optional filter to retrieve only the linked bank accounts # belonging to a specific location. - # @return [ListBankAccountsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_bank_accounts(cursor: nil, limit: nil, location_id: nil) @@ -42,7 +42,7 @@ def list_bank_accounts(cursor: nil, # 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). - # @return [GetBankAccountByV1IdResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def get_bank_account_by_v1_id(v1_bank_account_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -63,7 +63,7 @@ def get_bank_account_by_v1_id(v1_bank_account_id:) # linked to a Square account. # @param [String] bank_account_id Required parameter: Square-issued ID of # the desired `BankAccount`. - # @return [GetBankAccountResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def get_bank_account(bank_account_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, diff --git a/lib/square/api/base_api.rb b/lib/square/api/base_api.rb index e722a3a8..31d7f303 100644 --- a/lib/square/api/base_api.rb +++ b/lib/square/api/base_api.rb @@ -5,7 +5,7 @@ class BaseApi attr_accessor :config, :http_call_back def self.user_agent - 'Square-Ruby-SDK/39.0.0.20240821 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}' + 'Square-Ruby-SDK/39.1.0.20240919 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}' end def self.user_agent_parameters diff --git a/lib/square/api/booking_custom_attributes_api.rb b/lib/square/api/booking_custom_attributes_api.rb index dca32035..123f8d40 100644 --- a/lib/square/api/booking_custom_attributes_api.rb +++ b/lib/square/api/booking_custom_attributes_api.rb @@ -18,7 +18,7 @@ class BookingCustomAttributesApi < BaseApi # more information, see # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p # atterns/pagination). - # @return [ListBookingCustomAttributeDefinitionsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_booking_custom_attribute_definitions(limit: nil, cursor: nil) new_api_call_builder @@ -47,7 +47,7 @@ def list_booking_custom_attribute_definitions(limit: nil, # @param [CreateBookingCustomAttributeDefinitionRequest] body Required # parameter: An object containing the fields to POST for the request. See # the corresponding object definition for field details. - # @return [CreateBookingCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_booking_custom_attribute_definition(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -75,7 +75,7 @@ def create_booking_custom_attribute_definition(body:) # or *Appointments Premium*. # @param [String] key Required parameter: The key of the custom attribute # definition to delete. - # @return [DeleteBookingCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_booking_custom_attribute_definition(key:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::DELETE, @@ -106,7 +106,7 @@ def delete_booking_custom_attribute_definition(key:) # 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. - # @return [RetrieveBookingCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_booking_custom_attribute_definition(key:, version: nil) new_api_call_builder @@ -138,7 +138,7 @@ def retrieve_booking_custom_attribute_definition(key:, # @param [UpdateBookingCustomAttributeDefinitionRequest] body Required # parameter: An object containing the fields to POST for the request. See # the corresponding object definition for field details. - # @return [UpdateBookingCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_booking_custom_attribute_definition(key:, body:) new_api_call_builder @@ -170,7 +170,7 @@ def update_booking_custom_attribute_definition(key:, # @param [BulkDeleteBookingCustomAttributesRequest] body Required parameter: # An object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [BulkDeleteBookingCustomAttributesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_delete_booking_custom_attributes(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -199,7 +199,7 @@ def bulk_delete_booking_custom_attributes(body:) # @param [BulkUpsertBookingCustomAttributesRequest] body Required parameter: # An object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [BulkUpsertBookingCustomAttributesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_upsert_booking_custom_attributes(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -242,7 +242,7 @@ def bulk_upsert_booking_custom_attributes(body:) # 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`. - # @return [ListBookingCustomAttributesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_booking_custom_attributes(booking_id:, limit: nil, cursor: nil, @@ -279,7 +279,7 @@ def list_booking_custom_attributes(booking_id:, # 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. - # @return [DeleteBookingCustomAttributeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_booking_custom_attribute(booking_id:, key:) new_api_call_builder @@ -322,7 +322,7 @@ def delete_booking_custom_attribute(booking_id:, # 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. - # @return [RetrieveBookingCustomAttributeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_booking_custom_attribute(booking_id:, key:, with_definition: false, @@ -363,7 +363,7 @@ def retrieve_booking_custom_attribute(booking_id:, # @param [UpsertBookingCustomAttributeRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [UpsertBookingCustomAttributeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def upsert_booking_custom_attribute(booking_id:, key:, body:) diff --git a/lib/square/api/bookings_api.rb b/lib/square/api/bookings_api.rb index b4e2bbed..4cfa560b 100644 --- a/lib/square/api/bookings_api.rb +++ b/lib/square/api/bookings_api.rb @@ -26,7 +26,7 @@ class BookingsApi < BaseApi # @param [String] start_at_max Optional parameter: 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. - # @return [ListBookingsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_bookings(limit: nil, cursor: nil, customer_id: nil, @@ -71,7 +71,7 @@ def list_bookings(limit: nil, # @param [CreateBookingRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateBookingResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_booking(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -97,7 +97,7 @@ def create_booking(body:) # @param [SearchAvailabilityRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [SearchAvailabilityResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def search_availability(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -123,7 +123,7 @@ def search_availability(body:) # @param [BulkRetrieveBookingsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [BulkRetrieveBookingsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_retrieve_bookings(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -142,7 +142,7 @@ def bulk_retrieve_bookings(body:) end # Retrieves a seller's booking profile. - # @return [RetrieveBusinessBookingProfileResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_business_booking_profile new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -163,7 +163,7 @@ def retrieve_business_booking_profile # @param [String] cursor Optional parameter: 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. - # @return [ListLocationBookingProfilesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_location_booking_profiles(limit: nil, cursor: nil) new_api_call_builder @@ -184,7 +184,7 @@ def list_location_booking_profiles(limit: nil, # Retrieves a seller's location booking profile. # @param [String] location_id Required parameter: The ID of the location to # retrieve the booking profile. - # @return [RetrieveLocationBookingProfileResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_location_booking_profile(location_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -213,7 +213,7 @@ def retrieve_location_booking_profile(location_id:) # @param [String] location_id Optional parameter: Indicates whether to # include only team members enabled at the given location in the returned # result. - # @return [ListTeamMemberBookingProfilesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_team_member_booking_profiles(bookable_only: false, limit: nil, cursor: nil, @@ -239,7 +239,7 @@ def list_team_member_booking_profiles(bookable_only: false, # @param [BulkRetrieveTeamMemberBookingProfilesRequest] body Required # parameter: An object containing the fields to POST for the request. See # the corresponding object definition for field details. - # @return [BulkRetrieveTeamMemberBookingProfilesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_retrieve_team_member_booking_profiles(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -260,7 +260,7 @@ def bulk_retrieve_team_member_booking_profiles(body:) # Retrieves a team member's booking profile. # @param [String] team_member_id Required parameter: The ID of the team # member to retrieve. - # @return [RetrieveTeamMemberBookingProfileResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_team_member_booking_profile(team_member_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -285,7 +285,7 @@ def retrieve_team_member_booking_profile(team_member_id:) # @param [String] booking_id Required parameter: The ID of the # [Booking](entity:Booking) object representing the to-be-retrieved # booking. - # @return [RetrieveBookingResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_booking(booking_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -315,7 +315,7 @@ def retrieve_booking(booking_id:) # @param [UpdateBookingRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpdateBookingResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_booking(booking_id:, body:) new_api_call_builder @@ -350,7 +350,7 @@ def update_booking(booking_id:, # @param [CancelBookingRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CancelBookingResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def cancel_booking(booking_id:, body:) new_api_call_builder diff --git a/lib/square/api/cards_api.rb b/lib/square/api/cards_api.rb index 5d576dde..2a9bc339 100644 --- a/lib/square/api/cards_api.rb +++ b/lib/square/api/cards_api.rb @@ -19,7 +19,7 @@ class CardsApi < BaseApi # @param [SortOrder] sort_order Optional parameter: Sorts the returned list # by when the card was created with the specified order. This field defaults # to ASC. - # @return [ListCardsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_cards(cursor: nil, customer_id: nil, include_disabled: false, @@ -47,7 +47,7 @@ def list_cards(cursor: nil, # @param [CreateCardRequest] body Required parameter: An object containing # the fields to POST for the request. See the corresponding object # definition for field details. - # @return [CreateCardResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_card(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -68,7 +68,7 @@ def create_card(body:) # Retrieves details for a specific Card. # @param [String] card_id Required parameter: Unique ID for the desired # Card. - # @return [RetrieveCardResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_card(card_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -89,7 +89,7 @@ def retrieve_card(card_id:) # Disabling an already disabled card is allowed but has no effect. # @param [String] card_id Required parameter: Unique ID for the desired # Card. - # @return [DisableCardResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def disable_card(card_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, diff --git a/lib/square/api/cash_drawers_api.rb b/lib/square/api/cash_drawers_api.rb index bf1b337b..3962360c 100644 --- a/lib/square/api/cash_drawers_api.rb +++ b/lib/square/api/cash_drawers_api.rb @@ -16,7 +16,7 @@ class CashDrawersApi < BaseApi # events in a page of results (200 by default, 1000 max). # @param [String] cursor Optional parameter: Opaque cursor for fetching the # next page of results. - # @return [ListCashDrawerShiftsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_cash_drawer_shifts(location_id:, sort_order: nil, begin_time: nil, @@ -48,7 +48,7 @@ def list_cash_drawer_shifts(location_id:, # @param [String] location_id Required parameter: The ID of the location to # retrieve cash drawer shifts from. # @param [String] shift_id Required parameter: The shift ID. - # @return [RetrieveCashDrawerShiftResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_cash_drawer_shift(location_id:, shift_id:) new_api_call_builder @@ -75,7 +75,7 @@ def retrieve_cash_drawer_shift(location_id:, # returned in a page of results (200 by default, 1000 max). # @param [String] cursor Optional parameter: Opaque cursor for fetching the # next page of results. - # @return [ListCashDrawerShiftEventsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_cash_drawer_shift_events(location_id:, shift_id:, limit: nil, diff --git a/lib/square/api/catalog_api.rb b/lib/square/api/catalog_api.rb index 4683b711..7714528b 100644 --- a/lib/square/api/catalog_api.rb +++ b/lib/square/api/catalog_api.rb @@ -20,7 +20,7 @@ class CatalogApi < BaseApi # @param [BatchDeleteCatalogObjectsRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [BatchDeleteCatalogObjectsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def batch_delete_catalog_objects(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -47,7 +47,7 @@ def batch_delete_catalog_objects(body:) # @param [BatchRetrieveCatalogObjectsRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [BatchRetrieveCatalogObjectsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def batch_retrieve_catalog_objects(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -87,7 +87,7 @@ def batch_retrieve_catalog_objects(body:) # @param [BatchUpsertCatalogObjectsRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [BatchUpsertCatalogObjectsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def batch_upsert_catalog_objects(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -115,7 +115,7 @@ def batch_upsert_catalog_objects(body:) # JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB. # @param [CreateCatalogImageRequest] request Optional parameter: Example: # @param [File | UploadIO] image_file Optional parameter: Example: - # @return [CreateCatalogImageResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_catalog_image(request: nil, image_file: nil) new_api_call_builder @@ -144,7 +144,7 @@ def create_catalog_image(request: nil, # object to update the encapsulated image file. # @param [UpdateCatalogImageRequest] request Optional parameter: Example: # @param [File | UploadIO] image_file Optional parameter: Example: - # @return [UpdateCatalogImageResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_catalog_image(image_id:, request: nil, image_file: nil) @@ -169,7 +169,7 @@ def update_catalog_image(image_id:, # Retrieves information about the Square Catalog API, such as batch size # limits that can be used by the `BatchUpsertCatalogObjects` endpoint. - # @return [CatalogInfoResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def catalog_info new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -218,7 +218,7 @@ def catalog_info # matched against the [CatalogObject]($m/CatalogObject)s' `version` # attribute. If not included, results will be from the current version of # the catalog. - # @return [ListCatalogResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_catalog(cursor: nil, types: nil, catalog_version: nil) @@ -247,7 +247,7 @@ def list_catalog(cursor: nil, # @param [UpsertCatalogObjectRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpsertCatalogObjectResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def upsert_catalog_object(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -282,7 +282,7 @@ def upsert_catalog_object(body:) # 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). - # @return [DeleteCatalogObjectResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_catalog_object(object_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::DELETE, @@ -336,7 +336,7 @@ def delete_catalog_object(object_id:) # root category. If the returned category is a top-level category, the # `path_to_root` list is empty and is not returned in the response # payload. - # @return [RetrieveCatalogObjectResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_catalog_object(object_id:, include_related_objects: false, catalog_version: nil, @@ -379,7 +379,7 @@ def retrieve_catalog_object(object_id:, # @param [SearchCatalogObjectsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [SearchCatalogObjectsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def search_catalog_objects(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -417,7 +417,7 @@ def search_catalog_objects(body:) # @param [SearchCatalogItemsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [SearchCatalogItemsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def search_catalog_items(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -441,7 +441,7 @@ def search_catalog_items(body:) # @param [UpdateItemModifierListsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpdateItemModifierListsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_item_modifier_lists(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -465,7 +465,7 @@ def update_item_modifier_lists(body:) # @param [UpdateItemTaxesRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpdateItemTaxesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_item_taxes(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, diff --git a/lib/square/api/checkout_api.rb b/lib/square/api/checkout_api.rb index 879e0065..c259df0f 100644 --- a/lib/square/api/checkout_api.rb +++ b/lib/square/api/checkout_api.rb @@ -13,7 +13,7 @@ class CheckoutApi < BaseApi # @param [CreateCheckoutRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateCheckoutResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_checkout(location_id:, body:) warn 'Endpoint create_checkout in CheckoutApi is deprecated' @@ -38,7 +38,7 @@ def create_checkout(location_id:, # Retrieves the location-level settings for a Square-hosted checkout page. # @param [String] location_id Required parameter: The ID of the location for # which to retrieve settings. - # @return [RetrieveLocationSettingsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_location_settings(location_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -61,7 +61,7 @@ def retrieve_location_settings(location_id:) # @param [UpdateLocationSettingsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpdateLocationSettingsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_location_settings(location_id:, body:) new_api_call_builder @@ -83,7 +83,7 @@ def update_location_settings(location_id:, end # Retrieves the merchant-level settings for a Square-hosted checkout page. - # @return [RetrieveMerchantSettingsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_merchant_settings new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -102,7 +102,7 @@ def retrieve_merchant_settings # @param [UpdateMerchantSettingsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpdateMerchantSettingsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_merchant_settings(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::PUT, @@ -132,7 +132,7 @@ def update_merchant_settings(body:) # 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` - # @return [ListPaymentLinksResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_payment_links(cursor: nil, limit: nil) new_api_call_builder @@ -155,7 +155,7 @@ def list_payment_links(cursor: nil, # @param [CreatePaymentLinkRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreatePaymentLinkResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_payment_link(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -176,7 +176,7 @@ def create_payment_link(body:) # Deletes a payment link. # @param [String] id Required parameter: The ID of the payment link to # delete. - # @return [DeletePaymentLinkResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_payment_link(id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::DELETE, @@ -195,7 +195,7 @@ def delete_payment_link(id:) # Retrieves a payment link. # @param [String] id Required parameter: The ID of link to retrieve. - # @return [RetrievePaymentLinkResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_payment_link(id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -221,7 +221,7 @@ def retrieve_payment_link(id:) # @param [UpdatePaymentLinkRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpdatePaymentLinkResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_payment_link(id:, body:) new_api_call_builder diff --git a/lib/square/api/customer_custom_attributes_api.rb b/lib/square/api/customer_custom_attributes_api.rb index 95232614..9a7ad0fe 100644 --- a/lib/square/api/customer_custom_attributes_api.rb +++ b/lib/square/api/customer_custom_attributes_api.rb @@ -24,7 +24,7 @@ class CustomerCustomAttributesApi < BaseApi # more information, see # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p # atterns/pagination). - # @return [ListCustomerCustomAttributeDefinitionsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_customer_custom_attribute_definitions(limit: nil, cursor: nil) new_api_call_builder @@ -61,7 +61,7 @@ def list_customer_custom_attribute_definitions(limit: nil, # @param [CreateCustomerCustomAttributeDefinitionRequest] body Required # parameter: An object containing the fields to POST for the request. See # the corresponding object definition for field details. - # @return [CreateCustomerCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_customer_custom_attribute_definition(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -87,7 +87,7 @@ def create_customer_custom_attribute_definition(body:) # Only the definition owner can delete a custom attribute definition. # @param [String] key Required parameter: The key of the custom attribute # definition to delete. - # @return [DeleteCustomerCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_customer_custom_attribute_definition(key:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::DELETE, @@ -121,7 +121,7 @@ def delete_customer_custom_attribute_definition(key:) # 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. - # @return [RetrieveCustomerCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_customer_custom_attribute_definition(key:, version: nil) new_api_call_builder @@ -154,7 +154,7 @@ def retrieve_customer_custom_attribute_definition(key:, # @param [UpdateCustomerCustomAttributeDefinitionRequest] body Required # parameter: An object containing the fields to POST for the request. See # the corresponding object definition for field details. - # @return [UpdateCustomerCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_customer_custom_attribute_definition(key:, body:) new_api_call_builder @@ -200,7 +200,7 @@ def update_customer_custom_attribute_definition(key:, # @param [BulkUpsertCustomerCustomAttributesRequest] body Required # parameter: An object containing the fields to POST for the request. See # the corresponding object definition for field details. - # @return [BulkUpsertCustomerCustomAttributesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_upsert_customer_custom_attributes(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -248,7 +248,7 @@ def bulk_upsert_customer_custom_attributes(body:) # 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`. - # @return [ListCustomerCustomAttributesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_customer_custom_attributes(customer_id:, limit: nil, cursor: nil, @@ -284,7 +284,7 @@ def list_customer_custom_attributes(customer_id:, # 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. - # @return [DeleteCustomerCustomAttributeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_customer_custom_attribute(customer_id:, key:) new_api_call_builder @@ -333,7 +333,7 @@ def delete_customer_custom_attribute(customer_id:, # 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. - # @return [RetrieveCustomerCustomAttributeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_customer_custom_attribute(customer_id:, key:, with_definition: false, @@ -381,7 +381,7 @@ def retrieve_customer_custom_attribute(customer_id:, # @param [UpsertCustomerCustomAttributeRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [UpsertCustomerCustomAttributeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def upsert_customer_custom_attribute(customer_id:, key:, body:) diff --git a/lib/square/api/customer_groups_api.rb b/lib/square/api/customer_groups_api.rb index b7524458..109e1cd6 100644 --- a/lib/square/api/customer_groups_api.rb +++ b/lib/square/api/customer_groups_api.rb @@ -14,7 +14,7 @@ class CustomerGroupsApi < BaseApi # The default value is 50. For more information, see # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p # atterns/pagination). - # @return [ListCustomerGroupsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_customer_groups(cursor: nil, limit: nil) new_api_call_builder @@ -37,7 +37,7 @@ def list_customer_groups(cursor: nil, # @param [CreateCustomerGroupRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateCustomerGroupResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_customer_group(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -58,7 +58,7 @@ def create_customer_group(body:) # Deletes a customer group as identified by the `group_id` value. # @param [String] group_id Required parameter: The ID of the customer group # to delete. - # @return [DeleteCustomerGroupResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_customer_group(group_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::DELETE, @@ -78,7 +78,7 @@ def delete_customer_group(group_id:) # Retrieves a specific customer group as identified by the `group_id` value. # @param [String] group_id Required parameter: The ID of the customer group # to retrieve. - # @return [RetrieveCustomerGroupResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_customer_group(group_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -101,7 +101,7 @@ def retrieve_customer_group(group_id:) # @param [UpdateCustomerGroupRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpdateCustomerGroupResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_customer_group(group_id:, body:) new_api_call_builder diff --git a/lib/square/api/customer_segments_api.rb b/lib/square/api/customer_segments_api.rb index 86654769..a00b9937 100644 --- a/lib/square/api/customer_segments_api.rb +++ b/lib/square/api/customer_segments_api.rb @@ -14,7 +14,7 @@ class CustomerSegmentsApi < BaseApi # VALUE_TOO_HIGH` error. The default value is 50. For more information, see # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p # atterns/pagination). - # @return [ListCustomerSegmentsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_customer_segments(cursor: nil, limit: nil) new_api_call_builder @@ -36,7 +36,7 @@ def list_customer_segments(cursor: nil, # value. # @param [String] segment_id Required parameter: The Square-issued ID of the # customer segment. - # @return [RetrieveCustomerSegmentResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_customer_segment(segment_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, diff --git a/lib/square/api/customers_api.rb b/lib/square/api/customers_api.rb index 5aecdc4d..5f77aca2 100644 --- a/lib/square/api/customers_api.rb +++ b/lib/square/api/customers_api.rb @@ -29,7 +29,7 @@ class CustomersApi < BaseApi # @param [TrueClass | FalseClass] count Optional parameter: Indicates # whether to return the total count of customers in the `count` field of the # response. The default value is `false`. - # @return [ListCustomersResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_customers(cursor: nil, limit: nil, sort_field: nil, @@ -65,7 +65,7 @@ def list_customers(cursor: nil, # @param [CreateCustomerRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateCustomerResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_customer(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -96,7 +96,7 @@ def create_customer(body:) # @param [BulkCreateCustomersRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [BulkCreateCustomersResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_create_customers(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -119,7 +119,7 @@ def bulk_create_customers(body:) # @param [BulkDeleteCustomersRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [BulkDeleteCustomersResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_delete_customers(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -142,7 +142,7 @@ def bulk_delete_customers(body:) # @param [BulkRetrieveCustomersRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [BulkRetrieveCustomersResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_retrieve_customers(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -168,7 +168,7 @@ def bulk_retrieve_customers(body:) # @param [BulkUpdateCustomersRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [BulkUpdateCustomersResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_update_customers(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -200,7 +200,7 @@ def bulk_update_customers(body:) # @param [SearchCustomersRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [SearchCustomersResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def search_customers(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -232,7 +232,7 @@ def search_customers(body:) # [Delete a customer # profile](https://developer.squareup.com/docs/customers-api/use-the-api/kee # p-records#delete-customer-profile). - # @return [DeleteCustomerResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_customer(customer_id:, version: nil) new_api_call_builder @@ -254,7 +254,7 @@ def delete_customer(customer_id:, # Returns details for a single customer. # @param [String] customer_id Required parameter: The ID of the customer to # retrieve. - # @return [RetrieveCustomerResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_customer(customer_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -284,7 +284,7 @@ def retrieve_customer(customer_id:) # @param [UpdateCustomerRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpdateCustomerResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_customer(customer_id:, body:) new_api_call_builder @@ -315,7 +315,7 @@ def update_customer(customer_id:, # @param [CreateCustomerCardRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateCustomerCardResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_customer_card(customer_id:, body:) warn 'Endpoint create_customer_card in CustomersApi is deprecated' @@ -342,7 +342,7 @@ def create_customer_card(customer_id:, # that the card on file belongs to. # @param [String] card_id Required parameter: The ID of the card on file to # delete. - # @return [DeleteCustomerCardResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_customer_card(customer_id:, card_id:) warn 'Endpoint delete_customer_card in CustomersApi is deprecated' @@ -370,7 +370,7 @@ def delete_customer_card(customer_id:, # remove from the group. # @param [String] group_id Required parameter: The ID of the customer group # to remove the customer from. - # @return [RemoveGroupFromCustomerResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def remove_group_from_customer(customer_id:, group_id:) new_api_call_builder @@ -397,7 +397,7 @@ def remove_group_from_customer(customer_id:, # add to a group. # @param [String] group_id Required parameter: The ID of the customer group # to add the customer to. - # @return [AddGroupToCustomerResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def add_group_to_customer(customer_id:, group_id:) new_api_call_builder diff --git a/lib/square/api/devices_api.rb b/lib/square/api/devices_api.rb index 8e720501..508301ec 100644 --- a/lib/square/api/devices_api.rb +++ b/lib/square/api/devices_api.rb @@ -15,7 +15,7 @@ class DevicesApi < BaseApi # in a single page. # @param [String] location_id Optional parameter: If present, only returns # devices at the target location. - # @return [ListDevicesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_devices(cursor: nil, sort_order: nil, limit: nil, @@ -52,7 +52,7 @@ def list_devices(cursor: nil, # @param [DeviceCodeStatus] status Optional parameter: If specified, returns # DeviceCodes with the specified statuses. Returns DeviceCodes of status # `PAIRED` and `UNPAIRED` if empty. - # @return [ListDeviceCodesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_device_codes(cursor: nil, location_id: nil, product_type: nil, @@ -80,7 +80,7 @@ def list_device_codes(cursor: nil, # @param [CreateDeviceCodeRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateDeviceCodeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_device_code(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -101,7 +101,7 @@ def create_device_code(body:) # Retrieves DeviceCode with the associated ID. # @param [String] id Required parameter: The unique identifier for the # device code. - # @return [GetDeviceCodeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def get_device_code(id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -121,7 +121,7 @@ def get_device_code(id:) # Retrieves Device with the associated `device_id`. # @param [String] device_id Required parameter: The unique ID for the # desired `Device`. - # @return [GetDeviceResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def get_device(device_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, diff --git a/lib/square/api/disputes_api.rb b/lib/square/api/disputes_api.rb index 5566f2dc..edede405 100644 --- a/lib/square/api/disputes_api.rb +++ b/lib/square/api/disputes_api.rb @@ -13,7 +13,7 @@ class DisputesApi < BaseApi # @param [String] location_id Optional parameter: The ID of the location for # which to return a list of disputes. If not specified, the endpoint returns # disputes associated with all locations. - # @return [ListDisputesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_disputes(cursor: nil, states: nil, location_id: nil) @@ -36,7 +36,7 @@ def list_disputes(cursor: nil, # Returns details about a specific dispute. # @param [String] dispute_id Required parameter: The ID of the dispute you # want more details about. - # @return [RetrieveDisputeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_dispute(dispute_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -61,7 +61,7 @@ def retrieve_dispute(dispute_id:) # does not have sufficient funds, Square debits the associated bank account. # @param [String] dispute_id Required parameter: The ID of the dispute you # want to accept. - # @return [AcceptDisputeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def accept_dispute(dispute_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -85,7 +85,7 @@ def accept_dispute(dispute_id:) # set of results for the original query. For more information, see # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p # atterns/pagination). - # @return [ListDisputeEvidenceResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_dispute_evidence(dispute_id:, cursor: nil) new_api_call_builder @@ -113,7 +113,7 @@ def list_dispute_evidence(dispute_id:, # @param [CreateDisputeEvidenceFileRequest] request Optional parameter: # Defines the parameters for a `CreateDisputeEvidenceFile` request. # @param [File | UploadIO] image_file Optional parameter: Example: - # @return [CreateDisputeEvidenceFileResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_dispute_evidence_file(dispute_id:, request: nil, image_file: nil) @@ -142,7 +142,7 @@ def create_dispute_evidence_file(dispute_id:, # @param [CreateDisputeEvidenceTextRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [CreateDisputeEvidenceTextResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_dispute_evidence_text(dispute_id:, body:) new_api_call_builder @@ -169,7 +169,7 @@ def create_dispute_evidence_text(dispute_id:, # which you want to remove evidence. # @param [String] evidence_id Required parameter: The ID of the evidence you # want to remove. - # @return [DeleteDisputeEvidenceResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_dispute_evidence(dispute_id:, evidence_id:) new_api_call_builder @@ -196,7 +196,7 @@ def delete_dispute_evidence(dispute_id:, # which you want to retrieve evidence metadata. # @param [String] evidence_id Required parameter: The ID of the evidence to # retrieve. - # @return [RetrieveDisputeEvidenceResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_dispute_evidence(dispute_id:, evidence_id:) new_api_call_builder @@ -227,7 +227,7 @@ def retrieve_dispute_evidence(dispute_id:, # a dispute after submission. # @param [String] dispute_id Required parameter: The ID of the dispute for # which you want to submit evidence. - # @return [SubmitEvidenceResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def submit_evidence(dispute_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, diff --git a/lib/square/api/employees_api.rb b/lib/square/api/employees_api.rb index 4d9a77ea..be18b277 100644 --- a/lib/square/api/employees_api.rb +++ b/lib/square/api/employees_api.rb @@ -9,7 +9,7 @@ class EmployeesApi < BaseApi # returned on each page. # @param [String] cursor Optional parameter: The token required to retrieve # the specified page of results. - # @return [ListEmployeesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_employees(location_id: nil, status: nil, limit: nil, @@ -35,7 +35,7 @@ def list_employees(location_id: nil, # TODO: type endpoint description here # @param [String] id Required parameter: UUID for the employee that was # requested. - # @return [RetrieveEmployeeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_employee(id:) warn 'Endpoint retrieve_employee in EmployeesApi is deprecated' new_api_call_builder diff --git a/lib/square/api/events_api.rb b/lib/square/api/events_api.rb index 1ae7fd7e..84c75a5c 100644 --- a/lib/square/api/events_api.rb +++ b/lib/square/api/events_api.rb @@ -5,7 +5,7 @@ class EventsApi < BaseApi # @param [SearchEventsRequest] body Required parameter: An object containing # the fields to POST for the request. See the corresponding object # definition for field details. - # @return [SearchEventsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def search_events(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -28,7 +28,7 @@ def search_events(body:) # searchable. # Disabling events for a specific time period prevents them from being # searchable, even if you re-enable them later. - # @return [DisableEventsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def disable_events new_api_call_builder .request(new_request_builder(HttpMethodEnum::PUT, @@ -45,7 +45,7 @@ def disable_events # Enables events to make them searchable. Only events that occur while in # the enabled state are searchable. - # @return [EnableEventsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def enable_events new_api_call_builder .request(new_request_builder(HttpMethodEnum::PUT, @@ -65,7 +65,7 @@ def enable_events # @param [String] api_version Optional parameter: The API version for which # to list event types. Setting this field overrides the default version used # by the application. - # @return [ListEventTypesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_event_types(api_version: nil) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, diff --git a/lib/square/api/gift_card_activities_api.rb b/lib/square/api/gift_card_activities_api.rb index 8cb124de..b1cddd7d 100644 --- a/lib/square/api/gift_card_activities_api.rb +++ b/lib/square/api/gift_card_activities_api.rb @@ -41,7 +41,7 @@ class GiftCardActivitiesApi < BaseApi # @param [String] sort_order Optional parameter: The order in which the # endpoint returns the activities, based on `created_at`. - `ASC` - Oldest # to newest. - `DESC` - Newest to oldest (default). - # @return [ListGiftCardActivitiesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_gift_card_activities(gift_card_id: nil, type: nil, location_id: nil, @@ -78,7 +78,7 @@ def list_gift_card_activities(gift_card_id: nil, # @param [CreateGiftCardActivityRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateGiftCardActivityResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_gift_card_activity(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, diff --git a/lib/square/api/gift_cards_api.rb b/lib/square/api/gift_cards_api.rb index bb9aac7e..de20dc31 100644 --- a/lib/square/api/gift_cards_api.rb +++ b/lib/square/api/gift_cards_api.rb @@ -25,7 +25,7 @@ class GiftCardsApi < BaseApi # @param [String] customer_id Optional parameter: If a customer ID is # provided, the endpoint returns only the gift cards linked to the specified # customer. - # @return [ListGiftCardsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_gift_cards(type: nil, state: nil, limit: nil, @@ -61,7 +61,7 @@ def list_gift_cards(type: nil, # @param [CreateGiftCardRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateGiftCardResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_gift_card(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -83,7 +83,7 @@ def create_gift_card(body:) # @param [RetrieveGiftCardFromGANRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [RetrieveGiftCardFromGANResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_gift_card_from_gan(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -106,7 +106,7 @@ def retrieve_gift_card_from_gan(body:) # @param [RetrieveGiftCardFromNonceRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [RetrieveGiftCardFromNonceResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_gift_card_from_nonce(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -131,7 +131,7 @@ def retrieve_gift_card_from_nonce(body:) # @param [LinkCustomerToGiftCardRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [LinkCustomerToGiftCardResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def link_customer_to_gift_card(gift_card_id:, body:) new_api_call_builder @@ -159,7 +159,7 @@ def link_customer_to_gift_card(gift_card_id:, # @param [UnlinkCustomerFromGiftCardRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [UnlinkCustomerFromGiftCardResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def unlink_customer_from_gift_card(gift_card_id:, body:) new_api_call_builder @@ -183,7 +183,7 @@ def unlink_customer_from_gift_card(gift_card_id:, # Retrieves a gift card using the gift card ID. # @param [String] id Required parameter: The ID of the gift card to # retrieve. - # @return [RetrieveGiftCardResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_gift_card(id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, diff --git a/lib/square/api/inventory_api.rb b/lib/square/api/inventory_api.rb index c4c4381a..94209d22 100644 --- a/lib/square/api/inventory_api.rb +++ b/lib/square/api/inventory_api.rb @@ -7,7 +7,7 @@ class InventoryApi < BaseApi # is updated to conform to the standard convention. # @param [String] adjustment_id Required parameter: ID of the # [InventoryAdjustment](entity:InventoryAdjustment) to retrieve. - # @return [RetrieveInventoryAdjustmentResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def deprecated_retrieve_inventory_adjustment(adjustment_id:) warn 'Endpoint deprecated_retrieve_inventory_adjustment in InventoryApi '\ 'is deprecated' @@ -30,7 +30,7 @@ def deprecated_retrieve_inventory_adjustment(adjustment_id:) # with the provided `adjustment_id`. # @param [String] adjustment_id Required parameter: ID of the # [InventoryAdjustment](entity:InventoryAdjustment) to retrieve. - # @return [RetrieveInventoryAdjustmentResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_inventory_adjustment(adjustment_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -54,7 +54,7 @@ def retrieve_inventory_adjustment(adjustment_id:) # @param [BatchChangeInventoryRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [BatchChangeInventoryResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def deprecated_batch_change_inventory(body:) warn 'Endpoint deprecated_batch_change_inventory in InventoryApi is depr'\ 'ecated' @@ -81,7 +81,7 @@ def deprecated_batch_change_inventory(body:) # @param [BatchRetrieveInventoryChangesRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [BatchRetrieveInventoryChangesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def deprecated_batch_retrieve_inventory_changes(body:) warn 'Endpoint deprecated_batch_retrieve_inventory_changes in InventoryA'\ 'pi is deprecated' @@ -108,7 +108,7 @@ def deprecated_batch_retrieve_inventory_changes(body:) # @param [BatchRetrieveInventoryCountsRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [BatchRetrieveInventoryCountsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def deprecated_batch_retrieve_inventory_counts(body:) warn 'Endpoint deprecated_batch_retrieve_inventory_counts in InventoryAp'\ 'i is deprecated' @@ -135,7 +135,7 @@ def deprecated_batch_retrieve_inventory_counts(body:) # @param [BatchChangeInventoryRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [BatchChangeInventoryResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def batch_change_inventory(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -162,7 +162,7 @@ def batch_change_inventory(body:) # @param [BatchRetrieveInventoryChangesRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [BatchRetrieveInventoryChangesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def batch_retrieve_inventory_changes(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -193,7 +193,7 @@ def batch_retrieve_inventory_changes(body:) # @param [BatchRetrieveInventoryCountsRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [BatchRetrieveInventoryCountsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def batch_retrieve_inventory_counts(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -217,7 +217,7 @@ def batch_retrieve_inventory_counts(body:) # is updated to conform to the standard convention. # @param [String] physical_count_id Required parameter: ID of the # [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve. - # @return [RetrieveInventoryPhysicalCountResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def deprecated_retrieve_inventory_physical_count(physical_count_id:) warn 'Endpoint deprecated_retrieve_inventory_physical_count in Inventory'\ 'Api is deprecated' @@ -240,7 +240,7 @@ def deprecated_retrieve_inventory_physical_count(physical_count_id:) # object with the provided `physical_count_id`. # @param [String] physical_count_id Required parameter: ID of the # [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve. - # @return [RetrieveInventoryPhysicalCountResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_inventory_physical_count(physical_count_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -261,7 +261,7 @@ def retrieve_inventory_physical_count(physical_count_id:) # with the provided `transfer_id`. # @param [String] transfer_id Required parameter: ID of the # [InventoryTransfer](entity:InventoryTransfer) to retrieve. - # @return [RetrieveInventoryTransferResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_inventory_transfer(transfer_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -292,7 +292,7 @@ def retrieve_inventory_transfer(transfer_id:) # results for the original query. See the # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat # ion) guide for more information. - # @return [RetrieveInventoryCountResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_inventory_count(catalog_object_id:, location_ids: nil, cursor: nil) @@ -337,7 +337,7 @@ def retrieve_inventory_count(catalog_object_id:, # results for the original query. See the # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat # ion) guide for more information. - # @return [RetrieveInventoryChangesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_inventory_changes(catalog_object_id:, location_ids: nil, cursor: nil) diff --git a/lib/square/api/invoices_api.rb b/lib/square/api/invoices_api.rb index 40d44adb..99625792 100644 --- a/lib/square/api/invoices_api.rb +++ b/lib/square/api/invoices_api.rb @@ -14,7 +14,7 @@ class InvoicesApi < BaseApi # @param [Integer] limit Optional parameter: The maximum number of invoices # to return (200 is the maximum `limit`). If not provided, the server uses # a default limit of 100 invoices. - # @return [ListInvoicesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_invoices(location_id:, cursor: nil, limit: nil) @@ -42,7 +42,7 @@ def list_invoices(location_id:, # @param [CreateInvoiceRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateInvoiceResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_invoice(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -70,7 +70,7 @@ def create_invoice(body:) # @param [SearchInvoicesRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [SearchInvoicesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def search_invoices(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -98,7 +98,7 @@ def search_invoices(body:) # [invoice](entity:Invoice) to delete. If you do not know the version, you # can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or # [ListInvoices](api-endpoint:Invoices-ListInvoices). - # @return [DeleteInvoiceResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_invoice(invoice_id:, version: nil) new_api_call_builder @@ -120,7 +120,7 @@ def delete_invoice(invoice_id:, # Retrieves an invoice by invoice ID. # @param [String] invoice_id Required parameter: The ID of the invoice to # retrieve. - # @return [GetInvoiceResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def get_invoice(invoice_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -149,7 +149,7 @@ def get_invoice(invoice_id:) # @param [UpdateInvoiceRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpdateInvoiceResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_invoice(invoice_id:, body:) new_api_call_builder @@ -184,7 +184,7 @@ def update_invoice(invoice_id:, # Represents a # [CreateInvoiceAttachment]($e/Invoices/CreateInvoiceAttachment) request. # @param [File | UploadIO] image_file Optional parameter: Example: - # @return [CreateInvoiceAttachmentResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_invoice_attachment(invoice_id:, request: nil, image_file: nil) @@ -215,7 +215,7 @@ def create_invoice_attachment(invoice_id:, # [invoice](entity:Invoice) to delete the attachment from. # @param [String] attachment_id Required parameter: The ID of the # [attachment](entity:InvoiceAttachment) to delete. - # @return [DeleteInvoiceAttachmentResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_invoice_attachment(invoice_id:, attachment_id:) new_api_call_builder @@ -244,7 +244,7 @@ def delete_invoice_attachment(invoice_id:, # @param [CancelInvoiceRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CancelInvoiceResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def cancel_invoice(invoice_id:, body:) new_api_call_builder @@ -287,7 +287,7 @@ def cancel_invoice(invoice_id:, # @param [PublishInvoiceRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [PublishInvoiceResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def publish_invoice(invoice_id:, body:) new_api_call_builder diff --git a/lib/square/api/labor_api.rb b/lib/square/api/labor_api.rb index f0bc0149..f60c7565 100644 --- a/lib/square/api/labor_api.rb +++ b/lib/square/api/labor_api.rb @@ -10,7 +10,7 @@ class LaborApi < BaseApi # 200. The default is 200. # @param [String] cursor Optional parameter: A pointer to the next page of # `BreakType` results to fetch. - # @return [ListBreakTypesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_break_types(location_id: nil, limit: nil, cursor: nil) @@ -46,7 +46,7 @@ def list_break_types(location_id: nil, # @param [CreateBreakTypeRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateBreakTypeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_break_type(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -68,7 +68,7 @@ def create_break_type(body:) # A `BreakType` can be deleted even if it is referenced from a `Shift`. # @param [String] id Required parameter: The UUID for the `BreakType` being # deleted. - # @return [DeleteBreakTypeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_break_type(id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::DELETE, @@ -88,7 +88,7 @@ def delete_break_type(id:) # Returns a single `BreakType` specified by `id`. # @param [String] id Required parameter: The UUID for the `BreakType` being # retrieved. - # @return [GetBreakTypeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def get_break_type(id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -111,7 +111,7 @@ def get_break_type(id:) # @param [UpdateBreakTypeRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpdateBreakTypeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_break_type(id:, body:) new_api_call_builder @@ -140,7 +140,7 @@ def update_break_type(id:, # and 200. The default is 200. # @param [String] cursor Optional parameter: A pointer to the next page of # `EmployeeWage` results to fetch. - # @return [ListEmployeeWagesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_employee_wages(employee_id: nil, limit: nil, cursor: nil) @@ -164,7 +164,7 @@ def list_employee_wages(employee_id: nil, # Returns a single `EmployeeWage` specified by `id`. # @param [String] id Required parameter: The UUID for the `EmployeeWage` # being retrieved. - # @return [GetEmployeeWageResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def get_employee_wage(id:) warn 'Endpoint get_employee_wage in LaborApi is deprecated' new_api_call_builder @@ -203,7 +203,7 @@ def get_employee_wage(id:) # @param [CreateShiftRequest] body Required parameter: An object containing # the fields to POST for the request. See the corresponding object # definition for field details. - # @return [CreateShiftResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_shift(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -237,7 +237,7 @@ def create_shift(body:) # @param [SearchShiftsRequest] body Required parameter: An object containing # the fields to POST for the request. See the corresponding object # definition for field details. - # @return [SearchShiftsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def search_shifts(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -258,7 +258,7 @@ def search_shifts(body:) # Deletes a `Shift`. # @param [String] id Required parameter: The UUID for the `Shift` being # deleted. - # @return [DeleteShiftResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_shift(id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::DELETE, @@ -278,7 +278,7 @@ def delete_shift(id:) # Returns a single `Shift` specified by `id`. # @param [String] id Required parameter: The UUID for the `Shift` being # retrieved. - # @return [GetShiftResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def get_shift(id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -307,7 +307,7 @@ def get_shift(id:) # @param [UpdateShiftRequest] body Required parameter: An object containing # the fields to POST for the request. See the corresponding object # definition for field details. - # @return [UpdateShiftResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_shift(id:, body:) new_api_call_builder @@ -336,7 +336,7 @@ def update_shift(id:, # 1 and 200. The default is 200. # @param [String] cursor Optional parameter: A pointer to the next page of # `EmployeeWage` results to fetch. - # @return [ListTeamMemberWagesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_team_member_wages(team_member_id: nil, limit: nil, cursor: nil) @@ -359,7 +359,7 @@ def list_team_member_wages(team_member_id: nil, # Returns a single `TeamMemberWage` specified by `id`. # @param [String] id Required parameter: The UUID for the `TeamMemberWage` # being retrieved. - # @return [GetTeamMemberWageResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def get_team_member_wage(id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -381,7 +381,7 @@ def get_team_member_wage(id:) # `WorkweekConfigs` results to return per page. # @param [String] cursor Optional parameter: A pointer to the next page of # `WorkweekConfig` results to fetch. - # @return [ListWorkweekConfigsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_workweek_configs(limit: nil, cursor: nil) new_api_call_builder @@ -405,7 +405,7 @@ def list_workweek_configs(limit: nil, # @param [UpdateWorkweekConfigRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpdateWorkweekConfigResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_workweek_config(id:, body:) new_api_call_builder diff --git a/lib/square/api/location_custom_attributes_api.rb b/lib/square/api/location_custom_attributes_api.rb index 92d41b47..83dcde57 100644 --- a/lib/square/api/location_custom_attributes_api.rb +++ b/lib/square/api/location_custom_attributes_api.rb @@ -24,7 +24,7 @@ class LocationCustomAttributesApi < BaseApi # more information, see # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p # atterns/pagination). - # @return [ListLocationCustomAttributeDefinitionsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_location_custom_attribute_definitions(visibility_filter: nil, limit: nil, cursor: nil) @@ -59,7 +59,7 @@ def list_location_custom_attribute_definitions(visibility_filter: nil, # @param [CreateLocationCustomAttributeDefinitionRequest] body Required # parameter: An object containing the fields to POST for the request. See # the corresponding object definition for field details. - # @return [CreateLocationCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_location_custom_attribute_definition(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -85,7 +85,7 @@ def create_location_custom_attribute_definition(body:) # Only the definition owner can delete a custom attribute definition. # @param [String] key Required parameter: The key of the custom attribute # definition to delete. - # @return [DeleteLocationCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_location_custom_attribute_definition(key:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::DELETE, @@ -116,7 +116,7 @@ def delete_location_custom_attribute_definition(key:) # 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. - # @return [RetrieveLocationCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_location_custom_attribute_definition(key:, version: nil) new_api_call_builder @@ -146,7 +146,7 @@ def retrieve_location_custom_attribute_definition(key:, # @param [UpdateLocationCustomAttributeDefinitionRequest] body Required # parameter: An object containing the fields to POST for the request. See # the corresponding object definition for field details. - # @return [UpdateLocationCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_location_custom_attribute_definition(key:, body:) new_api_call_builder @@ -175,7 +175,7 @@ def update_location_custom_attribute_definition(key:, # @param [BulkDeleteLocationCustomAttributesRequest] body Required # parameter: An object containing the fields to POST for the request. See # the corresponding object definition for field details. - # @return [BulkDeleteLocationCustomAttributesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_delete_location_custom_attributes(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -215,7 +215,7 @@ def bulk_delete_location_custom_attributes(body:) # @param [BulkUpsertLocationCustomAttributesRequest] body Required # parameter: An object containing the fields to POST for the request. See # the corresponding object definition for field details. - # @return [BulkUpsertLocationCustomAttributesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_upsert_location_custom_attributes(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -265,7 +265,7 @@ def bulk_upsert_location_custom_attributes(body:) # 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`. - # @return [ListLocationCustomAttributesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_location_custom_attributes(location_id:, visibility_filter: nil, limit: nil, @@ -301,7 +301,7 @@ def list_location_custom_attributes(location_id:, # 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. - # @return [DeleteLocationCustomAttributeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_location_custom_attribute(location_id:, key:) new_api_call_builder @@ -347,7 +347,7 @@ def delete_location_custom_attribute(location_id:, # 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. - # @return [RetrieveLocationCustomAttributeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_location_custom_attribute(location_id:, key:, with_definition: false, @@ -392,7 +392,7 @@ def retrieve_location_custom_attribute(location_id:, # @param [UpsertLocationCustomAttributeRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [UpsertLocationCustomAttributeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def upsert_location_custom_attribute(location_id:, key:, body:) diff --git a/lib/square/api/locations_api.rb b/lib/square/api/locations_api.rb index 2c0e31f8..0a14c137 100644 --- a/lib/square/api/locations_api.rb +++ b/lib/square/api/locations_api.rb @@ -5,7 +5,7 @@ class LocationsApi < BaseApi # [locations](https://developer.squareup.com/docs/locations-api), # including those with an inactive status. Locations are listed # alphabetically by `name`. - # @return [ListLocationsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_locations new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -33,7 +33,7 @@ def list_locations # @param [CreateLocationRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateLocationResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_location(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -57,7 +57,7 @@ def create_location(body:) # -location). # @param [String] location_id Required parameter: The ID of the location to # retrieve. Specify the string "main" to return the main location. - # @return [RetrieveLocationResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_location(location_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -80,7 +80,7 @@ def retrieve_location(location_id:) # @param [UpdateLocationRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpdateLocationResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_location(location_id:, body:) new_api_call_builder diff --git a/lib/square/api/loyalty_api.rb b/lib/square/api/loyalty_api.rb index 0ff636f2..6680d73a 100644 --- a/lib/square/api/loyalty_api.rb +++ b/lib/square/api/loyalty_api.rb @@ -6,7 +6,7 @@ class LoyaltyApi < BaseApi # @param [CreateLoyaltyAccountRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateLoyaltyAccountResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_loyalty_account(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -32,7 +32,7 @@ def create_loyalty_account(body:) # @param [SearchLoyaltyAccountsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [SearchLoyaltyAccountsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def search_loyalty_accounts(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -53,7 +53,7 @@ def search_loyalty_accounts(body:) # Retrieves a loyalty account. # @param [String] account_id Required parameter: The ID of the [loyalty # account](entity:LoyaltyAccount) to retrieve. - # @return [RetrieveLoyaltyAccountResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_loyalty_account(account_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -100,7 +100,7 @@ def retrieve_loyalty_account(account_id:) # @param [AccumulateLoyaltyPointsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [AccumulateLoyaltyPointsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def accumulate_loyalty_points(account_id:, body:) new_api_call_builder @@ -131,7 +131,7 @@ def accumulate_loyalty_points(account_id:, # @param [AdjustLoyaltyPointsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [AdjustLoyaltyPointsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def adjust_loyalty_points(account_id:, body:) new_api_call_builder @@ -163,7 +163,7 @@ def adjust_loyalty_points(account_id:, # @param [SearchLoyaltyEventsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [SearchLoyaltyEventsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def search_loyalty_events(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -190,7 +190,7 @@ def search_loyalty_events(body:) # Replaced with # [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when # used with the keyword `main`. - # @return [ListLoyaltyProgramsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_loyalty_programs warn 'Endpoint list_loyalty_programs in LoyaltyApi is deprecated' new_api_call_builder @@ -216,7 +216,7 @@ def list_loyalty_programs # @param [String] program_id Required parameter: 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. - # @return [RetrieveLoyaltyProgramResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_loyalty_program(program_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -263,7 +263,7 @@ def retrieve_loyalty_program(program_id:) # @param [CalculateLoyaltyPointsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CalculateLoyaltyPointsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def calculate_loyalty_points(program_id:, body:) new_api_call_builder @@ -307,7 +307,7 @@ def calculate_loyalty_points(program_id:, # maximum value is 30. The default value is 30. For more information, see # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p # atterns/pagination). - # @return [ListLoyaltyPromotionsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_loyalty_promotions(program_id:, status: nil, cursor: nil, @@ -347,7 +347,7 @@ def list_loyalty_promotions(program_id:, # @param [CreateLoyaltyPromotionRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateLoyaltyPromotionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_loyalty_promotion(program_id:, body:) new_api_call_builder @@ -375,7 +375,7 @@ def create_loyalty_promotion(program_id:, # program](entity:LoyaltyProgram). To get the program ID, call # [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) # using the `main` keyword. - # @return [RetrieveLoyaltyPromotionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_loyalty_promotion(promotion_id:, program_id:) new_api_call_builder @@ -408,7 +408,7 @@ def retrieve_loyalty_promotion(promotion_id:, # that has an `ACTIVE` or `SCHEDULED` status. # @param [String] program_id Required parameter: The ID of the base [loyalty # program](entity:LoyaltyProgram). - # @return [CancelLoyaltyPromotionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def cancel_loyalty_promotion(promotion_id:, program_id:) new_api_call_builder @@ -439,7 +439,7 @@ def cancel_loyalty_promotion(promotion_id:, # @param [CreateLoyaltyRewardRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateLoyaltyRewardResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_loyalty_reward(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -467,7 +467,7 @@ def create_loyalty_reward(body:) # @param [SearchLoyaltyRewardsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [SearchLoyaltyRewardsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def search_loyalty_rewards(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -494,7 +494,7 @@ def search_loyalty_rewards(body:) # You cannot delete a reward that has reached the terminal state (REDEEMED). # @param [String] reward_id Required parameter: The ID of the [loyalty # reward](entity:LoyaltyReward) to delete. - # @return [DeleteLoyaltyRewardResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_loyalty_reward(reward_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::DELETE, @@ -514,7 +514,7 @@ def delete_loyalty_reward(reward_id:) # Retrieves a loyalty reward. # @param [String] reward_id Required parameter: The ID of the [loyalty # reward](entity:LoyaltyReward) to retrieve. - # @return [RetrieveLoyaltyRewardResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_loyalty_reward(reward_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -544,7 +544,7 @@ def retrieve_loyalty_reward(reward_id:) # @param [RedeemLoyaltyRewardRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [RedeemLoyaltyRewardResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def redeem_loyalty_reward(reward_id:, body:) new_api_call_builder diff --git a/lib/square/api/merchant_custom_attributes_api.rb b/lib/square/api/merchant_custom_attributes_api.rb index a7c8d740..ac687ab0 100644 --- a/lib/square/api/merchant_custom_attributes_api.rb +++ b/lib/square/api/merchant_custom_attributes_api.rb @@ -24,7 +24,7 @@ class MerchantCustomAttributesApi < BaseApi # more information, see # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p # atterns/pagination). - # @return [ListMerchantCustomAttributeDefinitionsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_merchant_custom_attribute_definitions(visibility_filter: nil, limit: nil, cursor: nil) @@ -59,7 +59,7 @@ def list_merchant_custom_attribute_definitions(visibility_filter: nil, # @param [CreateMerchantCustomAttributeDefinitionRequest] body Required # parameter: An object containing the fields to POST for the request. See # the corresponding object definition for field details. - # @return [CreateMerchantCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_merchant_custom_attribute_definition(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -85,7 +85,7 @@ def create_merchant_custom_attribute_definition(body:) # Only the definition owner can delete a custom attribute definition. # @param [String] key Required parameter: The key of the custom attribute # definition to delete. - # @return [DeleteMerchantCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_merchant_custom_attribute_definition(key:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::DELETE, @@ -116,7 +116,7 @@ def delete_merchant_custom_attribute_definition(key:) # 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. - # @return [RetrieveMerchantCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_merchant_custom_attribute_definition(key:, version: nil) new_api_call_builder @@ -146,7 +146,7 @@ def retrieve_merchant_custom_attribute_definition(key:, # @param [UpdateMerchantCustomAttributeDefinitionRequest] body Required # parameter: An object containing the fields to POST for the request. See # the corresponding object definition for field details. - # @return [UpdateMerchantCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_merchant_custom_attribute_definition(key:, body:) new_api_call_builder @@ -175,7 +175,7 @@ def update_merchant_custom_attribute_definition(key:, # @param [BulkDeleteMerchantCustomAttributesRequest] body Required # parameter: An object containing the fields to POST for the request. See # the corresponding object definition for field details. - # @return [BulkDeleteMerchantCustomAttributesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_delete_merchant_custom_attributes(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -215,7 +215,7 @@ def bulk_delete_merchant_custom_attributes(body:) # @param [BulkUpsertMerchantCustomAttributesRequest] body Required # parameter: An object containing the fields to POST for the request. See # the corresponding object definition for field details. - # @return [BulkUpsertMerchantCustomAttributesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_upsert_merchant_custom_attributes(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -265,7 +265,7 @@ def bulk_upsert_merchant_custom_attributes(body:) # 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`. - # @return [ListMerchantCustomAttributesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_merchant_custom_attributes(merchant_id:, visibility_filter: nil, limit: nil, @@ -301,7 +301,7 @@ def list_merchant_custom_attributes(merchant_id:, # 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. - # @return [DeleteMerchantCustomAttributeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_merchant_custom_attribute(merchant_id:, key:) new_api_call_builder @@ -347,7 +347,7 @@ def delete_merchant_custom_attribute(merchant_id:, # 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. - # @return [RetrieveMerchantCustomAttributeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_merchant_custom_attribute(merchant_id:, key:, with_definition: false, @@ -392,7 +392,7 @@ def retrieve_merchant_custom_attribute(merchant_id:, # @param [UpsertMerchantCustomAttributeRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [UpsertMerchantCustomAttributeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def upsert_merchant_custom_attribute(merchant_id:, key:, body:) diff --git a/lib/square/api/merchants_api.rb b/lib/square/api/merchants_api.rb index f6266b2a..fd3b7b40 100644 --- a/lib/square/api/merchants_api.rb +++ b/lib/square/api/merchants_api.rb @@ -14,7 +14,7 @@ class MerchantsApi < BaseApi # endpoint to retrieve the merchant information. # @param [Integer] cursor Optional parameter: The cursor generated by the # previous response. - # @return [ListMerchantsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_merchants(cursor: nil) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -34,7 +34,7 @@ def list_merchants(cursor: nil) # @param [String] merchant_id Required parameter: 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. - # @return [RetrieveMerchantResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_merchant(merchant_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, diff --git a/lib/square/api/mobile_authorization_api.rb b/lib/square/api/mobile_authorization_api.rb index b949e4fa..bb8f2f51 100644 --- a/lib/square/api/mobile_authorization_api.rb +++ b/lib/square/api/mobile_authorization_api.rb @@ -17,7 +17,7 @@ class MobileAuthorizationApi < BaseApi # @param [CreateMobileAuthorizationCodeRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [CreateMobileAuthorizationCodeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_mobile_authorization_code(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, diff --git a/lib/square/api/o_auth_api.rb b/lib/square/api/o_auth_api.rb index fbc4c77e..5af1becd 100644 --- a/lib/square/api/o_auth_api.rb +++ b/lib/square/api/o_auth_api.rb @@ -17,7 +17,7 @@ class OAuthApi < BaseApi # definition for field details. # @param [String] authorization Required parameter: Client # APPLICATION_SECRET - # @return [RevokeTokenResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def revoke_token(body:, authorization:) new_api_call_builder @@ -55,7 +55,7 @@ def revoke_token(body:, # @param [ObtainTokenRequest] body Required parameter: An object containing # the fields to POST for the request. See the corresponding object # definition for field details. - # @return [ObtainTokenResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def obtain_token(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -89,7 +89,7 @@ def obtain_token(body:) # ). # If the access token is expired or not a valid access token, the endpoint # returns an `UNAUTHORIZED` error. - # @return [RetrieveTokenStatusResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_token_status new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, diff --git a/lib/square/api/order_custom_attributes_api.rb b/lib/square/api/order_custom_attributes_api.rb index cb8c8dc6..c79aa40b 100644 --- a/lib/square/api/order_custom_attributes_api.rb +++ b/lib/square/api/order_custom_attributes_api.rb @@ -28,7 +28,7 @@ class OrderCustomAttributesApi < BaseApi # see # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat # ion). - # @return [ListOrderCustomAttributeDefinitionsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_order_custom_attribute_definitions(visibility_filter: nil, cursor: nil, limit: nil) @@ -57,7 +57,7 @@ def list_order_custom_attribute_definitions(visibility_filter: nil, # @param [CreateOrderCustomAttributeDefinitionRequest] body Required # parameter: An object containing the fields to POST for the request. See # the corresponding object definition for field details. - # @return [CreateOrderCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_order_custom_attribute_definition(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -80,7 +80,7 @@ def create_order_custom_attribute_definition(body:) # Only the definition owner can delete a custom attribute definition. # @param [String] key Required parameter: The key of the custom attribute # definition to delete. - # @return [DeleteOrderCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_order_custom_attribute_definition(key:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::DELETE, @@ -111,7 +111,7 @@ def delete_order_custom_attribute_definition(key:) # concurrency](https://developer.squareup.com/docs/build-basics/common-api-p # atterns/optimistic-concurrency) control, include this optional field and # specify the current version of the custom attribute. - # @return [RetrieveOrderCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_order_custom_attribute_definition(key:, version: nil) new_api_call_builder @@ -140,7 +140,7 @@ def retrieve_order_custom_attribute_definition(key:, # @param [UpdateOrderCustomAttributeDefinitionRequest] body Required # parameter: An object containing the fields to POST for the request. See # the corresponding object definition for field details. - # @return [UpdateOrderCustomAttributeDefinitionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_order_custom_attribute_definition(key:, body:) new_api_call_builder @@ -185,7 +185,7 @@ def update_order_custom_attribute_definition(key:, # @param [BulkDeleteOrderCustomAttributesRequest] body Required parameter: # An object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [BulkDeleteOrderCustomAttributesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_delete_order_custom_attributes(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -228,7 +228,7 @@ def bulk_delete_order_custom_attributes(body:) # @param [BulkUpsertOrderCustomAttributesRequest] body Required parameter: # An object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [BulkUpsertOrderCustomAttributesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_upsert_order_custom_attributes(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -280,7 +280,7 @@ def bulk_upsert_order_custom_attributes(body:) # 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`. - # @return [ListOrderCustomAttributesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_order_custom_attributes(order_id:, visibility_filter: nil, cursor: nil, @@ -317,7 +317,7 @@ def list_order_custom_attributes(order_id:, # @param [String] custom_attribute_key Required parameter: The key of the # custom attribute to delete. This key must match the key of an existing # custom attribute definition. - # @return [DeleteOrderCustomAttributeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_order_custom_attribute(order_id:, custom_attribute_key:) new_api_call_builder @@ -363,7 +363,7 @@ def delete_order_custom_attribute(order_id:, # 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`. - # @return [RetrieveOrderCustomAttributeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_order_custom_attribute(order_id:, custom_attribute_key:, version: nil, @@ -409,7 +409,7 @@ def retrieve_order_custom_attribute(order_id:, # @param [UpsertOrderCustomAttributeRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [UpsertOrderCustomAttributeResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def upsert_order_custom_attribute(order_id:, custom_attribute_key:, body:) diff --git a/lib/square/api/orders_api.rb b/lib/square/api/orders_api.rb index d6cc20d2..f3ffe7fd 100644 --- a/lib/square/api/orders_api.rb +++ b/lib/square/api/orders_api.rb @@ -12,7 +12,7 @@ class OrdersApi < BaseApi # @param [CreateOrderRequest] body Required parameter: An object containing # the fields to POST for the request. See the corresponding object # definition for field details. - # @return [CreateOrderResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_order(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -36,7 +36,7 @@ def create_order(body:) # @param [BatchRetrieveOrdersRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [BatchRetrieveOrdersResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def batch_retrieve_orders(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -58,7 +58,7 @@ def batch_retrieve_orders(body:) # @param [CalculateOrderRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CalculateOrderResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def calculate_order(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -83,7 +83,7 @@ def calculate_order(body:) # @param [CloneOrderRequest] body Required parameter: An object containing # the fields to POST for the request. See the corresponding object # definition for field details. - # @return [CloneOrderResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def clone_order(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -121,7 +121,7 @@ def clone_order(body:) # @param [SearchOrdersRequest] body Required parameter: An object containing # the fields to POST for the request. See the corresponding object # definition for field details. - # @return [SearchOrdersResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def search_orders(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -142,7 +142,7 @@ def search_orders(body:) # Retrieves an [Order]($m/Order) by ID. # @param [String] order_id Required parameter: The ID of the order to # retrieve. - # @return [RetrieveOrderResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_order(order_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -182,7 +182,7 @@ def retrieve_order(order_id:) # @param [UpdateOrderRequest] body Required parameter: An object containing # the fields to POST for the request. See the corresponding object # definition for field details. - # @return [UpdateOrderResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_order(order_id:, body:) new_api_call_builder @@ -227,7 +227,7 @@ def update_order(order_id:, # @param [PayOrderRequest] body Required parameter: An object containing the # fields to POST for the request. See the corresponding object definition # for field details. - # @return [PayOrderResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def pay_order(order_id:, body:) new_api_call_builder diff --git a/lib/square/api/payments_api.rb b/lib/square/api/payments_api.rb index 691e63c7..31906e0a 100644 --- a/lib/square/api/payments_api.rb +++ b/lib/square/api/payments_api.rb @@ -53,7 +53,7 @@ class PaymentsApi < BaseApi # set, payments without a value set in # `offline_payment_details.client_created_at` will not be returned. # Default: The current time. - # @return [ListPaymentsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_payments(begin_time: nil, end_time: nil, sort_order: nil, @@ -102,7 +102,7 @@ def list_payments(begin_time: nil, # @param [CreatePaymentRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreatePaymentResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_payment(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -138,7 +138,7 @@ def create_payment(body:) # @param [CancelPaymentByIdempotencyKeyRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [CancelPaymentByIdempotencyKeyResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def cancel_payment_by_idempotency_key(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -159,7 +159,7 @@ def cancel_payment_by_idempotency_key(body:) # Retrieves details for a specific payment. # @param [String] payment_id Required parameter: A unique ID for the desired # payment. - # @return [GetPaymentResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def get_payment(payment_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -183,7 +183,7 @@ def get_payment(payment_id:) # @param [UpdatePaymentRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpdatePaymentResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_payment(payment_id:, body:) new_api_call_builder @@ -209,7 +209,7 @@ def update_payment(payment_id:, # the APPROVED `status`. # @param [String] payment_id Required parameter: The ID of the payment to # cancel. - # @return [CancelPaymentResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def cancel_payment(payment_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -236,7 +236,7 @@ def cancel_payment(payment_id:) # @param [CompletePaymentRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CompletePaymentResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def complete_payment(payment_id:, body:) new_api_call_builder diff --git a/lib/square/api/payouts_api.rb b/lib/square/api/payouts_api.rb index 3222f932..fa1dd2b7 100644 --- a/lib/square/api/payouts_api.rb +++ b/lib/square/api/payouts_api.rb @@ -28,7 +28,7 @@ class PayoutsApi < BaseApi # 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` - # @return [ListPayoutsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_payouts(location_id: nil, status: nil, begin_time: nil, @@ -60,7 +60,7 @@ def list_payouts(location_id: nil, # To call this endpoint, set `PAYOUTS_READ` for the OAuth scope. # @param [String] payout_id Required parameter: The ID of the payout to # retrieve the information for. - # @return [GetPayoutResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def get_payout(payout_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -94,7 +94,7 @@ def get_payout(payout_id:) # 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` - # @return [ListPayoutEntriesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_payout_entries(payout_id:, sort_order: nil, cursor: nil, diff --git a/lib/square/api/refunds_api.rb b/lib/square/api/refunds_api.rb index b9637a46..9a389374 100644 --- a/lib/square/api/refunds_api.rb +++ b/lib/square/api/refunds_api.rb @@ -40,7 +40,7 @@ class RefundsApi < BaseApi # 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 - # @return [ListPaymentRefundsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_payment_refunds(begin_time: nil, end_time: nil, sort_order: nil, @@ -80,7 +80,7 @@ def list_payment_refunds(begin_time: nil, # @param [RefundPaymentRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [RefundPaymentResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def refund_payment(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -101,7 +101,7 @@ def refund_payment(body:) # Retrieves a specific refund using the `refund_id`. # @param [String] refund_id Required parameter: The unique ID for the # desired `PaymentRefund`. - # @return [GetPaymentRefundResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def get_payment_refund(refund_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, diff --git a/lib/square/api/sites_api.rb b/lib/square/api/sites_api.rb index e4a738aa..af81b112 100644 --- a/lib/square/api/sites_api.rb +++ b/lib/square/api/sites_api.rb @@ -8,7 +8,7 @@ class SitesApi < BaseApi # Online # APIs](https://developer.squareup.com/docs/online-api#early-access-program- # for-square-online-apis). - # @return [ListSitesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_sites new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, diff --git a/lib/square/api/snippets_api.rb b/lib/square/api/snippets_api.rb index db90da42..dc0d9dd6 100644 --- a/lib/square/api/snippets_api.rb +++ b/lib/square/api/snippets_api.rb @@ -11,7 +11,7 @@ class SnippetsApi < BaseApi # for-square-online-apis). # @param [String] site_id Required parameter: The ID of the site that # contains the snippet. - # @return [DeleteSnippetResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_snippet(site_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::DELETE, @@ -40,7 +40,7 @@ def delete_snippet(site_id:) # for-square-online-apis). # @param [String] site_id Required parameter: The ID of the site that # contains the snippet. - # @return [RetrieveSnippetResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_snippet(site_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -74,7 +74,7 @@ def retrieve_snippet(site_id:) # @param [UpsertSnippetRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpsertSnippetResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def upsert_snippet(site_id:, body:) new_api_call_builder diff --git a/lib/square/api/subscriptions_api.rb b/lib/square/api/subscriptions_api.rb index c519145b..6a35d7df 100644 --- a/lib/square/api/subscriptions_api.rb +++ b/lib/square/api/subscriptions_api.rb @@ -14,7 +14,7 @@ class SubscriptionsApi < BaseApi # @param [CreateSubscriptionRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateSubscriptionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_subscription(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -40,7 +40,7 @@ def create_subscription(body:) # @param [BulkSwapPlanRequest] body Required parameter: An object containing # the fields to POST for the request. See the corresponding object # definition for field details. - # @return [BulkSwapPlanResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_swap_plan(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -74,7 +74,7 @@ def bulk_swap_plan(body:) # @param [SearchSubscriptionsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [SearchSubscriptionsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def search_subscriptions(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -99,7 +99,7 @@ def search_subscriptions(body:) # related information to be included in the response. The supported query # parameter values are: - `actions`: to include scheduled actions on the # targeted subscription. - # @return [RetrieveSubscriptionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_subscription(subscription_id:, include: nil) new_api_call_builder @@ -126,7 +126,7 @@ def retrieve_subscription(subscription_id:, # @param [UpdateSubscriptionRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpdateSubscriptionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_subscription(subscription_id:, body:) new_api_call_builder @@ -152,7 +152,7 @@ def update_subscription(subscription_id:, # subscription the targeted action is to act upon. # @param [String] action_id Required parameter: The ID of the targeted # action to be deleted. - # @return [DeleteSubscriptionActionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_subscription_action(subscription_id:, action_id:) new_api_call_builder @@ -181,7 +181,7 @@ def delete_subscription_action(subscription_id:, # @param [ChangeBillingAnchorDateRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [ChangeBillingAnchorDateResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def change_billing_anchor_date(subscription_id:, body:) new_api_call_builder @@ -208,7 +208,7 @@ def change_billing_anchor_date(subscription_id:, # the subscription status changes from ACTIVE to CANCELED. # @param [String] subscription_id Required parameter: The ID of the # subscription to cancel. - # @return [CancelSubscriptionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def cancel_subscription(subscription_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -239,7 +239,7 @@ def cancel_subscription(subscription_id:) # atterns/pagination). # @param [Integer] limit Optional parameter: The upper limit on the number # of subscription events to return in a paged response. - # @return [ListSubscriptionEventsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_subscription_events(subscription_id:, cursor: nil, limit: nil) @@ -266,7 +266,7 @@ def list_subscription_events(subscription_id:, # @param [PauseSubscriptionRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [PauseSubscriptionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def pause_subscription(subscription_id:, body:) new_api_call_builder @@ -294,7 +294,7 @@ def pause_subscription(subscription_id:, # @param [ResumeSubscriptionRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [ResumeSubscriptionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def resume_subscription(subscription_id:, body:) new_api_call_builder @@ -325,7 +325,7 @@ def resume_subscription(subscription_id:, # @param [SwapPlanRequest] body Required parameter: An object containing the # fields to POST for the request. See the corresponding object definition # for field details. - # @return [SwapPlanResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def swap_plan(subscription_id:, body:) new_api_call_builder diff --git a/lib/square/api/team_api.rb b/lib/square/api/team_api.rb index 5f004bac..1f620a61 100644 --- a/lib/square/api/team_api.rb +++ b/lib/square/api/team_api.rb @@ -12,7 +12,7 @@ class TeamApi < BaseApi # @param [CreateTeamMemberRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateTeamMemberResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_team_member(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -43,7 +43,7 @@ def create_team_member(body:) # @param [BulkCreateTeamMembersRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [BulkCreateTeamMembersResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_create_team_members(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -74,7 +74,7 @@ def bulk_create_team_members(body:) # @param [BulkUpdateTeamMembersRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [BulkUpdateTeamMembersResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_update_team_members(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -99,7 +99,7 @@ def bulk_update_team_members(body:) # @param [SearchTeamMembersRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [SearchTeamMembersResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def search_team_members(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -123,7 +123,7 @@ def search_team_members(body:) # eam-member). # @param [String] team_member_id Required parameter: The ID of the team # member to retrieve. - # @return [RetrieveTeamMemberResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_team_member(team_member_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -150,7 +150,7 @@ def retrieve_team_member(team_member_id:) # @param [UpdateTeamMemberRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpdateTeamMemberResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_team_member(team_member_id:, body:) new_api_call_builder @@ -178,7 +178,7 @@ def update_team_member(team_member_id:, # setting). # @param [String] team_member_id Required parameter: The ID of the team # member for which to retrieve the wage setting. - # @return [RetrieveWageSettingResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_wage_setting(team_member_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -208,7 +208,7 @@ def retrieve_wage_setting(team_member_id:) # @param [UpdateWageSettingRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [UpdateWageSettingResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_wage_setting(team_member_id:, body:) new_api_call_builder diff --git a/lib/square/api/terminal_api.rb b/lib/square/api/terminal_api.rb index cfb5936c..5b575823 100644 --- a/lib/square/api/terminal_api.rb +++ b/lib/square/api/terminal_api.rb @@ -5,7 +5,7 @@ class TerminalApi < BaseApi # @param [CreateTerminalActionRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateTerminalActionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_terminal_action(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -29,7 +29,7 @@ def create_terminal_action(body:) # @param [SearchTerminalActionsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [SearchTerminalActionsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def search_terminal_actions(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -51,7 +51,7 @@ def search_terminal_actions(body:) # requests are available for 30 days. # @param [String] action_id Required parameter: Unique ID for the desired # `TerminalAction`. - # @return [GetTerminalActionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def get_terminal_action(action_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -71,7 +71,7 @@ def get_terminal_action(action_id:) # Cancels a Terminal action request if the status of the request permits it. # @param [String] action_id Required parameter: Unique ID for the desired # `TerminalAction`. - # @return [CancelTerminalActionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def cancel_terminal_action(action_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -95,7 +95,7 @@ def cancel_terminal_action(action_id:) # s/custom-workflows/link-and-dismiss-actions) for more details. # @param [String] action_id Required parameter: Unique ID for the # `TerminalAction` associated with the action to be dismissed. - # @return [DismissTerminalActionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def dismiss_terminal_action(action_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -118,7 +118,7 @@ def dismiss_terminal_action(action_id:) # @param [CreateTerminalCheckoutRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateTerminalCheckoutResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_terminal_checkout(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -143,7 +143,7 @@ def create_terminal_checkout(body:) # @param [SearchTerminalCheckoutsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [SearchTerminalCheckoutsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def search_terminal_checkouts(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -165,7 +165,7 @@ def search_terminal_checkouts(body:) # requests are available for 30 days. # @param [String] checkout_id Required parameter: The unique ID for the # desired `TerminalCheckout`. - # @return [GetTerminalCheckoutResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def get_terminal_checkout(checkout_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -186,7 +186,7 @@ def get_terminal_checkout(checkout_id:) # it. # @param [String] checkout_id Required parameter: The unique ID for the # desired `TerminalCheckout`. - # @return [CancelTerminalCheckoutResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def cancel_terminal_checkout(checkout_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -207,7 +207,7 @@ def cancel_terminal_checkout(checkout_id:) # request permits it. # @param [String] checkout_id Required parameter: Unique ID for the # `TerminalCheckout` associated with the checkout to be dismissed. - # @return [DismissTerminalCheckoutResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def dismiss_terminal_checkout(checkout_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -232,7 +232,7 @@ def dismiss_terminal_checkout(checkout_id:) # @param [CreateTerminalRefundRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [CreateTerminalRefundResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_terminal_refund(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -256,7 +256,7 @@ def create_terminal_refund(body:) # @param [SearchTerminalRefundsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [SearchTerminalRefundsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def search_terminal_refunds(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -278,7 +278,7 @@ def search_terminal_refunds(body:) # are available for 30 days. # @param [String] terminal_refund_id Required parameter: The unique ID for # the desired `TerminalRefund`. - # @return [GetTerminalRefundResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def get_terminal_refund(terminal_refund_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -299,7 +299,7 @@ def get_terminal_refund(terminal_refund_id:) # status of the request permits it. # @param [String] terminal_refund_id Required parameter: The unique ID for # the desired `TerminalRefund`. - # @return [CancelTerminalRefundResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def cancel_terminal_refund(terminal_refund_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -320,7 +320,7 @@ def cancel_terminal_refund(terminal_refund_id:) # permits it. # @param [String] terminal_refund_id Required parameter: Unique ID for the # `TerminalRefund` associated with the refund to be dismissed. - # @return [DismissTerminalRefundResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def dismiss_terminal_refund(terminal_refund_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, diff --git a/lib/square/api/transactions_api.rb b/lib/square/api/transactions_api.rb index 8bd617c3..db070549 100644 --- a/lib/square/api/transactions_api.rb +++ b/lib/square/api/transactions_api.rb @@ -28,7 +28,7 @@ class TransactionsApi < BaseApi # results for your original query. See [Paginating # results](https://developer.squareup.com/docs/working-with-apis/pagination) # for more information. - # @return [ListTransactionsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_transactions(location_id:, begin_time: nil, end_time: nil, @@ -59,7 +59,7 @@ def list_transactions(location_id:, # transaction's associated location. # @param [String] transaction_id Required parameter: The ID of the # transaction to retrieve. - # @return [RetrieveTransactionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_transaction(location_id:, transaction_id:) warn 'Endpoint retrieve_transaction in TransactionsApi is deprecated' @@ -89,7 +89,7 @@ def retrieve_transaction(location_id:, # for more information. # @param [String] location_id Required parameter: Example: # @param [String] transaction_id Required parameter: Example: - # @return [CaptureTransactionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def capture_transaction(location_id:, transaction_id:) warn 'Endpoint capture_transaction in TransactionsApi is deprecated' @@ -119,7 +119,7 @@ def capture_transaction(location_id:, # for more information. # @param [String] location_id Required parameter: Example: # @param [String] transaction_id Required parameter: Example: - # @return [VoidTransactionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def void_transaction(location_id:, transaction_id:) warn 'Endpoint void_transaction in TransactionsApi is deprecated' diff --git a/lib/square/api/v1_transactions_api.rb b/lib/square/api/v1_transactions_api.rb index 1fe6c588..c60b0e1d 100644 --- a/lib/square/api/v1_transactions_api.rb +++ b/lib/square/api/v1_transactions_api.rb @@ -11,7 +11,7 @@ class V1TransactionsApi < BaseApi # @param [String] batch_token Optional parameter: A pagination cursor to # retrieve the next set of results for your original query to the # endpoint. - # @return [Array[V1Order] Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def v1_list_orders(location_id:, order: nil, limit: nil, @@ -43,7 +43,7 @@ def v1_list_orders(location_id:, # @param [String] order_id Required parameter: The order's Square-issued ID. # You obtain this value from Order objects returned by the List Orders # endpoint - # @return [V1Order Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def v1_retrieve_order(location_id:, order_id:) warn 'Endpoint v1_retrieve_order in V1TransactionsApi is deprecated' @@ -74,7 +74,7 @@ def v1_retrieve_order(location_id:, # @param [V1UpdateOrderRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [V1Order Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def v1_update_order(location_id:, order_id:, body:) diff --git a/lib/square/api/vendors_api.rb b/lib/square/api/vendors_api.rb index 363d0b7a..6a0f3e8d 100644 --- a/lib/square/api/vendors_api.rb +++ b/lib/square/api/vendors_api.rb @@ -6,7 +6,7 @@ class VendorsApi < BaseApi # @param [BulkCreateVendorsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [BulkCreateVendorsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_create_vendors(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -28,7 +28,7 @@ def bulk_create_vendors(body:) # @param [BulkRetrieveVendorsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [BulkRetrieveVendorsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_retrieve_vendors(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -51,7 +51,7 @@ def bulk_retrieve_vendors(body:) # @param [BulkUpdateVendorsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [BulkUpdateVendorsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def bulk_update_vendors(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::PUT, @@ -74,7 +74,7 @@ def bulk_update_vendors(body:) # @param [CreateVendorRequest] body Required parameter: An object containing # the fields to POST for the request. See the corresponding object # definition for field details. - # @return [CreateVendorResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_vendor(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -97,7 +97,7 @@ def create_vendor(body:) # @param [SearchVendorsRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [SearchVendorsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def search_vendors(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -118,7 +118,7 @@ def search_vendors(body:) # Retrieves the vendor of a specified [Vendor]($m/Vendor) ID. # @param [String] vendor_id Required parameter: ID of the # [Vendor](entity:Vendor) to retrieve. - # @return [RetrieveVendorResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_vendor(vendor_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -140,7 +140,7 @@ def retrieve_vendor(vendor_id:) # the fields to POST for the request. See the corresponding object # definition for field details. # @param [String] vendor_id Required parameter: Example: - # @return [UpdateVendorResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_vendor(body:, vendor_id:) new_api_call_builder diff --git a/lib/square/api/webhook_subscriptions_api.rb b/lib/square/api/webhook_subscriptions_api.rb index e38074b6..42d509b1 100644 --- a/lib/square/api/webhook_subscriptions_api.rb +++ b/lib/square/api/webhook_subscriptions_api.rb @@ -5,7 +5,7 @@ class WebhookSubscriptionsApi < BaseApi # @param [String] api_version Optional parameter: The API version for which # to list event types. Setting this field overrides the default version used # by the application. - # @return [ListWebhookEventTypesResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_webhook_event_types(api_version: nil) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -37,7 +37,7 @@ def list_webhook_event_types(api_version: nil) # 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 - # @return [ListWebhookSubscriptionsResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def list_webhook_subscriptions(cursor: nil, include_disabled: false, sort_order: nil, @@ -63,7 +63,7 @@ def list_webhook_subscriptions(cursor: nil, # @param [CreateWebhookSubscriptionRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [CreateWebhookSubscriptionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def create_webhook_subscription(body:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::POST, @@ -84,7 +84,7 @@ def create_webhook_subscription(body:) # Deletes a webhook subscription. # @param [String] subscription_id Required parameter: [REQUIRED] The ID of # the [Subscription](entity:WebhookSubscription) to delete. - # @return [DeleteWebhookSubscriptionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def delete_webhook_subscription(subscription_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::DELETE, @@ -104,7 +104,7 @@ def delete_webhook_subscription(subscription_id:) # Retrieves a webhook subscription identified by its ID. # @param [String] subscription_id Required parameter: [REQUIRED] The ID of # the [Subscription](entity:WebhookSubscription) to retrieve. - # @return [RetrieveWebhookSubscriptionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def retrieve_webhook_subscription(subscription_id:) new_api_call_builder .request(new_request_builder(HttpMethodEnum::GET, @@ -127,7 +127,7 @@ def retrieve_webhook_subscription(subscription_id:) # @param [UpdateWebhookSubscriptionRequest] body Required parameter: An # object containing the fields to POST for the request. See the # corresponding object definition for field details. - # @return [UpdateWebhookSubscriptionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_webhook_subscription(subscription_id:, body:) new_api_call_builder @@ -155,7 +155,7 @@ def update_webhook_subscription(subscription_id:, # @param [UpdateWebhookSubscriptionSignatureKeyRequest] body Required # parameter: An object containing the fields to POST for the request. See # the corresponding object definition for field details. - # @return [UpdateWebhookSubscriptionSignatureKeyResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def update_webhook_subscription_signature_key(subscription_id:, body:) new_api_call_builder @@ -183,7 +183,7 @@ def update_webhook_subscription_signature_key(subscription_id:, # @param [TestWebhookSubscriptionRequest] body Required parameter: An object # containing the fields to POST for the request. See the corresponding # object definition for field details. - # @return [TestWebhookSubscriptionResponse Hash] response from the API call + # @return [ApiResponse] the complete http response with raw body and status code. def test_webhook_subscription(subscription_id:, body:) new_api_call_builder diff --git a/lib/square/client.rb b/lib/square/client.rb index 997391e9..6023057f 100644 --- a/lib/square/client.rb +++ b/lib/square/client.rb @@ -5,7 +5,7 @@ class Client attr_reader :config, :auth_managers def sdk_version - '39.0.0.20240821' + '39.1.0.20240919' end def square_version @@ -274,7 +274,7 @@ def initialize( retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524], retry_methods: %i[get put], http_callback: nil, environment: 'production', custom_url: 'https://connect.squareup.com', access_token: nil, - bearer_auth_credentials: nil, square_version: '2024-08-21', + bearer_auth_credentials: nil, square_version: '2024-09-19', user_agent_detail: '', additional_headers: {}, config: nil ) @config = if config.nil? diff --git a/lib/square/configuration.rb b/lib/square/configuration.rb index 2a2cdbe9..d5c67609 100644 --- a/lib/square/configuration.rb +++ b/lib/square/configuration.rb @@ -24,7 +24,7 @@ def initialize( retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524], retry_methods: %i[get put], http_callback: nil, environment: 'production', custom_url: 'https://connect.squareup.com', access_token: nil, - bearer_auth_credentials: nil, square_version: '2024-08-21', + bearer_auth_credentials: nil, square_version: '2024-09-19', user_agent_detail: '', additional_headers: {} ) diff --git a/square.gemspec b/square.gemspec index 558275f9..a3dc74b5 100644 --- a/square.gemspec +++ b/square.gemspec @@ -1,6 +1,6 @@ Gem::Specification.new do |s| s.name = 'square.rb' - s.version = '39.0.0.20240821' + s.version = '39.1.0.20240919' s.summary = 'square' s.description = '' s.authors = ['Square Developer Platform']