Skip to content

Commit 17ab6c7

Browse files
fern-api[bot]fern-api[bot]
authored
SDK regeneration
1 parent 2f68429 commit 17ab6c7

File tree

87 files changed

+149362
-8
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+149362
-8
lines changed

‎.mock/definition/__package__.yml‎

Lines changed: 37905 additions & 0 deletions
Large diffs are not rendered by default.

‎.mock/definition/api.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: api
2+
error-discrimination:
3+
strategy: status-code
4+
display-name: Square
5+
environments:
6+
Production: https://connect.squareup.com
7+
Sandbox: https://connect.squareupsandbox.com
8+
default-environment: Production
9+
headers:
10+
Square-Version:
11+
name: version
12+
env: VERSION
13+
type: literal<"2025-10-16">
14+
auth-schemes:
15+
Bearer:
16+
scheme: bearer
17+
token:
18+
env: SQUARE_TOKEN
19+
auth: Bearer

‎.mock/definition/applePay.yml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
imports:
2+
root: __package__.yml
3+
service:
4+
auth: false
5+
base-path: ''
6+
endpoints:
7+
RegisterDomain:
8+
path: /v2/apple-pay/domains
9+
method: POST
10+
auth:
11+
- oauth2: []
12+
docs: >-
13+
Activates a domain for use with Apple Pay on the Web and Square. A
14+
validation
15+
16+
is performed on this domain by Apple to ensure that it is properly set
17+
up as
18+
19+
an Apple Pay enabled domain.
20+
21+
22+
This endpoint provides an easy way for platform developers to bulk
23+
activate
24+
25+
Apple Pay on the Web with Square for merchants using their platform.
26+
27+
28+
Note: You will need to host a valid domain verification file on your
29+
domain to support Apple Pay. The
30+
31+
current version of this file is always available at
32+
https://app.squareup.com/digital-wallets/apple-pay/apple-developer-merchantid-domain-association,
33+
34+
and should be hosted at
35+
`.well_known/apple-developer-merchantid-domain-association` on your
36+
37+
domain. This file is subject to change; we strongly recommend checking
38+
for updates regularly and avoiding
39+
40+
long-lived caches that might not keep in sync with the correct file
41+
version.
42+
43+
44+
To learn more about the Web Payments SDK and how to add Apple Pay, see
45+
[Take an Apple Pay
46+
Payment](https://developer.squareup.com/docs/web-payments/apple-pay).
47+
source:
48+
openapi: openapi/openapi.json
49+
display-name: RegisterDomain
50+
request:
51+
name: RegisterDomainRequest
52+
body:
53+
properties:
54+
domain_name:
55+
type: string
56+
docs: >-
57+
A domain name as described in RFC-1034 that will be registered
58+
with ApplePay.
59+
validation:
60+
minLength: 1
61+
maxLength: 255
62+
content-type: application/json
63+
response:
64+
docs: Success
65+
type: root.RegisterDomainResponse
66+
status-code: 200
67+
examples:
68+
- headers:
69+
Square-Version: '2025-10-16'
70+
request:
71+
domain_name: example.com
72+
response:
73+
body:
74+
errors:
75+
- category: API_ERROR
76+
code: INTERNAL_SERVER_ERROR
77+
detail: detail
78+
field: field
79+
status: VERIFIED
80+
source:
81+
openapi: openapi/openapi.json

‎.mock/definition/bankAccounts.yml‎

Lines changed: 222 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,222 @@
1+
imports:
2+
root: __package__.yml
3+
service:
4+
auth: false
5+
base-path: ''
6+
endpoints:
7+
list:
8+
path: /v2/bank-accounts
9+
method: GET
10+
auth:
11+
- oauth2:
12+
- BANK_ACCOUNTS_READ
13+
docs: >-
14+
Returns a list of [BankAccount](entity:BankAccount) objects linked to a
15+
Square account.
16+
pagination:
17+
cursor: $request.cursor
18+
next_cursor: $response.cursor
19+
results: $response.bank_accounts
20+
source:
21+
openapi: openapi/openapi.json
22+
display-name: ListBankAccounts
23+
request:
24+
name: ListBankAccountsRequest
25+
query-parameters:
26+
cursor:
27+
type: optional<nullable<string>>
28+
docs: >-
29+
The pagination cursor returned by a previous call to this
30+
endpoint.
31+
32+
Use it in the next `ListBankAccounts` request to retrieve the next
33+
set
34+
35+
of results.
36+
37+
38+
See the
39+
[Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)
40+
guide for more information.
41+
limit:
42+
type: optional<nullable<integer>>
43+
docs: >-
44+
Upper limit on the number of bank accounts to return in the
45+
response.
46+
47+
Currently, 1000 is the largest supported limit. You can specify a
48+
limit
49+
50+
of up to 1000 bank accounts. This is also the default limit.
51+
location_id:
52+
type: optional<nullable<string>>
53+
docs: >-
54+
Location ID. You can specify this optional filter
55+
56+
to retrieve only the linked bank accounts belonging to a specific
57+
location.
58+
response:
59+
docs: Success
60+
type: root.ListBankAccountsResponse
61+
status-code: 200
62+
examples:
63+
- query-parameters:
64+
cursor: cursor
65+
limit: 1
66+
location_id: location_id
67+
headers:
68+
Square-Version: '2025-10-16'
69+
response:
70+
body:
71+
errors:
72+
- category: API_ERROR
73+
code: INTERNAL_SERVER_ERROR
74+
detail: detail
75+
field: field
76+
bank_accounts:
77+
- id: ao6iaQ9vhDiaQD7n3GB
78+
account_number_suffix: '971'
79+
country: US
80+
currency: USD
81+
account_type: CHECKING
82+
holder_name: Jane Doe
83+
primary_bank_identification_number: '112200303'
84+
secondary_bank_identification_number: secondary_bank_identification_number
85+
debit_mandate_reference_id: debit_mandate_reference_id
86+
reference_id: reference_id
87+
location_id: S8GWD5example
88+
status: VERIFICATION_IN_PROGRESS
89+
creditable: false
90+
debitable: false
91+
fingerprint: fingerprint
92+
version: 5
93+
bank_name: Bank Name
94+
- id: 4x7WXuaxrkQkVlka3GB
95+
account_number_suffix: '972'
96+
country: US
97+
currency: USD
98+
account_type: CHECKING
99+
holder_name: Jane Doe
100+
primary_bank_identification_number: '112200303'
101+
secondary_bank_identification_number: secondary_bank_identification_number
102+
debit_mandate_reference_id: debit_mandate_reference_id
103+
reference_id: reference_id
104+
location_id: S8GWD5example
105+
status: VERIFICATION_IN_PROGRESS
106+
creditable: false
107+
debitable: false
108+
fingerprint: fingerprint
109+
version: 5
110+
bank_name: Bank Name
111+
cursor: cursor
112+
GetByV1Id:
113+
path: /v2/bank-accounts/by-v1-id/{v1_bank_account_id}
114+
method: GET
115+
auth:
116+
- oauth2:
117+
- BANK_ACCOUNTS_READ
118+
docs: >-
119+
Returns details of a [BankAccount](entity:BankAccount) identified by V1
120+
bank account ID.
121+
source:
122+
openapi: openapi/openapi.json
123+
display-name: GetBankAccountByV1Id
124+
request:
125+
name: GetByV1IdBankAccountsRequest
126+
path-parameters:
127+
v1_bank_account_id:
128+
type: string
129+
docs: >-
130+
Connect V1 ID of the desired `BankAccount`. For more information,
131+
see
132+
133+
[Retrieve a bank account by using an ID issued by V1 Bank Accounts
134+
API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-id-issued-by-v1-bank-accounts-api).
135+
response:
136+
docs: Success
137+
type: root.GetBankAccountByV1IdResponse
138+
status-code: 200
139+
examples:
140+
- path-parameters:
141+
v1_bank_account_id: v1_bank_account_id
142+
headers:
143+
Square-Version: '2025-10-16'
144+
response:
145+
body:
146+
errors:
147+
- category: API_ERROR
148+
code: INTERNAL_SERVER_ERROR
149+
detail: detail
150+
field: field
151+
bank_account:
152+
id: w3yRgCGYQnwmdl0R3GB
153+
account_number_suffix: '971'
154+
country: US
155+
currency: USD
156+
account_type: CHECKING
157+
holder_name: Jane Doe
158+
primary_bank_identification_number: '112200303'
159+
secondary_bank_identification_number: secondary_bank_identification_number
160+
debit_mandate_reference_id: debit_mandate_reference_id
161+
reference_id: reference_id
162+
location_id: S8GWD5example
163+
status: VERIFICATION_IN_PROGRESS
164+
creditable: false
165+
debitable: false
166+
fingerprint: fingerprint
167+
version: 5
168+
bank_name: Bank Name
169+
get:
170+
path: /v2/bank-accounts/{bank_account_id}
171+
method: GET
172+
auth:
173+
- oauth2:
174+
- BANK_ACCOUNTS_READ
175+
docs: |-
176+
Returns details of a [BankAccount](entity:BankAccount)
177+
linked to a Square account.
178+
source:
179+
openapi: openapi/openapi.json
180+
display-name: GetBankAccount
181+
request:
182+
name: GetBankAccountsRequest
183+
path-parameters:
184+
bank_account_id:
185+
type: string
186+
docs: Square-issued ID of the desired `BankAccount`.
187+
response:
188+
docs: Success
189+
type: root.GetBankAccountResponse
190+
status-code: 200
191+
examples:
192+
- path-parameters:
193+
bank_account_id: bank_account_id
194+
headers:
195+
Square-Version: '2025-10-16'
196+
response:
197+
body:
198+
errors:
199+
- category: API_ERROR
200+
code: INTERNAL_SERVER_ERROR
201+
detail: detail
202+
field: field
203+
bank_account:
204+
id: w3yRgCGYQnwmdl0R3GB
205+
account_number_suffix: '971'
206+
country: US
207+
currency: USD
208+
account_type: CHECKING
209+
holder_name: Jane Doe
210+
primary_bank_identification_number: '112200303'
211+
secondary_bank_identification_number: secondary_bank_identification_number
212+
debit_mandate_reference_id: debit_mandate_reference_id
213+
reference_id: reference_id
214+
location_id: S8GWD5example
215+
status: VERIFICATION_IN_PROGRESS
216+
creditable: false
217+
debitable: false
218+
fingerprint: fingerprint
219+
version: 5
220+
bank_name: Bank Name
221+
source:
222+
openapi: openapi/openapi.json

0 commit comments

Comments
 (0)