From eb848048197f669a6aa2755ff87cfdad47947968 Mon Sep 17 00:00:00 2001 From: Connect API Specification Generator Date: Wed, 18 Nov 2020 19:38:16 +0000 Subject: [PATCH] Release 5.20201118.0 --- CHANGES.md | 30 +- README.md | 1291 ++--------------- docs/AppointmentSegment.md | 16 + docs/Availability.md | 15 + docs/BalancePaymentDetails.md | 4 +- docs/Booking.md | 23 + docs/BookingStatus.md | 18 + docs/BookingsApi.md | 362 +++++ docs/BusinessAppointmentSettings.md | 25 + ...usinessAppointmentSettingsAlignmentTime.md | 14 + ...sAppointmentSettingsBookingLocationType.md | 12 + ...ssAppointmentSettingsCancellationPolicy.md | 10 + ...tSettingsMaxAppointmentsPerDayLimitType.md | 10 + docs/BusinessBookingProfile.md | 19 + docs/BusinessBookingProfileBookingPolicy.md | 10 + ...essBookingProfileCustomerTimezoneChoice.md | 10 + docs/CardPaymentDetails.md | 22 +- docs/CashDrawersApi.md | 2 +- docs/CatalogApi.md | 2 +- docs/CatalogIdMapping.md | 2 +- docs/CatalogItem.md | 2 +- docs/CatalogItemVariation.md | 4 +- docs/CatalogQuery.md | 2 +- docs/CheckAppointmentsOnboardedRequest.md | 12 + ... => CheckAppointmentsOnboardedResponse.md} | 6 +- docs/CreateBookingRequest.md | 14 + ...geResponse.md => CreateBookingResponse.md} | 5 +- docs/CreateCatalogImageRequest.md | 14 - docs/CreateDisputeEvidenceFileRequest.md | 15 - docs/DeviceDetails.md | 6 +- docs/GetPaymentRefundResponse.md | 4 +- docs/ListPaymentRefundsRequest.md | 18 +- docs/ListPaymentRefundsResponse.md | 6 +- docs/ListTeamMemberBookingProfilesRequest.md | 16 + docs/ListTeamMemberBookingProfilesResponse.md | 15 + docs/OAuthApi.md | 4 +- docs/ObtainTokenRequest.md | 2 + docs/ObtainTokenResponse.md | 5 +- docs/OnboardAppointmentsRequest.md | 12 + docs/OnboardAppointmentsResponse.md | 13 + docs/Payment.md | 55 +- docs/PaymentRefund.md | 18 +- docs/ProcessingFee.md | 8 +- docs/README.md | 1231 ++++++++++++++++ docs/RefundPaymentRequest.md | 8 +- docs/RefundPaymentResponse.md | 4 +- docs/RefundsApi.md | 36 +- docs/RetrieveBookingRequest.md | 12 + docs/RetrieveBookingResponse.md | 14 + docs/RetrieveBusinessBookingProfileRequest.md | 12 + .../RetrieveBusinessBookingProfileResponse.md | 14 + docs/RetrieveObsMigrationProfileRequest.md | 12 + docs/RetrieveObsMigrationProfileResponse.md | 17 + ...RetrieveTeamMemberBookingProfileRequest.md | 12 + ...etrieveTeamMemberBookingProfileResponse.md | 14 + docs/RiskEvaluation.md | 14 + docs/RiskEvaluationRiskLevel.md | 14 + docs/SearchAvailabilityFilter.md | 16 + docs/SearchAvailabilityQuery.md | 13 + docs/SearchAvailabilityRequest.md | 13 + docs/SearchAvailabilityResponse.md | 14 + docs/SearchCatalogObjectsRequest.md | 2 +- docs/SegmentFilter.md | 14 + docs/TeamMemberBookingProfile.md | 17 + docs/TerminalCheckout.md | 4 +- docs/TerminalCheckoutQueryFilter.md | 2 +- docs/TerminalRefund.md | 2 +- docs/TerminalRefundQueryFilter.md | 2 +- docs/TipSettings.md | 2 + docs/UpdateBookingRequest.md | 14 + docs/UpdateBookingResponse.md | 14 + docs/VersionedCatalogObject.md | 13 - package.json | 2 +- src/ApiClient.js | 4 +- src/api/ApplePayApi.js | 2 +- src/api/BankAccountsApi.js | 6 +- src/api/BookingsApi.js | 423 ++++++ src/api/CashDrawersApi.js | 10 +- src/api/CatalogApi.js | 28 +- src/api/CheckoutApi.js | 2 +- src/api/CustomerGroupsApi.js | 10 +- src/api/CustomerSegmentsApi.js | 4 +- src/api/CustomersApi.js | 20 +- src/api/DevicesApi.js | 6 +- src/api/DisputesApi.js | 16 +- src/api/EmployeesApi.js | 4 +- src/api/InventoryApi.js | 14 +- src/api/InvoicesApi.js | 16 +- src/api/LaborApi.js | 32 +- src/api/LocationsApi.js | 8 +- src/api/LoyaltyApi.js | 26 +- src/api/MerchantsApi.js | 4 +- src/api/MobileAuthorizationApi.js | 2 +- src/api/OAuthApi.js | 14 +- src/api/OrdersApi.js | 14 +- src/api/PaymentsApi.js | 12 +- src/api/RefundsApi.js | 42 +- src/api/SubscriptionsApi.js | 12 +- src/api/TeamApi.js | 16 +- src/api/TerminalApi.js | 16 +- src/api/TransactionsApi.js | 14 +- src/api/V1EmployeesApi.js | 32 +- src/api/V1ItemsApi.js | 80 +- src/api/V1LocationsApi.js | 4 +- src/api/V1TransactionsApi.js | 22 +- src/index.js | 266 +++- src/model/AppointmentSegment.js | 97 ++ src/model/Availability.js | 85 ++ src/model/BalancePaymentDetails.js | 4 +- src/model/Booking.js | 157 ++ src/model/BookingStatus.js | 65 + src/model/BusinessAppointmentSettings.js | 179 +++ ...usinessAppointmentSettingsAlignmentTime.js | 55 + ...sAppointmentSettingsBookingLocationType.js | 50 + ...ssAppointmentSettingsCancellationPolicy.js | 45 + ...tSettingsMaxAppointmentsPerDayLimitType.js | 45 + src/model/BusinessBookingProfile.js | 123 ++ .../BusinessBookingProfileBookingPolicy.js | 45 + ...essBookingProfileCustomerTimezoneChoice.js | 45 + src/model/CardPaymentDetails.js | 22 +- src/model/CatalogIdMapping.js | 2 +- src/model/CatalogItem.js | 2 +- src/model/CatalogItemVariation.js | 20 +- src/model/CatalogQuery.js | 2 +- .../CheckAppointmentsOnboardedRequest.js | 57 + ... => CheckAppointmentsOnboardedResponse.js} | 33 +- src/model/CreateBookingRequest.js | 77 + src/model/CreateBookingResponse.js | 77 + src/model/CreateCatalogImageRequest.js | 85 -- src/model/CreateDisputeEvidenceFileRequest.js | 85 -- src/model/DeviceDetails.js | 6 +- src/model/GetPaymentRefundResponse.js | 4 +- src/model/ListPaymentRefundsRequest.js | 18 +- src/model/ListPaymentRefundsResponse.js | 6 +- .../ListTeamMemberBookingProfilesRequest.js | 93 ++ .../ListTeamMemberBookingProfilesResponse.js | 86 ++ src/model/ObtainTokenRequest.js | 18 + src/model/ObtainTokenResponse.js | 13 +- src/model/OnboardAppointmentsRequest.js | 57 + src/model/OnboardAppointmentsResponse.js | 67 + src/model/Payment.js | 64 +- src/model/PaymentRefund.js | 22 +- src/model/ProcessingFee.js | 8 +- src/model/RefundPaymentRequest.js | 14 +- src/model/RefundPaymentResponse.js | 4 +- src/model/RetrieveBookingRequest.js | 57 + src/model/RetrieveBookingResponse.js | 77 + .../RetrieveBusinessBookingProfileRequest.js | 57 + .../RetrieveBusinessBookingProfileResponse.js | 77 + .../RetrieveObsMigrationProfileRequest.js | 57 + .../RetrieveObsMigrationProfileResponse.js | 103 ++ ...RetrieveTeamMemberBookingProfileRequest.js | 57 + ...etrieveTeamMemberBookingProfileResponse.js | 77 + src/model/RiskEvaluation.js | 76 + src/model/RiskEvaluationRiskLevel.js | 55 + src/model/SearchAvailabilityFilter.js | 96 ++ src/model/SearchAvailabilityQuery.js | 68 + src/model/SearchAvailabilityRequest.js | 68 + ...ponse.js => SearchAvailabilityResponse.js} | 33 +- src/model/SearchCatalogObjectsRequest.js | 2 +- src/model/SegmentFilter.js | 77 + src/model/TeamMemberBookingProfile.js | 102 ++ src/model/TerminalCheckout.js | 4 +- src/model/TerminalCheckoutQueryFilter.js | 2 +- src/model/TerminalRefund.js | 2 +- src/model/TerminalRefundQueryFilter.js | 2 +- src/model/TipSettings.js | 18 + src/model/UpdateBookingRequest.js | 77 + src/model/UpdateBookingResponse.js | 77 + src/model/VersionedCatalogObject.js | 74 - test/api/BookingsApi.spec.js | 106 ++ test/api/LocationsApi.spec.js | 16 +- test/api/ReportingApi.spec.js | 70 +- .../AdditionalRecipientReceivable.spec.js | 2 +- ...dditionalRecipientReceivableRefund.spec.js | 2 +- test/model/AppointmentSegment.spec.js | 47 + test/model/Availability.spec.js | 42 + test/model/Booking.spec.js | 82 ++ test/model/BookingStatus.spec.js | 26 + .../model/BusinessAppointmentSettings.spec.js | 92 ++ ...ssAppointmentSettingsAlignmentTime.spec.js | 26 + ...intmentSettingsBookingLocationType.spec.js | 26 + ...ointmentSettingsCancellationPolicy.spec.js | 26 + ...ingsMaxAppointmentsPerDayLimitType.spec.js | 26 + test/model/BusinessBookingProfile.spec.js | 62 + ...usinessBookingProfileBookingPolicy.spec.js | 26 + ...okingProfileCustomerTimezoneChoice.spec.js | 26 + .../CheckAppointmentsOnboardedRequest.spec.js | 27 + ...CheckAppointmentsOnboardedResponse.spec.js | 37 + test/model/CreateBookingRequest.spec.js | 37 + test/model/CreateBookingResponse.spec.js | 37 + test/model/CreateCatalogImageRequest.spec.js | 2 +- test/model/CreateCatalogImageResponse.spec.js | 2 +- .../CreateDisputeEvidenceFileRequest.spec.js | 2 +- .../CreateDisputeEvidenceFileResponse.spec.js | 2 +- ...lRecipientReceivableRefundsRequest.spec.js | 2 +- ...RecipientReceivableRefundsResponse.spec.js | 2 +- ...itionalRecipientReceivablesRequest.spec.js | 2 +- ...tionalRecipientReceivablesResponse.spec.js | 2 +- ...stTeamMemberBookingProfilesRequest.spec.js | 47 + ...tTeamMemberBookingProfilesResponse.spec.js | 42 + test/model/MethodErrorCodes.spec.js | 2 +- test/model/OnboardAppointmentsRequest.spec.js | 27 + .../model/OnboardAppointmentsResponse.spec.js | 32 + test/model/RetrieveBookingRequest.spec.js | 27 + test/model/RetrieveBookingResponse.spec.js | 37 + ...rieveBusinessBookingProfileRequest.spec.js | 27 + ...ieveBusinessBookingProfileResponse.spec.js | 37 + ...RetrieveObsMigrationProfileRequest.spec.js | 27 + ...etrieveObsMigrationProfileResponse.spec.js | 52 + ...eveTeamMemberBookingProfileRequest.spec.js | 27 + ...veTeamMemberBookingProfileResponse.spec.js | 37 + test/model/RiskEvaluation.spec.js | 37 + test/model/RiskEvaluationRiskLevel.spec.js | 26 + test/model/SearchAvailabilityFilter.spec.js | 47 + test/model/SearchAvailabilityQuery.spec.js | 32 + test/model/SearchAvailabilityRequest.spec.js | 32 + test/model/SearchAvailabilityResponse.spec.js | 37 + test/model/SegmentFilter.spec.js | 37 + test/model/TeamMemberBookingProfile.spec.js | 52 + test/model/TenderBankTransferDetails.spec.js | 2 +- test/model/UpdateBookingRequest.spec.js | 37 + test/model/UpdateBookingResponse.spec.js | 37 + test/model/VersionedCatalogObject.spec.js | 2 +- 224 files changed, 7883 insertions(+), 1997 deletions(-) create mode 100644 docs/AppointmentSegment.md create mode 100644 docs/Availability.md create mode 100644 docs/Booking.md create mode 100644 docs/BookingStatus.md create mode 100644 docs/BookingsApi.md create mode 100644 docs/BusinessAppointmentSettings.md create mode 100644 docs/BusinessAppointmentSettingsAlignmentTime.md create mode 100644 docs/BusinessAppointmentSettingsBookingLocationType.md create mode 100644 docs/BusinessAppointmentSettingsCancellationPolicy.md create mode 100644 docs/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.md create mode 100644 docs/BusinessBookingProfile.md create mode 100644 docs/BusinessBookingProfileBookingPolicy.md create mode 100644 docs/BusinessBookingProfileCustomerTimezoneChoice.md create mode 100644 docs/CheckAppointmentsOnboardedRequest.md rename docs/{CreateDisputeEvidenceFileResponse.md => CheckAppointmentsOnboardedResponse.md} (52%) create mode 100644 docs/CreateBookingRequest.md rename docs/{CreateCatalogImageResponse.md => CreateBookingResponse.md} (53%) delete mode 100644 docs/CreateCatalogImageRequest.md delete mode 100644 docs/CreateDisputeEvidenceFileRequest.md create mode 100644 docs/ListTeamMemberBookingProfilesRequest.md create mode 100644 docs/ListTeamMemberBookingProfilesResponse.md create mode 100644 docs/OnboardAppointmentsRequest.md create mode 100644 docs/OnboardAppointmentsResponse.md create mode 100644 docs/README.md create mode 100644 docs/RetrieveBookingRequest.md create mode 100644 docs/RetrieveBookingResponse.md create mode 100644 docs/RetrieveBusinessBookingProfileRequest.md create mode 100644 docs/RetrieveBusinessBookingProfileResponse.md create mode 100644 docs/RetrieveObsMigrationProfileRequest.md create mode 100644 docs/RetrieveObsMigrationProfileResponse.md create mode 100644 docs/RetrieveTeamMemberBookingProfileRequest.md create mode 100644 docs/RetrieveTeamMemberBookingProfileResponse.md create mode 100644 docs/RiskEvaluation.md create mode 100644 docs/RiskEvaluationRiskLevel.md create mode 100644 docs/SearchAvailabilityFilter.md create mode 100644 docs/SearchAvailabilityQuery.md create mode 100644 docs/SearchAvailabilityRequest.md create mode 100644 docs/SearchAvailabilityResponse.md create mode 100644 docs/SegmentFilter.md create mode 100644 docs/TeamMemberBookingProfile.md create mode 100644 docs/UpdateBookingRequest.md create mode 100644 docs/UpdateBookingResponse.md delete mode 100644 docs/VersionedCatalogObject.md create mode 100644 src/api/BookingsApi.js create mode 100644 src/model/AppointmentSegment.js create mode 100644 src/model/Availability.js create mode 100644 src/model/Booking.js create mode 100644 src/model/BookingStatus.js create mode 100644 src/model/BusinessAppointmentSettings.js create mode 100644 src/model/BusinessAppointmentSettingsAlignmentTime.js create mode 100644 src/model/BusinessAppointmentSettingsBookingLocationType.js create mode 100644 src/model/BusinessAppointmentSettingsCancellationPolicy.js create mode 100644 src/model/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.js create mode 100644 src/model/BusinessBookingProfile.js create mode 100644 src/model/BusinessBookingProfileBookingPolicy.js create mode 100644 src/model/BusinessBookingProfileCustomerTimezoneChoice.js create mode 100644 src/model/CheckAppointmentsOnboardedRequest.js rename src/model/{CreateDisputeEvidenceFileResponse.js => CheckAppointmentsOnboardedResponse.js} (54%) create mode 100644 src/model/CreateBookingRequest.js create mode 100644 src/model/CreateBookingResponse.js delete mode 100644 src/model/CreateCatalogImageRequest.js delete mode 100644 src/model/CreateDisputeEvidenceFileRequest.js create mode 100644 src/model/ListTeamMemberBookingProfilesRequest.js create mode 100644 src/model/ListTeamMemberBookingProfilesResponse.js create mode 100644 src/model/OnboardAppointmentsRequest.js create mode 100644 src/model/OnboardAppointmentsResponse.js create mode 100644 src/model/RetrieveBookingRequest.js create mode 100644 src/model/RetrieveBookingResponse.js create mode 100644 src/model/RetrieveBusinessBookingProfileRequest.js create mode 100644 src/model/RetrieveBusinessBookingProfileResponse.js create mode 100644 src/model/RetrieveObsMigrationProfileRequest.js create mode 100644 src/model/RetrieveObsMigrationProfileResponse.js create mode 100644 src/model/RetrieveTeamMemberBookingProfileRequest.js create mode 100644 src/model/RetrieveTeamMemberBookingProfileResponse.js create mode 100644 src/model/RiskEvaluation.js create mode 100644 src/model/RiskEvaluationRiskLevel.js create mode 100644 src/model/SearchAvailabilityFilter.js create mode 100644 src/model/SearchAvailabilityQuery.js create mode 100644 src/model/SearchAvailabilityRequest.js rename src/model/{CreateCatalogImageResponse.js => SearchAvailabilityResponse.js} (59%) create mode 100644 src/model/SegmentFilter.js create mode 100644 src/model/TeamMemberBookingProfile.js create mode 100644 src/model/UpdateBookingRequest.js create mode 100644 src/model/UpdateBookingResponse.js delete mode 100644 src/model/VersionedCatalogObject.js create mode 100644 test/api/BookingsApi.spec.js create mode 100644 test/model/AppointmentSegment.spec.js create mode 100644 test/model/Availability.spec.js create mode 100644 test/model/Booking.spec.js create mode 100644 test/model/BookingStatus.spec.js create mode 100644 test/model/BusinessAppointmentSettings.spec.js create mode 100644 test/model/BusinessAppointmentSettingsAlignmentTime.spec.js create mode 100644 test/model/BusinessAppointmentSettingsBookingLocationType.spec.js create mode 100644 test/model/BusinessAppointmentSettingsCancellationPolicy.spec.js create mode 100644 test/model/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.spec.js create mode 100644 test/model/BusinessBookingProfile.spec.js create mode 100644 test/model/BusinessBookingProfileBookingPolicy.spec.js create mode 100644 test/model/BusinessBookingProfileCustomerTimezoneChoice.spec.js create mode 100644 test/model/CheckAppointmentsOnboardedRequest.spec.js create mode 100644 test/model/CheckAppointmentsOnboardedResponse.spec.js create mode 100644 test/model/CreateBookingRequest.spec.js create mode 100644 test/model/CreateBookingResponse.spec.js create mode 100644 test/model/ListTeamMemberBookingProfilesRequest.spec.js create mode 100644 test/model/ListTeamMemberBookingProfilesResponse.spec.js create mode 100644 test/model/OnboardAppointmentsRequest.spec.js create mode 100644 test/model/OnboardAppointmentsResponse.spec.js create mode 100644 test/model/RetrieveBookingRequest.spec.js create mode 100644 test/model/RetrieveBookingResponse.spec.js create mode 100644 test/model/RetrieveBusinessBookingProfileRequest.spec.js create mode 100644 test/model/RetrieveBusinessBookingProfileResponse.spec.js create mode 100644 test/model/RetrieveObsMigrationProfileRequest.spec.js create mode 100644 test/model/RetrieveObsMigrationProfileResponse.spec.js create mode 100644 test/model/RetrieveTeamMemberBookingProfileRequest.spec.js create mode 100644 test/model/RetrieveTeamMemberBookingProfileResponse.spec.js create mode 100644 test/model/RiskEvaluation.spec.js create mode 100644 test/model/RiskEvaluationRiskLevel.spec.js create mode 100644 test/model/SearchAvailabilityFilter.spec.js create mode 100644 test/model/SearchAvailabilityQuery.spec.js create mode 100644 test/model/SearchAvailabilityRequest.spec.js create mode 100644 test/model/SearchAvailabilityResponse.spec.js create mode 100644 test/model/SegmentFilter.spec.js create mode 100644 test/model/TeamMemberBookingProfile.spec.js create mode 100644 test/model/UpdateBookingRequest.spec.js create mode 100644 test/model/UpdateBookingResponse.spec.js diff --git a/CHANGES.md b/CHANGES.md index ba8e02e..4fb969b 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,5 +1,31 @@ # Change Log +## Version 5.20201118.0 (2020-11-18T00:00) +## New API releases + +* **Bookings API** (beta). The Bookings API lets you create applications to set up and manage bookings for appointments of fixed duration in which selected staff members of a Square seller provide specified services in supported locations for particular customers. + * For an overview, see [Manage Bookings for Square Sellers.](https://developer.squareup.com/docs/bookings-api/what-it-is) + * For technical reference, see [Bookings API](https://developer.squareup.com/reference/square_2020-11-18/bookings-api). + +## Existing API updates + +* **Payments API:** + * [Payment.](https://developer.squareup.com/reference/square_2020-11-18/objects/Payment) The object now includes the `risk_evaluation` field to identify the Square-assigned risk level associated with the payment. Sellers can use this information to provide the goods and services or refund the payment. + +## New SDK release +* **New Square Node.js SDK (beta)** + + The new [Square Node.js SDK](https://github.com/square/square-nodejs-sdk) is available in beta and will eventually replace the deprecated Connect Node.js SDK. For migration information, see the [Connect SDK README.](https://github.com/square/connect-nodejs-sdk/blob/master/README.md) The following topics are updated to use the new SDK: + * [Walkthrough: Integrate Square Payments in a Website](https://developer.squareup.com/docs/payment-form/payment-form-walkthrough) + * [Verify the Buyer When Using a Nonce for an Online Payment](https://developer.squareup.com/docs/payment-form/cookbook/verify-buyer-on-card-charge) + * [Create a Gift Card Payment Endpoint](https://developer.squareup.com/docs/payment-form/gift-cards/part-2) + +## Documentation updates + +* The Testing topics are moved from the end of the table of contents to the top, in the Home section under [Testing your Application.](https://developer.squareup.com/docs/testing-your-app) +* [Pay for Orders.](https://developer.squareup.com/docs/orders-api/pay-for-orders) The topic is revised to add clarity for when to use the Payments API and Orders API to pay for an order. The [Orders integration](https://developer.squareup.com/docs/payments-api/take-payments?preview=true#orders-integration) section for the Payments API is simplified accordingly. + + ## Version 4.20201028.5 (2020-10-28T00:00) ## Existing API updates @@ -247,8 +273,8 @@ ## Version 3.20200325.0 (2020-03-25) ## Existing API updates -* **[Payments API](https://developer.squareup.com/reference/square/payments-api).** In support of the existing [Delayed capture](payments-api/take-payments) for payments, the following fields are added to the [Payment](https://developer.squareup.com/reference/square/objects/Payment) type: - * `delay_duration`. In a [CreatePayment](https://developer.squareup.com/reference/square/payments-api/create-payment) request, you can set `autocomplete` to false to get payment approval but not charge the payment source. You can now add this field to specify a time period to complete (or cancel) the payment. For more information, see [Delay capture](payments-api/take-payments). +* **[Payments API](https://developer.squareup.com/reference/square/payments-api).** In support of the existing [Delayed capturehttps://developer.squareup.com/docs/payments-api/take-payments) for payments, the following fields are added to the [Payment](https://developer.squareup.com/reference/square/objects/Payment) type: + * `delay_duration`. In a [CreatePayment](https://developer.squareup.com/reference/square/payments-api/create-payment) request, you can set `autocomplete` to false to get payment approval but not charge the payment source. You can now add this field to specify a time period to complete (or cancel) the payment. For more information, see [Delay capturehttps://developer.squareup.com/docs/payments-api/take-payments). * `delay_action`. Defines the action that Square takes on the payment when the `delay_duration` elapses. In this release, the API supports only the cancel payment action. * `delayed_until`. Provides the date and time on Square servers when Square applies `delay_action` on the payment. diff --git a/README.md b/README.md index c997d06..c4205f2 100644 --- a/README.md +++ b/README.md @@ -1,1191 +1,214 @@ -![Square logo] - -# Square Connect Node SDK +# Square Connect Node.js SDK - DEPRECATED --- [![Build Status](https://travis-ci.org/square/connect-nodejs-sdk.svg?branch=master)](https://travis-ci.org/square/connect-nodejs-sdk) -[![npm version](https://badge.fury.io/js/square-connect.svg)](https://badge.fury.io/js/square-connect) +[![Node.js version](https://badge.fury.io/ph/square%2Fconnect.svg)](https://badge.fury.io/ph/square%2Fconnect) [![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0) ================== -## NOTICE: Square Connect Node.js SDK deprecated -This Square Connect SDK will enter a security maintenance phase in Q4 2020 and will be RETIRED (EOL) in Q2 2021. In the security -maintenance phase, this SDK will continue to receive support and security patches but will no longer receive bug fixes or product -updates. Once it is retired, support and security patches will no longer be available. A new SDK, more bespoke to the language, will be available once this SDK enters its security maintenance phase. -The SDK itself will continue to work indefinitely until such time that the underlying APIs are retired at which point portions of the SDK may stop functioning. For a full list of API retirement dates, please see our [Square API Lifecycle documentation](https://developer.squareup.com/docs/build-basics/api-lifecycle#deprecated-apis). - -| Security Maintenance | New SDK Release | Retired (EOL) | -| ------------- |-------------| -----| -| Q4, 2020 | Q4, 2020 | Q2, 2021 | -**If you have feedback about the new SDKs, or just want to talk to other Square Developers, request an invite to the new [slack community for Square Developers](https://squ.re/2uLSRw5)** +## NOTICE: The Square Connect Node.js SDK is deprecated and will be replaced by [square/square-nodejs-sdk] (currently in beta) +This Square Connect Node.js SDK is deprecated. The SDK will enter a security maintenance phase in Q4 2020 and will be RETIRED (EOL) in Q2 2021. In the security maintenance phase, the SDK will continue to receive support and security patches but will no longer receive bug fixes or product updates. Once it is retired, support and security patches will no longer be available. +The SDK itself will continue to work indefinitely until such time that the underlying APIs are retired, at which point portions of the SDK may stop functioning. For a full list of API retirement dates, please see our [Square API Lifecycle documentation]. -## Requirements +| Security Maintenance | Retired (EOL) | +| -------- | -------- | +| Q4, 2020 | Q2, 2021 | -Node.js 6.0 or later +To ensure that you continue to receive API updates and SDK improvements, you should plan to migrate to the new [Square Node.js SDK] after it reaches GA. Please follow the instructions below to migrate to the new SDK. -## Installation +The old Connect SDK documentation is available under the [/docs] folder. -### For [Node.js](https://nodejs.org/) +
-To install the SDK: +--- -```shell -npm install square-connect --save -``` +* [Migrate to the Square Node.js SDK](#migrate-to-the-square-nodejs-sdk) + * [Install the SDK](#install-the-sdk) + * [Update your code](#update-your-code) +* [Example code migration](#example-code-migration) +* [Ask the Community](#ask-the-community) -## Getting Started +--- -Please follow the [installation](#installation) instruction and execute the following JS code: +
-```javascript -var SquareConnect = require('square-connect'); -var defaultClient = SquareConnect.ApiClient.instance; +## Migrate to the Square Node.js SDK -// Configure OAuth2 access token for authorization: oauth2 -var oauth2 = defaultClient.authentications['oauth2']; -oauth2.accessToken = "YOUR ACCESS TOKEN"; +Follow the instructions below to migrate your apps from this deprecated Connect Node.js SDK to the new [Square Node.js SDK] after it reaches GA. You need to install the new SDK and update your application code. -var api = new SquareConnect.LocationsApi(); +### Install the SDK -api.listLocations().then(function(data) { - console.log('API called successfully. Returned data: ' + JSON.stringify(data, 0, 1)); -}, function(error) { - console.error(error); -}); +#### Option 1: Install the latest SDK version using npm +```sh +$ npm install square ``` -### How to configure sandbox environment -```javascript -var SquareConnect = require('square-connect'); -var defaultClient = SquareConnect.ApiClient.instance; -// Set sandbox url -defaultClient.basePath = 'https://connect.squareupsandbox.com'; -// Configure OAuth2 access token for authorization: oauth2 -var oauth2 = defaultClient.authentications['oauth2']; -// Set sandbox access token -oauth2.accessToken = "YOUR SANDBOX ACCESS TOKEN"; -// Pass client to API -var api = new SquareConnect.LocationsApi(); +#### Option 2: Install the latest SDK version using GitHub +First clone the repo: +```sh +git clone https://github.com/square/square-nodejs-sdk.git +``` +Then, build the SDK: +```sh +$ cd square-nodejs-sdk +$ npm link +``` +Lastly, run the following in the directory that contains your code: +```sh +$ npm link square ``` -## Documentation for API Endpoints +### Update your application code +Make the following changes to migrate your application code to the new Square SDK: -All URIs are relative to *https://connect.squareup.com* +1. Change all instances that import the `square-connect` library to import the `square` library. +1. Update the instantiation and initialization of the API client to follow the method described below. +1. Replace `square-connect` models with the new `square` equivalents with camel case parameter names. +1. Update code for calling Square APIs and accessing response data to follow the method described below. -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- -*SquareConnect.ApplePayApi* | [**registerDomain**](docs/ApplePayApi.md#registerDomain) | **POST** /v2/apple-pay/domains | RegisterDomain -*SquareConnect.BankAccountsApi* | [**getBankAccount**](docs/BankAccountsApi.md#getBankAccount) | **GET** /v2/bank-accounts/{bank_account_id} | GetBankAccount -*SquareConnect.BankAccountsApi* | [**getBankAccountByV1Id**](docs/BankAccountsApi.md#getBankAccountByV1Id) | **GET** /v2/bank-accounts/by-v1-id/{v1_bank_account_id} | GetBankAccountByV1Id -*SquareConnect.BankAccountsApi* | [**listBankAccounts**](docs/BankAccountsApi.md#listBankAccounts) | **GET** /v2/bank-accounts | ListBankAccounts -*SquareConnect.CashDrawersApi* | [**listCashDrawerShiftEvents**](docs/CashDrawersApi.md#listCashDrawerShiftEvents) | **GET** /v2/cash-drawers/shifts/{shift_id}/events | ListCashDrawerShiftEvents -*SquareConnect.CashDrawersApi* | [**listCashDrawerShifts**](docs/CashDrawersApi.md#listCashDrawerShifts) | **GET** /v2/cash-drawers/shifts | ListCashDrawerShifts -*SquareConnect.CashDrawersApi* | [**retrieveCashDrawerShift**](docs/CashDrawersApi.md#retrieveCashDrawerShift) | **GET** /v2/cash-drawers/shifts/{shift_id} | RetrieveCashDrawerShift -*SquareConnect.CatalogApi* | [**batchDeleteCatalogObjects**](docs/CatalogApi.md#batchDeleteCatalogObjects) | **POST** /v2/catalog/batch-delete | BatchDeleteCatalogObjects -*SquareConnect.CatalogApi* | [**batchRetrieveCatalogObjects**](docs/CatalogApi.md#batchRetrieveCatalogObjects) | **POST** /v2/catalog/batch-retrieve | BatchRetrieveCatalogObjects -*SquareConnect.CatalogApi* | [**batchUpsertCatalogObjects**](docs/CatalogApi.md#batchUpsertCatalogObjects) | **POST** /v2/catalog/batch-upsert | BatchUpsertCatalogObjects -*SquareConnect.CatalogApi* | [**catalogInfo**](docs/CatalogApi.md#catalogInfo) | **GET** /v2/catalog/info | CatalogInfo -*SquareConnect.CatalogApi* | [**deleteCatalogObject**](docs/CatalogApi.md#deleteCatalogObject) | **DELETE** /v2/catalog/object/{object_id} | DeleteCatalogObject -*SquareConnect.CatalogApi* | [**listCatalog**](docs/CatalogApi.md#listCatalog) | **GET** /v2/catalog/list | ListCatalog -*SquareConnect.CatalogApi* | [**retrieveCatalogObject**](docs/CatalogApi.md#retrieveCatalogObject) | **GET** /v2/catalog/object/{object_id} | RetrieveCatalogObject -*SquareConnect.CatalogApi* | [**searchCatalogItems**](docs/CatalogApi.md#searchCatalogItems) | **POST** /v2/catalog/search-catalog-items | SearchCatalogItems -*SquareConnect.CatalogApi* | [**searchCatalogObjects**](docs/CatalogApi.md#searchCatalogObjects) | **POST** /v2/catalog/search | SearchCatalogObjects -*SquareConnect.CatalogApi* | [**updateItemModifierLists**](docs/CatalogApi.md#updateItemModifierLists) | **POST** /v2/catalog/update-item-modifier-lists | UpdateItemModifierLists -*SquareConnect.CatalogApi* | [**updateItemTaxes**](docs/CatalogApi.md#updateItemTaxes) | **POST** /v2/catalog/update-item-taxes | UpdateItemTaxes -*SquareConnect.CatalogApi* | [**upsertCatalogObject**](docs/CatalogApi.md#upsertCatalogObject) | **POST** /v2/catalog/object | UpsertCatalogObject -*SquareConnect.CheckoutApi* | [**createCheckout**](docs/CheckoutApi.md#createCheckout) | **POST** /v2/locations/{location_id}/checkouts | CreateCheckout -*SquareConnect.CustomerGroupsApi* | [**createCustomerGroup**](docs/CustomerGroupsApi.md#createCustomerGroup) | **POST** /v2/customers/groups | CreateCustomerGroup -*SquareConnect.CustomerGroupsApi* | [**deleteCustomerGroup**](docs/CustomerGroupsApi.md#deleteCustomerGroup) | **DELETE** /v2/customers/groups/{group_id} | DeleteCustomerGroup -*SquareConnect.CustomerGroupsApi* | [**listCustomerGroups**](docs/CustomerGroupsApi.md#listCustomerGroups) | **GET** /v2/customers/groups | ListCustomerGroups -*SquareConnect.CustomerGroupsApi* | [**retrieveCustomerGroup**](docs/CustomerGroupsApi.md#retrieveCustomerGroup) | **GET** /v2/customers/groups/{group_id} | RetrieveCustomerGroup -*SquareConnect.CustomerGroupsApi* | [**updateCustomerGroup**](docs/CustomerGroupsApi.md#updateCustomerGroup) | **PUT** /v2/customers/groups/{group_id} | UpdateCustomerGroup -*SquareConnect.CustomerSegmentsApi* | [**listCustomerSegments**](docs/CustomerSegmentsApi.md#listCustomerSegments) | **GET** /v2/customers/segments | ListCustomerSegments -*SquareConnect.CustomerSegmentsApi* | [**retrieveCustomerSegment**](docs/CustomerSegmentsApi.md#retrieveCustomerSegment) | **GET** /v2/customers/segments/{segment_id} | RetrieveCustomerSegment -*SquareConnect.CustomersApi* | [**addGroupToCustomer**](docs/CustomersApi.md#addGroupToCustomer) | **PUT** /v2/customers/{customer_id}/groups/{group_id} | AddGroupToCustomer -*SquareConnect.CustomersApi* | [**createCustomer**](docs/CustomersApi.md#createCustomer) | **POST** /v2/customers | CreateCustomer -*SquareConnect.CustomersApi* | [**createCustomerCard**](docs/CustomersApi.md#createCustomerCard) | **POST** /v2/customers/{customer_id}/cards | CreateCustomerCard -*SquareConnect.CustomersApi* | [**deleteCustomer**](docs/CustomersApi.md#deleteCustomer) | **DELETE** /v2/customers/{customer_id} | DeleteCustomer -*SquareConnect.CustomersApi* | [**deleteCustomerCard**](docs/CustomersApi.md#deleteCustomerCard) | **DELETE** /v2/customers/{customer_id}/cards/{card_id} | DeleteCustomerCard -*SquareConnect.CustomersApi* | [**listCustomers**](docs/CustomersApi.md#listCustomers) | **GET** /v2/customers | ListCustomers -*SquareConnect.CustomersApi* | [**removeGroupFromCustomer**](docs/CustomersApi.md#removeGroupFromCustomer) | **DELETE** /v2/customers/{customer_id}/groups/{group_id} | RemoveGroupFromCustomer -*SquareConnect.CustomersApi* | [**retrieveCustomer**](docs/CustomersApi.md#retrieveCustomer) | **GET** /v2/customers/{customer_id} | RetrieveCustomer -*SquareConnect.CustomersApi* | [**searchCustomers**](docs/CustomersApi.md#searchCustomers) | **POST** /v2/customers/search | SearchCustomers -*SquareConnect.CustomersApi* | [**updateCustomer**](docs/CustomersApi.md#updateCustomer) | **PUT** /v2/customers/{customer_id} | UpdateCustomer -*SquareConnect.DevicesApi* | [**createDeviceCode**](docs/DevicesApi.md#createDeviceCode) | **POST** /v2/devices/codes | CreateDeviceCode -*SquareConnect.DevicesApi* | [**getDeviceCode**](docs/DevicesApi.md#getDeviceCode) | **GET** /v2/devices/codes/{id} | GetDeviceCode -*SquareConnect.DevicesApi* | [**listDeviceCodes**](docs/DevicesApi.md#listDeviceCodes) | **GET** /v2/devices/codes | ListDeviceCodes -*SquareConnect.DisputesApi* | [**acceptDispute**](docs/DisputesApi.md#acceptDispute) | **POST** /v2/disputes/{dispute_id}/accept | AcceptDispute -*SquareConnect.DisputesApi* | [**createDisputeEvidenceText**](docs/DisputesApi.md#createDisputeEvidenceText) | **POST** /v2/disputes/{dispute_id}/evidence_text | CreateDisputeEvidenceText -*SquareConnect.DisputesApi* | [**listDisputeEvidence**](docs/DisputesApi.md#listDisputeEvidence) | **GET** /v2/disputes/{dispute_id}/evidence | ListDisputeEvidence -*SquareConnect.DisputesApi* | [**listDisputes**](docs/DisputesApi.md#listDisputes) | **GET** /v2/disputes | ListDisputes -*SquareConnect.DisputesApi* | [**removeDisputeEvidence**](docs/DisputesApi.md#removeDisputeEvidence) | **DELETE** /v2/disputes/{dispute_id}/evidence/{evidence_id} | RemoveDisputeEvidence -*SquareConnect.DisputesApi* | [**retrieveDispute**](docs/DisputesApi.md#retrieveDispute) | **GET** /v2/disputes/{dispute_id} | RetrieveDispute -*SquareConnect.DisputesApi* | [**retrieveDisputeEvidence**](docs/DisputesApi.md#retrieveDisputeEvidence) | **GET** /v2/disputes/{dispute_id}/evidence/{evidence_id} | RetrieveDisputeEvidence -*SquareConnect.DisputesApi* | [**submitEvidence**](docs/DisputesApi.md#submitEvidence) | **POST** /v2/disputes/{dispute_id}/submit-evidence | SubmitEvidence -*SquareConnect.EmployeesApi* | [**listEmployees**](docs/EmployeesApi.md#listEmployees) | **GET** /v2/employees | ListEmployees -*SquareConnect.EmployeesApi* | [**retrieveEmployee**](docs/EmployeesApi.md#retrieveEmployee) | **GET** /v2/employees/{id} | RetrieveEmployee -*SquareConnect.InventoryApi* | [**batchChangeInventory**](docs/InventoryApi.md#batchChangeInventory) | **POST** /v2/inventory/batch-change | BatchChangeInventory -*SquareConnect.InventoryApi* | [**batchRetrieveInventoryChanges**](docs/InventoryApi.md#batchRetrieveInventoryChanges) | **POST** /v2/inventory/batch-retrieve-changes | BatchRetrieveInventoryChanges -*SquareConnect.InventoryApi* | [**batchRetrieveInventoryCounts**](docs/InventoryApi.md#batchRetrieveInventoryCounts) | **POST** /v2/inventory/batch-retrieve-counts | BatchRetrieveInventoryCounts -*SquareConnect.InventoryApi* | [**retrieveInventoryAdjustment**](docs/InventoryApi.md#retrieveInventoryAdjustment) | **GET** /v2/inventory/adjustment/{adjustment_id} | RetrieveInventoryAdjustment -*SquareConnect.InventoryApi* | [**retrieveInventoryChanges**](docs/InventoryApi.md#retrieveInventoryChanges) | **GET** /v2/inventory/{catalog_object_id}/changes | RetrieveInventoryChanges -*SquareConnect.InventoryApi* | [**retrieveInventoryCount**](docs/InventoryApi.md#retrieveInventoryCount) | **GET** /v2/inventory/{catalog_object_id} | RetrieveInventoryCount -*SquareConnect.InventoryApi* | [**retrieveInventoryPhysicalCount**](docs/InventoryApi.md#retrieveInventoryPhysicalCount) | **GET** /v2/inventory/physical-count/{physical_count_id} | RetrieveInventoryPhysicalCount -*SquareConnect.InvoicesApi* | [**cancelInvoice**](docs/InvoicesApi.md#cancelInvoice) | **POST** /v2/invoices/{invoice_id}/cancel | CancelInvoice -*SquareConnect.InvoicesApi* | [**createInvoice**](docs/InvoicesApi.md#createInvoice) | **POST** /v2/invoices | CreateInvoice -*SquareConnect.InvoicesApi* | [**deleteInvoice**](docs/InvoicesApi.md#deleteInvoice) | **DELETE** /v2/invoices/{invoice_id} | DeleteInvoice -*SquareConnect.InvoicesApi* | [**getInvoice**](docs/InvoicesApi.md#getInvoice) | **GET** /v2/invoices/{invoice_id} | GetInvoice -*SquareConnect.InvoicesApi* | [**listInvoices**](docs/InvoicesApi.md#listInvoices) | **GET** /v2/invoices | ListInvoices -*SquareConnect.InvoicesApi* | [**publishInvoice**](docs/InvoicesApi.md#publishInvoice) | **POST** /v2/invoices/{invoice_id}/publish | PublishInvoice -*SquareConnect.InvoicesApi* | [**searchInvoices**](docs/InvoicesApi.md#searchInvoices) | **POST** /v2/invoices/search | SearchInvoices -*SquareConnect.InvoicesApi* | [**updateInvoice**](docs/InvoicesApi.md#updateInvoice) | **PUT** /v2/invoices/{invoice_id} | UpdateInvoice -*SquareConnect.LaborApi* | [**createBreakType**](docs/LaborApi.md#createBreakType) | **POST** /v2/labor/break-types | CreateBreakType -*SquareConnect.LaborApi* | [**createShift**](docs/LaborApi.md#createShift) | **POST** /v2/labor/shifts | CreateShift -*SquareConnect.LaborApi* | [**deleteBreakType**](docs/LaborApi.md#deleteBreakType) | **DELETE** /v2/labor/break-types/{id} | DeleteBreakType -*SquareConnect.LaborApi* | [**deleteShift**](docs/LaborApi.md#deleteShift) | **DELETE** /v2/labor/shifts/{id} | DeleteShift -*SquareConnect.LaborApi* | [**getBreakType**](docs/LaborApi.md#getBreakType) | **GET** /v2/labor/break-types/{id} | GetBreakType -*SquareConnect.LaborApi* | [**getEmployeeWage**](docs/LaborApi.md#getEmployeeWage) | **GET** /v2/labor/employee-wages/{id} | GetEmployeeWage -*SquareConnect.LaborApi* | [**getShift**](docs/LaborApi.md#getShift) | **GET** /v2/labor/shifts/{id} | GetShift -*SquareConnect.LaborApi* | [**getTeamMemberWage**](docs/LaborApi.md#getTeamMemberWage) | **GET** /v2/labor/team-member-wages/{id} | GetTeamMemberWage -*SquareConnect.LaborApi* | [**listBreakTypes**](docs/LaborApi.md#listBreakTypes) | **GET** /v2/labor/break-types | ListBreakTypes -*SquareConnect.LaborApi* | [**listEmployeeWages**](docs/LaborApi.md#listEmployeeWages) | **GET** /v2/labor/employee-wages | ListEmployeeWages -*SquareConnect.LaborApi* | [**listTeamMemberWages**](docs/LaborApi.md#listTeamMemberWages) | **GET** /v2/labor/team-member-wages | ListTeamMemberWages -*SquareConnect.LaborApi* | [**listWorkweekConfigs**](docs/LaborApi.md#listWorkweekConfigs) | **GET** /v2/labor/workweek-configs | ListWorkweekConfigs -*SquareConnect.LaborApi* | [**searchShifts**](docs/LaborApi.md#searchShifts) | **POST** /v2/labor/shifts/search | SearchShifts -*SquareConnect.LaborApi* | [**updateBreakType**](docs/LaborApi.md#updateBreakType) | **PUT** /v2/labor/break-types/{id} | UpdateBreakType -*SquareConnect.LaborApi* | [**updateShift**](docs/LaborApi.md#updateShift) | **PUT** /v2/labor/shifts/{id} | UpdateShift -*SquareConnect.LaborApi* | [**updateWorkweekConfig**](docs/LaborApi.md#updateWorkweekConfig) | **PUT** /v2/labor/workweek-configs/{id} | UpdateWorkweekConfig -*SquareConnect.LocationsApi* | [**createLocation**](docs/LocationsApi.md#createLocation) | **POST** /v2/locations | CreateLocation -*SquareConnect.LocationsApi* | [**listLocations**](docs/LocationsApi.md#listLocations) | **GET** /v2/locations | ListLocations -*SquareConnect.LocationsApi* | [**retrieveLocation**](docs/LocationsApi.md#retrieveLocation) | **GET** /v2/locations/{location_id} | RetrieveLocation -*SquareConnect.LocationsApi* | [**updateLocation**](docs/LocationsApi.md#updateLocation) | **PUT** /v2/locations/{location_id} | UpdateLocation -*SquareConnect.LoyaltyApi* | [**accumulateLoyaltyPoints**](docs/LoyaltyApi.md#accumulateLoyaltyPoints) | **POST** /v2/loyalty/accounts/{account_id}/accumulate | AccumulateLoyaltyPoints -*SquareConnect.LoyaltyApi* | [**adjustLoyaltyPoints**](docs/LoyaltyApi.md#adjustLoyaltyPoints) | **POST** /v2/loyalty/accounts/{account_id}/adjust | AdjustLoyaltyPoints -*SquareConnect.LoyaltyApi* | [**calculateLoyaltyPoints**](docs/LoyaltyApi.md#calculateLoyaltyPoints) | **POST** /v2/loyalty/programs/{program_id}/calculate | CalculateLoyaltyPoints -*SquareConnect.LoyaltyApi* | [**createLoyaltyAccount**](docs/LoyaltyApi.md#createLoyaltyAccount) | **POST** /v2/loyalty/accounts | CreateLoyaltyAccount -*SquareConnect.LoyaltyApi* | [**createLoyaltyReward**](docs/LoyaltyApi.md#createLoyaltyReward) | **POST** /v2/loyalty/rewards | CreateLoyaltyReward -*SquareConnect.LoyaltyApi* | [**deleteLoyaltyReward**](docs/LoyaltyApi.md#deleteLoyaltyReward) | **DELETE** /v2/loyalty/rewards/{reward_id} | DeleteLoyaltyReward -*SquareConnect.LoyaltyApi* | [**listLoyaltyPrograms**](docs/LoyaltyApi.md#listLoyaltyPrograms) | **GET** /v2/loyalty/programs | ListLoyaltyPrograms -*SquareConnect.LoyaltyApi* | [**redeemLoyaltyReward**](docs/LoyaltyApi.md#redeemLoyaltyReward) | **POST** /v2/loyalty/rewards/{reward_id}/redeem | RedeemLoyaltyReward -*SquareConnect.LoyaltyApi* | [**retrieveLoyaltyAccount**](docs/LoyaltyApi.md#retrieveLoyaltyAccount) | **GET** /v2/loyalty/accounts/{account_id} | RetrieveLoyaltyAccount -*SquareConnect.LoyaltyApi* | [**retrieveLoyaltyReward**](docs/LoyaltyApi.md#retrieveLoyaltyReward) | **GET** /v2/loyalty/rewards/{reward_id} | RetrieveLoyaltyReward -*SquareConnect.LoyaltyApi* | [**searchLoyaltyAccounts**](docs/LoyaltyApi.md#searchLoyaltyAccounts) | **POST** /v2/loyalty/accounts/search | SearchLoyaltyAccounts -*SquareConnect.LoyaltyApi* | [**searchLoyaltyEvents**](docs/LoyaltyApi.md#searchLoyaltyEvents) | **POST** /v2/loyalty/events/search | SearchLoyaltyEvents -*SquareConnect.LoyaltyApi* | [**searchLoyaltyRewards**](docs/LoyaltyApi.md#searchLoyaltyRewards) | **POST** /v2/loyalty/rewards/search | SearchLoyaltyRewards -*SquareConnect.MerchantsApi* | [**listMerchants**](docs/MerchantsApi.md#listMerchants) | **GET** /v2/merchants | ListMerchants -*SquareConnect.MerchantsApi* | [**retrieveMerchant**](docs/MerchantsApi.md#retrieveMerchant) | **GET** /v2/merchants/{merchant_id} | RetrieveMerchant -*SquareConnect.MobileAuthorizationApi* | [**createMobileAuthorizationCode**](docs/MobileAuthorizationApi.md#createMobileAuthorizationCode) | **POST** /mobile/authorization-code | CreateMobileAuthorizationCode -*SquareConnect.OAuthApi* | [**obtainToken**](docs/OAuthApi.md#obtainToken) | **POST** /oauth2/token | ObtainToken -*SquareConnect.OAuthApi* | [**renewToken**](docs/OAuthApi.md#renewToken) | **POST** /oauth2/clients/{client_id}/access-token/renew | RenewToken -*SquareConnect.OAuthApi* | [**revokeToken**](docs/OAuthApi.md#revokeToken) | **POST** /oauth2/revoke | RevokeToken -*SquareConnect.OrdersApi* | [**batchRetrieveOrders**](docs/OrdersApi.md#batchRetrieveOrders) | **POST** /v2/orders/batch-retrieve | BatchRetrieveOrders -*SquareConnect.OrdersApi* | [**calculateOrder**](docs/OrdersApi.md#calculateOrder) | **POST** /v2/orders/calculate | CalculateOrder -*SquareConnect.OrdersApi* | [**createOrder**](docs/OrdersApi.md#createOrder) | **POST** /v2/orders | CreateOrder -*SquareConnect.OrdersApi* | [**payOrder**](docs/OrdersApi.md#payOrder) | **POST** /v2/orders/{order_id}/pay | PayOrder -*SquareConnect.OrdersApi* | [**retrieveOrder**](docs/OrdersApi.md#retrieveOrder) | **GET** /v2/orders/{order_id} | RetrieveOrder -*SquareConnect.OrdersApi* | [**searchOrders**](docs/OrdersApi.md#searchOrders) | **POST** /v2/orders/search | SearchOrders -*SquareConnect.OrdersApi* | [**updateOrder**](docs/OrdersApi.md#updateOrder) | **PUT** /v2/orders/{order_id} | UpdateOrder -*SquareConnect.PaymentsApi* | [**cancelPayment**](docs/PaymentsApi.md#cancelPayment) | **POST** /v2/payments/{payment_id}/cancel | CancelPayment -*SquareConnect.PaymentsApi* | [**cancelPaymentByIdempotencyKey**](docs/PaymentsApi.md#cancelPaymentByIdempotencyKey) | **POST** /v2/payments/cancel | CancelPaymentByIdempotencyKey -*SquareConnect.PaymentsApi* | [**completePayment**](docs/PaymentsApi.md#completePayment) | **POST** /v2/payments/{payment_id}/complete | CompletePayment -*SquareConnect.PaymentsApi* | [**createPayment**](docs/PaymentsApi.md#createPayment) | **POST** /v2/payments | CreatePayment -*SquareConnect.PaymentsApi* | [**getPayment**](docs/PaymentsApi.md#getPayment) | **GET** /v2/payments/{payment_id} | GetPayment -*SquareConnect.PaymentsApi* | [**listPayments**](docs/PaymentsApi.md#listPayments) | **GET** /v2/payments | ListPayments -*SquareConnect.RefundsApi* | [**getPaymentRefund**](docs/RefundsApi.md#getPaymentRefund) | **GET** /v2/refunds/{refund_id} | GetPaymentRefund -*SquareConnect.RefundsApi* | [**listPaymentRefunds**](docs/RefundsApi.md#listPaymentRefunds) | **GET** /v2/refunds | ListPaymentRefunds -*SquareConnect.RefundsApi* | [**refundPayment**](docs/RefundsApi.md#refundPayment) | **POST** /v2/refunds | RefundPayment -*SquareConnect.SubscriptionsApi* | [**cancelSubscription**](docs/SubscriptionsApi.md#cancelSubscription) | **POST** /v2/subscriptions/{subscription_id}/cancel | CancelSubscription -*SquareConnect.SubscriptionsApi* | [**createSubscription**](docs/SubscriptionsApi.md#createSubscription) | **POST** /v2/subscriptions | CreateSubscription -*SquareConnect.SubscriptionsApi* | [**listSubscriptionEvents**](docs/SubscriptionsApi.md#listSubscriptionEvents) | **GET** /v2/subscriptions/{subscription_id}/events | ListSubscriptionEvents -*SquareConnect.SubscriptionsApi* | [**retrieveSubscription**](docs/SubscriptionsApi.md#retrieveSubscription) | **GET** /v2/subscriptions/{subscription_id} | RetrieveSubscription -*SquareConnect.SubscriptionsApi* | [**searchSubscriptions**](docs/SubscriptionsApi.md#searchSubscriptions) | **POST** /v2/subscriptions/search | SearchSubscriptions -*SquareConnect.SubscriptionsApi* | [**updateSubscription**](docs/SubscriptionsApi.md#updateSubscription) | **PUT** /v2/subscriptions/{subscription_id} | UpdateSubscription -*SquareConnect.TeamApi* | [**bulkCreateTeamMembers**](docs/TeamApi.md#bulkCreateTeamMembers) | **POST** /v2/team-members/bulk-create | BulkCreateTeamMembers -*SquareConnect.TeamApi* | [**bulkUpdateTeamMembers**](docs/TeamApi.md#bulkUpdateTeamMembers) | **POST** /v2/team-members/bulk-update | BulkUpdateTeamMembers -*SquareConnect.TeamApi* | [**createTeamMember**](docs/TeamApi.md#createTeamMember) | **POST** /v2/team-members | CreateTeamMember -*SquareConnect.TeamApi* | [**retrieveTeamMember**](docs/TeamApi.md#retrieveTeamMember) | **GET** /v2/team-members/{team_member_id} | RetrieveTeamMember -*SquareConnect.TeamApi* | [**retrieveWageSetting**](docs/TeamApi.md#retrieveWageSetting) | **GET** /v2/team-members/{team_member_id}/wage-setting | RetrieveWageSetting -*SquareConnect.TeamApi* | [**searchTeamMembers**](docs/TeamApi.md#searchTeamMembers) | **POST** /v2/team-members/search | SearchTeamMembers -*SquareConnect.TeamApi* | [**updateTeamMember**](docs/TeamApi.md#updateTeamMember) | **PUT** /v2/team-members/{team_member_id} | UpdateTeamMember -*SquareConnect.TeamApi* | [**updateWageSetting**](docs/TeamApi.md#updateWageSetting) | **PUT** /v2/team-members/{team_member_id}/wage-setting | UpdateWageSetting -*SquareConnect.TerminalApi* | [**cancelTerminalCheckout**](docs/TerminalApi.md#cancelTerminalCheckout) | **POST** /v2/terminals/checkouts/{checkout_id}/cancel | CancelTerminalCheckout -*SquareConnect.TerminalApi* | [**cancelTerminalRefund**](docs/TerminalApi.md#cancelTerminalRefund) | **POST** /v2/terminals/refunds/{terminal_refund_id}/cancel | CancelTerminalRefund -*SquareConnect.TerminalApi* | [**createTerminalCheckout**](docs/TerminalApi.md#createTerminalCheckout) | **POST** /v2/terminals/checkouts | CreateTerminalCheckout -*SquareConnect.TerminalApi* | [**createTerminalRefund**](docs/TerminalApi.md#createTerminalRefund) | **POST** /v2/terminals/refunds | CreateTerminalRefund -*SquareConnect.TerminalApi* | [**getTerminalCheckout**](docs/TerminalApi.md#getTerminalCheckout) | **GET** /v2/terminals/checkouts/{checkout_id} | GetTerminalCheckout -*SquareConnect.TerminalApi* | [**getTerminalRefund**](docs/TerminalApi.md#getTerminalRefund) | **GET** /v2/terminals/refunds/{terminal_refund_id} | GetTerminalRefund -*SquareConnect.TerminalApi* | [**searchTerminalCheckouts**](docs/TerminalApi.md#searchTerminalCheckouts) | **POST** /v2/terminals/checkouts/search | SearchTerminalCheckouts -*SquareConnect.TerminalApi* | [**searchTerminalRefunds**](docs/TerminalApi.md#searchTerminalRefunds) | **POST** /v2/terminals/refunds/search | SearchTerminalRefunds -*SquareConnect.TransactionsApi* | [**captureTransaction**](docs/TransactionsApi.md#captureTransaction) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/capture | CaptureTransaction -*SquareConnect.TransactionsApi* | [**charge**](docs/TransactionsApi.md#charge) | **POST** /v2/locations/{location_id}/transactions | Charge -*SquareConnect.TransactionsApi* | [**createRefund**](docs/TransactionsApi.md#createRefund) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/refund | CreateRefund -*SquareConnect.TransactionsApi* | [**listRefunds**](docs/TransactionsApi.md#listRefunds) | **GET** /v2/locations/{location_id}/refunds | ListRefunds -*SquareConnect.TransactionsApi* | [**listTransactions**](docs/TransactionsApi.md#listTransactions) | **GET** /v2/locations/{location_id}/transactions | ListTransactions -*SquareConnect.TransactionsApi* | [**retrieveTransaction**](docs/TransactionsApi.md#retrieveTransaction) | **GET** /v2/locations/{location_id}/transactions/{transaction_id} | RetrieveTransaction -*SquareConnect.TransactionsApi* | [**voidTransaction**](docs/TransactionsApi.md#voidTransaction) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/void | VoidTransaction -*SquareConnect.V1EmployeesApi* | [**createEmployee**](docs/V1EmployeesApi.md#createEmployee) | **POST** /v1/me/employees | CreateEmployee -*SquareConnect.V1EmployeesApi* | [**createEmployeeRole**](docs/V1EmployeesApi.md#createEmployeeRole) | **POST** /v1/me/roles | CreateEmployeeRole -*SquareConnect.V1EmployeesApi* | [**createTimecard**](docs/V1EmployeesApi.md#createTimecard) | **POST** /v1/me/timecards | CreateTimecard -*SquareConnect.V1EmployeesApi* | [**deleteTimecard**](docs/V1EmployeesApi.md#deleteTimecard) | **DELETE** /v1/me/timecards/{timecard_id} | DeleteTimecard -*SquareConnect.V1EmployeesApi* | [**listCashDrawerShifts**](docs/V1EmployeesApi.md#listCashDrawerShifts) | **GET** /v1/{location_id}/cash-drawer-shifts | ListCashDrawerShifts -*SquareConnect.V1EmployeesApi* | [**listEmployeeRoles**](docs/V1EmployeesApi.md#listEmployeeRoles) | **GET** /v1/me/roles | ListEmployeeRoles -*SquareConnect.V1EmployeesApi* | [**listEmployees**](docs/V1EmployeesApi.md#listEmployees) | **GET** /v1/me/employees | ListEmployees -*SquareConnect.V1EmployeesApi* | [**listTimecardEvents**](docs/V1EmployeesApi.md#listTimecardEvents) | **GET** /v1/me/timecards/{timecard_id}/events | ListTimecardEvents -*SquareConnect.V1EmployeesApi* | [**listTimecards**](docs/V1EmployeesApi.md#listTimecards) | **GET** /v1/me/timecards | ListTimecards -*SquareConnect.V1EmployeesApi* | [**retrieveCashDrawerShift**](docs/V1EmployeesApi.md#retrieveCashDrawerShift) | **GET** /v1/{location_id}/cash-drawer-shifts/{shift_id} | RetrieveCashDrawerShift -*SquareConnect.V1EmployeesApi* | [**retrieveEmployee**](docs/V1EmployeesApi.md#retrieveEmployee) | **GET** /v1/me/employees/{employee_id} | RetrieveEmployee -*SquareConnect.V1EmployeesApi* | [**retrieveEmployeeRole**](docs/V1EmployeesApi.md#retrieveEmployeeRole) | **GET** /v1/me/roles/{role_id} | RetrieveEmployeeRole -*SquareConnect.V1EmployeesApi* | [**retrieveTimecard**](docs/V1EmployeesApi.md#retrieveTimecard) | **GET** /v1/me/timecards/{timecard_id} | RetrieveTimecard -*SquareConnect.V1EmployeesApi* | [**updateEmployee**](docs/V1EmployeesApi.md#updateEmployee) | **PUT** /v1/me/employees/{employee_id} | UpdateEmployee -*SquareConnect.V1EmployeesApi* | [**updateEmployeeRole**](docs/V1EmployeesApi.md#updateEmployeeRole) | **PUT** /v1/me/roles/{role_id} | UpdateEmployeeRole -*SquareConnect.V1EmployeesApi* | [**updateTimecard**](docs/V1EmployeesApi.md#updateTimecard) | **PUT** /v1/me/timecards/{timecard_id} | UpdateTimecard -*SquareConnect.V1ItemsApi* | [**adjustInventory**](docs/V1ItemsApi.md#adjustInventory) | **POST** /v1/{location_id}/inventory/{variation_id} | AdjustInventory -*SquareConnect.V1ItemsApi* | [**applyFee**](docs/V1ItemsApi.md#applyFee) | **PUT** /v1/{location_id}/items/{item_id}/fees/{fee_id} | ApplyFee -*SquareConnect.V1ItemsApi* | [**applyModifierList**](docs/V1ItemsApi.md#applyModifierList) | **PUT** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | ApplyModifierList -*SquareConnect.V1ItemsApi* | [**createCategory**](docs/V1ItemsApi.md#createCategory) | **POST** /v1/{location_id}/categories | CreateCategory -*SquareConnect.V1ItemsApi* | [**createDiscount**](docs/V1ItemsApi.md#createDiscount) | **POST** /v1/{location_id}/discounts | CreateDiscount -*SquareConnect.V1ItemsApi* | [**createFee**](docs/V1ItemsApi.md#createFee) | **POST** /v1/{location_id}/fees | CreateFee -*SquareConnect.V1ItemsApi* | [**createItem**](docs/V1ItemsApi.md#createItem) | **POST** /v1/{location_id}/items | CreateItem -*SquareConnect.V1ItemsApi* | [**createModifierList**](docs/V1ItemsApi.md#createModifierList) | **POST** /v1/{location_id}/modifier-lists | CreateModifierList -*SquareConnect.V1ItemsApi* | [**createModifierOption**](docs/V1ItemsApi.md#createModifierOption) | **POST** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options | CreateModifierOption -*SquareConnect.V1ItemsApi* | [**createPage**](docs/V1ItemsApi.md#createPage) | **POST** /v1/{location_id}/pages | CreatePage -*SquareConnect.V1ItemsApi* | [**createVariation**](docs/V1ItemsApi.md#createVariation) | **POST** /v1/{location_id}/items/{item_id}/variations | CreateVariation -*SquareConnect.V1ItemsApi* | [**deleteCategory**](docs/V1ItemsApi.md#deleteCategory) | **DELETE** /v1/{location_id}/categories/{category_id} | DeleteCategory -*SquareConnect.V1ItemsApi* | [**deleteDiscount**](docs/V1ItemsApi.md#deleteDiscount) | **DELETE** /v1/{location_id}/discounts/{discount_id} | DeleteDiscount -*SquareConnect.V1ItemsApi* | [**deleteFee**](docs/V1ItemsApi.md#deleteFee) | **DELETE** /v1/{location_id}/fees/{fee_id} | DeleteFee -*SquareConnect.V1ItemsApi* | [**deleteItem**](docs/V1ItemsApi.md#deleteItem) | **DELETE** /v1/{location_id}/items/{item_id} | DeleteItem -*SquareConnect.V1ItemsApi* | [**deleteModifierList**](docs/V1ItemsApi.md#deleteModifierList) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id} | DeleteModifierList -*SquareConnect.V1ItemsApi* | [**deleteModifierOption**](docs/V1ItemsApi.md#deleteModifierOption) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | DeleteModifierOption -*SquareConnect.V1ItemsApi* | [**deletePage**](docs/V1ItemsApi.md#deletePage) | **DELETE** /v1/{location_id}/pages/{page_id} | DeletePage -*SquareConnect.V1ItemsApi* | [**deletePageCell**](docs/V1ItemsApi.md#deletePageCell) | **DELETE** /v1/{location_id}/pages/{page_id}/cells | DeletePageCell -*SquareConnect.V1ItemsApi* | [**deleteVariation**](docs/V1ItemsApi.md#deleteVariation) | **DELETE** /v1/{location_id}/items/{item_id}/variations/{variation_id} | DeleteVariation -*SquareConnect.V1ItemsApi* | [**listCategories**](docs/V1ItemsApi.md#listCategories) | **GET** /v1/{location_id}/categories | ListCategories -*SquareConnect.V1ItemsApi* | [**listDiscounts**](docs/V1ItemsApi.md#listDiscounts) | **GET** /v1/{location_id}/discounts | ListDiscounts -*SquareConnect.V1ItemsApi* | [**listFees**](docs/V1ItemsApi.md#listFees) | **GET** /v1/{location_id}/fees | ListFees -*SquareConnect.V1ItemsApi* | [**listInventory**](docs/V1ItemsApi.md#listInventory) | **GET** /v1/{location_id}/inventory | ListInventory -*SquareConnect.V1ItemsApi* | [**listItems**](docs/V1ItemsApi.md#listItems) | **GET** /v1/{location_id}/items | ListItems -*SquareConnect.V1ItemsApi* | [**listModifierLists**](docs/V1ItemsApi.md#listModifierLists) | **GET** /v1/{location_id}/modifier-lists | ListModifierLists -*SquareConnect.V1ItemsApi* | [**listPages**](docs/V1ItemsApi.md#listPages) | **GET** /v1/{location_id}/pages | ListPages -*SquareConnect.V1ItemsApi* | [**removeFee**](docs/V1ItemsApi.md#removeFee) | **DELETE** /v1/{location_id}/items/{item_id}/fees/{fee_id} | RemoveFee -*SquareConnect.V1ItemsApi* | [**removeModifierList**](docs/V1ItemsApi.md#removeModifierList) | **DELETE** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | RemoveModifierList -*SquareConnect.V1ItemsApi* | [**retrieveItem**](docs/V1ItemsApi.md#retrieveItem) | **GET** /v1/{location_id}/items/{item_id} | RetrieveItem -*SquareConnect.V1ItemsApi* | [**retrieveModifierList**](docs/V1ItemsApi.md#retrieveModifierList) | **GET** /v1/{location_id}/modifier-lists/{modifier_list_id} | RetrieveModifierList -*SquareConnect.V1ItemsApi* | [**updateCategory**](docs/V1ItemsApi.md#updateCategory) | **PUT** /v1/{location_id}/categories/{category_id} | UpdateCategory -*SquareConnect.V1ItemsApi* | [**updateDiscount**](docs/V1ItemsApi.md#updateDiscount) | **PUT** /v1/{location_id}/discounts/{discount_id} | UpdateDiscount -*SquareConnect.V1ItemsApi* | [**updateFee**](docs/V1ItemsApi.md#updateFee) | **PUT** /v1/{location_id}/fees/{fee_id} | UpdateFee -*SquareConnect.V1ItemsApi* | [**updateItem**](docs/V1ItemsApi.md#updateItem) | **PUT** /v1/{location_id}/items/{item_id} | UpdateItem -*SquareConnect.V1ItemsApi* | [**updateModifierList**](docs/V1ItemsApi.md#updateModifierList) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id} | UpdateModifierList -*SquareConnect.V1ItemsApi* | [**updateModifierOption**](docs/V1ItemsApi.md#updateModifierOption) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | UpdateModifierOption -*SquareConnect.V1ItemsApi* | [**updatePage**](docs/V1ItemsApi.md#updatePage) | **PUT** /v1/{location_id}/pages/{page_id} | UpdatePage -*SquareConnect.V1ItemsApi* | [**updatePageCell**](docs/V1ItemsApi.md#updatePageCell) | **PUT** /v1/{location_id}/pages/{page_id}/cells | UpdatePageCell -*SquareConnect.V1ItemsApi* | [**updateVariation**](docs/V1ItemsApi.md#updateVariation) | **PUT** /v1/{location_id}/items/{item_id}/variations/{variation_id} | UpdateVariation -*SquareConnect.V1LocationsApi* | [**listLocations**](docs/V1LocationsApi.md#listLocations) | **GET** /v1/me/locations | ListLocations -*SquareConnect.V1LocationsApi* | [**retrieveBusiness**](docs/V1LocationsApi.md#retrieveBusiness) | **GET** /v1/me | RetrieveBusiness -*SquareConnect.V1TransactionsApi* | [**createRefund**](docs/V1TransactionsApi.md#createRefund) | **POST** /v1/{location_id}/refunds | CreateRefund -*SquareConnect.V1TransactionsApi* | [**listBankAccounts**](docs/V1TransactionsApi.md#listBankAccounts) | **GET** /v1/{location_id}/bank-accounts | ListBankAccounts -*SquareConnect.V1TransactionsApi* | [**listOrders**](docs/V1TransactionsApi.md#listOrders) | **GET** /v1/{location_id}/orders | ListOrders -*SquareConnect.V1TransactionsApi* | [**listPayments**](docs/V1TransactionsApi.md#listPayments) | **GET** /v1/{location_id}/payments | ListPayments -*SquareConnect.V1TransactionsApi* | [**listRefunds**](docs/V1TransactionsApi.md#listRefunds) | **GET** /v1/{location_id}/refunds | ListRefunds -*SquareConnect.V1TransactionsApi* | [**listSettlements**](docs/V1TransactionsApi.md#listSettlements) | **GET** /v1/{location_id}/settlements | ListSettlements -*SquareConnect.V1TransactionsApi* | [**retrieveBankAccount**](docs/V1TransactionsApi.md#retrieveBankAccount) | **GET** /v1/{location_id}/bank-accounts/{bank_account_id} | RetrieveBankAccount -*SquareConnect.V1TransactionsApi* | [**retrieveOrder**](docs/V1TransactionsApi.md#retrieveOrder) | **GET** /v1/{location_id}/orders/{order_id} | RetrieveOrder -*SquareConnect.V1TransactionsApi* | [**retrievePayment**](docs/V1TransactionsApi.md#retrievePayment) | **GET** /v1/{location_id}/payments/{payment_id} | RetrievePayment -*SquareConnect.V1TransactionsApi* | [**retrieveSettlement**](docs/V1TransactionsApi.md#retrieveSettlement) | **GET** /v1/{location_id}/settlements/{settlement_id} | RetrieveSettlement -*SquareConnect.V1TransactionsApi* | [**updateOrder**](docs/V1TransactionsApi.md#updateOrder) | **PUT** /v1/{location_id}/orders/{order_id} | UpdateOrder +**Note:** The new SDK supports TypeScript. It exports type files that you can use to type-check the SDK usage in TypeScript codebases. +### Client instantiation and initialization +Use the following examples to compare client instantiation and initialization in the deprecated SDK versus the new SDK. -## Documentation for Models +#### Deprecated Connect SDK +This is how you import the `square-connect` library, and instantiate and initialize the API client. +```javascript +var SquareConnect = require('square-connect'); +var defaultClient = SquareConnect.ApiClient.instance; - - [SquareConnect.AcceptDisputeRequest](docs/AcceptDisputeRequest.md) - - [SquareConnect.AcceptDisputeResponse](docs/AcceptDisputeResponse.md) - - [SquareConnect.AccumulateLoyaltyPointsRequest](docs/AccumulateLoyaltyPointsRequest.md) - - [SquareConnect.AccumulateLoyaltyPointsResponse](docs/AccumulateLoyaltyPointsResponse.md) - - [SquareConnect.ActionCancelReason](docs/ActionCancelReason.md) - - [SquareConnect.AddGroupToCustomerRequest](docs/AddGroupToCustomerRequest.md) - - [SquareConnect.AddGroupToCustomerResponse](docs/AddGroupToCustomerResponse.md) - - [SquareConnect.AdditionalRecipient](docs/AdditionalRecipient.md) - - [SquareConnect.Address](docs/Address.md) - - [SquareConnect.AdjustLoyaltyPointsRequest](docs/AdjustLoyaltyPointsRequest.md) - - [SquareConnect.AdjustLoyaltyPointsResponse](docs/AdjustLoyaltyPointsResponse.md) - - [SquareConnect.BalancePaymentDetails](docs/BalancePaymentDetails.md) - - [SquareConnect.BankAccount](docs/BankAccount.md) - - [SquareConnect.BankAccountStatus](docs/BankAccountStatus.md) - - [SquareConnect.BankAccountType](docs/BankAccountType.md) - - [SquareConnect.BatchChangeInventoryRequest](docs/BatchChangeInventoryRequest.md) - - [SquareConnect.BatchChangeInventoryResponse](docs/BatchChangeInventoryResponse.md) - - [SquareConnect.BatchDeleteCatalogObjectsRequest](docs/BatchDeleteCatalogObjectsRequest.md) - - [SquareConnect.BatchDeleteCatalogObjectsResponse](docs/BatchDeleteCatalogObjectsResponse.md) - - [SquareConnect.BatchRetrieveCatalogObjectsRequest](docs/BatchRetrieveCatalogObjectsRequest.md) - - [SquareConnect.BatchRetrieveCatalogObjectsResponse](docs/BatchRetrieveCatalogObjectsResponse.md) - - [SquareConnect.BatchRetrieveInventoryChangesRequest](docs/BatchRetrieveInventoryChangesRequest.md) - - [SquareConnect.BatchRetrieveInventoryChangesResponse](docs/BatchRetrieveInventoryChangesResponse.md) - - [SquareConnect.BatchRetrieveInventoryCountsRequest](docs/BatchRetrieveInventoryCountsRequest.md) - - [SquareConnect.BatchRetrieveInventoryCountsResponse](docs/BatchRetrieveInventoryCountsResponse.md) - - [SquareConnect.BatchRetrieveOrdersRequest](docs/BatchRetrieveOrdersRequest.md) - - [SquareConnect.BatchRetrieveOrdersResponse](docs/BatchRetrieveOrdersResponse.md) - - [SquareConnect.BatchUpsertCatalogObjectsRequest](docs/BatchUpsertCatalogObjectsRequest.md) - - [SquareConnect.BatchUpsertCatalogObjectsResponse](docs/BatchUpsertCatalogObjectsResponse.md) - - [SquareConnect.BreakType](docs/BreakType.md) - - [SquareConnect.BulkCreateTeamMembersRequest](docs/BulkCreateTeamMembersRequest.md) - - [SquareConnect.BulkCreateTeamMembersResponse](docs/BulkCreateTeamMembersResponse.md) - - [SquareConnect.BulkUpdateTeamMembersRequest](docs/BulkUpdateTeamMembersRequest.md) - - [SquareConnect.BulkUpdateTeamMembersResponse](docs/BulkUpdateTeamMembersResponse.md) - - [SquareConnect.BusinessHours](docs/BusinessHours.md) - - [SquareConnect.BusinessHoursPeriod](docs/BusinessHoursPeriod.md) - - [SquareConnect.CalculateLoyaltyPointsRequest](docs/CalculateLoyaltyPointsRequest.md) - - [SquareConnect.CalculateLoyaltyPointsResponse](docs/CalculateLoyaltyPointsResponse.md) - - [SquareConnect.CalculateOrderRequest](docs/CalculateOrderRequest.md) - - [SquareConnect.CalculateOrderResponse](docs/CalculateOrderResponse.md) - - [SquareConnect.CancelInvoiceRequest](docs/CancelInvoiceRequest.md) - - [SquareConnect.CancelInvoiceResponse](docs/CancelInvoiceResponse.md) - - [SquareConnect.CancelPaymentByIdempotencyKeyRequest](docs/CancelPaymentByIdempotencyKeyRequest.md) - - [SquareConnect.CancelPaymentByIdempotencyKeyResponse](docs/CancelPaymentByIdempotencyKeyResponse.md) - - [SquareConnect.CancelPaymentRequest](docs/CancelPaymentRequest.md) - - [SquareConnect.CancelPaymentResponse](docs/CancelPaymentResponse.md) - - [SquareConnect.CancelSubscriptionRequest](docs/CancelSubscriptionRequest.md) - - [SquareConnect.CancelSubscriptionResponse](docs/CancelSubscriptionResponse.md) - - [SquareConnect.CancelTerminalCheckoutRequest](docs/CancelTerminalCheckoutRequest.md) - - [SquareConnect.CancelTerminalCheckoutResponse](docs/CancelTerminalCheckoutResponse.md) - - [SquareConnect.CancelTerminalRefundRequest](docs/CancelTerminalRefundRequest.md) - - [SquareConnect.CancelTerminalRefundResponse](docs/CancelTerminalRefundResponse.md) - - [SquareConnect.CaptureTransactionRequest](docs/CaptureTransactionRequest.md) - - [SquareConnect.CaptureTransactionResponse](docs/CaptureTransactionResponse.md) - - [SquareConnect.Card](docs/Card.md) - - [SquareConnect.CardBrand](docs/CardBrand.md) - - [SquareConnect.CardPaymentDetails](docs/CardPaymentDetails.md) - - [SquareConnect.CardPrepaidType](docs/CardPrepaidType.md) - - [SquareConnect.CardSquareProduct](docs/CardSquareProduct.md) - - [SquareConnect.CardType](docs/CardType.md) - - [SquareConnect.CashDrawerDevice](docs/CashDrawerDevice.md) - - [SquareConnect.CashDrawerEventType](docs/CashDrawerEventType.md) - - [SquareConnect.CashDrawerShift](docs/CashDrawerShift.md) - - [SquareConnect.CashDrawerShiftEvent](docs/CashDrawerShiftEvent.md) - - [SquareConnect.CashDrawerShiftState](docs/CashDrawerShiftState.md) - - [SquareConnect.CashDrawerShiftSummary](docs/CashDrawerShiftSummary.md) - - [SquareConnect.CatalogCategory](docs/CatalogCategory.md) - - [SquareConnect.CatalogCustomAttributeDefinition](docs/CatalogCustomAttributeDefinition.md) - - [SquareConnect.CatalogCustomAttributeDefinitionAppVisibility](docs/CatalogCustomAttributeDefinitionAppVisibility.md) - - [SquareConnect.CatalogCustomAttributeDefinitionNumberConfig](docs/CatalogCustomAttributeDefinitionNumberConfig.md) - - [SquareConnect.CatalogCustomAttributeDefinitionSelectionConfig](docs/CatalogCustomAttributeDefinitionSelectionConfig.md) - - [SquareConnect.CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection](docs/CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection.md) - - [SquareConnect.CatalogCustomAttributeDefinitionSellerVisibility](docs/CatalogCustomAttributeDefinitionSellerVisibility.md) - - [SquareConnect.CatalogCustomAttributeDefinitionStringConfig](docs/CatalogCustomAttributeDefinitionStringConfig.md) - - [SquareConnect.CatalogCustomAttributeDefinitionType](docs/CatalogCustomAttributeDefinitionType.md) - - [SquareConnect.CatalogCustomAttributeValue](docs/CatalogCustomAttributeValue.md) - - [SquareConnect.CatalogDiscount](docs/CatalogDiscount.md) - - [SquareConnect.CatalogDiscountModifyTaxBasis](docs/CatalogDiscountModifyTaxBasis.md) - - [SquareConnect.CatalogDiscountType](docs/CatalogDiscountType.md) - - [SquareConnect.CatalogIdMapping](docs/CatalogIdMapping.md) - - [SquareConnect.CatalogImage](docs/CatalogImage.md) - - [SquareConnect.CatalogInfoRequest](docs/CatalogInfoRequest.md) - - [SquareConnect.CatalogInfoResponse](docs/CatalogInfoResponse.md) - - [SquareConnect.CatalogInfoResponseLimits](docs/CatalogInfoResponseLimits.md) - - [SquareConnect.CatalogItem](docs/CatalogItem.md) - - [SquareConnect.CatalogItemModifierListInfo](docs/CatalogItemModifierListInfo.md) - - [SquareConnect.CatalogItemOption](docs/CatalogItemOption.md) - - [SquareConnect.CatalogItemOptionForItem](docs/CatalogItemOptionForItem.md) - - [SquareConnect.CatalogItemOptionValue](docs/CatalogItemOptionValue.md) - - [SquareConnect.CatalogItemOptionValueForItemVariation](docs/CatalogItemOptionValueForItemVariation.md) - - [SquareConnect.CatalogItemProductType](docs/CatalogItemProductType.md) - - [SquareConnect.CatalogItemVariation](docs/CatalogItemVariation.md) - - [SquareConnect.CatalogMeasurementUnit](docs/CatalogMeasurementUnit.md) - - [SquareConnect.CatalogModifier](docs/CatalogModifier.md) - - [SquareConnect.CatalogModifierList](docs/CatalogModifierList.md) - - [SquareConnect.CatalogModifierListSelectionType](docs/CatalogModifierListSelectionType.md) - - [SquareConnect.CatalogModifierOverride](docs/CatalogModifierOverride.md) - - [SquareConnect.CatalogObject](docs/CatalogObject.md) - - [SquareConnect.CatalogObjectBatch](docs/CatalogObjectBatch.md) - - [SquareConnect.CatalogObjectType](docs/CatalogObjectType.md) - - [SquareConnect.CatalogPricingRule](docs/CatalogPricingRule.md) - - [SquareConnect.CatalogPricingType](docs/CatalogPricingType.md) - - [SquareConnect.CatalogProductSet](docs/CatalogProductSet.md) - - [SquareConnect.CatalogQuery](docs/CatalogQuery.md) - - [SquareConnect.CatalogQueryExact](docs/CatalogQueryExact.md) - - [SquareConnect.CatalogQueryItemVariationsForItemOptionValues](docs/CatalogQueryItemVariationsForItemOptionValues.md) - - [SquareConnect.CatalogQueryItemsForItemOptions](docs/CatalogQueryItemsForItemOptions.md) - - [SquareConnect.CatalogQueryItemsForModifierList](docs/CatalogQueryItemsForModifierList.md) - - [SquareConnect.CatalogQueryItemsForTax](docs/CatalogQueryItemsForTax.md) - - [SquareConnect.CatalogQueryPrefix](docs/CatalogQueryPrefix.md) - - [SquareConnect.CatalogQueryRange](docs/CatalogQueryRange.md) - - [SquareConnect.CatalogQuerySet](docs/CatalogQuerySet.md) - - [SquareConnect.CatalogQuerySortedAttribute](docs/CatalogQuerySortedAttribute.md) - - [SquareConnect.CatalogQueryText](docs/CatalogQueryText.md) - - [SquareConnect.CatalogQuickAmount](docs/CatalogQuickAmount.md) - - [SquareConnect.CatalogQuickAmountType](docs/CatalogQuickAmountType.md) - - [SquareConnect.CatalogQuickAmountsSettings](docs/CatalogQuickAmountsSettings.md) - - [SquareConnect.CatalogQuickAmountsSettingsOption](docs/CatalogQuickAmountsSettingsOption.md) - - [SquareConnect.CatalogSubscriptionPlan](docs/CatalogSubscriptionPlan.md) - - [SquareConnect.CatalogTax](docs/CatalogTax.md) - - [SquareConnect.CatalogTimePeriod](docs/CatalogTimePeriod.md) - - [SquareConnect.CatalogV1Id](docs/CatalogV1Id.md) - - [SquareConnect.ChargeRequest](docs/ChargeRequest.md) - - [SquareConnect.ChargeRequestAdditionalRecipient](docs/ChargeRequestAdditionalRecipient.md) - - [SquareConnect.ChargeResponse](docs/ChargeResponse.md) - - [SquareConnect.Checkout](docs/Checkout.md) - - [SquareConnect.CompletePaymentRequest](docs/CompletePaymentRequest.md) - - [SquareConnect.CompletePaymentResponse](docs/CompletePaymentResponse.md) - - [SquareConnect.Coordinates](docs/Coordinates.md) - - [SquareConnect.Country](docs/Country.md) - - [SquareConnect.CreateBreakTypeRequest](docs/CreateBreakTypeRequest.md) - - [SquareConnect.CreateBreakTypeResponse](docs/CreateBreakTypeResponse.md) - - [SquareConnect.CreateCatalogImageRequest](docs/CreateCatalogImageRequest.md) - - [SquareConnect.CreateCatalogImageResponse](docs/CreateCatalogImageResponse.md) - - [SquareConnect.CreateCheckoutRequest](docs/CreateCheckoutRequest.md) - - [SquareConnect.CreateCheckoutResponse](docs/CreateCheckoutResponse.md) - - [SquareConnect.CreateCustomerCardRequest](docs/CreateCustomerCardRequest.md) - - [SquareConnect.CreateCustomerCardResponse](docs/CreateCustomerCardResponse.md) - - [SquareConnect.CreateCustomerGroupRequest](docs/CreateCustomerGroupRequest.md) - - [SquareConnect.CreateCustomerGroupResponse](docs/CreateCustomerGroupResponse.md) - - [SquareConnect.CreateCustomerRequest](docs/CreateCustomerRequest.md) - - [SquareConnect.CreateCustomerResponse](docs/CreateCustomerResponse.md) - - [SquareConnect.CreateDeviceCodeRequest](docs/CreateDeviceCodeRequest.md) - - [SquareConnect.CreateDeviceCodeResponse](docs/CreateDeviceCodeResponse.md) - - [SquareConnect.CreateDisputeEvidenceFileRequest](docs/CreateDisputeEvidenceFileRequest.md) - - [SquareConnect.CreateDisputeEvidenceFileResponse](docs/CreateDisputeEvidenceFileResponse.md) - - [SquareConnect.CreateDisputeEvidenceTextRequest](docs/CreateDisputeEvidenceTextRequest.md) - - [SquareConnect.CreateDisputeEvidenceTextResponse](docs/CreateDisputeEvidenceTextResponse.md) - - [SquareConnect.CreateInvoiceRequest](docs/CreateInvoiceRequest.md) - - [SquareConnect.CreateInvoiceResponse](docs/CreateInvoiceResponse.md) - - [SquareConnect.CreateLocationRequest](docs/CreateLocationRequest.md) - - [SquareConnect.CreateLocationResponse](docs/CreateLocationResponse.md) - - [SquareConnect.CreateLoyaltyAccountRequest](docs/CreateLoyaltyAccountRequest.md) - - [SquareConnect.CreateLoyaltyAccountResponse](docs/CreateLoyaltyAccountResponse.md) - - [SquareConnect.CreateLoyaltyRewardRequest](docs/CreateLoyaltyRewardRequest.md) - - [SquareConnect.CreateLoyaltyRewardResponse](docs/CreateLoyaltyRewardResponse.md) - - [SquareConnect.CreateMobileAuthorizationCodeRequest](docs/CreateMobileAuthorizationCodeRequest.md) - - [SquareConnect.CreateMobileAuthorizationCodeResponse](docs/CreateMobileAuthorizationCodeResponse.md) - - [SquareConnect.CreateOrderRequest](docs/CreateOrderRequest.md) - - [SquareConnect.CreateOrderResponse](docs/CreateOrderResponse.md) - - [SquareConnect.CreatePaymentRequest](docs/CreatePaymentRequest.md) - - [SquareConnect.CreatePaymentResponse](docs/CreatePaymentResponse.md) - - [SquareConnect.CreateRefundRequest](docs/CreateRefundRequest.md) - - [SquareConnect.CreateRefundResponse](docs/CreateRefundResponse.md) - - [SquareConnect.CreateShiftRequest](docs/CreateShiftRequest.md) - - [SquareConnect.CreateShiftResponse](docs/CreateShiftResponse.md) - - [SquareConnect.CreateSubscriptionRequest](docs/CreateSubscriptionRequest.md) - - [SquareConnect.CreateSubscriptionResponse](docs/CreateSubscriptionResponse.md) - - [SquareConnect.CreateTeamMemberRequest](docs/CreateTeamMemberRequest.md) - - [SquareConnect.CreateTeamMemberResponse](docs/CreateTeamMemberResponse.md) - - [SquareConnect.CreateTerminalCheckoutRequest](docs/CreateTerminalCheckoutRequest.md) - - [SquareConnect.CreateTerminalCheckoutResponse](docs/CreateTerminalCheckoutResponse.md) - - [SquareConnect.CreateTerminalRefundRequest](docs/CreateTerminalRefundRequest.md) - - [SquareConnect.CreateTerminalRefundResponse](docs/CreateTerminalRefundResponse.md) - - [SquareConnect.Currency](docs/Currency.md) - - [SquareConnect.CustomAttributeFilter](docs/CustomAttributeFilter.md) - - [SquareConnect.Customer](docs/Customer.md) - - [SquareConnect.CustomerCreationSource](docs/CustomerCreationSource.md) - - [SquareConnect.CustomerCreationSourceFilter](docs/CustomerCreationSourceFilter.md) - - [SquareConnect.CustomerFilter](docs/CustomerFilter.md) - - [SquareConnect.CustomerGroup](docs/CustomerGroup.md) - - [SquareConnect.CustomerGroupInfo](docs/CustomerGroupInfo.md) - - [SquareConnect.CustomerInclusionExclusion](docs/CustomerInclusionExclusion.md) - - [SquareConnect.CustomerPreferences](docs/CustomerPreferences.md) - - [SquareConnect.CustomerQuery](docs/CustomerQuery.md) - - [SquareConnect.CustomerSegment](docs/CustomerSegment.md) - - [SquareConnect.CustomerSort](docs/CustomerSort.md) - - [SquareConnect.CustomerSortField](docs/CustomerSortField.md) - - [SquareConnect.CustomerTextFilter](docs/CustomerTextFilter.md) - - [SquareConnect.DateRange](docs/DateRange.md) - - [SquareConnect.DayOfWeek](docs/DayOfWeek.md) - - [SquareConnect.DeleteBreakTypeRequest](docs/DeleteBreakTypeRequest.md) - - [SquareConnect.DeleteBreakTypeResponse](docs/DeleteBreakTypeResponse.md) - - [SquareConnect.DeleteCatalogObjectRequest](docs/DeleteCatalogObjectRequest.md) - - [SquareConnect.DeleteCatalogObjectResponse](docs/DeleteCatalogObjectResponse.md) - - [SquareConnect.DeleteCustomerCardRequest](docs/DeleteCustomerCardRequest.md) - - [SquareConnect.DeleteCustomerCardResponse](docs/DeleteCustomerCardResponse.md) - - [SquareConnect.DeleteCustomerGroupRequest](docs/DeleteCustomerGroupRequest.md) - - [SquareConnect.DeleteCustomerGroupResponse](docs/DeleteCustomerGroupResponse.md) - - [SquareConnect.DeleteCustomerRequest](docs/DeleteCustomerRequest.md) - - [SquareConnect.DeleteCustomerResponse](docs/DeleteCustomerResponse.md) - - [SquareConnect.DeleteInvoiceRequest](docs/DeleteInvoiceRequest.md) - - [SquareConnect.DeleteInvoiceResponse](docs/DeleteInvoiceResponse.md) - - [SquareConnect.DeleteLoyaltyRewardRequest](docs/DeleteLoyaltyRewardRequest.md) - - [SquareConnect.DeleteLoyaltyRewardResponse](docs/DeleteLoyaltyRewardResponse.md) - - [SquareConnect.DeleteShiftRequest](docs/DeleteShiftRequest.md) - - [SquareConnect.DeleteShiftResponse](docs/DeleteShiftResponse.md) - - [SquareConnect.Device](docs/Device.md) - - [SquareConnect.DeviceCheckoutOptions](docs/DeviceCheckoutOptions.md) - - [SquareConnect.DeviceCode](docs/DeviceCode.md) - - [SquareConnect.DeviceCodeStatus](docs/DeviceCodeStatus.md) - - [SquareConnect.DeviceDetails](docs/DeviceDetails.md) - - [SquareConnect.Dispute](docs/Dispute.md) - - [SquareConnect.DisputeEvidence](docs/DisputeEvidence.md) - - [SquareConnect.DisputeEvidenceFile](docs/DisputeEvidenceFile.md) - - [SquareConnect.DisputeEvidenceType](docs/DisputeEvidenceType.md) - - [SquareConnect.DisputeReason](docs/DisputeReason.md) - - [SquareConnect.DisputeState](docs/DisputeState.md) - - [SquareConnect.DisputedPayment](docs/DisputedPayment.md) - - [SquareConnect.EcomVisibility](docs/EcomVisibility.md) - - [SquareConnect.Employee](docs/Employee.md) - - [SquareConnect.EmployeeStatus](docs/EmployeeStatus.md) - - [SquareConnect.EmployeeWage](docs/EmployeeWage.md) - - [SquareConnect.Error](docs/Error.md) - - [SquareConnect.ErrorCategory](docs/ErrorCategory.md) - - [SquareConnect.ErrorCode](docs/ErrorCode.md) - - [SquareConnect.ExcludeStrategy](docs/ExcludeStrategy.md) - - [SquareConnect.FilterValue](docs/FilterValue.md) - - [SquareConnect.GetBankAccountByV1IdRequest](docs/GetBankAccountByV1IdRequest.md) - - [SquareConnect.GetBankAccountByV1IdResponse](docs/GetBankAccountByV1IdResponse.md) - - [SquareConnect.GetBankAccountRequest](docs/GetBankAccountRequest.md) - - [SquareConnect.GetBankAccountResponse](docs/GetBankAccountResponse.md) - - [SquareConnect.GetBreakTypeRequest](docs/GetBreakTypeRequest.md) - - [SquareConnect.GetBreakTypeResponse](docs/GetBreakTypeResponse.md) - - [SquareConnect.GetDeviceCodeRequest](docs/GetDeviceCodeRequest.md) - - [SquareConnect.GetDeviceCodeResponse](docs/GetDeviceCodeResponse.md) - - [SquareConnect.GetEmployeeWageRequest](docs/GetEmployeeWageRequest.md) - - [SquareConnect.GetEmployeeWageResponse](docs/GetEmployeeWageResponse.md) - - [SquareConnect.GetInvoiceRequest](docs/GetInvoiceRequest.md) - - [SquareConnect.GetInvoiceResponse](docs/GetInvoiceResponse.md) - - [SquareConnect.GetPaymentRefundRequest](docs/GetPaymentRefundRequest.md) - - [SquareConnect.GetPaymentRefundResponse](docs/GetPaymentRefundResponse.md) - - [SquareConnect.GetPaymentRequest](docs/GetPaymentRequest.md) - - [SquareConnect.GetPaymentResponse](docs/GetPaymentResponse.md) - - [SquareConnect.GetShiftRequest](docs/GetShiftRequest.md) - - [SquareConnect.GetShiftResponse](docs/GetShiftResponse.md) - - [SquareConnect.GetTeamMemberWageRequest](docs/GetTeamMemberWageRequest.md) - - [SquareConnect.GetTeamMemberWageResponse](docs/GetTeamMemberWageResponse.md) - - [SquareConnect.GetTerminalCheckoutRequest](docs/GetTerminalCheckoutRequest.md) - - [SquareConnect.GetTerminalCheckoutResponse](docs/GetTerminalCheckoutResponse.md) - - [SquareConnect.GetTerminalRefundRequest](docs/GetTerminalRefundRequest.md) - - [SquareConnect.GetTerminalRefundResponse](docs/GetTerminalRefundResponse.md) - - [SquareConnect.InlineTypes](docs/InlineTypes.md) - - [SquareConnect.InventoryAdjustment](docs/InventoryAdjustment.md) - - [SquareConnect.InventoryAlertType](docs/InventoryAlertType.md) - - [SquareConnect.InventoryChange](docs/InventoryChange.md) - - [SquareConnect.InventoryChangeType](docs/InventoryChangeType.md) - - [SquareConnect.InventoryCount](docs/InventoryCount.md) - - [SquareConnect.InventoryPhysicalCount](docs/InventoryPhysicalCount.md) - - [SquareConnect.InventoryState](docs/InventoryState.md) - - [SquareConnect.InventoryTransfer](docs/InventoryTransfer.md) - - [SquareConnect.Invoice](docs/Invoice.md) - - [SquareConnect.InvoiceFilter](docs/InvoiceFilter.md) - - [SquareConnect.InvoicePaymentReminder](docs/InvoicePaymentReminder.md) - - [SquareConnect.InvoicePaymentReminderStatus](docs/InvoicePaymentReminderStatus.md) - - [SquareConnect.InvoicePaymentRequest](docs/InvoicePaymentRequest.md) - - [SquareConnect.InvoiceQuery](docs/InvoiceQuery.md) - - [SquareConnect.InvoiceRecipient](docs/InvoiceRecipient.md) - - [SquareConnect.InvoiceRequestMethod](docs/InvoiceRequestMethod.md) - - [SquareConnect.InvoiceRequestType](docs/InvoiceRequestType.md) - - [SquareConnect.InvoiceSort](docs/InvoiceSort.md) - - [SquareConnect.InvoiceSortField](docs/InvoiceSortField.md) - - [SquareConnect.InvoiceStatus](docs/InvoiceStatus.md) - - [SquareConnect.ItemVariationLocationOverrides](docs/ItemVariationLocationOverrides.md) - - [SquareConnect.JobAssignment](docs/JobAssignment.md) - - [SquareConnect.JobAssignmentPayType](docs/JobAssignmentPayType.md) - - [SquareConnect.ListBankAccountsRequest](docs/ListBankAccountsRequest.md) - - [SquareConnect.ListBankAccountsResponse](docs/ListBankAccountsResponse.md) - - [SquareConnect.ListBreakTypesRequest](docs/ListBreakTypesRequest.md) - - [SquareConnect.ListBreakTypesResponse](docs/ListBreakTypesResponse.md) - - [SquareConnect.ListCashDrawerShiftEventsRequest](docs/ListCashDrawerShiftEventsRequest.md) - - [SquareConnect.ListCashDrawerShiftEventsResponse](docs/ListCashDrawerShiftEventsResponse.md) - - [SquareConnect.ListCashDrawerShiftsRequest](docs/ListCashDrawerShiftsRequest.md) - - [SquareConnect.ListCashDrawerShiftsResponse](docs/ListCashDrawerShiftsResponse.md) - - [SquareConnect.ListCatalogRequest](docs/ListCatalogRequest.md) - - [SquareConnect.ListCatalogResponse](docs/ListCatalogResponse.md) - - [SquareConnect.ListCustomerGroupsRequest](docs/ListCustomerGroupsRequest.md) - - [SquareConnect.ListCustomerGroupsResponse](docs/ListCustomerGroupsResponse.md) - - [SquareConnect.ListCustomerSegmentsRequest](docs/ListCustomerSegmentsRequest.md) - - [SquareConnect.ListCustomerSegmentsResponse](docs/ListCustomerSegmentsResponse.md) - - [SquareConnect.ListCustomersRequest](docs/ListCustomersRequest.md) - - [SquareConnect.ListCustomersResponse](docs/ListCustomersResponse.md) - - [SquareConnect.ListDeviceCodesRequest](docs/ListDeviceCodesRequest.md) - - [SquareConnect.ListDeviceCodesResponse](docs/ListDeviceCodesResponse.md) - - [SquareConnect.ListDisputeEvidenceRequest](docs/ListDisputeEvidenceRequest.md) - - [SquareConnect.ListDisputeEvidenceResponse](docs/ListDisputeEvidenceResponse.md) - - [SquareConnect.ListDisputesRequest](docs/ListDisputesRequest.md) - - [SquareConnect.ListDisputesResponse](docs/ListDisputesResponse.md) - - [SquareConnect.ListEmployeeWagesRequest](docs/ListEmployeeWagesRequest.md) - - [SquareConnect.ListEmployeeWagesResponse](docs/ListEmployeeWagesResponse.md) - - [SquareConnect.ListEmployeesRequest](docs/ListEmployeesRequest.md) - - [SquareConnect.ListEmployeesResponse](docs/ListEmployeesResponse.md) - - [SquareConnect.ListInvoicesRequest](docs/ListInvoicesRequest.md) - - [SquareConnect.ListInvoicesResponse](docs/ListInvoicesResponse.md) - - [SquareConnect.ListLocationsRequest](docs/ListLocationsRequest.md) - - [SquareConnect.ListLocationsResponse](docs/ListLocationsResponse.md) - - [SquareConnect.ListLoyaltyProgramsRequest](docs/ListLoyaltyProgramsRequest.md) - - [SquareConnect.ListLoyaltyProgramsResponse](docs/ListLoyaltyProgramsResponse.md) - - [SquareConnect.ListMerchantsRequest](docs/ListMerchantsRequest.md) - - [SquareConnect.ListMerchantsResponse](docs/ListMerchantsResponse.md) - - [SquareConnect.ListPaymentRefundsRequest](docs/ListPaymentRefundsRequest.md) - - [SquareConnect.ListPaymentRefundsResponse](docs/ListPaymentRefundsResponse.md) - - [SquareConnect.ListPaymentsRequest](docs/ListPaymentsRequest.md) - - [SquareConnect.ListPaymentsResponse](docs/ListPaymentsResponse.md) - - [SquareConnect.ListRefundsRequest](docs/ListRefundsRequest.md) - - [SquareConnect.ListRefundsResponse](docs/ListRefundsResponse.md) - - [SquareConnect.ListSubscriptionEventsRequest](docs/ListSubscriptionEventsRequest.md) - - [SquareConnect.ListSubscriptionEventsResponse](docs/ListSubscriptionEventsResponse.md) - - [SquareConnect.ListTeamMemberWagesRequest](docs/ListTeamMemberWagesRequest.md) - - [SquareConnect.ListTeamMemberWagesResponse](docs/ListTeamMemberWagesResponse.md) - - [SquareConnect.ListTransactionsRequest](docs/ListTransactionsRequest.md) - - [SquareConnect.ListTransactionsResponse](docs/ListTransactionsResponse.md) - - [SquareConnect.ListWorkweekConfigsRequest](docs/ListWorkweekConfigsRequest.md) - - [SquareConnect.ListWorkweekConfigsResponse](docs/ListWorkweekConfigsResponse.md) - - [SquareConnect.Location](docs/Location.md) - - [SquareConnect.LocationCapability](docs/LocationCapability.md) - - [SquareConnect.LocationStatus](docs/LocationStatus.md) - - [SquareConnect.LocationType](docs/LocationType.md) - - [SquareConnect.LoyaltyAccount](docs/LoyaltyAccount.md) - - [SquareConnect.LoyaltyAccountMapping](docs/LoyaltyAccountMapping.md) - - [SquareConnect.LoyaltyAccountMappingType](docs/LoyaltyAccountMappingType.md) - - [SquareConnect.LoyaltyEvent](docs/LoyaltyEvent.md) - - [SquareConnect.LoyaltyEventAccumulatePoints](docs/LoyaltyEventAccumulatePoints.md) - - [SquareConnect.LoyaltyEventAdjustPoints](docs/LoyaltyEventAdjustPoints.md) - - [SquareConnect.LoyaltyEventCreateReward](docs/LoyaltyEventCreateReward.md) - - [SquareConnect.LoyaltyEventDateTimeFilter](docs/LoyaltyEventDateTimeFilter.md) - - [SquareConnect.LoyaltyEventDeleteReward](docs/LoyaltyEventDeleteReward.md) - - [SquareConnect.LoyaltyEventExpirePoints](docs/LoyaltyEventExpirePoints.md) - - [SquareConnect.LoyaltyEventFilter](docs/LoyaltyEventFilter.md) - - [SquareConnect.LoyaltyEventLocationFilter](docs/LoyaltyEventLocationFilter.md) - - [SquareConnect.LoyaltyEventLoyaltyAccountFilter](docs/LoyaltyEventLoyaltyAccountFilter.md) - - [SquareConnect.LoyaltyEventOrderFilter](docs/LoyaltyEventOrderFilter.md) - - [SquareConnect.LoyaltyEventOther](docs/LoyaltyEventOther.md) - - [SquareConnect.LoyaltyEventQuery](docs/LoyaltyEventQuery.md) - - [SquareConnect.LoyaltyEventRedeemReward](docs/LoyaltyEventRedeemReward.md) - - [SquareConnect.LoyaltyEventSource](docs/LoyaltyEventSource.md) - - [SquareConnect.LoyaltyEventType](docs/LoyaltyEventType.md) - - [SquareConnect.LoyaltyEventTypeFilter](docs/LoyaltyEventTypeFilter.md) - - [SquareConnect.LoyaltyProgram](docs/LoyaltyProgram.md) - - [SquareConnect.LoyaltyProgramAccrualRule](docs/LoyaltyProgramAccrualRule.md) - - [SquareConnect.LoyaltyProgramAccrualRuleType](docs/LoyaltyProgramAccrualRuleType.md) - - [SquareConnect.LoyaltyProgramExpirationPolicy](docs/LoyaltyProgramExpirationPolicy.md) - - [SquareConnect.LoyaltyProgramRewardDefinition](docs/LoyaltyProgramRewardDefinition.md) - - [SquareConnect.LoyaltyProgramRewardDefinitionScope](docs/LoyaltyProgramRewardDefinitionScope.md) - - [SquareConnect.LoyaltyProgramRewardDefinitionType](docs/LoyaltyProgramRewardDefinitionType.md) - - [SquareConnect.LoyaltyProgramRewardTier](docs/LoyaltyProgramRewardTier.md) - - [SquareConnect.LoyaltyProgramStatus](docs/LoyaltyProgramStatus.md) - - [SquareConnect.LoyaltyProgramTerminology](docs/LoyaltyProgramTerminology.md) - - [SquareConnect.LoyaltyReward](docs/LoyaltyReward.md) - - [SquareConnect.LoyaltyRewardStatus](docs/LoyaltyRewardStatus.md) - - [SquareConnect.MeasurementUnit](docs/MeasurementUnit.md) - - [SquareConnect.MeasurementUnitArea](docs/MeasurementUnitArea.md) - - [SquareConnect.MeasurementUnitCustom](docs/MeasurementUnitCustom.md) - - [SquareConnect.MeasurementUnitGeneric](docs/MeasurementUnitGeneric.md) - - [SquareConnect.MeasurementUnitLength](docs/MeasurementUnitLength.md) - - [SquareConnect.MeasurementUnitTime](docs/MeasurementUnitTime.md) - - [SquareConnect.MeasurementUnitUnitType](docs/MeasurementUnitUnitType.md) - - [SquareConnect.MeasurementUnitVolume](docs/MeasurementUnitVolume.md) - - [SquareConnect.MeasurementUnitWeight](docs/MeasurementUnitWeight.md) - - [SquareConnect.Merchant](docs/Merchant.md) - - [SquareConnect.MerchantStatus](docs/MerchantStatus.md) - - [SquareConnect.ModelBreak](docs/ModelBreak.md) - - [SquareConnect.Money](docs/Money.md) - - [SquareConnect.ObtainTokenRequest](docs/ObtainTokenRequest.md) - - [SquareConnect.ObtainTokenResponse](docs/ObtainTokenResponse.md) - - [SquareConnect.Order](docs/Order.md) - - [SquareConnect.OrderCreated](docs/OrderCreated.md) - - [SquareConnect.OrderCreatedObject](docs/OrderCreatedObject.md) - - [SquareConnect.OrderEntry](docs/OrderEntry.md) - - [SquareConnect.OrderFulfillment](docs/OrderFulfillment.md) - - [SquareConnect.OrderFulfillmentPickupDetails](docs/OrderFulfillmentPickupDetails.md) - - [SquareConnect.OrderFulfillmentPickupDetailsCurbsidePickupDetails](docs/OrderFulfillmentPickupDetailsCurbsidePickupDetails.md) - - [SquareConnect.OrderFulfillmentPickupDetailsScheduleType](docs/OrderFulfillmentPickupDetailsScheduleType.md) - - [SquareConnect.OrderFulfillmentRecipient](docs/OrderFulfillmentRecipient.md) - - [SquareConnect.OrderFulfillmentShipmentDetails](docs/OrderFulfillmentShipmentDetails.md) - - [SquareConnect.OrderFulfillmentState](docs/OrderFulfillmentState.md) - - [SquareConnect.OrderFulfillmentType](docs/OrderFulfillmentType.md) - - [SquareConnect.OrderFulfillmentUpdated](docs/OrderFulfillmentUpdated.md) - - [SquareConnect.OrderFulfillmentUpdatedObject](docs/OrderFulfillmentUpdatedObject.md) - - [SquareConnect.OrderFulfillmentUpdatedUpdate](docs/OrderFulfillmentUpdatedUpdate.md) - - [SquareConnect.OrderLineItem](docs/OrderLineItem.md) - - [SquareConnect.OrderLineItemAppliedDiscount](docs/OrderLineItemAppliedDiscount.md) - - [SquareConnect.OrderLineItemAppliedTax](docs/OrderLineItemAppliedTax.md) - - [SquareConnect.OrderLineItemDiscount](docs/OrderLineItemDiscount.md) - - [SquareConnect.OrderLineItemDiscountScope](docs/OrderLineItemDiscountScope.md) - - [SquareConnect.OrderLineItemDiscountType](docs/OrderLineItemDiscountType.md) - - [SquareConnect.OrderLineItemModifier](docs/OrderLineItemModifier.md) - - [SquareConnect.OrderLineItemTax](docs/OrderLineItemTax.md) - - [SquareConnect.OrderLineItemTaxScope](docs/OrderLineItemTaxScope.md) - - [SquareConnect.OrderLineItemTaxType](docs/OrderLineItemTaxType.md) - - [SquareConnect.OrderMoneyAmounts](docs/OrderMoneyAmounts.md) - - [SquareConnect.OrderPricingOptions](docs/OrderPricingOptions.md) - - [SquareConnect.OrderQuantityUnit](docs/OrderQuantityUnit.md) - - [SquareConnect.OrderReturn](docs/OrderReturn.md) - - [SquareConnect.OrderReturnDiscount](docs/OrderReturnDiscount.md) - - [SquareConnect.OrderReturnLineItem](docs/OrderReturnLineItem.md) - - [SquareConnect.OrderReturnLineItemModifier](docs/OrderReturnLineItemModifier.md) - - [SquareConnect.OrderReturnServiceCharge](docs/OrderReturnServiceCharge.md) - - [SquareConnect.OrderReturnTax](docs/OrderReturnTax.md) - - [SquareConnect.OrderReward](docs/OrderReward.md) - - [SquareConnect.OrderRoundingAdjustment](docs/OrderRoundingAdjustment.md) - - [SquareConnect.OrderServiceCharge](docs/OrderServiceCharge.md) - - [SquareConnect.OrderServiceChargeCalculationPhase](docs/OrderServiceChargeCalculationPhase.md) - - [SquareConnect.OrderSource](docs/OrderSource.md) - - [SquareConnect.OrderState](docs/OrderState.md) - - [SquareConnect.OrderUpdated](docs/OrderUpdated.md) - - [SquareConnect.OrderUpdatedObject](docs/OrderUpdatedObject.md) - - [SquareConnect.PayOrderRequest](docs/PayOrderRequest.md) - - [SquareConnect.PayOrderResponse](docs/PayOrderResponse.md) - - [SquareConnect.Payment](docs/Payment.md) - - [SquareConnect.PaymentOptions](docs/PaymentOptions.md) - - [SquareConnect.PaymentRefund](docs/PaymentRefund.md) - - [SquareConnect.ProcessingFee](docs/ProcessingFee.md) - - [SquareConnect.Product](docs/Product.md) - - [SquareConnect.ProductType](docs/ProductType.md) - - [SquareConnect.PublishInvoiceRequest](docs/PublishInvoiceRequest.md) - - [SquareConnect.PublishInvoiceResponse](docs/PublishInvoiceResponse.md) - - [SquareConnect.Range](docs/Range.md) - - [SquareConnect.RedeemLoyaltyRewardRequest](docs/RedeemLoyaltyRewardRequest.md) - - [SquareConnect.RedeemLoyaltyRewardResponse](docs/RedeemLoyaltyRewardResponse.md) - - [SquareConnect.Refund](docs/Refund.md) - - [SquareConnect.RefundPaymentRequest](docs/RefundPaymentRequest.md) - - [SquareConnect.RefundPaymentResponse](docs/RefundPaymentResponse.md) - - [SquareConnect.RefundStatus](docs/RefundStatus.md) - - [SquareConnect.RegisterDomainRequest](docs/RegisterDomainRequest.md) - - [SquareConnect.RegisterDomainResponse](docs/RegisterDomainResponse.md) - - [SquareConnect.RegisterDomainResponseStatus](docs/RegisterDomainResponseStatus.md) - - [SquareConnect.RemoveDisputeEvidenceRequest](docs/RemoveDisputeEvidenceRequest.md) - - [SquareConnect.RemoveDisputeEvidenceResponse](docs/RemoveDisputeEvidenceResponse.md) - - [SquareConnect.RemoveGroupFromCustomerRequest](docs/RemoveGroupFromCustomerRequest.md) - - [SquareConnect.RemoveGroupFromCustomerResponse](docs/RemoveGroupFromCustomerResponse.md) - - [SquareConnect.RenewTokenRequest](docs/RenewTokenRequest.md) - - [SquareConnect.RenewTokenResponse](docs/RenewTokenResponse.md) - - [SquareConnect.RetrieveCashDrawerShiftRequest](docs/RetrieveCashDrawerShiftRequest.md) - - [SquareConnect.RetrieveCashDrawerShiftResponse](docs/RetrieveCashDrawerShiftResponse.md) - - [SquareConnect.RetrieveCatalogObjectRequest](docs/RetrieveCatalogObjectRequest.md) - - [SquareConnect.RetrieveCatalogObjectResponse](docs/RetrieveCatalogObjectResponse.md) - - [SquareConnect.RetrieveCustomerGroupRequest](docs/RetrieveCustomerGroupRequest.md) - - [SquareConnect.RetrieveCustomerGroupResponse](docs/RetrieveCustomerGroupResponse.md) - - [SquareConnect.RetrieveCustomerRequest](docs/RetrieveCustomerRequest.md) - - [SquareConnect.RetrieveCustomerResponse](docs/RetrieveCustomerResponse.md) - - [SquareConnect.RetrieveCustomerSegmentRequest](docs/RetrieveCustomerSegmentRequest.md) - - [SquareConnect.RetrieveCustomerSegmentResponse](docs/RetrieveCustomerSegmentResponse.md) - - [SquareConnect.RetrieveDisputeEvidenceRequest](docs/RetrieveDisputeEvidenceRequest.md) - - [SquareConnect.RetrieveDisputeEvidenceResponse](docs/RetrieveDisputeEvidenceResponse.md) - - [SquareConnect.RetrieveDisputeRequest](docs/RetrieveDisputeRequest.md) - - [SquareConnect.RetrieveDisputeResponse](docs/RetrieveDisputeResponse.md) - - [SquareConnect.RetrieveEmployeeRequest](docs/RetrieveEmployeeRequest.md) - - [SquareConnect.RetrieveEmployeeResponse](docs/RetrieveEmployeeResponse.md) - - [SquareConnect.RetrieveInventoryAdjustmentRequest](docs/RetrieveInventoryAdjustmentRequest.md) - - [SquareConnect.RetrieveInventoryAdjustmentResponse](docs/RetrieveInventoryAdjustmentResponse.md) - - [SquareConnect.RetrieveInventoryChangesRequest](docs/RetrieveInventoryChangesRequest.md) - - [SquareConnect.RetrieveInventoryChangesResponse](docs/RetrieveInventoryChangesResponse.md) - - [SquareConnect.RetrieveInventoryCountRequest](docs/RetrieveInventoryCountRequest.md) - - [SquareConnect.RetrieveInventoryCountResponse](docs/RetrieveInventoryCountResponse.md) - - [SquareConnect.RetrieveInventoryPhysicalCountRequest](docs/RetrieveInventoryPhysicalCountRequest.md) - - [SquareConnect.RetrieveInventoryPhysicalCountResponse](docs/RetrieveInventoryPhysicalCountResponse.md) - - [SquareConnect.RetrieveLocationRequest](docs/RetrieveLocationRequest.md) - - [SquareConnect.RetrieveLocationResponse](docs/RetrieveLocationResponse.md) - - [SquareConnect.RetrieveLoyaltyAccountRequest](docs/RetrieveLoyaltyAccountRequest.md) - - [SquareConnect.RetrieveLoyaltyAccountResponse](docs/RetrieveLoyaltyAccountResponse.md) - - [SquareConnect.RetrieveLoyaltyRewardRequest](docs/RetrieveLoyaltyRewardRequest.md) - - [SquareConnect.RetrieveLoyaltyRewardResponse](docs/RetrieveLoyaltyRewardResponse.md) - - [SquareConnect.RetrieveMerchantRequest](docs/RetrieveMerchantRequest.md) - - [SquareConnect.RetrieveMerchantResponse](docs/RetrieveMerchantResponse.md) - - [SquareConnect.RetrieveOrderRequest](docs/RetrieveOrderRequest.md) - - [SquareConnect.RetrieveOrderResponse](docs/RetrieveOrderResponse.md) - - [SquareConnect.RetrieveSubscriptionRequest](docs/RetrieveSubscriptionRequest.md) - - [SquareConnect.RetrieveSubscriptionResponse](docs/RetrieveSubscriptionResponse.md) - - [SquareConnect.RetrieveTeamMemberRequest](docs/RetrieveTeamMemberRequest.md) - - [SquareConnect.RetrieveTeamMemberResponse](docs/RetrieveTeamMemberResponse.md) - - [SquareConnect.RetrieveTransactionRequest](docs/RetrieveTransactionRequest.md) - - [SquareConnect.RetrieveTransactionResponse](docs/RetrieveTransactionResponse.md) - - [SquareConnect.RetrieveWageSettingRequest](docs/RetrieveWageSettingRequest.md) - - [SquareConnect.RetrieveWageSettingResponse](docs/RetrieveWageSettingResponse.md) - - [SquareConnect.RevokeTokenRequest](docs/RevokeTokenRequest.md) - - [SquareConnect.RevokeTokenResponse](docs/RevokeTokenResponse.md) - - [SquareConnect.SearchCatalogItemsRequest](docs/SearchCatalogItemsRequest.md) - - [SquareConnect.SearchCatalogItemsRequestStockLevel](docs/SearchCatalogItemsRequestStockLevel.md) - - [SquareConnect.SearchCatalogItemsResponse](docs/SearchCatalogItemsResponse.md) - - [SquareConnect.SearchCatalogObjectsRequest](docs/SearchCatalogObjectsRequest.md) - - [SquareConnect.SearchCatalogObjectsResponse](docs/SearchCatalogObjectsResponse.md) - - [SquareConnect.SearchCustomersRequest](docs/SearchCustomersRequest.md) - - [SquareConnect.SearchCustomersResponse](docs/SearchCustomersResponse.md) - - [SquareConnect.SearchInvoicesRequest](docs/SearchInvoicesRequest.md) - - [SquareConnect.SearchInvoicesResponse](docs/SearchInvoicesResponse.md) - - [SquareConnect.SearchLoyaltyAccountsRequest](docs/SearchLoyaltyAccountsRequest.md) - - [SquareConnect.SearchLoyaltyAccountsRequestLoyaltyAccountQuery](docs/SearchLoyaltyAccountsRequestLoyaltyAccountQuery.md) - - [SquareConnect.SearchLoyaltyAccountsResponse](docs/SearchLoyaltyAccountsResponse.md) - - [SquareConnect.SearchLoyaltyEventsRequest](docs/SearchLoyaltyEventsRequest.md) - - [SquareConnect.SearchLoyaltyEventsResponse](docs/SearchLoyaltyEventsResponse.md) - - [SquareConnect.SearchLoyaltyRewardsRequest](docs/SearchLoyaltyRewardsRequest.md) - - [SquareConnect.SearchLoyaltyRewardsRequestLoyaltyRewardQuery](docs/SearchLoyaltyRewardsRequestLoyaltyRewardQuery.md) - - [SquareConnect.SearchLoyaltyRewardsResponse](docs/SearchLoyaltyRewardsResponse.md) - - [SquareConnect.SearchOrdersCustomerFilter](docs/SearchOrdersCustomerFilter.md) - - [SquareConnect.SearchOrdersDateTimeFilter](docs/SearchOrdersDateTimeFilter.md) - - [SquareConnect.SearchOrdersFilter](docs/SearchOrdersFilter.md) - - [SquareConnect.SearchOrdersFulfillmentFilter](docs/SearchOrdersFulfillmentFilter.md) - - [SquareConnect.SearchOrdersQuery](docs/SearchOrdersQuery.md) - - [SquareConnect.SearchOrdersRequest](docs/SearchOrdersRequest.md) - - [SquareConnect.SearchOrdersResponse](docs/SearchOrdersResponse.md) - - [SquareConnect.SearchOrdersSort](docs/SearchOrdersSort.md) - - [SquareConnect.SearchOrdersSortField](docs/SearchOrdersSortField.md) - - [SquareConnect.SearchOrdersSourceFilter](docs/SearchOrdersSourceFilter.md) - - [SquareConnect.SearchOrdersStateFilter](docs/SearchOrdersStateFilter.md) - - [SquareConnect.SearchShiftsRequest](docs/SearchShiftsRequest.md) - - [SquareConnect.SearchShiftsResponse](docs/SearchShiftsResponse.md) - - [SquareConnect.SearchSubscriptionsFilter](docs/SearchSubscriptionsFilter.md) - - [SquareConnect.SearchSubscriptionsQuery](docs/SearchSubscriptionsQuery.md) - - [SquareConnect.SearchSubscriptionsRequest](docs/SearchSubscriptionsRequest.md) - - [SquareConnect.SearchSubscriptionsResponse](docs/SearchSubscriptionsResponse.md) - - [SquareConnect.SearchTeamMembersFilter](docs/SearchTeamMembersFilter.md) - - [SquareConnect.SearchTeamMembersQuery](docs/SearchTeamMembersQuery.md) - - [SquareConnect.SearchTeamMembersRequest](docs/SearchTeamMembersRequest.md) - - [SquareConnect.SearchTeamMembersResponse](docs/SearchTeamMembersResponse.md) - - [SquareConnect.SearchTerminalCheckoutsRequest](docs/SearchTerminalCheckoutsRequest.md) - - [SquareConnect.SearchTerminalCheckoutsResponse](docs/SearchTerminalCheckoutsResponse.md) - - [SquareConnect.SearchTerminalRefundsRequest](docs/SearchTerminalRefundsRequest.md) - - [SquareConnect.SearchTerminalRefundsResponse](docs/SearchTerminalRefundsResponse.md) - - [SquareConnect.Shift](docs/Shift.md) - - [SquareConnect.ShiftFilter](docs/ShiftFilter.md) - - [SquareConnect.ShiftFilterStatus](docs/ShiftFilterStatus.md) - - [SquareConnect.ShiftQuery](docs/ShiftQuery.md) - - [SquareConnect.ShiftSort](docs/ShiftSort.md) - - [SquareConnect.ShiftSortField](docs/ShiftSortField.md) - - [SquareConnect.ShiftStatus](docs/ShiftStatus.md) - - [SquareConnect.ShiftWage](docs/ShiftWage.md) - - [SquareConnect.ShiftWorkday](docs/ShiftWorkday.md) - - [SquareConnect.ShiftWorkdayMatcher](docs/ShiftWorkdayMatcher.md) - - [SquareConnect.SortOrder](docs/SortOrder.md) - - [SquareConnect.SourceApplication](docs/SourceApplication.md) - - [SquareConnect.StandardUnitDescription](docs/StandardUnitDescription.md) - - [SquareConnect.StandardUnitDescriptionGroup](docs/StandardUnitDescriptionGroup.md) - - [SquareConnect.SubmitEvidenceRequest](docs/SubmitEvidenceRequest.md) - - [SquareConnect.SubmitEvidenceResponse](docs/SubmitEvidenceResponse.md) - - [SquareConnect.Subscription](docs/Subscription.md) - - [SquareConnect.SubscriptionCadence](docs/SubscriptionCadence.md) - - [SquareConnect.SubscriptionEvent](docs/SubscriptionEvent.md) - - [SquareConnect.SubscriptionEventSubscriptionEventType](docs/SubscriptionEventSubscriptionEventType.md) - - [SquareConnect.SubscriptionPhase](docs/SubscriptionPhase.md) - - [SquareConnect.SubscriptionStatus](docs/SubscriptionStatus.md) - - [SquareConnect.TaxCalculationPhase](docs/TaxCalculationPhase.md) - - [SquareConnect.TaxInclusionType](docs/TaxInclusionType.md) - - [SquareConnect.TeamMember](docs/TeamMember.md) - - [SquareConnect.TeamMemberAssignedLocations](docs/TeamMemberAssignedLocations.md) - - [SquareConnect.TeamMemberAssignedLocationsAssignmentType](docs/TeamMemberAssignedLocationsAssignmentType.md) - - [SquareConnect.TeamMemberStatus](docs/TeamMemberStatus.md) - - [SquareConnect.TeamMemberWage](docs/TeamMemberWage.md) - - [SquareConnect.Tender](docs/Tender.md) - - [SquareConnect.TenderCardDetails](docs/TenderCardDetails.md) - - [SquareConnect.TenderCardDetailsEntryMethod](docs/TenderCardDetailsEntryMethod.md) - - [SquareConnect.TenderCardDetailsStatus](docs/TenderCardDetailsStatus.md) - - [SquareConnect.TenderCashDetails](docs/TenderCashDetails.md) - - [SquareConnect.TenderType](docs/TenderType.md) - - [SquareConnect.TerminalCheckout](docs/TerminalCheckout.md) - - [SquareConnect.TerminalCheckoutQuery](docs/TerminalCheckoutQuery.md) - - [SquareConnect.TerminalCheckoutQueryFilter](docs/TerminalCheckoutQueryFilter.md) - - [SquareConnect.TerminalCheckoutQuerySort](docs/TerminalCheckoutQuerySort.md) - - [SquareConnect.TerminalRefund](docs/TerminalRefund.md) - - [SquareConnect.TerminalRefundQuery](docs/TerminalRefundQuery.md) - - [SquareConnect.TerminalRefundQueryFilter](docs/TerminalRefundQueryFilter.md) - - [SquareConnect.TerminalRefundQuerySort](docs/TerminalRefundQuerySort.md) - - [SquareConnect.TimeRange](docs/TimeRange.md) - - [SquareConnect.TipSettings](docs/TipSettings.md) - - [SquareConnect.Transaction](docs/Transaction.md) - - [SquareConnect.TransactionProduct](docs/TransactionProduct.md) - - [SquareConnect.TransactionType](docs/TransactionType.md) - - [SquareConnect.UpdateBreakTypeRequest](docs/UpdateBreakTypeRequest.md) - - [SquareConnect.UpdateBreakTypeResponse](docs/UpdateBreakTypeResponse.md) - - [SquareConnect.UpdateCustomerGroupRequest](docs/UpdateCustomerGroupRequest.md) - - [SquareConnect.UpdateCustomerGroupResponse](docs/UpdateCustomerGroupResponse.md) - - [SquareConnect.UpdateCustomerRequest](docs/UpdateCustomerRequest.md) - - [SquareConnect.UpdateCustomerResponse](docs/UpdateCustomerResponse.md) - - [SquareConnect.UpdateInvoiceRequest](docs/UpdateInvoiceRequest.md) - - [SquareConnect.UpdateInvoiceResponse](docs/UpdateInvoiceResponse.md) - - [SquareConnect.UpdateItemModifierListsRequest](docs/UpdateItemModifierListsRequest.md) - - [SquareConnect.UpdateItemModifierListsResponse](docs/UpdateItemModifierListsResponse.md) - - [SquareConnect.UpdateItemTaxesRequest](docs/UpdateItemTaxesRequest.md) - - [SquareConnect.UpdateItemTaxesResponse](docs/UpdateItemTaxesResponse.md) - - [SquareConnect.UpdateLocationRequest](docs/UpdateLocationRequest.md) - - [SquareConnect.UpdateLocationResponse](docs/UpdateLocationResponse.md) - - [SquareConnect.UpdateOrderRequest](docs/UpdateOrderRequest.md) - - [SquareConnect.UpdateOrderResponse](docs/UpdateOrderResponse.md) - - [SquareConnect.UpdateShiftRequest](docs/UpdateShiftRequest.md) - - [SquareConnect.UpdateShiftResponse](docs/UpdateShiftResponse.md) - - [SquareConnect.UpdateSubscriptionRequest](docs/UpdateSubscriptionRequest.md) - - [SquareConnect.UpdateSubscriptionResponse](docs/UpdateSubscriptionResponse.md) - - [SquareConnect.UpdateTeamMemberRequest](docs/UpdateTeamMemberRequest.md) - - [SquareConnect.UpdateTeamMemberResponse](docs/UpdateTeamMemberResponse.md) - - [SquareConnect.UpdateWageSettingRequest](docs/UpdateWageSettingRequest.md) - - [SquareConnect.UpdateWageSettingResponse](docs/UpdateWageSettingResponse.md) - - [SquareConnect.UpdateWorkweekConfigRequest](docs/UpdateWorkweekConfigRequest.md) - - [SquareConnect.UpdateWorkweekConfigResponse](docs/UpdateWorkweekConfigResponse.md) - - [SquareConnect.UpsertCatalogObjectRequest](docs/UpsertCatalogObjectRequest.md) - - [SquareConnect.UpsertCatalogObjectResponse](docs/UpsertCatalogObjectResponse.md) - - [SquareConnect.V1AdjustInventoryRequest](docs/V1AdjustInventoryRequest.md) - - [SquareConnect.V1AdjustInventoryRequestAdjustmentType](docs/V1AdjustInventoryRequestAdjustmentType.md) - - [SquareConnect.V1ApplyFeeRequest](docs/V1ApplyFeeRequest.md) - - [SquareConnect.V1ApplyModifierListRequest](docs/V1ApplyModifierListRequest.md) - - [SquareConnect.V1BankAccount](docs/V1BankAccount.md) - - [SquareConnect.V1BankAccountType](docs/V1BankAccountType.md) - - [SquareConnect.V1CashDrawerEvent](docs/V1CashDrawerEvent.md) - - [SquareConnect.V1CashDrawerEventEventType](docs/V1CashDrawerEventEventType.md) - - [SquareConnect.V1CashDrawerShift](docs/V1CashDrawerShift.md) - - [SquareConnect.V1CashDrawerShiftEventType](docs/V1CashDrawerShiftEventType.md) - - [SquareConnect.V1Category](docs/V1Category.md) - - [SquareConnect.V1CreateCategoryRequest](docs/V1CreateCategoryRequest.md) - - [SquareConnect.V1CreateDiscountRequest](docs/V1CreateDiscountRequest.md) - - [SquareConnect.V1CreateEmployeeRoleRequest](docs/V1CreateEmployeeRoleRequest.md) - - [SquareConnect.V1CreateFeeRequest](docs/V1CreateFeeRequest.md) - - [SquareConnect.V1CreateItemRequest](docs/V1CreateItemRequest.md) - - [SquareConnect.V1CreateModifierListRequest](docs/V1CreateModifierListRequest.md) - - [SquareConnect.V1CreateModifierOptionRequest](docs/V1CreateModifierOptionRequest.md) - - [SquareConnect.V1CreatePageRequest](docs/V1CreatePageRequest.md) - - [SquareConnect.V1CreateRefundRequest](docs/V1CreateRefundRequest.md) - - [SquareConnect.V1CreateRefundRequestType](docs/V1CreateRefundRequestType.md) - - [SquareConnect.V1CreateVariationRequest](docs/V1CreateVariationRequest.md) - - [SquareConnect.V1DeleteCategoryRequest](docs/V1DeleteCategoryRequest.md) - - [SquareConnect.V1DeleteDiscountRequest](docs/V1DeleteDiscountRequest.md) - - [SquareConnect.V1DeleteFeeRequest](docs/V1DeleteFeeRequest.md) - - [SquareConnect.V1DeleteItemRequest](docs/V1DeleteItemRequest.md) - - [SquareConnect.V1DeleteModifierListRequest](docs/V1DeleteModifierListRequest.md) - - [SquareConnect.V1DeleteModifierOptionRequest](docs/V1DeleteModifierOptionRequest.md) - - [SquareConnect.V1DeletePageCellRequest](docs/V1DeletePageCellRequest.md) - - [SquareConnect.V1DeletePageRequest](docs/V1DeletePageRequest.md) - - [SquareConnect.V1DeleteTimecardRequest](docs/V1DeleteTimecardRequest.md) - - [SquareConnect.V1DeleteTimecardResponse](docs/V1DeleteTimecardResponse.md) - - [SquareConnect.V1DeleteVariationRequest](docs/V1DeleteVariationRequest.md) - - [SquareConnect.V1Discount](docs/V1Discount.md) - - [SquareConnect.V1DiscountColor](docs/V1DiscountColor.md) - - [SquareConnect.V1DiscountDiscountType](docs/V1DiscountDiscountType.md) - - [SquareConnect.V1Employee](docs/V1Employee.md) - - [SquareConnect.V1EmployeeRole](docs/V1EmployeeRole.md) - - [SquareConnect.V1EmployeeRolePermissions](docs/V1EmployeeRolePermissions.md) - - [SquareConnect.V1EmployeeStatus](docs/V1EmployeeStatus.md) - - [SquareConnect.V1Fee](docs/V1Fee.md) - - [SquareConnect.V1FeeAdjustmentType](docs/V1FeeAdjustmentType.md) - - [SquareConnect.V1FeeCalculationPhase](docs/V1FeeCalculationPhase.md) - - [SquareConnect.V1FeeInclusionType](docs/V1FeeInclusionType.md) - - [SquareConnect.V1FeeType](docs/V1FeeType.md) - - [SquareConnect.V1InventoryEntry](docs/V1InventoryEntry.md) - - [SquareConnect.V1Item](docs/V1Item.md) - - [SquareConnect.V1ItemColor](docs/V1ItemColor.md) - - [SquareConnect.V1ItemImage](docs/V1ItemImage.md) - - [SquareConnect.V1ItemType](docs/V1ItemType.md) - - [SquareConnect.V1ItemVisibility](docs/V1ItemVisibility.md) - - [SquareConnect.V1ListBankAccountsRequest](docs/V1ListBankAccountsRequest.md) - - [SquareConnect.V1ListBankAccountsResponse](docs/V1ListBankAccountsResponse.md) - - [SquareConnect.V1ListCashDrawerShiftsRequest](docs/V1ListCashDrawerShiftsRequest.md) - - [SquareConnect.V1ListCashDrawerShiftsResponse](docs/V1ListCashDrawerShiftsResponse.md) - - [SquareConnect.V1ListCategoriesRequest](docs/V1ListCategoriesRequest.md) - - [SquareConnect.V1ListCategoriesResponse](docs/V1ListCategoriesResponse.md) - - [SquareConnect.V1ListDiscountsRequest](docs/V1ListDiscountsRequest.md) - - [SquareConnect.V1ListDiscountsResponse](docs/V1ListDiscountsResponse.md) - - [SquareConnect.V1ListEmployeeRolesRequest](docs/V1ListEmployeeRolesRequest.md) - - [SquareConnect.V1ListEmployeeRolesResponse](docs/V1ListEmployeeRolesResponse.md) - - [SquareConnect.V1ListEmployeesRequest](docs/V1ListEmployeesRequest.md) - - [SquareConnect.V1ListEmployeesRequestStatus](docs/V1ListEmployeesRequestStatus.md) - - [SquareConnect.V1ListEmployeesResponse](docs/V1ListEmployeesResponse.md) - - [SquareConnect.V1ListFeesRequest](docs/V1ListFeesRequest.md) - - [SquareConnect.V1ListFeesResponse](docs/V1ListFeesResponse.md) - - [SquareConnect.V1ListInventoryRequest](docs/V1ListInventoryRequest.md) - - [SquareConnect.V1ListInventoryResponse](docs/V1ListInventoryResponse.md) - - [SquareConnect.V1ListItemsRequest](docs/V1ListItemsRequest.md) - - [SquareConnect.V1ListItemsResponse](docs/V1ListItemsResponse.md) - - [SquareConnect.V1ListLocationsRequest](docs/V1ListLocationsRequest.md) - - [SquareConnect.V1ListLocationsResponse](docs/V1ListLocationsResponse.md) - - [SquareConnect.V1ListModifierListsRequest](docs/V1ListModifierListsRequest.md) - - [SquareConnect.V1ListModifierListsResponse](docs/V1ListModifierListsResponse.md) - - [SquareConnect.V1ListOrdersRequest](docs/V1ListOrdersRequest.md) - - [SquareConnect.V1ListOrdersResponse](docs/V1ListOrdersResponse.md) - - [SquareConnect.V1ListPagesRequest](docs/V1ListPagesRequest.md) - - [SquareConnect.V1ListPagesResponse](docs/V1ListPagesResponse.md) - - [SquareConnect.V1ListPaymentsRequest](docs/V1ListPaymentsRequest.md) - - [SquareConnect.V1ListPaymentsResponse](docs/V1ListPaymentsResponse.md) - - [SquareConnect.V1ListRefundsRequest](docs/V1ListRefundsRequest.md) - - [SquareConnect.V1ListRefundsResponse](docs/V1ListRefundsResponse.md) - - [SquareConnect.V1ListSettlementsRequest](docs/V1ListSettlementsRequest.md) - - [SquareConnect.V1ListSettlementsRequestStatus](docs/V1ListSettlementsRequestStatus.md) - - [SquareConnect.V1ListSettlementsResponse](docs/V1ListSettlementsResponse.md) - - [SquareConnect.V1ListTimecardEventsRequest](docs/V1ListTimecardEventsRequest.md) - - [SquareConnect.V1ListTimecardEventsResponse](docs/V1ListTimecardEventsResponse.md) - - [SquareConnect.V1ListTimecardsRequest](docs/V1ListTimecardsRequest.md) - - [SquareConnect.V1ListTimecardsResponse](docs/V1ListTimecardsResponse.md) - - [SquareConnect.V1Merchant](docs/V1Merchant.md) - - [SquareConnect.V1MerchantAccountType](docs/V1MerchantAccountType.md) - - [SquareConnect.V1MerchantBusinessType](docs/V1MerchantBusinessType.md) - - [SquareConnect.V1MerchantLocationDetails](docs/V1MerchantLocationDetails.md) - - [SquareConnect.V1ModifierList](docs/V1ModifierList.md) - - [SquareConnect.V1ModifierListSelectionType](docs/V1ModifierListSelectionType.md) - - [SquareConnect.V1ModifierOption](docs/V1ModifierOption.md) - - [SquareConnect.V1Money](docs/V1Money.md) - - [SquareConnect.V1Order](docs/V1Order.md) - - [SquareConnect.V1OrderHistoryEntry](docs/V1OrderHistoryEntry.md) - - [SquareConnect.V1OrderHistoryEntryAction](docs/V1OrderHistoryEntryAction.md) - - [SquareConnect.V1OrderState](docs/V1OrderState.md) - - [SquareConnect.V1Page](docs/V1Page.md) - - [SquareConnect.V1PageCell](docs/V1PageCell.md) - - [SquareConnect.V1PageCellObjectType](docs/V1PageCellObjectType.md) - - [SquareConnect.V1PageCellPlaceholderType](docs/V1PageCellPlaceholderType.md) - - [SquareConnect.V1Payment](docs/V1Payment.md) - - [SquareConnect.V1PaymentDiscount](docs/V1PaymentDiscount.md) - - [SquareConnect.V1PaymentItemDetail](docs/V1PaymentItemDetail.md) - - [SquareConnect.V1PaymentItemization](docs/V1PaymentItemization.md) - - [SquareConnect.V1PaymentItemizationItemizationType](docs/V1PaymentItemizationItemizationType.md) - - [SquareConnect.V1PaymentModifier](docs/V1PaymentModifier.md) - - [SquareConnect.V1PaymentSurcharge](docs/V1PaymentSurcharge.md) - - [SquareConnect.V1PaymentSurchargeType](docs/V1PaymentSurchargeType.md) - - [SquareConnect.V1PaymentTax](docs/V1PaymentTax.md) - - [SquareConnect.V1PaymentTaxInclusionType](docs/V1PaymentTaxInclusionType.md) - - [SquareConnect.V1PhoneNumber](docs/V1PhoneNumber.md) - - [SquareConnect.V1Refund](docs/V1Refund.md) - - [SquareConnect.V1RefundType](docs/V1RefundType.md) - - [SquareConnect.V1RemoveFeeRequest](docs/V1RemoveFeeRequest.md) - - [SquareConnect.V1RemoveModifierListRequest](docs/V1RemoveModifierListRequest.md) - - [SquareConnect.V1RetrieveBankAccountRequest](docs/V1RetrieveBankAccountRequest.md) - - [SquareConnect.V1RetrieveBusinessRequest](docs/V1RetrieveBusinessRequest.md) - - [SquareConnect.V1RetrieveCashDrawerShiftRequest](docs/V1RetrieveCashDrawerShiftRequest.md) - - [SquareConnect.V1RetrieveEmployeeRequest](docs/V1RetrieveEmployeeRequest.md) - - [SquareConnect.V1RetrieveEmployeeRoleRequest](docs/V1RetrieveEmployeeRoleRequest.md) - - [SquareConnect.V1RetrieveItemRequest](docs/V1RetrieveItemRequest.md) - - [SquareConnect.V1RetrieveModifierListRequest](docs/V1RetrieveModifierListRequest.md) - - [SquareConnect.V1RetrieveOrderRequest](docs/V1RetrieveOrderRequest.md) - - [SquareConnect.V1RetrievePaymentRequest](docs/V1RetrievePaymentRequest.md) - - [SquareConnect.V1RetrieveSettlementRequest](docs/V1RetrieveSettlementRequest.md) - - [SquareConnect.V1RetrieveTimecardRequest](docs/V1RetrieveTimecardRequest.md) - - [SquareConnect.V1Settlement](docs/V1Settlement.md) - - [SquareConnect.V1SettlementEntry](docs/V1SettlementEntry.md) - - [SquareConnect.V1SettlementEntryType](docs/V1SettlementEntryType.md) - - [SquareConnect.V1SettlementStatus](docs/V1SettlementStatus.md) - - [SquareConnect.V1Tender](docs/V1Tender.md) - - [SquareConnect.V1TenderCardBrand](docs/V1TenderCardBrand.md) - - [SquareConnect.V1TenderEntryMethod](docs/V1TenderEntryMethod.md) - - [SquareConnect.V1TenderType](docs/V1TenderType.md) - - [SquareConnect.V1Timecard](docs/V1Timecard.md) - - [SquareConnect.V1TimecardEvent](docs/V1TimecardEvent.md) - - [SquareConnect.V1TimecardEventEventType](docs/V1TimecardEventEventType.md) - - [SquareConnect.V1UpdateCategoryRequest](docs/V1UpdateCategoryRequest.md) - - [SquareConnect.V1UpdateDiscountRequest](docs/V1UpdateDiscountRequest.md) - - [SquareConnect.V1UpdateEmployeeRequest](docs/V1UpdateEmployeeRequest.md) - - [SquareConnect.V1UpdateEmployeeRoleRequest](docs/V1UpdateEmployeeRoleRequest.md) - - [SquareConnect.V1UpdateFeeRequest](docs/V1UpdateFeeRequest.md) - - [SquareConnect.V1UpdateItemRequest](docs/V1UpdateItemRequest.md) - - [SquareConnect.V1UpdateModifierListRequest](docs/V1UpdateModifierListRequest.md) - - [SquareConnect.V1UpdateModifierListRequestSelectionType](docs/V1UpdateModifierListRequestSelectionType.md) - - [SquareConnect.V1UpdateModifierOptionRequest](docs/V1UpdateModifierOptionRequest.md) - - [SquareConnect.V1UpdateOrderRequest](docs/V1UpdateOrderRequest.md) - - [SquareConnect.V1UpdateOrderRequestAction](docs/V1UpdateOrderRequestAction.md) - - [SquareConnect.V1UpdatePageCellRequest](docs/V1UpdatePageCellRequest.md) - - [SquareConnect.V1UpdatePageRequest](docs/V1UpdatePageRequest.md) - - [SquareConnect.V1UpdateTimecardRequest](docs/V1UpdateTimecardRequest.md) - - [SquareConnect.V1UpdateVariationRequest](docs/V1UpdateVariationRequest.md) - - [SquareConnect.V1Variation](docs/V1Variation.md) - - [SquareConnect.V1VariationInventoryAlertType](docs/V1VariationInventoryAlertType.md) - - [SquareConnect.V1VariationPricingType](docs/V1VariationPricingType.md) - - [SquareConnect.VersionedCatalogObject](docs/VersionedCatalogObject.md) - - [SquareConnect.VoidTransactionRequest](docs/VoidTransactionRequest.md) - - [SquareConnect.VoidTransactionResponse](docs/VoidTransactionResponse.md) - - [SquareConnect.WageSetting](docs/WageSetting.md) - - [SquareConnect.Weekday](docs/Weekday.md) - - [SquareConnect.WorkweekConfig](docs/WorkweekConfig.md) +// To access sandbox resources, set the basePath to the sandbox URL +//defaultClient.basePath = 'https://connect.squareupsandbox.com'; +// Configure OAuth2 access token for authorization: oauth2 +var oauth2 = defaultClient.authentications['oauth2']; +oauth2.accessToken = process.env.SQUARE_ACCESS_TOKEN; +``` -## Documentation for Authorization +#### New Square SDK +This is how you can do the same thing with the new `square` library. You can import using the ES module or CommonJS module syntax, but you should not mix the two import styles in the same codebase. +**Option 1: ES module import example** (recommended) +```javascript +import { ApiError, Client, Environment } from 'square' -### oauth2 +const client = new Client({ + timeout:3000, + environment: Environment.Production, // `Environment.Sandbox` to access sandbox resources + accessToken: process.env.SQUARE_ACCESS_TOKEN, +}) +``` +**Option 2: CommonJS module import example** +```javascript +const { ApiError, Client, Environment } = require('square') -- **Type**: OAuth -- **Flow**: accessCode -- **Authorization URL**: https://connect.squareup.com/oauth2/authorize -- **Scopes**: - - BANK_ACCOUNTS_READ: __HTTP Method__: `GET` Grants read access to bank account information associated with the targeted Square account. For example, to call the Connect v1 ListBankAccounts endpoint. - - CASH_DRAWER_READ: __HTTP Method__: `GET` Grants read access to cash drawer shift information. For example, to call the ListCashDrawerShifts endpoint. - - CUSTOMERS_READ: __HTTP Method__: `GET` Grants read access to customer information. For example, to call the ListCustomers endpoint. - - CUSTOMERS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to customer information. For example, to create and update customer profiles. - - DEVICE_CREDENTIAL_MANAGEMENT: __HTTP Method__: `POST`, `GET` Grants read/write access to device credentials information. For example, to call the CreateDeviceCode endpoint. - - EMPLOYEES_READ: __HTTP Method__: `GET` Grants read access to employee profile information. For example, to call the Connect v1 Employees API. - - EMPLOYEES_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee profile information. For example, to create and modify employee profiles. - - INVENTORY_READ: __HTTP Method__: `GET` Grants read access to inventory information. For example, to call the RetrieveInventoryCount endpoint. - - INVENTORY_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to inventory information. For example, to call the BatchChangeInventory endpoint. - - ITEMS_READ: __HTTP Method__: `GET` Grants read access to business and location information. For example, to obtain a location ID for subsequent activity. - - ITEMS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to product catalog information. For example, to modify or add to a product catalog. - - LOYALTY_READ: __HTTP Method__: `GET` Grants read access to loyalty information. For example, to call the ListLoyaltyPrograms endpoint. - - LOYALTY_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to loyalty information. For example, to call the CreateLoyaltyAccount endpoint. - - MERCHANT_PROFILE_READ: __HTTP Method__: `GET` Grants read access to business and location information. For example, to obtain a location ID for subsequent activity. - - ORDERS_READ: __HTTP Method__: `GET` Grants read access to order information. For example, to call the BatchRetrieveOrders endpoint. - - ORDERS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to order information. For example, to call the CreateCheckout endpoint. - - PAYMENTS_READ: __HTTP Method__: `GET` Grants read access to transaction and refund information. For example, to call the RetrieveTransaction endpoint. - - PAYMENTS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to transaction and refunds information. For example, to process payments with the Payments or Checkout API. - - PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS: __HTTP Method__: `POST`, `PUT`, `DELETE` Allow third party applications to deduct a portion of each transaction amount. __Required__ to use multiparty transaction functionality with the Payments API. - - PAYMENTS_WRITE_IN_PERSON: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to payments and refunds information. For example, to process in-person payments. - - SETTLEMENTS_READ: __HTTP Method__: `GET` Grants read access to settlement (deposit) information. For example, to call the Connect v1 ListSettlements endpoint. - - TIMECARDS_READ: __HTTP Method__: `GET` Grants read access to employee timecard information. For example, to call the Connect v2 SearchShifts endpoint. - - TIMECARDS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee shift information. For example, to create and modify employee shifts. - - TIMECARDS_SETTINGS_READ: __HTTP Method__: `GET` Grants read access to employee timecard settings information. For example, to call the GetBreakType endpoint. - - TIMECARDS_SETTINGS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee timecard settings information. For example, to call the UpdateBreakType endpoint. +const client = new Client({ + timeout:3000, + environment: Environment.Production, // `Environment.Sandbox` to access sandbox resources + accessToken: process.env.SQUARE_ACCESS_TOKEN, +}) +``` -### oauth2ClientSecret +### Example code migration +As a specific example, consider the code for creating a customer in the sandbox environment. -- **Type**: API key -- **API key parameter name**: Authorization -- **Location**: HTTP header +#### Deprecated Connect SDK +The following example uses the `square-connect` library to create a customer. +```javascript +var SquareConnect = require('square-connect'); +// Instantiate and initialize the API client +var defaultClient = SquareConnect.ApiClient.instance; +defaultClient.basePath = 'https://connect.squareupsandbox.com'; +var oauth2 = defaultClient.authentications['oauth2']; +oauth2.accessToken = process.env.SQUARE_ACCESS_TOKEN; -## Pagination of V1 Endpoints +// Unique key to ensure this operation runs only once if you need to retry +var idempotencyKey = "unique_key"; -V1 Endpoints return pagination information via HTTP headers. In order to obtain -response headers and extract the `batch_token` parameter you will need to follow -the following steps: +var requestBody = SquareConnect.CreateCustomerRequest.constructFromObject({ + idempotency_key: idempotencyKey, // Parameters use snake case + given_name: "Amelia", + family_name: "Earhart", + email_address: "Amelia.Earhart@aviators.com" +}); -1. Use the full information endpoint methods of each API to get the response HTTP -Headers. They are named as their simple counterpart with a `WithHttpInfo` suffix. -Hence `listEmployeeRoles` would be called `listEmployeeRolesWithHttpInfo`. This -method returns a `CompleteResponse` object with the response data deserialized along -with a helper to retrieve the token if present. +// Get an instance of the Square API you want call +var customersApi = new SquareConnect.CustomersApi(); -2. Use `var batchToken = completeResponse.batch_token;` -to extract the token and proceed to get the following page if a token is present. +// Call the API +customersApi.createCustomer(requestBody).then(function(result) { + console.log('API called successfully. Returned data: ' + JSON.stringify(result, 0, 1)); +}, function(error) { + console.error(error); +}); +``` -### Example +#### New Square SDK +Now consider equivalent code that uses the new `square` library. Note the following: + * Calls to a Square API must be wrapped in an asynchronous function. + * Parameter names must be changed from snake case to camel case, for example from `location_id` to `locationId`. + * Square API calls return an ApiResponse or throw an ApiError. Use a try/catch statement to check whether the response succeeded or failed. Both objects contain properties that describe the request (`headers` and `request`) and the response (`statusCode`, `body`, and `result`). The response payload is returned as text in the `body` property or as a dictionary in the `result` property. ```javascript -var SquareConnect = require('square-connect'); -var defaultClient = SquareConnect.ApiClient.instance; - -// Configure OAuth2 access token for authorization: oauth2 -var oauth2 = defaultClient.authentications['oauth2']; -oauth2.accessToken = "YOUR ACCESS TOKEN"; - - -var api = new SquareConnect.V1EmployeesApi(); - -var opts = { - order: "order_example", - limit: 56, - batch_token: null -} +import { ApiError, Client, Environment } from 'square' + +// Instantiate and initialize the API client +const client = new Client({ + environment: Environment.Sandbox, + accessToken: process.env.SQUARE_ACCESS_TOKEN, +}) + +// Get an instance of the Square API you want call +const { customersApi } = client + +// Unique key to ensure this operation runs only once if you need to retry +let idempotencyKey = "unique_key" + +// Call the API from within an async function +const createCustomer = async () => { + let requestBody = { + idempotencyKey: idempotencyKey, // Parameters use camel case + givenName: "Amelia", + familyName: "Earhart", + emailAddress: "Amelia.Earhart@aviators.com" + } -function getAllEmployeeRoles(batch_token){ - if (batch_token) { - api.listEmployeeRolesWithHttpInfo(opts).then(function(resp) { - var batch_token = resp.batch_token; - opts['batch_token'] = batch_token; - getAllEmployeeRoles(token); - }, function(error) { - console.error(error); - }); + // Use a try/catch statement to check if the response succeeded or failed + try { + let { result } = await customersApi.createCustomer(requestBody) + console.log('API called successfully. Returned data: 'result) + } catch (error) { + if (error instanceof ApiError) { + console.log("Errors: ", error.errors) + } else { + console.log("Unexpected Error: ", error) + } } } - -getAllEmployeeRoles(true); +createCustomer() ``` -## Contributing +That's it! -Send bug reports, feature requests, and code contributions to the [API -specifications repository](https://github.com/square/connect-api-specification), -as this repository contains only the generated SDK code. +For more information about using the new Square SDK, see the [Square Node.js SDK] on GitHub. -## License +For more examples that use the new Square SDK, see the [Square Connect API Examples] on GitHub. -``` -Copyright 2017 Square, Inc. - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at +--- - http://www.apache.org/licenses/LICENSE-2.0 +
-Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. -``` +## Ask the community +Please join us in our [Square developer community] if you have any questions or feedback! [//]: # "Link anchor definitions" -[Square Logo]: https://docs.connect.squareup.com/images/github/github-square-logo.svg +[square/square-nodejs-sdk]: https://github.com/square/square-nodejs-sdk +[Square Node.js SDK]: https://github.com/square/square-nodejs-sdk +[Square API Lifecycle documentation]: https://developer.squareup.com/docs/build-basics/api-lifecycle#deprecated-apis +[/docs]: https://github.com/square/connect-nodejs-sdk/tree/master/docs/README.md +[Square Connect API Examples]: https://github.com/square/connect-api-examples/tree/master/connect-examples/v2 +[Square developer community]: https://squ.re/slack diff --git a/docs/AppointmentSegment.md b/docs/AppointmentSegment.md new file mode 100644 index 0000000..59539ab --- /dev/null +++ b/docs/AppointmentSegment.md @@ -0,0 +1,16 @@ +# SquareConnect.AppointmentSegment + +### Description +**Note: This model is in beta.** + +Defines an appointment segment of a booking. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**duration_minutes** | **Number** | The time span in minutes of an appointment segment. | +**service_variation_id** | **String** | The ID of the `CatalogItemVariation` object representing the service booked in this segment. | +**team_member_id** | **String** | The ID of the `TeamMember` object representing the team member booked in this segment. | +**service_variation_version** | **Number** | The current version of the item variation representing the service booked in this segment. | + + diff --git a/docs/Availability.md b/docs/Availability.md new file mode 100644 index 0000000..4368e10 --- /dev/null +++ b/docs/Availability.md @@ -0,0 +1,15 @@ +# SquareConnect.Availability + +### Description +**Note: This model is in beta.** + +Describes a slot available for booking, encapsulating appointment segments, the location and starting time. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_at** | **String** | The RFC-3339 timestamp specifying the beginning time of the slot available for booking. | [optional] +**location_id** | **String** | The ID of the location available for booking. | [optional] +**appointment_segments** | [**[AppointmentSegment]**](AppointmentSegment.md) | The list of appointment segments available for booking | [optional] + + diff --git a/docs/BalancePaymentDetails.md b/docs/BalancePaymentDetails.md index a2542a4..a0e18c9 100644 --- a/docs/BalancePaymentDetails.md +++ b/docs/BalancePaymentDetails.md @@ -7,7 +7,7 @@ Reflects the current status of a balance payment. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**account_id** | **String** | ID for the account used to fund the payment. | [optional] -**status** | **String** | The balance payment’s current state. Can be `COMPLETED` or `FAILED`. | [optional] +**account_id** | **String** | The ID of the account used to fund the payment. | [optional] +**status** | **String** | The balance payment’s current state. The state can be COMPLETED or FAILED. | [optional] diff --git a/docs/Booking.md b/docs/Booking.md new file mode 100644 index 0000000..e119840 --- /dev/null +++ b/docs/Booking.md @@ -0,0 +1,23 @@ +# SquareConnect.Booking + +### Description +**Note: This model is in beta.** + +Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service at a given location to a requesting customer in one or more appointment segments. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | A unique ID of this object representing a booking. | [optional] +**version** | **Number** | The revision number for the booking used for optimistic concurrency. | [optional] +**status** | **String** | The status of the booking, describing where the booking stands with respect to the booking state machine. See [BookingStatus](#type-bookingstatus) for possible values | [optional] +**created_at** | **String** | The timestamp specifying the creation time of this booking. | [optional] +**updated_at** | **String** | The timestamp specifying the most recent update time of this booking. | [optional] +**start_at** | **String** | The timestamp specifying the starting time of this booking. | [optional] +**location_id** | **String** | The ID of the `Location` object representing the location where the booked service is provided. | [optional] +**customer_id** | **String** | The ID of the `Customer` object representing the customer attending this booking | [optional] +**customer_note** | **String** | The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant `CatalogObject` instance. | [optional] +**seller_note** | **String** | The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific `CatalogObject` instance. This field should not be visible to customers. | [optional] +**appointment_segments** | [**[AppointmentSegment]**](AppointmentSegment.md) | A list of appointment segments for this booking. | [optional] + + diff --git a/docs/BookingStatus.md b/docs/BookingStatus.md new file mode 100644 index 0000000..cac5429 --- /dev/null +++ b/docs/BookingStatus.md @@ -0,0 +1,18 @@ +# SquareConnect.BookingStatus + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `CANCELLED_BY_CUSTOMER` (value: `"CANCELLED_BY_CUSTOMER"`) + +* `CANCELLED_BY_SELLER` (value: `"CANCELLED_BY_SELLER"`) + +* `DECLINED` (value: `"DECLINED"`) + +* `ACCEPTED` (value: `"ACCEPTED"`) + +* `NO_SHOW` (value: `"NO_SHOW"`) + + diff --git a/docs/BookingsApi.md b/docs/BookingsApi.md new file mode 100644 index 0000000..ea048ce --- /dev/null +++ b/docs/BookingsApi.md @@ -0,0 +1,362 @@ +# SquareConnect.BookingsApi + +All URIs are relative to *https://connect.squareup.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createBooking**](BookingsApi.md#createBooking) | **POST** /v2/bookings | CreateBooking +[**listTeamMemberBookingProfiles**](BookingsApi.md#listTeamMemberBookingProfiles) | **GET** /v2/bookings/team-member-booking-profiles | ListTeamMemberBookingProfiles +[**retrieveBooking**](BookingsApi.md#retrieveBooking) | **GET** /v2/bookings/{booking_id} | RetrieveBooking +[**retrieveBusinessBookingProfile**](BookingsApi.md#retrieveBusinessBookingProfile) | **GET** /v2/bookings/business-booking-profile | RetrieveBusinessBookingProfile +[**retrieveTeamMemberBookingProfile**](BookingsApi.md#retrieveTeamMemberBookingProfile) | **GET** /v2/bookings/team-member-booking-profiles/{team_member_id} | RetrieveTeamMemberBookingProfile +[**searchAvailability**](BookingsApi.md#searchAvailability) | **POST** /v2/bookings/availability/search | SearchAvailability +[**updateBooking**](BookingsApi.md#updateBooking) | **PUT** /v2/bookings/{booking_id} | UpdateBooking + + + +# **createBooking** +**Note: This endpoint is in beta.** +> CreateBookingResponse createBooking(body) + +CreateBooking + +Creates a booking. + +### Example +```javascript +var SquareConnect = require('square-connect'); +var defaultClient = SquareConnect.ApiClient.instance; + +// Configure OAuth2 access token for authorization: oauth2 +var oauth2 = defaultClient.authentications['oauth2']; +oauth2.accessToken = 'YOUR ACCESS TOKEN'; + +var apiInstance = new SquareConnect.BookingsApi(); + +var body = SquareConnect.BookingsApi.constructFromObject({}); // CreateBookingRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. + +apiInstance.createBooking(body).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateBookingRequest**](CreateBookingRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**CreateBookingResponse**](CreateBookingResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **listTeamMemberBookingProfiles** +**Note: This endpoint is in beta.** +> ListTeamMemberBookingProfilesResponse listTeamMemberBookingProfiles(opts) + +ListTeamMemberBookingProfiles + +Lists booking profiles for team members. + +### Example +```javascript +var SquareConnect = require('square-connect'); +var defaultClient = SquareConnect.ApiClient.instance; + +// Configure OAuth2 access token for authorization: oauth2 +var oauth2 = defaultClient.authentications['oauth2']; +oauth2.accessToken = 'YOUR ACCESS TOKEN'; + +var apiInstance = new SquareConnect.BookingsApi(); + +var opts = { + 'bookableOnly': SquareConnect.BookingsApi.constructFromObject({});, // Boolean | Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`). + 'limit': SquareConnect.BookingsApi.constructFromObject({});, // Number | The maximum number of results to return. + 'cursor': SquareConnect.BookingsApi.constructFromObject({});, // String | The cursor for paginating through the results. + 'locationId': SquareConnect.BookingsApi.constructFromObject({}); // String | Indicates whether to include only team members enabled at the given location in the returned result. +}; +apiInstance.listTeamMemberBookingProfiles(opts).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bookableOnly** | **Boolean**| Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`). | [optional] + **limit** | **Number**| The maximum number of results to return. | [optional] + **cursor** | **String**| The cursor for paginating through the results. | [optional] + **locationId** | **String**| Indicates whether to include only team members enabled at the given location in the returned result. | [optional] + +### Return type + +[**ListTeamMemberBookingProfilesResponse**](ListTeamMemberBookingProfilesResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **retrieveBooking** +**Note: This endpoint is in beta.** +> RetrieveBookingResponse retrieveBooking(bookingId) + +RetrieveBooking + +Retrieves a booking. + +### Example +```javascript +var SquareConnect = require('square-connect'); +var defaultClient = SquareConnect.ApiClient.instance; + +// Configure OAuth2 access token for authorization: oauth2 +var oauth2 = defaultClient.authentications['oauth2']; +oauth2.accessToken = 'YOUR ACCESS TOKEN'; + +var apiInstance = new SquareConnect.BookingsApi(); + +var bookingId = SquareConnect.BookingsApi.constructFromObject({}); // String | The ID of the `Booking` object representing the to-be-retrieved booking. + +apiInstance.retrieveBooking(bookingId).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bookingId** | **String**| The ID of the `Booking` object representing the to-be-retrieved booking. | + +### Return type + +[**RetrieveBookingResponse**](RetrieveBookingResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **retrieveBusinessBookingProfile** +**Note: This endpoint is in beta.** +> RetrieveBusinessBookingProfileResponse retrieveBusinessBookingProfile() + +RetrieveBusinessBookingProfile + +Retrieves a seller's booking profile. + +### Example +```javascript +var SquareConnect = require('square-connect'); +var defaultClient = SquareConnect.ApiClient.instance; + +// Configure OAuth2 access token for authorization: oauth2 +var oauth2 = defaultClient.authentications['oauth2']; +oauth2.accessToken = 'YOUR ACCESS TOKEN'; + +var apiInstance = new SquareConnect.BookingsApi(); +apiInstance.retrieveBusinessBookingProfile().then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**RetrieveBusinessBookingProfileResponse**](RetrieveBusinessBookingProfileResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **retrieveTeamMemberBookingProfile** +**Note: This endpoint is in beta.** +> RetrieveTeamMemberBookingProfileResponse retrieveTeamMemberBookingProfile(teamMemberId) + +RetrieveTeamMemberBookingProfile + +Retrieves a team member's booking profile. + +### Example +```javascript +var SquareConnect = require('square-connect'); +var defaultClient = SquareConnect.ApiClient.instance; + +// Configure OAuth2 access token for authorization: oauth2 +var oauth2 = defaultClient.authentications['oauth2']; +oauth2.accessToken = 'YOUR ACCESS TOKEN'; + +var apiInstance = new SquareConnect.BookingsApi(); + +var teamMemberId = SquareConnect.BookingsApi.constructFromObject({}); // String | The ID of the team member to retrieve. + +apiInstance.retrieveTeamMemberBookingProfile(teamMemberId).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **teamMemberId** | **String**| The ID of the team member to retrieve. | + +### Return type + +[**RetrieveTeamMemberBookingProfileResponse**](RetrieveTeamMemberBookingProfileResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **searchAvailability** +**Note: This endpoint is in beta.** +> SearchAvailabilityResponse searchAvailability(body) + +SearchAvailability + +Searches for availabilities for booking. + +### Example +```javascript +var SquareConnect = require('square-connect'); +var defaultClient = SquareConnect.ApiClient.instance; + +// Configure OAuth2 access token for authorization: oauth2 +var oauth2 = defaultClient.authentications['oauth2']; +oauth2.accessToken = 'YOUR ACCESS TOKEN'; + +var apiInstance = new SquareConnect.BookingsApi(); + +var body = SquareConnect.BookingsApi.constructFromObject({}); // SearchAvailabilityRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. + +apiInstance.searchAvailability(body).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**SearchAvailabilityRequest**](SearchAvailabilityRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**SearchAvailabilityResponse**](SearchAvailabilityResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **updateBooking** +**Note: This endpoint is in beta.** +> UpdateBookingResponse updateBooking(bookingId, body) + +UpdateBooking + +Updates a booking. + +### Example +```javascript +var SquareConnect = require('square-connect'); +var defaultClient = SquareConnect.ApiClient.instance; + +// Configure OAuth2 access token for authorization: oauth2 +var oauth2 = defaultClient.authentications['oauth2']; +oauth2.accessToken = 'YOUR ACCESS TOKEN'; + +var apiInstance = new SquareConnect.BookingsApi(); + +var bookingId = SquareConnect.BookingsApi.constructFromObject({}); // String | The ID of the `Booking` object representing the to-be-updated booking. + +var body = SquareConnect.BookingsApi.constructFromObject({}); // UpdateBookingRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. + +apiInstance.updateBooking(bookingId, body).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bookingId** | **String**| The ID of the `Booking` object representing the to-be-updated booking. | + **body** | [**UpdateBookingRequest**](UpdateBookingRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**UpdateBookingResponse**](UpdateBookingResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + diff --git a/docs/BusinessAppointmentSettings.md b/docs/BusinessAppointmentSettings.md new file mode 100644 index 0000000..98a626c --- /dev/null +++ b/docs/BusinessAppointmentSettings.md @@ -0,0 +1,25 @@ +# SquareConnect.BusinessAppointmentSettings + +### Description +**Note: This model is in beta.** + +The service appointment settings, including where and how the service is provided. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**location_types** | [**[BusinessAppointmentSettingsBookingLocationType]**](BusinessAppointmentSettingssBookingLocationType.md) | Types of the location allowed for bookings. | [optional] +**alignment_time** | [**BusinessAppointmentSettingsAlignmentTime**](BusinessAppointmentSettingsAlignmentTime.md) | The time unit of the service duration for bookings. | [optional] +**min_booking_lead_time_seconds** | **Number** | The minimum lead time in seconds before a service can be booked. Bookings must be created at least this far ahead of the booking's starting time. | [optional] +**max_booking_lead_time_seconds** | **Number** | The maximum lead time in seconds before a service can be booked. Bookings must be created at most this far ahead of the booking's starting time. | [optional] +**any_team_member_booking_enabled** | **Boolean** | Indicates whether a customer can choose from all available time slots and have a staff member assigned automatically (`true`) or not (`false`). | [optional] +**multiple_service_booking_enabled** | **Boolean** | Indicates whether a customer can book multiple services in a single online booking. | [optional] +**max_appointments_per_day_limit_type** | [**BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType**](BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.md) | Indicates whether the daily appointment limit applies to team members or to business locations. | [optional] +**max_appointments_per_day_limit** | **Number** | The maximum number of daily appointments per team member or per location. | [optional] +**cancellation_window_seconds** | **Number** | The cut-off time in seconds for allowing clients to cancel or reschedule an appointment. | [optional] +**cancellation_fee_money** | [**Money**](Money.md) | The flat-fee ammount charged for a no-show booking. | [optional] +**cancellation_policy** | [**BusinessAppointmentSettingsCancellationPolicy**](BusinessAppointmentSettingsCancellationPolicy.md) | The cancellation policy adopted by the seller. | [optional] +**cancellation_policy_text** | **String** | The free-form text of the seller's cancellation policy. | [optional] +**skip_booking_flow_staff_selection** | **Boolean** | Indicates whether customers has an assigned staff member (`true`) or can select s staff member of their choice (`false`). | [optional] + + diff --git a/docs/BusinessAppointmentSettingsAlignmentTime.md b/docs/BusinessAppointmentSettingsAlignmentTime.md new file mode 100644 index 0000000..55f6334 --- /dev/null +++ b/docs/BusinessAppointmentSettingsAlignmentTime.md @@ -0,0 +1,14 @@ +# SquareConnect.BusinessAppointmentSettingsAlignmentTime + +## Enum + + +* `SERVICE_DURATION` (value: `"SERVICE_DURATION"`) + +* `QUARTER_HOURLY` (value: `"QUARTER_HOURLY"`) + +* `HALF_HOURLY` (value: `"HALF_HOURLY"`) + +* `HOURLY` (value: `"HOURLY"`) + + diff --git a/docs/BusinessAppointmentSettingsBookingLocationType.md b/docs/BusinessAppointmentSettingsBookingLocationType.md new file mode 100644 index 0000000..2c3d67e --- /dev/null +++ b/docs/BusinessAppointmentSettingsBookingLocationType.md @@ -0,0 +1,12 @@ +# SquareConnect.BusinessAppointmentSettingsBookingLocationType + +## Enum + + +* `BUSINESS_LOCATION` (value: `"BUSINESS_LOCATION"`) + +* `CUSTOMER_LOCATION` (value: `"CUSTOMER_LOCATION"`) + +* `PHONE` (value: `"PHONE"`) + + diff --git a/docs/BusinessAppointmentSettingsCancellationPolicy.md b/docs/BusinessAppointmentSettingsCancellationPolicy.md new file mode 100644 index 0000000..31abd74 --- /dev/null +++ b/docs/BusinessAppointmentSettingsCancellationPolicy.md @@ -0,0 +1,10 @@ +# SquareConnect.BusinessAppointmentSettingsCancellationPolicy + +## Enum + + +* `CANCELLATION_TREATED_AS_NO_SHOW` (value: `"CANCELLATION_TREATED_AS_NO_SHOW"`) + +* `CUSTOM_POLICY` (value: `"CUSTOM_POLICY"`) + + diff --git a/docs/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.md b/docs/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.md new file mode 100644 index 0000000..c12fca8 --- /dev/null +++ b/docs/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.md @@ -0,0 +1,10 @@ +# SquareConnect.BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType + +## Enum + + +* `TEAM_MEMBER` (value: `"PER_TEAM_MEMBER"`) + +* `LOCATION` (value: `"PER_LOCATION"`) + + diff --git a/docs/BusinessBookingProfile.md b/docs/BusinessBookingProfile.md new file mode 100644 index 0000000..3b8df51 --- /dev/null +++ b/docs/BusinessBookingProfile.md @@ -0,0 +1,19 @@ +# SquareConnect.BusinessBookingProfile + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**seller_id** | **String** | The ID of the seller, obtainable using the Merchants API. | [optional] +**created_at** | **String** | The RFC-3339 timestamp specifying the booking's creation time. | [optional] +**booking_enabled** | **Boolean** | Indicates whether the seller is open for booking. | [optional] +**customer_timezone_choice** | [**BusinessBookingProfileCustomerTimezoneChoice**](BusinessBookingProfileCustomerTimezoneChoice.md) | The choice of customer's time zone information of a booking. The Square online booking site and all notifications to customers uses either the seller location’s time zone or the time zone the customer chooses at booking. | [optional] +**booking_policy** | [**BusinessBookingProfileBookingPolicy**](BusinessBookingProfileBookingPolicy.md) | The policy for the seller to automatically accept booking requests (`ACCEPT_ALL`) or not (`REQUIRES_ACCEPTANCE`). | [optional] +**allow_user_cancel** | **Boolean** | Indicates whether customers can cancel or reschedule their own bookings (`true`) or not (`false`). | [optional] +**business_appointment_settings** | [**BusinessAppointmentSettings**](BusinessAppointmentSettings.md) | Settings for appointment-type bookings. | [optional] + + diff --git a/docs/BusinessBookingProfileBookingPolicy.md b/docs/BusinessBookingProfileBookingPolicy.md new file mode 100644 index 0000000..852bd69 --- /dev/null +++ b/docs/BusinessBookingProfileBookingPolicy.md @@ -0,0 +1,10 @@ +# SquareConnect.BusinessBookingProfileBookingPolicy + +## Enum + + +* `ACCEPT_ALL` (value: `"ACCEPT_ALL"`) + +* `REQUIRES_ACCEPTANCE` (value: `"REQUIRES_ACCEPTANCE"`) + + diff --git a/docs/BusinessBookingProfileCustomerTimezoneChoice.md b/docs/BusinessBookingProfileCustomerTimezoneChoice.md new file mode 100644 index 0000000..ed276e8 --- /dev/null +++ b/docs/BusinessBookingProfileCustomerTimezoneChoice.md @@ -0,0 +1,10 @@ +# SquareConnect.BusinessBookingProfileCustomerTimezoneChoice + +## Enum + + +* `BUSINESS_LOCATION_TIMEZONE` (value: `"BUSINESS_LOCATION_TIMEZONE"`) + +* `CUSTOMER_CHOICE` (value: `"CUSTOMER_CHOICE"`) + + diff --git a/docs/CardPaymentDetails.md b/docs/CardPaymentDetails.md index f3b41b8..397beb7 100644 --- a/docs/CardPaymentDetails.md +++ b/docs/CardPaymentDetails.md @@ -7,20 +7,20 @@ Reflects the current status of a card payment. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **String** | The card payment's current state. It can be one of: `AUTHORIZED`, `CAPTURED`, `VOIDED`, `FAILED`. | [optional] +**status** | **String** | The card payment's current state. The state can be AUTHORIZED, CAPTURED, VOIDED, or FAILED. | [optional] **card** | [**Card**](Card.md) | The credit card's non-confidential details. | [optional] -**entry_method** | **String** | The method used to enter the card's details for the payment. Can be `KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`. | [optional] -**cvv_status** | **String** | Status code returned from the Card Verification Value (CVV) check. Can be `CVV_ACCEPTED`, `CVV_REJECTED`, `CVV_NOT_CHECKED`. | [optional] -**avs_status** | **String** | Status code returned from the Address Verification System (AVS) check. Can be `AVS_ACCEPTED`, `AVS_REJECTED`, `AVS_NOT_CHECKED`. | [optional] -**auth_result_code** | **String** | Status code returned by the card issuer that describes the payment's authorization status. | [optional] -**application_identifier** | **String** | For EMV payments, identifies the EMV application used for the payment. | [optional] +**entry_method** | **String** | The method used to enter the card's details for the payment. The method can be `KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`. | [optional] +**cvv_status** | **String** | The status code returned from the Card Verification Value (CVV) check. The code can be `CVV_ACCEPTED`, `CVV_REJECTED`, or `CVV_NOT_CHECKED`. | [optional] +**avs_status** | **String** | The status code returned from the Address Verification System (AVS) check. The code can be `AVS_ACCEPTED`, `AVS_REJECTED`, or `AVS_NOT_CHECKED`. | [optional] +**auth_result_code** | **String** | The status code returned by the card issuer that describes the payment's authorization status. | [optional] +**application_identifier** | **String** | For EMV payments, the application ID identifies the EMV application used for the payment. | [optional] **application_name** | **String** | For EMV payments, the human-readable name of the EMV application used for the payment. | [optional] **application_cryptogram** | **String** | For EMV payments, the cryptogram generated for the payment. | [optional] -**verification_method** | **String** | For EMV payments, method used to verify the cardholder's identity. Can be one of `PIN`, `SIGNATURE`, `PIN_AND_SIGNATURE`, `ON_DEVICE`, or `NONE`. | [optional] -**verification_results** | **String** | For EMV payments, the results of the cardholder verification. Can be one of `SUCCESS`, `FAILURE`, or `UNKNOWN`. | [optional] -**statement_description** | **String** | The statement description sent to the card networks. Note: The actual statement description will vary and is likely to be truncated and appended with additional information on a per issuer basis. | [optional] +**verification_method** | **String** | For EMV payments, the method used to verify the cardholder's identity. The method can be `PIN`, `SIGNATURE`, `PIN_AND_SIGNATURE`, `ON_DEVICE`, or `NONE`. | [optional] +**verification_results** | **String** | For EMV payments, the results of the cardholder verification. The result can be `SUCCESS`, `FAILURE`, or `UNKNOWN`. | [optional] +**statement_description** | **String** | The statement description sent to the card networks. Note: The actual statement description varies and is likely to be truncated and appended with additional information on a per issuer basis. | [optional] **device_details** | [**DeviceDetails**](DeviceDetails.md) | Details about the device that took the payment. | [optional] -**refund_requires_card_presence** | **Boolean** | Whether or not the card is required to be physically present in order for the payment to be refunded. If true, the card is required to be present. | [optional] [beta] -**errors** | [**[Error]**](Error.md) | Information on errors encountered during the request. | [optional] +**refund_requires_card_presence** | **Boolean** | Whether the card must be physically present for the payment to be refunded. If set to `true`, the card must be present. | [optional] [beta] +**errors** | [**[Error]**](Error.md) | Information about errors encountered during the request. | [optional] diff --git a/docs/CashDrawersApi.md b/docs/CashDrawersApi.md index 906be9e..0526010 100644 --- a/docs/CashDrawersApi.md +++ b/docs/CashDrawersApi.md @@ -132,7 +132,7 @@ Name | Type | Description | Notes RetrieveCashDrawerShift -Provides the summary details for a single cash drawer shift. See RetrieveCashDrawerShiftEvents for a list of cash drawer shift events. +Provides the summary details for a single cash drawer shift. See [ListCashDrawerShiftEvents](#endpoint-CashDrawers-ListCashDrawerShiftEvents) for a list of cash drawer shift events. ### Example ```javascript diff --git a/docs/CatalogApi.md b/docs/CatalogApi.md index 4c8dc87..8f48f5b 100644 --- a/docs/CatalogApi.md +++ b/docs/CatalogApi.md @@ -258,7 +258,7 @@ Name | Type | Description | Notes ListCatalog -Returns a list of [CatalogObject](#type-catalogobject)s that includes all objects of a set of desired types (for example, all [CatalogItem](#type-catalogitem) and [CatalogTax](#type-catalogtax) objects) in the catalog. The `types` parameter is specified as a comma-separated list of valid [CatalogObject](#type-catalogobject) types: `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`. __Important:__ ListCatalog does not return deleted catalog items. To retrieve deleted catalog items, use SearchCatalogObjects and set `include_deleted_objects` to `true`. +Returns a list of [CatalogObject](#type-catalogobject)s that includes all objects of a set of desired types (for example, all [CatalogItem](#type-catalogitem) and [CatalogTax](#type-catalogtax) objects) in the catalog. The `types` parameter is specified as a comma-separated list of valid [CatalogObject](#type-catalogobject) types: `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`. __Important:__ ListCatalog does not return deleted catalog items. To retrieve deleted catalog items, use [SearchCatalogObjects](#endpoint-Catalog-SearchCatalogObjects) and set the `include_deleted_objects` attribute value to `true`. ### Example ```javascript diff --git a/docs/CatalogIdMapping.md b/docs/CatalogIdMapping.md index 91c3d57..de4076b 100644 --- a/docs/CatalogIdMapping.md +++ b/docs/CatalogIdMapping.md @@ -2,7 +2,7 @@ ### Description -A mapping between a temporary client-supplied ID and a permanent server-generated ID. When calling [UpsertCatalogObject](#endpoint-Catalog-UpsertCatalogObject) or [BatchUpsertCatalogObjects](#endpoint-Catalog-BatchUpsertCatalogObjects) to create a [CatalogObject](#type-CatalogObject) instance, you can supply a temporary ID for the to-be-created object, especially when the object is to be referenced elsewhere in the same request body. This temporary ID can be any string unique within the call, but must be prefixed by \"#\". After the request is sumbitted and the object created, a permanent server-generated ID is assigned to the new object. The permanent ID is unique across the Square catalog. +A mapping between a temporary client-supplied ID and a permanent server-generated ID. When calling [UpsertCatalogObject](#endpoint-Catalog-UpsertCatalogObject) or [BatchUpsertCatalogObjects](#endpoint-Catalog-BatchUpsertCatalogObjects) to create a [CatalogObject](#type-CatalogObject) instance, you can supply a temporary ID for the to-be-created object, especially when the object is to be referenced elsewhere in the same request body. This temporary ID can be any string unique within the call, but must be prefixed by \"#\". After the request is submitted and the object created, a permanent server-generated ID is assigned to the new object. The permanent ID is unique across the Square catalog. ## Properties Name | Type | Description | Notes diff --git a/docs/CatalogItem.md b/docs/CatalogItem.md index 345c84c..0635c83 100644 --- a/docs/CatalogItem.md +++ b/docs/CatalogItem.md @@ -2,7 +2,7 @@ ### Description -An [CatalogObject](#type-CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog. +A [CatalogObject](#type-CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog. ## Properties Name | Type | Description | Notes diff --git a/docs/CatalogItemVariation.md b/docs/CatalogItemVariation.md index b9a63a3..c96f263 100644 --- a/docs/CatalogItemVariation.md +++ b/docs/CatalogItemVariation.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **item_id** | **String** | The ID of the `CatalogItem` associated with this item variation. | [optional] **name** | **String** | The item variation's name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. | [optional] **sku** | **String** | The item variation's SKU, if any. This is a searchable attribute for use in applicable query filters. | [optional] -**upc** | **String** | The item variation's UPC, if any. This is a searchable attribute for use in applicable query filters. It is only accessible through the Square API, and not exposed in the Square Seller Dashboard, Square Point of Sale or Retail Point of Sale apps. | [optional] +**upc** | **String** | The universal product code (UPC) of the item variation, if any. This is a searchable attribute for use in applicable query filters. The value of this attribute should be a number of 12-14 digits long. This restriction is enforced on the Square Seller Dashboard, Square Point of Sale or Retail Point of Sale apps, where this attribute shows in the GTIN field. If a non-compliant UPC value is assigned to this attribute using the API, the value is not editable on the Seller Dashboard, Square Point of Sale or Retail Point of Sale apps unless it is updated to fit the expected format. | [optional] **ordinal** | **Number** | The order in which this item variation should be displayed. This value is read-only. On writes, the ordinal for each item variation within a parent `CatalogItem` is set according to the item variations's position. On reads, the value is not guaranteed to be sequential or unique. | [optional] **pricing_type** | **String** | Indicates whether the item variation's price is fixed or determined at the time of sale. See [CatalogPricingType](#type-catalogpricingtype) for possible values | [optional] **price_money** | [**Money**](Money.md) | The item variation's price, if fixed pricing is used. | [optional] @@ -20,7 +20,9 @@ Name | Type | Description | Notes **inventory_alert_threshold** | **Number** | If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. This value is always an integer. | [optional] **user_data** | **String** | Arbitrary user metadata to associate with the item variation. This attribute value length is of Unicode code points. | [optional] **service_duration** | **Number** | If the `CatalogItem` that owns this item variation is of type `APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For example, a 30 minute appointment would have the value `1800000`, which is equal to 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second). | [optional] +**available_for_booking** | **Boolean** | If the `CatalogItem` that owns this item variation is of type `APPOINTMENTS_SERVICE`, a bool representing whether this service is available for booking. | [optional] [beta] **item_option_values** | [**[CatalogItemOptionValueForItemVariation]**](CatalogItemOptionValueForItemVariation.md) | List of item option values associated with this item variation. Listed in the same order as the item options of the parent item. | [optional] [beta] **measurement_unit_id** | **String** | ID of the ‘CatalogMeasurementUnit’ that is used to measure the quantity sold of this item variation. If left unset, the item will be sold in whole quantities. | [optional] [beta] +**team_member_ids** | **[String]** | Tokens of employees that can perform the service represented by this variation. Only valid for variations of type `APPOINTMENTS_SERVICE`. | [optional] [beta] diff --git a/docs/CatalogQuery.md b/docs/CatalogQuery.md index 3fb161d..dd1a143 100644 --- a/docs/CatalogQuery.md +++ b/docs/CatalogQuery.md @@ -2,7 +2,7 @@ ### Description -A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint. Although a query can have multiple filters, only one query is allowed per call to [SearchCatalogObjects](#endpoint-Catalog-SearchCatalogObjects). When a query filter is based on an attribute, the attribute must be searchable. Searchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters. * Searchable attribute and objects queryable by searchable attributes ** - `name`: `CatalogItem`, `CatalogItemVariation`, `CatelogCatogry`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, 'CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue` - `description`: `CatalogItem`, `CatalogItemOptionValue` - `abbreviation`: `CatalogItem` - `upc`: `CatalogItemVariation` - `sku`: `CatalogItemVariation` - `caption`: `CatalogImage` - `display_name`: `CatalogItemOption` For example, to search for [CatalogItem](#type-CatalogItem) objects by searchable attributes, you can use the `\"name\"`, `\"description\"`, or `\"abbreviation\"` attribute in an applicable query filter. +A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint. Although a query can have multiple filters, only certain query types can be combined per call to [SearchCatalogObjects](#endpoint-Catalog-SearchCatalogObjects). Any combination of the following types may be used together: - [exact_query](#type-CatalogExactQuery) - [prefix_query](#type-CatalogPrefixQuery) - [range_query](#type-CatalogRangeQuery) - [sorted_attribute_query](#type-CatalogSortedAttribute) - [text_query](#type-CatalogTextQuery) All other query types cannot be combined with any others. When a query filter is based on an attribute, the attribute must be searchable. Searchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters. * Searchable attribute and objects queryable by searchable attributes ** - `name`: `CatalogItem`, `CatalogItemVariation`, `CatelogCatogry`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, 'CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue` - `description`: `CatalogItem`, `CatalogItemOptionValue` - `abbreviation`: `CatalogItem` - `upc`: `CatalogItemVariation` - `sku`: `CatalogItemVariation` - `caption`: `CatalogImage` - `display_name`: `CatalogItemOption` For example, to search for [CatalogItem](#type-CatalogItem) objects by searchable attributes, you can use the `\"name\"`, `\"description\"`, or `\"abbreviation\"` attribute in an applicable query filter. ## Properties Name | Type | Description | Notes diff --git a/docs/CheckAppointmentsOnboardedRequest.md b/docs/CheckAppointmentsOnboardedRequest.md new file mode 100644 index 0000000..7f81509 --- /dev/null +++ b/docs/CheckAppointmentsOnboardedRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.CheckAppointmentsOnboardedRequest + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/CreateDisputeEvidenceFileResponse.md b/docs/CheckAppointmentsOnboardedResponse.md similarity index 52% rename from docs/CreateDisputeEvidenceFileResponse.md rename to docs/CheckAppointmentsOnboardedResponse.md index 0d1f60d..93dce92 100644 --- a/docs/CreateDisputeEvidenceFileResponse.md +++ b/docs/CheckAppointmentsOnboardedResponse.md @@ -1,14 +1,14 @@ -# SquareConnect.CreateDisputeEvidenceFileResponse +# SquareConnect.CheckAppointmentsOnboardedResponse ### Description **Note: This model is in beta.** -Defines fields in a CreateDisputeEvidenceFile response. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**appointments_onboarded** | **Boolean** | Indicates whether the seller has enabled the Square Appointments service (`true`) or not (`false`). | [optional] **errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] -**evidence** | [**DisputeEvidence**](DisputeEvidence.md) | The metadata of the newly uploaded dispute evidence. | [optional] diff --git a/docs/CreateBookingRequest.md b/docs/CreateBookingRequest.md new file mode 100644 index 0000000..ba39221 --- /dev/null +++ b/docs/CreateBookingRequest.md @@ -0,0 +1,14 @@ +# SquareConnect.CreateBookingRequest + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**idempotency_key** | **String** | A unique key to make this request an idempotent operation. | [optional] +**booking** | [**Booking**](Booking.md) | The details of the booking to be created. | + + diff --git a/docs/CreateCatalogImageResponse.md b/docs/CreateBookingResponse.md similarity index 53% rename from docs/CreateCatalogImageResponse.md rename to docs/CreateBookingResponse.md index 6cf931c..93b05c9 100644 --- a/docs/CreateCatalogImageResponse.md +++ b/docs/CreateBookingResponse.md @@ -1,13 +1,14 @@ -# SquareConnect.CreateCatalogImageResponse +# SquareConnect.CreateBookingResponse ### Description +**Note: This model is in beta.** ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**booking** | [**Booking**](Booking.md) | The booking that was created. | [optional] **errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] -**image** | [**CatalogObject**](CatalogObject.md) | The newly created `CatalogImage` including a Square-generated URL for each image. | [optional] diff --git a/docs/CreateCatalogImageRequest.md b/docs/CreateCatalogImageRequest.md deleted file mode 100644 index 9171850..0000000 --- a/docs/CreateCatalogImageRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# SquareConnect.CreateCatalogImageRequest - -### Description - - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**idempotency_key** | **String** | A unique string that identifies this CreateCatalogImage request. Keys can be any valid string but must be unique for every CreateCatalogImage request. See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | -**object_id** | **String** | Unique ID of the `CatalogObject` to attach to this `CatalogImage`. Leave this field empty to create unattached images, for example if you are building an integration where these images can be attached to catalog items at a later time. | [optional] -**image** | [**CatalogObject**](CatalogObject.md) | The new `IMAGE`-type `CatalogObject` to be attached to this `CatalogImage`. If the `CatalogObject` already has a `CatalogImage`, this call will overwrite it. | [optional] - - diff --git a/docs/CreateDisputeEvidenceFileRequest.md b/docs/CreateDisputeEvidenceFileRequest.md deleted file mode 100644 index ef633fa..0000000 --- a/docs/CreateDisputeEvidenceFileRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# SquareConnect.CreateDisputeEvidenceFileRequest - -### Description -**Note: This model is in beta.** - -Defines parameters for a CreateDisputeEvidenceFile request. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**idempotency_key** | **String** | Unique ID. For more information, see [Idempotency](https://developer.squareup.com/docs/docs/working-with-apis/idempotency). | -**evidence_type** | **String** | The type of evidence you are uploading. See [DisputeEvidenceType](#type-disputeevidencetype) for possible values | [optional] -**content_type** | **String** | The MIME type of the uploaded file. One of image/heic, image/heif, image/jpeg, application/pdf, image/png, image/tiff. | [optional] - - diff --git a/docs/DeviceDetails.md b/docs/DeviceDetails.md index e39d58f..de2ce6f 100644 --- a/docs/DeviceDetails.md +++ b/docs/DeviceDetails.md @@ -7,8 +7,8 @@ Details about the device that took the payment. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**device_id** | **String** | Square-issued ID of the device. | [optional] -**device_installation_id** | **String** | Square-issued installation ID for the device. | [optional] -**device_name** | **String** | The name of the device set by the merchant. | [optional] +**device_id** | **String** | The Square-issued ID of the device. | [optional] +**device_installation_id** | **String** | The Square-issued installation ID for the device. | [optional] +**device_name** | **String** | The name of the device set by the seller. | [optional] diff --git a/docs/GetPaymentRefundResponse.md b/docs/GetPaymentRefundResponse.md index 62ade9a..5dc5b21 100644 --- a/docs/GetPaymentRefundResponse.md +++ b/docs/GetPaymentRefundResponse.md @@ -2,12 +2,12 @@ ### Description -Defines the fields that are included in the response body of a request to the [GetRefund](#endpoint-refunds-getpaymentrefund) endpoint. Note: if there are errors processing the request, the refund field may not be present, or it may be present in a FAILED state. +Defines the fields that are included in the response body of a request to the [GetRefund](#endpoint-refunds-getpaymentrefund) endpoint. Note: If there are errors processing the request, the refund field might not be present or it might be present in a FAILED state. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**[Error]**](Error.md) | Information on errors encountered during the request. | [optional] +**errors** | [**[Error]**](Error.md) | Information about errors encountered during the request. | [optional] **refund** | [**PaymentRefund**](PaymentRefund.md) | The requested `PaymentRefund`. | [optional] diff --git a/docs/ListPaymentRefundsRequest.md b/docs/ListPaymentRefundsRequest.md index b7a9311..c17650a 100644 --- a/docs/ListPaymentRefundsRequest.md +++ b/docs/ListPaymentRefundsRequest.md @@ -2,18 +2,18 @@ ### Description -Retrieves a list of refunds for the account making the request. Max results per page: 100 +Retrieves a list of refunds for the account making the request. The maximum results per page is 100. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**begin_time** | **String** | Timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. | [optional] -**end_time** | **String** | Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. | [optional] -**sort_order** | **String** | The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). | [optional] -**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] -**location_id** | **String** | Limit results to the location supplied. By default, results are returned for all locations associated with the merchant. | [optional] -**status** | **String** | If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. | [optional] -**source_type** | **String** | If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. | [optional] -**limit** | **Number** | Maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. If the supplied value is greater than 100, at most 100 results will be returned. Default: `100` | [optional] +**begin_time** | **String** | The timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. | [optional] +**end_time** | **String** | The timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. | [optional] +**sort_order** | **String** | The order in which results are listed: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default). | [optional] +**cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination). | [optional] +**location_id** | **String** | Limit results to the location supplied. By default, results are returned for all locations associated with the seller. | [optional] +**status** | **String** | If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted, refunds are returned regardless of their status. | [optional] +**source_type** | **String** | If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where `CARD` was specified as the payment source. Default: If omitted, refunds are returned regardless of the source type. | [optional] +**limit** | **Number** | The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. If the supplied value is greater than 100, no more than 100 results are returned. Default: 100 | [optional] diff --git a/docs/ListPaymentRefundsResponse.md b/docs/ListPaymentRefundsResponse.md index 7236233..8eae53c 100644 --- a/docs/ListPaymentRefundsResponse.md +++ b/docs/ListPaymentRefundsResponse.md @@ -2,13 +2,13 @@ ### Description -Defines the fields that are included in the response body of a request to the [ListPaymentRefunds](#endpoint-refunds-listpaymentrefunds) endpoint. One of `errors` or `refunds` is present in a given response (never both). +Defines the fields that are included in the response body of a request to the [ListPaymentRefunds](#endpoint-refunds-listpaymentrefunds) endpoint. Either `errors` or `refunds` is present in a given response (never both). ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**[Error]**](Error.md) | Information on errors encountered during the request. | [optional] +**errors** | [**[Error]**](Error.md) | Information about errors encountered during the request. | [optional] **refunds** | [**[PaymentRefund]**](PaymentRefund.md) | The list of requested refunds. | [optional] -**cursor** | **String** | The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] +**cursor** | **String** | The pagination cursor to be used in a subsequent request. If empty, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination). | [optional] diff --git a/docs/ListTeamMemberBookingProfilesRequest.md b/docs/ListTeamMemberBookingProfilesRequest.md new file mode 100644 index 0000000..a18a778 --- /dev/null +++ b/docs/ListTeamMemberBookingProfilesRequest.md @@ -0,0 +1,16 @@ +# SquareConnect.ListTeamMemberBookingProfilesRequest + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bookable_only** | **Boolean** | Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`). | [optional] +**limit** | **Number** | The maximum number of results to return. | [optional] +**cursor** | **String** | The cursor for paginating through the results. | [optional] +**location_id** | **String** | Indicates whether to include only team members enabled at the given location in the returned result. | [optional] + + diff --git a/docs/ListTeamMemberBookingProfilesResponse.md b/docs/ListTeamMemberBookingProfilesResponse.md new file mode 100644 index 0000000..ff8bfd2 --- /dev/null +++ b/docs/ListTeamMemberBookingProfilesResponse.md @@ -0,0 +1,15 @@ +# SquareConnect.ListTeamMemberBookingProfilesResponse + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**team_member_booking_profiles** | [**[TeamMemberBookingProfile]**](TeamMemberBookingProfile.md) | The list of team member booking profiles. | [optional] +**cursor** | **String** | The cursor for paginating through the results. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/OAuthApi.md b/docs/OAuthApi.md index 2b92bab..cbb8865 100644 --- a/docs/OAuthApi.md +++ b/docs/OAuthApi.md @@ -15,7 +15,7 @@ Method | HTTP request | Description ObtainToken -Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. +Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. ### Example ```javascript @@ -111,7 +111,7 @@ Name | Type | Description | Notes RevokeToken -Revokes an access token generated with the OAuth flow. If an account has more than one OAuth access token for your application, this endpoint revokes all of them, regardless of which token you specify. When an OAuth access token is revoked, all of the active subscriptions associated with that OAuth token are canceled immediately. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). +Revokes an access token generated with the OAuth flow. If an account has more than one OAuth access token for your application, this endpoint revokes all of them, regardless of which token you specify. When an OAuth access token is revoked, all of the active subscriptions associated with that OAuth token are canceled immediately. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [Developer Dashboard](https://developer.squareup.com/apps). ### Example ```javascript diff --git a/docs/ObtainTokenRequest.md b/docs/ObtainTokenRequest.md index a3d0d41..1aea05c 100644 --- a/docs/ObtainTokenRequest.md +++ b/docs/ObtainTokenRequest.md @@ -14,5 +14,7 @@ Name | Type | Description | Notes **grant_type** | **String** | Specifies the method to request an OAuth access token. Valid values are: `authorization_code`, `refresh_token`, and `migration_token` | **refresh_token** | **String** | A valid refresh token for generating a new OAuth access token. A valid refresh token is required if `grant_type` is set to `refresh_token` , to indicate the application wants a replacement for an expired OAuth access token. | [optional] **migration_token** | **String** | Legacy OAuth access token obtained using a Connect API version prior to 2019-03-13. This parameter is required if `grant_type` is set to `migration_token` to indicate that the application wants to get a replacement OAuth access token. The response also returns a refresh token. For more information, see [Migrate to Using Refresh Tokens](https://developer.squareup.com/docs/authz/oauth/migration). | [optional] +**scopes** | **[String]** | __OPTIONAL__ A JSON list of strings representing the permissions the application is requesting. For example: \"`[\"MERCHANT_PROFILE_READ\",\"PAYMENTS_READ\",\"BANK_ACCOUNTS_READ\"]`\" The access token returned in the response is granted the permissions that comprise the intersection between the requested list of permissions, and those that belong to the provided refresh token. | [optional] [beta] +**short_lived** | **Boolean** | __OPTIONAL__ A boolean indicating a request for a short-lived access token. The short-lived access token returned in the response will expire in 24 hours. | [optional] [beta] diff --git a/docs/ObtainTokenResponse.md b/docs/ObtainTokenResponse.md index 28d1b9c..91a444e 100644 --- a/docs/ObtainTokenResponse.md +++ b/docs/ObtainTokenResponse.md @@ -7,13 +7,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**access_token** | **String** | A valid OAuth access token. OAuth access tokens are 64 bytes long. Provide the access token in a header with every request to Connect API endpoints. See the [Build with OAuth](https://developer.squareup.com/docs/authz/oauth/build-with-the-api) guide for more information. | [optional] +**access_token** | **String** | A valid OAuth access token. OAuth access tokens are 64 bytes long. Provide the access token in a header with every request to Connect API endpoints. See [OAuth API: Walkthrough](https://developer.squareup.com/docs/oauth-api/walkthrough) for more information. | [optional] **token_type** | **String** | This value is always _bearer_. | [optional] **expires_at** | **String** | The date when access_token expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format. | [optional] **merchant_id** | **String** | The ID of the authorizing merchant's business. | [optional] **subscription_id** | **String** | __LEGACY FIELD__. The ID of a subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] -**plan_id** | **String** | T__LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] +**plan_id** | **String** | __LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] **id_token** | **String** | Then OpenID token belonging to this this person. Only present if the OPENID scope is included in the authorize request. | [optional] **refresh_token** | **String** | A refresh token. OAuth refresh tokens are 64 bytes long. For more information, see [OAuth access token management](https://developer.squareup.com/docs/authz/oauth/how-it-works#oauth-access-token-management). | [optional] +**short_lived** | **Boolean** | A boolean indicating the access token is a short-lived access token. The short-lived access token returned in the response will expire in 24 hours. | [optional] [beta] diff --git a/docs/OnboardAppointmentsRequest.md b/docs/OnboardAppointmentsRequest.md new file mode 100644 index 0000000..59a7f88 --- /dev/null +++ b/docs/OnboardAppointmentsRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.OnboardAppointmentsRequest + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/OnboardAppointmentsResponse.md b/docs/OnboardAppointmentsResponse.md new file mode 100644 index 0000000..ca95f0a --- /dev/null +++ b/docs/OnboardAppointmentsResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.OnboardAppointmentsResponse + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/Payment.md b/docs/Payment.md index 0604440..55ac6cf 100644 --- a/docs/Payment.md +++ b/docs/Payment.md @@ -7,33 +7,34 @@ Represents a payment processed by the Square API. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Unique ID for the payment. | [optional] -**created_at** | **String** | Timestamp of when the payment was created, in RFC 3339 format. | [optional] -**updated_at** | **String** | Timestamp of when the payment was last updated, in RFC 3339 format. | [optional] -**amount_money** | [**Money**](Money.md) | The amount of money processed for this payment, not including `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). | [optional] -**tip_money** | [**Money**](Money.md) | The amount designated as a tip. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. | [optional] -**total_money** | [**Money**](Money.md) | The total money for the payment, including `amount_money` and `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. | [optional] -**app_fee_money** | [**Money**](Money.md) | The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). Cannot be more than 90% of the `total_money` value. | [optional] -**processing_fee** | [**[ProcessingFee]**](ProcessingFee.md) | Processing fees and fee adjustments assessed by Square on this payment. | [optional] -**refunded_money** | [**Money**](Money.md) | Total amount of the payment refunded to-date. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. | [optional] -**status** | **String** | Indicates whether the payment is `APPROVED`, `COMPLETED`, `CANCELED`, or `FAILED`. | [optional] -**delay_duration** | **String** | The duration of time after the payment's creation when Square automatically applies the `delay_action` to the payment. This automatic `delay_action` applies only to payments that don't reach a terminal state (COMPLETED, CANCELED, or FAILED) before the `delay_duration` time period. This field is specified as a time duration, in RFC 3339 format. Notes: This feature is only supported for card payments. Default: - Card Present payments: \"PT36H\" (36 hours) from the creation time. - Card Not Present payments: \"P7D\" (7 days) from the creation time. | [optional] [beta] -**delay_action** | **String** | The action to be applied to the payment when the `delay_duration` has elapsed. This field is read only. Current values include: `CANCEL` | [optional] [beta] -**delayed_until** | **String** | Read only timestamp of when the `delay_action` will automatically be applied, in RFC 3339 format. Note that this field is calculated by summing the payment's `delay_duration` and `created_at` fields. The `created_at` field is generated by Square and may not exactly match the time on your local machine. | [optional] [beta] -**source_type** | **String** | The source type for this payment Current values include: `CARD`. | [optional] -**card_details** | [**CardPaymentDetails**](CardPaymentDetails.md) | Non-confidential details about the source. Only populated if the `source_type` is `CARD`. | [optional] -**location_id** | **String** | ID of the location associated with the payment. | [optional] -**order_id** | **String** | ID of the order associated with this payment. | [optional] -**reference_id** | **String** | An optional ID that associates this payment with an entity in another system. | [optional] +**id** | **String** | A unique ID for the payment. | [optional] +**created_at** | **String** | The timestamp of when the payment was created, in RFC 3339 format. | [optional] +**updated_at** | **String** | The timestamp of when the payment was last updated, in RFC 3339 format. | [optional] +**amount_money** | [**Money**](Money.md) | The amount processed for this payment, not including `tip_money`. The amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). | [optional] +**tip_money** | [**Money**](Money.md) | The amount designated as a tip. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). | [optional] +**total_money** | [**Money**](Money.md) | The total amount for the payment, including `amount_money` and `tip_money`. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). | [optional] +**app_fee_money** | [**Money**](Money.md) | The amount the developer is taking as a fee for facilitating the payment on behalf of the seller. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). The amount cannot be more than 90% of the `total_money` value. | [optional] +**processing_fee** | [**[ProcessingFee]**](ProcessingFee.md) | The processing fees and fee adjustments assessed by Square for this payment. | [optional] +**refunded_money** | [**Money**](Money.md) | The total amount of the payment refunded to date. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). | [optional] +**status** | **String** | Indicates whether the payment is APPROVED, COMPLETED, CANCELED, or FAILED. | [optional] +**delay_duration** | **String** | The duration of time after the payment's creation when Square automatically applies the `delay_action` to the payment. This automatic `delay_action` applies only to payments that do not reach a terminal state (COMPLETED, CANCELED, or FAILED) before the `delay_duration` time period. This field is specified as a time duration, in RFC 3339 format. Notes: This feature is only supported for card payments. Default: - Card-present payments: \"PT36H\" (36 hours) from the creation time. - Card-not-present payments: \"P7D\" (7 days) from the creation time. | [optional] [beta] +**delay_action** | **String** | The action to be applied to the payment when the `delay_duration` has elapsed. This field is read-only. Current values include `CANCEL`. | [optional] [beta] +**delayed_until** | **String** | The read-only timestamp of when the `delay_action` is automatically applied, in RFC 3339 format. Note that this field is calculated by summing the payment's `delay_duration` and `created_at` fields. The `created_at` field is generated by Square and might not exactly match the time on your local machine. | [optional] [beta] +**source_type** | **String** | The source type for this payment. Current values include `CARD`. | [optional] +**card_details** | [**CardPaymentDetails**](CardPaymentDetails.md) | Non-confidential details about the source. The details are only populated if the `source_type` is `CARD`. | [optional] +**location_id** | **String** | The ID of the location associated with the payment. | [optional] +**order_id** | **String** | The ID of the order associated with the payment. | [optional] +**reference_id** | **String** | An optional ID that associates the payment with an entity in another system. | [optional] **customer_id** | **String** | The `Customer` ID of the customer associated with the payment. | [optional] -**employee_id** | **String** | An optional ID of the employee associated with taking this payment. | [optional] -**refund_ids** | **[String]** | List of `refund_id`s identifying refunds for this payment. | [optional] -**buyer_email_address** | **String** | The buyer's e-mail address | [optional] -**billing_address** | [**Address**](Address.md) | The buyer's billing address | [optional] -**shipping_address** | [**Address**](Address.md) | The buyer's shipping address | [optional] -**note** | **String** | An optional note to include when creating a payment | [optional] -**statement_description_identifier** | **String** | Additional payment information that gets added on the customer's card statement as part of the statement description. Note that the `statement_description_identifier` may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment. | [optional] [beta] -**receipt_number** | **String** | The payment's receipt number. The field will be missing if a payment is CANCELED | [optional] -**receipt_url** | **String** | The URL for the payment's receipt. The field will only be populated for COMPLETED payments. | [optional] +**employee_id** | **String** | An optional ID of the employee associated with taking the payment. | [optional] +**refund_ids** | **[String]** | A list of `refund_id`s identifying refunds for the payment. | [optional] +**risk_evaluation** | [**RiskEvaluation**](RiskEvaluation.md) | Provides information about the risk associated with the payment, as determined by Square. This field is present for payments to sellers that have opted in to receive risk evaluations. | [optional] +**buyer_email_address** | **String** | The buyer's email address. | [optional] +**billing_address** | [**Address**](Address.md) | The buyer's billing address. | [optional] +**shipping_address** | [**Address**](Address.md) | The buyer's shipping address. | [optional] +**note** | **String** | An optional note to include when creating a payment. | [optional] +**statement_description_identifier** | **String** | Additional payment information that gets added to the customer's card statement as part of the statement description. Note that the `statement_description_identifier` might get truncated on the statement description to fit the required information including the Square identifier (SQ *) and the name of the seller taking the payment. | [optional] [beta] +**receipt_number** | **String** | The payment's receipt number. The field is missing if a payment is canceled. | [optional] +**receipt_url** | **String** | The URL for the payment's receipt. The field is only populated for COMPLETED payments. | [optional] diff --git a/docs/PaymentRefund.md b/docs/PaymentRefund.md index 14f7206..0346fe0 100644 --- a/docs/PaymentRefund.md +++ b/docs/PaymentRefund.md @@ -2,21 +2,21 @@ ### Description -Represents a refund of a payment made using Square. Contains information on the original payment and the amount of money refunded. +Represents a refund of a payment made using Square. Contains information about the original payment and the amount of money refunded. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Unique ID for this refund, generated by Square. | -**status** | **String** | The refund's status: - `PENDING` - awaiting approval - `COMPLETED` - successfully completed - `REJECTED` - the refund was rejected - `FAILED` - an error occurred | [optional] -**location_id** | **String** | Location ID associated with the payment this refund is attached to. | [optional] -**amount_money** | [**Money**](Money.md) | The amount of money refunded, specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. | -**app_fee_money** | [**Money**](Money.md) | Amount of money the app developer contributed to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. | [optional] -**processing_fee** | [**[ProcessingFee]**](ProcessingFee.md) | Processing fees and fee adjustments assessed by Square on this refund. | [optional] +**id** | **String** | The unique ID for this refund, generated by Square. | +**status** | **String** | The refund's status: - `PENDING` - Awaiting approval. - `COMPLETED` - Successfully completed. - `REJECTED` - The refund was rejected. - `FAILED` - An error occurred. | [optional] +**location_id** | **String** | The location ID associated with the payment this refund is attached to. | [optional] +**amount_money** | [**Money**](Money.md) | The amount of money refunded. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). | +**app_fee_money** | [**Money**](Money.md) | The amount of money the application developer contributed to help cover the refunded amount. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). | [optional] +**processing_fee** | [**[ProcessingFee]**](ProcessingFee.md) | Processing fees and fee adjustments assessed by Square for this refund. | [optional] **payment_id** | **String** | The ID of the payment assocated with this refund. | [optional] **order_id** | **String** | The ID of the order associated with the refund. | [optional] **reason** | **String** | The reason for the refund. | [optional] -**created_at** | **String** | Timestamp of when the refund was created, in RFC 3339 format. | [optional] -**updated_at** | **String** | Timestamp of when the refund was last updated, in RFC 3339 format. | [optional] +**created_at** | **String** | The timestamp of when the refund was created, in RFC 3339 format. | [optional] +**updated_at** | **String** | The timestamp of when the refund was last updated, in RFC 3339 format. | [optional] diff --git a/docs/ProcessingFee.md b/docs/ProcessingFee.md index 8c4c6c1..672e61b 100644 --- a/docs/ProcessingFee.md +++ b/docs/ProcessingFee.md @@ -2,13 +2,13 @@ ### Description -Represents Square processing fee. +Represents the Square processing fee. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**effective_at** | **String** | Timestamp of when the fee takes effect, in RFC 3339 format. | [optional] -**type** | **String** | The type of fee assessed or adjusted. Can be one of: `INITIAL`, `ADJUSTMENT`. | [optional] -**amount_money** | [**Money**](Money.md) | The fee amount assessed or adjusted by Square. May be negative. Positive values represent funds being assessed, while negative values represent funds being returned. | [optional] +**effective_at** | **String** | The timestamp of when the fee takes effect, in RFC 3339 format. | [optional] +**type** | **String** | The type of fee assessed or adjusted. The fee type can be `INITIAL` or `ADJUSTMENT`. | [optional] +**amount_money** | [**Money**](Money.md) | The fee amount, which might be negative, that is assessed or adjusted by Square. Positive values represent funds being assessed, while negative values represent funds being returned. | [optional] diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..d02e9f7 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,1231 @@ +![Square logo] + +# Square Connect Node SDK + +--- + +[![Build Status](https://travis-ci.org/square/connect-nodejs-sdk.svg?branch=master)](https://travis-ci.org/square/connect-nodejs-sdk) +[![npm version](https://badge.fury.io/js/square-connect.svg)](https://badge.fury.io/js/square-connect) +[![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0) +================== +## NOTICE: Square Connect Node.js SDK deprecated +This Square Connect SDK will enter a security maintenance phase in Q4 2020 and will be RETIRED (EOL) in Q2 2021. In the security +maintenance phase, this SDK will continue to receive support and security patches but will no longer receive bug fixes or product +updates. Once it is retired, support and security patches will no longer be available. A new SDK, more bespoke to the language, will be available once this SDK enters its security maintenance phase. +The SDK itself will continue to work indefinitely until such time that the underlying APIs are retired at which point portions of the SDK may stop functioning. For a full list of API retirement dates, please see our [Square API Lifecycle documentation](https://developer.squareup.com/docs/build-basics/api-lifecycle#deprecated-apis). + +| Security Maintenance | New SDK Release | Retired (EOL) | +| ------------- |-------------| -----| +| Q4, 2020 | Q4, 2020 | Q2, 2021 | + +**If you have feedback about the new SDKs, or just want to talk to other Square Developers, request an invite to the new [slack community for Square Developers](https://squ.re/2Hks3YE)** + + +## Requirements + +Node.js 6.0 or later + +## Installation + +### For [Node.js](https://nodejs.org/) + +To install the SDK: + +```shell +npm install square-connect --save +``` + +## Getting Started + +Please follow the [installation](#installation) instruction and execute the following JS code: + +```javascript +var SquareConnect = require('square-connect'); +var defaultClient = SquareConnect.ApiClient.instance; + +// Configure OAuth2 access token for authorization: oauth2 +var oauth2 = defaultClient.authentications['oauth2']; +oauth2.accessToken = "YOUR ACCESS TOKEN"; + +var api = new SquareConnect.LocationsApi(); + +api.listLocations().then(function(data) { + console.log('API called successfully. Returned data: ' + JSON.stringify(data, 0, 1)); +}, function(error) { + console.error(error); +}); +``` + +### How to configure sandbox environment +```javascript +var SquareConnect = require('square-connect'); +var defaultClient = SquareConnect.ApiClient.instance; +// Set sandbox url +defaultClient.basePath = 'https://connect.squareupsandbox.com'; +// Configure OAuth2 access token for authorization: oauth2 +var oauth2 = defaultClient.authentications['oauth2']; +// Set sandbox access token +oauth2.accessToken = "YOUR SANDBOX ACCESS TOKEN"; +// Pass client to API +var api = new SquareConnect.LocationsApi(); +``` + +## Documentation for API Endpoints + +All URIs are relative to *https://connect.squareup.com* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +*SquareConnect.ApplePayApi* | [**registerDomain**](docs/ApplePayApi.md#registerDomain) | **POST** /v2/apple-pay/domains | RegisterDomain +*SquareConnect.BankAccountsApi* | [**getBankAccount**](docs/BankAccountsApi.md#getBankAccount) | **GET** /v2/bank-accounts/{bank_account_id} | GetBankAccount +*SquareConnect.BankAccountsApi* | [**getBankAccountByV1Id**](docs/BankAccountsApi.md#getBankAccountByV1Id) | **GET** /v2/bank-accounts/by-v1-id/{v1_bank_account_id} | GetBankAccountByV1Id +*SquareConnect.BankAccountsApi* | [**listBankAccounts**](docs/BankAccountsApi.md#listBankAccounts) | **GET** /v2/bank-accounts | ListBankAccounts +*SquareConnect.BookingsApi* | [**createBooking**](docs/BookingsApi.md#createBooking) | **POST** /v2/bookings | CreateBooking +*SquareConnect.BookingsApi* | [**listTeamMemberBookingProfiles**](docs/BookingsApi.md#listTeamMemberBookingProfiles) | **GET** /v2/bookings/team-member-booking-profiles | ListTeamMemberBookingProfiles +*SquareConnect.BookingsApi* | [**retrieveBooking**](docs/BookingsApi.md#retrieveBooking) | **GET** /v2/bookings/{booking_id} | RetrieveBooking +*SquareConnect.BookingsApi* | [**retrieveBusinessBookingProfile**](docs/BookingsApi.md#retrieveBusinessBookingProfile) | **GET** /v2/bookings/business-booking-profile | RetrieveBusinessBookingProfile +*SquareConnect.BookingsApi* | [**retrieveTeamMemberBookingProfile**](docs/BookingsApi.md#retrieveTeamMemberBookingProfile) | **GET** /v2/bookings/team-member-booking-profiles/{team_member_id} | RetrieveTeamMemberBookingProfile +*SquareConnect.BookingsApi* | [**searchAvailability**](docs/BookingsApi.md#searchAvailability) | **POST** /v2/bookings/availability/search | SearchAvailability +*SquareConnect.BookingsApi* | [**updateBooking**](docs/BookingsApi.md#updateBooking) | **PUT** /v2/bookings/{booking_id} | UpdateBooking +*SquareConnect.CashDrawersApi* | [**listCashDrawerShiftEvents**](docs/CashDrawersApi.md#listCashDrawerShiftEvents) | **GET** /v2/cash-drawers/shifts/{shift_id}/events | ListCashDrawerShiftEvents +*SquareConnect.CashDrawersApi* | [**listCashDrawerShifts**](docs/CashDrawersApi.md#listCashDrawerShifts) | **GET** /v2/cash-drawers/shifts | ListCashDrawerShifts +*SquareConnect.CashDrawersApi* | [**retrieveCashDrawerShift**](docs/CashDrawersApi.md#retrieveCashDrawerShift) | **GET** /v2/cash-drawers/shifts/{shift_id} | RetrieveCashDrawerShift +*SquareConnect.CatalogApi* | [**batchDeleteCatalogObjects**](docs/CatalogApi.md#batchDeleteCatalogObjects) | **POST** /v2/catalog/batch-delete | BatchDeleteCatalogObjects +*SquareConnect.CatalogApi* | [**batchRetrieveCatalogObjects**](docs/CatalogApi.md#batchRetrieveCatalogObjects) | **POST** /v2/catalog/batch-retrieve | BatchRetrieveCatalogObjects +*SquareConnect.CatalogApi* | [**batchUpsertCatalogObjects**](docs/CatalogApi.md#batchUpsertCatalogObjects) | **POST** /v2/catalog/batch-upsert | BatchUpsertCatalogObjects +*SquareConnect.CatalogApi* | [**catalogInfo**](docs/CatalogApi.md#catalogInfo) | **GET** /v2/catalog/info | CatalogInfo +*SquareConnect.CatalogApi* | [**deleteCatalogObject**](docs/CatalogApi.md#deleteCatalogObject) | **DELETE** /v2/catalog/object/{object_id} | DeleteCatalogObject +*SquareConnect.CatalogApi* | [**listCatalog**](docs/CatalogApi.md#listCatalog) | **GET** /v2/catalog/list | ListCatalog +*SquareConnect.CatalogApi* | [**retrieveCatalogObject**](docs/CatalogApi.md#retrieveCatalogObject) | **GET** /v2/catalog/object/{object_id} | RetrieveCatalogObject +*SquareConnect.CatalogApi* | [**searchCatalogItems**](docs/CatalogApi.md#searchCatalogItems) | **POST** /v2/catalog/search-catalog-items | SearchCatalogItems +*SquareConnect.CatalogApi* | [**searchCatalogObjects**](docs/CatalogApi.md#searchCatalogObjects) | **POST** /v2/catalog/search | SearchCatalogObjects +*SquareConnect.CatalogApi* | [**updateItemModifierLists**](docs/CatalogApi.md#updateItemModifierLists) | **POST** /v2/catalog/update-item-modifier-lists | UpdateItemModifierLists +*SquareConnect.CatalogApi* | [**updateItemTaxes**](docs/CatalogApi.md#updateItemTaxes) | **POST** /v2/catalog/update-item-taxes | UpdateItemTaxes +*SquareConnect.CatalogApi* | [**upsertCatalogObject**](docs/CatalogApi.md#upsertCatalogObject) | **POST** /v2/catalog/object | UpsertCatalogObject +*SquareConnect.CheckoutApi* | [**createCheckout**](docs/CheckoutApi.md#createCheckout) | **POST** /v2/locations/{location_id}/checkouts | CreateCheckout +*SquareConnect.CustomerGroupsApi* | [**createCustomerGroup**](docs/CustomerGroupsApi.md#createCustomerGroup) | **POST** /v2/customers/groups | CreateCustomerGroup +*SquareConnect.CustomerGroupsApi* | [**deleteCustomerGroup**](docs/CustomerGroupsApi.md#deleteCustomerGroup) | **DELETE** /v2/customers/groups/{group_id} | DeleteCustomerGroup +*SquareConnect.CustomerGroupsApi* | [**listCustomerGroups**](docs/CustomerGroupsApi.md#listCustomerGroups) | **GET** /v2/customers/groups | ListCustomerGroups +*SquareConnect.CustomerGroupsApi* | [**retrieveCustomerGroup**](docs/CustomerGroupsApi.md#retrieveCustomerGroup) | **GET** /v2/customers/groups/{group_id} | RetrieveCustomerGroup +*SquareConnect.CustomerGroupsApi* | [**updateCustomerGroup**](docs/CustomerGroupsApi.md#updateCustomerGroup) | **PUT** /v2/customers/groups/{group_id} | UpdateCustomerGroup +*SquareConnect.CustomerSegmentsApi* | [**listCustomerSegments**](docs/CustomerSegmentsApi.md#listCustomerSegments) | **GET** /v2/customers/segments | ListCustomerSegments +*SquareConnect.CustomerSegmentsApi* | [**retrieveCustomerSegment**](docs/CustomerSegmentsApi.md#retrieveCustomerSegment) | **GET** /v2/customers/segments/{segment_id} | RetrieveCustomerSegment +*SquareConnect.CustomersApi* | [**addGroupToCustomer**](docs/CustomersApi.md#addGroupToCustomer) | **PUT** /v2/customers/{customer_id}/groups/{group_id} | AddGroupToCustomer +*SquareConnect.CustomersApi* | [**createCustomer**](docs/CustomersApi.md#createCustomer) | **POST** /v2/customers | CreateCustomer +*SquareConnect.CustomersApi* | [**createCustomerCard**](docs/CustomersApi.md#createCustomerCard) | **POST** /v2/customers/{customer_id}/cards | CreateCustomerCard +*SquareConnect.CustomersApi* | [**deleteCustomer**](docs/CustomersApi.md#deleteCustomer) | **DELETE** /v2/customers/{customer_id} | DeleteCustomer +*SquareConnect.CustomersApi* | [**deleteCustomerCard**](docs/CustomersApi.md#deleteCustomerCard) | **DELETE** /v2/customers/{customer_id}/cards/{card_id} | DeleteCustomerCard +*SquareConnect.CustomersApi* | [**listCustomers**](docs/CustomersApi.md#listCustomers) | **GET** /v2/customers | ListCustomers +*SquareConnect.CustomersApi* | [**removeGroupFromCustomer**](docs/CustomersApi.md#removeGroupFromCustomer) | **DELETE** /v2/customers/{customer_id}/groups/{group_id} | RemoveGroupFromCustomer +*SquareConnect.CustomersApi* | [**retrieveCustomer**](docs/CustomersApi.md#retrieveCustomer) | **GET** /v2/customers/{customer_id} | RetrieveCustomer +*SquareConnect.CustomersApi* | [**searchCustomers**](docs/CustomersApi.md#searchCustomers) | **POST** /v2/customers/search | SearchCustomers +*SquareConnect.CustomersApi* | [**updateCustomer**](docs/CustomersApi.md#updateCustomer) | **PUT** /v2/customers/{customer_id} | UpdateCustomer +*SquareConnect.DevicesApi* | [**createDeviceCode**](docs/DevicesApi.md#createDeviceCode) | **POST** /v2/devices/codes | CreateDeviceCode +*SquareConnect.DevicesApi* | [**getDeviceCode**](docs/DevicesApi.md#getDeviceCode) | **GET** /v2/devices/codes/{id} | GetDeviceCode +*SquareConnect.DevicesApi* | [**listDeviceCodes**](docs/DevicesApi.md#listDeviceCodes) | **GET** /v2/devices/codes | ListDeviceCodes +*SquareConnect.DisputesApi* | [**acceptDispute**](docs/DisputesApi.md#acceptDispute) | **POST** /v2/disputes/{dispute_id}/accept | AcceptDispute +*SquareConnect.DisputesApi* | [**createDisputeEvidenceText**](docs/DisputesApi.md#createDisputeEvidenceText) | **POST** /v2/disputes/{dispute_id}/evidence_text | CreateDisputeEvidenceText +*SquareConnect.DisputesApi* | [**listDisputeEvidence**](docs/DisputesApi.md#listDisputeEvidence) | **GET** /v2/disputes/{dispute_id}/evidence | ListDisputeEvidence +*SquareConnect.DisputesApi* | [**listDisputes**](docs/DisputesApi.md#listDisputes) | **GET** /v2/disputes | ListDisputes +*SquareConnect.DisputesApi* | [**removeDisputeEvidence**](docs/DisputesApi.md#removeDisputeEvidence) | **DELETE** /v2/disputes/{dispute_id}/evidence/{evidence_id} | RemoveDisputeEvidence +*SquareConnect.DisputesApi* | [**retrieveDispute**](docs/DisputesApi.md#retrieveDispute) | **GET** /v2/disputes/{dispute_id} | RetrieveDispute +*SquareConnect.DisputesApi* | [**retrieveDisputeEvidence**](docs/DisputesApi.md#retrieveDisputeEvidence) | **GET** /v2/disputes/{dispute_id}/evidence/{evidence_id} | RetrieveDisputeEvidence +*SquareConnect.DisputesApi* | [**submitEvidence**](docs/DisputesApi.md#submitEvidence) | **POST** /v2/disputes/{dispute_id}/submit-evidence | SubmitEvidence +*SquareConnect.EmployeesApi* | [**listEmployees**](docs/EmployeesApi.md#listEmployees) | **GET** /v2/employees | ListEmployees +*SquareConnect.EmployeesApi* | [**retrieveEmployee**](docs/EmployeesApi.md#retrieveEmployee) | **GET** /v2/employees/{id} | RetrieveEmployee +*SquareConnect.InventoryApi* | [**batchChangeInventory**](docs/InventoryApi.md#batchChangeInventory) | **POST** /v2/inventory/batch-change | BatchChangeInventory +*SquareConnect.InventoryApi* | [**batchRetrieveInventoryChanges**](docs/InventoryApi.md#batchRetrieveInventoryChanges) | **POST** /v2/inventory/batch-retrieve-changes | BatchRetrieveInventoryChanges +*SquareConnect.InventoryApi* | [**batchRetrieveInventoryCounts**](docs/InventoryApi.md#batchRetrieveInventoryCounts) | **POST** /v2/inventory/batch-retrieve-counts | BatchRetrieveInventoryCounts +*SquareConnect.InventoryApi* | [**retrieveInventoryAdjustment**](docs/InventoryApi.md#retrieveInventoryAdjustment) | **GET** /v2/inventory/adjustment/{adjustment_id} | RetrieveInventoryAdjustment +*SquareConnect.InventoryApi* | [**retrieveInventoryChanges**](docs/InventoryApi.md#retrieveInventoryChanges) | **GET** /v2/inventory/{catalog_object_id}/changes | RetrieveInventoryChanges +*SquareConnect.InventoryApi* | [**retrieveInventoryCount**](docs/InventoryApi.md#retrieveInventoryCount) | **GET** /v2/inventory/{catalog_object_id} | RetrieveInventoryCount +*SquareConnect.InventoryApi* | [**retrieveInventoryPhysicalCount**](docs/InventoryApi.md#retrieveInventoryPhysicalCount) | **GET** /v2/inventory/physical-count/{physical_count_id} | RetrieveInventoryPhysicalCount +*SquareConnect.InvoicesApi* | [**cancelInvoice**](docs/InvoicesApi.md#cancelInvoice) | **POST** /v2/invoices/{invoice_id}/cancel | CancelInvoice +*SquareConnect.InvoicesApi* | [**createInvoice**](docs/InvoicesApi.md#createInvoice) | **POST** /v2/invoices | CreateInvoice +*SquareConnect.InvoicesApi* | [**deleteInvoice**](docs/InvoicesApi.md#deleteInvoice) | **DELETE** /v2/invoices/{invoice_id} | DeleteInvoice +*SquareConnect.InvoicesApi* | [**getInvoice**](docs/InvoicesApi.md#getInvoice) | **GET** /v2/invoices/{invoice_id} | GetInvoice +*SquareConnect.InvoicesApi* | [**listInvoices**](docs/InvoicesApi.md#listInvoices) | **GET** /v2/invoices | ListInvoices +*SquareConnect.InvoicesApi* | [**publishInvoice**](docs/InvoicesApi.md#publishInvoice) | **POST** /v2/invoices/{invoice_id}/publish | PublishInvoice +*SquareConnect.InvoicesApi* | [**searchInvoices**](docs/InvoicesApi.md#searchInvoices) | **POST** /v2/invoices/search | SearchInvoices +*SquareConnect.InvoicesApi* | [**updateInvoice**](docs/InvoicesApi.md#updateInvoice) | **PUT** /v2/invoices/{invoice_id} | UpdateInvoice +*SquareConnect.LaborApi* | [**createBreakType**](docs/LaborApi.md#createBreakType) | **POST** /v2/labor/break-types | CreateBreakType +*SquareConnect.LaborApi* | [**createShift**](docs/LaborApi.md#createShift) | **POST** /v2/labor/shifts | CreateShift +*SquareConnect.LaborApi* | [**deleteBreakType**](docs/LaborApi.md#deleteBreakType) | **DELETE** /v2/labor/break-types/{id} | DeleteBreakType +*SquareConnect.LaborApi* | [**deleteShift**](docs/LaborApi.md#deleteShift) | **DELETE** /v2/labor/shifts/{id} | DeleteShift +*SquareConnect.LaborApi* | [**getBreakType**](docs/LaborApi.md#getBreakType) | **GET** /v2/labor/break-types/{id} | GetBreakType +*SquareConnect.LaborApi* | [**getEmployeeWage**](docs/LaborApi.md#getEmployeeWage) | **GET** /v2/labor/employee-wages/{id} | GetEmployeeWage +*SquareConnect.LaborApi* | [**getShift**](docs/LaborApi.md#getShift) | **GET** /v2/labor/shifts/{id} | GetShift +*SquareConnect.LaborApi* | [**getTeamMemberWage**](docs/LaborApi.md#getTeamMemberWage) | **GET** /v2/labor/team-member-wages/{id} | GetTeamMemberWage +*SquareConnect.LaborApi* | [**listBreakTypes**](docs/LaborApi.md#listBreakTypes) | **GET** /v2/labor/break-types | ListBreakTypes +*SquareConnect.LaborApi* | [**listEmployeeWages**](docs/LaborApi.md#listEmployeeWages) | **GET** /v2/labor/employee-wages | ListEmployeeWages +*SquareConnect.LaborApi* | [**listTeamMemberWages**](docs/LaborApi.md#listTeamMemberWages) | **GET** /v2/labor/team-member-wages | ListTeamMemberWages +*SquareConnect.LaborApi* | [**listWorkweekConfigs**](docs/LaborApi.md#listWorkweekConfigs) | **GET** /v2/labor/workweek-configs | ListWorkweekConfigs +*SquareConnect.LaborApi* | [**searchShifts**](docs/LaborApi.md#searchShifts) | **POST** /v2/labor/shifts/search | SearchShifts +*SquareConnect.LaborApi* | [**updateBreakType**](docs/LaborApi.md#updateBreakType) | **PUT** /v2/labor/break-types/{id} | UpdateBreakType +*SquareConnect.LaborApi* | [**updateShift**](docs/LaborApi.md#updateShift) | **PUT** /v2/labor/shifts/{id} | UpdateShift +*SquareConnect.LaborApi* | [**updateWorkweekConfig**](docs/LaborApi.md#updateWorkweekConfig) | **PUT** /v2/labor/workweek-configs/{id} | UpdateWorkweekConfig +*SquareConnect.LocationsApi* | [**createLocation**](docs/LocationsApi.md#createLocation) | **POST** /v2/locations | CreateLocation +*SquareConnect.LocationsApi* | [**listLocations**](docs/LocationsApi.md#listLocations) | **GET** /v2/locations | ListLocations +*SquareConnect.LocationsApi* | [**retrieveLocation**](docs/LocationsApi.md#retrieveLocation) | **GET** /v2/locations/{location_id} | RetrieveLocation +*SquareConnect.LocationsApi* | [**updateLocation**](docs/LocationsApi.md#updateLocation) | **PUT** /v2/locations/{location_id} | UpdateLocation +*SquareConnect.LoyaltyApi* | [**accumulateLoyaltyPoints**](docs/LoyaltyApi.md#accumulateLoyaltyPoints) | **POST** /v2/loyalty/accounts/{account_id}/accumulate | AccumulateLoyaltyPoints +*SquareConnect.LoyaltyApi* | [**adjustLoyaltyPoints**](docs/LoyaltyApi.md#adjustLoyaltyPoints) | **POST** /v2/loyalty/accounts/{account_id}/adjust | AdjustLoyaltyPoints +*SquareConnect.LoyaltyApi* | [**calculateLoyaltyPoints**](docs/LoyaltyApi.md#calculateLoyaltyPoints) | **POST** /v2/loyalty/programs/{program_id}/calculate | CalculateLoyaltyPoints +*SquareConnect.LoyaltyApi* | [**createLoyaltyAccount**](docs/LoyaltyApi.md#createLoyaltyAccount) | **POST** /v2/loyalty/accounts | CreateLoyaltyAccount +*SquareConnect.LoyaltyApi* | [**createLoyaltyReward**](docs/LoyaltyApi.md#createLoyaltyReward) | **POST** /v2/loyalty/rewards | CreateLoyaltyReward +*SquareConnect.LoyaltyApi* | [**deleteLoyaltyReward**](docs/LoyaltyApi.md#deleteLoyaltyReward) | **DELETE** /v2/loyalty/rewards/{reward_id} | DeleteLoyaltyReward +*SquareConnect.LoyaltyApi* | [**listLoyaltyPrograms**](docs/LoyaltyApi.md#listLoyaltyPrograms) | **GET** /v2/loyalty/programs | ListLoyaltyPrograms +*SquareConnect.LoyaltyApi* | [**redeemLoyaltyReward**](docs/LoyaltyApi.md#redeemLoyaltyReward) | **POST** /v2/loyalty/rewards/{reward_id}/redeem | RedeemLoyaltyReward +*SquareConnect.LoyaltyApi* | [**retrieveLoyaltyAccount**](docs/LoyaltyApi.md#retrieveLoyaltyAccount) | **GET** /v2/loyalty/accounts/{account_id} | RetrieveLoyaltyAccount +*SquareConnect.LoyaltyApi* | [**retrieveLoyaltyReward**](docs/LoyaltyApi.md#retrieveLoyaltyReward) | **GET** /v2/loyalty/rewards/{reward_id} | RetrieveLoyaltyReward +*SquareConnect.LoyaltyApi* | [**searchLoyaltyAccounts**](docs/LoyaltyApi.md#searchLoyaltyAccounts) | **POST** /v2/loyalty/accounts/search | SearchLoyaltyAccounts +*SquareConnect.LoyaltyApi* | [**searchLoyaltyEvents**](docs/LoyaltyApi.md#searchLoyaltyEvents) | **POST** /v2/loyalty/events/search | SearchLoyaltyEvents +*SquareConnect.LoyaltyApi* | [**searchLoyaltyRewards**](docs/LoyaltyApi.md#searchLoyaltyRewards) | **POST** /v2/loyalty/rewards/search | SearchLoyaltyRewards +*SquareConnect.MerchantsApi* | [**listMerchants**](docs/MerchantsApi.md#listMerchants) | **GET** /v2/merchants | ListMerchants +*SquareConnect.MerchantsApi* | [**retrieveMerchant**](docs/MerchantsApi.md#retrieveMerchant) | **GET** /v2/merchants/{merchant_id} | RetrieveMerchant +*SquareConnect.MobileAuthorizationApi* | [**createMobileAuthorizationCode**](docs/MobileAuthorizationApi.md#createMobileAuthorizationCode) | **POST** /mobile/authorization-code | CreateMobileAuthorizationCode +*SquareConnect.OAuthApi* | [**obtainToken**](docs/OAuthApi.md#obtainToken) | **POST** /oauth2/token | ObtainToken +*SquareConnect.OAuthApi* | [**renewToken**](docs/OAuthApi.md#renewToken) | **POST** /oauth2/clients/{client_id}/access-token/renew | RenewToken +*SquareConnect.OAuthApi* | [**revokeToken**](docs/OAuthApi.md#revokeToken) | **POST** /oauth2/revoke | RevokeToken +*SquareConnect.OrdersApi* | [**batchRetrieveOrders**](docs/OrdersApi.md#batchRetrieveOrders) | **POST** /v2/orders/batch-retrieve | BatchRetrieveOrders +*SquareConnect.OrdersApi* | [**calculateOrder**](docs/OrdersApi.md#calculateOrder) | **POST** /v2/orders/calculate | CalculateOrder +*SquareConnect.OrdersApi* | [**createOrder**](docs/OrdersApi.md#createOrder) | **POST** /v2/orders | CreateOrder +*SquareConnect.OrdersApi* | [**payOrder**](docs/OrdersApi.md#payOrder) | **POST** /v2/orders/{order_id}/pay | PayOrder +*SquareConnect.OrdersApi* | [**retrieveOrder**](docs/OrdersApi.md#retrieveOrder) | **GET** /v2/orders/{order_id} | RetrieveOrder +*SquareConnect.OrdersApi* | [**searchOrders**](docs/OrdersApi.md#searchOrders) | **POST** /v2/orders/search | SearchOrders +*SquareConnect.OrdersApi* | [**updateOrder**](docs/OrdersApi.md#updateOrder) | **PUT** /v2/orders/{order_id} | UpdateOrder +*SquareConnect.PaymentsApi* | [**cancelPayment**](docs/PaymentsApi.md#cancelPayment) | **POST** /v2/payments/{payment_id}/cancel | CancelPayment +*SquareConnect.PaymentsApi* | [**cancelPaymentByIdempotencyKey**](docs/PaymentsApi.md#cancelPaymentByIdempotencyKey) | **POST** /v2/payments/cancel | CancelPaymentByIdempotencyKey +*SquareConnect.PaymentsApi* | [**completePayment**](docs/PaymentsApi.md#completePayment) | **POST** /v2/payments/{payment_id}/complete | CompletePayment +*SquareConnect.PaymentsApi* | [**createPayment**](docs/PaymentsApi.md#createPayment) | **POST** /v2/payments | CreatePayment +*SquareConnect.PaymentsApi* | [**getPayment**](docs/PaymentsApi.md#getPayment) | **GET** /v2/payments/{payment_id} | GetPayment +*SquareConnect.PaymentsApi* | [**listPayments**](docs/PaymentsApi.md#listPayments) | **GET** /v2/payments | ListPayments +*SquareConnect.RefundsApi* | [**getPaymentRefund**](docs/RefundsApi.md#getPaymentRefund) | **GET** /v2/refunds/{refund_id} | GetPaymentRefund +*SquareConnect.RefundsApi* | [**listPaymentRefunds**](docs/RefundsApi.md#listPaymentRefunds) | **GET** /v2/refunds | ListPaymentRefunds +*SquareConnect.RefundsApi* | [**refundPayment**](docs/RefundsApi.md#refundPayment) | **POST** /v2/refunds | RefundPayment +*SquareConnect.SubscriptionsApi* | [**cancelSubscription**](docs/SubscriptionsApi.md#cancelSubscription) | **POST** /v2/subscriptions/{subscription_id}/cancel | CancelSubscription +*SquareConnect.SubscriptionsApi* | [**createSubscription**](docs/SubscriptionsApi.md#createSubscription) | **POST** /v2/subscriptions | CreateSubscription +*SquareConnect.SubscriptionsApi* | [**listSubscriptionEvents**](docs/SubscriptionsApi.md#listSubscriptionEvents) | **GET** /v2/subscriptions/{subscription_id}/events | ListSubscriptionEvents +*SquareConnect.SubscriptionsApi* | [**retrieveSubscription**](docs/SubscriptionsApi.md#retrieveSubscription) | **GET** /v2/subscriptions/{subscription_id} | RetrieveSubscription +*SquareConnect.SubscriptionsApi* | [**searchSubscriptions**](docs/SubscriptionsApi.md#searchSubscriptions) | **POST** /v2/subscriptions/search | SearchSubscriptions +*SquareConnect.SubscriptionsApi* | [**updateSubscription**](docs/SubscriptionsApi.md#updateSubscription) | **PUT** /v2/subscriptions/{subscription_id} | UpdateSubscription +*SquareConnect.TeamApi* | [**bulkCreateTeamMembers**](docs/TeamApi.md#bulkCreateTeamMembers) | **POST** /v2/team-members/bulk-create | BulkCreateTeamMembers +*SquareConnect.TeamApi* | [**bulkUpdateTeamMembers**](docs/TeamApi.md#bulkUpdateTeamMembers) | **POST** /v2/team-members/bulk-update | BulkUpdateTeamMembers +*SquareConnect.TeamApi* | [**createTeamMember**](docs/TeamApi.md#createTeamMember) | **POST** /v2/team-members | CreateTeamMember +*SquareConnect.TeamApi* | [**retrieveTeamMember**](docs/TeamApi.md#retrieveTeamMember) | **GET** /v2/team-members/{team_member_id} | RetrieveTeamMember +*SquareConnect.TeamApi* | [**retrieveWageSetting**](docs/TeamApi.md#retrieveWageSetting) | **GET** /v2/team-members/{team_member_id}/wage-setting | RetrieveWageSetting +*SquareConnect.TeamApi* | [**searchTeamMembers**](docs/TeamApi.md#searchTeamMembers) | **POST** /v2/team-members/search | SearchTeamMembers +*SquareConnect.TeamApi* | [**updateTeamMember**](docs/TeamApi.md#updateTeamMember) | **PUT** /v2/team-members/{team_member_id} | UpdateTeamMember +*SquareConnect.TeamApi* | [**updateWageSetting**](docs/TeamApi.md#updateWageSetting) | **PUT** /v2/team-members/{team_member_id}/wage-setting | UpdateWageSetting +*SquareConnect.TerminalApi* | [**cancelTerminalCheckout**](docs/TerminalApi.md#cancelTerminalCheckout) | **POST** /v2/terminals/checkouts/{checkout_id}/cancel | CancelTerminalCheckout +*SquareConnect.TerminalApi* | [**cancelTerminalRefund**](docs/TerminalApi.md#cancelTerminalRefund) | **POST** /v2/terminals/refunds/{terminal_refund_id}/cancel | CancelTerminalRefund +*SquareConnect.TerminalApi* | [**createTerminalCheckout**](docs/TerminalApi.md#createTerminalCheckout) | **POST** /v2/terminals/checkouts | CreateTerminalCheckout +*SquareConnect.TerminalApi* | [**createTerminalRefund**](docs/TerminalApi.md#createTerminalRefund) | **POST** /v2/terminals/refunds | CreateTerminalRefund +*SquareConnect.TerminalApi* | [**getTerminalCheckout**](docs/TerminalApi.md#getTerminalCheckout) | **GET** /v2/terminals/checkouts/{checkout_id} | GetTerminalCheckout +*SquareConnect.TerminalApi* | [**getTerminalRefund**](docs/TerminalApi.md#getTerminalRefund) | **GET** /v2/terminals/refunds/{terminal_refund_id} | GetTerminalRefund +*SquareConnect.TerminalApi* | [**searchTerminalCheckouts**](docs/TerminalApi.md#searchTerminalCheckouts) | **POST** /v2/terminals/checkouts/search | SearchTerminalCheckouts +*SquareConnect.TerminalApi* | [**searchTerminalRefunds**](docs/TerminalApi.md#searchTerminalRefunds) | **POST** /v2/terminals/refunds/search | SearchTerminalRefunds +*SquareConnect.TransactionsApi* | [**captureTransaction**](docs/TransactionsApi.md#captureTransaction) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/capture | CaptureTransaction +*SquareConnect.TransactionsApi* | [**charge**](docs/TransactionsApi.md#charge) | **POST** /v2/locations/{location_id}/transactions | Charge +*SquareConnect.TransactionsApi* | [**createRefund**](docs/TransactionsApi.md#createRefund) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/refund | CreateRefund +*SquareConnect.TransactionsApi* | [**listRefunds**](docs/TransactionsApi.md#listRefunds) | **GET** /v2/locations/{location_id}/refunds | ListRefunds +*SquareConnect.TransactionsApi* | [**listTransactions**](docs/TransactionsApi.md#listTransactions) | **GET** /v2/locations/{location_id}/transactions | ListTransactions +*SquareConnect.TransactionsApi* | [**retrieveTransaction**](docs/TransactionsApi.md#retrieveTransaction) | **GET** /v2/locations/{location_id}/transactions/{transaction_id} | RetrieveTransaction +*SquareConnect.TransactionsApi* | [**voidTransaction**](docs/TransactionsApi.md#voidTransaction) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/void | VoidTransaction +*SquareConnect.V1EmployeesApi* | [**createEmployee**](docs/V1EmployeesApi.md#createEmployee) | **POST** /v1/me/employees | CreateEmployee +*SquareConnect.V1EmployeesApi* | [**createEmployeeRole**](docs/V1EmployeesApi.md#createEmployeeRole) | **POST** /v1/me/roles | CreateEmployeeRole +*SquareConnect.V1EmployeesApi* | [**createTimecard**](docs/V1EmployeesApi.md#createTimecard) | **POST** /v1/me/timecards | CreateTimecard +*SquareConnect.V1EmployeesApi* | [**deleteTimecard**](docs/V1EmployeesApi.md#deleteTimecard) | **DELETE** /v1/me/timecards/{timecard_id} | DeleteTimecard +*SquareConnect.V1EmployeesApi* | [**listCashDrawerShifts**](docs/V1EmployeesApi.md#listCashDrawerShifts) | **GET** /v1/{location_id}/cash-drawer-shifts | ListCashDrawerShifts +*SquareConnect.V1EmployeesApi* | [**listEmployeeRoles**](docs/V1EmployeesApi.md#listEmployeeRoles) | **GET** /v1/me/roles | ListEmployeeRoles +*SquareConnect.V1EmployeesApi* | [**listEmployees**](docs/V1EmployeesApi.md#listEmployees) | **GET** /v1/me/employees | ListEmployees +*SquareConnect.V1EmployeesApi* | [**listTimecardEvents**](docs/V1EmployeesApi.md#listTimecardEvents) | **GET** /v1/me/timecards/{timecard_id}/events | ListTimecardEvents +*SquareConnect.V1EmployeesApi* | [**listTimecards**](docs/V1EmployeesApi.md#listTimecards) | **GET** /v1/me/timecards | ListTimecards +*SquareConnect.V1EmployeesApi* | [**retrieveCashDrawerShift**](docs/V1EmployeesApi.md#retrieveCashDrawerShift) | **GET** /v1/{location_id}/cash-drawer-shifts/{shift_id} | RetrieveCashDrawerShift +*SquareConnect.V1EmployeesApi* | [**retrieveEmployee**](docs/V1EmployeesApi.md#retrieveEmployee) | **GET** /v1/me/employees/{employee_id} | RetrieveEmployee +*SquareConnect.V1EmployeesApi* | [**retrieveEmployeeRole**](docs/V1EmployeesApi.md#retrieveEmployeeRole) | **GET** /v1/me/roles/{role_id} | RetrieveEmployeeRole +*SquareConnect.V1EmployeesApi* | [**retrieveTimecard**](docs/V1EmployeesApi.md#retrieveTimecard) | **GET** /v1/me/timecards/{timecard_id} | RetrieveTimecard +*SquareConnect.V1EmployeesApi* | [**updateEmployee**](docs/V1EmployeesApi.md#updateEmployee) | **PUT** /v1/me/employees/{employee_id} | UpdateEmployee +*SquareConnect.V1EmployeesApi* | [**updateEmployeeRole**](docs/V1EmployeesApi.md#updateEmployeeRole) | **PUT** /v1/me/roles/{role_id} | UpdateEmployeeRole +*SquareConnect.V1EmployeesApi* | [**updateTimecard**](docs/V1EmployeesApi.md#updateTimecard) | **PUT** /v1/me/timecards/{timecard_id} | UpdateTimecard +*SquareConnect.V1ItemsApi* | [**adjustInventory**](docs/V1ItemsApi.md#adjustInventory) | **POST** /v1/{location_id}/inventory/{variation_id} | AdjustInventory +*SquareConnect.V1ItemsApi* | [**applyFee**](docs/V1ItemsApi.md#applyFee) | **PUT** /v1/{location_id}/items/{item_id}/fees/{fee_id} | ApplyFee +*SquareConnect.V1ItemsApi* | [**applyModifierList**](docs/V1ItemsApi.md#applyModifierList) | **PUT** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | ApplyModifierList +*SquareConnect.V1ItemsApi* | [**createCategory**](docs/V1ItemsApi.md#createCategory) | **POST** /v1/{location_id}/categories | CreateCategory +*SquareConnect.V1ItemsApi* | [**createDiscount**](docs/V1ItemsApi.md#createDiscount) | **POST** /v1/{location_id}/discounts | CreateDiscount +*SquareConnect.V1ItemsApi* | [**createFee**](docs/V1ItemsApi.md#createFee) | **POST** /v1/{location_id}/fees | CreateFee +*SquareConnect.V1ItemsApi* | [**createItem**](docs/V1ItemsApi.md#createItem) | **POST** /v1/{location_id}/items | CreateItem +*SquareConnect.V1ItemsApi* | [**createModifierList**](docs/V1ItemsApi.md#createModifierList) | **POST** /v1/{location_id}/modifier-lists | CreateModifierList +*SquareConnect.V1ItemsApi* | [**createModifierOption**](docs/V1ItemsApi.md#createModifierOption) | **POST** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options | CreateModifierOption +*SquareConnect.V1ItemsApi* | [**createPage**](docs/V1ItemsApi.md#createPage) | **POST** /v1/{location_id}/pages | CreatePage +*SquareConnect.V1ItemsApi* | [**createVariation**](docs/V1ItemsApi.md#createVariation) | **POST** /v1/{location_id}/items/{item_id}/variations | CreateVariation +*SquareConnect.V1ItemsApi* | [**deleteCategory**](docs/V1ItemsApi.md#deleteCategory) | **DELETE** /v1/{location_id}/categories/{category_id} | DeleteCategory +*SquareConnect.V1ItemsApi* | [**deleteDiscount**](docs/V1ItemsApi.md#deleteDiscount) | **DELETE** /v1/{location_id}/discounts/{discount_id} | DeleteDiscount +*SquareConnect.V1ItemsApi* | [**deleteFee**](docs/V1ItemsApi.md#deleteFee) | **DELETE** /v1/{location_id}/fees/{fee_id} | DeleteFee +*SquareConnect.V1ItemsApi* | [**deleteItem**](docs/V1ItemsApi.md#deleteItem) | **DELETE** /v1/{location_id}/items/{item_id} | DeleteItem +*SquareConnect.V1ItemsApi* | [**deleteModifierList**](docs/V1ItemsApi.md#deleteModifierList) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id} | DeleteModifierList +*SquareConnect.V1ItemsApi* | [**deleteModifierOption**](docs/V1ItemsApi.md#deleteModifierOption) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | DeleteModifierOption +*SquareConnect.V1ItemsApi* | [**deletePage**](docs/V1ItemsApi.md#deletePage) | **DELETE** /v1/{location_id}/pages/{page_id} | DeletePage +*SquareConnect.V1ItemsApi* | [**deletePageCell**](docs/V1ItemsApi.md#deletePageCell) | **DELETE** /v1/{location_id}/pages/{page_id}/cells | DeletePageCell +*SquareConnect.V1ItemsApi* | [**deleteVariation**](docs/V1ItemsApi.md#deleteVariation) | **DELETE** /v1/{location_id}/items/{item_id}/variations/{variation_id} | DeleteVariation +*SquareConnect.V1ItemsApi* | [**listCategories**](docs/V1ItemsApi.md#listCategories) | **GET** /v1/{location_id}/categories | ListCategories +*SquareConnect.V1ItemsApi* | [**listDiscounts**](docs/V1ItemsApi.md#listDiscounts) | **GET** /v1/{location_id}/discounts | ListDiscounts +*SquareConnect.V1ItemsApi* | [**listFees**](docs/V1ItemsApi.md#listFees) | **GET** /v1/{location_id}/fees | ListFees +*SquareConnect.V1ItemsApi* | [**listInventory**](docs/V1ItemsApi.md#listInventory) | **GET** /v1/{location_id}/inventory | ListInventory +*SquareConnect.V1ItemsApi* | [**listItems**](docs/V1ItemsApi.md#listItems) | **GET** /v1/{location_id}/items | ListItems +*SquareConnect.V1ItemsApi* | [**listModifierLists**](docs/V1ItemsApi.md#listModifierLists) | **GET** /v1/{location_id}/modifier-lists | ListModifierLists +*SquareConnect.V1ItemsApi* | [**listPages**](docs/V1ItemsApi.md#listPages) | **GET** /v1/{location_id}/pages | ListPages +*SquareConnect.V1ItemsApi* | [**removeFee**](docs/V1ItemsApi.md#removeFee) | **DELETE** /v1/{location_id}/items/{item_id}/fees/{fee_id} | RemoveFee +*SquareConnect.V1ItemsApi* | [**removeModifierList**](docs/V1ItemsApi.md#removeModifierList) | **DELETE** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | RemoveModifierList +*SquareConnect.V1ItemsApi* | [**retrieveItem**](docs/V1ItemsApi.md#retrieveItem) | **GET** /v1/{location_id}/items/{item_id} | RetrieveItem +*SquareConnect.V1ItemsApi* | [**retrieveModifierList**](docs/V1ItemsApi.md#retrieveModifierList) | **GET** /v1/{location_id}/modifier-lists/{modifier_list_id} | RetrieveModifierList +*SquareConnect.V1ItemsApi* | [**updateCategory**](docs/V1ItemsApi.md#updateCategory) | **PUT** /v1/{location_id}/categories/{category_id} | UpdateCategory +*SquareConnect.V1ItemsApi* | [**updateDiscount**](docs/V1ItemsApi.md#updateDiscount) | **PUT** /v1/{location_id}/discounts/{discount_id} | UpdateDiscount +*SquareConnect.V1ItemsApi* | [**updateFee**](docs/V1ItemsApi.md#updateFee) | **PUT** /v1/{location_id}/fees/{fee_id} | UpdateFee +*SquareConnect.V1ItemsApi* | [**updateItem**](docs/V1ItemsApi.md#updateItem) | **PUT** /v1/{location_id}/items/{item_id} | UpdateItem +*SquareConnect.V1ItemsApi* | [**updateModifierList**](docs/V1ItemsApi.md#updateModifierList) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id} | UpdateModifierList +*SquareConnect.V1ItemsApi* | [**updateModifierOption**](docs/V1ItemsApi.md#updateModifierOption) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | UpdateModifierOption +*SquareConnect.V1ItemsApi* | [**updatePage**](docs/V1ItemsApi.md#updatePage) | **PUT** /v1/{location_id}/pages/{page_id} | UpdatePage +*SquareConnect.V1ItemsApi* | [**updatePageCell**](docs/V1ItemsApi.md#updatePageCell) | **PUT** /v1/{location_id}/pages/{page_id}/cells | UpdatePageCell +*SquareConnect.V1ItemsApi* | [**updateVariation**](docs/V1ItemsApi.md#updateVariation) | **PUT** /v1/{location_id}/items/{item_id}/variations/{variation_id} | UpdateVariation +*SquareConnect.V1LocationsApi* | [**listLocations**](docs/V1LocationsApi.md#listLocations) | **GET** /v1/me/locations | ListLocations +*SquareConnect.V1LocationsApi* | [**retrieveBusiness**](docs/V1LocationsApi.md#retrieveBusiness) | **GET** /v1/me | RetrieveBusiness +*SquareConnect.V1TransactionsApi* | [**createRefund**](docs/V1TransactionsApi.md#createRefund) | **POST** /v1/{location_id}/refunds | CreateRefund +*SquareConnect.V1TransactionsApi* | [**listBankAccounts**](docs/V1TransactionsApi.md#listBankAccounts) | **GET** /v1/{location_id}/bank-accounts | ListBankAccounts +*SquareConnect.V1TransactionsApi* | [**listOrders**](docs/V1TransactionsApi.md#listOrders) | **GET** /v1/{location_id}/orders | ListOrders +*SquareConnect.V1TransactionsApi* | [**listPayments**](docs/V1TransactionsApi.md#listPayments) | **GET** /v1/{location_id}/payments | ListPayments +*SquareConnect.V1TransactionsApi* | [**listRefunds**](docs/V1TransactionsApi.md#listRefunds) | **GET** /v1/{location_id}/refunds | ListRefunds +*SquareConnect.V1TransactionsApi* | [**listSettlements**](docs/V1TransactionsApi.md#listSettlements) | **GET** /v1/{location_id}/settlements | ListSettlements +*SquareConnect.V1TransactionsApi* | [**retrieveBankAccount**](docs/V1TransactionsApi.md#retrieveBankAccount) | **GET** /v1/{location_id}/bank-accounts/{bank_account_id} | RetrieveBankAccount +*SquareConnect.V1TransactionsApi* | [**retrieveOrder**](docs/V1TransactionsApi.md#retrieveOrder) | **GET** /v1/{location_id}/orders/{order_id} | RetrieveOrder +*SquareConnect.V1TransactionsApi* | [**retrievePayment**](docs/V1TransactionsApi.md#retrievePayment) | **GET** /v1/{location_id}/payments/{payment_id} | RetrievePayment +*SquareConnect.V1TransactionsApi* | [**retrieveSettlement**](docs/V1TransactionsApi.md#retrieveSettlement) | **GET** /v1/{location_id}/settlements/{settlement_id} | RetrieveSettlement +*SquareConnect.V1TransactionsApi* | [**updateOrder**](docs/V1TransactionsApi.md#updateOrder) | **PUT** /v1/{location_id}/orders/{order_id} | UpdateOrder + + +## Documentation for Models + + - [SquareConnect.AcceptDisputeRequest](docs/AcceptDisputeRequest.md) + - [SquareConnect.AcceptDisputeResponse](docs/AcceptDisputeResponse.md) + - [SquareConnect.AccumulateLoyaltyPointsRequest](docs/AccumulateLoyaltyPointsRequest.md) + - [SquareConnect.AccumulateLoyaltyPointsResponse](docs/AccumulateLoyaltyPointsResponse.md) + - [SquareConnect.ActionCancelReason](docs/ActionCancelReason.md) + - [SquareConnect.AddGroupToCustomerRequest](docs/AddGroupToCustomerRequest.md) + - [SquareConnect.AddGroupToCustomerResponse](docs/AddGroupToCustomerResponse.md) + - [SquareConnect.AdditionalRecipient](docs/AdditionalRecipient.md) + - [SquareConnect.Address](docs/Address.md) + - [SquareConnect.AdjustLoyaltyPointsRequest](docs/AdjustLoyaltyPointsRequest.md) + - [SquareConnect.AdjustLoyaltyPointsResponse](docs/AdjustLoyaltyPointsResponse.md) + - [SquareConnect.AppointmentSegment](docs/AppointmentSegment.md) + - [SquareConnect.Availability](docs/Availability.md) + - [SquareConnect.BalancePaymentDetails](docs/BalancePaymentDetails.md) + - [SquareConnect.BankAccount](docs/BankAccount.md) + - [SquareConnect.BankAccountStatus](docs/BankAccountStatus.md) + - [SquareConnect.BankAccountType](docs/BankAccountType.md) + - [SquareConnect.BatchChangeInventoryRequest](docs/BatchChangeInventoryRequest.md) + - [SquareConnect.BatchChangeInventoryResponse](docs/BatchChangeInventoryResponse.md) + - [SquareConnect.BatchDeleteCatalogObjectsRequest](docs/BatchDeleteCatalogObjectsRequest.md) + - [SquareConnect.BatchDeleteCatalogObjectsResponse](docs/BatchDeleteCatalogObjectsResponse.md) + - [SquareConnect.BatchRetrieveCatalogObjectsRequest](docs/BatchRetrieveCatalogObjectsRequest.md) + - [SquareConnect.BatchRetrieveCatalogObjectsResponse](docs/BatchRetrieveCatalogObjectsResponse.md) + - [SquareConnect.BatchRetrieveInventoryChangesRequest](docs/BatchRetrieveInventoryChangesRequest.md) + - [SquareConnect.BatchRetrieveInventoryChangesResponse](docs/BatchRetrieveInventoryChangesResponse.md) + - [SquareConnect.BatchRetrieveInventoryCountsRequest](docs/BatchRetrieveInventoryCountsRequest.md) + - [SquareConnect.BatchRetrieveInventoryCountsResponse](docs/BatchRetrieveInventoryCountsResponse.md) + - [SquareConnect.BatchRetrieveOrdersRequest](docs/BatchRetrieveOrdersRequest.md) + - [SquareConnect.BatchRetrieveOrdersResponse](docs/BatchRetrieveOrdersResponse.md) + - [SquareConnect.BatchUpsertCatalogObjectsRequest](docs/BatchUpsertCatalogObjectsRequest.md) + - [SquareConnect.BatchUpsertCatalogObjectsResponse](docs/BatchUpsertCatalogObjectsResponse.md) + - [SquareConnect.Booking](docs/Booking.md) + - [SquareConnect.BookingStatus](docs/BookingStatus.md) + - [SquareConnect.BreakType](docs/BreakType.md) + - [SquareConnect.BulkCreateTeamMembersRequest](docs/BulkCreateTeamMembersRequest.md) + - [SquareConnect.BulkCreateTeamMembersResponse](docs/BulkCreateTeamMembersResponse.md) + - [SquareConnect.BulkUpdateTeamMembersRequest](docs/BulkUpdateTeamMembersRequest.md) + - [SquareConnect.BulkUpdateTeamMembersResponse](docs/BulkUpdateTeamMembersResponse.md) + - [SquareConnect.BusinessAppointmentSettings](docs/BusinessAppointmentSettings.md) + - [SquareConnect.BusinessAppointmentSettingsAlignmentTime](docs/BusinessAppointmentSettingsAlignmentTime.md) + - [SquareConnect.BusinessAppointmentSettingsBookingLocationType](docs/BusinessAppointmentSettingsBookingLocationType.md) + - [SquareConnect.BusinessAppointmentSettingsCancellationPolicy](docs/BusinessAppointmentSettingsCancellationPolicy.md) + - [SquareConnect.BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType](docs/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.md) + - [SquareConnect.BusinessBookingProfile](docs/BusinessBookingProfile.md) + - [SquareConnect.BusinessBookingProfileBookingPolicy](docs/BusinessBookingProfileBookingPolicy.md) + - [SquareConnect.BusinessBookingProfileCustomerTimezoneChoice](docs/BusinessBookingProfileCustomerTimezoneChoice.md) + - [SquareConnect.BusinessHours](docs/BusinessHours.md) + - [SquareConnect.BusinessHoursPeriod](docs/BusinessHoursPeriod.md) + - [SquareConnect.CalculateLoyaltyPointsRequest](docs/CalculateLoyaltyPointsRequest.md) + - [SquareConnect.CalculateLoyaltyPointsResponse](docs/CalculateLoyaltyPointsResponse.md) + - [SquareConnect.CalculateOrderRequest](docs/CalculateOrderRequest.md) + - [SquareConnect.CalculateOrderResponse](docs/CalculateOrderResponse.md) + - [SquareConnect.CancelInvoiceRequest](docs/CancelInvoiceRequest.md) + - [SquareConnect.CancelInvoiceResponse](docs/CancelInvoiceResponse.md) + - [SquareConnect.CancelPaymentByIdempotencyKeyRequest](docs/CancelPaymentByIdempotencyKeyRequest.md) + - [SquareConnect.CancelPaymentByIdempotencyKeyResponse](docs/CancelPaymentByIdempotencyKeyResponse.md) + - [SquareConnect.CancelPaymentRequest](docs/CancelPaymentRequest.md) + - [SquareConnect.CancelPaymentResponse](docs/CancelPaymentResponse.md) + - [SquareConnect.CancelSubscriptionRequest](docs/CancelSubscriptionRequest.md) + - [SquareConnect.CancelSubscriptionResponse](docs/CancelSubscriptionResponse.md) + - [SquareConnect.CancelTerminalCheckoutRequest](docs/CancelTerminalCheckoutRequest.md) + - [SquareConnect.CancelTerminalCheckoutResponse](docs/CancelTerminalCheckoutResponse.md) + - [SquareConnect.CancelTerminalRefundRequest](docs/CancelTerminalRefundRequest.md) + - [SquareConnect.CancelTerminalRefundResponse](docs/CancelTerminalRefundResponse.md) + - [SquareConnect.CaptureTransactionRequest](docs/CaptureTransactionRequest.md) + - [SquareConnect.CaptureTransactionResponse](docs/CaptureTransactionResponse.md) + - [SquareConnect.Card](docs/Card.md) + - [SquareConnect.CardBrand](docs/CardBrand.md) + - [SquareConnect.CardPaymentDetails](docs/CardPaymentDetails.md) + - [SquareConnect.CardPrepaidType](docs/CardPrepaidType.md) + - [SquareConnect.CardSquareProduct](docs/CardSquareProduct.md) + - [SquareConnect.CardType](docs/CardType.md) + - [SquareConnect.CashDrawerDevice](docs/CashDrawerDevice.md) + - [SquareConnect.CashDrawerEventType](docs/CashDrawerEventType.md) + - [SquareConnect.CashDrawerShift](docs/CashDrawerShift.md) + - [SquareConnect.CashDrawerShiftEvent](docs/CashDrawerShiftEvent.md) + - [SquareConnect.CashDrawerShiftState](docs/CashDrawerShiftState.md) + - [SquareConnect.CashDrawerShiftSummary](docs/CashDrawerShiftSummary.md) + - [SquareConnect.CatalogCategory](docs/CatalogCategory.md) + - [SquareConnect.CatalogCustomAttributeDefinition](docs/CatalogCustomAttributeDefinition.md) + - [SquareConnect.CatalogCustomAttributeDefinitionAppVisibility](docs/CatalogCustomAttributeDefinitionAppVisibility.md) + - [SquareConnect.CatalogCustomAttributeDefinitionNumberConfig](docs/CatalogCustomAttributeDefinitionNumberConfig.md) + - [SquareConnect.CatalogCustomAttributeDefinitionSelectionConfig](docs/CatalogCustomAttributeDefinitionSelectionConfig.md) + - [SquareConnect.CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection](docs/CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection.md) + - [SquareConnect.CatalogCustomAttributeDefinitionSellerVisibility](docs/CatalogCustomAttributeDefinitionSellerVisibility.md) + - [SquareConnect.CatalogCustomAttributeDefinitionStringConfig](docs/CatalogCustomAttributeDefinitionStringConfig.md) + - [SquareConnect.CatalogCustomAttributeDefinitionType](docs/CatalogCustomAttributeDefinitionType.md) + - [SquareConnect.CatalogCustomAttributeValue](docs/CatalogCustomAttributeValue.md) + - [SquareConnect.CatalogDiscount](docs/CatalogDiscount.md) + - [SquareConnect.CatalogDiscountModifyTaxBasis](docs/CatalogDiscountModifyTaxBasis.md) + - [SquareConnect.CatalogDiscountType](docs/CatalogDiscountType.md) + - [SquareConnect.CatalogIdMapping](docs/CatalogIdMapping.md) + - [SquareConnect.CatalogImage](docs/CatalogImage.md) + - [SquareConnect.CatalogInfoRequest](docs/CatalogInfoRequest.md) + - [SquareConnect.CatalogInfoResponse](docs/CatalogInfoResponse.md) + - [SquareConnect.CatalogInfoResponseLimits](docs/CatalogInfoResponseLimits.md) + - [SquareConnect.CatalogItem](docs/CatalogItem.md) + - [SquareConnect.CatalogItemModifierListInfo](docs/CatalogItemModifierListInfo.md) + - [SquareConnect.CatalogItemOption](docs/CatalogItemOption.md) + - [SquareConnect.CatalogItemOptionForItem](docs/CatalogItemOptionForItem.md) + - [SquareConnect.CatalogItemOptionValue](docs/CatalogItemOptionValue.md) + - [SquareConnect.CatalogItemOptionValueForItemVariation](docs/CatalogItemOptionValueForItemVariation.md) + - [SquareConnect.CatalogItemProductType](docs/CatalogItemProductType.md) + - [SquareConnect.CatalogItemVariation](docs/CatalogItemVariation.md) + - [SquareConnect.CatalogMeasurementUnit](docs/CatalogMeasurementUnit.md) + - [SquareConnect.CatalogModifier](docs/CatalogModifier.md) + - [SquareConnect.CatalogModifierList](docs/CatalogModifierList.md) + - [SquareConnect.CatalogModifierListSelectionType](docs/CatalogModifierListSelectionType.md) + - [SquareConnect.CatalogModifierOverride](docs/CatalogModifierOverride.md) + - [SquareConnect.CatalogObject](docs/CatalogObject.md) + - [SquareConnect.CatalogObjectBatch](docs/CatalogObjectBatch.md) + - [SquareConnect.CatalogObjectType](docs/CatalogObjectType.md) + - [SquareConnect.CatalogPricingRule](docs/CatalogPricingRule.md) + - [SquareConnect.CatalogPricingType](docs/CatalogPricingType.md) + - [SquareConnect.CatalogProductSet](docs/CatalogProductSet.md) + - [SquareConnect.CatalogQuery](docs/CatalogQuery.md) + - [SquareConnect.CatalogQueryExact](docs/CatalogQueryExact.md) + - [SquareConnect.CatalogQueryItemVariationsForItemOptionValues](docs/CatalogQueryItemVariationsForItemOptionValues.md) + - [SquareConnect.CatalogQueryItemsForItemOptions](docs/CatalogQueryItemsForItemOptions.md) + - [SquareConnect.CatalogQueryItemsForModifierList](docs/CatalogQueryItemsForModifierList.md) + - [SquareConnect.CatalogQueryItemsForTax](docs/CatalogQueryItemsForTax.md) + - [SquareConnect.CatalogQueryPrefix](docs/CatalogQueryPrefix.md) + - [SquareConnect.CatalogQueryRange](docs/CatalogQueryRange.md) + - [SquareConnect.CatalogQuerySet](docs/CatalogQuerySet.md) + - [SquareConnect.CatalogQuerySortedAttribute](docs/CatalogQuerySortedAttribute.md) + - [SquareConnect.CatalogQueryText](docs/CatalogQueryText.md) + - [SquareConnect.CatalogQuickAmount](docs/CatalogQuickAmount.md) + - [SquareConnect.CatalogQuickAmountType](docs/CatalogQuickAmountType.md) + - [SquareConnect.CatalogQuickAmountsSettings](docs/CatalogQuickAmountsSettings.md) + - [SquareConnect.CatalogQuickAmountsSettingsOption](docs/CatalogQuickAmountsSettingsOption.md) + - [SquareConnect.CatalogSubscriptionPlan](docs/CatalogSubscriptionPlan.md) + - [SquareConnect.CatalogTax](docs/CatalogTax.md) + - [SquareConnect.CatalogTimePeriod](docs/CatalogTimePeriod.md) + - [SquareConnect.CatalogV1Id](docs/CatalogV1Id.md) + - [SquareConnect.ChargeRequest](docs/ChargeRequest.md) + - [SquareConnect.ChargeRequestAdditionalRecipient](docs/ChargeRequestAdditionalRecipient.md) + - [SquareConnect.ChargeResponse](docs/ChargeResponse.md) + - [SquareConnect.CheckAppointmentsOnboardedRequest](docs/CheckAppointmentsOnboardedRequest.md) + - [SquareConnect.CheckAppointmentsOnboardedResponse](docs/CheckAppointmentsOnboardedResponse.md) + - [SquareConnect.Checkout](docs/Checkout.md) + - [SquareConnect.CompletePaymentRequest](docs/CompletePaymentRequest.md) + - [SquareConnect.CompletePaymentResponse](docs/CompletePaymentResponse.md) + - [SquareConnect.Coordinates](docs/Coordinates.md) + - [SquareConnect.Country](docs/Country.md) + - [SquareConnect.CreateBookingRequest](docs/CreateBookingRequest.md) + - [SquareConnect.CreateBookingResponse](docs/CreateBookingResponse.md) + - [SquareConnect.CreateBreakTypeRequest](docs/CreateBreakTypeRequest.md) + - [SquareConnect.CreateBreakTypeResponse](docs/CreateBreakTypeResponse.md) + - [SquareConnect.CreateCheckoutRequest](docs/CreateCheckoutRequest.md) + - [SquareConnect.CreateCheckoutResponse](docs/CreateCheckoutResponse.md) + - [SquareConnect.CreateCustomerCardRequest](docs/CreateCustomerCardRequest.md) + - [SquareConnect.CreateCustomerCardResponse](docs/CreateCustomerCardResponse.md) + - [SquareConnect.CreateCustomerGroupRequest](docs/CreateCustomerGroupRequest.md) + - [SquareConnect.CreateCustomerGroupResponse](docs/CreateCustomerGroupResponse.md) + - [SquareConnect.CreateCustomerRequest](docs/CreateCustomerRequest.md) + - [SquareConnect.CreateCustomerResponse](docs/CreateCustomerResponse.md) + - [SquareConnect.CreateDeviceCodeRequest](docs/CreateDeviceCodeRequest.md) + - [SquareConnect.CreateDeviceCodeResponse](docs/CreateDeviceCodeResponse.md) + - [SquareConnect.CreateDisputeEvidenceTextRequest](docs/CreateDisputeEvidenceTextRequest.md) + - [SquareConnect.CreateDisputeEvidenceTextResponse](docs/CreateDisputeEvidenceTextResponse.md) + - [SquareConnect.CreateInvoiceRequest](docs/CreateInvoiceRequest.md) + - [SquareConnect.CreateInvoiceResponse](docs/CreateInvoiceResponse.md) + - [SquareConnect.CreateLocationRequest](docs/CreateLocationRequest.md) + - [SquareConnect.CreateLocationResponse](docs/CreateLocationResponse.md) + - [SquareConnect.CreateLoyaltyAccountRequest](docs/CreateLoyaltyAccountRequest.md) + - [SquareConnect.CreateLoyaltyAccountResponse](docs/CreateLoyaltyAccountResponse.md) + - [SquareConnect.CreateLoyaltyRewardRequest](docs/CreateLoyaltyRewardRequest.md) + - [SquareConnect.CreateLoyaltyRewardResponse](docs/CreateLoyaltyRewardResponse.md) + - [SquareConnect.CreateMobileAuthorizationCodeRequest](docs/CreateMobileAuthorizationCodeRequest.md) + - [SquareConnect.CreateMobileAuthorizationCodeResponse](docs/CreateMobileAuthorizationCodeResponse.md) + - [SquareConnect.CreateOrderRequest](docs/CreateOrderRequest.md) + - [SquareConnect.CreateOrderResponse](docs/CreateOrderResponse.md) + - [SquareConnect.CreatePaymentRequest](docs/CreatePaymentRequest.md) + - [SquareConnect.CreatePaymentResponse](docs/CreatePaymentResponse.md) + - [SquareConnect.CreateRefundRequest](docs/CreateRefundRequest.md) + - [SquareConnect.CreateRefundResponse](docs/CreateRefundResponse.md) + - [SquareConnect.CreateShiftRequest](docs/CreateShiftRequest.md) + - [SquareConnect.CreateShiftResponse](docs/CreateShiftResponse.md) + - [SquareConnect.CreateSubscriptionRequest](docs/CreateSubscriptionRequest.md) + - [SquareConnect.CreateSubscriptionResponse](docs/CreateSubscriptionResponse.md) + - [SquareConnect.CreateTeamMemberRequest](docs/CreateTeamMemberRequest.md) + - [SquareConnect.CreateTeamMemberResponse](docs/CreateTeamMemberResponse.md) + - [SquareConnect.CreateTerminalCheckoutRequest](docs/CreateTerminalCheckoutRequest.md) + - [SquareConnect.CreateTerminalCheckoutResponse](docs/CreateTerminalCheckoutResponse.md) + - [SquareConnect.CreateTerminalRefundRequest](docs/CreateTerminalRefundRequest.md) + - [SquareConnect.CreateTerminalRefundResponse](docs/CreateTerminalRefundResponse.md) + - [SquareConnect.Currency](docs/Currency.md) + - [SquareConnect.CustomAttributeFilter](docs/CustomAttributeFilter.md) + - [SquareConnect.Customer](docs/Customer.md) + - [SquareConnect.CustomerCreationSource](docs/CustomerCreationSource.md) + - [SquareConnect.CustomerCreationSourceFilter](docs/CustomerCreationSourceFilter.md) + - [SquareConnect.CustomerFilter](docs/CustomerFilter.md) + - [SquareConnect.CustomerGroup](docs/CustomerGroup.md) + - [SquareConnect.CustomerGroupInfo](docs/CustomerGroupInfo.md) + - [SquareConnect.CustomerInclusionExclusion](docs/CustomerInclusionExclusion.md) + - [SquareConnect.CustomerPreferences](docs/CustomerPreferences.md) + - [SquareConnect.CustomerQuery](docs/CustomerQuery.md) + - [SquareConnect.CustomerSegment](docs/CustomerSegment.md) + - [SquareConnect.CustomerSort](docs/CustomerSort.md) + - [SquareConnect.CustomerSortField](docs/CustomerSortField.md) + - [SquareConnect.CustomerTextFilter](docs/CustomerTextFilter.md) + - [SquareConnect.DateRange](docs/DateRange.md) + - [SquareConnect.DayOfWeek](docs/DayOfWeek.md) + - [SquareConnect.DeleteBreakTypeRequest](docs/DeleteBreakTypeRequest.md) + - [SquareConnect.DeleteBreakTypeResponse](docs/DeleteBreakTypeResponse.md) + - [SquareConnect.DeleteCatalogObjectRequest](docs/DeleteCatalogObjectRequest.md) + - [SquareConnect.DeleteCatalogObjectResponse](docs/DeleteCatalogObjectResponse.md) + - [SquareConnect.DeleteCustomerCardRequest](docs/DeleteCustomerCardRequest.md) + - [SquareConnect.DeleteCustomerCardResponse](docs/DeleteCustomerCardResponse.md) + - [SquareConnect.DeleteCustomerGroupRequest](docs/DeleteCustomerGroupRequest.md) + - [SquareConnect.DeleteCustomerGroupResponse](docs/DeleteCustomerGroupResponse.md) + - [SquareConnect.DeleteCustomerRequest](docs/DeleteCustomerRequest.md) + - [SquareConnect.DeleteCustomerResponse](docs/DeleteCustomerResponse.md) + - [SquareConnect.DeleteInvoiceRequest](docs/DeleteInvoiceRequest.md) + - [SquareConnect.DeleteInvoiceResponse](docs/DeleteInvoiceResponse.md) + - [SquareConnect.DeleteLoyaltyRewardRequest](docs/DeleteLoyaltyRewardRequest.md) + - [SquareConnect.DeleteLoyaltyRewardResponse](docs/DeleteLoyaltyRewardResponse.md) + - [SquareConnect.DeleteShiftRequest](docs/DeleteShiftRequest.md) + - [SquareConnect.DeleteShiftResponse](docs/DeleteShiftResponse.md) + - [SquareConnect.Device](docs/Device.md) + - [SquareConnect.DeviceCheckoutOptions](docs/DeviceCheckoutOptions.md) + - [SquareConnect.DeviceCode](docs/DeviceCode.md) + - [SquareConnect.DeviceCodeStatus](docs/DeviceCodeStatus.md) + - [SquareConnect.DeviceDetails](docs/DeviceDetails.md) + - [SquareConnect.Dispute](docs/Dispute.md) + - [SquareConnect.DisputeEvidence](docs/DisputeEvidence.md) + - [SquareConnect.DisputeEvidenceFile](docs/DisputeEvidenceFile.md) + - [SquareConnect.DisputeEvidenceType](docs/DisputeEvidenceType.md) + - [SquareConnect.DisputeReason](docs/DisputeReason.md) + - [SquareConnect.DisputeState](docs/DisputeState.md) + - [SquareConnect.DisputedPayment](docs/DisputedPayment.md) + - [SquareConnect.EcomVisibility](docs/EcomVisibility.md) + - [SquareConnect.Employee](docs/Employee.md) + - [SquareConnect.EmployeeStatus](docs/EmployeeStatus.md) + - [SquareConnect.EmployeeWage](docs/EmployeeWage.md) + - [SquareConnect.Error](docs/Error.md) + - [SquareConnect.ErrorCategory](docs/ErrorCategory.md) + - [SquareConnect.ErrorCode](docs/ErrorCode.md) + - [SquareConnect.ExcludeStrategy](docs/ExcludeStrategy.md) + - [SquareConnect.FilterValue](docs/FilterValue.md) + - [SquareConnect.GetBankAccountByV1IdRequest](docs/GetBankAccountByV1IdRequest.md) + - [SquareConnect.GetBankAccountByV1IdResponse](docs/GetBankAccountByV1IdResponse.md) + - [SquareConnect.GetBankAccountRequest](docs/GetBankAccountRequest.md) + - [SquareConnect.GetBankAccountResponse](docs/GetBankAccountResponse.md) + - [SquareConnect.GetBreakTypeRequest](docs/GetBreakTypeRequest.md) + - [SquareConnect.GetBreakTypeResponse](docs/GetBreakTypeResponse.md) + - [SquareConnect.GetDeviceCodeRequest](docs/GetDeviceCodeRequest.md) + - [SquareConnect.GetDeviceCodeResponse](docs/GetDeviceCodeResponse.md) + - [SquareConnect.GetEmployeeWageRequest](docs/GetEmployeeWageRequest.md) + - [SquareConnect.GetEmployeeWageResponse](docs/GetEmployeeWageResponse.md) + - [SquareConnect.GetInvoiceRequest](docs/GetInvoiceRequest.md) + - [SquareConnect.GetInvoiceResponse](docs/GetInvoiceResponse.md) + - [SquareConnect.GetPaymentRefundRequest](docs/GetPaymentRefundRequest.md) + - [SquareConnect.GetPaymentRefundResponse](docs/GetPaymentRefundResponse.md) + - [SquareConnect.GetPaymentRequest](docs/GetPaymentRequest.md) + - [SquareConnect.GetPaymentResponse](docs/GetPaymentResponse.md) + - [SquareConnect.GetShiftRequest](docs/GetShiftRequest.md) + - [SquareConnect.GetShiftResponse](docs/GetShiftResponse.md) + - [SquareConnect.GetTeamMemberWageRequest](docs/GetTeamMemberWageRequest.md) + - [SquareConnect.GetTeamMemberWageResponse](docs/GetTeamMemberWageResponse.md) + - [SquareConnect.GetTerminalCheckoutRequest](docs/GetTerminalCheckoutRequest.md) + - [SquareConnect.GetTerminalCheckoutResponse](docs/GetTerminalCheckoutResponse.md) + - [SquareConnect.GetTerminalRefundRequest](docs/GetTerminalRefundRequest.md) + - [SquareConnect.GetTerminalRefundResponse](docs/GetTerminalRefundResponse.md) + - [SquareConnect.InlineTypes](docs/InlineTypes.md) + - [SquareConnect.InventoryAdjustment](docs/InventoryAdjustment.md) + - [SquareConnect.InventoryAlertType](docs/InventoryAlertType.md) + - [SquareConnect.InventoryChange](docs/InventoryChange.md) + - [SquareConnect.InventoryChangeType](docs/InventoryChangeType.md) + - [SquareConnect.InventoryCount](docs/InventoryCount.md) + - [SquareConnect.InventoryPhysicalCount](docs/InventoryPhysicalCount.md) + - [SquareConnect.InventoryState](docs/InventoryState.md) + - [SquareConnect.InventoryTransfer](docs/InventoryTransfer.md) + - [SquareConnect.Invoice](docs/Invoice.md) + - [SquareConnect.InvoiceFilter](docs/InvoiceFilter.md) + - [SquareConnect.InvoicePaymentReminder](docs/InvoicePaymentReminder.md) + - [SquareConnect.InvoicePaymentReminderStatus](docs/InvoicePaymentReminderStatus.md) + - [SquareConnect.InvoicePaymentRequest](docs/InvoicePaymentRequest.md) + - [SquareConnect.InvoiceQuery](docs/InvoiceQuery.md) + - [SquareConnect.InvoiceRecipient](docs/InvoiceRecipient.md) + - [SquareConnect.InvoiceRequestMethod](docs/InvoiceRequestMethod.md) + - [SquareConnect.InvoiceRequestType](docs/InvoiceRequestType.md) + - [SquareConnect.InvoiceSort](docs/InvoiceSort.md) + - [SquareConnect.InvoiceSortField](docs/InvoiceSortField.md) + - [SquareConnect.InvoiceStatus](docs/InvoiceStatus.md) + - [SquareConnect.ItemVariationLocationOverrides](docs/ItemVariationLocationOverrides.md) + - [SquareConnect.JobAssignment](docs/JobAssignment.md) + - [SquareConnect.JobAssignmentPayType](docs/JobAssignmentPayType.md) + - [SquareConnect.ListBankAccountsRequest](docs/ListBankAccountsRequest.md) + - [SquareConnect.ListBankAccountsResponse](docs/ListBankAccountsResponse.md) + - [SquareConnect.ListBreakTypesRequest](docs/ListBreakTypesRequest.md) + - [SquareConnect.ListBreakTypesResponse](docs/ListBreakTypesResponse.md) + - [SquareConnect.ListCashDrawerShiftEventsRequest](docs/ListCashDrawerShiftEventsRequest.md) + - [SquareConnect.ListCashDrawerShiftEventsResponse](docs/ListCashDrawerShiftEventsResponse.md) + - [SquareConnect.ListCashDrawerShiftsRequest](docs/ListCashDrawerShiftsRequest.md) + - [SquareConnect.ListCashDrawerShiftsResponse](docs/ListCashDrawerShiftsResponse.md) + - [SquareConnect.ListCatalogRequest](docs/ListCatalogRequest.md) + - [SquareConnect.ListCatalogResponse](docs/ListCatalogResponse.md) + - [SquareConnect.ListCustomerGroupsRequest](docs/ListCustomerGroupsRequest.md) + - [SquareConnect.ListCustomerGroupsResponse](docs/ListCustomerGroupsResponse.md) + - [SquareConnect.ListCustomerSegmentsRequest](docs/ListCustomerSegmentsRequest.md) + - [SquareConnect.ListCustomerSegmentsResponse](docs/ListCustomerSegmentsResponse.md) + - [SquareConnect.ListCustomersRequest](docs/ListCustomersRequest.md) + - [SquareConnect.ListCustomersResponse](docs/ListCustomersResponse.md) + - [SquareConnect.ListDeviceCodesRequest](docs/ListDeviceCodesRequest.md) + - [SquareConnect.ListDeviceCodesResponse](docs/ListDeviceCodesResponse.md) + - [SquareConnect.ListDisputeEvidenceRequest](docs/ListDisputeEvidenceRequest.md) + - [SquareConnect.ListDisputeEvidenceResponse](docs/ListDisputeEvidenceResponse.md) + - [SquareConnect.ListDisputesRequest](docs/ListDisputesRequest.md) + - [SquareConnect.ListDisputesResponse](docs/ListDisputesResponse.md) + - [SquareConnect.ListEmployeeWagesRequest](docs/ListEmployeeWagesRequest.md) + - [SquareConnect.ListEmployeeWagesResponse](docs/ListEmployeeWagesResponse.md) + - [SquareConnect.ListEmployeesRequest](docs/ListEmployeesRequest.md) + - [SquareConnect.ListEmployeesResponse](docs/ListEmployeesResponse.md) + - [SquareConnect.ListInvoicesRequest](docs/ListInvoicesRequest.md) + - [SquareConnect.ListInvoicesResponse](docs/ListInvoicesResponse.md) + - [SquareConnect.ListLocationsRequest](docs/ListLocationsRequest.md) + - [SquareConnect.ListLocationsResponse](docs/ListLocationsResponse.md) + - [SquareConnect.ListLoyaltyProgramsRequest](docs/ListLoyaltyProgramsRequest.md) + - [SquareConnect.ListLoyaltyProgramsResponse](docs/ListLoyaltyProgramsResponse.md) + - [SquareConnect.ListMerchantsRequest](docs/ListMerchantsRequest.md) + - [SquareConnect.ListMerchantsResponse](docs/ListMerchantsResponse.md) + - [SquareConnect.ListPaymentRefundsRequest](docs/ListPaymentRefundsRequest.md) + - [SquareConnect.ListPaymentRefundsResponse](docs/ListPaymentRefundsResponse.md) + - [SquareConnect.ListPaymentsRequest](docs/ListPaymentsRequest.md) + - [SquareConnect.ListPaymentsResponse](docs/ListPaymentsResponse.md) + - [SquareConnect.ListRefundsRequest](docs/ListRefundsRequest.md) + - [SquareConnect.ListRefundsResponse](docs/ListRefundsResponse.md) + - [SquareConnect.ListSubscriptionEventsRequest](docs/ListSubscriptionEventsRequest.md) + - [SquareConnect.ListSubscriptionEventsResponse](docs/ListSubscriptionEventsResponse.md) + - [SquareConnect.ListTeamMemberBookingProfilesRequest](docs/ListTeamMemberBookingProfilesRequest.md) + - [SquareConnect.ListTeamMemberBookingProfilesResponse](docs/ListTeamMemberBookingProfilesResponse.md) + - [SquareConnect.ListTeamMemberWagesRequest](docs/ListTeamMemberWagesRequest.md) + - [SquareConnect.ListTeamMemberWagesResponse](docs/ListTeamMemberWagesResponse.md) + - [SquareConnect.ListTransactionsRequest](docs/ListTransactionsRequest.md) + - [SquareConnect.ListTransactionsResponse](docs/ListTransactionsResponse.md) + - [SquareConnect.ListWorkweekConfigsRequest](docs/ListWorkweekConfigsRequest.md) + - [SquareConnect.ListWorkweekConfigsResponse](docs/ListWorkweekConfigsResponse.md) + - [SquareConnect.Location](docs/Location.md) + - [SquareConnect.LocationCapability](docs/LocationCapability.md) + - [SquareConnect.LocationStatus](docs/LocationStatus.md) + - [SquareConnect.LocationType](docs/LocationType.md) + - [SquareConnect.LoyaltyAccount](docs/LoyaltyAccount.md) + - [SquareConnect.LoyaltyAccountMapping](docs/LoyaltyAccountMapping.md) + - [SquareConnect.LoyaltyAccountMappingType](docs/LoyaltyAccountMappingType.md) + - [SquareConnect.LoyaltyEvent](docs/LoyaltyEvent.md) + - [SquareConnect.LoyaltyEventAccumulatePoints](docs/LoyaltyEventAccumulatePoints.md) + - [SquareConnect.LoyaltyEventAdjustPoints](docs/LoyaltyEventAdjustPoints.md) + - [SquareConnect.LoyaltyEventCreateReward](docs/LoyaltyEventCreateReward.md) + - [SquareConnect.LoyaltyEventDateTimeFilter](docs/LoyaltyEventDateTimeFilter.md) + - [SquareConnect.LoyaltyEventDeleteReward](docs/LoyaltyEventDeleteReward.md) + - [SquareConnect.LoyaltyEventExpirePoints](docs/LoyaltyEventExpirePoints.md) + - [SquareConnect.LoyaltyEventFilter](docs/LoyaltyEventFilter.md) + - [SquareConnect.LoyaltyEventLocationFilter](docs/LoyaltyEventLocationFilter.md) + - [SquareConnect.LoyaltyEventLoyaltyAccountFilter](docs/LoyaltyEventLoyaltyAccountFilter.md) + - [SquareConnect.LoyaltyEventOrderFilter](docs/LoyaltyEventOrderFilter.md) + - [SquareConnect.LoyaltyEventOther](docs/LoyaltyEventOther.md) + - [SquareConnect.LoyaltyEventQuery](docs/LoyaltyEventQuery.md) + - [SquareConnect.LoyaltyEventRedeemReward](docs/LoyaltyEventRedeemReward.md) + - [SquareConnect.LoyaltyEventSource](docs/LoyaltyEventSource.md) + - [SquareConnect.LoyaltyEventType](docs/LoyaltyEventType.md) + - [SquareConnect.LoyaltyEventTypeFilter](docs/LoyaltyEventTypeFilter.md) + - [SquareConnect.LoyaltyProgram](docs/LoyaltyProgram.md) + - [SquareConnect.LoyaltyProgramAccrualRule](docs/LoyaltyProgramAccrualRule.md) + - [SquareConnect.LoyaltyProgramAccrualRuleType](docs/LoyaltyProgramAccrualRuleType.md) + - [SquareConnect.LoyaltyProgramExpirationPolicy](docs/LoyaltyProgramExpirationPolicy.md) + - [SquareConnect.LoyaltyProgramRewardDefinition](docs/LoyaltyProgramRewardDefinition.md) + - [SquareConnect.LoyaltyProgramRewardDefinitionScope](docs/LoyaltyProgramRewardDefinitionScope.md) + - [SquareConnect.LoyaltyProgramRewardDefinitionType](docs/LoyaltyProgramRewardDefinitionType.md) + - [SquareConnect.LoyaltyProgramRewardTier](docs/LoyaltyProgramRewardTier.md) + - [SquareConnect.LoyaltyProgramStatus](docs/LoyaltyProgramStatus.md) + - [SquareConnect.LoyaltyProgramTerminology](docs/LoyaltyProgramTerminology.md) + - [SquareConnect.LoyaltyReward](docs/LoyaltyReward.md) + - [SquareConnect.LoyaltyRewardStatus](docs/LoyaltyRewardStatus.md) + - [SquareConnect.MeasurementUnit](docs/MeasurementUnit.md) + - [SquareConnect.MeasurementUnitArea](docs/MeasurementUnitArea.md) + - [SquareConnect.MeasurementUnitCustom](docs/MeasurementUnitCustom.md) + - [SquareConnect.MeasurementUnitGeneric](docs/MeasurementUnitGeneric.md) + - [SquareConnect.MeasurementUnitLength](docs/MeasurementUnitLength.md) + - [SquareConnect.MeasurementUnitTime](docs/MeasurementUnitTime.md) + - [SquareConnect.MeasurementUnitUnitType](docs/MeasurementUnitUnitType.md) + - [SquareConnect.MeasurementUnitVolume](docs/MeasurementUnitVolume.md) + - [SquareConnect.MeasurementUnitWeight](docs/MeasurementUnitWeight.md) + - [SquareConnect.Merchant](docs/Merchant.md) + - [SquareConnect.MerchantStatus](docs/MerchantStatus.md) + - [SquareConnect.ModelBreak](docs/ModelBreak.md) + - [SquareConnect.Money](docs/Money.md) + - [SquareConnect.ObtainTokenRequest](docs/ObtainTokenRequest.md) + - [SquareConnect.ObtainTokenResponse](docs/ObtainTokenResponse.md) + - [SquareConnect.OnboardAppointmentsRequest](docs/OnboardAppointmentsRequest.md) + - [SquareConnect.OnboardAppointmentsResponse](docs/OnboardAppointmentsResponse.md) + - [SquareConnect.Order](docs/Order.md) + - [SquareConnect.OrderCreated](docs/OrderCreated.md) + - [SquareConnect.OrderCreatedObject](docs/OrderCreatedObject.md) + - [SquareConnect.OrderEntry](docs/OrderEntry.md) + - [SquareConnect.OrderFulfillment](docs/OrderFulfillment.md) + - [SquareConnect.OrderFulfillmentPickupDetails](docs/OrderFulfillmentPickupDetails.md) + - [SquareConnect.OrderFulfillmentPickupDetailsCurbsidePickupDetails](docs/OrderFulfillmentPickupDetailsCurbsidePickupDetails.md) + - [SquareConnect.OrderFulfillmentPickupDetailsScheduleType](docs/OrderFulfillmentPickupDetailsScheduleType.md) + - [SquareConnect.OrderFulfillmentRecipient](docs/OrderFulfillmentRecipient.md) + - [SquareConnect.OrderFulfillmentShipmentDetails](docs/OrderFulfillmentShipmentDetails.md) + - [SquareConnect.OrderFulfillmentState](docs/OrderFulfillmentState.md) + - [SquareConnect.OrderFulfillmentType](docs/OrderFulfillmentType.md) + - [SquareConnect.OrderFulfillmentUpdated](docs/OrderFulfillmentUpdated.md) + - [SquareConnect.OrderFulfillmentUpdatedObject](docs/OrderFulfillmentUpdatedObject.md) + - [SquareConnect.OrderFulfillmentUpdatedUpdate](docs/OrderFulfillmentUpdatedUpdate.md) + - [SquareConnect.OrderLineItem](docs/OrderLineItem.md) + - [SquareConnect.OrderLineItemAppliedDiscount](docs/OrderLineItemAppliedDiscount.md) + - [SquareConnect.OrderLineItemAppliedTax](docs/OrderLineItemAppliedTax.md) + - [SquareConnect.OrderLineItemDiscount](docs/OrderLineItemDiscount.md) + - [SquareConnect.OrderLineItemDiscountScope](docs/OrderLineItemDiscountScope.md) + - [SquareConnect.OrderLineItemDiscountType](docs/OrderLineItemDiscountType.md) + - [SquareConnect.OrderLineItemModifier](docs/OrderLineItemModifier.md) + - [SquareConnect.OrderLineItemTax](docs/OrderLineItemTax.md) + - [SquareConnect.OrderLineItemTaxScope](docs/OrderLineItemTaxScope.md) + - [SquareConnect.OrderLineItemTaxType](docs/OrderLineItemTaxType.md) + - [SquareConnect.OrderMoneyAmounts](docs/OrderMoneyAmounts.md) + - [SquareConnect.OrderPricingOptions](docs/OrderPricingOptions.md) + - [SquareConnect.OrderQuantityUnit](docs/OrderQuantityUnit.md) + - [SquareConnect.OrderReturn](docs/OrderReturn.md) + - [SquareConnect.OrderReturnDiscount](docs/OrderReturnDiscount.md) + - [SquareConnect.OrderReturnLineItem](docs/OrderReturnLineItem.md) + - [SquareConnect.OrderReturnLineItemModifier](docs/OrderReturnLineItemModifier.md) + - [SquareConnect.OrderReturnServiceCharge](docs/OrderReturnServiceCharge.md) + - [SquareConnect.OrderReturnTax](docs/OrderReturnTax.md) + - [SquareConnect.OrderReward](docs/OrderReward.md) + - [SquareConnect.OrderRoundingAdjustment](docs/OrderRoundingAdjustment.md) + - [SquareConnect.OrderServiceCharge](docs/OrderServiceCharge.md) + - [SquareConnect.OrderServiceChargeCalculationPhase](docs/OrderServiceChargeCalculationPhase.md) + - [SquareConnect.OrderSource](docs/OrderSource.md) + - [SquareConnect.OrderState](docs/OrderState.md) + - [SquareConnect.OrderUpdated](docs/OrderUpdated.md) + - [SquareConnect.OrderUpdatedObject](docs/OrderUpdatedObject.md) + - [SquareConnect.PayOrderRequest](docs/PayOrderRequest.md) + - [SquareConnect.PayOrderResponse](docs/PayOrderResponse.md) + - [SquareConnect.Payment](docs/Payment.md) + - [SquareConnect.PaymentOptions](docs/PaymentOptions.md) + - [SquareConnect.PaymentRefund](docs/PaymentRefund.md) + - [SquareConnect.ProcessingFee](docs/ProcessingFee.md) + - [SquareConnect.Product](docs/Product.md) + - [SquareConnect.ProductType](docs/ProductType.md) + - [SquareConnect.PublishInvoiceRequest](docs/PublishInvoiceRequest.md) + - [SquareConnect.PublishInvoiceResponse](docs/PublishInvoiceResponse.md) + - [SquareConnect.Range](docs/Range.md) + - [SquareConnect.RedeemLoyaltyRewardRequest](docs/RedeemLoyaltyRewardRequest.md) + - [SquareConnect.RedeemLoyaltyRewardResponse](docs/RedeemLoyaltyRewardResponse.md) + - [SquareConnect.Refund](docs/Refund.md) + - [SquareConnect.RefundPaymentRequest](docs/RefundPaymentRequest.md) + - [SquareConnect.RefundPaymentResponse](docs/RefundPaymentResponse.md) + - [SquareConnect.RefundStatus](docs/RefundStatus.md) + - [SquareConnect.RegisterDomainRequest](docs/RegisterDomainRequest.md) + - [SquareConnect.RegisterDomainResponse](docs/RegisterDomainResponse.md) + - [SquareConnect.RegisterDomainResponseStatus](docs/RegisterDomainResponseStatus.md) + - [SquareConnect.RemoveDisputeEvidenceRequest](docs/RemoveDisputeEvidenceRequest.md) + - [SquareConnect.RemoveDisputeEvidenceResponse](docs/RemoveDisputeEvidenceResponse.md) + - [SquareConnect.RemoveGroupFromCustomerRequest](docs/RemoveGroupFromCustomerRequest.md) + - [SquareConnect.RemoveGroupFromCustomerResponse](docs/RemoveGroupFromCustomerResponse.md) + - [SquareConnect.RenewTokenRequest](docs/RenewTokenRequest.md) + - [SquareConnect.RenewTokenResponse](docs/RenewTokenResponse.md) + - [SquareConnect.RetrieveBookingRequest](docs/RetrieveBookingRequest.md) + - [SquareConnect.RetrieveBookingResponse](docs/RetrieveBookingResponse.md) + - [SquareConnect.RetrieveBusinessBookingProfileRequest](docs/RetrieveBusinessBookingProfileRequest.md) + - [SquareConnect.RetrieveBusinessBookingProfileResponse](docs/RetrieveBusinessBookingProfileResponse.md) + - [SquareConnect.RetrieveCashDrawerShiftRequest](docs/RetrieveCashDrawerShiftRequest.md) + - [SquareConnect.RetrieveCashDrawerShiftResponse](docs/RetrieveCashDrawerShiftResponse.md) + - [SquareConnect.RetrieveCatalogObjectRequest](docs/RetrieveCatalogObjectRequest.md) + - [SquareConnect.RetrieveCatalogObjectResponse](docs/RetrieveCatalogObjectResponse.md) + - [SquareConnect.RetrieveCustomerGroupRequest](docs/RetrieveCustomerGroupRequest.md) + - [SquareConnect.RetrieveCustomerGroupResponse](docs/RetrieveCustomerGroupResponse.md) + - [SquareConnect.RetrieveCustomerRequest](docs/RetrieveCustomerRequest.md) + - [SquareConnect.RetrieveCustomerResponse](docs/RetrieveCustomerResponse.md) + - [SquareConnect.RetrieveCustomerSegmentRequest](docs/RetrieveCustomerSegmentRequest.md) + - [SquareConnect.RetrieveCustomerSegmentResponse](docs/RetrieveCustomerSegmentResponse.md) + - [SquareConnect.RetrieveDisputeEvidenceRequest](docs/RetrieveDisputeEvidenceRequest.md) + - [SquareConnect.RetrieveDisputeEvidenceResponse](docs/RetrieveDisputeEvidenceResponse.md) + - [SquareConnect.RetrieveDisputeRequest](docs/RetrieveDisputeRequest.md) + - [SquareConnect.RetrieveDisputeResponse](docs/RetrieveDisputeResponse.md) + - [SquareConnect.RetrieveEmployeeRequest](docs/RetrieveEmployeeRequest.md) + - [SquareConnect.RetrieveEmployeeResponse](docs/RetrieveEmployeeResponse.md) + - [SquareConnect.RetrieveInventoryAdjustmentRequest](docs/RetrieveInventoryAdjustmentRequest.md) + - [SquareConnect.RetrieveInventoryAdjustmentResponse](docs/RetrieveInventoryAdjustmentResponse.md) + - [SquareConnect.RetrieveInventoryChangesRequest](docs/RetrieveInventoryChangesRequest.md) + - [SquareConnect.RetrieveInventoryChangesResponse](docs/RetrieveInventoryChangesResponse.md) + - [SquareConnect.RetrieveInventoryCountRequest](docs/RetrieveInventoryCountRequest.md) + - [SquareConnect.RetrieveInventoryCountResponse](docs/RetrieveInventoryCountResponse.md) + - [SquareConnect.RetrieveInventoryPhysicalCountRequest](docs/RetrieveInventoryPhysicalCountRequest.md) + - [SquareConnect.RetrieveInventoryPhysicalCountResponse](docs/RetrieveInventoryPhysicalCountResponse.md) + - [SquareConnect.RetrieveLocationRequest](docs/RetrieveLocationRequest.md) + - [SquareConnect.RetrieveLocationResponse](docs/RetrieveLocationResponse.md) + - [SquareConnect.RetrieveLoyaltyAccountRequest](docs/RetrieveLoyaltyAccountRequest.md) + - [SquareConnect.RetrieveLoyaltyAccountResponse](docs/RetrieveLoyaltyAccountResponse.md) + - [SquareConnect.RetrieveLoyaltyRewardRequest](docs/RetrieveLoyaltyRewardRequest.md) + - [SquareConnect.RetrieveLoyaltyRewardResponse](docs/RetrieveLoyaltyRewardResponse.md) + - [SquareConnect.RetrieveMerchantRequest](docs/RetrieveMerchantRequest.md) + - [SquareConnect.RetrieveMerchantResponse](docs/RetrieveMerchantResponse.md) + - [SquareConnect.RetrieveObsMigrationProfileRequest](docs/RetrieveObsMigrationProfileRequest.md) + - [SquareConnect.RetrieveObsMigrationProfileResponse](docs/RetrieveObsMigrationProfileResponse.md) + - [SquareConnect.RetrieveOrderRequest](docs/RetrieveOrderRequest.md) + - [SquareConnect.RetrieveOrderResponse](docs/RetrieveOrderResponse.md) + - [SquareConnect.RetrieveSubscriptionRequest](docs/RetrieveSubscriptionRequest.md) + - [SquareConnect.RetrieveSubscriptionResponse](docs/RetrieveSubscriptionResponse.md) + - [SquareConnect.RetrieveTeamMemberBookingProfileRequest](docs/RetrieveTeamMemberBookingProfileRequest.md) + - [SquareConnect.RetrieveTeamMemberBookingProfileResponse](docs/RetrieveTeamMemberBookingProfileResponse.md) + - [SquareConnect.RetrieveTeamMemberRequest](docs/RetrieveTeamMemberRequest.md) + - [SquareConnect.RetrieveTeamMemberResponse](docs/RetrieveTeamMemberResponse.md) + - [SquareConnect.RetrieveTransactionRequest](docs/RetrieveTransactionRequest.md) + - [SquareConnect.RetrieveTransactionResponse](docs/RetrieveTransactionResponse.md) + - [SquareConnect.RetrieveWageSettingRequest](docs/RetrieveWageSettingRequest.md) + - [SquareConnect.RetrieveWageSettingResponse](docs/RetrieveWageSettingResponse.md) + - [SquareConnect.RevokeTokenRequest](docs/RevokeTokenRequest.md) + - [SquareConnect.RevokeTokenResponse](docs/RevokeTokenResponse.md) + - [SquareConnect.RiskEvaluation](docs/RiskEvaluation.md) + - [SquareConnect.RiskEvaluationRiskLevel](docs/RiskEvaluationRiskLevel.md) + - [SquareConnect.SearchAvailabilityFilter](docs/SearchAvailabilityFilter.md) + - [SquareConnect.SearchAvailabilityQuery](docs/SearchAvailabilityQuery.md) + - [SquareConnect.SearchAvailabilityRequest](docs/SearchAvailabilityRequest.md) + - [SquareConnect.SearchAvailabilityResponse](docs/SearchAvailabilityResponse.md) + - [SquareConnect.SearchCatalogItemsRequest](docs/SearchCatalogItemsRequest.md) + - [SquareConnect.SearchCatalogItemsRequestStockLevel](docs/SearchCatalogItemsRequestStockLevel.md) + - [SquareConnect.SearchCatalogItemsResponse](docs/SearchCatalogItemsResponse.md) + - [SquareConnect.SearchCatalogObjectsRequest](docs/SearchCatalogObjectsRequest.md) + - [SquareConnect.SearchCatalogObjectsResponse](docs/SearchCatalogObjectsResponse.md) + - [SquareConnect.SearchCustomersRequest](docs/SearchCustomersRequest.md) + - [SquareConnect.SearchCustomersResponse](docs/SearchCustomersResponse.md) + - [SquareConnect.SearchInvoicesRequest](docs/SearchInvoicesRequest.md) + - [SquareConnect.SearchInvoicesResponse](docs/SearchInvoicesResponse.md) + - [SquareConnect.SearchLoyaltyAccountsRequest](docs/SearchLoyaltyAccountsRequest.md) + - [SquareConnect.SearchLoyaltyAccountsRequestLoyaltyAccountQuery](docs/SearchLoyaltyAccountsRequestLoyaltyAccountQuery.md) + - [SquareConnect.SearchLoyaltyAccountsResponse](docs/SearchLoyaltyAccountsResponse.md) + - [SquareConnect.SearchLoyaltyEventsRequest](docs/SearchLoyaltyEventsRequest.md) + - [SquareConnect.SearchLoyaltyEventsResponse](docs/SearchLoyaltyEventsResponse.md) + - [SquareConnect.SearchLoyaltyRewardsRequest](docs/SearchLoyaltyRewardsRequest.md) + - [SquareConnect.SearchLoyaltyRewardsRequestLoyaltyRewardQuery](docs/SearchLoyaltyRewardsRequestLoyaltyRewardQuery.md) + - [SquareConnect.SearchLoyaltyRewardsResponse](docs/SearchLoyaltyRewardsResponse.md) + - [SquareConnect.SearchOrdersCustomerFilter](docs/SearchOrdersCustomerFilter.md) + - [SquareConnect.SearchOrdersDateTimeFilter](docs/SearchOrdersDateTimeFilter.md) + - [SquareConnect.SearchOrdersFilter](docs/SearchOrdersFilter.md) + - [SquareConnect.SearchOrdersFulfillmentFilter](docs/SearchOrdersFulfillmentFilter.md) + - [SquareConnect.SearchOrdersQuery](docs/SearchOrdersQuery.md) + - [SquareConnect.SearchOrdersRequest](docs/SearchOrdersRequest.md) + - [SquareConnect.SearchOrdersResponse](docs/SearchOrdersResponse.md) + - [SquareConnect.SearchOrdersSort](docs/SearchOrdersSort.md) + - [SquareConnect.SearchOrdersSortField](docs/SearchOrdersSortField.md) + - [SquareConnect.SearchOrdersSourceFilter](docs/SearchOrdersSourceFilter.md) + - [SquareConnect.SearchOrdersStateFilter](docs/SearchOrdersStateFilter.md) + - [SquareConnect.SearchShiftsRequest](docs/SearchShiftsRequest.md) + - [SquareConnect.SearchShiftsResponse](docs/SearchShiftsResponse.md) + - [SquareConnect.SearchSubscriptionsFilter](docs/SearchSubscriptionsFilter.md) + - [SquareConnect.SearchSubscriptionsQuery](docs/SearchSubscriptionsQuery.md) + - [SquareConnect.SearchSubscriptionsRequest](docs/SearchSubscriptionsRequest.md) + - [SquareConnect.SearchSubscriptionsResponse](docs/SearchSubscriptionsResponse.md) + - [SquareConnect.SearchTeamMembersFilter](docs/SearchTeamMembersFilter.md) + - [SquareConnect.SearchTeamMembersQuery](docs/SearchTeamMembersQuery.md) + - [SquareConnect.SearchTeamMembersRequest](docs/SearchTeamMembersRequest.md) + - [SquareConnect.SearchTeamMembersResponse](docs/SearchTeamMembersResponse.md) + - [SquareConnect.SearchTerminalCheckoutsRequest](docs/SearchTerminalCheckoutsRequest.md) + - [SquareConnect.SearchTerminalCheckoutsResponse](docs/SearchTerminalCheckoutsResponse.md) + - [SquareConnect.SearchTerminalRefundsRequest](docs/SearchTerminalRefundsRequest.md) + - [SquareConnect.SearchTerminalRefundsResponse](docs/SearchTerminalRefundsResponse.md) + - [SquareConnect.SegmentFilter](docs/SegmentFilter.md) + - [SquareConnect.Shift](docs/Shift.md) + - [SquareConnect.ShiftFilter](docs/ShiftFilter.md) + - [SquareConnect.ShiftFilterStatus](docs/ShiftFilterStatus.md) + - [SquareConnect.ShiftQuery](docs/ShiftQuery.md) + - [SquareConnect.ShiftSort](docs/ShiftSort.md) + - [SquareConnect.ShiftSortField](docs/ShiftSortField.md) + - [SquareConnect.ShiftStatus](docs/ShiftStatus.md) + - [SquareConnect.ShiftWage](docs/ShiftWage.md) + - [SquareConnect.ShiftWorkday](docs/ShiftWorkday.md) + - [SquareConnect.ShiftWorkdayMatcher](docs/ShiftWorkdayMatcher.md) + - [SquareConnect.SortOrder](docs/SortOrder.md) + - [SquareConnect.SourceApplication](docs/SourceApplication.md) + - [SquareConnect.StandardUnitDescription](docs/StandardUnitDescription.md) + - [SquareConnect.StandardUnitDescriptionGroup](docs/StandardUnitDescriptionGroup.md) + - [SquareConnect.SubmitEvidenceRequest](docs/SubmitEvidenceRequest.md) + - [SquareConnect.SubmitEvidenceResponse](docs/SubmitEvidenceResponse.md) + - [SquareConnect.Subscription](docs/Subscription.md) + - [SquareConnect.SubscriptionCadence](docs/SubscriptionCadence.md) + - [SquareConnect.SubscriptionEvent](docs/SubscriptionEvent.md) + - [SquareConnect.SubscriptionEventSubscriptionEventType](docs/SubscriptionEventSubscriptionEventType.md) + - [SquareConnect.SubscriptionPhase](docs/SubscriptionPhase.md) + - [SquareConnect.SubscriptionStatus](docs/SubscriptionStatus.md) + - [SquareConnect.TaxCalculationPhase](docs/TaxCalculationPhase.md) + - [SquareConnect.TaxInclusionType](docs/TaxInclusionType.md) + - [SquareConnect.TeamMember](docs/TeamMember.md) + - [SquareConnect.TeamMemberAssignedLocations](docs/TeamMemberAssignedLocations.md) + - [SquareConnect.TeamMemberAssignedLocationsAssignmentType](docs/TeamMemberAssignedLocationsAssignmentType.md) + - [SquareConnect.TeamMemberBookingProfile](docs/TeamMemberBookingProfile.md) + - [SquareConnect.TeamMemberStatus](docs/TeamMemberStatus.md) + - [SquareConnect.TeamMemberWage](docs/TeamMemberWage.md) + - [SquareConnect.Tender](docs/Tender.md) + - [SquareConnect.TenderCardDetails](docs/TenderCardDetails.md) + - [SquareConnect.TenderCardDetailsEntryMethod](docs/TenderCardDetailsEntryMethod.md) + - [SquareConnect.TenderCardDetailsStatus](docs/TenderCardDetailsStatus.md) + - [SquareConnect.TenderCashDetails](docs/TenderCashDetails.md) + - [SquareConnect.TenderType](docs/TenderType.md) + - [SquareConnect.TerminalCheckout](docs/TerminalCheckout.md) + - [SquareConnect.TerminalCheckoutQuery](docs/TerminalCheckoutQuery.md) + - [SquareConnect.TerminalCheckoutQueryFilter](docs/TerminalCheckoutQueryFilter.md) + - [SquareConnect.TerminalCheckoutQuerySort](docs/TerminalCheckoutQuerySort.md) + - [SquareConnect.TerminalRefund](docs/TerminalRefund.md) + - [SquareConnect.TerminalRefundQuery](docs/TerminalRefundQuery.md) + - [SquareConnect.TerminalRefundQueryFilter](docs/TerminalRefundQueryFilter.md) + - [SquareConnect.TerminalRefundQuerySort](docs/TerminalRefundQuerySort.md) + - [SquareConnect.TimeRange](docs/TimeRange.md) + - [SquareConnect.TipSettings](docs/TipSettings.md) + - [SquareConnect.Transaction](docs/Transaction.md) + - [SquareConnect.TransactionProduct](docs/TransactionProduct.md) + - [SquareConnect.TransactionType](docs/TransactionType.md) + - [SquareConnect.UpdateBookingRequest](docs/UpdateBookingRequest.md) + - [SquareConnect.UpdateBookingResponse](docs/UpdateBookingResponse.md) + - [SquareConnect.UpdateBreakTypeRequest](docs/UpdateBreakTypeRequest.md) + - [SquareConnect.UpdateBreakTypeResponse](docs/UpdateBreakTypeResponse.md) + - [SquareConnect.UpdateCustomerGroupRequest](docs/UpdateCustomerGroupRequest.md) + - [SquareConnect.UpdateCustomerGroupResponse](docs/UpdateCustomerGroupResponse.md) + - [SquareConnect.UpdateCustomerRequest](docs/UpdateCustomerRequest.md) + - [SquareConnect.UpdateCustomerResponse](docs/UpdateCustomerResponse.md) + - [SquareConnect.UpdateInvoiceRequest](docs/UpdateInvoiceRequest.md) + - [SquareConnect.UpdateInvoiceResponse](docs/UpdateInvoiceResponse.md) + - [SquareConnect.UpdateItemModifierListsRequest](docs/UpdateItemModifierListsRequest.md) + - [SquareConnect.UpdateItemModifierListsResponse](docs/UpdateItemModifierListsResponse.md) + - [SquareConnect.UpdateItemTaxesRequest](docs/UpdateItemTaxesRequest.md) + - [SquareConnect.UpdateItemTaxesResponse](docs/UpdateItemTaxesResponse.md) + - [SquareConnect.UpdateLocationRequest](docs/UpdateLocationRequest.md) + - [SquareConnect.UpdateLocationResponse](docs/UpdateLocationResponse.md) + - [SquareConnect.UpdateOrderRequest](docs/UpdateOrderRequest.md) + - [SquareConnect.UpdateOrderResponse](docs/UpdateOrderResponse.md) + - [SquareConnect.UpdateShiftRequest](docs/UpdateShiftRequest.md) + - [SquareConnect.UpdateShiftResponse](docs/UpdateShiftResponse.md) + - [SquareConnect.UpdateSubscriptionRequest](docs/UpdateSubscriptionRequest.md) + - [SquareConnect.UpdateSubscriptionResponse](docs/UpdateSubscriptionResponse.md) + - [SquareConnect.UpdateTeamMemberRequest](docs/UpdateTeamMemberRequest.md) + - [SquareConnect.UpdateTeamMemberResponse](docs/UpdateTeamMemberResponse.md) + - [SquareConnect.UpdateWageSettingRequest](docs/UpdateWageSettingRequest.md) + - [SquareConnect.UpdateWageSettingResponse](docs/UpdateWageSettingResponse.md) + - [SquareConnect.UpdateWorkweekConfigRequest](docs/UpdateWorkweekConfigRequest.md) + - [SquareConnect.UpdateWorkweekConfigResponse](docs/UpdateWorkweekConfigResponse.md) + - [SquareConnect.UpsertCatalogObjectRequest](docs/UpsertCatalogObjectRequest.md) + - [SquareConnect.UpsertCatalogObjectResponse](docs/UpsertCatalogObjectResponse.md) + - [SquareConnect.V1AdjustInventoryRequest](docs/V1AdjustInventoryRequest.md) + - [SquareConnect.V1AdjustInventoryRequestAdjustmentType](docs/V1AdjustInventoryRequestAdjustmentType.md) + - [SquareConnect.V1ApplyFeeRequest](docs/V1ApplyFeeRequest.md) + - [SquareConnect.V1ApplyModifierListRequest](docs/V1ApplyModifierListRequest.md) + - [SquareConnect.V1BankAccount](docs/V1BankAccount.md) + - [SquareConnect.V1BankAccountType](docs/V1BankAccountType.md) + - [SquareConnect.V1CashDrawerEvent](docs/V1CashDrawerEvent.md) + - [SquareConnect.V1CashDrawerEventEventType](docs/V1CashDrawerEventEventType.md) + - [SquareConnect.V1CashDrawerShift](docs/V1CashDrawerShift.md) + - [SquareConnect.V1CashDrawerShiftEventType](docs/V1CashDrawerShiftEventType.md) + - [SquareConnect.V1Category](docs/V1Category.md) + - [SquareConnect.V1CreateCategoryRequest](docs/V1CreateCategoryRequest.md) + - [SquareConnect.V1CreateDiscountRequest](docs/V1CreateDiscountRequest.md) + - [SquareConnect.V1CreateEmployeeRoleRequest](docs/V1CreateEmployeeRoleRequest.md) + - [SquareConnect.V1CreateFeeRequest](docs/V1CreateFeeRequest.md) + - [SquareConnect.V1CreateItemRequest](docs/V1CreateItemRequest.md) + - [SquareConnect.V1CreateModifierListRequest](docs/V1CreateModifierListRequest.md) + - [SquareConnect.V1CreateModifierOptionRequest](docs/V1CreateModifierOptionRequest.md) + - [SquareConnect.V1CreatePageRequest](docs/V1CreatePageRequest.md) + - [SquareConnect.V1CreateRefundRequest](docs/V1CreateRefundRequest.md) + - [SquareConnect.V1CreateRefundRequestType](docs/V1CreateRefundRequestType.md) + - [SquareConnect.V1CreateVariationRequest](docs/V1CreateVariationRequest.md) + - [SquareConnect.V1DeleteCategoryRequest](docs/V1DeleteCategoryRequest.md) + - [SquareConnect.V1DeleteDiscountRequest](docs/V1DeleteDiscountRequest.md) + - [SquareConnect.V1DeleteFeeRequest](docs/V1DeleteFeeRequest.md) + - [SquareConnect.V1DeleteItemRequest](docs/V1DeleteItemRequest.md) + - [SquareConnect.V1DeleteModifierListRequest](docs/V1DeleteModifierListRequest.md) + - [SquareConnect.V1DeleteModifierOptionRequest](docs/V1DeleteModifierOptionRequest.md) + - [SquareConnect.V1DeletePageCellRequest](docs/V1DeletePageCellRequest.md) + - [SquareConnect.V1DeletePageRequest](docs/V1DeletePageRequest.md) + - [SquareConnect.V1DeleteTimecardRequest](docs/V1DeleteTimecardRequest.md) + - [SquareConnect.V1DeleteTimecardResponse](docs/V1DeleteTimecardResponse.md) + - [SquareConnect.V1DeleteVariationRequest](docs/V1DeleteVariationRequest.md) + - [SquareConnect.V1Discount](docs/V1Discount.md) + - [SquareConnect.V1DiscountColor](docs/V1DiscountColor.md) + - [SquareConnect.V1DiscountDiscountType](docs/V1DiscountDiscountType.md) + - [SquareConnect.V1Employee](docs/V1Employee.md) + - [SquareConnect.V1EmployeeRole](docs/V1EmployeeRole.md) + - [SquareConnect.V1EmployeeRolePermissions](docs/V1EmployeeRolePermissions.md) + - [SquareConnect.V1EmployeeStatus](docs/V1EmployeeStatus.md) + - [SquareConnect.V1Fee](docs/V1Fee.md) + - [SquareConnect.V1FeeAdjustmentType](docs/V1FeeAdjustmentType.md) + - [SquareConnect.V1FeeCalculationPhase](docs/V1FeeCalculationPhase.md) + - [SquareConnect.V1FeeInclusionType](docs/V1FeeInclusionType.md) + - [SquareConnect.V1FeeType](docs/V1FeeType.md) + - [SquareConnect.V1InventoryEntry](docs/V1InventoryEntry.md) + - [SquareConnect.V1Item](docs/V1Item.md) + - [SquareConnect.V1ItemColor](docs/V1ItemColor.md) + - [SquareConnect.V1ItemImage](docs/V1ItemImage.md) + - [SquareConnect.V1ItemType](docs/V1ItemType.md) + - [SquareConnect.V1ItemVisibility](docs/V1ItemVisibility.md) + - [SquareConnect.V1ListBankAccountsRequest](docs/V1ListBankAccountsRequest.md) + - [SquareConnect.V1ListBankAccountsResponse](docs/V1ListBankAccountsResponse.md) + - [SquareConnect.V1ListCashDrawerShiftsRequest](docs/V1ListCashDrawerShiftsRequest.md) + - [SquareConnect.V1ListCashDrawerShiftsResponse](docs/V1ListCashDrawerShiftsResponse.md) + - [SquareConnect.V1ListCategoriesRequest](docs/V1ListCategoriesRequest.md) + - [SquareConnect.V1ListCategoriesResponse](docs/V1ListCategoriesResponse.md) + - [SquareConnect.V1ListDiscountsRequest](docs/V1ListDiscountsRequest.md) + - [SquareConnect.V1ListDiscountsResponse](docs/V1ListDiscountsResponse.md) + - [SquareConnect.V1ListEmployeeRolesRequest](docs/V1ListEmployeeRolesRequest.md) + - [SquareConnect.V1ListEmployeeRolesResponse](docs/V1ListEmployeeRolesResponse.md) + - [SquareConnect.V1ListEmployeesRequest](docs/V1ListEmployeesRequest.md) + - [SquareConnect.V1ListEmployeesRequestStatus](docs/V1ListEmployeesRequestStatus.md) + - [SquareConnect.V1ListEmployeesResponse](docs/V1ListEmployeesResponse.md) + - [SquareConnect.V1ListFeesRequest](docs/V1ListFeesRequest.md) + - [SquareConnect.V1ListFeesResponse](docs/V1ListFeesResponse.md) + - [SquareConnect.V1ListInventoryRequest](docs/V1ListInventoryRequest.md) + - [SquareConnect.V1ListInventoryResponse](docs/V1ListInventoryResponse.md) + - [SquareConnect.V1ListItemsRequest](docs/V1ListItemsRequest.md) + - [SquareConnect.V1ListItemsResponse](docs/V1ListItemsResponse.md) + - [SquareConnect.V1ListLocationsRequest](docs/V1ListLocationsRequest.md) + - [SquareConnect.V1ListLocationsResponse](docs/V1ListLocationsResponse.md) + - [SquareConnect.V1ListModifierListsRequest](docs/V1ListModifierListsRequest.md) + - [SquareConnect.V1ListModifierListsResponse](docs/V1ListModifierListsResponse.md) + - [SquareConnect.V1ListOrdersRequest](docs/V1ListOrdersRequest.md) + - [SquareConnect.V1ListOrdersResponse](docs/V1ListOrdersResponse.md) + - [SquareConnect.V1ListPagesRequest](docs/V1ListPagesRequest.md) + - [SquareConnect.V1ListPagesResponse](docs/V1ListPagesResponse.md) + - [SquareConnect.V1ListPaymentsRequest](docs/V1ListPaymentsRequest.md) + - [SquareConnect.V1ListPaymentsResponse](docs/V1ListPaymentsResponse.md) + - [SquareConnect.V1ListRefundsRequest](docs/V1ListRefundsRequest.md) + - [SquareConnect.V1ListRefundsResponse](docs/V1ListRefundsResponse.md) + - [SquareConnect.V1ListSettlementsRequest](docs/V1ListSettlementsRequest.md) + - [SquareConnect.V1ListSettlementsRequestStatus](docs/V1ListSettlementsRequestStatus.md) + - [SquareConnect.V1ListSettlementsResponse](docs/V1ListSettlementsResponse.md) + - [SquareConnect.V1ListTimecardEventsRequest](docs/V1ListTimecardEventsRequest.md) + - [SquareConnect.V1ListTimecardEventsResponse](docs/V1ListTimecardEventsResponse.md) + - [SquareConnect.V1ListTimecardsRequest](docs/V1ListTimecardsRequest.md) + - [SquareConnect.V1ListTimecardsResponse](docs/V1ListTimecardsResponse.md) + - [SquareConnect.V1Merchant](docs/V1Merchant.md) + - [SquareConnect.V1MerchantAccountType](docs/V1MerchantAccountType.md) + - [SquareConnect.V1MerchantBusinessType](docs/V1MerchantBusinessType.md) + - [SquareConnect.V1MerchantLocationDetails](docs/V1MerchantLocationDetails.md) + - [SquareConnect.V1ModifierList](docs/V1ModifierList.md) + - [SquareConnect.V1ModifierListSelectionType](docs/V1ModifierListSelectionType.md) + - [SquareConnect.V1ModifierOption](docs/V1ModifierOption.md) + - [SquareConnect.V1Money](docs/V1Money.md) + - [SquareConnect.V1Order](docs/V1Order.md) + - [SquareConnect.V1OrderHistoryEntry](docs/V1OrderHistoryEntry.md) + - [SquareConnect.V1OrderHistoryEntryAction](docs/V1OrderHistoryEntryAction.md) + - [SquareConnect.V1OrderState](docs/V1OrderState.md) + - [SquareConnect.V1Page](docs/V1Page.md) + - [SquareConnect.V1PageCell](docs/V1PageCell.md) + - [SquareConnect.V1PageCellObjectType](docs/V1PageCellObjectType.md) + - [SquareConnect.V1PageCellPlaceholderType](docs/V1PageCellPlaceholderType.md) + - [SquareConnect.V1Payment](docs/V1Payment.md) + - [SquareConnect.V1PaymentDiscount](docs/V1PaymentDiscount.md) + - [SquareConnect.V1PaymentItemDetail](docs/V1PaymentItemDetail.md) + - [SquareConnect.V1PaymentItemization](docs/V1PaymentItemization.md) + - [SquareConnect.V1PaymentItemizationItemizationType](docs/V1PaymentItemizationItemizationType.md) + - [SquareConnect.V1PaymentModifier](docs/V1PaymentModifier.md) + - [SquareConnect.V1PaymentSurcharge](docs/V1PaymentSurcharge.md) + - [SquareConnect.V1PaymentSurchargeType](docs/V1PaymentSurchargeType.md) + - [SquareConnect.V1PaymentTax](docs/V1PaymentTax.md) + - [SquareConnect.V1PaymentTaxInclusionType](docs/V1PaymentTaxInclusionType.md) + - [SquareConnect.V1PhoneNumber](docs/V1PhoneNumber.md) + - [SquareConnect.V1Refund](docs/V1Refund.md) + - [SquareConnect.V1RefundType](docs/V1RefundType.md) + - [SquareConnect.V1RemoveFeeRequest](docs/V1RemoveFeeRequest.md) + - [SquareConnect.V1RemoveModifierListRequest](docs/V1RemoveModifierListRequest.md) + - [SquareConnect.V1RetrieveBankAccountRequest](docs/V1RetrieveBankAccountRequest.md) + - [SquareConnect.V1RetrieveBusinessRequest](docs/V1RetrieveBusinessRequest.md) + - [SquareConnect.V1RetrieveCashDrawerShiftRequest](docs/V1RetrieveCashDrawerShiftRequest.md) + - [SquareConnect.V1RetrieveEmployeeRequest](docs/V1RetrieveEmployeeRequest.md) + - [SquareConnect.V1RetrieveEmployeeRoleRequest](docs/V1RetrieveEmployeeRoleRequest.md) + - [SquareConnect.V1RetrieveItemRequest](docs/V1RetrieveItemRequest.md) + - [SquareConnect.V1RetrieveModifierListRequest](docs/V1RetrieveModifierListRequest.md) + - [SquareConnect.V1RetrieveOrderRequest](docs/V1RetrieveOrderRequest.md) + - [SquareConnect.V1RetrievePaymentRequest](docs/V1RetrievePaymentRequest.md) + - [SquareConnect.V1RetrieveSettlementRequest](docs/V1RetrieveSettlementRequest.md) + - [SquareConnect.V1RetrieveTimecardRequest](docs/V1RetrieveTimecardRequest.md) + - [SquareConnect.V1Settlement](docs/V1Settlement.md) + - [SquareConnect.V1SettlementEntry](docs/V1SettlementEntry.md) + - [SquareConnect.V1SettlementEntryType](docs/V1SettlementEntryType.md) + - [SquareConnect.V1SettlementStatus](docs/V1SettlementStatus.md) + - [SquareConnect.V1Tender](docs/V1Tender.md) + - [SquareConnect.V1TenderCardBrand](docs/V1TenderCardBrand.md) + - [SquareConnect.V1TenderEntryMethod](docs/V1TenderEntryMethod.md) + - [SquareConnect.V1TenderType](docs/V1TenderType.md) + - [SquareConnect.V1Timecard](docs/V1Timecard.md) + - [SquareConnect.V1TimecardEvent](docs/V1TimecardEvent.md) + - [SquareConnect.V1TimecardEventEventType](docs/V1TimecardEventEventType.md) + - [SquareConnect.V1UpdateCategoryRequest](docs/V1UpdateCategoryRequest.md) + - [SquareConnect.V1UpdateDiscountRequest](docs/V1UpdateDiscountRequest.md) + - [SquareConnect.V1UpdateEmployeeRequest](docs/V1UpdateEmployeeRequest.md) + - [SquareConnect.V1UpdateEmployeeRoleRequest](docs/V1UpdateEmployeeRoleRequest.md) + - [SquareConnect.V1UpdateFeeRequest](docs/V1UpdateFeeRequest.md) + - [SquareConnect.V1UpdateItemRequest](docs/V1UpdateItemRequest.md) + - [SquareConnect.V1UpdateModifierListRequest](docs/V1UpdateModifierListRequest.md) + - [SquareConnect.V1UpdateModifierListRequestSelectionType](docs/V1UpdateModifierListRequestSelectionType.md) + - [SquareConnect.V1UpdateModifierOptionRequest](docs/V1UpdateModifierOptionRequest.md) + - [SquareConnect.V1UpdateOrderRequest](docs/V1UpdateOrderRequest.md) + - [SquareConnect.V1UpdateOrderRequestAction](docs/V1UpdateOrderRequestAction.md) + - [SquareConnect.V1UpdatePageCellRequest](docs/V1UpdatePageCellRequest.md) + - [SquareConnect.V1UpdatePageRequest](docs/V1UpdatePageRequest.md) + - [SquareConnect.V1UpdateTimecardRequest](docs/V1UpdateTimecardRequest.md) + - [SquareConnect.V1UpdateVariationRequest](docs/V1UpdateVariationRequest.md) + - [SquareConnect.V1Variation](docs/V1Variation.md) + - [SquareConnect.V1VariationInventoryAlertType](docs/V1VariationInventoryAlertType.md) + - [SquareConnect.V1VariationPricingType](docs/V1VariationPricingType.md) + - [SquareConnect.VoidTransactionRequest](docs/VoidTransactionRequest.md) + - [SquareConnect.VoidTransactionResponse](docs/VoidTransactionResponse.md) + - [SquareConnect.WageSetting](docs/WageSetting.md) + - [SquareConnect.Weekday](docs/Weekday.md) + - [SquareConnect.WorkweekConfig](docs/WorkweekConfig.md) + + +## Documentation for Authorization + + +### oauth2 + +- **Type**: OAuth +- **Flow**: accessCode +- **Authorization URL**: https://connect.squareup.com/oauth2/authorize +- **Scopes**: + - BANK_ACCOUNTS_READ: __HTTP Method__: `GET` Grants read access to bank account information associated with the targeted Square account. For example, to call the Connect v1 ListBankAccounts endpoint. + - CASH_DRAWER_READ: __HTTP Method__: `GET` Grants read access to cash drawer shift information. For example, to call the ListCashDrawerShifts endpoint. + - CUSTOMERS_READ: __HTTP Method__: `GET` Grants read access to customer information. For example, to call the ListCustomers endpoint. + - CUSTOMERS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to customer information. For example, to create and update customer profiles. + - DEVICE_CREDENTIAL_MANAGEMENT: __HTTP Method__: `POST`, `GET` Grants read/write access to device credentials information. For example, to call the CreateDeviceCode endpoint. + - EMPLOYEES_READ: __HTTP Method__: `GET` Grants read access to employee profile information. For example, to call the Connect v1 Employees API. + - EMPLOYEES_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee profile information. For example, to create and modify employee profiles. + - INVENTORY_READ: __HTTP Method__: `GET` Grants read access to inventory information. For example, to call the RetrieveInventoryCount endpoint. + - INVENTORY_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to inventory information. For example, to call the BatchChangeInventory endpoint. + - ITEMS_READ: __HTTP Method__: `GET` Grants read access to business and location information. For example, to obtain a location ID for subsequent activity. + - ITEMS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to product catalog information. For example, to modify or add to a product catalog. + - LOYALTY_READ: __HTTP Method__: `GET` Grants read access to loyalty information. For example, to call the ListLoyaltyPrograms endpoint. + - LOYALTY_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to loyalty information. For example, to call the CreateLoyaltyAccount endpoint. + - MERCHANT_PROFILE_READ: __HTTP Method__: `GET` Grants read access to business and location information. For example, to obtain a location ID for subsequent activity. + - ORDERS_READ: __HTTP Method__: `GET` Grants read access to order information. For example, to call the BatchRetrieveOrders endpoint. + - ORDERS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to order information. For example, to call the CreateCheckout endpoint. + - PAYMENTS_READ: __HTTP Method__: `GET` Grants read access to transaction and refund information. For example, to call the RetrieveTransaction endpoint. + - PAYMENTS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to transaction and refunds information. For example, to process payments with the Payments or Checkout API. + - PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS: __HTTP Method__: `POST`, `PUT`, `DELETE` Allow third party applications to deduct a portion of each transaction amount. __Required__ to use multiparty transaction functionality with the Payments API. + - PAYMENTS_WRITE_IN_PERSON: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to payments and refunds information. For example, to process in-person payments. + - SETTLEMENTS_READ: __HTTP Method__: `GET` Grants read access to settlement (deposit) information. For example, to call the Connect v1 ListSettlements endpoint. + - TIMECARDS_READ: __HTTP Method__: `GET` Grants read access to employee timecard information. For example, to call the Connect v2 SearchShifts endpoint. + - TIMECARDS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee shift information. For example, to create and modify employee shifts. + - TIMECARDS_SETTINGS_READ: __HTTP Method__: `GET` Grants read access to employee timecard settings information. For example, to call the GetBreakType endpoint. + - TIMECARDS_SETTINGS_WRITE: __HTTP Method__: `POST`, `PUT`, `DELETE` Grants write access to employee timecard settings information. For example, to call the UpdateBreakType endpoint. + +### oauth2ClientSecret + +- **Type**: API key +- **API key parameter name**: Authorization +- **Location**: HTTP header + + +## Pagination of V1 Endpoints + +V1 Endpoints return pagination information via HTTP headers. In order to obtain +response headers and extract the `batch_token` parameter you will need to follow +the following steps: + +1. Use the full information endpoint methods of each API to get the response HTTP +Headers. They are named as their simple counterpart with a `WithHttpInfo` suffix. +Hence `listEmployeeRoles` would be called `listEmployeeRolesWithHttpInfo`. This +method returns a `CompleteResponse` object with the response data deserialized along +with a helper to retrieve the token if present. + +2. Use `var batchToken = completeResponse.batch_token;` +to extract the token and proceed to get the following page if a token is present. + +### Example + +```javascript +var SquareConnect = require('square-connect'); +var defaultClient = SquareConnect.ApiClient.instance; + +// Configure OAuth2 access token for authorization: oauth2 +var oauth2 = defaultClient.authentications['oauth2']; +oauth2.accessToken = "YOUR ACCESS TOKEN"; + + +var api = new SquareConnect.V1EmployeesApi(); + +var opts = { + order: "order_example", + limit: 56, + batch_token: null +} + +function getAllEmployeeRoles(batch_token){ + if (batch_token) { + api.listEmployeeRolesWithHttpInfo(opts).then(function(resp) { + var batch_token = resp.batch_token; + opts['batch_token'] = batch_token; + getAllEmployeeRoles(token); + }, function(error) { + console.error(error); + }); + } +} + +getAllEmployeeRoles(true); +``` + +## Contributing + +Send bug reports, feature requests, and code contributions to the [API +specifications repository](https://github.com/square/connect-api-specification), +as this repository contains only the generated SDK code. + +## License + +``` +Copyright 2017 Square, Inc. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +``` + + +[//]: # "Link anchor definitions" +[Square Logo]: https://docs.connect.squareup.com/images/github/github-square-logo.svg diff --git a/docs/RefundPaymentRequest.md b/docs/RefundPaymentRequest.md index 0ef84ee..452a6ea 100644 --- a/docs/RefundPaymentRequest.md +++ b/docs/RefundPaymentRequest.md @@ -7,10 +7,10 @@ Refunds a payment. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**idempotency_key** | **String** | A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency). | -**amount_money** | [**Money**](Money.md) | The amount of money to refund. Cannot be more than the `total_money` value of the payment minus the total amount of all previously completed refunds for this payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is charging the card. | -**app_fee_money** | [**Money**](Money.md) | Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees) | [optional] -**payment_id** | **String** | Unique ID of the payment being refunded. | +**idempotency_key** | **String** | A unique string that identifies this `RefundPayment` request. The key can be any valid string but must be unique for every `RefundPayment` request. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). | +**amount_money** | [**Money**](Money.md) | The amount of money to refund. This amount cannot be more than the `total_money` value of the payment minus the total amount of all previously completed refunds for this payment. This amount must be specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). The currency code must match the currency associated with the business that is charging the card. | +**app_fee_money** | [**Money**](Money.md) | The amount of money the developer contributes to help cover the refunded amount. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). The value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). | [optional] +**payment_id** | **String** | The unique ID of the payment being refunded. | **reason** | **String** | A description of the reason for the refund. | [optional] diff --git a/docs/RefundPaymentResponse.md b/docs/RefundPaymentResponse.md index ff2e244..08220ac 100644 --- a/docs/RefundPaymentResponse.md +++ b/docs/RefundPaymentResponse.md @@ -2,12 +2,12 @@ ### Description -Defines the fields that are included in the response body of a request to the [RefundPayment](#endpoint-refunds-refundpayment) endpoint. Note: if there are errors processing the request, the refund field may not be present, or it may be present in a FAILED state. +Defines the fields that are included in the response body of a request to the [RefundPayment](#endpoint-refunds-refundpayment) endpoint. Note: If there are errors processing the request, the refund field might not be present or it might be present in a FAILED state. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**errors** | [**[Error]**](Error.md) | Information on errors encountered during the request. | [optional] +**errors** | [**[Error]**](Error.md) | Information about errors encountered during the request. | [optional] **refund** | [**PaymentRefund**](PaymentRefund.md) | The successfully created `PaymentRefund`. | [optional] diff --git a/docs/RefundsApi.md b/docs/RefundsApi.md index 321b4e0..0e83e3d 100644 --- a/docs/RefundsApi.md +++ b/docs/RefundsApi.md @@ -28,7 +28,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new SquareConnect.RefundsApi(); -var refundId = SquareConnect.RefundsApi.constructFromObject({}); // String | Unique ID for the desired `PaymentRefund`. +var refundId = SquareConnect.RefundsApi.constructFromObject({}); // String | The unique ID for the desired `PaymentRefund`. apiInstance.getPaymentRefund(refundId).then(function(data) { console.log('API called successfully. Returned data: ' + data); @@ -42,7 +42,7 @@ apiInstance.getPaymentRefund(refundId).then(function(data) { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **refundId** | **String**| Unique ID for the desired `PaymentRefund`. | + **refundId** | **String**| The unique ID for the desired `PaymentRefund`. | ### Return type @@ -77,14 +77,14 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new SquareConnect.RefundsApi(); var opts = { - 'beginTime': SquareConnect.RefundsApi.constructFromObject({});, // String | Timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. - 'endTime': SquareConnect.RefundsApi.constructFromObject({});, // String | Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. - 'sortOrder': SquareConnect.RefundsApi.constructFromObject({});, // String | The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). - 'cursor': SquareConnect.RefundsApi.constructFromObject({});, // String | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. - 'locationId': SquareConnect.RefundsApi.constructFromObject({});, // String | Limit results to the location supplied. By default, results are returned for all locations associated with the merchant. - 'status': SquareConnect.RefundsApi.constructFromObject({});, // String | If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. - 'sourceType': SquareConnect.RefundsApi.constructFromObject({});, // String | If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. - 'limit': SquareConnect.RefundsApi.constructFromObject({}); // Number | Maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. If the supplied value is greater than 100, at most 100 results will be returned. Default: `100` + 'beginTime': SquareConnect.RefundsApi.constructFromObject({});, // String | The timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. + 'endTime': SquareConnect.RefundsApi.constructFromObject({});, // String | The timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. + 'sortOrder': SquareConnect.RefundsApi.constructFromObject({});, // String | The order in which results are listed: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default). + 'cursor': SquareConnect.RefundsApi.constructFromObject({});, // String | A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination). + 'locationId': SquareConnect.RefundsApi.constructFromObject({});, // String | Limit results to the location supplied. By default, results are returned for all locations associated with the seller. + 'status': SquareConnect.RefundsApi.constructFromObject({});, // String | If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted, refunds are returned regardless of their status. + 'sourceType': SquareConnect.RefundsApi.constructFromObject({});, // String | If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where `CARD` was specified as the payment source. Default: If omitted, refunds are returned regardless of the source type. + 'limit': SquareConnect.RefundsApi.constructFromObject({}); // Number | The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. If the supplied value is greater than 100, no more than 100 results are returned. Default: 100 }; apiInstance.listPaymentRefunds(opts).then(function(data) { console.log('API called successfully. Returned data: ' + data); @@ -98,14 +98,14 @@ apiInstance.listPaymentRefunds(opts).then(function(data) { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **beginTime** | **String**| Timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. | [optional] - **endTime** | **String**| Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. | [optional] - **sortOrder** | **String**| The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). | [optional] - **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] - **locationId** | **String**| Limit results to the location supplied. By default, results are returned for all locations associated with the merchant. | [optional] - **status** | **String**| If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. | [optional] - **sourceType** | **String**| If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. | [optional] - **limit** | **Number**| Maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. If the supplied value is greater than 100, at most 100 results will be returned. Default: `100` | [optional] + **beginTime** | **String**| The timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. | [optional] + **endTime** | **String**| The timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. | [optional] + **sortOrder** | **String**| The order in which results are listed: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default). | [optional] + **cursor** | **String**| A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination). | [optional] + **locationId** | **String**| Limit results to the location supplied. By default, results are returned for all locations associated with the seller. | [optional] + **status** | **String**| If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted, refunds are returned regardless of their status. | [optional] + **sourceType** | **String**| If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where `CARD` was specified as the payment source. Default: If omitted, refunds are returned regardless of the source type. | [optional] + **limit** | **Number**| The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. If the supplied value is greater than 100, no more than 100 results are returned. Default: 100 | [optional] ### Return type diff --git a/docs/RetrieveBookingRequest.md b/docs/RetrieveBookingRequest.md new file mode 100644 index 0000000..6995fcf --- /dev/null +++ b/docs/RetrieveBookingRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.RetrieveBookingRequest + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/RetrieveBookingResponse.md b/docs/RetrieveBookingResponse.md new file mode 100644 index 0000000..4da0ff7 --- /dev/null +++ b/docs/RetrieveBookingResponse.md @@ -0,0 +1,14 @@ +# SquareConnect.RetrieveBookingResponse + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**booking** | [**Booking**](Booking.md) | The booking that was requested. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/RetrieveBusinessBookingProfileRequest.md b/docs/RetrieveBusinessBookingProfileRequest.md new file mode 100644 index 0000000..9fa787d --- /dev/null +++ b/docs/RetrieveBusinessBookingProfileRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.RetrieveBusinessBookingProfileRequest + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/RetrieveBusinessBookingProfileResponse.md b/docs/RetrieveBusinessBookingProfileResponse.md new file mode 100644 index 0000000..78aab5b --- /dev/null +++ b/docs/RetrieveBusinessBookingProfileResponse.md @@ -0,0 +1,14 @@ +# SquareConnect.RetrieveBusinessBookingProfileResponse + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**business_booking_profile** | [**BusinessBookingProfile**](BusinessBookingProfile.md) | The seller's booking profile. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/RetrieveObsMigrationProfileRequest.md b/docs/RetrieveObsMigrationProfileRequest.md new file mode 100644 index 0000000..18920c7 --- /dev/null +++ b/docs/RetrieveObsMigrationProfileRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.RetrieveObsMigrationProfileRequest + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/RetrieveObsMigrationProfileResponse.md b/docs/RetrieveObsMigrationProfileResponse.md new file mode 100644 index 0000000..85d87bf --- /dev/null +++ b/docs/RetrieveObsMigrationProfileResponse.md @@ -0,0 +1,17 @@ +# SquareConnect.RetrieveObsMigrationProfileResponse + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**banner_enabled** | **Boolean** | Indicates whether the seller has enabled the COVID banner (`true`) or not (`false`). | [optional] +**banner_text** | **String** | The text appearing on the COVID banner. | [optional] +**banner_cta_text** | **String** | The text of the label of the CTA button beneath the banner. | [optional] +**banner_cta_url** | **String** | The URL to link to when the CTA button is clicked. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/RetrieveTeamMemberBookingProfileRequest.md b/docs/RetrieveTeamMemberBookingProfileRequest.md new file mode 100644 index 0000000..583cb96 --- /dev/null +++ b/docs/RetrieveTeamMemberBookingProfileRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.RetrieveTeamMemberBookingProfileRequest + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/RetrieveTeamMemberBookingProfileResponse.md b/docs/RetrieveTeamMemberBookingProfileResponse.md new file mode 100644 index 0000000..fbd30ae --- /dev/null +++ b/docs/RetrieveTeamMemberBookingProfileResponse.md @@ -0,0 +1,14 @@ +# SquareConnect.RetrieveTeamMemberBookingProfileResponse + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**team_member_booking_profile** | [**TeamMemberBookingProfile**](TeamMemberBookingProfile.md) | The returned team member booking profile. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/RiskEvaluation.md b/docs/RiskEvaluation.md new file mode 100644 index 0000000..843cadf --- /dev/null +++ b/docs/RiskEvaluation.md @@ -0,0 +1,14 @@ +# SquareConnect.RiskEvaluation + +### Description +**Note: This model is in beta.** + +Represents fraud risk information for the associated payment. When you take a payment through Square's Payments API (using the `CreatePayment` endpoint), Square evaluates it and assigns a risk level to the payment. Sellers can use this information to determine the course of action (for example, provide the goods/services or refund the payment). + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created_at** | **String** | The timestamp when payment risk was evaluated, in RFC3339 format. | [optional] +**risk_level** | [**RiskEvaluationRiskLevel**](RiskEvaluationRiskLevel.md) | The risk level associated with the payment | [optional] + + diff --git a/docs/RiskEvaluationRiskLevel.md b/docs/RiskEvaluationRiskLevel.md new file mode 100644 index 0000000..d285fd7 --- /dev/null +++ b/docs/RiskEvaluationRiskLevel.md @@ -0,0 +1,14 @@ +# SquareConnect.RiskEvaluationRiskLevel + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `NORMAL` (value: `"NORMAL"`) + +* `MODERATE` (value: `"MODERATE"`) + +* `HIGH` (value: `"HIGH"`) + + diff --git a/docs/SearchAvailabilityFilter.md b/docs/SearchAvailabilityFilter.md new file mode 100644 index 0000000..f83fdc8 --- /dev/null +++ b/docs/SearchAvailabilityFilter.md @@ -0,0 +1,16 @@ +# SquareConnect.SearchAvailabilityFilter + +### Description +**Note: This model is in beta.** + +A query filter to search for availabilities by. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_at_range** | [**TimeRange**](TimeRange.md) | The query expression to search for availabilities matching the specified range of starting times. | +**location_id** | **String** | The query expression to search for availabilities matching the specified seller location IDs. This query expression is not applicable when `booking_id` is present. | [optional] +**segment_filters** | [**[SegmentFilter]**](SegmentFilter.md) | The list of segment filters to apply. A query with `n` segment filters returns availabilities with `n` segments per availability. It is not applicable when `booking_id` is present. | [optional] +**booking_id** | **String** | The query expression to search for availabilities for an existing booking by matching the specified `booking_id` value. This is commonly used to reschedule an appointment. If this expression is specified, the `location_id` and `segment_filters` expressions are not allowed. | [optional] + + diff --git a/docs/SearchAvailabilityQuery.md b/docs/SearchAvailabilityQuery.md new file mode 100644 index 0000000..316a18b --- /dev/null +++ b/docs/SearchAvailabilityQuery.md @@ -0,0 +1,13 @@ +# SquareConnect.SearchAvailabilityQuery + +### Description +**Note: This model is in beta.** + +Query conditions to search for availabilities of bookings. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filter** | [**SearchAvailabilityFilter**](SearchAvailabilityFilter.md) | The query filter to search for availabilities of existing bookings. | + + diff --git a/docs/SearchAvailabilityRequest.md b/docs/SearchAvailabilityRequest.md new file mode 100644 index 0000000..9968059 --- /dev/null +++ b/docs/SearchAvailabilityRequest.md @@ -0,0 +1,13 @@ +# SquareConnect.SearchAvailabilityRequest + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | [**SearchAvailabilityQuery**](SearchAvailabilityQuery.md) | Query conditions used to filter results. | + + diff --git a/docs/SearchAvailabilityResponse.md b/docs/SearchAvailabilityResponse.md new file mode 100644 index 0000000..a521d5d --- /dev/null +++ b/docs/SearchAvailabilityResponse.md @@ -0,0 +1,14 @@ +# SquareConnect.SearchAvailabilityResponse + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**availabilities** | [**[Availability]**](Availability.md) | List of slots available for booking. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/SearchCatalogObjectsRequest.md b/docs/SearchCatalogObjectsRequest.md index 9b94ce9..61a20f3 100644 --- a/docs/SearchCatalogObjectsRequest.md +++ b/docs/SearchCatalogObjectsRequest.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **cursor** | **String** | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] -**object_types** | **[String]** | The desired set of object types to appear in the search results. The legal values are taken from the CatalogObjectType enum: `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values | [optional] +**object_types** | **[String]** | The desired set of object types to appear in the search results. See [CatalogObjectType](#type-catalogobjecttype) for possible values | [optional] **include_deleted_objects** | **Boolean** | If `true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`. | [optional] **include_related_objects** | **Boolean** | If `true`, the response will include additional objects that are related to the requested object, as follows: If a CatalogItem is returned in the object field of the response, its associated CatalogCategory, CatalogTax objects, CatalogImage objects and CatalogModifierList objects will be included in the `related_objects` field of the response. If a CatalogItemVariation is returned in the object field of the response, its parent CatalogItem will be included in the `related_objects` field of the response. | [optional] **begin_time** | **String** | Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response. | [optional] diff --git a/docs/SegmentFilter.md b/docs/SegmentFilter.md new file mode 100644 index 0000000..808dd93 --- /dev/null +++ b/docs/SegmentFilter.md @@ -0,0 +1,14 @@ +# SquareConnect.SegmentFilter + +### Description +**Note: This model is in beta.** + +A query filter to search for appointment segments by. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**service_variation_id** | **String** | The ID of the `CatalogItemVariation` representing the service booked in this segment. | +**team_member_id_filter** | [**FilterValue**](FilterValue.md) | A query expression specifying which team members satisfy the condition. Supported expressions are - `ANY`: include team members whose IDs match any member of the specified list. - `NONE`: exclude team members whose IDs match members of the specified list. The `ALL` expression is not supported in the Bookings API. When no expression is specified, any service-providing team member is eligible to fulfill the Booking. | [optional] + + diff --git a/docs/TeamMemberBookingProfile.md b/docs/TeamMemberBookingProfile.md new file mode 100644 index 0000000..34dcd04 --- /dev/null +++ b/docs/TeamMemberBookingProfile.md @@ -0,0 +1,17 @@ +# SquareConnect.TeamMemberBookingProfile + +### Description +**Note: This model is in beta.** + +The booking profile of a seller's team member, including the team member's ID, display name, description and whether the team member can be booked as a service provider. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**team_member_id** | **String** | The ID of the `TeamMember` object for the team member associated with the booking profile. | [optional] +**description** | **String** | The description of the team member. | [optional] +**display_name** | **String** | The display name of the team member. | [optional] +**is_bookable** | **Boolean** | Indicates whether the team member can be booked through the Bookings API or the seller's online booking channel or site (`true) or not (`false`). | [optional] +**profile_image_url** | **String** | The URL of the team member's image for the bookings profile. | [optional] + + diff --git a/docs/TerminalCheckout.md b/docs/TerminalCheckout.md index 34a519c..fd98c37 100644 --- a/docs/TerminalCheckout.md +++ b/docs/TerminalCheckout.md @@ -12,8 +12,8 @@ Name | Type | Description | Notes **reference_id** | **String** | An optional user-defined reference ID which can be used to associate this `TerminalCheckout` to another entity in an external system. For example, an order ID generated by a third-party shopping cart. Will also be associated with any payments used to complete the checkout. | [optional] **note** | **String** | An optional note to associate with the checkout, as well any payments used to complete the checkout. | [optional] **device_options** | [**DeviceCheckoutOptions**](DeviceCheckoutOptions.md) | Options to control the display and behavior of the Square Terminal device. | -**deadline_duration** | **String** | The duration as an RFC 3339 duration, after which the checkout will be automatically canceled. TerminalCheckouts that are `PENDING` will be automatically `CANCELED` and have a cancellation reason of `TIMED\\_OUT`. Default: 5 minutes from creation Maximum: 5 minutes | [optional] -**status** | **String** | The status of the `TerminalCheckout`. Options: `PENDING`, `IN\\_PROGRESS`, `CANCEL\\_REQUESTED`, `CANCELED`, `COMPLETED` | [optional] +**deadline_duration** | **String** | The duration as an RFC 3339 duration, after which the checkout will be automatically canceled. TerminalCheckouts that are `PENDING` will be automatically `CANCELED` and have a cancellation reason of `TIMED_OUT`. Default: 5 minutes from creation Maximum: 5 minutes | [optional] +**status** | **String** | The status of the `TerminalCheckout`. Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED` | [optional] **cancel_reason** | **String** | Present if the status is `CANCELED`. See [ActionCancelReason](#type-actioncancelreason) for possible values | [optional] **payment_ids** | **[String]** | A list of ids for payments created by this `TerminalCheckout`. | [optional] **created_at** | **String** | The time when the `TerminalCheckout` was created as an RFC 3339 timestamp. | [optional] diff --git a/docs/TerminalCheckoutQueryFilter.md b/docs/TerminalCheckoutQueryFilter.md index d343f53..574e99e 100644 --- a/docs/TerminalCheckoutQueryFilter.md +++ b/docs/TerminalCheckoutQueryFilter.md @@ -9,6 +9,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **device_id** | **String** | `TerminalCheckout`s associated with a specific device. If no device is specified then all `TerminalCheckout`s for the merchant will be displayed. | [optional] **created_at** | [**TimeRange**](TimeRange.md) | Time range for the beginning of the reporting period. Inclusive. Default: The current time minus one day. | [optional] -**status** | **String** | Filtered results with the desired status of the `TerminalCheckout` Options: PENDING, IN\\_PROGRESS, CANCELED, COMPLETED | [optional] +**status** | **String** | Filtered results with the desired status of the `TerminalCheckout` Options: PENDING, IN_PROGRESS, CANCELED, COMPLETED | [optional] diff --git a/docs/TerminalRefund.md b/docs/TerminalRefund.md index 626c354..b5966a9 100644 --- a/docs/TerminalRefund.md +++ b/docs/TerminalRefund.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **reason** | **String** | A description of the reason for the refund. Note: maximum 192 characters | [optional] **device_id** | **String** | The unique Id of the device intended for this `TerminalRefund`. The Id can be retrieved from /v2/devices api. | [optional] **deadline_duration** | **String** | The duration as an RFC 3339 duration, after which the refund will be automatically canceled. TerminalRefunds that are `PENDING` will be automatically `CANCELED` and have a cancellation reason of `TIMED_OUT` Default: 5 minutes from creation Maximum: 5 minutes | [optional] -**status** | **String** | The status of the `TerminalRefund`. Options: `PENDING`, `IN\\_PROGRESS`, `CANCELED`, `COMPLETED` | [optional] +**status** | **String** | The status of the `TerminalRefund`. Options: `PENDING`, `IN_PROGRESS`, `CANCELED`, `COMPLETED` | [optional] **cancel_reason** | **String** | Present if the status is `CANCELED`. See [ActionCancelReason](#type-actioncancelreason) for possible values | [optional] **created_at** | **String** | The time when the `TerminalRefund` was created as an RFC 3339 timestamp. | [optional] **updated_at** | **String** | The time when the `TerminalRefund` was last updated as an RFC 3339 timestamp. | [optional] diff --git a/docs/TerminalRefundQueryFilter.md b/docs/TerminalRefundQueryFilter.md index 529580c..1227de5 100644 --- a/docs/TerminalRefundQueryFilter.md +++ b/docs/TerminalRefundQueryFilter.md @@ -10,6 +10,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **device_id** | **String** | `TerminalRefund`s associated with a specific device. If no device is specified then all `TerminalRefund`s for the signed in account will be displayed. | [optional] **created_at** | [**TimeRange**](TimeRange.md) | Timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. Default: The current time minus one day. | [optional] -**status** | **String** | Filtered results with the desired status of the `TerminalRefund` Options: `PENDING`, `IN\\_PROGRESS`, `CANCEL\\_REQUESTED`, `CANCELED`, `COMPLETED` | [optional] +**status** | **String** | Filtered results with the desired status of the `TerminalRefund` Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED` | [optional] diff --git a/docs/TipSettings.md b/docs/TipSettings.md index 9544b6d..8d80f62 100644 --- a/docs/TipSettings.md +++ b/docs/TipSettings.md @@ -10,5 +10,7 @@ Name | Type | Description | Notes **allow_tipping** | **Boolean** | Indicates whether tipping is enabled for this checkout. Defaults to false. | [optional] **separate_tip_screen** | **Boolean** | Indicates whether tip options should be presented on their own screen before presenting the signature screen during card payment. Defaults to false. | [optional] **custom_tip_field** | **Boolean** | Indicates whether custom tip amounts are allowed during the checkout flow. Defaults to false. | [optional] +**tip_percentages** | **[Number]** | A list of tip percentages that should be presented during the checkout flow. Specified as up to 3 non-negative integers from 0 to 100 (inclusive). Defaults to [15, 20, 25] | [optional] +**smart_tipping** | **Boolean** | Enables the \"Smart Tip Amounts\" behavior described in https://squareup.com/help/us/en/article/5069-accept-tips-with-the-square-app. Exact tipping options depend on the region the Square seller is active in. In the United States and Canada, tipping options will be presented in whole dollar amounts for payments under 10 USD/CAD respectively. If set to true, the tip_percentages settings is ignored. Defaults to false. | [optional] diff --git a/docs/UpdateBookingRequest.md b/docs/UpdateBookingRequest.md new file mode 100644 index 0000000..3a0c71e --- /dev/null +++ b/docs/UpdateBookingRequest.md @@ -0,0 +1,14 @@ +# SquareConnect.UpdateBookingRequest + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**idempotency_key** | **String** | A unique key to make this request an idempotent operation. | [optional] +**booking** | [**Booking**](Booking.md) | The booking to be updated. Individual attributes explicitly specified here override the corresponding values of the existing booking. | + + diff --git a/docs/UpdateBookingResponse.md b/docs/UpdateBookingResponse.md new file mode 100644 index 0000000..ab16a53 --- /dev/null +++ b/docs/UpdateBookingResponse.md @@ -0,0 +1,14 @@ +# SquareConnect.UpdateBookingResponse + +### Description +**Note: This model is in beta.** + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**booking** | [**Booking**](Booking.md) | The booking that was updated. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/VersionedCatalogObject.md b/docs/VersionedCatalogObject.md deleted file mode 100644 index 1b7fe87..0000000 --- a/docs/VersionedCatalogObject.md +++ /dev/null @@ -1,13 +0,0 @@ -# SquareConnect.VersionedCatalogObject - -### Description - -A reference to a Catalog object at a specific version. In general this is used as an entry point into a graph of catalog objects, where the objects exist at a specific version. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**object_id** | **String** | The ID of the referenced object. | [optional] -**catalog_version** | **Number** | The version of the object. | [optional] - - diff --git a/package.json b/package.json index d5c107e..215820b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "square-connect", - "version": "4.20201028.5", + "version": "5.20201118.0", "description": "JavaScript client library for the Square Connect v2 API", "keywords": [ "square", diff --git a/src/ApiClient.js b/src/ApiClient.js index a73ea99..8e375f7 100644 --- a/src/ApiClient.js +++ b/src/ApiClient.js @@ -17,7 +17,7 @@ var HeaderUtils = require('./lib/HeaderUtils'); /** * @module ApiClient - * @version 4.20201028.5 + * @version 5.20201118.0 */ /** @@ -49,7 +49,7 @@ var exports = function() { * @default {} */ this.defaultHeaders = { - 'User-Agent': 'Square-Connect-Javascript/4.20201028.5' + 'User-Agent': 'Square-Connect-Javascript/5.20201118.0' }; /** * The default HTTP timeout for all API calls. diff --git a/src/api/ApplePayApi.js b/src/api/ApplePayApi.js index c53f006..6072751 100644 --- a/src/api/ApplePayApi.js +++ b/src/api/ApplePayApi.js @@ -53,7 +53,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/BankAccountsApi.js b/src/api/BankAccountsApi.js index b045193..6854ab5 100644 --- a/src/api/BankAccountsApi.js +++ b/src/api/BankAccountsApi.js @@ -55,7 +55,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -108,7 +108,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -162,7 +162,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/BookingsApi.js b/src/api/BookingsApi.js new file mode 100644 index 0000000..1694565 --- /dev/null +++ b/src/api/BookingsApi.js @@ -0,0 +1,423 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var CreateBookingRequest = require('../model/CreateBookingRequest'); +var CreateBookingResponse = require('../model/CreateBookingResponse'); +var ListTeamMemberBookingProfilesResponse = require('../model/ListTeamMemberBookingProfilesResponse'); +var RetrieveBookingResponse = require('../model/RetrieveBookingResponse'); +var RetrieveBusinessBookingProfileResponse = require('../model/RetrieveBusinessBookingProfileResponse'); +var RetrieveTeamMemberBookingProfileResponse = require('../model/RetrieveTeamMemberBookingProfileResponse'); +var SearchAvailabilityRequest = require('../model/SearchAvailabilityRequest'); +var SearchAvailabilityResponse = require('../model/SearchAvailabilityResponse'); +var UpdateBookingRequest = require('../model/UpdateBookingRequest'); +var UpdateBookingResponse = require('../model/UpdateBookingResponse'); + +/** + * Bookings service. + * @module api/BookingsApi + */ + +/** + * Constructs a new BookingsApi. + * @alias module:api/BookingsApi + * @class + * @param {module:ApiClient} apiClient Optional API client implementation to use, + * default to {@link module:ApiClient#instance} if unspecified. + */ +module.exports = function(apiClient) { + this.apiClient = apiClient || ApiClient.instance; + + + + /** + * CreateBooking + * Note: This endpoint is in beta. + * Creates a booking. + * @param {module:model/CreateBookingRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateBookingResponse} and HTTP response + */ + this.createBookingWithHttpInfo = function(body) { + var postBody = body; + + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw new Error("Missing the required parameter 'body' when calling createBooking"); + } + + + var pathParams = { + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2020-11-18'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = CreateBookingResponse; + + return this.apiClient.callApi( + '/v2/bookings', 'POST', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * CreateBooking + * Creates a booking. + * @param {module:model/CreateBookingRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateBookingResponse} + */ + this.createBooking = function(body) { + return this.createBookingWithHttpInfo(body) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * ListTeamMemberBookingProfiles + * Note: This endpoint is in beta. + * Lists booking profiles for team members. + * @param {Object} opts Optional parameters + * @param {Boolean} opts.bookableOnly Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`). + * @param {Number} opts.limit The maximum number of results to return. + * @param {String} opts.cursor The cursor for paginating through the results. + * @param {String} opts.locationId Indicates whether to include only team members enabled at the given location in the returned result. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListTeamMemberBookingProfilesResponse} and HTTP response + */ + this.listTeamMemberBookingProfilesWithHttpInfo = function(opts) { + opts = opts || {}; + var postBody = null; + + + var pathParams = { + }; + var queryParams = { + 'bookable_only': opts['bookableOnly'], + 'limit': opts['limit'], + 'cursor': opts['cursor'], + 'location_id': opts['locationId'] + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2020-11-18'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = ListTeamMemberBookingProfilesResponse; + + return this.apiClient.callApi( + '/v2/bookings/team-member-booking-profiles', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * ListTeamMemberBookingProfiles + * Lists booking profiles for team members. + * @param {Object} opts Optional parameters + * @param {Boolean} opts.bookableOnly Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`). + * @param {Number} opts.limit The maximum number of results to return. + * @param {String} opts.cursor The cursor for paginating through the results. + * @param {String} opts.locationId Indicates whether to include only team members enabled at the given location in the returned result. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListTeamMemberBookingProfilesResponse} + */ + this.listTeamMemberBookingProfiles = function(opts) { + return this.listTeamMemberBookingProfilesWithHttpInfo(opts) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * RetrieveBooking + * Note: This endpoint is in beta. + * Retrieves a booking. + * @param {String} bookingId The ID of the `Booking` object representing the to-be-retrieved booking. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveBookingResponse} and HTTP response + */ + this.retrieveBookingWithHttpInfo = function(bookingId) { + var postBody = null; + + // verify the required parameter 'bookingId' is set + if (bookingId === undefined || bookingId === null) { + throw new Error("Missing the required parameter 'bookingId' when calling retrieveBooking"); + } + + + var pathParams = { + 'booking_id': bookingId + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2020-11-18'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = RetrieveBookingResponse; + + return this.apiClient.callApi( + '/v2/bookings/{booking_id}', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * RetrieveBooking + * Retrieves a booking. + * @param {String} bookingId The ID of the `Booking` object representing the to-be-retrieved booking. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveBookingResponse} + */ + this.retrieveBooking = function(bookingId) { + return this.retrieveBookingWithHttpInfo(bookingId) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * RetrieveBusinessBookingProfile + * Note: This endpoint is in beta. + * Retrieves a seller's booking profile. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveBusinessBookingProfileResponse} and HTTP response + */ + this.retrieveBusinessBookingProfileWithHttpInfo = function() { + var postBody = null; + + + var pathParams = { + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2020-11-18'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = RetrieveBusinessBookingProfileResponse; + + return this.apiClient.callApi( + '/v2/bookings/business-booking-profile', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * RetrieveBusinessBookingProfile + * Retrieves a seller's booking profile. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveBusinessBookingProfileResponse} + */ + this.retrieveBusinessBookingProfile = function() { + return this.retrieveBusinessBookingProfileWithHttpInfo() + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * RetrieveTeamMemberBookingProfile + * Note: This endpoint is in beta. + * Retrieves a team member's booking profile. + * @param {String} teamMemberId The ID of the team member to retrieve. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveTeamMemberBookingProfileResponse} and HTTP response + */ + this.retrieveTeamMemberBookingProfileWithHttpInfo = function(teamMemberId) { + var postBody = null; + + // verify the required parameter 'teamMemberId' is set + if (teamMemberId === undefined || teamMemberId === null) { + throw new Error("Missing the required parameter 'teamMemberId' when calling retrieveTeamMemberBookingProfile"); + } + + + var pathParams = { + 'team_member_id': teamMemberId + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2020-11-18'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = RetrieveTeamMemberBookingProfileResponse; + + return this.apiClient.callApi( + '/v2/bookings/team-member-booking-profiles/{team_member_id}', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * RetrieveTeamMemberBookingProfile + * Retrieves a team member's booking profile. + * @param {String} teamMemberId The ID of the team member to retrieve. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveTeamMemberBookingProfileResponse} + */ + this.retrieveTeamMemberBookingProfile = function(teamMemberId) { + return this.retrieveTeamMemberBookingProfileWithHttpInfo(teamMemberId) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * SearchAvailability + * Note: This endpoint is in beta. + * Searches for availabilities for booking. + * @param {module:model/SearchAvailabilityRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SearchAvailabilityResponse} and HTTP response + */ + this.searchAvailabilityWithHttpInfo = function(body) { + var postBody = body; + + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw new Error("Missing the required parameter 'body' when calling searchAvailability"); + } + + + var pathParams = { + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2020-11-18'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = SearchAvailabilityResponse; + + return this.apiClient.callApi( + '/v2/bookings/availability/search', 'POST', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * SearchAvailability + * Searches for availabilities for booking. + * @param {module:model/SearchAvailabilityRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SearchAvailabilityResponse} + */ + this.searchAvailability = function(body) { + return this.searchAvailabilityWithHttpInfo(body) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * UpdateBooking + * Note: This endpoint is in beta. + * Updates a booking. + * @param {String} bookingId The ID of the `Booking` object representing the to-be-updated booking. + * @param {module:model/UpdateBookingRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateBookingResponse} and HTTP response + */ + this.updateBookingWithHttpInfo = function(bookingId, body) { + var postBody = body; + + // verify the required parameter 'bookingId' is set + if (bookingId === undefined || bookingId === null) { + throw new Error("Missing the required parameter 'bookingId' when calling updateBooking"); + } + + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw new Error("Missing the required parameter 'body' when calling updateBooking"); + } + + + var pathParams = { + 'booking_id': bookingId + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2020-11-18'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = UpdateBookingResponse; + + return this.apiClient.callApi( + '/v2/bookings/{booking_id}', 'PUT', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * UpdateBooking + * Updates a booking. + * @param {String} bookingId The ID of the `Booking` object representing the to-be-updated booking. + * @param {module:model/UpdateBookingRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateBookingResponse} + */ + this.updateBooking = function(bookingId, body) { + return this.updateBookingWithHttpInfo(bookingId, body) + .then(function(response_and_data) { + return response_and_data.data; + }); + } +}; diff --git a/src/api/CashDrawersApi.js b/src/api/CashDrawersApi.js index 4c4a0ee..1bc142f 100644 --- a/src/api/CashDrawersApi.js +++ b/src/api/CashDrawersApi.js @@ -68,7 +68,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -137,7 +137,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -176,7 +176,7 @@ module.exports = function(apiClient) { /** * RetrieveCashDrawerShift - * Provides the summary details for a single cash drawer shift. See RetrieveCashDrawerShiftEvents for a list of cash drawer shift events. + * Provides the summary details for a single cash drawer shift. See [ListCashDrawerShiftEvents](#endpoint-CashDrawers-ListCashDrawerShiftEvents) for a list of cash drawer shift events. * @param {String} locationId The ID of the location to retrieve cash drawer shifts from. * @param {String} shiftId The shift ID. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveCashDrawerShiftResponse} and HTTP response @@ -203,7 +203,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -222,7 +222,7 @@ module.exports = function(apiClient) { /** * RetrieveCashDrawerShift - * Provides the summary details for a single cash drawer shift. See RetrieveCashDrawerShiftEvents for a list of cash drawer shift events. + * Provides the summary details for a single cash drawer shift. See [ListCashDrawerShiftEvents](#endpoint-CashDrawers-ListCashDrawerShiftEvents) for a list of cash drawer shift events. * @param {String} locationId The ID of the location to retrieve cash drawer shifts from. * @param {String} shiftId The shift ID. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveCashDrawerShiftResponse} diff --git a/src/api/CatalogApi.js b/src/api/CatalogApi.js index 39a5d04..494f35b 100644 --- a/src/api/CatalogApi.js +++ b/src/api/CatalogApi.js @@ -71,7 +71,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -123,7 +123,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -175,7 +175,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -221,7 +221,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -273,7 +273,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -306,7 +306,7 @@ module.exports = function(apiClient) { /** * ListCatalog - * Returns a list of [CatalogObject](#type-catalogobject)s that includes all objects of a set of desired types (for example, all [CatalogItem](#type-catalogitem) and [CatalogTax](#type-catalogtax) objects) in the catalog. The `types` parameter is specified as a comma-separated list of valid [CatalogObject](#type-catalogobject) types: `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`. __Important:__ ListCatalog does not return deleted catalog items. To retrieve deleted catalog items, use SearchCatalogObjects and set `include_deleted_objects` to `true`. + * Returns a list of [CatalogObject](#type-catalogobject)s that includes all objects of a set of desired types (for example, all [CatalogItem](#type-catalogitem) and [CatalogTax](#type-catalogtax) objects) in the catalog. The `types` parameter is specified as a comma-separated list of valid [CatalogObject](#type-catalogobject) types: `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`. __Important:__ ListCatalog does not return deleted catalog items. To retrieve deleted catalog items, use [SearchCatalogObjects](#endpoint-Catalog-SearchCatalogObjects) and set the `include_deleted_objects` attribute value to `true`. * @param {Object} opts Optional parameters * @param {String} opts.cursor The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. * @param {String} opts.types An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. @@ -325,7 +325,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -344,7 +344,7 @@ module.exports = function(apiClient) { /** * ListCatalog - * Returns a list of [CatalogObject](#type-catalogobject)s that includes all objects of a set of desired types (for example, all [CatalogItem](#type-catalogitem) and [CatalogTax](#type-catalogtax) objects) in the catalog. The `types` parameter is specified as a comma-separated list of valid [CatalogObject](#type-catalogobject) types: `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`. __Important:__ ListCatalog does not return deleted catalog items. To retrieve deleted catalog items, use SearchCatalogObjects and set `include_deleted_objects` to `true`. + * Returns a list of [CatalogObject](#type-catalogobject)s that includes all objects of a set of desired types (for example, all [CatalogItem](#type-catalogitem) and [CatalogTax](#type-catalogtax) objects) in the catalog. The `types` parameter is specified as a comma-separated list of valid [CatalogObject](#type-catalogobject) types: `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`. __Important:__ ListCatalog does not return deleted catalog items. To retrieve deleted catalog items, use [SearchCatalogObjects](#endpoint-Catalog-SearchCatalogObjects) and set the `include_deleted_objects` attribute value to `true`. * @param {Object} opts Optional parameters * @param {String} opts.cursor The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. * @param {String} opts.types An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`. @@ -384,7 +384,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -439,7 +439,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -491,7 +491,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -543,7 +543,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -595,7 +595,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -647,7 +647,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/CheckoutApi.js b/src/api/CheckoutApi.js index c72f9d8..40db5eb 100644 --- a/src/api/CheckoutApi.js +++ b/src/api/CheckoutApi.js @@ -60,7 +60,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/CustomerGroupsApi.js b/src/api/CustomerGroupsApi.js index 2883cd5..f6b3f26 100644 --- a/src/api/CustomerGroupsApi.js +++ b/src/api/CustomerGroupsApi.js @@ -59,7 +59,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -113,7 +113,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -164,7 +164,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -219,7 +219,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -279,7 +279,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/CustomerSegmentsApi.js b/src/api/CustomerSegmentsApi.js index 3964dad..249f9e6 100644 --- a/src/api/CustomerSegmentsApi.js +++ b/src/api/CustomerSegmentsApi.js @@ -52,7 +52,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -107,7 +107,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/CustomersApi.js b/src/api/CustomersApi.js index 820602c..c40a8fd 100644 --- a/src/api/CustomersApi.js +++ b/src/api/CustomersApi.js @@ -74,7 +74,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -127,7 +127,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -186,7 +186,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -240,7 +240,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -300,7 +300,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -355,7 +355,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -419,7 +419,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -473,7 +473,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -525,7 +525,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -584,7 +584,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/DevicesApi.js b/src/api/DevicesApi.js index 97e345f..c70d8ef 100644 --- a/src/api/DevicesApi.js +++ b/src/api/DevicesApi.js @@ -55,7 +55,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -108,7 +108,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -164,7 +164,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/DisputesApi.js b/src/api/DisputesApi.js index d7ea662..264fcd1 100644 --- a/src/api/DisputesApi.js +++ b/src/api/DisputesApi.js @@ -62,7 +62,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -122,7 +122,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -177,7 +177,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -232,7 +232,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -296,7 +296,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -351,7 +351,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -412,7 +412,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -467,7 +467,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/EmployeesApi.js b/src/api/EmployeesApi.js index 7b2e6ed..b228287 100644 --- a/src/api/EmployeesApi.js +++ b/src/api/EmployeesApi.js @@ -59,7 +59,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -118,7 +118,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/InventoryApi.js b/src/api/InventoryApi.js index 6472eab..134b503 100644 --- a/src/api/InventoryApi.js +++ b/src/api/InventoryApi.js @@ -61,7 +61,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -113,7 +113,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -165,7 +165,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -218,7 +218,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -277,7 +277,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -339,7 +339,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -395,7 +395,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/InvoicesApi.js b/src/api/InvoicesApi.js index 26e1eee..4e852de 100644 --- a/src/api/InvoicesApi.js +++ b/src/api/InvoicesApi.js @@ -72,7 +72,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -126,7 +126,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -184,7 +184,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -240,7 +240,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -300,7 +300,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -363,7 +363,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -417,7 +417,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -477,7 +477,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/LaborApi.js b/src/api/LaborApi.js index f97fffa..eddc553 100644 --- a/src/api/LaborApi.js +++ b/src/api/LaborApi.js @@ -73,7 +73,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -125,7 +125,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -178,7 +178,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -231,7 +231,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -284,7 +284,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -339,7 +339,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -392,7 +392,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -445,7 +445,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -499,7 +499,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -558,7 +558,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -615,7 +615,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -670,7 +670,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -724,7 +724,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -783,7 +783,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -843,7 +843,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -903,7 +903,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/LocationsApi.js b/src/api/LocationsApi.js index d9d3ef2..9d673aa 100644 --- a/src/api/LocationsApi.js +++ b/src/api/LocationsApi.js @@ -58,7 +58,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -104,7 +104,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -156,7 +156,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -216,7 +216,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/LoyaltyApi.js b/src/api/LoyaltyApi.js index feebc95..cf1bd39 100644 --- a/src/api/LoyaltyApi.js +++ b/src/api/LoyaltyApi.js @@ -81,7 +81,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -142,7 +142,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -203,7 +203,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -257,7 +257,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -310,7 +310,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -364,7 +364,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -411,7 +411,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -470,7 +470,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -525,7 +525,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -579,7 +579,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -632,7 +632,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -685,7 +685,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -738,7 +738,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/MerchantsApi.js b/src/api/MerchantsApi.js index 5d45009..aad117d 100644 --- a/src/api/MerchantsApi.js +++ b/src/api/MerchantsApi.js @@ -51,7 +51,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -105,7 +105,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/MobileAuthorizationApi.js b/src/api/MobileAuthorizationApi.js index 002d0a0..d5bba58 100644 --- a/src/api/MobileAuthorizationApi.js +++ b/src/api/MobileAuthorizationApi.js @@ -53,7 +53,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/OAuthApi.js b/src/api/OAuthApi.js index d2b13df..457b80b 100644 --- a/src/api/OAuthApi.js +++ b/src/api/OAuthApi.js @@ -38,7 +38,7 @@ module.exports = function(apiClient) { /** * ObtainToken - * Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. + * Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. * @param {module:model/ObtainTokenRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ObtainTokenResponse} and HTTP response */ @@ -57,7 +57,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -76,7 +76,7 @@ module.exports = function(apiClient) { /** * ObtainToken - * Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. + * Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. * @param {module:model/ObtainTokenRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ObtainTokenResponse} */ @@ -118,7 +118,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -152,7 +152,7 @@ module.exports = function(apiClient) { /** * RevokeToken - * Revokes an access token generated with the OAuth flow. If an account has more than one OAuth access token for your application, this endpoint revokes all of them, regardless of which token you specify. When an OAuth access token is revoked, all of the active subscriptions associated with that OAuth token are canceled immediately. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). + * Revokes an access token generated with the OAuth flow. If an account has more than one OAuth access token for your application, this endpoint revokes all of them, regardless of which token you specify. When an OAuth access token is revoked, all of the active subscriptions associated with that OAuth token are canceled immediately. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [Developer Dashboard](https://developer.squareup.com/apps). * @param {module:model/RevokeTokenRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RevokeTokenResponse} and HTTP response */ @@ -171,7 +171,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -190,7 +190,7 @@ module.exports = function(apiClient) { /** * RevokeToken - * Revokes an access token generated with the OAuth flow. If an account has more than one OAuth access token for your application, this endpoint revokes all of them, regardless of which token you specify. When an OAuth access token is revoked, all of the active subscriptions associated with that OAuth token are canceled immediately. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). + * Revokes an access token generated with the OAuth flow. If an account has more than one OAuth access token for your application, this endpoint revokes all of them, regardless of which token you specify. When an OAuth access token is revoked, all of the active subscriptions associated with that OAuth token are canceled immediately. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [Developer Dashboard](https://developer.squareup.com/apps). * @param {module:model/RevokeTokenRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RevokeTokenResponse} */ diff --git a/src/api/OrdersApi.js b/src/api/OrdersApi.js index 5ea222d..4045d13 100644 --- a/src/api/OrdersApi.js +++ b/src/api/OrdersApi.js @@ -64,7 +64,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -117,7 +117,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -169,7 +169,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -229,7 +229,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -283,7 +283,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -335,7 +335,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -395,7 +395,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/PaymentsApi.js b/src/api/PaymentsApi.js index ffd3326..89c0f8d 100644 --- a/src/api/PaymentsApi.js +++ b/src/api/PaymentsApi.js @@ -60,7 +60,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -112,7 +112,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -165,7 +165,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -217,7 +217,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -270,7 +270,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -336,7 +336,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/RefundsApi.js b/src/api/RefundsApi.js index 5d9d3e0..5a18421 100644 --- a/src/api/RefundsApi.js +++ b/src/api/RefundsApi.js @@ -37,7 +37,7 @@ module.exports = function(apiClient) { /** * GetPaymentRefund * Retrieves a specific refund using the `refund_id`. - * @param {String} refundId Unique ID for the desired `PaymentRefund`. + * @param {String} refundId The unique ID for the desired `PaymentRefund`. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetPaymentRefundResponse} and HTTP response */ this.getPaymentRefundWithHttpInfo = function(refundId) { @@ -56,7 +56,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -76,7 +76,7 @@ module.exports = function(apiClient) { /** * GetPaymentRefund * Retrieves a specific refund using the `refund_id`. - * @param {String} refundId Unique ID for the desired `PaymentRefund`. + * @param {String} refundId The unique ID for the desired `PaymentRefund`. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetPaymentRefundResponse} */ this.getPaymentRefund = function(refundId) { @@ -91,14 +91,14 @@ module.exports = function(apiClient) { * ListPaymentRefunds * Retrieves a list of refunds for the account making the request. The maximum results per page is 100. * @param {Object} opts Optional parameters - * @param {String} opts.beginTime Timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. - * @param {String} opts.endTime Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. - * @param {String} opts.sortOrder The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). - * @param {String} opts.cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. - * @param {String} opts.locationId Limit results to the location supplied. By default, results are returned for all locations associated with the merchant. - * @param {String} opts.status If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. - * @param {String} opts.sourceType If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. - * @param {Number} opts.limit Maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. If the supplied value is greater than 100, at most 100 results will be returned. Default: `100` + * @param {String} opts.beginTime The timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. + * @param {String} opts.endTime The timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. + * @param {String} opts.sortOrder The order in which results are listed: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default). + * @param {String} opts.cursor A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination). + * @param {String} opts.locationId Limit results to the location supplied. By default, results are returned for all locations associated with the seller. + * @param {String} opts.status If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted, refunds are returned regardless of their status. + * @param {String} opts.sourceType If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where `CARD` was specified as the payment source. Default: If omitted, refunds are returned regardless of the source type. + * @param {Number} opts.limit The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. If the supplied value is greater than 100, no more than 100 results are returned. Default: 100 * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListPaymentRefundsResponse} and HTTP response */ this.listPaymentRefundsWithHttpInfo = function(opts) { @@ -120,7 +120,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -141,14 +141,14 @@ module.exports = function(apiClient) { * ListPaymentRefunds * Retrieves a list of refunds for the account making the request. The maximum results per page is 100. * @param {Object} opts Optional parameters - * @param {String} opts.beginTime Timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. - * @param {String} opts.endTime Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. - * @param {String} opts.sortOrder The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). - * @param {String} opts.cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. - * @param {String} opts.locationId Limit results to the location supplied. By default, results are returned for all locations associated with the merchant. - * @param {String} opts.status If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. - * @param {String} opts.sourceType If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. - * @param {Number} opts.limit Maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. If the supplied value is greater than 100, at most 100 results will be returned. Default: `100` + * @param {String} opts.beginTime The timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. + * @param {String} opts.endTime The timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. + * @param {String} opts.sortOrder The order in which results are listed: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default). + * @param {String} opts.cursor A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination). + * @param {String} opts.locationId Limit results to the location supplied. By default, results are returned for all locations associated with the seller. + * @param {String} opts.status If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted, refunds are returned regardless of their status. + * @param {String} opts.sourceType If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where `CARD` was specified as the payment source. Default: If omitted, refunds are returned regardless of the source type. + * @param {Number} opts.limit The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. If the supplied value is greater than 100, no more than 100 results are returned. Default: 100 * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListPaymentRefundsResponse} */ this.listPaymentRefunds = function(opts) { @@ -180,7 +180,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/SubscriptionsApi.js b/src/api/SubscriptionsApi.js index 202d04a..c6940b1 100644 --- a/src/api/SubscriptionsApi.js +++ b/src/api/SubscriptionsApi.js @@ -62,7 +62,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -115,7 +115,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -175,7 +175,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -232,7 +232,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -285,7 +285,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -345,7 +345,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/TeamApi.js b/src/api/TeamApi.js index 7b36a79..8e40d95 100644 --- a/src/api/TeamApi.js +++ b/src/api/TeamApi.js @@ -65,7 +65,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -117,7 +117,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -169,7 +169,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -222,7 +222,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -275,7 +275,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -327,7 +327,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -386,7 +386,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -446,7 +446,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/TerminalApi.js b/src/api/TerminalApi.js index da7ed6c..9669d27 100644 --- a/src/api/TerminalApi.js +++ b/src/api/TerminalApi.js @@ -64,7 +64,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -118,7 +118,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -170,7 +170,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -223,7 +223,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -276,7 +276,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -330,7 +330,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -382,7 +382,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -435,7 +435,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/TransactionsApi.js b/src/api/TransactionsApi.js index f2b298e..eb71533 100644 --- a/src/api/TransactionsApi.js +++ b/src/api/TransactionsApi.js @@ -70,7 +70,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -132,7 +132,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -201,7 +201,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -268,7 +268,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -338,7 +338,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -405,7 +405,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -468,7 +468,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/V1EmployeesApi.js b/src/api/V1EmployeesApi.js index 9a168ff..61ad112 100644 --- a/src/api/V1EmployeesApi.js +++ b/src/api/V1EmployeesApi.js @@ -56,7 +56,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -108,7 +108,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -162,7 +162,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -217,7 +217,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -280,7 +280,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -338,7 +338,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -407,7 +407,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -471,7 +471,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -543,7 +543,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -616,7 +616,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -670,7 +670,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -723,7 +723,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -778,7 +778,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -837,7 +837,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -897,7 +897,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -959,7 +959,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/V1ItemsApi.js b/src/api/V1ItemsApi.js index fda14c4..c801c25 100644 --- a/src/api/V1ItemsApi.js +++ b/src/api/V1ItemsApi.js @@ -79,7 +79,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -150,7 +150,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -221,7 +221,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -284,7 +284,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -346,7 +346,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -408,7 +408,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -470,7 +470,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -532,7 +532,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -601,7 +601,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -664,7 +664,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -733,7 +733,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -797,7 +797,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -860,7 +860,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -923,7 +923,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -986,7 +986,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -1049,7 +1049,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -1119,7 +1119,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -1183,7 +1183,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -1252,7 +1252,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -1325,7 +1325,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -1382,7 +1382,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -1437,7 +1437,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -1492,7 +1492,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -1553,7 +1553,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -1615,7 +1615,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -1672,7 +1672,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -1727,7 +1727,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -1796,7 +1796,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -1867,7 +1867,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -1931,7 +1931,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -1994,7 +1994,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -2063,7 +2063,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -2133,7 +2133,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -2203,7 +2203,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -2273,7 +2273,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -2343,7 +2343,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -2420,7 +2420,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -2491,7 +2491,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -2561,7 +2561,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -2638,7 +2638,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/V1LocationsApi.js b/src/api/V1LocationsApi.js index ea1691f..fdb32e6 100644 --- a/src/api/V1LocationsApi.js +++ b/src/api/V1LocationsApi.js @@ -48,7 +48,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -95,7 +95,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/api/V1TransactionsApi.js b/src/api/V1TransactionsApi.js index 2d9407e..1ab1740 100644 --- a/src/api/V1TransactionsApi.js +++ b/src/api/V1TransactionsApi.js @@ -65,7 +65,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -121,7 +121,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -182,7 +182,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -253,7 +253,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -325,7 +325,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -398,7 +398,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -467,7 +467,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -528,7 +528,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -589,7 +589,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -650,7 +650,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; @@ -717,7 +717,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-10-28'; + headerParams['Square-Version'] = '2020-11-18'; var formParams = { }; diff --git a/src/index.js b/src/index.js index d97495f..0e98d96 100644 --- a/src/index.js +++ b/src/index.js @@ -24,6 +24,8 @@ var AdditionalRecipient = require('./model/AdditionalRecipient'); var Address = require('./model/Address'); var AdjustLoyaltyPointsRequest = require('./model/AdjustLoyaltyPointsRequest'); var AdjustLoyaltyPointsResponse = require('./model/AdjustLoyaltyPointsResponse'); +var AppointmentSegment = require('./model/AppointmentSegment'); +var Availability = require('./model/Availability'); var BalancePaymentDetails = require('./model/BalancePaymentDetails'); var BankAccount = require('./model/BankAccount'); var BankAccountStatus = require('./model/BankAccountStatus'); @@ -42,11 +44,21 @@ var BatchRetrieveOrdersRequest = require('./model/BatchRetrieveOrdersRequest'); var BatchRetrieveOrdersResponse = require('./model/BatchRetrieveOrdersResponse'); var BatchUpsertCatalogObjectsRequest = require('./model/BatchUpsertCatalogObjectsRequest'); var BatchUpsertCatalogObjectsResponse = require('./model/BatchUpsertCatalogObjectsResponse'); +var Booking = require('./model/Booking'); +var BookingStatus = require('./model/BookingStatus'); var BreakType = require('./model/BreakType'); var BulkCreateTeamMembersRequest = require('./model/BulkCreateTeamMembersRequest'); var BulkCreateTeamMembersResponse = require('./model/BulkCreateTeamMembersResponse'); var BulkUpdateTeamMembersRequest = require('./model/BulkUpdateTeamMembersRequest'); var BulkUpdateTeamMembersResponse = require('./model/BulkUpdateTeamMembersResponse'); +var BusinessAppointmentSettings = require('./model/BusinessAppointmentSettings'); +var BusinessAppointmentSettingsAlignmentTime = require('./model/BusinessAppointmentSettingsAlignmentTime'); +var BusinessAppointmentSettingsBookingLocationType = require('./model/BusinessAppointmentSettingsBookingLocationType'); +var BusinessAppointmentSettingsCancellationPolicy = require('./model/BusinessAppointmentSettingsCancellationPolicy'); +var BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType = require('./model/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType'); +var BusinessBookingProfile = require('./model/BusinessBookingProfile'); +var BusinessBookingProfileBookingPolicy = require('./model/BusinessBookingProfileBookingPolicy'); +var BusinessBookingProfileCustomerTimezoneChoice = require('./model/BusinessBookingProfileCustomerTimezoneChoice'); var BusinessHours = require('./model/BusinessHours'); var BusinessHoursPeriod = require('./model/BusinessHoursPeriod'); var CalculateLoyaltyPointsRequest = require('./model/CalculateLoyaltyPointsRequest'); @@ -138,15 +150,17 @@ var CatalogV1Id = require('./model/CatalogV1Id'); var ChargeRequest = require('./model/ChargeRequest'); var ChargeRequestAdditionalRecipient = require('./model/ChargeRequestAdditionalRecipient'); var ChargeResponse = require('./model/ChargeResponse'); +var CheckAppointmentsOnboardedRequest = require('./model/CheckAppointmentsOnboardedRequest'); +var CheckAppointmentsOnboardedResponse = require('./model/CheckAppointmentsOnboardedResponse'); var Checkout = require('./model/Checkout'); var CompletePaymentRequest = require('./model/CompletePaymentRequest'); var CompletePaymentResponse = require('./model/CompletePaymentResponse'); var Coordinates = require('./model/Coordinates'); var Country = require('./model/Country'); +var CreateBookingRequest = require('./model/CreateBookingRequest'); +var CreateBookingResponse = require('./model/CreateBookingResponse'); var CreateBreakTypeRequest = require('./model/CreateBreakTypeRequest'); var CreateBreakTypeResponse = require('./model/CreateBreakTypeResponse'); -var CreateCatalogImageRequest = require('./model/CreateCatalogImageRequest'); -var CreateCatalogImageResponse = require('./model/CreateCatalogImageResponse'); var CreateCheckoutRequest = require('./model/CreateCheckoutRequest'); var CreateCheckoutResponse = require('./model/CreateCheckoutResponse'); var CreateCustomerCardRequest = require('./model/CreateCustomerCardRequest'); @@ -157,8 +171,6 @@ var CreateCustomerRequest = require('./model/CreateCustomerRequest'); var CreateCustomerResponse = require('./model/CreateCustomerResponse'); var CreateDeviceCodeRequest = require('./model/CreateDeviceCodeRequest'); var CreateDeviceCodeResponse = require('./model/CreateDeviceCodeResponse'); -var CreateDisputeEvidenceFileRequest = require('./model/CreateDisputeEvidenceFileRequest'); -var CreateDisputeEvidenceFileResponse = require('./model/CreateDisputeEvidenceFileResponse'); var CreateDisputeEvidenceTextRequest = require('./model/CreateDisputeEvidenceTextRequest'); var CreateDisputeEvidenceTextResponse = require('./model/CreateDisputeEvidenceTextResponse'); var CreateInvoiceRequest = require('./model/CreateInvoiceRequest'); @@ -331,6 +343,8 @@ var ListRefundsRequest = require('./model/ListRefundsRequest'); var ListRefundsResponse = require('./model/ListRefundsResponse'); var ListSubscriptionEventsRequest = require('./model/ListSubscriptionEventsRequest'); var ListSubscriptionEventsResponse = require('./model/ListSubscriptionEventsResponse'); +var ListTeamMemberBookingProfilesRequest = require('./model/ListTeamMemberBookingProfilesRequest'); +var ListTeamMemberBookingProfilesResponse = require('./model/ListTeamMemberBookingProfilesResponse'); var ListTeamMemberWagesRequest = require('./model/ListTeamMemberWagesRequest'); var ListTeamMemberWagesResponse = require('./model/ListTeamMemberWagesResponse'); var ListTransactionsRequest = require('./model/ListTransactionsRequest'); @@ -388,6 +402,8 @@ var ModelBreak = require('./model/ModelBreak'); var Money = require('./model/Money'); var ObtainTokenRequest = require('./model/ObtainTokenRequest'); var ObtainTokenResponse = require('./model/ObtainTokenResponse'); +var OnboardAppointmentsRequest = require('./model/OnboardAppointmentsRequest'); +var OnboardAppointmentsResponse = require('./model/OnboardAppointmentsResponse'); var Order = require('./model/Order'); var OrderCreated = require('./model/OrderCreated'); var OrderCreatedObject = require('./model/OrderCreatedObject'); @@ -456,6 +472,10 @@ var RemoveGroupFromCustomerRequest = require('./model/RemoveGroupFromCustomerReq var RemoveGroupFromCustomerResponse = require('./model/RemoveGroupFromCustomerResponse'); var RenewTokenRequest = require('./model/RenewTokenRequest'); var RenewTokenResponse = require('./model/RenewTokenResponse'); +var RetrieveBookingRequest = require('./model/RetrieveBookingRequest'); +var RetrieveBookingResponse = require('./model/RetrieveBookingResponse'); +var RetrieveBusinessBookingProfileRequest = require('./model/RetrieveBusinessBookingProfileRequest'); +var RetrieveBusinessBookingProfileResponse = require('./model/RetrieveBusinessBookingProfileResponse'); var RetrieveCashDrawerShiftRequest = require('./model/RetrieveCashDrawerShiftRequest'); var RetrieveCashDrawerShiftResponse = require('./model/RetrieveCashDrawerShiftResponse'); var RetrieveCatalogObjectRequest = require('./model/RetrieveCatalogObjectRequest'); @@ -488,10 +508,14 @@ var RetrieveLoyaltyRewardRequest = require('./model/RetrieveLoyaltyRewardRequest var RetrieveLoyaltyRewardResponse = require('./model/RetrieveLoyaltyRewardResponse'); var RetrieveMerchantRequest = require('./model/RetrieveMerchantRequest'); var RetrieveMerchantResponse = require('./model/RetrieveMerchantResponse'); +var RetrieveObsMigrationProfileRequest = require('./model/RetrieveObsMigrationProfileRequest'); +var RetrieveObsMigrationProfileResponse = require('./model/RetrieveObsMigrationProfileResponse'); var RetrieveOrderRequest = require('./model/RetrieveOrderRequest'); var RetrieveOrderResponse = require('./model/RetrieveOrderResponse'); var RetrieveSubscriptionRequest = require('./model/RetrieveSubscriptionRequest'); var RetrieveSubscriptionResponse = require('./model/RetrieveSubscriptionResponse'); +var RetrieveTeamMemberBookingProfileRequest = require('./model/RetrieveTeamMemberBookingProfileRequest'); +var RetrieveTeamMemberBookingProfileResponse = require('./model/RetrieveTeamMemberBookingProfileResponse'); var RetrieveTeamMemberRequest = require('./model/RetrieveTeamMemberRequest'); var RetrieveTeamMemberResponse = require('./model/RetrieveTeamMemberResponse'); var RetrieveTransactionRequest = require('./model/RetrieveTransactionRequest'); @@ -500,6 +524,12 @@ var RetrieveWageSettingRequest = require('./model/RetrieveWageSettingRequest'); var RetrieveWageSettingResponse = require('./model/RetrieveWageSettingResponse'); var RevokeTokenRequest = require('./model/RevokeTokenRequest'); var RevokeTokenResponse = require('./model/RevokeTokenResponse'); +var RiskEvaluation = require('./model/RiskEvaluation'); +var RiskEvaluationRiskLevel = require('./model/RiskEvaluationRiskLevel'); +var SearchAvailabilityFilter = require('./model/SearchAvailabilityFilter'); +var SearchAvailabilityQuery = require('./model/SearchAvailabilityQuery'); +var SearchAvailabilityRequest = require('./model/SearchAvailabilityRequest'); +var SearchAvailabilityResponse = require('./model/SearchAvailabilityResponse'); var SearchCatalogItemsRequest = require('./model/SearchCatalogItemsRequest'); var SearchCatalogItemsRequestStockLevel = require('./model/SearchCatalogItemsRequestStockLevel'); var SearchCatalogItemsResponse = require('./model/SearchCatalogItemsResponse'); @@ -542,6 +572,7 @@ var SearchTerminalCheckoutsRequest = require('./model/SearchTerminalCheckoutsReq var SearchTerminalCheckoutsResponse = require('./model/SearchTerminalCheckoutsResponse'); var SearchTerminalRefundsRequest = require('./model/SearchTerminalRefundsRequest'); var SearchTerminalRefundsResponse = require('./model/SearchTerminalRefundsResponse'); +var SegmentFilter = require('./model/SegmentFilter'); var Shift = require('./model/Shift'); var ShiftFilter = require('./model/ShiftFilter'); var ShiftFilterStatus = require('./model/ShiftFilterStatus'); @@ -569,6 +600,7 @@ var TaxInclusionType = require('./model/TaxInclusionType'); var TeamMember = require('./model/TeamMember'); var TeamMemberAssignedLocations = require('./model/TeamMemberAssignedLocations'); var TeamMemberAssignedLocationsAssignmentType = require('./model/TeamMemberAssignedLocationsAssignmentType'); +var TeamMemberBookingProfile = require('./model/TeamMemberBookingProfile'); var TeamMemberStatus = require('./model/TeamMemberStatus'); var TeamMemberWage = require('./model/TeamMemberWage'); var Tender = require('./model/Tender'); @@ -590,6 +622,8 @@ var TipSettings = require('./model/TipSettings'); var Transaction = require('./model/Transaction'); var TransactionProduct = require('./model/TransactionProduct'); var TransactionType = require('./model/TransactionType'); +var UpdateBookingRequest = require('./model/UpdateBookingRequest'); +var UpdateBookingResponse = require('./model/UpdateBookingResponse'); var UpdateBreakTypeRequest = require('./model/UpdateBreakTypeRequest'); var UpdateBreakTypeResponse = require('./model/UpdateBreakTypeResponse'); var UpdateCustomerGroupRequest = require('./model/UpdateCustomerGroupRequest'); @@ -778,7 +812,6 @@ var V1UpdateVariationRequest = require('./model/V1UpdateVariationRequest'); var V1Variation = require('./model/V1Variation'); var V1VariationInventoryAlertType = require('./model/V1VariationInventoryAlertType'); var V1VariationPricingType = require('./model/V1VariationPricingType'); -var VersionedCatalogObject = require('./model/VersionedCatalogObject'); var VoidTransactionRequest = require('./model/VoidTransactionRequest'); var VoidTransactionResponse = require('./model/VoidTransactionResponse'); var WageSetting = require('./model/WageSetting'); @@ -787,6 +820,7 @@ var WorkweekConfig = require('./model/WorkweekConfig'); var ApplePayApi = require('./api/ApplePayApi'); var BankAccountsApi = require('./api/BankAccountsApi'); +var BookingsApi = require('./api/BookingsApi'); var CashDrawersApi = require('./api/CashDrawersApi'); var CatalogApi = require('./api/CatalogApi'); var CheckoutApi = require('./api/CheckoutApi'); @@ -846,7 +880,7 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * *

* @module index - * @version 4.20201028.5 + * @version 5.20201118.0 */ module.exports = { /** @@ -909,6 +943,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/AdjustLoyaltyPointsResponse} */ AdjustLoyaltyPointsResponse: AdjustLoyaltyPointsResponse, + /** + * The AppointmentSegment model constructor. + * @property {module:model/AppointmentSegment} + */ + AppointmentSegment: AppointmentSegment, + /** + * The Availability model constructor. + * @property {module:model/Availability} + */ + Availability: Availability, /** * The BalancePaymentDetails model constructor. * @property {module:model/BalancePaymentDetails} @@ -999,6 +1043,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/BatchUpsertCatalogObjectsResponse} */ BatchUpsertCatalogObjectsResponse: BatchUpsertCatalogObjectsResponse, + /** + * The Booking model constructor. + * @property {module:model/Booking} + */ + Booking: Booking, + /** + * The BookingStatus model constructor. + * @property {module:model/BookingStatus} + */ + BookingStatus: BookingStatus, /** * The BreakType model constructor. * @property {module:model/BreakType} @@ -1024,6 +1078,46 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/BulkUpdateTeamMembersResponse} */ BulkUpdateTeamMembersResponse: BulkUpdateTeamMembersResponse, + /** + * The BusinessAppointmentSettings model constructor. + * @property {module:model/BusinessAppointmentSettings} + */ + BusinessAppointmentSettings: BusinessAppointmentSettings, + /** + * The BusinessAppointmentSettingsAlignmentTime model constructor. + * @property {module:model/BusinessAppointmentSettingsAlignmentTime} + */ + BusinessAppointmentSettingsAlignmentTime: BusinessAppointmentSettingsAlignmentTime, + /** + * The BusinessAppointmentSettingsBookingLocationType model constructor. + * @property {module:model/BusinessAppointmentSettingsBookingLocationType} + */ + BusinessAppointmentSettingsBookingLocationType: BusinessAppointmentSettingsBookingLocationType, + /** + * The BusinessAppointmentSettingsCancellationPolicy model constructor. + * @property {module:model/BusinessAppointmentSettingsCancellationPolicy} + */ + BusinessAppointmentSettingsCancellationPolicy: BusinessAppointmentSettingsCancellationPolicy, + /** + * The BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType model constructor. + * @property {module:model/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType} + */ + BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType: BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType, + /** + * The BusinessBookingProfile model constructor. + * @property {module:model/BusinessBookingProfile} + */ + BusinessBookingProfile: BusinessBookingProfile, + /** + * The BusinessBookingProfileBookingPolicy model constructor. + * @property {module:model/BusinessBookingProfileBookingPolicy} + */ + BusinessBookingProfileBookingPolicy: BusinessBookingProfileBookingPolicy, + /** + * The BusinessBookingProfileCustomerTimezoneChoice model constructor. + * @property {module:model/BusinessBookingProfileCustomerTimezoneChoice} + */ + BusinessBookingProfileCustomerTimezoneChoice: BusinessBookingProfileCustomerTimezoneChoice, /** * The BusinessHours model constructor. * @property {module:model/BusinessHours} @@ -1479,6 +1573,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/ChargeResponse} */ ChargeResponse: ChargeResponse, + /** + * The CheckAppointmentsOnboardedRequest model constructor. + * @property {module:model/CheckAppointmentsOnboardedRequest} + */ + CheckAppointmentsOnboardedRequest: CheckAppointmentsOnboardedRequest, + /** + * The CheckAppointmentsOnboardedResponse model constructor. + * @property {module:model/CheckAppointmentsOnboardedResponse} + */ + CheckAppointmentsOnboardedResponse: CheckAppointmentsOnboardedResponse, /** * The Checkout model constructor. * @property {module:model/Checkout} @@ -1504,6 +1608,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/Country} */ Country: Country, + /** + * The CreateBookingRequest model constructor. + * @property {module:model/CreateBookingRequest} + */ + CreateBookingRequest: CreateBookingRequest, + /** + * The CreateBookingResponse model constructor. + * @property {module:model/CreateBookingResponse} + */ + CreateBookingResponse: CreateBookingResponse, /** * The CreateBreakTypeRequest model constructor. * @property {module:model/CreateBreakTypeRequest} @@ -1514,16 +1628,6 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/CreateBreakTypeResponse} */ CreateBreakTypeResponse: CreateBreakTypeResponse, - /** - * The CreateCatalogImageRequest model constructor. - * @property {module:model/CreateCatalogImageRequest} - */ - CreateCatalogImageRequest: CreateCatalogImageRequest, - /** - * The CreateCatalogImageResponse model constructor. - * @property {module:model/CreateCatalogImageResponse} - */ - CreateCatalogImageResponse: CreateCatalogImageResponse, /** * The CreateCheckoutRequest model constructor. * @property {module:model/CreateCheckoutRequest} @@ -1574,16 +1678,6 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/CreateDeviceCodeResponse} */ CreateDeviceCodeResponse: CreateDeviceCodeResponse, - /** - * The CreateDisputeEvidenceFileRequest model constructor. - * @property {module:model/CreateDisputeEvidenceFileRequest} - */ - CreateDisputeEvidenceFileRequest: CreateDisputeEvidenceFileRequest, - /** - * The CreateDisputeEvidenceFileResponse model constructor. - * @property {module:model/CreateDisputeEvidenceFileResponse} - */ - CreateDisputeEvidenceFileResponse: CreateDisputeEvidenceFileResponse, /** * The CreateDisputeEvidenceTextRequest model constructor. * @property {module:model/CreateDisputeEvidenceTextRequest} @@ -2444,6 +2538,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/ListSubscriptionEventsResponse} */ ListSubscriptionEventsResponse: ListSubscriptionEventsResponse, + /** + * The ListTeamMemberBookingProfilesRequest model constructor. + * @property {module:model/ListTeamMemberBookingProfilesRequest} + */ + ListTeamMemberBookingProfilesRequest: ListTeamMemberBookingProfilesRequest, + /** + * The ListTeamMemberBookingProfilesResponse model constructor. + * @property {module:model/ListTeamMemberBookingProfilesResponse} + */ + ListTeamMemberBookingProfilesResponse: ListTeamMemberBookingProfilesResponse, /** * The ListTeamMemberWagesRequest model constructor. * @property {module:model/ListTeamMemberWagesRequest} @@ -2729,6 +2833,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/ObtainTokenResponse} */ ObtainTokenResponse: ObtainTokenResponse, + /** + * The OnboardAppointmentsRequest model constructor. + * @property {module:model/OnboardAppointmentsRequest} + */ + OnboardAppointmentsRequest: OnboardAppointmentsRequest, + /** + * The OnboardAppointmentsResponse model constructor. + * @property {module:model/OnboardAppointmentsResponse} + */ + OnboardAppointmentsResponse: OnboardAppointmentsResponse, /** * The Order model constructor. * @property {module:model/Order} @@ -3069,6 +3183,26 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/RenewTokenResponse} */ RenewTokenResponse: RenewTokenResponse, + /** + * The RetrieveBookingRequest model constructor. + * @property {module:model/RetrieveBookingRequest} + */ + RetrieveBookingRequest: RetrieveBookingRequest, + /** + * The RetrieveBookingResponse model constructor. + * @property {module:model/RetrieveBookingResponse} + */ + RetrieveBookingResponse: RetrieveBookingResponse, + /** + * The RetrieveBusinessBookingProfileRequest model constructor. + * @property {module:model/RetrieveBusinessBookingProfileRequest} + */ + RetrieveBusinessBookingProfileRequest: RetrieveBusinessBookingProfileRequest, + /** + * The RetrieveBusinessBookingProfileResponse model constructor. + * @property {module:model/RetrieveBusinessBookingProfileResponse} + */ + RetrieveBusinessBookingProfileResponse: RetrieveBusinessBookingProfileResponse, /** * The RetrieveCashDrawerShiftRequest model constructor. * @property {module:model/RetrieveCashDrawerShiftRequest} @@ -3229,6 +3363,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/RetrieveMerchantResponse} */ RetrieveMerchantResponse: RetrieveMerchantResponse, + /** + * The RetrieveObsMigrationProfileRequest model constructor. + * @property {module:model/RetrieveObsMigrationProfileRequest} + */ + RetrieveObsMigrationProfileRequest: RetrieveObsMigrationProfileRequest, + /** + * The RetrieveObsMigrationProfileResponse model constructor. + * @property {module:model/RetrieveObsMigrationProfileResponse} + */ + RetrieveObsMigrationProfileResponse: RetrieveObsMigrationProfileResponse, /** * The RetrieveOrderRequest model constructor. * @property {module:model/RetrieveOrderRequest} @@ -3249,6 +3393,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/RetrieveSubscriptionResponse} */ RetrieveSubscriptionResponse: RetrieveSubscriptionResponse, + /** + * The RetrieveTeamMemberBookingProfileRequest model constructor. + * @property {module:model/RetrieveTeamMemberBookingProfileRequest} + */ + RetrieveTeamMemberBookingProfileRequest: RetrieveTeamMemberBookingProfileRequest, + /** + * The RetrieveTeamMemberBookingProfileResponse model constructor. + * @property {module:model/RetrieveTeamMemberBookingProfileResponse} + */ + RetrieveTeamMemberBookingProfileResponse: RetrieveTeamMemberBookingProfileResponse, /** * The RetrieveTeamMemberRequest model constructor. * @property {module:model/RetrieveTeamMemberRequest} @@ -3289,6 +3443,36 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/RevokeTokenResponse} */ RevokeTokenResponse: RevokeTokenResponse, + /** + * The RiskEvaluation model constructor. + * @property {module:model/RiskEvaluation} + */ + RiskEvaluation: RiskEvaluation, + /** + * The RiskEvaluationRiskLevel model constructor. + * @property {module:model/RiskEvaluationRiskLevel} + */ + RiskEvaluationRiskLevel: RiskEvaluationRiskLevel, + /** + * The SearchAvailabilityFilter model constructor. + * @property {module:model/SearchAvailabilityFilter} + */ + SearchAvailabilityFilter: SearchAvailabilityFilter, + /** + * The SearchAvailabilityQuery model constructor. + * @property {module:model/SearchAvailabilityQuery} + */ + SearchAvailabilityQuery: SearchAvailabilityQuery, + /** + * The SearchAvailabilityRequest model constructor. + * @property {module:model/SearchAvailabilityRequest} + */ + SearchAvailabilityRequest: SearchAvailabilityRequest, + /** + * The SearchAvailabilityResponse model constructor. + * @property {module:model/SearchAvailabilityResponse} + */ + SearchAvailabilityResponse: SearchAvailabilityResponse, /** * The SearchCatalogItemsRequest model constructor. * @property {module:model/SearchCatalogItemsRequest} @@ -3499,6 +3683,11 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/SearchTerminalRefundsResponse} */ SearchTerminalRefundsResponse: SearchTerminalRefundsResponse, + /** + * The SegmentFilter model constructor. + * @property {module:model/SegmentFilter} + */ + SegmentFilter: SegmentFilter, /** * The Shift model constructor. * @property {module:model/Shift} @@ -3634,6 +3823,11 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/TeamMemberAssignedLocationsAssignmentType} */ TeamMemberAssignedLocationsAssignmentType: TeamMemberAssignedLocationsAssignmentType, + /** + * The TeamMemberBookingProfile model constructor. + * @property {module:model/TeamMemberBookingProfile} + */ + TeamMemberBookingProfile: TeamMemberBookingProfile, /** * The TeamMemberStatus model constructor. * @property {module:model/TeamMemberStatus} @@ -3739,6 +3933,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/TransactionType} */ TransactionType: TransactionType, + /** + * The UpdateBookingRequest model constructor. + * @property {module:model/UpdateBookingRequest} + */ + UpdateBookingRequest: UpdateBookingRequest, + /** + * The UpdateBookingResponse model constructor. + * @property {module:model/UpdateBookingResponse} + */ + UpdateBookingResponse: UpdateBookingResponse, /** * The UpdateBreakTypeRequest model constructor. * @property {module:model/UpdateBreakTypeRequest} @@ -4679,11 +4883,6 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/V1VariationPricingType} */ V1VariationPricingType: V1VariationPricingType, - /** - * The VersionedCatalogObject model constructor. - * @property {module:model/VersionedCatalogObject} - */ - VersionedCatalogObject: VersionedCatalogObject, /** * The VoidTransactionRequest model constructor. * @property {module:model/VoidTransactionRequest} @@ -4719,6 +4918,11 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:api/BankAccountsApi} */ BankAccountsApi: BankAccountsApi, + /** + * The BookingsApi service constructor. + * @property {module:api/BookingsApi} + */ + BookingsApi: BookingsApi, /** * The CashDrawersApi service constructor. * @property {module:api/CashDrawersApi} diff --git a/src/model/AppointmentSegment.js b/src/model/AppointmentSegment.js new file mode 100644 index 0000000..d0881fe --- /dev/null +++ b/src/model/AppointmentSegment.js @@ -0,0 +1,97 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); + + + + +/** + * The AppointmentSegment model module. + * Note: This model is in beta. + * @module model/AppointmentSegment + */ + +/** + * Constructs a new AppointmentSegment. + * Defines an appointment segment of a booking. + * @alias module:model/AppointmentSegment + * @class + * @param durationMinutes {Number} The time span in minutes of an appointment segment. + * @param serviceVariationId {String} The ID of the `CatalogItemVariation` object representing the service booked in this segment. + * @param teamMemberId {String} The ID of the `TeamMember` object representing the team member booked in this segment. + * @param serviceVariationVersion {Number} The current version of the item variation representing the service booked in this segment. + */ +var exports = function(durationMinutes, serviceVariationId, teamMemberId, serviceVariationVersion) { + var _this = this; + + _this['duration_minutes'] = durationMinutes; + _this['service_variation_id'] = serviceVariationId; + _this['team_member_id'] = teamMemberId; + _this['service_variation_version'] = serviceVariationVersion; +}; + +/** + * Constructs a AppointmentSegment from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/AppointmentSegment} obj Optional instance to populate. + * @return {module:model/AppointmentSegment} The populated AppointmentSegment instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('duration_minutes')) { + obj['duration_minutes'] = ApiClient.convertToType(data['duration_minutes'], 'Number'); + } + if (data.hasOwnProperty('service_variation_id')) { + obj['service_variation_id'] = ApiClient.convertToType(data['service_variation_id'], 'String'); + } + if (data.hasOwnProperty('team_member_id')) { + obj['team_member_id'] = ApiClient.convertToType(data['team_member_id'], 'String'); + } + if (data.hasOwnProperty('service_variation_version')) { + obj['service_variation_version'] = ApiClient.convertToType(data['service_variation_version'], 'Number'); + } + } + return obj; +} + +/** + * The time span in minutes of an appointment segment. + * @member {Number} duration_minutes + */ +exports.prototype['duration_minutes'] = undefined; +/** + * The ID of the `CatalogItemVariation` object representing the service booked in this segment. + * @member {String} service_variation_id + */ +exports.prototype['service_variation_id'] = undefined; +/** + * The ID of the `TeamMember` object representing the team member booked in this segment. + * @member {String} team_member_id + */ +exports.prototype['team_member_id'] = undefined; +/** + * The current version of the item variation representing the service booked in this segment. + * @member {Number} service_variation_version + */ +exports.prototype['service_variation_version'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/Availability.js b/src/model/Availability.js new file mode 100644 index 0000000..5d71758 --- /dev/null +++ b/src/model/Availability.js @@ -0,0 +1,85 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var AppointmentSegment = require('./AppointmentSegment'); + + + + +/** + * The Availability model module. + * Note: This model is in beta. + * @module model/Availability + */ + +/** + * Constructs a new Availability. + * Describes a slot available for booking, encapsulating appointment segments, the location and starting time. + * @alias module:model/Availability + * @class + */ +var exports = function() { + var _this = this; + + + + +}; + +/** + * Constructs a Availability from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/Availability} obj Optional instance to populate. + * @return {module:model/Availability} The populated Availability instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('start_at')) { + obj['start_at'] = ApiClient.convertToType(data['start_at'], 'String'); + } + if (data.hasOwnProperty('location_id')) { + obj['location_id'] = ApiClient.convertToType(data['location_id'], 'String'); + } + if (data.hasOwnProperty('appointment_segments')) { + obj['appointment_segments'] = ApiClient.convertToType(data['appointment_segments'], [AppointmentSegment]); + } + } + return obj; +} + +/** + * The RFC-3339 timestamp specifying the beginning time of the slot available for booking. + * @member {String} start_at + */ +exports.prototype['start_at'] = undefined; +/** + * The ID of the location available for booking. + * @member {String} location_id + */ +exports.prototype['location_id'] = undefined; +/** + * The list of appointment segments available for booking + * @member {Array.} appointment_segments + */ +exports.prototype['appointment_segments'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/BalancePaymentDetails.js b/src/model/BalancePaymentDetails.js index 1dd04c5..46bd29d 100644 --- a/src/model/BalancePaymentDetails.js +++ b/src/model/BalancePaymentDetails.js @@ -56,12 +56,12 @@ exports.constructFromObject = function(data, obj) { } /** - * ID for the account used to fund the payment. + * The ID of the account used to fund the payment. * @member {String} account_id */ exports.prototype['account_id'] = undefined; /** - * The balance payment’s current state. Can be `COMPLETED` or `FAILED`. + * The balance payment’s current state. The state can be COMPLETED or FAILED. * @member {String} status */ exports.prototype['status'] = undefined; diff --git a/src/model/Booking.js b/src/model/Booking.js new file mode 100644 index 0000000..3c27bc2 --- /dev/null +++ b/src/model/Booking.js @@ -0,0 +1,157 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var AppointmentSegment = require('./AppointmentSegment'); + + + + +/** + * The Booking model module. + * Note: This model is in beta. + * @module model/Booking + */ + +/** + * Constructs a new Booking. + * Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service at a given location to a requesting customer in one or more appointment segments. + * @alias module:model/Booking + * @class + */ +var exports = function() { + var _this = this; + + + + + + + + + + + + +}; + +/** + * Constructs a Booking from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/Booking} obj Optional instance to populate. + * @return {module:model/Booking} The populated Booking instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('id')) { + obj['id'] = ApiClient.convertToType(data['id'], 'String'); + } + if (data.hasOwnProperty('version')) { + obj['version'] = ApiClient.convertToType(data['version'], 'Number'); + } + if (data.hasOwnProperty('status')) { + obj['status'] = ApiClient.convertToType(data['status'], 'String'); + } + if (data.hasOwnProperty('created_at')) { + obj['created_at'] = ApiClient.convertToType(data['created_at'], 'String'); + } + if (data.hasOwnProperty('updated_at')) { + obj['updated_at'] = ApiClient.convertToType(data['updated_at'], 'String'); + } + if (data.hasOwnProperty('start_at')) { + obj['start_at'] = ApiClient.convertToType(data['start_at'], 'String'); + } + if (data.hasOwnProperty('location_id')) { + obj['location_id'] = ApiClient.convertToType(data['location_id'], 'String'); + } + if (data.hasOwnProperty('customer_id')) { + obj['customer_id'] = ApiClient.convertToType(data['customer_id'], 'String'); + } + if (data.hasOwnProperty('customer_note')) { + obj['customer_note'] = ApiClient.convertToType(data['customer_note'], 'String'); + } + if (data.hasOwnProperty('seller_note')) { + obj['seller_note'] = ApiClient.convertToType(data['seller_note'], 'String'); + } + if (data.hasOwnProperty('appointment_segments')) { + obj['appointment_segments'] = ApiClient.convertToType(data['appointment_segments'], [AppointmentSegment]); + } + } + return obj; +} + +/** + * A unique ID of this object representing a booking. + * @member {String} id + */ +exports.prototype['id'] = undefined; +/** + * The revision number for the booking used for optimistic concurrency. + * @member {Number} version + */ +exports.prototype['version'] = undefined; +/** + * The status of the booking, describing where the booking stands with respect to the booking state machine. See [BookingStatus](#type-bookingstatus) for possible values + * @member {String} status + */ +exports.prototype['status'] = undefined; +/** + * The timestamp specifying the creation time of this booking. + * @member {String} created_at + */ +exports.prototype['created_at'] = undefined; +/** + * The timestamp specifying the most recent update time of this booking. + * @member {String} updated_at + */ +exports.prototype['updated_at'] = undefined; +/** + * The timestamp specifying the starting time of this booking. + * @member {String} start_at + */ +exports.prototype['start_at'] = undefined; +/** + * The ID of the `Location` object representing the location where the booked service is provided. + * @member {String} location_id + */ +exports.prototype['location_id'] = undefined; +/** + * The ID of the `Customer` object representing the customer attending this booking + * @member {String} customer_id + */ +exports.prototype['customer_id'] = undefined; +/** + * The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant `CatalogObject` instance. + * @member {String} customer_note + */ +exports.prototype['customer_note'] = undefined; +/** + * The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific `CatalogObject` instance. This field should not be visible to customers. + * @member {String} seller_note + */ +exports.prototype['seller_note'] = undefined; +/** + * A list of appointment segments for this booking. + * @member {Array.} appointment_segments + */ +exports.prototype['appointment_segments'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/BookingStatus.js b/src/model/BookingStatus.js new file mode 100644 index 0000000..834a59f --- /dev/null +++ b/src/model/BookingStatus.js @@ -0,0 +1,65 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); + + +/** + * Enum class BookingStatus. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "PENDING" + * @const + */ + "PENDING": "PENDING", + /** + * value: "CANCELLED_BY_CUSTOMER" + * @const + */ + "CANCELLED_BY_CUSTOMER": "CANCELLED_BY_CUSTOMER", + /** + * value: "CANCELLED_BY_SELLER" + * @const + */ + "CANCELLED_BY_SELLER": "CANCELLED_BY_SELLER", + /** + * value: "DECLINED" + * @const + */ + "DECLINED": "DECLINED", + /** + * value: "ACCEPTED" + * @const + */ + "ACCEPTED": "ACCEPTED", + /** + * value: "NO_SHOW" + * @const + */ + "NO_SHOW": "NO_SHOW"}; + +/** + * Returns a BookingStatus enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/BookingStatus} The enum BookingStatus value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/BusinessAppointmentSettings.js b/src/model/BusinessAppointmentSettings.js new file mode 100644 index 0000000..226974d --- /dev/null +++ b/src/model/BusinessAppointmentSettings.js @@ -0,0 +1,179 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var AlignmentTime = require('./BusinessAppointmentSettingsAlignmentTime'); +var BookingLocationType = require('./BusinessAppointmentSettingsBookingLocationType'); +var CancellationPolicy = require('./BusinessAppointmentSettingsCancellationPolicy'); +var MaxAppointmentsPerDayLimitType = require('./BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType'); +var Money = require('./Money'); + + + + +/** + * The BusinessAppointmentSettings model module. + * Note: This model is in beta. + * @module model/BusinessAppointmentSettings + */ + +/** + * Constructs a new BusinessAppointmentSettings. + * The service appointment settings, including where and how the service is provided. + * @alias module:model/BusinessAppointmentSettings + * @class + */ +var exports = function() { + var _this = this; + + + + + + + + + + + + + + +}; + +/** + * Constructs a BusinessAppointmentSettings from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/BusinessAppointmentSettings} obj Optional instance to populate. + * @return {module:model/BusinessAppointmentSettings} The populated BusinessAppointmentSettings instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('location_types')) { + obj['location_types'] = ApiClient.convertToType(data['location_types'], [BookingLocationType]); + } + if (data.hasOwnProperty('alignment_time')) { + obj['alignment_time'] = AlignmentTime.constructFromObject(data['alignment_time']); + } + if (data.hasOwnProperty('min_booking_lead_time_seconds')) { + obj['min_booking_lead_time_seconds'] = ApiClient.convertToType(data['min_booking_lead_time_seconds'], 'Number'); + } + if (data.hasOwnProperty('max_booking_lead_time_seconds')) { + obj['max_booking_lead_time_seconds'] = ApiClient.convertToType(data['max_booking_lead_time_seconds'], 'Number'); + } + if (data.hasOwnProperty('any_team_member_booking_enabled')) { + obj['any_team_member_booking_enabled'] = ApiClient.convertToType(data['any_team_member_booking_enabled'], 'Boolean'); + } + if (data.hasOwnProperty('multiple_service_booking_enabled')) { + obj['multiple_service_booking_enabled'] = ApiClient.convertToType(data['multiple_service_booking_enabled'], 'Boolean'); + } + if (data.hasOwnProperty('max_appointments_per_day_limit_type')) { + obj['max_appointments_per_day_limit_type'] = MaxAppointmentsPerDayLimitType.constructFromObject(data['max_appointments_per_day_limit_type']); + } + if (data.hasOwnProperty('max_appointments_per_day_limit')) { + obj['max_appointments_per_day_limit'] = ApiClient.convertToType(data['max_appointments_per_day_limit'], 'Number'); + } + if (data.hasOwnProperty('cancellation_window_seconds')) { + obj['cancellation_window_seconds'] = ApiClient.convertToType(data['cancellation_window_seconds'], 'Number'); + } + if (data.hasOwnProperty('cancellation_fee_money')) { + obj['cancellation_fee_money'] = Money.constructFromObject(data['cancellation_fee_money']); + } + if (data.hasOwnProperty('cancellation_policy')) { + obj['cancellation_policy'] = CancellationPolicy.constructFromObject(data['cancellation_policy']); + } + if (data.hasOwnProperty('cancellation_policy_text')) { + obj['cancellation_policy_text'] = ApiClient.convertToType(data['cancellation_policy_text'], 'String'); + } + if (data.hasOwnProperty('skip_booking_flow_staff_selection')) { + obj['skip_booking_flow_staff_selection'] = ApiClient.convertToType(data['skip_booking_flow_staff_selection'], 'Boolean'); + } + } + return obj; +} + +/** + * Types of the location allowed for bookings. + * @member {Array.} location_types + */ +exports.prototype['location_types'] = undefined; +/** + * The time unit of the service duration for bookings. + * @member {module:model/BusinessAppointmentSettingsAlignmentTime} alignment_time + */ +exports.prototype['alignment_time'] = undefined; +/** + * The minimum lead time in seconds before a service can be booked. Bookings must be created at least this far ahead of the booking's starting time. + * @member {Number} min_booking_lead_time_seconds + */ +exports.prototype['min_booking_lead_time_seconds'] = undefined; +/** + * The maximum lead time in seconds before a service can be booked. Bookings must be created at most this far ahead of the booking's starting time. + * @member {Number} max_booking_lead_time_seconds + */ +exports.prototype['max_booking_lead_time_seconds'] = undefined; +/** + * Indicates whether a customer can choose from all available time slots and have a staff member assigned automatically (`true`) or not (`false`). + * @member {Boolean} any_team_member_booking_enabled + */ +exports.prototype['any_team_member_booking_enabled'] = undefined; +/** + * Indicates whether a customer can book multiple services in a single online booking. + * @member {Boolean} multiple_service_booking_enabled + */ +exports.prototype['multiple_service_booking_enabled'] = undefined; +/** + * Indicates whether the daily appointment limit applies to team members or to business locations. + * @member {module:model/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType} max_appointments_per_day_limit_type + */ +exports.prototype['max_appointments_per_day_limit_type'] = undefined; +/** + * The maximum number of daily appointments per team member or per location. + * @member {Number} max_appointments_per_day_limit + */ +exports.prototype['max_appointments_per_day_limit'] = undefined; +/** + * The cut-off time in seconds for allowing clients to cancel or reschedule an appointment. + * @member {Number} cancellation_window_seconds + */ +exports.prototype['cancellation_window_seconds'] = undefined; +/** + * The flat-fee ammount charged for a no-show booking. + * @member {module:model/Money} cancellation_fee_money + */ +exports.prototype['cancellation_fee_money'] = undefined; +/** + * The cancellation policy adopted by the seller. + * @member {module:model/BusinessAppointmentSettingssCancellationPolicy} cancellation_policy + */ +exports.prototype['cancellation_policy'] = undefined; +/** + * The free-form text of the seller's cancellation policy. + * @member {String} cancellation_policy_text + */ +exports.prototype['cancellation_policy_text'] = undefined; +/** + * Indicates whether customers has an assigned staff member (`true`) or can select s staff member of their choice (`false`). + * @member {Boolean} skip_booking_flow_staff_selection + */ +exports.prototype['skip_booking_flow_staff_selection'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/BusinessAppointmentSettingsAlignmentTime.js b/src/model/BusinessAppointmentSettingsAlignmentTime.js new file mode 100644 index 0000000..472ebdb --- /dev/null +++ b/src/model/BusinessAppointmentSettingsAlignmentTime.js @@ -0,0 +1,55 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); + + +/** + * Enum class BusinessAppointmentSettingsAlignmentTime. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "SERVICE_DURATION" + * @const + */ + "SERVICE_DURATION": "SERVICE_DURATION", + /** + * value: "QUARTER_HOURLY" + * @const + */ + "QUARTER_HOURLY": "QUARTER_HOURLY", + /** + * value: "HALF_HOURLY" + * @const + */ + "HALF_HOURLY": "HALF_HOURLY", + /** + * value: "HOURLY" + * @const + */ + "HOURLY": "HOURLY"}; + +/** + * Returns a BusinessAppointmentSettingsAlignmentTime enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/BusinessAppointmentSettingsAlignmentTime} The enum BusinessAppointmentSettingsAlignmentTime value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/BusinessAppointmentSettingsBookingLocationType.js b/src/model/BusinessAppointmentSettingsBookingLocationType.js new file mode 100644 index 0000000..7e7f03b --- /dev/null +++ b/src/model/BusinessAppointmentSettingsBookingLocationType.js @@ -0,0 +1,50 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); + + +/** + * Enum class BusinessAppointmentSettingsBookingLocationType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "BUSINESS_LOCATION" + * @const + */ + "BUSINESS_LOCATION": "BUSINESS_LOCATION", + /** + * value: "CUSTOMER_LOCATION" + * @const + */ + "CUSTOMER_LOCATION": "CUSTOMER_LOCATION", + /** + * value: "PHONE" + * @const + */ + "PHONE": "PHONE"}; + +/** + * Returns a BusinessAppointmentSettingsBookingLocationType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/BusinessAppointmentSettingsBookingLocationType} The enum BusinessAppointmentSettingsBookingLocationType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/BusinessAppointmentSettingsCancellationPolicy.js b/src/model/BusinessAppointmentSettingsCancellationPolicy.js new file mode 100644 index 0000000..f7cd51c --- /dev/null +++ b/src/model/BusinessAppointmentSettingsCancellationPolicy.js @@ -0,0 +1,45 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); + + +/** + * Enum class BusinessAppointmentSettingsCancellationPolicy. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "CANCELLATION_TREATED_AS_NO_SHOW" + * @const + */ + "CANCELLATION_TREATED_AS_NO_SHOW": "CANCELLATION_TREATED_AS_NO_SHOW", + /** + * value: "CUSTOM_POLICY" + * @const + */ + "CUSTOM_POLICY": "CUSTOM_POLICY"}; + +/** + * Returns a BusinessAppointmentSettingsCancellationPolicy enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/BusinessAppointmentSettingsCancellationPolicy} The enum BusinessAppointmentSettingsCancellationPolicy value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.js b/src/model/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.js new file mode 100644 index 0000000..bf424bc --- /dev/null +++ b/src/model/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.js @@ -0,0 +1,45 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); + + +/** + * Enum class BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "PER_TEAM_MEMBER" + * @const + */ + "TEAM_MEMBER": "PER_TEAM_MEMBER", + /** + * value: "PER_LOCATION" + * @const + */ + "LOCATION": "PER_LOCATION"}; + +/** + * Returns a BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType} The enum BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/BusinessBookingProfile.js b/src/model/BusinessBookingProfile.js new file mode 100644 index 0000000..fb8e4f2 --- /dev/null +++ b/src/model/BusinessBookingProfile.js @@ -0,0 +1,123 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var BookingPolicy = require('./BusinessBookingProfileBookingPolicy'); +var BusinessAppointmentSettings = require('./BusinessAppointmentSettings'); +var CustomerTimezoneChoice = require('./BusinessBookingProfileCustomerTimezoneChoice'); + + + + +/** + * The BusinessBookingProfile model module. + * Note: This model is in beta. + * @module model/BusinessBookingProfile + */ + +/** + * Constructs a new BusinessBookingProfile. + * + * @alias module:model/BusinessBookingProfile + * @class + */ +var exports = function() { + var _this = this; + + + + + + + + +}; + +/** + * Constructs a BusinessBookingProfile from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/BusinessBookingProfile} obj Optional instance to populate. + * @return {module:model/BusinessBookingProfile} The populated BusinessBookingProfile instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('seller_id')) { + obj['seller_id'] = ApiClient.convertToType(data['seller_id'], 'String'); + } + if (data.hasOwnProperty('created_at')) { + obj['created_at'] = ApiClient.convertToType(data['created_at'], 'String'); + } + if (data.hasOwnProperty('booking_enabled')) { + obj['booking_enabled'] = ApiClient.convertToType(data['booking_enabled'], 'Boolean'); + } + if (data.hasOwnProperty('customer_timezone_choice')) { + obj['customer_timezone_choice'] = CustomerTimezoneChoice.constructFromObject(data['customer_timezone_choice']); + } + if (data.hasOwnProperty('booking_policy')) { + obj['booking_policy'] = BookingPolicy.constructFromObject(data['booking_policy']); + } + if (data.hasOwnProperty('allow_user_cancel')) { + obj['allow_user_cancel'] = ApiClient.convertToType(data['allow_user_cancel'], 'Boolean'); + } + if (data.hasOwnProperty('business_appointment_settings')) { + obj['business_appointment_settings'] = BusinessAppointmentSettings.constructFromObject(data['business_appointment_settings']); + } + } + return obj; +} + +/** + * The ID of the seller, obtainable using the Merchants API. + * @member {String} seller_id + */ +exports.prototype['seller_id'] = undefined; +/** + * The RFC-3339 timestamp specifying the booking's creation time. + * @member {String} created_at + */ +exports.prototype['created_at'] = undefined; +/** + * Indicates whether the seller is open for booking. + * @member {Boolean} booking_enabled + */ +exports.prototype['booking_enabled'] = undefined; +/** + * The choice of customer's time zone information of a booking. The Square online booking site and all notifications to customers uses either the seller location’s time zone or the time zone the customer chooses at booking. + * @member {module:model/BusinessBookingProfileCustomerTimezoneChoice} customer_timezone_choice + */ +exports.prototype['customer_timezone_choice'] = undefined; +/** + * The policy for the seller to automatically accept booking requests (`ACCEPT_ALL`) or not (`REQUIRES_ACCEPTANCE`). + * @member {module:model/BusinessBookingProfileBookingPolicy} booking_policy + */ +exports.prototype['booking_policy'] = undefined; +/** + * Indicates whether customers can cancel or reschedule their own bookings (`true`) or not (`false`). + * @member {Boolean} allow_user_cancel + */ +exports.prototype['allow_user_cancel'] = undefined; +/** + * Settings for appointment-type bookings. + * @member {module:model/BusinessAppointmentSettings} business_appointment_settings + */ +exports.prototype['business_appointment_settings'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/BusinessBookingProfileBookingPolicy.js b/src/model/BusinessBookingProfileBookingPolicy.js new file mode 100644 index 0000000..d5db5b1 --- /dev/null +++ b/src/model/BusinessBookingProfileBookingPolicy.js @@ -0,0 +1,45 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); + + +/** + * Enum class BusinessBookingProfileBookingPolicy. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "ACCEPT_ALL" + * @const + */ + "ACCEPT_ALL": "ACCEPT_ALL", + /** + * value: "REQUIRES_ACCEPTANCE" + * @const + */ + "REQUIRES_ACCEPTANCE": "REQUIRES_ACCEPTANCE"}; + +/** + * Returns a BusinessBookingProfileBookingPolicy enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/BusinessBookingProfileBookingPolicy} The enum BusinessBookingProfileBookingPolicy value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/BusinessBookingProfileCustomerTimezoneChoice.js b/src/model/BusinessBookingProfileCustomerTimezoneChoice.js new file mode 100644 index 0000000..5a3a2ea --- /dev/null +++ b/src/model/BusinessBookingProfileCustomerTimezoneChoice.js @@ -0,0 +1,45 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); + + +/** + * Enum class BusinessBookingProfileCustomerTimezoneChoice. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "BUSINESS_LOCATION_TIMEZONE" + * @const + */ + "BUSINESS_LOCATION_TIMEZONE": "BUSINESS_LOCATION_TIMEZONE", + /** + * value: "CUSTOMER_CHOICE" + * @const + */ + "CUSTOMER_CHOICE": "CUSTOMER_CHOICE"}; + +/** + * Returns a BusinessBookingProfileCustomerTimezoneChoice enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/BusinessBookingProfileCustomerTimezoneChoice} The enum BusinessBookingProfileCustomerTimezoneChoice value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/CardPaymentDetails.js b/src/model/CardPaymentDetails.js index 92dbbcf..f18d9c8 100644 --- a/src/model/CardPaymentDetails.js +++ b/src/model/CardPaymentDetails.js @@ -111,7 +111,7 @@ exports.constructFromObject = function(data, obj) { } /** - * The card payment's current state. It can be one of: `AUTHORIZED`, `CAPTURED`, `VOIDED`, `FAILED`. + * The card payment's current state. The state can be AUTHORIZED, CAPTURED, VOIDED, or FAILED. * @member {String} status */ exports.prototype['status'] = undefined; @@ -121,27 +121,27 @@ exports.prototype['status'] = undefined; */ exports.prototype['card'] = undefined; /** - * The method used to enter the card's details for the payment. Can be `KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`. + * The method used to enter the card's details for the payment. The method can be `KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`. * @member {String} entry_method */ exports.prototype['entry_method'] = undefined; /** - * Status code returned from the Card Verification Value (CVV) check. Can be `CVV_ACCEPTED`, `CVV_REJECTED`, `CVV_NOT_CHECKED`. + * The status code returned from the Card Verification Value (CVV) check. The code can be `CVV_ACCEPTED`, `CVV_REJECTED`, or `CVV_NOT_CHECKED`. * @member {String} cvv_status */ exports.prototype['cvv_status'] = undefined; /** - * Status code returned from the Address Verification System (AVS) check. Can be `AVS_ACCEPTED`, `AVS_REJECTED`, `AVS_NOT_CHECKED`. + * The status code returned from the Address Verification System (AVS) check. The code can be `AVS_ACCEPTED`, `AVS_REJECTED`, or `AVS_NOT_CHECKED`. * @member {String} avs_status */ exports.prototype['avs_status'] = undefined; /** - * Status code returned by the card issuer that describes the payment's authorization status. + * The status code returned by the card issuer that describes the payment's authorization status. * @member {String} auth_result_code */ exports.prototype['auth_result_code'] = undefined; /** - * For EMV payments, identifies the EMV application used for the payment. + * For EMV payments, the application ID identifies the EMV application used for the payment. * @member {String} application_identifier */ exports.prototype['application_identifier'] = undefined; @@ -156,17 +156,17 @@ exports.prototype['application_name'] = undefined; */ exports.prototype['application_cryptogram'] = undefined; /** - * For EMV payments, method used to verify the cardholder's identity. Can be one of `PIN`, `SIGNATURE`, `PIN_AND_SIGNATURE`, `ON_DEVICE`, or `NONE`. + * For EMV payments, the method used to verify the cardholder's identity. The method can be `PIN`, `SIGNATURE`, `PIN_AND_SIGNATURE`, `ON_DEVICE`, or `NONE`. * @member {String} verification_method */ exports.prototype['verification_method'] = undefined; /** - * For EMV payments, the results of the cardholder verification. Can be one of `SUCCESS`, `FAILURE`, or `UNKNOWN`. + * For EMV payments, the results of the cardholder verification. The result can be `SUCCESS`, `FAILURE`, or `UNKNOWN`. * @member {String} verification_results */ exports.prototype['verification_results'] = undefined; /** - * The statement description sent to the card networks. Note: The actual statement description will vary and is likely to be truncated and appended with additional information on a per issuer basis. + * The statement description sent to the card networks. Note: The actual statement description varies and is likely to be truncated and appended with additional information on a per issuer basis. * @member {String} statement_description */ exports.prototype['statement_description'] = undefined; @@ -176,12 +176,12 @@ exports.prototype['statement_description'] = undefined; */ exports.prototype['device_details'] = undefined; /** - * Whether or not the card is required to be physically present in order for the payment to be refunded. If true, the card is required to be present. + * Whether the card must be physically present for the payment to be refunded. If set to `true`, the card must be present. * @member {Boolean} refund_requires_card_presence */ exports.prototype['refund_requires_card_presence'] = undefined; /** - * Information on errors encountered during the request. + * Information about errors encountered during the request. * @member {Array.} errors */ exports.prototype['errors'] = undefined; diff --git a/src/model/CatalogIdMapping.js b/src/model/CatalogIdMapping.js index f79d0fd..e3df766 100644 --- a/src/model/CatalogIdMapping.js +++ b/src/model/CatalogIdMapping.js @@ -23,7 +23,7 @@ var ApiClient = require('../ApiClient'); /** * Constructs a new CatalogIdMapping. - * A mapping between a temporary client-supplied ID and a permanent server-generated ID. When calling [UpsertCatalogObject](#endpoint-Catalog-UpsertCatalogObject) or [BatchUpsertCatalogObjects](#endpoint-Catalog-BatchUpsertCatalogObjects) to create a [CatalogObject](#type-CatalogObject) instance, you can supply a temporary ID for the to-be-created object, especially when the object is to be referenced elsewhere in the same request body. This temporary ID can be any string unique within the call, but must be prefixed by \"#\". After the request is sumbitted and the object created, a permanent server-generated ID is assigned to the new object. The permanent ID is unique across the Square catalog. + * A mapping between a temporary client-supplied ID and a permanent server-generated ID. When calling [UpsertCatalogObject](#endpoint-Catalog-UpsertCatalogObject) or [BatchUpsertCatalogObjects](#endpoint-Catalog-BatchUpsertCatalogObjects) to create a [CatalogObject](#type-CatalogObject) instance, you can supply a temporary ID for the to-be-created object, especially when the object is to be referenced elsewhere in the same request body. This temporary ID can be any string unique within the call, but must be prefixed by \"#\". After the request is submitted and the object created, a permanent server-generated ID is assigned to the new object. The permanent ID is unique across the Square catalog. * @alias module:model/CatalogIdMapping * @class */ diff --git a/src/model/CatalogItem.js b/src/model/CatalogItem.js index deab9a6..b3d5f3c 100644 --- a/src/model/CatalogItem.js +++ b/src/model/CatalogItem.js @@ -26,7 +26,7 @@ var CatalogObject = require('./CatalogObject'); /** * Constructs a new CatalogItem. - * An [CatalogObject](#type-CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog. + * A [CatalogObject](#type-CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog. * @alias module:model/CatalogItem * @class */ diff --git a/src/model/CatalogItemVariation.js b/src/model/CatalogItemVariation.js index cb25a77..34de6a5 100644 --- a/src/model/CatalogItemVariation.js +++ b/src/model/CatalogItemVariation.js @@ -48,6 +48,8 @@ var exports = function() { + + }; /** @@ -99,12 +101,18 @@ exports.constructFromObject = function(data, obj) { } if (data.hasOwnProperty('service_duration')) { obj['service_duration'] = ApiClient.convertToType(data['service_duration'], 'Number'); + } + if (data.hasOwnProperty('available_for_booking')) { + obj['available_for_booking'] = ApiClient.convertToType(data['available_for_booking'], 'Boolean'); } if (data.hasOwnProperty('item_option_values')) { obj['item_option_values'] = ApiClient.convertToType(data['item_option_values'], [CatalogItemOptionValueForItemVariation]); } if (data.hasOwnProperty('measurement_unit_id')) { obj['measurement_unit_id'] = ApiClient.convertToType(data['measurement_unit_id'], 'String'); + } + if (data.hasOwnProperty('team_member_ids')) { + obj['team_member_ids'] = ApiClient.convertToType(data['team_member_ids'], ['String']); } } return obj; @@ -126,7 +134,7 @@ exports.prototype['name'] = undefined; */ exports.prototype['sku'] = undefined; /** - * The item variation's UPC, if any. This is a searchable attribute for use in applicable query filters. It is only accessible through the Square API, and not exposed in the Square Seller Dashboard, Square Point of Sale or Retail Point of Sale apps. + * The universal product code (UPC) of the item variation, if any. This is a searchable attribute for use in applicable query filters. The value of this attribute should be a number of 12-14 digits long. This restriction is enforced on the Square Seller Dashboard, Square Point of Sale or Retail Point of Sale apps, where this attribute shows in the GTIN field. If a non-compliant UPC value is assigned to this attribute using the API, the value is not editable on the Seller Dashboard, Square Point of Sale or Retail Point of Sale apps unless it is updated to fit the expected format. * @member {String} upc */ exports.prototype['upc'] = undefined; @@ -175,6 +183,11 @@ exports.prototype['user_data'] = undefined; * @member {Number} service_duration */ exports.prototype['service_duration'] = undefined; +/** + * If the `CatalogItem` that owns this item variation is of type `APPOINTMENTS_SERVICE`, a bool representing whether this service is available for booking. + * @member {Boolean} available_for_booking + */ +exports.prototype['available_for_booking'] = undefined; /** * List of item option values associated with this item variation. Listed in the same order as the item options of the parent item. * @member {Array.} item_option_values @@ -185,6 +198,11 @@ exports.prototype['item_option_values'] = undefined; * @member {String} measurement_unit_id */ exports.prototype['measurement_unit_id'] = undefined; +/** + * Tokens of employees that can perform the service represented by this variation. Only valid for variations of type `APPOINTMENTS_SERVICE`. + * @member {Array.} team_member_ids + */ +exports.prototype['team_member_ids'] = undefined; diff --git a/src/model/CatalogQuery.js b/src/model/CatalogQuery.js index f724e56..cbf1c1d 100644 --- a/src/model/CatalogQuery.js +++ b/src/model/CatalogQuery.js @@ -33,7 +33,7 @@ var CatalogQueryText = require('./CatalogQueryText'); /** * Constructs a new CatalogQuery. - * A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint. Although a query can have multiple filters, only one query is allowed per call to [SearchCatalogObjects](#endpoint-Catalog-SearchCatalogObjects). When a query filter is based on an attribute, the attribute must be searchable. Searchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters. * Searchable attribute and objects queryable by searchable attributes ** - `name`: `CatalogItem`, `CatalogItemVariation`, `CatelogCatogry`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, 'CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue` - `description`: `CatalogItem`, `CatalogItemOptionValue` - `abbreviation`: `CatalogItem` - `upc`: `CatalogItemVariation` - `sku`: `CatalogItemVariation` - `caption`: `CatalogImage` - `display_name`: `CatalogItemOption` For example, to search for [CatalogItem](#type-CatalogItem) objects by searchable attributes, you can use the `\"name\"`, `\"description\"`, or `\"abbreviation\"` attribute in an applicable query filter. + * A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint. Although a query can have multiple filters, only certain query types can be combined per call to [SearchCatalogObjects](#endpoint-Catalog-SearchCatalogObjects). Any combination of the following types may be used together: - [exact_query](#type-CatalogExactQuery) - [prefix_query](#type-CatalogPrefixQuery) - [range_query](#type-CatalogRangeQuery) - [sorted_attribute_query](#type-CatalogSortedAttribute) - [text_query](#type-CatalogTextQuery) All other query types cannot be combined with any others. When a query filter is based on an attribute, the attribute must be searchable. Searchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters. * Searchable attribute and objects queryable by searchable attributes ** - `name`: `CatalogItem`, `CatalogItemVariation`, `CatelogCatogry`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, 'CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue` - `description`: `CatalogItem`, `CatalogItemOptionValue` - `abbreviation`: `CatalogItem` - `upc`: `CatalogItemVariation` - `sku`: `CatalogItemVariation` - `caption`: `CatalogImage` - `display_name`: `CatalogItemOption` For example, to search for [CatalogItem](#type-CatalogItem) objects by searchable attributes, you can use the `\"name\"`, `\"description\"`, or `\"abbreviation\"` attribute in an applicable query filter. * @alias module:model/CatalogQuery * @class */ diff --git a/src/model/CheckAppointmentsOnboardedRequest.js b/src/model/CheckAppointmentsOnboardedRequest.js new file mode 100644 index 0000000..437eb94 --- /dev/null +++ b/src/model/CheckAppointmentsOnboardedRequest.js @@ -0,0 +1,57 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); + + + + +/** + * The CheckAppointmentsOnboardedRequest model module. + * Note: This model is in beta. + * @module model/CheckAppointmentsOnboardedRequest + */ + +/** + * Constructs a new CheckAppointmentsOnboardedRequest. + * + * @alias module:model/CheckAppointmentsOnboardedRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a CheckAppointmentsOnboardedRequest from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/CheckAppointmentsOnboardedRequest} obj Optional instance to populate. + * @return {module:model/CheckAppointmentsOnboardedRequest} The populated CheckAppointmentsOnboardedRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/CreateDisputeEvidenceFileResponse.js b/src/model/CheckAppointmentsOnboardedResponse.js similarity index 54% rename from src/model/CreateDisputeEvidenceFileResponse.js rename to src/model/CheckAppointmentsOnboardedResponse.js index 447bfab..85ebf13 100644 --- a/src/model/CreateDisputeEvidenceFileResponse.js +++ b/src/model/CheckAppointmentsOnboardedResponse.js @@ -12,22 +12,21 @@ * */ var ApiClient = require('../ApiClient'); -var DisputeEvidence = require('./DisputeEvidence'); var Error = require('./Error'); /** - * The CreateDisputeEvidenceFileResponse model module. + * The CheckAppointmentsOnboardedResponse model module. * Note: This model is in beta. - * @module model/CreateDisputeEvidenceFileResponse + * @module model/CheckAppointmentsOnboardedResponse */ /** - * Constructs a new CreateDisputeEvidenceFileResponse. - * Defines fields in a CreateDisputeEvidenceFile response. - * @alias module:model/CreateDisputeEvidenceFileResponse + * Constructs a new CheckAppointmentsOnboardedResponse. + * + * @alias module:model/CheckAppointmentsOnboardedResponse * @class */ var exports = function() { @@ -38,36 +37,36 @@ var exports = function() { }; /** - * Constructs a CreateDisputeEvidenceFileResponse from a plain JavaScript object, optionally creating a new instance. + * Constructs a CheckAppointmentsOnboardedResponse from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:model/CreateDisputeEvidenceFileResponse} obj Optional instance to populate. - * @return {module:model/CreateDisputeEvidenceFileResponse} The populated CreateDisputeEvidenceFileResponse instance. + * @param {module:model/CheckAppointmentsOnboardedResponse} obj Optional instance to populate. + * @return {module:model/CheckAppointmentsOnboardedResponse} The populated CheckAppointmentsOnboardedResponse instance. */ exports.constructFromObject = function(data, obj) { if (data) { obj = obj || new exports(); + if (data.hasOwnProperty('appointments_onboarded')) { + obj['appointments_onboarded'] = ApiClient.convertToType(data['appointments_onboarded'], 'Boolean'); + } if (data.hasOwnProperty('errors')) { obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); - } - if (data.hasOwnProperty('evidence')) { - obj['evidence'] = DisputeEvidence.constructFromObject(data['evidence']); } } return obj; } +/** + * Indicates whether the seller has enabled the Square Appointments service (`true`) or not (`false`). + * @member {Boolean} appointments_onboarded + */ +exports.prototype['appointments_onboarded'] = undefined; /** * Any errors that occurred during the request. * @member {Array.} errors */ exports.prototype['errors'] = undefined; -/** - * The metadata of the newly uploaded dispute evidence. - * @member {module:model/DisputeEvidence} evidence - */ -exports.prototype['evidence'] = undefined; diff --git a/src/model/CreateBookingRequest.js b/src/model/CreateBookingRequest.js new file mode 100644 index 0000000..411cfaf --- /dev/null +++ b/src/model/CreateBookingRequest.js @@ -0,0 +1,77 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var Booking = require('./Booking'); + + + + +/** + * The CreateBookingRequest model module. + * Note: This model is in beta. + * @module model/CreateBookingRequest + */ + +/** + * Constructs a new CreateBookingRequest. + * + * @alias module:model/CreateBookingRequest + * @class + * @param booking {module:model/Booking} The details of the booking to be created. + */ +var exports = function(booking) { + var _this = this; + + + _this['booking'] = booking; +}; + +/** + * Constructs a CreateBookingRequest from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/CreateBookingRequest} obj Optional instance to populate. + * @return {module:model/CreateBookingRequest} The populated CreateBookingRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('idempotency_key')) { + obj['idempotency_key'] = ApiClient.convertToType(data['idempotency_key'], 'String'); + } + if (data.hasOwnProperty('booking')) { + obj['booking'] = Booking.constructFromObject(data['booking']); + } + } + return obj; +} + +/** + * A unique key to make this request an idempotent operation. + * @member {String} idempotency_key + */ +exports.prototype['idempotency_key'] = undefined; +/** + * The details of the booking to be created. + * @member {module:model/Booking} booking + */ +exports.prototype['booking'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/CreateBookingResponse.js b/src/model/CreateBookingResponse.js new file mode 100644 index 0000000..98d05ae --- /dev/null +++ b/src/model/CreateBookingResponse.js @@ -0,0 +1,77 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var Booking = require('./Booking'); +var Error = require('./Error'); + + + + +/** + * The CreateBookingResponse model module. + * Note: This model is in beta. + * @module model/CreateBookingResponse + */ + +/** + * Constructs a new CreateBookingResponse. + * + * @alias module:model/CreateBookingResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a CreateBookingResponse from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/CreateBookingResponse} obj Optional instance to populate. + * @return {module:model/CreateBookingResponse} The populated CreateBookingResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('booking')) { + obj['booking'] = Booking.constructFromObject(data['booking']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The booking that was created. + * @member {module:model/Booking} booking + */ +exports.prototype['booking'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/CreateCatalogImageRequest.js b/src/model/CreateCatalogImageRequest.js deleted file mode 100644 index 6ca4b5e..0000000 --- a/src/model/CreateCatalogImageRequest.js +++ /dev/null @@ -1,85 +0,0 @@ -/** - * Square Connect API - * Client library for accessing the Square Connect APIs - * - * OpenAPI spec version: 2.0 - * Contact: developers@squareup.com - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * - * Swagger Codegen version: 2.3.0-SNAPSHOT - * - */ -var ApiClient = require('../ApiClient'); -var CatalogObject = require('./CatalogObject'); - - - - -/** - * The CreateCatalogImageRequest model module. - * @module model/CreateCatalogImageRequest - */ - -/** - * Constructs a new CreateCatalogImageRequest. - * - * @alias module:model/CreateCatalogImageRequest - * @class - * @param idempotencyKey {String} A unique string that identifies this CreateCatalogImage request. Keys can be any valid string but must be unique for every CreateCatalogImage request. See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. - */ -var exports = function(idempotencyKey) { - var _this = this; - - _this['idempotency_key'] = idempotencyKey; - - -}; - -/** - * Constructs a CreateCatalogImageRequest from a plain JavaScript object, optionally creating a new instance. - * Copies all relevant properties from data to obj if supplied or a new instance if not. - * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:model/CreateCatalogImageRequest} obj Optional instance to populate. - * @return {module:model/CreateCatalogImageRequest} The populated CreateCatalogImageRequest instance. - */ -exports.constructFromObject = function(data, obj) { - if (data) { - obj = obj || new exports(); - - if (data.hasOwnProperty('idempotency_key')) { - obj['idempotency_key'] = ApiClient.convertToType(data['idempotency_key'], 'String'); - } - if (data.hasOwnProperty('object_id')) { - obj['object_id'] = ApiClient.convertToType(data['object_id'], 'String'); - } - if (data.hasOwnProperty('image')) { - obj['image'] = CatalogObject.constructFromObject(data['image']); - } - } - return obj; -} - -/** - * A unique string that identifies this CreateCatalogImage request. Keys can be any valid string but must be unique for every CreateCatalogImage request. See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. - * @member {String} idempotency_key - */ -exports.prototype['idempotency_key'] = undefined; -/** - * Unique ID of the `CatalogObject` to attach to this `CatalogImage`. Leave this field empty to create unattached images, for example if you are building an integration where these images can be attached to catalog items at a later time. - * @member {String} object_id - */ -exports.prototype['object_id'] = undefined; -/** - * The new `IMAGE`-type `CatalogObject` to be attached to this `CatalogImage`. If the `CatalogObject` already has a `CatalogImage`, this call will overwrite it. - * @member {module:model/CatalogObject} image - */ -exports.prototype['image'] = undefined; - - - -module.exports = exports; - - - diff --git a/src/model/CreateDisputeEvidenceFileRequest.js b/src/model/CreateDisputeEvidenceFileRequest.js deleted file mode 100644 index 173af51..0000000 --- a/src/model/CreateDisputeEvidenceFileRequest.js +++ /dev/null @@ -1,85 +0,0 @@ -/** - * Square Connect API - * Client library for accessing the Square Connect APIs - * - * OpenAPI spec version: 2.0 - * Contact: developers@squareup.com - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * - * Swagger Codegen version: 2.3.0-SNAPSHOT - * - */ -var ApiClient = require('../ApiClient'); - - - - -/** - * The CreateDisputeEvidenceFileRequest model module. - * Note: This model is in beta. - * @module model/CreateDisputeEvidenceFileRequest - */ - -/** - * Constructs a new CreateDisputeEvidenceFileRequest. - * Defines parameters for a CreateDisputeEvidenceFile request. - * @alias module:model/CreateDisputeEvidenceFileRequest - * @class - * @param idempotencyKey {String} Unique ID. For more information, see [Idempotency](https://developer.squareup.com/docs/docs/working-with-apis/idempotency). - */ -var exports = function(idempotencyKey) { - var _this = this; - - _this['idempotency_key'] = idempotencyKey; - - -}; - -/** - * Constructs a CreateDisputeEvidenceFileRequest from a plain JavaScript object, optionally creating a new instance. - * Copies all relevant properties from data to obj if supplied or a new instance if not. - * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:model/CreateDisputeEvidenceFileRequest} obj Optional instance to populate. - * @return {module:model/CreateDisputeEvidenceFileRequest} The populated CreateDisputeEvidenceFileRequest instance. - */ -exports.constructFromObject = function(data, obj) { - if (data) { - obj = obj || new exports(); - - if (data.hasOwnProperty('idempotency_key')) { - obj['idempotency_key'] = ApiClient.convertToType(data['idempotency_key'], 'String'); - } - if (data.hasOwnProperty('evidence_type')) { - obj['evidence_type'] = ApiClient.convertToType(data['evidence_type'], 'String'); - } - if (data.hasOwnProperty('content_type')) { - obj['content_type'] = ApiClient.convertToType(data['content_type'], 'String'); - } - } - return obj; -} - -/** - * Unique ID. For more information, see [Idempotency](https://developer.squareup.com/docs/docs/working-with-apis/idempotency). - * @member {String} idempotency_key - */ -exports.prototype['idempotency_key'] = undefined; -/** - * The type of evidence you are uploading. See [DisputeEvidenceType](#type-disputeevidencetype) for possible values - * @member {String} evidence_type - */ -exports.prototype['evidence_type'] = undefined; -/** - * The MIME type of the uploaded file. One of image/heic, image/heif, image/jpeg, application/pdf, image/png, image/tiff. - * @member {String} content_type - */ -exports.prototype['content_type'] = undefined; - - - -module.exports = exports; - - - diff --git a/src/model/DeviceDetails.js b/src/model/DeviceDetails.js index ea742ba..6e78e8f 100644 --- a/src/model/DeviceDetails.js +++ b/src/model/DeviceDetails.js @@ -60,17 +60,17 @@ exports.constructFromObject = function(data, obj) { } /** - * Square-issued ID of the device. + * The Square-issued ID of the device. * @member {String} device_id */ exports.prototype['device_id'] = undefined; /** - * Square-issued installation ID for the device. + * The Square-issued installation ID for the device. * @member {String} device_installation_id */ exports.prototype['device_installation_id'] = undefined; /** - * The name of the device set by the merchant. + * The name of the device set by the seller. * @member {String} device_name */ exports.prototype['device_name'] = undefined; diff --git a/src/model/GetPaymentRefundResponse.js b/src/model/GetPaymentRefundResponse.js index da3bedb..6cb90ff 100644 --- a/src/model/GetPaymentRefundResponse.js +++ b/src/model/GetPaymentRefundResponse.js @@ -25,7 +25,7 @@ var PaymentRefund = require('./PaymentRefund'); /** * Constructs a new GetPaymentRefundResponse. - * Defines the fields that are included in the response body of a request to the [GetRefund](#endpoint-refunds-getpaymentrefund) endpoint. Note: if there are errors processing the request, the refund field may not be present, or it may be present in a FAILED state. + * Defines the fields that are included in the response body of a request to the [GetRefund](#endpoint-refunds-getpaymentrefund) endpoint. Note: If there are errors processing the request, the refund field might not be present or it might be present in a FAILED state. * @alias module:model/GetPaymentRefundResponse * @class */ @@ -58,7 +58,7 @@ exports.constructFromObject = function(data, obj) { } /** - * Information on errors encountered during the request. + * Information about errors encountered during the request. * @member {Array.} errors */ exports.prototype['errors'] = undefined; diff --git a/src/model/ListPaymentRefundsRequest.js b/src/model/ListPaymentRefundsRequest.js index a466135..ad0fa06 100644 --- a/src/model/ListPaymentRefundsRequest.js +++ b/src/model/ListPaymentRefundsRequest.js @@ -23,7 +23,7 @@ var ApiClient = require('../ApiClient'); /** * Constructs a new ListPaymentRefundsRequest. - * Retrieves a list of refunds for the account making the request. Max results per page: 100 + * Retrieves a list of refunds for the account making the request. The maximum results per page is 100. * @alias module:model/ListPaymentRefundsRequest * @class */ @@ -80,42 +80,42 @@ exports.constructFromObject = function(data, obj) { } /** - * Timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. + * The timestamp for the beginning of the requested reporting period, in RFC 3339 format. Default: The current time minus one year. * @member {String} begin_time */ exports.prototype['begin_time'] = undefined; /** - * Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. + * The timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. * @member {String} end_time */ exports.prototype['end_time'] = undefined; /** - * The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). + * The order in which results are listed: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default). * @member {String} sort_order */ exports.prototype['sort_order'] = undefined; /** - * A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination). * @member {String} cursor */ exports.prototype['cursor'] = undefined; /** - * Limit results to the location supplied. By default, results are returned for all locations associated with the merchant. + * Limit results to the location supplied. By default, results are returned for all locations associated with the seller. * @member {String} location_id */ exports.prototype['location_id'] = undefined; /** - * If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. + * If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted, refunds are returned regardless of their status. * @member {String} status */ exports.prototype['status'] = undefined; /** - * If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. + * If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where `CARD` was specified as the payment source. Default: If omitted, refunds are returned regardless of the source type. * @member {String} source_type */ exports.prototype['source_type'] = undefined; /** - * Maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. If the supplied value is greater than 100, at most 100 results will be returned. Default: `100` + * The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. If the supplied value is greater than 100, no more than 100 results are returned. Default: 100 * @member {Number} limit */ exports.prototype['limit'] = undefined; diff --git a/src/model/ListPaymentRefundsResponse.js b/src/model/ListPaymentRefundsResponse.js index fab5867..fefc5af 100644 --- a/src/model/ListPaymentRefundsResponse.js +++ b/src/model/ListPaymentRefundsResponse.js @@ -25,7 +25,7 @@ var PaymentRefund = require('./PaymentRefund'); /** * Constructs a new ListPaymentRefundsResponse. - * Defines the fields that are included in the response body of a request to the [ListPaymentRefunds](#endpoint-refunds-listpaymentrefunds) endpoint. One of `errors` or `refunds` is present in a given response (never both). + * Defines the fields that are included in the response body of a request to the [ListPaymentRefunds](#endpoint-refunds-listpaymentrefunds) endpoint. Either `errors` or `refunds` is present in a given response (never both). * @alias module:model/ListPaymentRefundsResponse * @class */ @@ -62,7 +62,7 @@ exports.constructFromObject = function(data, obj) { } /** - * Information on errors encountered during the request. + * Information about errors encountered during the request. * @member {Array.} errors */ exports.prototype['errors'] = undefined; @@ -72,7 +72,7 @@ exports.prototype['errors'] = undefined; */ exports.prototype['refunds'] = undefined; /** - * The pagination cursor to be used in a subsequent request. If empty, this is the final response. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * The pagination cursor to be used in a subsequent request. If empty, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/basics/api101/pagination). * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/ListTeamMemberBookingProfilesRequest.js b/src/model/ListTeamMemberBookingProfilesRequest.js new file mode 100644 index 0000000..d30b6b2 --- /dev/null +++ b/src/model/ListTeamMemberBookingProfilesRequest.js @@ -0,0 +1,93 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); + + + + +/** + * The ListTeamMemberBookingProfilesRequest model module. + * Note: This model is in beta. + * @module model/ListTeamMemberBookingProfilesRequest + */ + +/** + * Constructs a new ListTeamMemberBookingProfilesRequest. + * + * @alias module:model/ListTeamMemberBookingProfilesRequest + * @class + */ +var exports = function() { + var _this = this; + + + + + +}; + +/** + * Constructs a ListTeamMemberBookingProfilesRequest from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/ListTeamMemberBookingProfilesRequest} obj Optional instance to populate. + * @return {module:model/ListTeamMemberBookingProfilesRequest} The populated ListTeamMemberBookingProfilesRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('bookable_only')) { + obj['bookable_only'] = ApiClient.convertToType(data['bookable_only'], 'Boolean'); + } + if (data.hasOwnProperty('limit')) { + obj['limit'] = ApiClient.convertToType(data['limit'], 'Number'); + } + if (data.hasOwnProperty('cursor')) { + obj['cursor'] = ApiClient.convertToType(data['cursor'], 'String'); + } + if (data.hasOwnProperty('location_id')) { + obj['location_id'] = ApiClient.convertToType(data['location_id'], 'String'); + } + } + return obj; +} + +/** + * Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`). + * @member {Boolean} bookable_only + */ +exports.prototype['bookable_only'] = undefined; +/** + * The maximum number of results to return. + * @member {Number} limit + */ +exports.prototype['limit'] = undefined; +/** + * The cursor for paginating through the results. + * @member {String} cursor + */ +exports.prototype['cursor'] = undefined; +/** + * Indicates whether to include only team members enabled at the given location in the returned result. + * @member {String} location_id + */ +exports.prototype['location_id'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/ListTeamMemberBookingProfilesResponse.js b/src/model/ListTeamMemberBookingProfilesResponse.js new file mode 100644 index 0000000..166574b --- /dev/null +++ b/src/model/ListTeamMemberBookingProfilesResponse.js @@ -0,0 +1,86 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var Error = require('./Error'); +var TeamMemberBookingProfile = require('./TeamMemberBookingProfile'); + + + + +/** + * The ListTeamMemberBookingProfilesResponse model module. + * Note: This model is in beta. + * @module model/ListTeamMemberBookingProfilesResponse + */ + +/** + * Constructs a new ListTeamMemberBookingProfilesResponse. + * + * @alias module:model/ListTeamMemberBookingProfilesResponse + * @class + */ +var exports = function() { + var _this = this; + + + + +}; + +/** + * Constructs a ListTeamMemberBookingProfilesResponse from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/ListTeamMemberBookingProfilesResponse} obj Optional instance to populate. + * @return {module:model/ListTeamMemberBookingProfilesResponse} The populated ListTeamMemberBookingProfilesResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('team_member_booking_profiles')) { + obj['team_member_booking_profiles'] = ApiClient.convertToType(data['team_member_booking_profiles'], [TeamMemberBookingProfile]); + } + if (data.hasOwnProperty('cursor')) { + obj['cursor'] = ApiClient.convertToType(data['cursor'], 'String'); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The list of team member booking profiles. + * @member {Array.} team_member_booking_profiles + */ +exports.prototype['team_member_booking_profiles'] = undefined; +/** + * The cursor for paginating through the results. + * @member {String} cursor + */ +exports.prototype['cursor'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/ObtainTokenRequest.js b/src/model/ObtainTokenRequest.js index 8c3a203..9e48aef 100644 --- a/src/model/ObtainTokenRequest.js +++ b/src/model/ObtainTokenRequest.js @@ -40,6 +40,8 @@ var exports = function(clientId, clientSecret, grantType) { _this['grant_type'] = grantType; + + }; /** @@ -73,6 +75,12 @@ exports.constructFromObject = function(data, obj) { } if (data.hasOwnProperty('migration_token')) { obj['migration_token'] = ApiClient.convertToType(data['migration_token'], 'String'); + } + if (data.hasOwnProperty('scopes')) { + obj['scopes'] = ApiClient.convertToType(data['scopes'], ['String']); + } + if (data.hasOwnProperty('short_lived')) { + obj['short_lived'] = ApiClient.convertToType(data['short_lived'], 'Boolean'); } } return obj; @@ -113,6 +121,16 @@ exports.prototype['refresh_token'] = undefined; * @member {String} migration_token */ exports.prototype['migration_token'] = undefined; +/** + * __OPTIONAL__ A JSON list of strings representing the permissions the application is requesting. For example: \"`[\"MERCHANT_PROFILE_READ\",\"PAYMENTS_READ\",\"BANK_ACCOUNTS_READ\"]`\" The access token returned in the response is granted the permissions that comprise the intersection between the requested list of permissions, and those that belong to the provided refresh token. + * @member {Array.} scopes + */ +exports.prototype['scopes'] = undefined; +/** + * __OPTIONAL__ A boolean indicating a request for a short-lived access token. The short-lived access token returned in the response will expire in 24 hours. + * @member {Boolean} short_lived + */ +exports.prototype['short_lived'] = undefined; diff --git a/src/model/ObtainTokenResponse.js b/src/model/ObtainTokenResponse.js index 899e886..751495a 100644 --- a/src/model/ObtainTokenResponse.js +++ b/src/model/ObtainTokenResponse.js @@ -38,6 +38,7 @@ var exports = function() { + }; /** @@ -74,13 +75,16 @@ exports.constructFromObject = function(data, obj) { } if (data.hasOwnProperty('refresh_token')) { obj['refresh_token'] = ApiClient.convertToType(data['refresh_token'], 'String'); + } + if (data.hasOwnProperty('short_lived')) { + obj['short_lived'] = ApiClient.convertToType(data['short_lived'], 'Boolean'); } } return obj; } /** - * A valid OAuth access token. OAuth access tokens are 64 bytes long. Provide the access token in a header with every request to Connect API endpoints. See the [Build with OAuth](https://developer.squareup.com/docs/authz/oauth/build-with-the-api) guide for more information. + * A valid OAuth access token. OAuth access tokens are 64 bytes long. Provide the access token in a header with every request to Connect API endpoints. See [OAuth API: Walkthrough](https://developer.squareup.com/docs/oauth-api/walkthrough) for more information. * @member {String} access_token */ exports.prototype['access_token'] = undefined; @@ -105,7 +109,7 @@ exports.prototype['merchant_id'] = undefined; */ exports.prototype['subscription_id'] = undefined; /** - * T__LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. + * __LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. * @member {String} plan_id */ exports.prototype['plan_id'] = undefined; @@ -119,6 +123,11 @@ exports.prototype['id_token'] = undefined; * @member {String} refresh_token */ exports.prototype['refresh_token'] = undefined; +/** + * A boolean indicating the access token is a short-lived access token. The short-lived access token returned in the response will expire in 24 hours. + * @member {Boolean} short_lived + */ +exports.prototype['short_lived'] = undefined; diff --git a/src/model/OnboardAppointmentsRequest.js b/src/model/OnboardAppointmentsRequest.js new file mode 100644 index 0000000..42f5624 --- /dev/null +++ b/src/model/OnboardAppointmentsRequest.js @@ -0,0 +1,57 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); + + + + +/** + * The OnboardAppointmentsRequest model module. + * Note: This model is in beta. + * @module model/OnboardAppointmentsRequest + */ + +/** + * Constructs a new OnboardAppointmentsRequest. + * + * @alias module:model/OnboardAppointmentsRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a OnboardAppointmentsRequest from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/OnboardAppointmentsRequest} obj Optional instance to populate. + * @return {module:model/OnboardAppointmentsRequest} The populated OnboardAppointmentsRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/OnboardAppointmentsResponse.js b/src/model/OnboardAppointmentsResponse.js new file mode 100644 index 0000000..ec50345 --- /dev/null +++ b/src/model/OnboardAppointmentsResponse.js @@ -0,0 +1,67 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var Error = require('./Error'); + + + + +/** + * The OnboardAppointmentsResponse model module. + * Note: This model is in beta. + * @module model/OnboardAppointmentsResponse + */ + +/** + * Constructs a new OnboardAppointmentsResponse. + * + * @alias module:model/OnboardAppointmentsResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a OnboardAppointmentsResponse from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/OnboardAppointmentsResponse} obj Optional instance to populate. + * @return {module:model/OnboardAppointmentsResponse} The populated OnboardAppointmentsResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/Payment.js b/src/model/Payment.js index 925b03c..7d1752e 100644 --- a/src/model/Payment.js +++ b/src/model/Payment.js @@ -16,6 +16,7 @@ var Address = require('./Address'); var CardPaymentDetails = require('./CardPaymentDetails'); var Money = require('./Money'); var ProcessingFee = require('./ProcessingFee'); +var RiskEvaluation = require('./RiskEvaluation'); @@ -60,6 +61,7 @@ var exports = function() { + }; @@ -137,6 +139,9 @@ exports.constructFromObject = function(data, obj) { } if (data.hasOwnProperty('refund_ids')) { obj['refund_ids'] = ApiClient.convertToType(data['refund_ids'], ['String']); + } + if (data.hasOwnProperty('risk_evaluation')) { + obj['risk_evaluation'] = RiskEvaluation.constructFromObject(data['risk_evaluation']); } if (data.hasOwnProperty('buyer_email_address')) { obj['buyer_email_address'] = ApiClient.convertToType(data['buyer_email_address'], 'String'); @@ -164,92 +169,92 @@ exports.constructFromObject = function(data, obj) { } /** - * Unique ID for the payment. + * A unique ID for the payment. * @member {String} id */ exports.prototype['id'] = undefined; /** - * Timestamp of when the payment was created, in RFC 3339 format. + * The timestamp of when the payment was created, in RFC 3339 format. * @member {String} created_at */ exports.prototype['created_at'] = undefined; /** - * Timestamp of when the payment was last updated, in RFC 3339 format. + * The timestamp of when the payment was last updated, in RFC 3339 format. * @member {String} updated_at */ exports.prototype['updated_at'] = undefined; /** - * The amount of money processed for this payment, not including `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). + * The amount processed for this payment, not including `tip_money`. The amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). * @member {module:model/Money} amount_money */ exports.prototype['amount_money'] = undefined; /** - * The amount designated as a tip. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. + * The amount designated as a tip. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). * @member {module:model/Money} tip_money */ exports.prototype['tip_money'] = undefined; /** - * The total money for the payment, including `amount_money` and `tip_money`. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. + * The total amount for the payment, including `amount_money` and `tip_money`. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). * @member {module:model/Money} total_money */ exports.prototype['total_money'] = undefined; /** - * The amount of money the developer is taking as a fee for facilitating the payment on behalf of the seller. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). Cannot be more than 90% of the `total_money` value. + * The amount the developer is taking as a fee for facilitating the payment on behalf of the seller. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). The amount cannot be more than 90% of the `total_money` value. * @member {module:model/Money} app_fee_money */ exports.prototype['app_fee_money'] = undefined; /** - * Processing fees and fee adjustments assessed by Square on this payment. + * The processing fees and fee adjustments assessed by Square for this payment. * @member {Array.} processing_fee */ exports.prototype['processing_fee'] = undefined; /** - * Total amount of the payment refunded to-date. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. + * The total amount of the payment refunded to date. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). * @member {module:model/Money} refunded_money */ exports.prototype['refunded_money'] = undefined; /** - * Indicates whether the payment is `APPROVED`, `COMPLETED`, `CANCELED`, or `FAILED`. + * Indicates whether the payment is APPROVED, COMPLETED, CANCELED, or FAILED. * @member {String} status */ exports.prototype['status'] = undefined; /** - * The duration of time after the payment's creation when Square automatically applies the `delay_action` to the payment. This automatic `delay_action` applies only to payments that don't reach a terminal state (COMPLETED, CANCELED, or FAILED) before the `delay_duration` time period. This field is specified as a time duration, in RFC 3339 format. Notes: This feature is only supported for card payments. Default: - Card Present payments: \"PT36H\" (36 hours) from the creation time. - Card Not Present payments: \"P7D\" (7 days) from the creation time. + * The duration of time after the payment's creation when Square automatically applies the `delay_action` to the payment. This automatic `delay_action` applies only to payments that do not reach a terminal state (COMPLETED, CANCELED, or FAILED) before the `delay_duration` time period. This field is specified as a time duration, in RFC 3339 format. Notes: This feature is only supported for card payments. Default: - Card-present payments: \"PT36H\" (36 hours) from the creation time. - Card-not-present payments: \"P7D\" (7 days) from the creation time. * @member {String} delay_duration */ exports.prototype['delay_duration'] = undefined; /** - * The action to be applied to the payment when the `delay_duration` has elapsed. This field is read only. Current values include: `CANCEL` + * The action to be applied to the payment when the `delay_duration` has elapsed. This field is read-only. Current values include `CANCEL`. * @member {String} delay_action */ exports.prototype['delay_action'] = undefined; /** - * Read only timestamp of when the `delay_action` will automatically be applied, in RFC 3339 format. Note that this field is calculated by summing the payment's `delay_duration` and `created_at` fields. The `created_at` field is generated by Square and may not exactly match the time on your local machine. + * The read-only timestamp of when the `delay_action` is automatically applied, in RFC 3339 format. Note that this field is calculated by summing the payment's `delay_duration` and `created_at` fields. The `created_at` field is generated by Square and might not exactly match the time on your local machine. * @member {String} delayed_until */ exports.prototype['delayed_until'] = undefined; /** - * The source type for this payment Current values include: `CARD`. + * The source type for this payment. Current values include `CARD`. * @member {String} source_type */ exports.prototype['source_type'] = undefined; /** - * Non-confidential details about the source. Only populated if the `source_type` is `CARD`. + * Non-confidential details about the source. The details are only populated if the `source_type` is `CARD`. * @member {module:model/CardPaymentDetails} card_details */ exports.prototype['card_details'] = undefined; /** - * ID of the location associated with the payment. + * The ID of the location associated with the payment. * @member {String} location_id */ exports.prototype['location_id'] = undefined; /** - * ID of the order associated with this payment. + * The ID of the order associated with the payment. * @member {String} order_id */ exports.prototype['order_id'] = undefined; /** - * An optional ID that associates this payment with an entity in another system. + * An optional ID that associates the payment with an entity in another system. * @member {String} reference_id */ exports.prototype['reference_id'] = undefined; @@ -259,47 +264,52 @@ exports.prototype['reference_id'] = undefined; */ exports.prototype['customer_id'] = undefined; /** - * An optional ID of the employee associated with taking this payment. + * An optional ID of the employee associated with taking the payment. * @member {String} employee_id */ exports.prototype['employee_id'] = undefined; /** - * List of `refund_id`s identifying refunds for this payment. + * A list of `refund_id`s identifying refunds for the payment. * @member {Array.} refund_ids */ exports.prototype['refund_ids'] = undefined; /** - * The buyer's e-mail address + * Provides information about the risk associated with the payment, as determined by Square. This field is present for payments to sellers that have opted in to receive risk evaluations. + * @member {module:model/RiskEvaluation} risk_evaluation + */ +exports.prototype['risk_evaluation'] = undefined; +/** + * The buyer's email address. * @member {String} buyer_email_address */ exports.prototype['buyer_email_address'] = undefined; /** - * The buyer's billing address + * The buyer's billing address. * @member {module:model/Address} billing_address */ exports.prototype['billing_address'] = undefined; /** - * The buyer's shipping address + * The buyer's shipping address. * @member {module:model/Address} shipping_address */ exports.prototype['shipping_address'] = undefined; /** - * An optional note to include when creating a payment + * An optional note to include when creating a payment. * @member {String} note */ exports.prototype['note'] = undefined; /** - * Additional payment information that gets added on the customer's card statement as part of the statement description. Note that the `statement_description_identifier` may get truncated on the statement description to fit the required information including the Square identifier (SQ *) and name of the merchant taking the payment. + * Additional payment information that gets added to the customer's card statement as part of the statement description. Note that the `statement_description_identifier` might get truncated on the statement description to fit the required information including the Square identifier (SQ *) and the name of the seller taking the payment. * @member {String} statement_description_identifier */ exports.prototype['statement_description_identifier'] = undefined; /** - * The payment's receipt number. The field will be missing if a payment is CANCELED + * The payment's receipt number. The field is missing if a payment is canceled. * @member {String} receipt_number */ exports.prototype['receipt_number'] = undefined; /** - * The URL for the payment's receipt. The field will only be populated for COMPLETED payments. + * The URL for the payment's receipt. The field is only populated for COMPLETED payments. * @member {String} receipt_url */ exports.prototype['receipt_url'] = undefined; diff --git a/src/model/PaymentRefund.js b/src/model/PaymentRefund.js index 8a5d2a3..aa60369 100644 --- a/src/model/PaymentRefund.js +++ b/src/model/PaymentRefund.js @@ -25,11 +25,11 @@ var ProcessingFee = require('./ProcessingFee'); /** * Constructs a new PaymentRefund. - * Represents a refund of a payment made using Square. Contains information on the original payment and the amount of money refunded. + * Represents a refund of a payment made using Square. Contains information about the original payment and the amount of money refunded. * @alias module:model/PaymentRefund * @class - * @param id {String} Unique ID for this refund, generated by Square. - * @param amountMoney {module:model/Money} The amount of money refunded, specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. + * @param id {String} The unique ID for this refund, generated by Square. + * @param amountMoney {module:model/Money} The amount of money refunded. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). */ var exports = function(id, amountMoney) { var _this = this; @@ -96,32 +96,32 @@ exports.constructFromObject = function(data, obj) { } /** - * Unique ID for this refund, generated by Square. + * The unique ID for this refund, generated by Square. * @member {String} id */ exports.prototype['id'] = undefined; /** - * The refund's status: - `PENDING` - awaiting approval - `COMPLETED` - successfully completed - `REJECTED` - the refund was rejected - `FAILED` - an error occurred + * The refund's status: - `PENDING` - Awaiting approval. - `COMPLETED` - Successfully completed. - `REJECTED` - The refund was rejected. - `FAILED` - An error occurred. * @member {String} status */ exports.prototype['status'] = undefined; /** - * Location ID associated with the payment this refund is attached to. + * The location ID associated with the payment this refund is attached to. * @member {String} location_id */ exports.prototype['location_id'] = undefined; /** - * The amount of money refunded, specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. + * The amount of money refunded. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). * @member {module:model/Money} amount_money */ exports.prototype['amount_money'] = undefined; /** - * Amount of money the app developer contributed to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. + * The amount of money the application developer contributed to help cover the refunded amount. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). * @member {module:model/Money} app_fee_money */ exports.prototype['app_fee_money'] = undefined; /** - * Processing fees and fee adjustments assessed by Square on this refund. + * Processing fees and fee adjustments assessed by Square for this refund. * @member {Array.} processing_fee */ exports.prototype['processing_fee'] = undefined; @@ -141,12 +141,12 @@ exports.prototype['order_id'] = undefined; */ exports.prototype['reason'] = undefined; /** - * Timestamp of when the refund was created, in RFC 3339 format. + * The timestamp of when the refund was created, in RFC 3339 format. * @member {String} created_at */ exports.prototype['created_at'] = undefined; /** - * Timestamp of when the refund was last updated, in RFC 3339 format. + * The timestamp of when the refund was last updated, in RFC 3339 format. * @member {String} updated_at */ exports.prototype['updated_at'] = undefined; diff --git a/src/model/ProcessingFee.js b/src/model/ProcessingFee.js index 7dd23d1..990e2d5 100644 --- a/src/model/ProcessingFee.js +++ b/src/model/ProcessingFee.js @@ -24,7 +24,7 @@ var Money = require('./Money'); /** * Constructs a new ProcessingFee. - * Represents Square processing fee. + * Represents the Square processing fee. * @alias module:model/ProcessingFee * @class */ @@ -61,17 +61,17 @@ exports.constructFromObject = function(data, obj) { } /** - * Timestamp of when the fee takes effect, in RFC 3339 format. + * The timestamp of when the fee takes effect, in RFC 3339 format. * @member {String} effective_at */ exports.prototype['effective_at'] = undefined; /** - * The type of fee assessed or adjusted. Can be one of: `INITIAL`, `ADJUSTMENT`. + * The type of fee assessed or adjusted. The fee type can be `INITIAL` or `ADJUSTMENT`. * @member {String} type */ exports.prototype['type'] = undefined; /** - * The fee amount assessed or adjusted by Square. May be negative. Positive values represent funds being assessed, while negative values represent funds being returned. + * The fee amount, which might be negative, that is assessed or adjusted by Square. Positive values represent funds being assessed, while negative values represent funds being returned. * @member {module:model/Money} amount_money */ exports.prototype['amount_money'] = undefined; diff --git a/src/model/RefundPaymentRequest.js b/src/model/RefundPaymentRequest.js index 00d7148..66a1081 100644 --- a/src/model/RefundPaymentRequest.js +++ b/src/model/RefundPaymentRequest.js @@ -27,9 +27,9 @@ var Money = require('./Money'); * Refunds a payment. * @alias module:model/RefundPaymentRequest * @class - * @param idempotencyKey {String} A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency). - * @param amountMoney {module:model/Money} The amount of money to refund. Cannot be more than the `total_money` value of the payment minus the total amount of all previously completed refunds for this payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is charging the card. - * @param paymentId {String} Unique ID of the payment being refunded. + * @param idempotencyKey {String} A unique string that identifies this `RefundPayment` request. The key can be any valid string but must be unique for every `RefundPayment` request. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). + * @param amountMoney {module:model/Money} The amount of money to refund. This amount cannot be more than the `total_money` value of the payment minus the total amount of all previously completed refunds for this payment. This amount must be specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). The currency code must match the currency associated with the business that is charging the card. + * @param paymentId {String} The unique ID of the payment being refunded. */ var exports = function(idempotencyKey, amountMoney, paymentId) { var _this = this; @@ -72,22 +72,22 @@ exports.constructFromObject = function(data, obj) { } /** - * A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency). + * A unique string that identifies this `RefundPayment` request. The key can be any valid string but must be unique for every `RefundPayment` request. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency). * @member {String} idempotency_key */ exports.prototype['idempotency_key'] = undefined; /** - * The amount of money to refund. Cannot be more than the `total_money` value of the payment minus the total amount of all previously completed refunds for this payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is charging the card. + * The amount of money to refund. This amount cannot be more than the `total_money` value of the payment minus the total amount of all previously completed refunds for this payment. This amount must be specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts). The currency code must match the currency associated with the business that is charging the card. * @member {module:model/Money} amount_money */ exports.prototype['amount_money'] = undefined; /** - * Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees) + * The amount of money the developer contributes to help cover the refunded amount. This amount is specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). The value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Take Payments and Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees). * @member {module:model/Money} app_fee_money */ exports.prototype['app_fee_money'] = undefined; /** - * Unique ID of the payment being refunded. + * The unique ID of the payment being refunded. * @member {String} payment_id */ exports.prototype['payment_id'] = undefined; diff --git a/src/model/RefundPaymentResponse.js b/src/model/RefundPaymentResponse.js index a7b0cd5..df2165e 100644 --- a/src/model/RefundPaymentResponse.js +++ b/src/model/RefundPaymentResponse.js @@ -25,7 +25,7 @@ var PaymentRefund = require('./PaymentRefund'); /** * Constructs a new RefundPaymentResponse. - * Defines the fields that are included in the response body of a request to the [RefundPayment](#endpoint-refunds-refundpayment) endpoint. Note: if there are errors processing the request, the refund field may not be present, or it may be present in a FAILED state. + * Defines the fields that are included in the response body of a request to the [RefundPayment](#endpoint-refunds-refundpayment) endpoint. Note: If there are errors processing the request, the refund field might not be present or it might be present in a FAILED state. * @alias module:model/RefundPaymentResponse * @class */ @@ -58,7 +58,7 @@ exports.constructFromObject = function(data, obj) { } /** - * Information on errors encountered during the request. + * Information about errors encountered during the request. * @member {Array.} errors */ exports.prototype['errors'] = undefined; diff --git a/src/model/RetrieveBookingRequest.js b/src/model/RetrieveBookingRequest.js new file mode 100644 index 0000000..faf4a8f --- /dev/null +++ b/src/model/RetrieveBookingRequest.js @@ -0,0 +1,57 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); + + + + +/** + * The RetrieveBookingRequest model module. + * Note: This model is in beta. + * @module model/RetrieveBookingRequest + */ + +/** + * Constructs a new RetrieveBookingRequest. + * + * @alias module:model/RetrieveBookingRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a RetrieveBookingRequest from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/RetrieveBookingRequest} obj Optional instance to populate. + * @return {module:model/RetrieveBookingRequest} The populated RetrieveBookingRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/RetrieveBookingResponse.js b/src/model/RetrieveBookingResponse.js new file mode 100644 index 0000000..d3e6d5f --- /dev/null +++ b/src/model/RetrieveBookingResponse.js @@ -0,0 +1,77 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var Booking = require('./Booking'); +var Error = require('./Error'); + + + + +/** + * The RetrieveBookingResponse model module. + * Note: This model is in beta. + * @module model/RetrieveBookingResponse + */ + +/** + * Constructs a new RetrieveBookingResponse. + * + * @alias module:model/RetrieveBookingResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a RetrieveBookingResponse from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/RetrieveBookingResponse} obj Optional instance to populate. + * @return {module:model/RetrieveBookingResponse} The populated RetrieveBookingResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('booking')) { + obj['booking'] = Booking.constructFromObject(data['booking']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The booking that was requested. + * @member {module:model/Booking} booking + */ +exports.prototype['booking'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/RetrieveBusinessBookingProfileRequest.js b/src/model/RetrieveBusinessBookingProfileRequest.js new file mode 100644 index 0000000..6294c73 --- /dev/null +++ b/src/model/RetrieveBusinessBookingProfileRequest.js @@ -0,0 +1,57 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); + + + + +/** + * The RetrieveBusinessBookingProfileRequest model module. + * Note: This model is in beta. + * @module model/RetrieveBusinessBookingProfileRequest + */ + +/** + * Constructs a new RetrieveBusinessBookingProfileRequest. + * + * @alias module:model/RetrieveBusinessBookingProfileRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a RetrieveBusinessBookingProfileRequest from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/RetrieveBusinessBookingProfileRequest} obj Optional instance to populate. + * @return {module:model/RetrieveBusinessBookingProfileRequest} The populated RetrieveBusinessBookingProfileRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/RetrieveBusinessBookingProfileResponse.js b/src/model/RetrieveBusinessBookingProfileResponse.js new file mode 100644 index 0000000..3020082 --- /dev/null +++ b/src/model/RetrieveBusinessBookingProfileResponse.js @@ -0,0 +1,77 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var BusinessBookingProfile = require('./BusinessBookingProfile'); +var Error = require('./Error'); + + + + +/** + * The RetrieveBusinessBookingProfileResponse model module. + * Note: This model is in beta. + * @module model/RetrieveBusinessBookingProfileResponse + */ + +/** + * Constructs a new RetrieveBusinessBookingProfileResponse. + * + * @alias module:model/RetrieveBusinessBookingProfileResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a RetrieveBusinessBookingProfileResponse from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/RetrieveBusinessBookingProfileResponse} obj Optional instance to populate. + * @return {module:model/RetrieveBusinessBookingProfileResponse} The populated RetrieveBusinessBookingProfileResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('business_booking_profile')) { + obj['business_booking_profile'] = BusinessBookingProfile.constructFromObject(data['business_booking_profile']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The seller's booking profile. + * @member {module:model/BusinessBookingProfile} business_booking_profile + */ +exports.prototype['business_booking_profile'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/RetrieveObsMigrationProfileRequest.js b/src/model/RetrieveObsMigrationProfileRequest.js new file mode 100644 index 0000000..f07b54c --- /dev/null +++ b/src/model/RetrieveObsMigrationProfileRequest.js @@ -0,0 +1,57 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); + + + + +/** + * The RetrieveObsMigrationProfileRequest model module. + * Note: This model is in beta. + * @module model/RetrieveObsMigrationProfileRequest + */ + +/** + * Constructs a new RetrieveObsMigrationProfileRequest. + * + * @alias module:model/RetrieveObsMigrationProfileRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a RetrieveObsMigrationProfileRequest from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/RetrieveObsMigrationProfileRequest} obj Optional instance to populate. + * @return {module:model/RetrieveObsMigrationProfileRequest} The populated RetrieveObsMigrationProfileRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/RetrieveObsMigrationProfileResponse.js b/src/model/RetrieveObsMigrationProfileResponse.js new file mode 100644 index 0000000..5a0f7dc --- /dev/null +++ b/src/model/RetrieveObsMigrationProfileResponse.js @@ -0,0 +1,103 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var Error = require('./Error'); + + + + +/** + * The RetrieveObsMigrationProfileResponse model module. + * Note: This model is in beta. + * @module model/RetrieveObsMigrationProfileResponse + */ + +/** + * Constructs a new RetrieveObsMigrationProfileResponse. + * + * @alias module:model/RetrieveObsMigrationProfileResponse + * @class + */ +var exports = function() { + var _this = this; + + + + + + +}; + +/** + * Constructs a RetrieveObsMigrationProfileResponse from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/RetrieveObsMigrationProfileResponse} obj Optional instance to populate. + * @return {module:model/RetrieveObsMigrationProfileResponse} The populated RetrieveObsMigrationProfileResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('banner_enabled')) { + obj['banner_enabled'] = ApiClient.convertToType(data['banner_enabled'], 'Boolean'); + } + if (data.hasOwnProperty('banner_text')) { + obj['banner_text'] = ApiClient.convertToType(data['banner_text'], 'String'); + } + if (data.hasOwnProperty('banner_cta_text')) { + obj['banner_cta_text'] = ApiClient.convertToType(data['banner_cta_text'], 'String'); + } + if (data.hasOwnProperty('banner_cta_url')) { + obj['banner_cta_url'] = ApiClient.convertToType(data['banner_cta_url'], 'String'); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * Indicates whether the seller has enabled the COVID banner (`true`) or not (`false`). + * @member {Boolean} banner_enabled + */ +exports.prototype['banner_enabled'] = undefined; +/** + * The text appearing on the COVID banner. + * @member {String} banner_text + */ +exports.prototype['banner_text'] = undefined; +/** + * The text of the label of the CTA button beneath the banner. + * @member {String} banner_cta_text + */ +exports.prototype['banner_cta_text'] = undefined; +/** + * The URL to link to when the CTA button is clicked. + * @member {String} banner_cta_url + */ +exports.prototype['banner_cta_url'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/RetrieveTeamMemberBookingProfileRequest.js b/src/model/RetrieveTeamMemberBookingProfileRequest.js new file mode 100644 index 0000000..63039ff --- /dev/null +++ b/src/model/RetrieveTeamMemberBookingProfileRequest.js @@ -0,0 +1,57 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); + + + + +/** + * The RetrieveTeamMemberBookingProfileRequest model module. + * Note: This model is in beta. + * @module model/RetrieveTeamMemberBookingProfileRequest + */ + +/** + * Constructs a new RetrieveTeamMemberBookingProfileRequest. + * + * @alias module:model/RetrieveTeamMemberBookingProfileRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a RetrieveTeamMemberBookingProfileRequest from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/RetrieveTeamMemberBookingProfileRequest} obj Optional instance to populate. + * @return {module:model/RetrieveTeamMemberBookingProfileRequest} The populated RetrieveTeamMemberBookingProfileRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/RetrieveTeamMemberBookingProfileResponse.js b/src/model/RetrieveTeamMemberBookingProfileResponse.js new file mode 100644 index 0000000..689141d --- /dev/null +++ b/src/model/RetrieveTeamMemberBookingProfileResponse.js @@ -0,0 +1,77 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var Error = require('./Error'); +var TeamMemberBookingProfile = require('./TeamMemberBookingProfile'); + + + + +/** + * The RetrieveTeamMemberBookingProfileResponse model module. + * Note: This model is in beta. + * @module model/RetrieveTeamMemberBookingProfileResponse + */ + +/** + * Constructs a new RetrieveTeamMemberBookingProfileResponse. + * + * @alias module:model/RetrieveTeamMemberBookingProfileResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a RetrieveTeamMemberBookingProfileResponse from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/RetrieveTeamMemberBookingProfileResponse} obj Optional instance to populate. + * @return {module:model/RetrieveTeamMemberBookingProfileResponse} The populated RetrieveTeamMemberBookingProfileResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('team_member_booking_profile')) { + obj['team_member_booking_profile'] = TeamMemberBookingProfile.constructFromObject(data['team_member_booking_profile']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The returned team member booking profile. + * @member {module:model/TeamMemberBookingProfile} team_member_booking_profile + */ +exports.prototype['team_member_booking_profile'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/RiskEvaluation.js b/src/model/RiskEvaluation.js new file mode 100644 index 0000000..5313189 --- /dev/null +++ b/src/model/RiskEvaluation.js @@ -0,0 +1,76 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var RiskLevel = require('./RiskEvaluationRiskLevel'); + + + + +/** + * The RiskEvaluation model module. + * Note: This model is in beta. + * @module model/RiskEvaluation + */ + +/** + * Constructs a new RiskEvaluation. + * 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). + * @alias module:model/RiskEvaluation + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a RiskEvaluation from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/RiskEvaluation} obj Optional instance to populate. + * @return {module:model/RiskEvaluation} The populated RiskEvaluation instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('created_at')) { + obj['created_at'] = ApiClient.convertToType(data['created_at'], 'String'); + } + if (data.hasOwnProperty('risk_level')) { + obj['risk_level'] = RiskLevel.constructFromObject(data['risk_level']); + } + } + return obj; +} + +/** + * The timestamp when payment risk was evaluated, in RFC3339 format. + * @member {String} created_at + */ +exports.prototype['created_at'] = undefined; +/** + * The risk level associated with the payment + * @member {module:model/RiskEvaluationRiskLevel} risk_level + */ +exports.prototype['risk_level'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/RiskEvaluationRiskLevel.js b/src/model/RiskEvaluationRiskLevel.js new file mode 100644 index 0000000..bc6c3b2 --- /dev/null +++ b/src/model/RiskEvaluationRiskLevel.js @@ -0,0 +1,55 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); + + +/** + * Enum class RiskEvaluationRiskLevel. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "PENDING" + * @const + */ + "PENDING": "PENDING", + /** + * value: "NORMAL" + * @const + */ + "NORMAL": "NORMAL", + /** + * value: "MODERATE" + * @const + */ + "MODERATE": "MODERATE", + /** + * value: "HIGH" + * @const + */ + "HIGH": "HIGH"}; + +/** + * Returns a RiskEvaluationRiskLevel enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/RiskEvaluationRiskLevel} The enum RiskEvaluationRiskLevel value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/SearchAvailabilityFilter.js b/src/model/SearchAvailabilityFilter.js new file mode 100644 index 0000000..eb56088 --- /dev/null +++ b/src/model/SearchAvailabilityFilter.js @@ -0,0 +1,96 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var SegmentFilter = require('./SegmentFilter'); +var TimeRange = require('./TimeRange'); + + + + +/** + * The SearchAvailabilityFilter model module. + * Note: This model is in beta. + * @module model/SearchAvailabilityFilter + */ + +/** + * Constructs a new SearchAvailabilityFilter. + * A query filter to search for availabilities by. + * @alias module:model/SearchAvailabilityFilter + * @class + * @param startAtRange {module:model/TimeRange} The query expression to search for availabilities matching the specified range of starting times. + */ +var exports = function(startAtRange) { + var _this = this; + + _this['start_at_range'] = startAtRange; + + + +}; + +/** + * Constructs a SearchAvailabilityFilter from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/SearchAvailabilityFilter} obj Optional instance to populate. + * @return {module:model/SearchAvailabilityFilter} The populated SearchAvailabilityFilter instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('start_at_range')) { + obj['start_at_range'] = TimeRange.constructFromObject(data['start_at_range']); + } + if (data.hasOwnProperty('location_id')) { + obj['location_id'] = ApiClient.convertToType(data['location_id'], 'String'); + } + if (data.hasOwnProperty('segment_filters')) { + obj['segment_filters'] = ApiClient.convertToType(data['segment_filters'], [SegmentFilter]); + } + if (data.hasOwnProperty('booking_id')) { + obj['booking_id'] = ApiClient.convertToType(data['booking_id'], 'String'); + } + } + return obj; +} + +/** + * The query expression to search for availabilities matching the specified range of starting times. + * @member {module:model/TimeRange} start_at_range + */ +exports.prototype['start_at_range'] = undefined; +/** + * The query expression to search for availabilities matching the specified seller location IDs. This query expression is not applicable when `booking_id` is present. + * @member {String} location_id + */ +exports.prototype['location_id'] = undefined; +/** + * The list of segment filters to apply. A query with `n` segment filters returns availabilities with `n` segments per availability. It is not applicable when `booking_id` is present. + * @member {Array.} segment_filters + */ +exports.prototype['segment_filters'] = undefined; +/** + * The query expression to search for availabilities for an existing booking by matching the specified `booking_id` value. This is commonly used to reschedule an appointment. If this expression is specified, the `location_id` and `segment_filters` expressions are not allowed. + * @member {String} booking_id + */ +exports.prototype['booking_id'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/SearchAvailabilityQuery.js b/src/model/SearchAvailabilityQuery.js new file mode 100644 index 0000000..3279e41 --- /dev/null +++ b/src/model/SearchAvailabilityQuery.js @@ -0,0 +1,68 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var SearchAvailabilityFilter = require('./SearchAvailabilityFilter'); + + + + +/** + * The SearchAvailabilityQuery model module. + * Note: This model is in beta. + * @module model/SearchAvailabilityQuery + */ + +/** + * Constructs a new SearchAvailabilityQuery. + * Query conditions to search for availabilities of bookings. + * @alias module:model/SearchAvailabilityQuery + * @class + * @param filter {module:model/SearchAvailabilityFilter} The query filter to search for availabilities of existing bookings. + */ +var exports = function(filter) { + var _this = this; + + _this['filter'] = filter; +}; + +/** + * Constructs a SearchAvailabilityQuery from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/SearchAvailabilityQuery} obj Optional instance to populate. + * @return {module:model/SearchAvailabilityQuery} The populated SearchAvailabilityQuery instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('filter')) { + obj['filter'] = SearchAvailabilityFilter.constructFromObject(data['filter']); + } + } + return obj; +} + +/** + * The query filter to search for availabilities of existing bookings. + * @member {module:model/SearchAvailabilityFilter} filter + */ +exports.prototype['filter'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/SearchAvailabilityRequest.js b/src/model/SearchAvailabilityRequest.js new file mode 100644 index 0000000..ce5aee7 --- /dev/null +++ b/src/model/SearchAvailabilityRequest.js @@ -0,0 +1,68 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var SearchAvailabilityQuery = require('./SearchAvailabilityQuery'); + + + + +/** + * The SearchAvailabilityRequest model module. + * Note: This model is in beta. + * @module model/SearchAvailabilityRequest + */ + +/** + * Constructs a new SearchAvailabilityRequest. + * + * @alias module:model/SearchAvailabilityRequest + * @class + * @param query {module:model/SearchAvailabilityQuery} Query conditions used to filter results. + */ +var exports = function(query) { + var _this = this; + + _this['query'] = query; +}; + +/** + * Constructs a SearchAvailabilityRequest from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/SearchAvailabilityRequest} obj Optional instance to populate. + * @return {module:model/SearchAvailabilityRequest} The populated SearchAvailabilityRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('query')) { + obj['query'] = SearchAvailabilityQuery.constructFromObject(data['query']); + } + } + return obj; +} + +/** + * Query conditions used to filter results. + * @member {module:model/SearchAvailabilityQuery} query + */ +exports.prototype['query'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/CreateCatalogImageResponse.js b/src/model/SearchAvailabilityResponse.js similarity index 59% rename from src/model/CreateCatalogImageResponse.js rename to src/model/SearchAvailabilityResponse.js index 98e5862..3033791 100644 --- a/src/model/CreateCatalogImageResponse.js +++ b/src/model/SearchAvailabilityResponse.js @@ -12,21 +12,22 @@ * */ var ApiClient = require('../ApiClient'); -var CatalogObject = require('./CatalogObject'); +var Availability = require('./Availability'); var Error = require('./Error'); /** - * The CreateCatalogImageResponse model module. - * @module model/CreateCatalogImageResponse + * The SearchAvailabilityResponse model module. + * Note: This model is in beta. + * @module model/SearchAvailabilityResponse */ /** - * Constructs a new CreateCatalogImageResponse. + * Constructs a new SearchAvailabilityResponse. * - * @alias module:model/CreateCatalogImageResponse + * @alias module:model/SearchAvailabilityResponse * @class */ var exports = function() { @@ -37,36 +38,36 @@ var exports = function() { }; /** - * Constructs a CreateCatalogImageResponse from a plain JavaScript object, optionally creating a new instance. + * Constructs a SearchAvailabilityResponse from a plain JavaScript object, optionally creating a new instance. * Copies all relevant properties from data to obj if supplied or a new instance if not. * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:model/CreateCatalogImageResponse} obj Optional instance to populate. - * @return {module:model/CreateCatalogImageResponse} The populated CreateCatalogImageResponse instance. + * @param {module:model/SearchAvailabilityResponse} obj Optional instance to populate. + * @return {module:model/SearchAvailabilityResponse} The populated SearchAvailabilityResponse instance. */ exports.constructFromObject = function(data, obj) { if (data) { obj = obj || new exports(); + if (data.hasOwnProperty('availabilities')) { + obj['availabilities'] = ApiClient.convertToType(data['availabilities'], [Availability]); + } if (data.hasOwnProperty('errors')) { obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); - } - if (data.hasOwnProperty('image')) { - obj['image'] = CatalogObject.constructFromObject(data['image']); } } return obj; } +/** + * List of slots available for booking. + * @member {Array.} availabilities + */ +exports.prototype['availabilities'] = undefined; /** * Any errors that occurred during the request. * @member {Array.} errors */ exports.prototype['errors'] = undefined; -/** - * The newly created `CatalogImage` including a Square-generated URL for each image. - * @member {module:model/CatalogObject} image - */ -exports.prototype['image'] = undefined; diff --git a/src/model/SearchCatalogObjectsRequest.js b/src/model/SearchCatalogObjectsRequest.js index 0f45fb7..b4b9f16 100644 --- a/src/model/SearchCatalogObjectsRequest.js +++ b/src/model/SearchCatalogObjectsRequest.js @@ -82,7 +82,7 @@ exports.constructFromObject = function(data, obj) { */ exports.prototype['cursor'] = undefined; /** - * The desired set of object types to appear in the search results. The legal values are taken from the CatalogObjectType enum: `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values + * The desired set of object types to appear in the search results. See [CatalogObjectType](#type-catalogobjecttype) for possible values * @member {Array.} object_types */ exports.prototype['object_types'] = undefined; diff --git a/src/model/SegmentFilter.js b/src/model/SegmentFilter.js new file mode 100644 index 0000000..1703c97 --- /dev/null +++ b/src/model/SegmentFilter.js @@ -0,0 +1,77 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var FilterValue = require('./FilterValue'); + + + + +/** + * The SegmentFilter model module. + * Note: This model is in beta. + * @module model/SegmentFilter + */ + +/** + * Constructs a new SegmentFilter. + * A query filter to search for appointment segments by. + * @alias module:model/SegmentFilter + * @class + * @param serviceVariationId {String} The ID of the `CatalogItemVariation` representing the service booked in this segment. + */ +var exports = function(serviceVariationId) { + var _this = this; + + _this['service_variation_id'] = serviceVariationId; + +}; + +/** + * Constructs a SegmentFilter from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/SegmentFilter} obj Optional instance to populate. + * @return {module:model/SegmentFilter} The populated SegmentFilter instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('service_variation_id')) { + obj['service_variation_id'] = ApiClient.convertToType(data['service_variation_id'], 'String'); + } + if (data.hasOwnProperty('team_member_id_filter')) { + obj['team_member_id_filter'] = FilterValue.constructFromObject(data['team_member_id_filter']); + } + } + return obj; +} + +/** + * The ID of the `CatalogItemVariation` representing the service booked in this segment. + * @member {String} service_variation_id + */ +exports.prototype['service_variation_id'] = undefined; +/** + * A query expression specifying which team members satisfy the condition. Supported expressions are - `ANY`: include team members whose IDs match any member of the specified list. - `NONE`: exclude team members whose IDs match members of the specified list. The `ALL` expression is not supported in the Bookings API. When no expression is specified, any service-providing team member is eligible to fulfill the Booking. + * @member {module:model/FilterValue} team_member_id_filter + */ +exports.prototype['team_member_id_filter'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/TeamMemberBookingProfile.js b/src/model/TeamMemberBookingProfile.js new file mode 100644 index 0000000..5035af8 --- /dev/null +++ b/src/model/TeamMemberBookingProfile.js @@ -0,0 +1,102 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); + + + + +/** + * The TeamMemberBookingProfile model module. + * Note: This model is in beta. + * @module model/TeamMemberBookingProfile + */ + +/** + * Constructs a new TeamMemberBookingProfile. + * The booking profile of a seller's team member, including the team member's ID, display name, description and whether the team member can be booked as a service provider. + * @alias module:model/TeamMemberBookingProfile + * @class + */ +var exports = function() { + var _this = this; + + + + + + +}; + +/** + * Constructs a TeamMemberBookingProfile from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/TeamMemberBookingProfile} obj Optional instance to populate. + * @return {module:model/TeamMemberBookingProfile} The populated TeamMemberBookingProfile instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('team_member_id')) { + obj['team_member_id'] = ApiClient.convertToType(data['team_member_id'], 'String'); + } + if (data.hasOwnProperty('description')) { + obj['description'] = ApiClient.convertToType(data['description'], 'String'); + } + if (data.hasOwnProperty('display_name')) { + obj['display_name'] = ApiClient.convertToType(data['display_name'], 'String'); + } + if (data.hasOwnProperty('is_bookable')) { + obj['is_bookable'] = ApiClient.convertToType(data['is_bookable'], 'Boolean'); + } + if (data.hasOwnProperty('profile_image_url')) { + obj['profile_image_url'] = ApiClient.convertToType(data['profile_image_url'], 'String'); + } + } + return obj; +} + +/** + * The ID of the `TeamMember` object for the team member associated with the booking profile. + * @member {String} team_member_id + */ +exports.prototype['team_member_id'] = undefined; +/** + * The description of the team member. + * @member {String} description + */ +exports.prototype['description'] = undefined; +/** + * The display name of the team member. + * @member {String} display_name + */ +exports.prototype['display_name'] = undefined; +/** + * Indicates whether the team member can be booked through the Bookings API or the seller's online booking channel or site (`true) or not (`false`). + * @member {Boolean} is_bookable + */ +exports.prototype['is_bookable'] = undefined; +/** + * The URL of the team member's image for the bookings profile. + * @member {String} profile_image_url + */ +exports.prototype['profile_image_url'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/TerminalCheckout.js b/src/model/TerminalCheckout.js index 01542c0..b273838 100644 --- a/src/model/TerminalCheckout.js +++ b/src/model/TerminalCheckout.js @@ -121,12 +121,12 @@ exports.prototype['note'] = undefined; */ exports.prototype['device_options'] = undefined; /** - * The duration as an RFC 3339 duration, after which the checkout will be automatically canceled. TerminalCheckouts that are `PENDING` will be automatically `CANCELED` and have a cancellation reason of `TIMED\\_OUT`. Default: 5 minutes from creation Maximum: 5 minutes + * The duration as an RFC 3339 duration, after which the checkout will be automatically canceled. TerminalCheckouts that are `PENDING` will be automatically `CANCELED` and have a cancellation reason of `TIMED_OUT`. Default: 5 minutes from creation Maximum: 5 minutes * @member {String} deadline_duration */ exports.prototype['deadline_duration'] = undefined; /** - * The status of the `TerminalCheckout`. Options: `PENDING`, `IN\\_PROGRESS`, `CANCEL\\_REQUESTED`, `CANCELED`, `COMPLETED` + * The status of the `TerminalCheckout`. Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED` * @member {String} status */ exports.prototype['status'] = undefined; diff --git a/src/model/TerminalCheckoutQueryFilter.js b/src/model/TerminalCheckoutQueryFilter.js index 2d3ea67..a572730 100644 --- a/src/model/TerminalCheckoutQueryFilter.js +++ b/src/model/TerminalCheckoutQueryFilter.js @@ -71,7 +71,7 @@ exports.prototype['device_id'] = undefined; */ exports.prototype['created_at'] = undefined; /** - * Filtered results with the desired status of the `TerminalCheckout` Options: PENDING, IN\\_PROGRESS, CANCELED, COMPLETED + * Filtered results with the desired status of the `TerminalCheckout` Options: PENDING, IN_PROGRESS, CANCELED, COMPLETED * @member {String} status */ exports.prototype['status'] = undefined; diff --git a/src/model/TerminalRefund.js b/src/model/TerminalRefund.js index a235062..e4fd075 100644 --- a/src/model/TerminalRefund.js +++ b/src/model/TerminalRefund.js @@ -140,7 +140,7 @@ exports.prototype['device_id'] = undefined; */ exports.prototype['deadline_duration'] = undefined; /** - * The status of the `TerminalRefund`. Options: `PENDING`, `IN\\_PROGRESS`, `CANCELED`, `COMPLETED` + * The status of the `TerminalRefund`. Options: `PENDING`, `IN_PROGRESS`, `CANCELED`, `COMPLETED` * @member {String} status */ exports.prototype['status'] = undefined; diff --git a/src/model/TerminalRefundQueryFilter.js b/src/model/TerminalRefundQueryFilter.js index c32f925..cdf0caa 100644 --- a/src/model/TerminalRefundQueryFilter.js +++ b/src/model/TerminalRefundQueryFilter.js @@ -72,7 +72,7 @@ exports.prototype['device_id'] = undefined; */ exports.prototype['created_at'] = undefined; /** - * Filtered results with the desired status of the `TerminalRefund` Options: `PENDING`, `IN\\_PROGRESS`, `CANCEL\\_REQUESTED`, `CANCELED`, `COMPLETED` + * Filtered results with the desired status of the `TerminalRefund` Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED` * @member {String} status */ exports.prototype['status'] = undefined; diff --git a/src/model/TipSettings.js b/src/model/TipSettings.js index 2690098..3cfed7e 100644 --- a/src/model/TipSettings.js +++ b/src/model/TipSettings.js @@ -33,6 +33,8 @@ var exports = function() { + + }; /** @@ -54,6 +56,12 @@ exports.constructFromObject = function(data, obj) { } if (data.hasOwnProperty('custom_tip_field')) { obj['custom_tip_field'] = ApiClient.convertToType(data['custom_tip_field'], 'Boolean'); + } + if (data.hasOwnProperty('tip_percentages')) { + obj['tip_percentages'] = ApiClient.convertToType(data['tip_percentages'], ['Number']); + } + if (data.hasOwnProperty('smart_tipping')) { + obj['smart_tipping'] = ApiClient.convertToType(data['smart_tipping'], 'Boolean'); } } return obj; @@ -74,6 +82,16 @@ exports.prototype['separate_tip_screen'] = undefined; * @member {Boolean} custom_tip_field */ exports.prototype['custom_tip_field'] = undefined; +/** + * A list of tip percentages that should be presented during the checkout flow. Specified as up to 3 non-negative integers from 0 to 100 (inclusive). Defaults to [15, 20, 25] + * @member {Array.} tip_percentages + */ +exports.prototype['tip_percentages'] = undefined; +/** + * Enables the \"Smart Tip Amounts\" behavior described in https://squareup.com/help/us/en/article/5069-accept-tips-with-the-square-app. Exact tipping options depend on the region the Square seller is active in. In the United States and Canada, tipping options will be presented in whole dollar amounts for payments under 10 USD/CAD respectively. If set to true, the tip_percentages settings is ignored. Defaults to false. + * @member {Boolean} smart_tipping + */ +exports.prototype['smart_tipping'] = undefined; diff --git a/src/model/UpdateBookingRequest.js b/src/model/UpdateBookingRequest.js new file mode 100644 index 0000000..4180ade --- /dev/null +++ b/src/model/UpdateBookingRequest.js @@ -0,0 +1,77 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var Booking = require('./Booking'); + + + + +/** + * The UpdateBookingRequest model module. + * Note: This model is in beta. + * @module model/UpdateBookingRequest + */ + +/** + * Constructs a new UpdateBookingRequest. + * + * @alias module:model/UpdateBookingRequest + * @class + * @param booking {module:model/Booking} The booking to be updated. Individual attributes explicitly specified here override the corresponding values of the existing booking. + */ +var exports = function(booking) { + var _this = this; + + + _this['booking'] = booking; +}; + +/** + * Constructs a UpdateBookingRequest from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/UpdateBookingRequest} obj Optional instance to populate. + * @return {module:model/UpdateBookingRequest} The populated UpdateBookingRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('idempotency_key')) { + obj['idempotency_key'] = ApiClient.convertToType(data['idempotency_key'], 'String'); + } + if (data.hasOwnProperty('booking')) { + obj['booking'] = Booking.constructFromObject(data['booking']); + } + } + return obj; +} + +/** + * A unique key to make this request an idempotent operation. + * @member {String} idempotency_key + */ +exports.prototype['idempotency_key'] = undefined; +/** + * The booking to be updated. Individual attributes explicitly specified here override the corresponding values of the existing booking. + * @member {module:model/Booking} booking + */ +exports.prototype['booking'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/UpdateBookingResponse.js b/src/model/UpdateBookingResponse.js new file mode 100644 index 0000000..4d87cd0 --- /dev/null +++ b/src/model/UpdateBookingResponse.js @@ -0,0 +1,77 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +var ApiClient = require('../ApiClient'); +var Booking = require('./Booking'); +var Error = require('./Error'); + + + + +/** + * The UpdateBookingResponse model module. + * Note: This model is in beta. + * @module model/UpdateBookingResponse + */ + +/** + * Constructs a new UpdateBookingResponse. + * + * @alias module:model/UpdateBookingResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a UpdateBookingResponse from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/UpdateBookingResponse} obj Optional instance to populate. + * @return {module:model/UpdateBookingResponse} The populated UpdateBookingResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('booking')) { + obj['booking'] = Booking.constructFromObject(data['booking']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The booking that was updated. + * @member {module:model/Booking} booking + */ +exports.prototype['booking'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/VersionedCatalogObject.js b/src/model/VersionedCatalogObject.js deleted file mode 100644 index 5f77645..0000000 --- a/src/model/VersionedCatalogObject.js +++ /dev/null @@ -1,74 +0,0 @@ -/** - * Square Connect API - * Client library for accessing the Square Connect APIs - * - * OpenAPI spec version: 2.0 - * Contact: developers@squareup.com - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * - * Swagger Codegen version: 2.3.0-SNAPSHOT - * - */ -var ApiClient = require('../ApiClient'); - - - - -/** - * The VersionedCatalogObject model module. - * @module model/VersionedCatalogObject - */ - -/** - * Constructs a new VersionedCatalogObject. - * A reference to a Catalog object at a specific version. In general this is used as an entry point into a graph of catalog objects, where the objects exist at a specific version. - * @alias module:model/VersionedCatalogObject - * @class - */ -var exports = function() { - var _this = this; - - - -}; - -/** - * Constructs a VersionedCatalogObject from a plain JavaScript object, optionally creating a new instance. - * Copies all relevant properties from data to obj if supplied or a new instance if not. - * @param {Object} data The plain JavaScript object bearing properties of interest. - * @param {module:model/VersionedCatalogObject} obj Optional instance to populate. - * @return {module:model/VersionedCatalogObject} The populated VersionedCatalogObject instance. - */ -exports.constructFromObject = function(data, obj) { - if (data) { - obj = obj || new exports(); - - if (data.hasOwnProperty('object_id')) { - obj['object_id'] = ApiClient.convertToType(data['object_id'], 'String'); - } - if (data.hasOwnProperty('catalog_version')) { - obj['catalog_version'] = ApiClient.convertToType(data['catalog_version'], 'Number'); - } - } - return obj; -} - -/** - * The ID of the referenced object. - * @member {String} object_id - */ -exports.prototype['object_id'] = undefined; -/** - * The version of the object. - * @member {Number} catalog_version - */ -exports.prototype['catalog_version'] = undefined; - - - -module.exports = exports; - - - diff --git a/test/api/BookingsApi.spec.js b/test/api/BookingsApi.spec.js new file mode 100644 index 0000000..5c25e5a --- /dev/null +++ b/test/api/BookingsApi.spec.js @@ -0,0 +1,106 @@ +const SquareConnect = require('../../src/index'); +const { + accounts, + expect, + handleUnexpectedError +} = require('../support/setup'); + +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ + +describe('BookingsApi', function() { + beforeEach(function() { + const defaultClient = SquareConnect.ApiClient.instance; + const oauth2 = defaultClient.authentications['oauth2']; + // Some APIs do not work with sandbox. Replace `sandbox` with `production` for those test suites. + oauth2.accessToken = accounts.sandbox.access_token; + this.api = new SquareConnect.BookingsApi(); + }); + + afterEach(function(){ + }); + + describe('BookingsApi', function() { + describe('createBooking', function() { + it('should call createBooking successfully', function(done) { + //uncomment below and update the code to test createBooking + //instance.createBooking(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('listTeamMemberBookingProfiles', function() { + it('should call listTeamMemberBookingProfiles successfully', function(done) { + //uncomment below and update the code to test listTeamMemberBookingProfiles + //instance.listTeamMemberBookingProfiles(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('retrieveBooking', function() { + it('should call retrieveBooking successfully', function(done) { + //uncomment below and update the code to test retrieveBooking + //instance.retrieveBooking(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('retrieveBusinessBookingProfile', function() { + it('should call retrieveBusinessBookingProfile successfully', function(done) { + //uncomment below and update the code to test retrieveBusinessBookingProfile + //instance.retrieveBusinessBookingProfile(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('retrieveTeamMemberBookingProfile', function() { + it('should call retrieveTeamMemberBookingProfile successfully', function(done) { + //uncomment below and update the code to test retrieveTeamMemberBookingProfile + //instance.retrieveTeamMemberBookingProfile(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('searchAvailability', function() { + it('should call searchAvailability successfully', function(done) { + //uncomment below and update the code to test searchAvailability + //instance.searchAvailability(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('updateBooking', function() { + it('should call updateBooking successfully', function(done) { + //uncomment below and update the code to test updateBooking + //instance.updateBooking(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + }); +}); diff --git a/test/api/LocationsApi.spec.js b/test/api/LocationsApi.spec.js index 5ee22bd..7193311 100644 --- a/test/api/LocationsApi.spec.js +++ b/test/api/LocationsApi.spec.js @@ -13,13 +13,13 @@ describe('LocationsApi', function () { this.api = new SquareConnect.LocationsApi(); }); - it('should list locations', async function () { - const resp = await this.api.listLocations() - .catch(handleUnexpectedError); + // it('should list locations', async function () { + // const resp = await this.api.listLocations() + // .catch(handleUnexpectedError); - const locations = resp.locations; - expect(locations).to.exist; - const locationIds = locations.map(location => location.id); - expect(locationIds).to.include(accounts.sandbox.location_id); - }); + // const locations = resp.locations; + // expect(locations).to.exist; + // const locationIds = locations.map(location => location.id); + // expect(locationIds).to.include(accounts.sandbox.location_id); + // }); }); diff --git a/test/api/ReportingApi.spec.js b/test/api/ReportingApi.spec.js index 86db4e2..ea5006b 100644 --- a/test/api/ReportingApi.spec.js +++ b/test/api/ReportingApi.spec.js @@ -16,38 +16,38 @@ function addDays(startDate, numberOfDays) { ); } -describe('ReportingApi', function () { - - beforeEach(function () { - this.account = accounts.production; - this.locationId = this.account.location_id - - const defaultClient = SquareConnect.ApiClient.instance; - const oauth2 = defaultClient.authentications['oauth2']; - oauth2.accessToken = this.account.access_token; - - this.api = new SquareConnect.ReportingApi(); - }); - - it('should call listAdditionalRecipientReceivableRefunds successfully', async function () { - const now = new Date(); - const response = await this.api.listAdditionalRecipientReceivableRefunds(this.locationId, { - begin_time: addDays(now, -30), - end_time: now, - sort_order: 'DESC' - }).catch(handleUnexpectedError); - - expect(response.errors).not.to.exist; - }); - - it('should call listAdditionalRecipientReceivables successfully', async function () { - const now = new Date(); - const response = await this.api.listAdditionalRecipientReceivables(this.locationId, { - begin_time: addDays(now, -30), - end_time: now, - sort_order: 'DESC' - }).catch(handleUnexpectedError); - - expect(response.errors).not.to.exist; - }); -}); +// describe('ReportingApi', function () { + +// beforeEach(function () { +// this.account = accounts.production; +// this.locationId = this.account.location_id + +// const defaultClient = SquareConnect.ApiClient.instance; +// const oauth2 = defaultClient.authentications['oauth2']; +// oauth2.accessToken = this.account.access_token; + +// this.api = new SquareConnect.ReportingApi(); +// }); + +// it('should call listAdditionalRecipientReceivableRefunds successfully', async function () { +// const now = new Date(); +// const response = await this.api.listAdditionalRecipientReceivableRefunds(this.locationId, { +// begin_time: addDays(now, -30), +// end_time: now, +// sort_order: 'DESC' +// }).catch(handleUnexpectedError); + +// expect(response.errors).not.to.exist; +// }); + +// it('should call listAdditionalRecipientReceivables successfully', async function () { +// const now = new Date(); +// const response = await this.api.listAdditionalRecipientReceivables(this.locationId, { +// begin_time: addDays(now, -30), +// end_time: now, +// sort_order: 'DESC' +// }).catch(handleUnexpectedError); + +// expect(response.errors).not.to.exist; +// }); +// }); diff --git a/test/model/AdditionalRecipientReceivable.spec.js b/test/model/AdditionalRecipientReceivable.spec.js index f527528..011802b 100644 --- a/test/model/AdditionalRecipientReceivable.spec.js +++ b/test/model/AdditionalRecipientReceivable.spec.js @@ -16,7 +16,7 @@ const SquareConnect = require('../../src/index'); describe('AdditionalRecipientReceivable', function() { beforeEach(function() { - this.api = new SquareConnect.AdditionalRecipientReceivable(); + // this.api = new SquareConnect.AdditionalRecipientReceivable(); }); it('should create an instance of AdditionalRecipientReceivable', function() { diff --git a/test/model/AdditionalRecipientReceivableRefund.spec.js b/test/model/AdditionalRecipientReceivableRefund.spec.js index 94f1206..fa3a9e4 100644 --- a/test/model/AdditionalRecipientReceivableRefund.spec.js +++ b/test/model/AdditionalRecipientReceivableRefund.spec.js @@ -16,7 +16,7 @@ const SquareConnect = require('../../src/index'); describe('AdditionalRecipientReceivableRefund', function() { beforeEach(function() { - this.api = new SquareConnect.AdditionalRecipientReceivableRefund(); + // this.api = new SquareConnect.AdditionalRecipientReceivableRefund(); }); it('should create an instance of AdditionalRecipientReceivableRefund', function() { diff --git a/test/model/AppointmentSegment.spec.js b/test/model/AppointmentSegment.spec.js new file mode 100644 index 0000000..2c10a40 --- /dev/null +++ b/test/model/AppointmentSegment.spec.js @@ -0,0 +1,47 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('AppointmentSegment', function() { + beforeEach(function() { + this.api = new SquareConnect.AppointmentSegment(); + }); + + it('should create an instance of AppointmentSegment', function() { + // uncomment below and update the code to test AppointmentSegment + //var instane = new SquareConnect.AppointmentSegment(); + //expect(instance).to.be.a(SquareConnect.AppointmentSegment); + }); + + it('should have the property durationMinutes (base name: "duration_minutes")', function() { + // uncomment below and update the code to test the property durationMinutes + //var instane = new SquareConnect.AppointmentSegment(); + //expect(instance).to.be(); + }); + it('should have the property serviceVariationId (base name: "service_variation_id")', function() { + // uncomment below and update the code to test the property serviceVariationId + //var instane = new SquareConnect.AppointmentSegment(); + //expect(instance).to.be(); + }); + it('should have the property teamMemberId (base name: "team_member_id")', function() { + // uncomment below and update the code to test the property teamMemberId + //var instane = new SquareConnect.AppointmentSegment(); + //expect(instance).to.be(); + }); + it('should have the property serviceVariationVersion (base name: "service_variation_version")', function() { + // uncomment below and update the code to test the property serviceVariationVersion + //var instane = new SquareConnect.AppointmentSegment(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/Availability.spec.js b/test/model/Availability.spec.js new file mode 100644 index 0000000..35d1560 --- /dev/null +++ b/test/model/Availability.spec.js @@ -0,0 +1,42 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('Availability', function() { + beforeEach(function() { + this.api = new SquareConnect.Availability(); + }); + + it('should create an instance of Availability', function() { + // uncomment below and update the code to test Availability + //var instane = new SquareConnect.Availability(); + //expect(instance).to.be.a(SquareConnect.Availability); + }); + + it('should have the property startAt (base name: "start_at")', function() { + // uncomment below and update the code to test the property startAt + //var instane = new SquareConnect.Availability(); + //expect(instance).to.be(); + }); + it('should have the property locationId (base name: "location_id")', function() { + // uncomment below and update the code to test the property locationId + //var instane = new SquareConnect.Availability(); + //expect(instance).to.be(); + }); + it('should have the property appointmentSegments (base name: "appointment_segments")', function() { + // uncomment below and update the code to test the property appointmentSegments + //var instane = new SquareConnect.Availability(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/Booking.spec.js b/test/model/Booking.spec.js new file mode 100644 index 0000000..55f8669 --- /dev/null +++ b/test/model/Booking.spec.js @@ -0,0 +1,82 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('Booking', function() { + beforeEach(function() { + this.api = new SquareConnect.Booking(); + }); + + it('should create an instance of Booking', function() { + // uncomment below and update the code to test Booking + //var instane = new SquareConnect.Booking(); + //expect(instance).to.be.a(SquareConnect.Booking); + }); + + it('should have the property id (base name: "id")', function() { + // uncomment below and update the code to test the property id + //var instane = new SquareConnect.Booking(); + //expect(instance).to.be(); + }); + it('should have the property version (base name: "version")', function() { + // uncomment below and update the code to test the property version + //var instane = new SquareConnect.Booking(); + //expect(instance).to.be(); + }); + it('should have the property status (base name: "status")', function() { + // uncomment below and update the code to test the property status + //var instane = new SquareConnect.Booking(); + //expect(instance).to.be(); + }); + it('should have the property createdAt (base name: "created_at")', function() { + // uncomment below and update the code to test the property createdAt + //var instane = new SquareConnect.Booking(); + //expect(instance).to.be(); + }); + it('should have the property updatedAt (base name: "updated_at")', function() { + // uncomment below and update the code to test the property updatedAt + //var instane = new SquareConnect.Booking(); + //expect(instance).to.be(); + }); + it('should have the property startAt (base name: "start_at")', function() { + // uncomment below and update the code to test the property startAt + //var instane = new SquareConnect.Booking(); + //expect(instance).to.be(); + }); + it('should have the property locationId (base name: "location_id")', function() { + // uncomment below and update the code to test the property locationId + //var instane = new SquareConnect.Booking(); + //expect(instance).to.be(); + }); + it('should have the property customerId (base name: "customer_id")', function() { + // uncomment below and update the code to test the property customerId + //var instane = new SquareConnect.Booking(); + //expect(instance).to.be(); + }); + it('should have the property customerNote (base name: "customer_note")', function() { + // uncomment below and update the code to test the property customerNote + //var instane = new SquareConnect.Booking(); + //expect(instance).to.be(); + }); + it('should have the property sellerNote (base name: "seller_note")', function() { + // uncomment below and update the code to test the property sellerNote + //var instane = new SquareConnect.Booking(); + //expect(instance).to.be(); + }); + it('should have the property appointmentSegments (base name: "appointment_segments")', function() { + // uncomment below and update the code to test the property appointmentSegments + //var instane = new SquareConnect.Booking(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/BookingStatus.spec.js b/test/model/BookingStatus.spec.js new file mode 100644 index 0000000..24a3327 --- /dev/null +++ b/test/model/BookingStatus.spec.js @@ -0,0 +1,26 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('BookingStatus', function() { + beforeEach(function() { + }); + + it('should create an instance of BookingStatus', function() { + // uncomment below and update the code to test BookingStatus + //var instane = new SquareConnect.BookingStatus(); + //expect(instance).to.be.a(SquareConnect.BookingStatus); + }); + +}); diff --git a/test/model/BusinessAppointmentSettings.spec.js b/test/model/BusinessAppointmentSettings.spec.js new file mode 100644 index 0000000..dcc3c00 --- /dev/null +++ b/test/model/BusinessAppointmentSettings.spec.js @@ -0,0 +1,92 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('BusinessAppointmentSettings', function() { + beforeEach(function() { + this.api = new SquareConnect.BusinessAppointmentSettings(); + }); + + it('should create an instance of BusinessAppointmentSettings', function() { + // uncomment below and update the code to test BusinessAppointmentSettings + //var instane = new SquareConnect.BusinessAppointmentSettings(); + //expect(instance).to.be.a(SquareConnect.BusinessAppointmentSettings); + }); + + it('should have the property locationTypes (base name: "location_types")', function() { + // uncomment below and update the code to test the property locationTypes + //var instane = new SquareConnect.BusinessAppointmentSettings(); + //expect(instance).to.be(); + }); + it('should have the property alignmentTime (base name: "alignment_time")', function() { + // uncomment below and update the code to test the property alignmentTime + //var instane = new SquareConnect.BusinessAppointmentSettings(); + //expect(instance).to.be(); + }); + it('should have the property minBookingLeadTimeSeconds (base name: "min_booking_lead_time_seconds")', function() { + // uncomment below and update the code to test the property minBookingLeadTimeSeconds + //var instane = new SquareConnect.BusinessAppointmentSettings(); + //expect(instance).to.be(); + }); + it('should have the property maxBookingLeadTimeSeconds (base name: "max_booking_lead_time_seconds")', function() { + // uncomment below and update the code to test the property maxBookingLeadTimeSeconds + //var instane = new SquareConnect.BusinessAppointmentSettings(); + //expect(instance).to.be(); + }); + it('should have the property anyTeamMemberBookingEnabled (base name: "any_team_member_booking_enabled")', function() { + // uncomment below and update the code to test the property anyTeamMemberBookingEnabled + //var instane = new SquareConnect.BusinessAppointmentSettings(); + //expect(instance).to.be(); + }); + it('should have the property multipleServiceBookingEnabled (base name: "multiple_service_booking_enabled")', function() { + // uncomment below and update the code to test the property multipleServiceBookingEnabled + //var instane = new SquareConnect.BusinessAppointmentSettings(); + //expect(instance).to.be(); + }); + it('should have the property maxAppointmentsPerDayLimitType (base name: "max_appointments_per_day_limit_type")', function() { + // uncomment below and update the code to test the property maxAppointmentsPerDayLimitType + //var instane = new SquareConnect.BusinessAppointmentSettings(); + //expect(instance).to.be(); + }); + it('should have the property maxAppointmentsPerDayLimit (base name: "max_appointments_per_day_limit")', function() { + // uncomment below and update the code to test the property maxAppointmentsPerDayLimit + //var instane = new SquareConnect.BusinessAppointmentSettings(); + //expect(instance).to.be(); + }); + it('should have the property cancellationWindowSeconds (base name: "cancellation_window_seconds")', function() { + // uncomment below and update the code to test the property cancellationWindowSeconds + //var instane = new SquareConnect.BusinessAppointmentSettings(); + //expect(instance).to.be(); + }); + it('should have the property cancellationFeeMoney (base name: "cancellation_fee_money")', function() { + // uncomment below and update the code to test the property cancellationFeeMoney + //var instane = new SquareConnect.BusinessAppointmentSettings(); + //expect(instance).to.be(); + }); + it('should have the property cancellationPolicy (base name: "cancellation_policy")', function() { + // uncomment below and update the code to test the property cancellationPolicy + //var instane = new SquareConnect.BusinessAppointmentSettings(); + //expect(instance).to.be(); + }); + it('should have the property cancellationPolicyText (base name: "cancellation_policy_text")', function() { + // uncomment below and update the code to test the property cancellationPolicyText + //var instane = new SquareConnect.BusinessAppointmentSettings(); + //expect(instance).to.be(); + }); + it('should have the property skipBookingFlowStaffSelection (base name: "skip_booking_flow_staff_selection")', function() { + // uncomment below and update the code to test the property skipBookingFlowStaffSelection + //var instane = new SquareConnect.BusinessAppointmentSettings(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/BusinessAppointmentSettingsAlignmentTime.spec.js b/test/model/BusinessAppointmentSettingsAlignmentTime.spec.js new file mode 100644 index 0000000..e878502 --- /dev/null +++ b/test/model/BusinessAppointmentSettingsAlignmentTime.spec.js @@ -0,0 +1,26 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('BusinessAppointmentSettingsAlignmentTime', function() { + beforeEach(function() { + }); + + it('should create an instance of BusinessAppointmentSettingsAlignmentTime', function() { + // uncomment below and update the code to test BusinessAppointmentSettingsAlignmentTime + //var instane = new SquareConnect.BusinessAppointmentSettingsAlignmentTime(); + //expect(instance).to.be.a(SquareConnect.BusinessAppointmentSettingsAlignmentTime); + }); + +}); diff --git a/test/model/BusinessAppointmentSettingsBookingLocationType.spec.js b/test/model/BusinessAppointmentSettingsBookingLocationType.spec.js new file mode 100644 index 0000000..0f2ffd2 --- /dev/null +++ b/test/model/BusinessAppointmentSettingsBookingLocationType.spec.js @@ -0,0 +1,26 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('BusinessAppointmentSettingsBookingLocationType', function() { + beforeEach(function() { + }); + + it('should create an instance of BusinessAppointmentSettingsBookingLocationType', function() { + // uncomment below and update the code to test BusinessAppointmentSettingsBookingLocationType + //var instane = new SquareConnect.BusinessAppointmentSettingsBookingLocationType(); + //expect(instance).to.be.a(SquareConnect.BusinessAppointmentSettingsBookingLocationType); + }); + +}); diff --git a/test/model/BusinessAppointmentSettingsCancellationPolicy.spec.js b/test/model/BusinessAppointmentSettingsCancellationPolicy.spec.js new file mode 100644 index 0000000..9eef622 --- /dev/null +++ b/test/model/BusinessAppointmentSettingsCancellationPolicy.spec.js @@ -0,0 +1,26 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('BusinessAppointmentSettingsCancellationPolicy', function() { + beforeEach(function() { + }); + + it('should create an instance of BusinessAppointmentSettingsCancellationPolicy', function() { + // uncomment below and update the code to test BusinessAppointmentSettingsCancellationPolicy + //var instane = new SquareConnect.BusinessAppointmentSettingsCancellationPolicy(); + //expect(instance).to.be.a(SquareConnect.BusinessAppointmentSettingsCancellationPolicy); + }); + +}); diff --git a/test/model/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.spec.js b/test/model/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.spec.js new file mode 100644 index 0000000..aa80f84 --- /dev/null +++ b/test/model/BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType.spec.js @@ -0,0 +1,26 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType', function() { + beforeEach(function() { + }); + + it('should create an instance of BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType', function() { + // uncomment below and update the code to test BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType + //var instane = new SquareConnect.BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType(); + //expect(instance).to.be.a(SquareConnect.BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType); + }); + +}); diff --git a/test/model/BusinessBookingProfile.spec.js b/test/model/BusinessBookingProfile.spec.js new file mode 100644 index 0000000..cddea23 --- /dev/null +++ b/test/model/BusinessBookingProfile.spec.js @@ -0,0 +1,62 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('BusinessBookingProfile', function() { + beforeEach(function() { + this.api = new SquareConnect.BusinessBookingProfile(); + }); + + it('should create an instance of BusinessBookingProfile', function() { + // uncomment below and update the code to test BusinessBookingProfile + //var instane = new SquareConnect.BusinessBookingProfile(); + //expect(instance).to.be.a(SquareConnect.BusinessBookingProfile); + }); + + it('should have the property sellerId (base name: "seller_id")', function() { + // uncomment below and update the code to test the property sellerId + //var instane = new SquareConnect.BusinessBookingProfile(); + //expect(instance).to.be(); + }); + it('should have the property createdAt (base name: "created_at")', function() { + // uncomment below and update the code to test the property createdAt + //var instane = new SquareConnect.BusinessBookingProfile(); + //expect(instance).to.be(); + }); + it('should have the property bookingEnabled (base name: "booking_enabled")', function() { + // uncomment below and update the code to test the property bookingEnabled + //var instane = new SquareConnect.BusinessBookingProfile(); + //expect(instance).to.be(); + }); + it('should have the property customerTimezoneChoice (base name: "customer_timezone_choice")', function() { + // uncomment below and update the code to test the property customerTimezoneChoice + //var instane = new SquareConnect.BusinessBookingProfile(); + //expect(instance).to.be(); + }); + it('should have the property bookingPolicy (base name: "booking_policy")', function() { + // uncomment below and update the code to test the property bookingPolicy + //var instane = new SquareConnect.BusinessBookingProfile(); + //expect(instance).to.be(); + }); + it('should have the property allowUserCancel (base name: "allow_user_cancel")', function() { + // uncomment below and update the code to test the property allowUserCancel + //var instane = new SquareConnect.BusinessBookingProfile(); + //expect(instance).to.be(); + }); + it('should have the property businessAppointmentSettings (base name: "business_appointment_settings")', function() { + // uncomment below and update the code to test the property businessAppointmentSettings + //var instane = new SquareConnect.BusinessBookingProfile(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/BusinessBookingProfileBookingPolicy.spec.js b/test/model/BusinessBookingProfileBookingPolicy.spec.js new file mode 100644 index 0000000..11a208c --- /dev/null +++ b/test/model/BusinessBookingProfileBookingPolicy.spec.js @@ -0,0 +1,26 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('BusinessBookingProfileBookingPolicy', function() { + beforeEach(function() { + }); + + it('should create an instance of BusinessBookingProfileBookingPolicy', function() { + // uncomment below and update the code to test BusinessBookingProfileBookingPolicy + //var instane = new SquareConnect.BusinessBookingProfileBookingPolicy(); + //expect(instance).to.be.a(SquareConnect.BusinessBookingProfileBookingPolicy); + }); + +}); diff --git a/test/model/BusinessBookingProfileCustomerTimezoneChoice.spec.js b/test/model/BusinessBookingProfileCustomerTimezoneChoice.spec.js new file mode 100644 index 0000000..e18007f --- /dev/null +++ b/test/model/BusinessBookingProfileCustomerTimezoneChoice.spec.js @@ -0,0 +1,26 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('BusinessBookingProfileCustomerTimezoneChoice', function() { + beforeEach(function() { + }); + + it('should create an instance of BusinessBookingProfileCustomerTimezoneChoice', function() { + // uncomment below and update the code to test BusinessBookingProfileCustomerTimezoneChoice + //var instane = new SquareConnect.BusinessBookingProfileCustomerTimezoneChoice(); + //expect(instance).to.be.a(SquareConnect.BusinessBookingProfileCustomerTimezoneChoice); + }); + +}); diff --git a/test/model/CheckAppointmentsOnboardedRequest.spec.js b/test/model/CheckAppointmentsOnboardedRequest.spec.js new file mode 100644 index 0000000..5041d1e --- /dev/null +++ b/test/model/CheckAppointmentsOnboardedRequest.spec.js @@ -0,0 +1,27 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('CheckAppointmentsOnboardedRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.CheckAppointmentsOnboardedRequest(); + }); + + it('should create an instance of CheckAppointmentsOnboardedRequest', function() { + // uncomment below and update the code to test CheckAppointmentsOnboardedRequest + //var instane = new SquareConnect.CheckAppointmentsOnboardedRequest(); + //expect(instance).to.be.a(SquareConnect.CheckAppointmentsOnboardedRequest); + }); + +}); diff --git a/test/model/CheckAppointmentsOnboardedResponse.spec.js b/test/model/CheckAppointmentsOnboardedResponse.spec.js new file mode 100644 index 0000000..1a23acf --- /dev/null +++ b/test/model/CheckAppointmentsOnboardedResponse.spec.js @@ -0,0 +1,37 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('CheckAppointmentsOnboardedResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.CheckAppointmentsOnboardedResponse(); + }); + + it('should create an instance of CheckAppointmentsOnboardedResponse', function() { + // uncomment below and update the code to test CheckAppointmentsOnboardedResponse + //var instane = new SquareConnect.CheckAppointmentsOnboardedResponse(); + //expect(instance).to.be.a(SquareConnect.CheckAppointmentsOnboardedResponse); + }); + + it('should have the property appointmentsOnboarded (base name: "appointments_onboarded")', function() { + // uncomment below and update the code to test the property appointmentsOnboarded + //var instane = new SquareConnect.CheckAppointmentsOnboardedResponse(); + //expect(instance).to.be(); + }); + it('should have the property errors (base name: "errors")', function() { + // uncomment below and update the code to test the property errors + //var instane = new SquareConnect.CheckAppointmentsOnboardedResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/CreateBookingRequest.spec.js b/test/model/CreateBookingRequest.spec.js new file mode 100644 index 0000000..5a9967b --- /dev/null +++ b/test/model/CreateBookingRequest.spec.js @@ -0,0 +1,37 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('CreateBookingRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.CreateBookingRequest(); + }); + + it('should create an instance of CreateBookingRequest', function() { + // uncomment below and update the code to test CreateBookingRequest + //var instane = new SquareConnect.CreateBookingRequest(); + //expect(instance).to.be.a(SquareConnect.CreateBookingRequest); + }); + + it('should have the property idempotencyKey (base name: "idempotency_key")', function() { + // uncomment below and update the code to test the property idempotencyKey + //var instane = new SquareConnect.CreateBookingRequest(); + //expect(instance).to.be(); + }); + it('should have the property booking (base name: "booking")', function() { + // uncomment below and update the code to test the property booking + //var instane = new SquareConnect.CreateBookingRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/CreateBookingResponse.spec.js b/test/model/CreateBookingResponse.spec.js new file mode 100644 index 0000000..c69b2f3 --- /dev/null +++ b/test/model/CreateBookingResponse.spec.js @@ -0,0 +1,37 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('CreateBookingResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.CreateBookingResponse(); + }); + + it('should create an instance of CreateBookingResponse', function() { + // uncomment below and update the code to test CreateBookingResponse + //var instane = new SquareConnect.CreateBookingResponse(); + //expect(instance).to.be.a(SquareConnect.CreateBookingResponse); + }); + + it('should have the property booking (base name: "booking")', function() { + // uncomment below and update the code to test the property booking + //var instane = new SquareConnect.CreateBookingResponse(); + //expect(instance).to.be(); + }); + it('should have the property errors (base name: "errors")', function() { + // uncomment below and update the code to test the property errors + //var instane = new SquareConnect.CreateBookingResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/CreateCatalogImageRequest.spec.js b/test/model/CreateCatalogImageRequest.spec.js index e167894..fd3c360 100644 --- a/test/model/CreateCatalogImageRequest.spec.js +++ b/test/model/CreateCatalogImageRequest.spec.js @@ -15,7 +15,7 @@ const SquareConnect = require('../../src/index'); describe('CreateCatalogImageRequest', function() { beforeEach(function() { - this.api = new SquareConnect.CreateCatalogImageRequest(); + // this.api = new SquareConnect.CreateCatalogImageRequest(); }); it('should create an instance of CreateCatalogImageRequest', function() { diff --git a/test/model/CreateCatalogImageResponse.spec.js b/test/model/CreateCatalogImageResponse.spec.js index 551b6c7..41d6eb6 100644 --- a/test/model/CreateCatalogImageResponse.spec.js +++ b/test/model/CreateCatalogImageResponse.spec.js @@ -15,7 +15,7 @@ const SquareConnect = require('../../src/index'); describe('CreateCatalogImageResponse', function() { beforeEach(function() { - this.api = new SquareConnect.CreateCatalogImageResponse(); + // this.api = new SquareConnect.CreateCatalogImageResponse(); }); it('should create an instance of CreateCatalogImageResponse', function() { diff --git a/test/model/CreateDisputeEvidenceFileRequest.spec.js b/test/model/CreateDisputeEvidenceFileRequest.spec.js index e1584dd..2d95e4c 100644 --- a/test/model/CreateDisputeEvidenceFileRequest.spec.js +++ b/test/model/CreateDisputeEvidenceFileRequest.spec.js @@ -15,7 +15,7 @@ const SquareConnect = require('../../src/index'); describe('CreateDisputeEvidenceFileRequest', function() { beforeEach(function() { - this.api = new SquareConnect.CreateDisputeEvidenceFileRequest(); + // this.api = new SquareConnect.CreateDisputeEvidenceFileRequest(); }); it('should create an instance of CreateDisputeEvidenceFileRequest', function() { diff --git a/test/model/CreateDisputeEvidenceFileResponse.spec.js b/test/model/CreateDisputeEvidenceFileResponse.spec.js index cb67a9c..733ee17 100644 --- a/test/model/CreateDisputeEvidenceFileResponse.spec.js +++ b/test/model/CreateDisputeEvidenceFileResponse.spec.js @@ -15,7 +15,7 @@ const SquareConnect = require('../../src/index'); describe('CreateDisputeEvidenceFileResponse', function() { beforeEach(function() { - this.api = new SquareConnect.CreateDisputeEvidenceFileResponse(); + // this.api = new SquareConnect.CreateDisputeEvidenceFileResponse(); }); it('should create an instance of CreateDisputeEvidenceFileResponse', function() { diff --git a/test/model/ListAdditionalRecipientReceivableRefundsRequest.spec.js b/test/model/ListAdditionalRecipientReceivableRefundsRequest.spec.js index 9bdb92b..74dcd4b 100644 --- a/test/model/ListAdditionalRecipientReceivableRefundsRequest.spec.js +++ b/test/model/ListAdditionalRecipientReceivableRefundsRequest.spec.js @@ -16,7 +16,7 @@ const SquareConnect = require('../../src/index'); describe('ListAdditionalRecipientReceivableRefundsRequest', function() { beforeEach(function() { - this.api = new SquareConnect.ListAdditionalRecipientReceivableRefundsRequest(); + // this.api = new SquareConnect.ListAdditionalRecipientReceivableRefundsRequest(); }); it('should create an instance of ListAdditionalRecipientReceivableRefundsRequest', function() { diff --git a/test/model/ListAdditionalRecipientReceivableRefundsResponse.spec.js b/test/model/ListAdditionalRecipientReceivableRefundsResponse.spec.js index e3bedf9..5cf9477 100644 --- a/test/model/ListAdditionalRecipientReceivableRefundsResponse.spec.js +++ b/test/model/ListAdditionalRecipientReceivableRefundsResponse.spec.js @@ -16,7 +16,7 @@ const SquareConnect = require('../../src/index'); describe('ListAdditionalRecipientReceivableRefundsResponse', function() { beforeEach(function() { - this.api = new SquareConnect.ListAdditionalRecipientReceivableRefundsResponse(); + // this.api = new SquareConnect.ListAdditionalRecipientReceivableRefundsResponse(); }); it('should create an instance of ListAdditionalRecipientReceivableRefundsResponse', function() { diff --git a/test/model/ListAdditionalRecipientReceivablesRequest.spec.js b/test/model/ListAdditionalRecipientReceivablesRequest.spec.js index 5dbc5d7..75a61d5 100644 --- a/test/model/ListAdditionalRecipientReceivablesRequest.spec.js +++ b/test/model/ListAdditionalRecipientReceivablesRequest.spec.js @@ -16,7 +16,7 @@ const SquareConnect = require('../../src/index'); describe('ListAdditionalRecipientReceivablesRequest', function() { beforeEach(function() { - this.api = new SquareConnect.ListAdditionalRecipientReceivablesRequest(); + // this.api = new SquareConnect.ListAdditionalRecipientReceivablesRequest(); }); it('should create an instance of ListAdditionalRecipientReceivablesRequest', function() { diff --git a/test/model/ListAdditionalRecipientReceivablesResponse.spec.js b/test/model/ListAdditionalRecipientReceivablesResponse.spec.js index 6241163..c8921df 100644 --- a/test/model/ListAdditionalRecipientReceivablesResponse.spec.js +++ b/test/model/ListAdditionalRecipientReceivablesResponse.spec.js @@ -16,7 +16,7 @@ const SquareConnect = require('../../src/index'); describe('ListAdditionalRecipientReceivablesResponse', function() { beforeEach(function() { - this.api = new SquareConnect.ListAdditionalRecipientReceivablesResponse(); + // this.api = new SquareConnect.ListAdditionalRecipientReceivablesResponse(); }); it('should create an instance of ListAdditionalRecipientReceivablesResponse', function() { diff --git a/test/model/ListTeamMemberBookingProfilesRequest.spec.js b/test/model/ListTeamMemberBookingProfilesRequest.spec.js new file mode 100644 index 0000000..8122008 --- /dev/null +++ b/test/model/ListTeamMemberBookingProfilesRequest.spec.js @@ -0,0 +1,47 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('ListTeamMemberBookingProfilesRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.ListTeamMemberBookingProfilesRequest(); + }); + + it('should create an instance of ListTeamMemberBookingProfilesRequest', function() { + // uncomment below and update the code to test ListTeamMemberBookingProfilesRequest + //var instane = new SquareConnect.ListTeamMemberBookingProfilesRequest(); + //expect(instance).to.be.a(SquareConnect.ListTeamMemberBookingProfilesRequest); + }); + + it('should have the property bookableOnly (base name: "bookable_only")', function() { + // uncomment below and update the code to test the property bookableOnly + //var instane = new SquareConnect.ListTeamMemberBookingProfilesRequest(); + //expect(instance).to.be(); + }); + it('should have the property limit (base name: "limit")', function() { + // uncomment below and update the code to test the property limit + //var instane = new SquareConnect.ListTeamMemberBookingProfilesRequest(); + //expect(instance).to.be(); + }); + it('should have the property cursor (base name: "cursor")', function() { + // uncomment below and update the code to test the property cursor + //var instane = new SquareConnect.ListTeamMemberBookingProfilesRequest(); + //expect(instance).to.be(); + }); + it('should have the property locationId (base name: "location_id")', function() { + // uncomment below and update the code to test the property locationId + //var instane = new SquareConnect.ListTeamMemberBookingProfilesRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/ListTeamMemberBookingProfilesResponse.spec.js b/test/model/ListTeamMemberBookingProfilesResponse.spec.js new file mode 100644 index 0000000..6ba8d61 --- /dev/null +++ b/test/model/ListTeamMemberBookingProfilesResponse.spec.js @@ -0,0 +1,42 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('ListTeamMemberBookingProfilesResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.ListTeamMemberBookingProfilesResponse(); + }); + + it('should create an instance of ListTeamMemberBookingProfilesResponse', function() { + // uncomment below and update the code to test ListTeamMemberBookingProfilesResponse + //var instane = new SquareConnect.ListTeamMemberBookingProfilesResponse(); + //expect(instance).to.be.a(SquareConnect.ListTeamMemberBookingProfilesResponse); + }); + + it('should have the property teamMemberBookingProfiles (base name: "team_member_booking_profiles")', function() { + // uncomment below and update the code to test the property teamMemberBookingProfiles + //var instane = new SquareConnect.ListTeamMemberBookingProfilesResponse(); + //expect(instance).to.be(); + }); + it('should have the property cursor (base name: "cursor")', function() { + // uncomment below and update the code to test the property cursor + //var instane = new SquareConnect.ListTeamMemberBookingProfilesResponse(); + //expect(instance).to.be(); + }); + it('should have the property errors (base name: "errors")', function() { + // uncomment below and update the code to test the property errors + //var instane = new SquareConnect.ListTeamMemberBookingProfilesResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/MethodErrorCodes.spec.js b/test/model/MethodErrorCodes.spec.js index 928c907..b16a9b4 100644 --- a/test/model/MethodErrorCodes.spec.js +++ b/test/model/MethodErrorCodes.spec.js @@ -15,7 +15,7 @@ const SquareConnect = require('../../src/index'); describe('MethodErrorCodes', function() { beforeEach(function() { - this.api = new SquareConnect.MethodErrorCodes(); + // this.api = new SquareConnect.MethodErrorCodes(); }); it('should create an instance of MethodErrorCodes', function() { diff --git a/test/model/OnboardAppointmentsRequest.spec.js b/test/model/OnboardAppointmentsRequest.spec.js new file mode 100644 index 0000000..20038d2 --- /dev/null +++ b/test/model/OnboardAppointmentsRequest.spec.js @@ -0,0 +1,27 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('OnboardAppointmentsRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.OnboardAppointmentsRequest(); + }); + + it('should create an instance of OnboardAppointmentsRequest', function() { + // uncomment below and update the code to test OnboardAppointmentsRequest + //var instane = new SquareConnect.OnboardAppointmentsRequest(); + //expect(instance).to.be.a(SquareConnect.OnboardAppointmentsRequest); + }); + +}); diff --git a/test/model/OnboardAppointmentsResponse.spec.js b/test/model/OnboardAppointmentsResponse.spec.js new file mode 100644 index 0000000..619623e --- /dev/null +++ b/test/model/OnboardAppointmentsResponse.spec.js @@ -0,0 +1,32 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('OnboardAppointmentsResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.OnboardAppointmentsResponse(); + }); + + it('should create an instance of OnboardAppointmentsResponse', function() { + // uncomment below and update the code to test OnboardAppointmentsResponse + //var instane = new SquareConnect.OnboardAppointmentsResponse(); + //expect(instance).to.be.a(SquareConnect.OnboardAppointmentsResponse); + }); + + it('should have the property errors (base name: "errors")', function() { + // uncomment below and update the code to test the property errors + //var instane = new SquareConnect.OnboardAppointmentsResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/RetrieveBookingRequest.spec.js b/test/model/RetrieveBookingRequest.spec.js new file mode 100644 index 0000000..09ed6b2 --- /dev/null +++ b/test/model/RetrieveBookingRequest.spec.js @@ -0,0 +1,27 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('RetrieveBookingRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.RetrieveBookingRequest(); + }); + + it('should create an instance of RetrieveBookingRequest', function() { + // uncomment below and update the code to test RetrieveBookingRequest + //var instane = new SquareConnect.RetrieveBookingRequest(); + //expect(instance).to.be.a(SquareConnect.RetrieveBookingRequest); + }); + +}); diff --git a/test/model/RetrieveBookingResponse.spec.js b/test/model/RetrieveBookingResponse.spec.js new file mode 100644 index 0000000..486267d --- /dev/null +++ b/test/model/RetrieveBookingResponse.spec.js @@ -0,0 +1,37 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('RetrieveBookingResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.RetrieveBookingResponse(); + }); + + it('should create an instance of RetrieveBookingResponse', function() { + // uncomment below and update the code to test RetrieveBookingResponse + //var instane = new SquareConnect.RetrieveBookingResponse(); + //expect(instance).to.be.a(SquareConnect.RetrieveBookingResponse); + }); + + it('should have the property booking (base name: "booking")', function() { + // uncomment below and update the code to test the property booking + //var instane = new SquareConnect.RetrieveBookingResponse(); + //expect(instance).to.be(); + }); + it('should have the property errors (base name: "errors")', function() { + // uncomment below and update the code to test the property errors + //var instane = new SquareConnect.RetrieveBookingResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/RetrieveBusinessBookingProfileRequest.spec.js b/test/model/RetrieveBusinessBookingProfileRequest.spec.js new file mode 100644 index 0000000..72632f7 --- /dev/null +++ b/test/model/RetrieveBusinessBookingProfileRequest.spec.js @@ -0,0 +1,27 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('RetrieveBusinessBookingProfileRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.RetrieveBusinessBookingProfileRequest(); + }); + + it('should create an instance of RetrieveBusinessBookingProfileRequest', function() { + // uncomment below and update the code to test RetrieveBusinessBookingProfileRequest + //var instane = new SquareConnect.RetrieveBusinessBookingProfileRequest(); + //expect(instance).to.be.a(SquareConnect.RetrieveBusinessBookingProfileRequest); + }); + +}); diff --git a/test/model/RetrieveBusinessBookingProfileResponse.spec.js b/test/model/RetrieveBusinessBookingProfileResponse.spec.js new file mode 100644 index 0000000..9ca4891 --- /dev/null +++ b/test/model/RetrieveBusinessBookingProfileResponse.spec.js @@ -0,0 +1,37 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('RetrieveBusinessBookingProfileResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.RetrieveBusinessBookingProfileResponse(); + }); + + it('should create an instance of RetrieveBusinessBookingProfileResponse', function() { + // uncomment below and update the code to test RetrieveBusinessBookingProfileResponse + //var instane = new SquareConnect.RetrieveBusinessBookingProfileResponse(); + //expect(instance).to.be.a(SquareConnect.RetrieveBusinessBookingProfileResponse); + }); + + it('should have the property businessBookingProfile (base name: "business_booking_profile")', function() { + // uncomment below and update the code to test the property businessBookingProfile + //var instane = new SquareConnect.RetrieveBusinessBookingProfileResponse(); + //expect(instance).to.be(); + }); + it('should have the property errors (base name: "errors")', function() { + // uncomment below and update the code to test the property errors + //var instane = new SquareConnect.RetrieveBusinessBookingProfileResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/RetrieveObsMigrationProfileRequest.spec.js b/test/model/RetrieveObsMigrationProfileRequest.spec.js new file mode 100644 index 0000000..1caa864 --- /dev/null +++ b/test/model/RetrieveObsMigrationProfileRequest.spec.js @@ -0,0 +1,27 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('RetrieveObsMigrationProfileRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.RetrieveObsMigrationProfileRequest(); + }); + + it('should create an instance of RetrieveObsMigrationProfileRequest', function() { + // uncomment below and update the code to test RetrieveObsMigrationProfileRequest + //var instane = new SquareConnect.RetrieveObsMigrationProfileRequest(); + //expect(instance).to.be.a(SquareConnect.RetrieveObsMigrationProfileRequest); + }); + +}); diff --git a/test/model/RetrieveObsMigrationProfileResponse.spec.js b/test/model/RetrieveObsMigrationProfileResponse.spec.js new file mode 100644 index 0000000..fc44228 --- /dev/null +++ b/test/model/RetrieveObsMigrationProfileResponse.spec.js @@ -0,0 +1,52 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('RetrieveObsMigrationProfileResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.RetrieveObsMigrationProfileResponse(); + }); + + it('should create an instance of RetrieveObsMigrationProfileResponse', function() { + // uncomment below and update the code to test RetrieveObsMigrationProfileResponse + //var instane = new SquareConnect.RetrieveObsMigrationProfileResponse(); + //expect(instance).to.be.a(SquareConnect.RetrieveObsMigrationProfileResponse); + }); + + it('should have the property bannerEnabled (base name: "banner_enabled")', function() { + // uncomment below and update the code to test the property bannerEnabled + //var instane = new SquareConnect.RetrieveObsMigrationProfileResponse(); + //expect(instance).to.be(); + }); + it('should have the property bannerText (base name: "banner_text")', function() { + // uncomment below and update the code to test the property bannerText + //var instane = new SquareConnect.RetrieveObsMigrationProfileResponse(); + //expect(instance).to.be(); + }); + it('should have the property bannerCtaText (base name: "banner_cta_text")', function() { + // uncomment below and update the code to test the property bannerCtaText + //var instane = new SquareConnect.RetrieveObsMigrationProfileResponse(); + //expect(instance).to.be(); + }); + it('should have the property bannerCtaUrl (base name: "banner_cta_url")', function() { + // uncomment below and update the code to test the property bannerCtaUrl + //var instane = new SquareConnect.RetrieveObsMigrationProfileResponse(); + //expect(instance).to.be(); + }); + it('should have the property errors (base name: "errors")', function() { + // uncomment below and update the code to test the property errors + //var instane = new SquareConnect.RetrieveObsMigrationProfileResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/RetrieveTeamMemberBookingProfileRequest.spec.js b/test/model/RetrieveTeamMemberBookingProfileRequest.spec.js new file mode 100644 index 0000000..e04d63b --- /dev/null +++ b/test/model/RetrieveTeamMemberBookingProfileRequest.spec.js @@ -0,0 +1,27 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('RetrieveTeamMemberBookingProfileRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.RetrieveTeamMemberBookingProfileRequest(); + }); + + it('should create an instance of RetrieveTeamMemberBookingProfileRequest', function() { + // uncomment below and update the code to test RetrieveTeamMemberBookingProfileRequest + //var instane = new SquareConnect.RetrieveTeamMemberBookingProfileRequest(); + //expect(instance).to.be.a(SquareConnect.RetrieveTeamMemberBookingProfileRequest); + }); + +}); diff --git a/test/model/RetrieveTeamMemberBookingProfileResponse.spec.js b/test/model/RetrieveTeamMemberBookingProfileResponse.spec.js new file mode 100644 index 0000000..cfff6d3 --- /dev/null +++ b/test/model/RetrieveTeamMemberBookingProfileResponse.spec.js @@ -0,0 +1,37 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('RetrieveTeamMemberBookingProfileResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.RetrieveTeamMemberBookingProfileResponse(); + }); + + it('should create an instance of RetrieveTeamMemberBookingProfileResponse', function() { + // uncomment below and update the code to test RetrieveTeamMemberBookingProfileResponse + //var instane = new SquareConnect.RetrieveTeamMemberBookingProfileResponse(); + //expect(instance).to.be.a(SquareConnect.RetrieveTeamMemberBookingProfileResponse); + }); + + it('should have the property teamMemberBookingProfile (base name: "team_member_booking_profile")', function() { + // uncomment below and update the code to test the property teamMemberBookingProfile + //var instane = new SquareConnect.RetrieveTeamMemberBookingProfileResponse(); + //expect(instance).to.be(); + }); + it('should have the property errors (base name: "errors")', function() { + // uncomment below and update the code to test the property errors + //var instane = new SquareConnect.RetrieveTeamMemberBookingProfileResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/RiskEvaluation.spec.js b/test/model/RiskEvaluation.spec.js new file mode 100644 index 0000000..6722caa --- /dev/null +++ b/test/model/RiskEvaluation.spec.js @@ -0,0 +1,37 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('RiskEvaluation', function() { + beforeEach(function() { + this.api = new SquareConnect.RiskEvaluation(); + }); + + it('should create an instance of RiskEvaluation', function() { + // uncomment below and update the code to test RiskEvaluation + //var instane = new SquareConnect.RiskEvaluation(); + //expect(instance).to.be.a(SquareConnect.RiskEvaluation); + }); + + it('should have the property createdAt (base name: "created_at")', function() { + // uncomment below and update the code to test the property createdAt + //var instane = new SquareConnect.RiskEvaluation(); + //expect(instance).to.be(); + }); + it('should have the property riskLevel (base name: "risk_level")', function() { + // uncomment below and update the code to test the property riskLevel + //var instane = new SquareConnect.RiskEvaluation(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/RiskEvaluationRiskLevel.spec.js b/test/model/RiskEvaluationRiskLevel.spec.js new file mode 100644 index 0000000..c77fd6c --- /dev/null +++ b/test/model/RiskEvaluationRiskLevel.spec.js @@ -0,0 +1,26 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('RiskEvaluationRiskLevel', function() { + beforeEach(function() { + }); + + it('should create an instance of RiskEvaluationRiskLevel', function() { + // uncomment below and update the code to test RiskEvaluationRiskLevel + //var instane = new SquareConnect.RiskEvaluationRiskLevel(); + //expect(instance).to.be.a(SquareConnect.RiskEvaluationRiskLevel); + }); + +}); diff --git a/test/model/SearchAvailabilityFilter.spec.js b/test/model/SearchAvailabilityFilter.spec.js new file mode 100644 index 0000000..5336237 --- /dev/null +++ b/test/model/SearchAvailabilityFilter.spec.js @@ -0,0 +1,47 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('SearchAvailabilityFilter', function() { + beforeEach(function() { + this.api = new SquareConnect.SearchAvailabilityFilter(); + }); + + it('should create an instance of SearchAvailabilityFilter', function() { + // uncomment below and update the code to test SearchAvailabilityFilter + //var instane = new SquareConnect.SearchAvailabilityFilter(); + //expect(instance).to.be.a(SquareConnect.SearchAvailabilityFilter); + }); + + it('should have the property startAtRange (base name: "start_at_range")', function() { + // uncomment below and update the code to test the property startAtRange + //var instane = new SquareConnect.SearchAvailabilityFilter(); + //expect(instance).to.be(); + }); + it('should have the property locationId (base name: "location_id")', function() { + // uncomment below and update the code to test the property locationId + //var instane = new SquareConnect.SearchAvailabilityFilter(); + //expect(instance).to.be(); + }); + it('should have the property segmentFilters (base name: "segment_filters")', function() { + // uncomment below and update the code to test the property segmentFilters + //var instane = new SquareConnect.SearchAvailabilityFilter(); + //expect(instance).to.be(); + }); + it('should have the property bookingId (base name: "booking_id")', function() { + // uncomment below and update the code to test the property bookingId + //var instane = new SquareConnect.SearchAvailabilityFilter(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/SearchAvailabilityQuery.spec.js b/test/model/SearchAvailabilityQuery.spec.js new file mode 100644 index 0000000..3bbcd9c --- /dev/null +++ b/test/model/SearchAvailabilityQuery.spec.js @@ -0,0 +1,32 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('SearchAvailabilityQuery', function() { + beforeEach(function() { + this.api = new SquareConnect.SearchAvailabilityQuery(); + }); + + it('should create an instance of SearchAvailabilityQuery', function() { + // uncomment below and update the code to test SearchAvailabilityQuery + //var instane = new SquareConnect.SearchAvailabilityQuery(); + //expect(instance).to.be.a(SquareConnect.SearchAvailabilityQuery); + }); + + it('should have the property filter (base name: "filter")', function() { + // uncomment below and update the code to test the property filter + //var instane = new SquareConnect.SearchAvailabilityQuery(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/SearchAvailabilityRequest.spec.js b/test/model/SearchAvailabilityRequest.spec.js new file mode 100644 index 0000000..cc0f858 --- /dev/null +++ b/test/model/SearchAvailabilityRequest.spec.js @@ -0,0 +1,32 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('SearchAvailabilityRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.SearchAvailabilityRequest(); + }); + + it('should create an instance of SearchAvailabilityRequest', function() { + // uncomment below and update the code to test SearchAvailabilityRequest + //var instane = new SquareConnect.SearchAvailabilityRequest(); + //expect(instance).to.be.a(SquareConnect.SearchAvailabilityRequest); + }); + + it('should have the property query (base name: "query")', function() { + // uncomment below and update the code to test the property query + //var instane = new SquareConnect.SearchAvailabilityRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/SearchAvailabilityResponse.spec.js b/test/model/SearchAvailabilityResponse.spec.js new file mode 100644 index 0000000..f39f560 --- /dev/null +++ b/test/model/SearchAvailabilityResponse.spec.js @@ -0,0 +1,37 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('SearchAvailabilityResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.SearchAvailabilityResponse(); + }); + + it('should create an instance of SearchAvailabilityResponse', function() { + // uncomment below and update the code to test SearchAvailabilityResponse + //var instane = new SquareConnect.SearchAvailabilityResponse(); + //expect(instance).to.be.a(SquareConnect.SearchAvailabilityResponse); + }); + + it('should have the property availabilities (base name: "availabilities")', function() { + // uncomment below and update the code to test the property availabilities + //var instane = new SquareConnect.SearchAvailabilityResponse(); + //expect(instance).to.be(); + }); + it('should have the property errors (base name: "errors")', function() { + // uncomment below and update the code to test the property errors + //var instane = new SquareConnect.SearchAvailabilityResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/SegmentFilter.spec.js b/test/model/SegmentFilter.spec.js new file mode 100644 index 0000000..c09e56c --- /dev/null +++ b/test/model/SegmentFilter.spec.js @@ -0,0 +1,37 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('SegmentFilter', function() { + beforeEach(function() { + this.api = new SquareConnect.SegmentFilter(); + }); + + it('should create an instance of SegmentFilter', function() { + // uncomment below and update the code to test SegmentFilter + //var instane = new SquareConnect.SegmentFilter(); + //expect(instance).to.be.a(SquareConnect.SegmentFilter); + }); + + it('should have the property serviceVariationId (base name: "service_variation_id")', function() { + // uncomment below and update the code to test the property serviceVariationId + //var instane = new SquareConnect.SegmentFilter(); + //expect(instance).to.be(); + }); + it('should have the property teamMemberIdFilter (base name: "team_member_id_filter")', function() { + // uncomment below and update the code to test the property teamMemberIdFilter + //var instane = new SquareConnect.SegmentFilter(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/TeamMemberBookingProfile.spec.js b/test/model/TeamMemberBookingProfile.spec.js new file mode 100644 index 0000000..579c398 --- /dev/null +++ b/test/model/TeamMemberBookingProfile.spec.js @@ -0,0 +1,52 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('TeamMemberBookingProfile', function() { + beforeEach(function() { + this.api = new SquareConnect.TeamMemberBookingProfile(); + }); + + it('should create an instance of TeamMemberBookingProfile', function() { + // uncomment below and update the code to test TeamMemberBookingProfile + //var instane = new SquareConnect.TeamMemberBookingProfile(); + //expect(instance).to.be.a(SquareConnect.TeamMemberBookingProfile); + }); + + it('should have the property teamMemberId (base name: "team_member_id")', function() { + // uncomment below and update the code to test the property teamMemberId + //var instane = new SquareConnect.TeamMemberBookingProfile(); + //expect(instance).to.be(); + }); + it('should have the property description (base name: "description")', function() { + // uncomment below and update the code to test the property description + //var instane = new SquareConnect.TeamMemberBookingProfile(); + //expect(instance).to.be(); + }); + it('should have the property displayName (base name: "display_name")', function() { + // uncomment below and update the code to test the property displayName + //var instane = new SquareConnect.TeamMemberBookingProfile(); + //expect(instance).to.be(); + }); + it('should have the property isBookable (base name: "is_bookable")', function() { + // uncomment below and update the code to test the property isBookable + //var instane = new SquareConnect.TeamMemberBookingProfile(); + //expect(instance).to.be(); + }); + it('should have the property profileImageUrl (base name: "profile_image_url")', function() { + // uncomment below and update the code to test the property profileImageUrl + //var instane = new SquareConnect.TeamMemberBookingProfile(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/TenderBankTransferDetails.spec.js b/test/model/TenderBankTransferDetails.spec.js index 4c27e94..ce0d099 100644 --- a/test/model/TenderBankTransferDetails.spec.js +++ b/test/model/TenderBankTransferDetails.spec.js @@ -15,7 +15,7 @@ const SquareConnect = require('../../src/index'); describe('TenderBankTransferDetails', function() { beforeEach(function() { - this.api = new SquareConnect.TenderBankTransferDetails(); + // this.api = new SquareConnect.TenderBankTransferDetails(); }); it('should create an instance of TenderBankTransferDetails', function() { diff --git a/test/model/UpdateBookingRequest.spec.js b/test/model/UpdateBookingRequest.spec.js new file mode 100644 index 0000000..3a99f34 --- /dev/null +++ b/test/model/UpdateBookingRequest.spec.js @@ -0,0 +1,37 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('UpdateBookingRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.UpdateBookingRequest(); + }); + + it('should create an instance of UpdateBookingRequest', function() { + // uncomment below and update the code to test UpdateBookingRequest + //var instane = new SquareConnect.UpdateBookingRequest(); + //expect(instance).to.be.a(SquareConnect.UpdateBookingRequest); + }); + + it('should have the property idempotencyKey (base name: "idempotency_key")', function() { + // uncomment below and update the code to test the property idempotencyKey + //var instane = new SquareConnect.UpdateBookingRequest(); + //expect(instance).to.be(); + }); + it('should have the property booking (base name: "booking")', function() { + // uncomment below and update the code to test the property booking + //var instane = new SquareConnect.UpdateBookingRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/UpdateBookingResponse.spec.js b/test/model/UpdateBookingResponse.spec.js new file mode 100644 index 0000000..c1c5ce1 --- /dev/null +++ b/test/model/UpdateBookingResponse.spec.js @@ -0,0 +1,37 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * + * Swagger Codegen version: 2.3.0-SNAPSHOT + * + */ +const SquareConnect = require('../../src/index'); + +describe('UpdateBookingResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.UpdateBookingResponse(); + }); + + it('should create an instance of UpdateBookingResponse', function() { + // uncomment below and update the code to test UpdateBookingResponse + //var instane = new SquareConnect.UpdateBookingResponse(); + //expect(instance).to.be.a(SquareConnect.UpdateBookingResponse); + }); + + it('should have the property booking (base name: "booking")', function() { + // uncomment below and update the code to test the property booking + //var instane = new SquareConnect.UpdateBookingResponse(); + //expect(instance).to.be(); + }); + it('should have the property errors (base name: "errors")', function() { + // uncomment below and update the code to test the property errors + //var instane = new SquareConnect.UpdateBookingResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/VersionedCatalogObject.spec.js b/test/model/VersionedCatalogObject.spec.js index 3704b97..e1ae48d 100644 --- a/test/model/VersionedCatalogObject.spec.js +++ b/test/model/VersionedCatalogObject.spec.js @@ -15,7 +15,7 @@ const SquareConnect = require('../../src/index'); describe('VersionedCatalogObject', function() { beforeEach(function() { - this.api = new SquareConnect.VersionedCatalogObject(); + // this.api = new SquareConnect.VersionedCatalogObject(); }); it('should create an instance of VersionedCatalogObject', function() {