Add legacy SDK in legacy/

Author: fern-api[bot]

legacy/CHANGELOG.md

@@ -0,0 +1,157 @@
+# Square Legacy Node.js SDK
+
+Use this JavaScript library to manage Square resources (such as payments, orders, items, and inventory) for your own Square account or on behalf of Square sellers.
+
+* [Requirements](#requirements)
+* [Installation](#installation)
+* [Quickstart](#quickstart)
+* [Usage](#usage)
+* [Tests](#tests)
+* [SDK Reference](#sdk-reference)
+* [Deprecated APIs](#deprecated-apis)
+
+## Requirements
+
+Use of the Square Node.js SDK requires:
+
+* Node.js 14 or higher
+
+This SDK supports Node.js versions that are either current, or that are in long-term support status (LTS).  The SDK does not support Node.js versions that have reached their end-of-life (EOL).  For more information on Node.js versioning, see <https://nodejs.org/en/about/releases/>.
+
+This SDK is for use with Node.js only. It does not support other usages, such as for web browsers or frontend applications.
+
+## Installation
+
+For more information, see [Set Up Your Square SDK for a Node.js Project](https://developer.squareup.com/docs/sdks/nodejs/setup-project).
+
+## Quickstart
+
+For more information, see [Square Node.js SDK Quickstart](https://developer.squareup.com/docs/sdks/nodejs/quick-start).
+
+## Usage
+For more information, see [Using the Square Node.js SDK](https://developer.squareup.com/docs/sdks/nodejs/using-nodejs-sdk).
+
+## SDK Reference
+
+### Payments
+* [Payments]
+* [Refunds]
+* [Disputes]
+* [Checkout]
+* [Apple Pay]
+* [Cards]
+* [Payouts]
+
+### Terminal
+* [Terminal]
+
+### Orders
+* [Orders]
+* [Order Custom Attributes]
+
+### Subscriptions
+* [Subscriptions]
+
+### Invoices
+* [Invoices]
+
+### Items
+* [Catalog]
+* [Inventory]
+
+### Customers
+* [Customers]
+* [Customer Groups]
+* [Customer Segments]
+
+### Loyalty
+* [Loyalty]
+
+### Gift Cards
+* [Gift Cards]
+* [Gift Card Activities]
+
+### Bookings
+* [Bookings]
+* [Booking Custom Attributes]
+
+### Business
+* [Merchants]
+* [Merchant Custom Attributes]
+* [Locations]
+* [Location Custom Attributes]
+* [Devices]
+* [Cash Drawers]
+
+### Team
+* [Team]
+* [Labor]
+
+### Financials
+* [Bank Accounts]
+
+### Online
+* [Sites]
+* [Snippets]
+
+### Authorization
+* [Mobile Authorization]
+* [OAuth]
+
+### Webhook Subscriptions
+* [Webhook Subscriptions]
+## Deprecated APIs
+
+The following Square APIs are [deprecated](https://developer.squareup.com/docs/build-basics/api-lifecycle):
+
+* [Employees] - replaced by the [Team] API. For more information, see [Migrate from the Employees API](https://developer.squareup.com/docs/team/migrate-from-v2-employees).
+
+* [Transactions] - replaced by the [Orders] and [Payments] APIs.  For more information, see [Migrate from the Transactions API](https://developer.squareup.com/docs/payments-api/migrate-from-transactions-api).
+
+
+[Developer Dashboard]: https://developer.squareup.com/apps
+[Square API]: https://squareup.com/developers
+[sign up for a developer account]: https://squareup.com/signup?v=developers
+[Locations overview]: https://developer.squareup.com/docs/locations-api
+[OAuth overview]: https://developer.squareup.com/docs/oauth-api/overview
+[Client]: doc/client.md
+[Devices]: doc/api/devices.md
+[Disputes]: doc/api/disputes.md
+[Terminal]: doc/api/terminal.md
+[Team]: doc/api/team.md
+[Cash Drawers]: doc/api/cash-drawers.md
+[Vendors]: doc/api/vendors.md
+[Customer Groups]: doc/api/customer-groups.md
+[Customer Segments]: doc/api/customer-segments.md
+[Bank Accounts]: doc/api/bank-accounts.md
+[Payments]: doc/api/payments.md
+[Checkout]: doc/api/checkout.md
+[Catalog]: doc/api/catalog.md
+[Customers]: doc/api/customers.md
+[Customer Custom Attributes]: doc/api/customer-custom-attributes.md
+[Inventory]: doc/api/inventory.md
+[Labor]: doc/api/labor.md
+[Loyalty]: doc/api/loyalty.md
+[Bookings]: doc/api/bookings.md
+[Booking Custom Attributes]: doc/api/booking-custom-attributes.md
+[Locations]: doc/api/locations.md
+[Location Custom Attributes]: doc/api/location-custom-attributes.md
+[Merchants]: doc/api/merchants.md
+[Merchant Custom Attributes]: doc/api/merchant-custom-attributes.md
+[Orders]: doc/api/orders.md
+[Order Custom Attributes]: doc/api/order-custom-attributes.md
+[Invoices]: doc/api/invoices.md
+[Apple Pay]: doc/api/apple-pay.md
+[Refunds]: doc/api/refunds.md
+[Subscriptions]: doc/api/subscriptions.md
+[Mobile Authorization]: doc/api/mobile-authorization.md
+[OAuth]: doc/api/o-auth.md
+[Sites]: doc/api/sites.md
+[Snippets]: doc/api/snippets.md
+[Cards]: doc/api/cards.md
+[Payouts]: doc/api/payouts.md
+[Gift Cards]: doc/api/gift-cards.md
+[Gift Card Activities]: doc/api/gift-card-activities.md
+[Employees]: doc/api/employees.md
+[Transactions]: doc/api/transactions.md
+[Webhook Subscriptions]: doc/api/webhook-subscriptions.md

legacy/README.md

@@ -0,0 +1,18 @@
+
+# ApiError
+
+Thrown when the HTTP status code is not okay.
+
+The ApiError extends the ApiResponse interface, so all ApiResponse properties are available.
+
+## Properties
+
+| Name | Type | Description |
+|  --- | --- | --- |
+| request | HttpRequest | Original request that resulted in this response. |
+| statusCode | number | Response status code. |
+| headers | Record<string, string> | Response headers. |
+| result | T | Response data. |
+| body | string \| Blob \| NodeJS.ReadableStream | Original body from the response. |
+| errors? | Error[] | Represents an error encountered during a request to the Connect API |
+

legacy/doc/api-error.md

@@ -0,0 +1,15 @@
+
+# ApiResponse
+
+An interface for the result of an API call.
+
+## Properties
+
+| Name | Type | Description |
+|  --- | --- | --- |
+| request | HttpRequest | Original request that resulted in this response. |
+| statusCode | number | Response status codee. |
+| headers | Record<string, string> | Response headers. |
+| result | T | Response data. |
+| body | string \| Blob \| NodeJS.ReadableStream | Original body from the response. |
+

legacy/doc/api-response.md

@@ -0,0 +1,65 @@
+# Apple Pay
+
+```ts
+const applePayApi = client.applePayApi;
+```
+
+## Class Name
+
+`ApplePayApi`
+
+
+# Register Domain
+
+Activates a domain for use with Apple Pay on the Web and Square. A validation
+is performed on this domain by Apple to ensure that it is properly set up as
+an Apple Pay enabled domain.
+
+This endpoint provides an easy way for platform developers to bulk activate
+Apple Pay on the Web with Square for merchants using their platform.
+
+Note: You will need to host a valid domain verification file on your domain to support Apple Pay.  The
+current version of this file is always available at https://app.squareup.com/digital-wallets/apple-pay/apple-developer-merchantid-domain-association,
+and should be hosted at `.well_known/apple-developer-merchantid-domain-association` on your
+domain.  This file is subject to change; we strongly recommend checking for updates regularly and avoiding
+long-lived caches that might not keep in sync with the correct file version.
+
+To learn more about the Web Payments SDK and how to add Apple Pay, see [Take an Apple Pay Payment](https://developer.squareup.com/docs/web-payments/apple-pay).
+
+```ts
+async registerDomain(
+  body: RegisterDomainRequest,
+  requestOptions?: RequestOptions
+): Promise<ApiResponse<RegisterDomainResponse>>
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `body` | [`RegisterDomainRequest`](../../doc/models/register-domain-request.md) | Body, Required | An object containing the fields to POST for the request.<br><br>See the corresponding object definition for field details. |
+| `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
+
+## Response Type
+
+[`RegisterDomainResponse`](../../doc/models/register-domain-response.md)
+
+## Example Usage
+
+```ts
+const body: RegisterDomainRequest = {
+  domainName: 'example.com',
+};
+
+try {
+  const { result, ...httpResponse } = await applePayApi.registerDomain(body);
+  // Get more response info...
+  // const { statusCode, headers } = httpResponse;
+} catch (error) {
+  if (error instanceof ApiError) {
+    const errors = error.result;
+    // const { statusCode, headers } = error;
+  }
+}
+```
+

legacy/doc/api/apple-pay.md

@@ -0,0 +1,139 @@
+# Bank Accounts
+
+```ts
+const bankAccountsApi = client.bankAccountsApi;
+```
+
+## Class Name
+
+`BankAccountsApi`
+
+## Methods
+
+* [List Bank Accounts](../../doc/api/bank-accounts.md#list-bank-accounts)
+* [Get Bank Account by V1 Id](../../doc/api/bank-accounts.md#get-bank-account-by-v1-id)
+* [Get Bank Account](../../doc/api/bank-accounts.md#get-bank-account)
+
+
+# List Bank Accounts
+
+Returns a list of [BankAccount](../../doc/models/bank-account.md) objects linked to a Square account.
+
+```ts
+async listBankAccounts(
+  cursor?: string,
+  limit?: number,
+  locationId?: string,
+  requestOptions?: RequestOptions
+): Promise<ApiResponse<ListBankAccountsResponse>>
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `cursor` | `string \| undefined` | Query, Optional | The pagination cursor returned by a previous call to this endpoint.<br>Use it in the next `ListBankAccounts` request to retrieve the next set<br>of results.<br><br>See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. |
+| `limit` | `number \| undefined` | Query, Optional | Upper limit on the number of bank accounts to return in the response.<br>Currently, 1000 is the largest supported limit. You can specify a limit<br>of up to 1000 bank accounts. This is also the default limit. |
+| `locationId` | `string \| undefined` | Query, Optional | Location ID. You can specify this optional filter<br>to retrieve only the linked bank accounts belonging to a specific location. |
+| `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
+
+## Response Type
+
+[`ListBankAccountsResponse`](../../doc/models/list-bank-accounts-response.md)
+
+## Example Usage
+
+```ts
+try {
+  const { result, ...httpResponse } = await bankAccountsApi.listBankAccounts();
+  // Get more response info...
+  // const { statusCode, headers } = httpResponse;
+} catch (error) {
+  if (error instanceof ApiError) {
+    const errors = error.result;
+    // const { statusCode, headers } = error;
+  }
+}
+```
+
+
+# Get Bank Account by V1 Id
+
+Returns details of a [BankAccount](../../doc/models/bank-account.md) identified by V1 bank account ID.
+
+```ts
+async getBankAccountByV1Id(
+  v1BankAccountId: string,
+  requestOptions?: RequestOptions
+): Promise<ApiResponse<GetBankAccountByV1IdResponse>>
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `v1BankAccountId` | `string` | Template, Required | Connect V1 ID of the desired `BankAccount`. For more information, see<br>[Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api). |
+| `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
+
+## Response Type
+
+[`GetBankAccountByV1IdResponse`](../../doc/models/get-bank-account-by-v1-id-response.md)
+
+## Example Usage
+
+```ts
+const v1BankAccountId = 'v1_bank_account_id8';
+
+try {
+  const { result, ...httpResponse } = await bankAccountsApi.getBankAccountByV1Id(v1BankAccountId);
+  // Get more response info...
+  // const { statusCode, headers } = httpResponse;
+} catch (error) {
+  if (error instanceof ApiError) {
+    const errors = error.result;
+    // const { statusCode, headers } = error;
+  }
+}
+```
+
+
+# Get Bank Account
+
+Returns details of a [BankAccount](../../doc/models/bank-account.md)
+linked to a Square account.
+
+```ts
+async getBankAccount(
+  bankAccountId: string,
+  requestOptions?: RequestOptions
+): Promise<ApiResponse<GetBankAccountResponse>>
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+|  --- | --- | --- | --- |
+| `bankAccountId` | `string` | Template, Required | Square-issued ID of the desired `BankAccount`. |
+| `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. |
+
+## Response Type
+
+[`GetBankAccountResponse`](../../doc/models/get-bank-account-response.md)
+
+## Example Usage
+
+```ts
+const bankAccountId = 'bank_account_id0';
+
+try {
+  const { result, ...httpResponse } = await bankAccountsApi.getBankAccount(bankAccountId);
+  // Get more response info...
+  // const { statusCode, headers } = httpResponse;
+} catch (error) {
+  if (error instanceof ApiError) {
+    const errors = error.result;
+    // const { statusCode, headers } = error;
+  }
+}
+```
+