Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions .fern/metadata.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"cliVersion": "4.23.1",
"cliVersion": "3.98.5",
"generatorName": "fernapi/fern-typescript-sdk",
"generatorVersion": "3.54.0",
"generatorVersion": "3.43.8",
"generatorConfig": {
"namespaceExport": "Square",
"allowCustomFetcher": true,
Expand Down Expand Up @@ -54,6 +54,5 @@
}
}
},
"originGitCommit": "809bbe97ec8c4928c84c231c117042f8f36cc91d",
"sdkVersion": "44.0.1"
"sdkVersion": "44.1.0"
}
10 changes: 10 additions & 0 deletions .fern/replay.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions .fernignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,6 @@ tests/unit/fetcher/stream-wrappers/webpack.test.ts
tests/integration
legacy
jest.config.mjs
.fern/replay.lock
.fern/replay.yml
.gitattributes
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.fern/replay.lock linguist-generated=true
13 changes: 1 addition & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ The Square TypeScript library provides convenient access to the Square APIs from
- [Pagination](#pagination)
- [Webhook Signature Verification](#webhook-signature-verification)
- [Advanced](#advanced)
- [Subpackage Exports](#subpackage-exports)
- [Additional Headers](#additional-headers)
- [Additional Query String Parameters](#additional-query-string-parameters)
- [Retries](#retries)
Expand Down Expand Up @@ -273,16 +272,6 @@ const isValid = WebhooksHelper.verifySignature({

## Advanced

### Subpackage Exports

This SDK supports direct imports of subpackage clients, which allows JavaScript bundlers to tree-shake and include only the imported subpackage code. This results in much smaller bundle sizes.

```typescript
import { OAuthClient } from 'square/oAuth';

const client = new OAuthClient({...});
```

### Additional Headers

If you would like to send additional headers as part of the request, use the `headers` request option.
Expand Down Expand Up @@ -470,4 +459,4 @@ otherwise they would be overwritten upon the next generated release. Feel free t
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!
On the other hand, contributions to the README are always very welcome!
2 changes: 1 addition & 1 deletion biome.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://biomejs.dev/schemas/2.4.3/schema.json",
"$schema": "https://biomejs.dev/schemas/2.3.1/schema.json",
"root": true,
"vcs": {
"enabled": false
Expand Down
7 changes: 3 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "square",
"version": "44.0.1",
"version": "44.1.0",
"private": false,
"repository": {
"type": "git",
Expand Down Expand Up @@ -44,14 +44,13 @@
"msw": "2.11.2",
"@types/node": "^18.19.70",
"typescript": "~5.7.2",
"@biomejs/biome": "2.4.3"
"@biomejs/biome": "2.3.1"
},
"browser": {
"fs": false,
"os": false,
"path": false,
"stream": false,
"crypto": false
"stream": false
},
"packageManager": "yarn@1.22.22",
"engines": {
Expand Down
97 changes: 48 additions & 49 deletions reference.md

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions src/BaseClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export type BaseClientOptions = {
/** Specify a custom URL to connect the client to. */
baseUrl?: core.Supplier<string>;
/** Override the Square-Version header */
version?: "2026-01-22";
version?: "2026-05-20";
/** Additional headers to include in requests. */
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
/** The default maximum time to wait for a response in seconds. */
Expand All @@ -32,7 +32,7 @@ export interface BaseRequestOptions {
/** A hook to abort the request. */
abortSignal?: AbortSignal;
/** Override the Square-Version header */
version?: "2026-01-22";
version?: "2026-05-20";
/** Additional query string parameters to include in the request. */
queryParams?: Record<string, unknown>;
/** Additional headers to include in the request. */
Expand All @@ -56,11 +56,11 @@ export function normalizeClientOptions<T extends BaseClientOptions = BaseClientO
{
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "square",
"X-Fern-SDK-Version": "44.0.1",
"User-Agent": "square/44.0.1",
"X-Fern-SDK-Version": "44.1.0",
"User-Agent": "square/44.1.0",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
"Square-Version": options?.version ?? "2026-01-22",
"Square-Version": options?.version ?? "2026-05-20",
},
options?.headers,
);
Expand Down
2 changes: 1 addition & 1 deletion src/api/resources/applePay/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ export class ApplePayClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down
4 changes: 0 additions & 4 deletions src/api/resources/applePay/exports.ts

This file was deleted.

10 changes: 5 additions & 5 deletions src/api/resources/bankAccounts/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ export class BankAccountsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -138,7 +138,7 @@ export class BankAccountsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -214,7 +214,7 @@ export class BankAccountsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -289,7 +289,7 @@ export class BankAccountsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -364,7 +364,7 @@ export class BankAccountsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down
4 changes: 0 additions & 4 deletions src/api/resources/bankAccounts/exports.ts

This file was deleted.

20 changes: 10 additions & 10 deletions src/api/resources/bookings/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ export class BookingsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -180,7 +180,7 @@ export class BookingsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -262,7 +262,7 @@ export class BookingsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -345,7 +345,7 @@ export class BookingsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -415,7 +415,7 @@ export class BookingsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -490,7 +490,7 @@ export class BookingsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -566,7 +566,7 @@ export class BookingsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -650,7 +650,7 @@ export class BookingsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -727,7 +727,7 @@ export class BookingsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -809,7 +809,7 @@ export class BookingsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down
5 changes: 0 additions & 5 deletions src/api/resources/bookings/exports.ts

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export class CustomAttributeDefinitionsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -146,7 +146,7 @@ export class CustomAttributeDefinitionsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -234,7 +234,7 @@ export class CustomAttributeDefinitionsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -316,7 +316,7 @@ export class CustomAttributeDefinitionsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -403,7 +403,7 @@ export class CustomAttributeDefinitionsClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export class CustomAttributesClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -151,7 +151,7 @@ export class CustomAttributesClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -240,7 +240,7 @@ export class CustomAttributesClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -336,7 +336,7 @@ export class CustomAttributesClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -419,7 +419,7 @@ export class CustomAttributesClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down Expand Up @@ -507,7 +507,7 @@ export class CustomAttributesClient {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
this._options?.headers,
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-01-22" }),
mergeOnlyDefinedHeaders({ "Square-Version": requestOptions?.version ?? "2026-05-20" }),
requestOptions?.headers,
);
const _response = await (this._options.fetcher ?? core.fetcher)({
Expand Down
Loading
Loading