Skip to content

Commit 2d7247c

Browse files
mikekonomikekono
authored
Merge pull request #173 from square/fern-bot/03-19-2025-0300PM
🌿 Fern Regeneration -- March 19, 2025
2 parents 03a7314 + 5ee1bb3 commit 2d7247c

File tree

164 files changed

+121511
-1248
lines changed

Some content is hidden

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

164 files changed

+121511
-1248
lines changed

‎.mock/definition/__package__.yml‎

Lines changed: 26977 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-03-19">
14+
auth-schemes:
15+
Bearer:
16+
scheme: bearer
17+
token:
18+
env: SQUARE_TOKEN
19+
auth: Bearer

‎.mock/definition/applePay.yml‎

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

‎.mock/definition/bankAccounts.yml‎

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

0 commit comments

Comments
 (0)