@unified-api/typescript-sdk 2.9.4 → 2.9.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FUNCTIONS.md +108 -0
- package/README.md +36 -15
- package/RUNTIMES.md +22 -0
- package/docs/sdks/account/README.md +501 -0
- package/docs/sdks/accounting/README.md +3629 -0
- package/docs/sdks/activity/README.md +501 -0
- package/docs/sdks/apicall/README.md +165 -0
- package/docs/sdks/application/README.md +501 -0
- package/docs/sdks/applicationstatus/README.md +88 -0
- package/docs/sdks/ats/README.md +3710 -0
- package/docs/sdks/auth/README.md +173 -0
- package/docs/sdks/branch/README.md +501 -0
- package/docs/sdks/call/README.md +88 -0
- package/docs/sdks/candidate/README.md +501 -0
- package/docs/sdks/channel/README.md +171 -0
- package/docs/sdks/class/README.md +501 -0
- package/docs/sdks/collection/README.md +501 -0
- package/docs/sdks/commerce/README.md +2477 -0
- package/docs/sdks/commit/README.md +501 -0
- package/docs/sdks/company/README.md +1240 -0
- package/docs/sdks/connection/README.md +485 -0
- package/docs/sdks/contact/README.md +1489 -0
- package/docs/sdks/course/README.md +501 -0
- package/docs/sdks/crm/README.md +2971 -0
- package/docs/sdks/customer/README.md +501 -0
- package/docs/sdks/deal/README.md +501 -0
- package/docs/sdks/document/README.md +501 -0
- package/docs/sdks/employee/README.md +501 -0
- package/docs/sdks/enrich/README.md +169 -0
- package/docs/sdks/event/README.md +501 -0
- package/docs/sdks/file/README.md +501 -0
- package/docs/sdks/genai/README.md +169 -0
- package/docs/sdks/group/README.md +995 -0
- package/docs/sdks/hris/README.md +2311 -0
- package/docs/sdks/instructor/README.md +501 -0
- package/docs/sdks/integration/README.md +248 -0
- package/docs/sdks/interview/README.md +501 -0
- package/docs/sdks/inventory/README.md +501 -0
- package/docs/sdks/invoice/README.md +501 -0
- package/docs/sdks/issue/README.md +84 -0
- package/docs/sdks/item/README.md +501 -0
- package/docs/sdks/job/README.md +501 -0
- package/docs/sdks/journal/README.md +501 -0
- package/docs/sdks/kms/README.md +995 -0
- package/docs/sdks/lead/README.md +501 -0
- package/docs/sdks/link/README.md +501 -0
- package/docs/sdks/list/README.md +501 -0
- package/docs/sdks/lms/README.md +1983 -0
- package/docs/sdks/location/README.md +995 -0
- package/docs/sdks/login/README.md +90 -0
- package/docs/sdks/martech/README.md +995 -0
- package/docs/sdks/member/README.md +501 -0
- package/docs/sdks/message/README.md +501 -0
- package/docs/sdks/messaging/README.md +665 -0
- package/docs/sdks/metadata/README.md +501 -0
- package/docs/sdks/model/README.md +88 -0
- package/docs/sdks/note/README.md +501 -0
- package/docs/sdks/order/README.md +501 -0
- package/docs/sdks/organization/README.md +665 -0
- package/docs/sdks/page/README.md +501 -0
- package/docs/sdks/passthrough/README.md +671 -0
- package/docs/sdks/payment/README.md +1323 -0
- package/docs/sdks/payout/README.md +171 -0
- package/docs/sdks/payslip/README.md +171 -0
- package/docs/sdks/person/README.md +88 -0
- package/docs/sdks/pipeline/README.md +501 -0
- package/docs/sdks/project/README.md +501 -0
- package/docs/sdks/prompt/README.md +88 -0
- package/docs/sdks/pullrequest/README.md +501 -0
- package/docs/sdks/refund/README.md +171 -0
- package/docs/sdks/repo/README.md +2477 -0
- package/docs/sdks/repository/README.md +501 -0
- package/docs/sdks/scim/README.md +995 -0
- package/docs/sdks/scorecard/README.md +501 -0
- package/docs/sdks/space/README.md +501 -0
- package/docs/sdks/storage/README.md +501 -0
- package/docs/sdks/student/README.md +501 -0
- package/docs/sdks/task/README.md +995 -0
- package/docs/sdks/taxrate/README.md +501 -0
- package/docs/sdks/ticket/README.md +501 -0
- package/docs/sdks/ticketing/README.md +1489 -0
- package/docs/sdks/timeoff/README.md +171 -0
- package/docs/sdks/transaction/README.md +501 -0
- package/docs/sdks/uc/README.md +582 -0
- package/docs/sdks/unified/README.md +1601 -0
- package/docs/sdks/unifiedto/README.md +7 -0
- package/docs/sdks/user/README.md +501 -0
- package/docs/sdks/webhook/README.md +647 -0
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/primitives.d.ts +2 -0
- package/lib/primitives.d.ts.map +1 -1
- package/lib/primitives.js +53 -0
- package/lib/primitives.js.map +1 -1
- package/package.json +3 -1
- package/sdk/models/shared/crmcontact.d.ts +2 -0
- package/sdk/models/shared/crmcontact.d.ts.map +1 -1
- package/sdk/models/shared/crmcontact.js +4 -0
- package/sdk/models/shared/crmcontact.js.map +1 -1
- package/sdk/models/shared/crmlead.d.ts +2 -0
- package/sdk/models/shared/crmlead.d.ts.map +1 -1
- package/sdk/models/shared/crmlead.js +4 -0
- package/sdk/models/shared/crmlead.js.map +1 -1
- package/sdk/models/shared/index.d.ts +1 -0
- package/sdk/models/shared/index.d.ts.map +1 -1
- package/sdk/models/shared/index.js +1 -0
- package/sdk/models/shared/index.js.map +1 -1
- package/sdk/models/shared/kmspage.d.ts +5 -0
- package/sdk/models/shared/kmspage.d.ts.map +1 -1
- package/sdk/models/shared/kmspage.js +7 -0
- package/sdk/models/shared/kmspage.js.map +1 -1
- package/sdk/models/shared/kmspagemetadata.d.ts +37 -0
- package/sdk/models/shared/kmspagemetadata.d.ts.map +1 -0
- package/sdk/models/shared/kmspagemetadata.js +63 -0
- package/sdk/models/shared/kmspagemetadata.js.map +1 -0
- package/sdk/models/shared/kmsspace.d.ts +2 -0
- package/sdk/models/shared/kmsspace.d.ts.map +1 -1
- package/sdk/models/shared/kmsspace.js +4 -0
- package/sdk/models/shared/kmsspace.js.map +1 -1
- package/sdk/models/shared/security.d.ts +2 -2
- package/sdk/models/shared/security.d.ts.map +1 -1
- package/sdk/models/shared/security.js +2 -2
- package/sdk/models/shared/security.js.map +1 -1
- package/sdk/types/operations.d.ts +5 -3
- package/sdk/types/operations.d.ts.map +1 -1
- package/sdk/types/operations.js +3 -0
- package/sdk/types/operations.js.map +1 -1
- package/src/lib/config.ts +3 -3
- package/src/lib/primitives.ts +62 -0
- package/src/sdk/models/shared/crmcontact.ts +6 -0
- package/src/sdk/models/shared/crmlead.ts +6 -0
- package/src/sdk/models/shared/index.ts +1 -0
- package/src/sdk/models/shared/kmspage.ts +16 -0
- package/src/sdk/models/shared/kmspagemetadata.ts +72 -0
- package/src/sdk/models/shared/kmsspace.ts +6 -0
- package/src/sdk/models/shared/security.ts +4 -4
- package/src/sdk/types/operations.ts +11 -5
|
@@ -0,0 +1,1323 @@
|
|
|
1
|
+
# Payment
|
|
2
|
+
(*payment*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [createPaymentLink](#createpaymentlink) - Create a link
|
|
9
|
+
* [createPaymentPayment](#createpaymentpayment) - Create a payment
|
|
10
|
+
* [getPaymentLink](#getpaymentlink) - Retrieve a link
|
|
11
|
+
* [getPaymentPayment](#getpaymentpayment) - Retrieve a payment
|
|
12
|
+
* [getPaymentPayout](#getpaymentpayout) - Retrieve a payout
|
|
13
|
+
* [getPaymentRefund](#getpaymentrefund) - Retrieve a refund
|
|
14
|
+
* [listPaymentLinks](#listpaymentlinks) - List all links
|
|
15
|
+
* [listPaymentPayments](#listpaymentpayments) - List all payments
|
|
16
|
+
* [listPaymentPayouts](#listpaymentpayouts) - List all payouts
|
|
17
|
+
* [listPaymentRefunds](#listpaymentrefunds) - List all refunds
|
|
18
|
+
* [patchPaymentLink](#patchpaymentlink) - Update a link
|
|
19
|
+
* [patchPaymentPayment](#patchpaymentpayment) - Update a payment
|
|
20
|
+
* [removePaymentLink](#removepaymentlink) - Remove a link
|
|
21
|
+
* [removePaymentPayment](#removepaymentpayment) - Remove a payment
|
|
22
|
+
* [updatePaymentLink](#updatepaymentlink) - Update a link
|
|
23
|
+
* [updatePaymentPayment](#updatepaymentpayment) - Update a payment
|
|
24
|
+
|
|
25
|
+
## createPaymentLink
|
|
26
|
+
|
|
27
|
+
Create a link
|
|
28
|
+
|
|
29
|
+
### Example Usage
|
|
30
|
+
|
|
31
|
+
```typescript
|
|
32
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
33
|
+
|
|
34
|
+
const unifiedTo = new UnifiedTo({
|
|
35
|
+
security: {
|
|
36
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
37
|
+
},
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
async function run() {
|
|
41
|
+
const result = await unifiedTo.payment.createPaymentLink({
|
|
42
|
+
connectionId: "<value>",
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
// Handle the result
|
|
46
|
+
console.log(result);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
run();
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Standalone function
|
|
53
|
+
|
|
54
|
+
The standalone function version of this method:
|
|
55
|
+
|
|
56
|
+
```typescript
|
|
57
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
58
|
+
import { paymentCreatePaymentLink } from "@unified-api/typescript-sdk/funcs/paymentCreatePaymentLink.js";
|
|
59
|
+
|
|
60
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
61
|
+
// You can create one instance of it to use across an application.
|
|
62
|
+
const unifiedTo = new UnifiedToCore({
|
|
63
|
+
security: {
|
|
64
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
65
|
+
},
|
|
66
|
+
});
|
|
67
|
+
|
|
68
|
+
async function run() {
|
|
69
|
+
const res = await paymentCreatePaymentLink(unifiedTo, {
|
|
70
|
+
connectionId: "<value>",
|
|
71
|
+
});
|
|
72
|
+
|
|
73
|
+
if (!res.ok) {
|
|
74
|
+
throw res.error;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
const { value: result } = res;
|
|
78
|
+
|
|
79
|
+
// Handle the result
|
|
80
|
+
console.log(result);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
run();
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### Parameters
|
|
87
|
+
|
|
88
|
+
| Parameter | Type | Required | Description |
|
|
89
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
90
|
+
| `request` | [operations.CreatePaymentLinkRequest](../../sdk/models/operations/createpaymentlinkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
91
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
92
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
93
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
94
|
+
|
|
95
|
+
### Response
|
|
96
|
+
|
|
97
|
+
**Promise\<[shared.PaymentLink](../../sdk/models/shared/paymentlink.md)\>**
|
|
98
|
+
|
|
99
|
+
### Errors
|
|
100
|
+
|
|
101
|
+
| Error Type | Status Code | Content Type |
|
|
102
|
+
| --------------- | --------------- | --------------- |
|
|
103
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
104
|
+
|
|
105
|
+
## createPaymentPayment
|
|
106
|
+
|
|
107
|
+
Create a payment
|
|
108
|
+
|
|
109
|
+
### Example Usage
|
|
110
|
+
|
|
111
|
+
```typescript
|
|
112
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
113
|
+
|
|
114
|
+
const unifiedTo = new UnifiedTo({
|
|
115
|
+
security: {
|
|
116
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
117
|
+
},
|
|
118
|
+
});
|
|
119
|
+
|
|
120
|
+
async function run() {
|
|
121
|
+
const result = await unifiedTo.payment.createPaymentPayment({
|
|
122
|
+
connectionId: "<value>",
|
|
123
|
+
});
|
|
124
|
+
|
|
125
|
+
// Handle the result
|
|
126
|
+
console.log(result);
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
run();
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### Standalone function
|
|
133
|
+
|
|
134
|
+
The standalone function version of this method:
|
|
135
|
+
|
|
136
|
+
```typescript
|
|
137
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
138
|
+
import { paymentCreatePaymentPayment } from "@unified-api/typescript-sdk/funcs/paymentCreatePaymentPayment.js";
|
|
139
|
+
|
|
140
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
141
|
+
// You can create one instance of it to use across an application.
|
|
142
|
+
const unifiedTo = new UnifiedToCore({
|
|
143
|
+
security: {
|
|
144
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
145
|
+
},
|
|
146
|
+
});
|
|
147
|
+
|
|
148
|
+
async function run() {
|
|
149
|
+
const res = await paymentCreatePaymentPayment(unifiedTo, {
|
|
150
|
+
connectionId: "<value>",
|
|
151
|
+
});
|
|
152
|
+
|
|
153
|
+
if (!res.ok) {
|
|
154
|
+
throw res.error;
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
const { value: result } = res;
|
|
158
|
+
|
|
159
|
+
// Handle the result
|
|
160
|
+
console.log(result);
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
run();
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
### Parameters
|
|
167
|
+
|
|
168
|
+
| Parameter | Type | Required | Description |
|
|
169
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
170
|
+
| `request` | [operations.CreatePaymentPaymentRequest](../../sdk/models/operations/createpaymentpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
171
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
172
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
173
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
174
|
+
|
|
175
|
+
### Response
|
|
176
|
+
|
|
177
|
+
**Promise\<[shared.PaymentPayment](../../sdk/models/shared/paymentpayment.md)\>**
|
|
178
|
+
|
|
179
|
+
### Errors
|
|
180
|
+
|
|
181
|
+
| Error Type | Status Code | Content Type |
|
|
182
|
+
| --------------- | --------------- | --------------- |
|
|
183
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
184
|
+
|
|
185
|
+
## getPaymentLink
|
|
186
|
+
|
|
187
|
+
Retrieve a link
|
|
188
|
+
|
|
189
|
+
### Example Usage
|
|
190
|
+
|
|
191
|
+
```typescript
|
|
192
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
193
|
+
|
|
194
|
+
const unifiedTo = new UnifiedTo({
|
|
195
|
+
security: {
|
|
196
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
197
|
+
},
|
|
198
|
+
});
|
|
199
|
+
|
|
200
|
+
async function run() {
|
|
201
|
+
const result = await unifiedTo.payment.getPaymentLink({
|
|
202
|
+
connectionId: "<value>",
|
|
203
|
+
id: "<id>",
|
|
204
|
+
});
|
|
205
|
+
|
|
206
|
+
// Handle the result
|
|
207
|
+
console.log(result);
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
run();
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### Standalone function
|
|
214
|
+
|
|
215
|
+
The standalone function version of this method:
|
|
216
|
+
|
|
217
|
+
```typescript
|
|
218
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
219
|
+
import { paymentGetPaymentLink } from "@unified-api/typescript-sdk/funcs/paymentGetPaymentLink.js";
|
|
220
|
+
|
|
221
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
222
|
+
// You can create one instance of it to use across an application.
|
|
223
|
+
const unifiedTo = new UnifiedToCore({
|
|
224
|
+
security: {
|
|
225
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
226
|
+
},
|
|
227
|
+
});
|
|
228
|
+
|
|
229
|
+
async function run() {
|
|
230
|
+
const res = await paymentGetPaymentLink(unifiedTo, {
|
|
231
|
+
connectionId: "<value>",
|
|
232
|
+
id: "<id>",
|
|
233
|
+
});
|
|
234
|
+
|
|
235
|
+
if (!res.ok) {
|
|
236
|
+
throw res.error;
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
const { value: result } = res;
|
|
240
|
+
|
|
241
|
+
// Handle the result
|
|
242
|
+
console.log(result);
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
run();
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
### Parameters
|
|
249
|
+
|
|
250
|
+
| Parameter | Type | Required | Description |
|
|
251
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
252
|
+
| `request` | [operations.GetPaymentLinkRequest](../../sdk/models/operations/getpaymentlinkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
253
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
254
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
255
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
256
|
+
|
|
257
|
+
### Response
|
|
258
|
+
|
|
259
|
+
**Promise\<[shared.PaymentLink](../../sdk/models/shared/paymentlink.md)\>**
|
|
260
|
+
|
|
261
|
+
### Errors
|
|
262
|
+
|
|
263
|
+
| Error Type | Status Code | Content Type |
|
|
264
|
+
| --------------- | --------------- | --------------- |
|
|
265
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
266
|
+
|
|
267
|
+
## getPaymentPayment
|
|
268
|
+
|
|
269
|
+
Retrieve a payment
|
|
270
|
+
|
|
271
|
+
### Example Usage
|
|
272
|
+
|
|
273
|
+
```typescript
|
|
274
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
275
|
+
|
|
276
|
+
const unifiedTo = new UnifiedTo({
|
|
277
|
+
security: {
|
|
278
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
279
|
+
},
|
|
280
|
+
});
|
|
281
|
+
|
|
282
|
+
async function run() {
|
|
283
|
+
const result = await unifiedTo.payment.getPaymentPayment({
|
|
284
|
+
connectionId: "<value>",
|
|
285
|
+
id: "<id>",
|
|
286
|
+
});
|
|
287
|
+
|
|
288
|
+
// Handle the result
|
|
289
|
+
console.log(result);
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
run();
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
### Standalone function
|
|
296
|
+
|
|
297
|
+
The standalone function version of this method:
|
|
298
|
+
|
|
299
|
+
```typescript
|
|
300
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
301
|
+
import { paymentGetPaymentPayment } from "@unified-api/typescript-sdk/funcs/paymentGetPaymentPayment.js";
|
|
302
|
+
|
|
303
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
304
|
+
// You can create one instance of it to use across an application.
|
|
305
|
+
const unifiedTo = new UnifiedToCore({
|
|
306
|
+
security: {
|
|
307
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
308
|
+
},
|
|
309
|
+
});
|
|
310
|
+
|
|
311
|
+
async function run() {
|
|
312
|
+
const res = await paymentGetPaymentPayment(unifiedTo, {
|
|
313
|
+
connectionId: "<value>",
|
|
314
|
+
id: "<id>",
|
|
315
|
+
});
|
|
316
|
+
|
|
317
|
+
if (!res.ok) {
|
|
318
|
+
throw res.error;
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
const { value: result } = res;
|
|
322
|
+
|
|
323
|
+
// Handle the result
|
|
324
|
+
console.log(result);
|
|
325
|
+
}
|
|
326
|
+
|
|
327
|
+
run();
|
|
328
|
+
```
|
|
329
|
+
|
|
330
|
+
### Parameters
|
|
331
|
+
|
|
332
|
+
| Parameter | Type | Required | Description |
|
|
333
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
334
|
+
| `request` | [operations.GetPaymentPaymentRequest](../../sdk/models/operations/getpaymentpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
335
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
336
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
337
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
338
|
+
|
|
339
|
+
### Response
|
|
340
|
+
|
|
341
|
+
**Promise\<[shared.PaymentPayment](../../sdk/models/shared/paymentpayment.md)\>**
|
|
342
|
+
|
|
343
|
+
### Errors
|
|
344
|
+
|
|
345
|
+
| Error Type | Status Code | Content Type |
|
|
346
|
+
| --------------- | --------------- | --------------- |
|
|
347
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
348
|
+
|
|
349
|
+
## getPaymentPayout
|
|
350
|
+
|
|
351
|
+
Retrieve a payout
|
|
352
|
+
|
|
353
|
+
### Example Usage
|
|
354
|
+
|
|
355
|
+
```typescript
|
|
356
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
357
|
+
|
|
358
|
+
const unifiedTo = new UnifiedTo({
|
|
359
|
+
security: {
|
|
360
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
361
|
+
},
|
|
362
|
+
});
|
|
363
|
+
|
|
364
|
+
async function run() {
|
|
365
|
+
const result = await unifiedTo.payment.getPaymentPayout({
|
|
366
|
+
connectionId: "<value>",
|
|
367
|
+
id: "<id>",
|
|
368
|
+
});
|
|
369
|
+
|
|
370
|
+
// Handle the result
|
|
371
|
+
console.log(result);
|
|
372
|
+
}
|
|
373
|
+
|
|
374
|
+
run();
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
### Standalone function
|
|
378
|
+
|
|
379
|
+
The standalone function version of this method:
|
|
380
|
+
|
|
381
|
+
```typescript
|
|
382
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
383
|
+
import { paymentGetPaymentPayout } from "@unified-api/typescript-sdk/funcs/paymentGetPaymentPayout.js";
|
|
384
|
+
|
|
385
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
386
|
+
// You can create one instance of it to use across an application.
|
|
387
|
+
const unifiedTo = new UnifiedToCore({
|
|
388
|
+
security: {
|
|
389
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
390
|
+
},
|
|
391
|
+
});
|
|
392
|
+
|
|
393
|
+
async function run() {
|
|
394
|
+
const res = await paymentGetPaymentPayout(unifiedTo, {
|
|
395
|
+
connectionId: "<value>",
|
|
396
|
+
id: "<id>",
|
|
397
|
+
});
|
|
398
|
+
|
|
399
|
+
if (!res.ok) {
|
|
400
|
+
throw res.error;
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
const { value: result } = res;
|
|
404
|
+
|
|
405
|
+
// Handle the result
|
|
406
|
+
console.log(result);
|
|
407
|
+
}
|
|
408
|
+
|
|
409
|
+
run();
|
|
410
|
+
```
|
|
411
|
+
|
|
412
|
+
### Parameters
|
|
413
|
+
|
|
414
|
+
| Parameter | Type | Required | Description |
|
|
415
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
416
|
+
| `request` | [operations.GetPaymentPayoutRequest](../../sdk/models/operations/getpaymentpayoutrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
417
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
418
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
419
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
420
|
+
|
|
421
|
+
### Response
|
|
422
|
+
|
|
423
|
+
**Promise\<[shared.PaymentPayout](../../sdk/models/shared/paymentpayout.md)\>**
|
|
424
|
+
|
|
425
|
+
### Errors
|
|
426
|
+
|
|
427
|
+
| Error Type | Status Code | Content Type |
|
|
428
|
+
| --------------- | --------------- | --------------- |
|
|
429
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
430
|
+
|
|
431
|
+
## getPaymentRefund
|
|
432
|
+
|
|
433
|
+
Retrieve a refund
|
|
434
|
+
|
|
435
|
+
### Example Usage
|
|
436
|
+
|
|
437
|
+
```typescript
|
|
438
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
439
|
+
|
|
440
|
+
const unifiedTo = new UnifiedTo({
|
|
441
|
+
security: {
|
|
442
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
443
|
+
},
|
|
444
|
+
});
|
|
445
|
+
|
|
446
|
+
async function run() {
|
|
447
|
+
const result = await unifiedTo.payment.getPaymentRefund({
|
|
448
|
+
connectionId: "<value>",
|
|
449
|
+
id: "<id>",
|
|
450
|
+
});
|
|
451
|
+
|
|
452
|
+
// Handle the result
|
|
453
|
+
console.log(result);
|
|
454
|
+
}
|
|
455
|
+
|
|
456
|
+
run();
|
|
457
|
+
```
|
|
458
|
+
|
|
459
|
+
### Standalone function
|
|
460
|
+
|
|
461
|
+
The standalone function version of this method:
|
|
462
|
+
|
|
463
|
+
```typescript
|
|
464
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
465
|
+
import { paymentGetPaymentRefund } from "@unified-api/typescript-sdk/funcs/paymentGetPaymentRefund.js";
|
|
466
|
+
|
|
467
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
468
|
+
// You can create one instance of it to use across an application.
|
|
469
|
+
const unifiedTo = new UnifiedToCore({
|
|
470
|
+
security: {
|
|
471
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
472
|
+
},
|
|
473
|
+
});
|
|
474
|
+
|
|
475
|
+
async function run() {
|
|
476
|
+
const res = await paymentGetPaymentRefund(unifiedTo, {
|
|
477
|
+
connectionId: "<value>",
|
|
478
|
+
id: "<id>",
|
|
479
|
+
});
|
|
480
|
+
|
|
481
|
+
if (!res.ok) {
|
|
482
|
+
throw res.error;
|
|
483
|
+
}
|
|
484
|
+
|
|
485
|
+
const { value: result } = res;
|
|
486
|
+
|
|
487
|
+
// Handle the result
|
|
488
|
+
console.log(result);
|
|
489
|
+
}
|
|
490
|
+
|
|
491
|
+
run();
|
|
492
|
+
```
|
|
493
|
+
|
|
494
|
+
### Parameters
|
|
495
|
+
|
|
496
|
+
| Parameter | Type | Required | Description |
|
|
497
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
498
|
+
| `request` | [operations.GetPaymentRefundRequest](../../sdk/models/operations/getpaymentrefundrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
499
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
500
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
501
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
502
|
+
|
|
503
|
+
### Response
|
|
504
|
+
|
|
505
|
+
**Promise\<[shared.PaymentRefund](../../sdk/models/shared/paymentrefund.md)\>**
|
|
506
|
+
|
|
507
|
+
### Errors
|
|
508
|
+
|
|
509
|
+
| Error Type | Status Code | Content Type |
|
|
510
|
+
| --------------- | --------------- | --------------- |
|
|
511
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
512
|
+
|
|
513
|
+
## listPaymentLinks
|
|
514
|
+
|
|
515
|
+
List all links
|
|
516
|
+
|
|
517
|
+
### Example Usage
|
|
518
|
+
|
|
519
|
+
```typescript
|
|
520
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
521
|
+
|
|
522
|
+
const unifiedTo = new UnifiedTo({
|
|
523
|
+
security: {
|
|
524
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
525
|
+
},
|
|
526
|
+
});
|
|
527
|
+
|
|
528
|
+
async function run() {
|
|
529
|
+
const result = await unifiedTo.payment.listPaymentLinks({
|
|
530
|
+
connectionId: "<value>",
|
|
531
|
+
});
|
|
532
|
+
|
|
533
|
+
// Handle the result
|
|
534
|
+
console.log(result);
|
|
535
|
+
}
|
|
536
|
+
|
|
537
|
+
run();
|
|
538
|
+
```
|
|
539
|
+
|
|
540
|
+
### Standalone function
|
|
541
|
+
|
|
542
|
+
The standalone function version of this method:
|
|
543
|
+
|
|
544
|
+
```typescript
|
|
545
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
546
|
+
import { paymentListPaymentLinks } from "@unified-api/typescript-sdk/funcs/paymentListPaymentLinks.js";
|
|
547
|
+
|
|
548
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
549
|
+
// You can create one instance of it to use across an application.
|
|
550
|
+
const unifiedTo = new UnifiedToCore({
|
|
551
|
+
security: {
|
|
552
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
553
|
+
},
|
|
554
|
+
});
|
|
555
|
+
|
|
556
|
+
async function run() {
|
|
557
|
+
const res = await paymentListPaymentLinks(unifiedTo, {
|
|
558
|
+
connectionId: "<value>",
|
|
559
|
+
});
|
|
560
|
+
|
|
561
|
+
if (!res.ok) {
|
|
562
|
+
throw res.error;
|
|
563
|
+
}
|
|
564
|
+
|
|
565
|
+
const { value: result } = res;
|
|
566
|
+
|
|
567
|
+
// Handle the result
|
|
568
|
+
console.log(result);
|
|
569
|
+
}
|
|
570
|
+
|
|
571
|
+
run();
|
|
572
|
+
```
|
|
573
|
+
|
|
574
|
+
### Parameters
|
|
575
|
+
|
|
576
|
+
| Parameter | Type | Required | Description |
|
|
577
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
578
|
+
| `request` | [operations.ListPaymentLinksRequest](../../sdk/models/operations/listpaymentlinksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
579
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
580
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
581
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
582
|
+
|
|
583
|
+
### Response
|
|
584
|
+
|
|
585
|
+
**Promise\<[shared.PaymentLink[]](../../models/.md)\>**
|
|
586
|
+
|
|
587
|
+
### Errors
|
|
588
|
+
|
|
589
|
+
| Error Type | Status Code | Content Type |
|
|
590
|
+
| --------------- | --------------- | --------------- |
|
|
591
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
592
|
+
|
|
593
|
+
## listPaymentPayments
|
|
594
|
+
|
|
595
|
+
List all payments
|
|
596
|
+
|
|
597
|
+
### Example Usage
|
|
598
|
+
|
|
599
|
+
```typescript
|
|
600
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
601
|
+
|
|
602
|
+
const unifiedTo = new UnifiedTo({
|
|
603
|
+
security: {
|
|
604
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
605
|
+
},
|
|
606
|
+
});
|
|
607
|
+
|
|
608
|
+
async function run() {
|
|
609
|
+
const result = await unifiedTo.payment.listPaymentPayments({
|
|
610
|
+
connectionId: "<value>",
|
|
611
|
+
});
|
|
612
|
+
|
|
613
|
+
// Handle the result
|
|
614
|
+
console.log(result);
|
|
615
|
+
}
|
|
616
|
+
|
|
617
|
+
run();
|
|
618
|
+
```
|
|
619
|
+
|
|
620
|
+
### Standalone function
|
|
621
|
+
|
|
622
|
+
The standalone function version of this method:
|
|
623
|
+
|
|
624
|
+
```typescript
|
|
625
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
626
|
+
import { paymentListPaymentPayments } from "@unified-api/typescript-sdk/funcs/paymentListPaymentPayments.js";
|
|
627
|
+
|
|
628
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
629
|
+
// You can create one instance of it to use across an application.
|
|
630
|
+
const unifiedTo = new UnifiedToCore({
|
|
631
|
+
security: {
|
|
632
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
633
|
+
},
|
|
634
|
+
});
|
|
635
|
+
|
|
636
|
+
async function run() {
|
|
637
|
+
const res = await paymentListPaymentPayments(unifiedTo, {
|
|
638
|
+
connectionId: "<value>",
|
|
639
|
+
});
|
|
640
|
+
|
|
641
|
+
if (!res.ok) {
|
|
642
|
+
throw res.error;
|
|
643
|
+
}
|
|
644
|
+
|
|
645
|
+
const { value: result } = res;
|
|
646
|
+
|
|
647
|
+
// Handle the result
|
|
648
|
+
console.log(result);
|
|
649
|
+
}
|
|
650
|
+
|
|
651
|
+
run();
|
|
652
|
+
```
|
|
653
|
+
|
|
654
|
+
### Parameters
|
|
655
|
+
|
|
656
|
+
| Parameter | Type | Required | Description |
|
|
657
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
658
|
+
| `request` | [operations.ListPaymentPaymentsRequest](../../sdk/models/operations/listpaymentpaymentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
659
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
660
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
661
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
662
|
+
|
|
663
|
+
### Response
|
|
664
|
+
|
|
665
|
+
**Promise\<[shared.PaymentPayment[]](../../models/.md)\>**
|
|
666
|
+
|
|
667
|
+
### Errors
|
|
668
|
+
|
|
669
|
+
| Error Type | Status Code | Content Type |
|
|
670
|
+
| --------------- | --------------- | --------------- |
|
|
671
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
672
|
+
|
|
673
|
+
## listPaymentPayouts
|
|
674
|
+
|
|
675
|
+
List all payouts
|
|
676
|
+
|
|
677
|
+
### Example Usage
|
|
678
|
+
|
|
679
|
+
```typescript
|
|
680
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
681
|
+
|
|
682
|
+
const unifiedTo = new UnifiedTo({
|
|
683
|
+
security: {
|
|
684
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
685
|
+
},
|
|
686
|
+
});
|
|
687
|
+
|
|
688
|
+
async function run() {
|
|
689
|
+
const result = await unifiedTo.payment.listPaymentPayouts({
|
|
690
|
+
connectionId: "<value>",
|
|
691
|
+
});
|
|
692
|
+
|
|
693
|
+
// Handle the result
|
|
694
|
+
console.log(result);
|
|
695
|
+
}
|
|
696
|
+
|
|
697
|
+
run();
|
|
698
|
+
```
|
|
699
|
+
|
|
700
|
+
### Standalone function
|
|
701
|
+
|
|
702
|
+
The standalone function version of this method:
|
|
703
|
+
|
|
704
|
+
```typescript
|
|
705
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
706
|
+
import { paymentListPaymentPayouts } from "@unified-api/typescript-sdk/funcs/paymentListPaymentPayouts.js";
|
|
707
|
+
|
|
708
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
709
|
+
// You can create one instance of it to use across an application.
|
|
710
|
+
const unifiedTo = new UnifiedToCore({
|
|
711
|
+
security: {
|
|
712
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
713
|
+
},
|
|
714
|
+
});
|
|
715
|
+
|
|
716
|
+
async function run() {
|
|
717
|
+
const res = await paymentListPaymentPayouts(unifiedTo, {
|
|
718
|
+
connectionId: "<value>",
|
|
719
|
+
});
|
|
720
|
+
|
|
721
|
+
if (!res.ok) {
|
|
722
|
+
throw res.error;
|
|
723
|
+
}
|
|
724
|
+
|
|
725
|
+
const { value: result } = res;
|
|
726
|
+
|
|
727
|
+
// Handle the result
|
|
728
|
+
console.log(result);
|
|
729
|
+
}
|
|
730
|
+
|
|
731
|
+
run();
|
|
732
|
+
```
|
|
733
|
+
|
|
734
|
+
### Parameters
|
|
735
|
+
|
|
736
|
+
| Parameter | Type | Required | Description |
|
|
737
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
738
|
+
| `request` | [operations.ListPaymentPayoutsRequest](../../sdk/models/operations/listpaymentpayoutsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
739
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
740
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
741
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
742
|
+
|
|
743
|
+
### Response
|
|
744
|
+
|
|
745
|
+
**Promise\<[shared.PaymentPayout[]](../../models/.md)\>**
|
|
746
|
+
|
|
747
|
+
### Errors
|
|
748
|
+
|
|
749
|
+
| Error Type | Status Code | Content Type |
|
|
750
|
+
| --------------- | --------------- | --------------- |
|
|
751
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
752
|
+
|
|
753
|
+
## listPaymentRefunds
|
|
754
|
+
|
|
755
|
+
List all refunds
|
|
756
|
+
|
|
757
|
+
### Example Usage
|
|
758
|
+
|
|
759
|
+
```typescript
|
|
760
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
761
|
+
|
|
762
|
+
const unifiedTo = new UnifiedTo({
|
|
763
|
+
security: {
|
|
764
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
765
|
+
},
|
|
766
|
+
});
|
|
767
|
+
|
|
768
|
+
async function run() {
|
|
769
|
+
const result = await unifiedTo.payment.listPaymentRefunds({
|
|
770
|
+
connectionId: "<value>",
|
|
771
|
+
});
|
|
772
|
+
|
|
773
|
+
// Handle the result
|
|
774
|
+
console.log(result);
|
|
775
|
+
}
|
|
776
|
+
|
|
777
|
+
run();
|
|
778
|
+
```
|
|
779
|
+
|
|
780
|
+
### Standalone function
|
|
781
|
+
|
|
782
|
+
The standalone function version of this method:
|
|
783
|
+
|
|
784
|
+
```typescript
|
|
785
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
786
|
+
import { paymentListPaymentRefunds } from "@unified-api/typescript-sdk/funcs/paymentListPaymentRefunds.js";
|
|
787
|
+
|
|
788
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
789
|
+
// You can create one instance of it to use across an application.
|
|
790
|
+
const unifiedTo = new UnifiedToCore({
|
|
791
|
+
security: {
|
|
792
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
793
|
+
},
|
|
794
|
+
});
|
|
795
|
+
|
|
796
|
+
async function run() {
|
|
797
|
+
const res = await paymentListPaymentRefunds(unifiedTo, {
|
|
798
|
+
connectionId: "<value>",
|
|
799
|
+
});
|
|
800
|
+
|
|
801
|
+
if (!res.ok) {
|
|
802
|
+
throw res.error;
|
|
803
|
+
}
|
|
804
|
+
|
|
805
|
+
const { value: result } = res;
|
|
806
|
+
|
|
807
|
+
// Handle the result
|
|
808
|
+
console.log(result);
|
|
809
|
+
}
|
|
810
|
+
|
|
811
|
+
run();
|
|
812
|
+
```
|
|
813
|
+
|
|
814
|
+
### Parameters
|
|
815
|
+
|
|
816
|
+
| Parameter | Type | Required | Description |
|
|
817
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
818
|
+
| `request` | [operations.ListPaymentRefundsRequest](../../sdk/models/operations/listpaymentrefundsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
819
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
820
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
821
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
822
|
+
|
|
823
|
+
### Response
|
|
824
|
+
|
|
825
|
+
**Promise\<[shared.PaymentRefund[]](../../models/.md)\>**
|
|
826
|
+
|
|
827
|
+
### Errors
|
|
828
|
+
|
|
829
|
+
| Error Type | Status Code | Content Type |
|
|
830
|
+
| --------------- | --------------- | --------------- |
|
|
831
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
832
|
+
|
|
833
|
+
## patchPaymentLink
|
|
834
|
+
|
|
835
|
+
Update a link
|
|
836
|
+
|
|
837
|
+
### Example Usage
|
|
838
|
+
|
|
839
|
+
```typescript
|
|
840
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
841
|
+
|
|
842
|
+
const unifiedTo = new UnifiedTo({
|
|
843
|
+
security: {
|
|
844
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
845
|
+
},
|
|
846
|
+
});
|
|
847
|
+
|
|
848
|
+
async function run() {
|
|
849
|
+
const result = await unifiedTo.payment.patchPaymentLink({
|
|
850
|
+
connectionId: "<value>",
|
|
851
|
+
id: "<id>",
|
|
852
|
+
});
|
|
853
|
+
|
|
854
|
+
// Handle the result
|
|
855
|
+
console.log(result);
|
|
856
|
+
}
|
|
857
|
+
|
|
858
|
+
run();
|
|
859
|
+
```
|
|
860
|
+
|
|
861
|
+
### Standalone function
|
|
862
|
+
|
|
863
|
+
The standalone function version of this method:
|
|
864
|
+
|
|
865
|
+
```typescript
|
|
866
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
867
|
+
import { paymentPatchPaymentLink } from "@unified-api/typescript-sdk/funcs/paymentPatchPaymentLink.js";
|
|
868
|
+
|
|
869
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
870
|
+
// You can create one instance of it to use across an application.
|
|
871
|
+
const unifiedTo = new UnifiedToCore({
|
|
872
|
+
security: {
|
|
873
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
874
|
+
},
|
|
875
|
+
});
|
|
876
|
+
|
|
877
|
+
async function run() {
|
|
878
|
+
const res = await paymentPatchPaymentLink(unifiedTo, {
|
|
879
|
+
connectionId: "<value>",
|
|
880
|
+
id: "<id>",
|
|
881
|
+
});
|
|
882
|
+
|
|
883
|
+
if (!res.ok) {
|
|
884
|
+
throw res.error;
|
|
885
|
+
}
|
|
886
|
+
|
|
887
|
+
const { value: result } = res;
|
|
888
|
+
|
|
889
|
+
// Handle the result
|
|
890
|
+
console.log(result);
|
|
891
|
+
}
|
|
892
|
+
|
|
893
|
+
run();
|
|
894
|
+
```
|
|
895
|
+
|
|
896
|
+
### Parameters
|
|
897
|
+
|
|
898
|
+
| Parameter | Type | Required | Description |
|
|
899
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
900
|
+
| `request` | [operations.PatchPaymentLinkRequest](../../sdk/models/operations/patchpaymentlinkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
901
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
902
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
903
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
904
|
+
|
|
905
|
+
### Response
|
|
906
|
+
|
|
907
|
+
**Promise\<[shared.PaymentLink](../../sdk/models/shared/paymentlink.md)\>**
|
|
908
|
+
|
|
909
|
+
### Errors
|
|
910
|
+
|
|
911
|
+
| Error Type | Status Code | Content Type |
|
|
912
|
+
| --------------- | --------------- | --------------- |
|
|
913
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
914
|
+
|
|
915
|
+
## patchPaymentPayment
|
|
916
|
+
|
|
917
|
+
Update a payment
|
|
918
|
+
|
|
919
|
+
### Example Usage
|
|
920
|
+
|
|
921
|
+
```typescript
|
|
922
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
923
|
+
|
|
924
|
+
const unifiedTo = new UnifiedTo({
|
|
925
|
+
security: {
|
|
926
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
927
|
+
},
|
|
928
|
+
});
|
|
929
|
+
|
|
930
|
+
async function run() {
|
|
931
|
+
const result = await unifiedTo.payment.patchPaymentPayment({
|
|
932
|
+
connectionId: "<value>",
|
|
933
|
+
id: "<id>",
|
|
934
|
+
});
|
|
935
|
+
|
|
936
|
+
// Handle the result
|
|
937
|
+
console.log(result);
|
|
938
|
+
}
|
|
939
|
+
|
|
940
|
+
run();
|
|
941
|
+
```
|
|
942
|
+
|
|
943
|
+
### Standalone function
|
|
944
|
+
|
|
945
|
+
The standalone function version of this method:
|
|
946
|
+
|
|
947
|
+
```typescript
|
|
948
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
949
|
+
import { paymentPatchPaymentPayment } from "@unified-api/typescript-sdk/funcs/paymentPatchPaymentPayment.js";
|
|
950
|
+
|
|
951
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
952
|
+
// You can create one instance of it to use across an application.
|
|
953
|
+
const unifiedTo = new UnifiedToCore({
|
|
954
|
+
security: {
|
|
955
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
956
|
+
},
|
|
957
|
+
});
|
|
958
|
+
|
|
959
|
+
async function run() {
|
|
960
|
+
const res = await paymentPatchPaymentPayment(unifiedTo, {
|
|
961
|
+
connectionId: "<value>",
|
|
962
|
+
id: "<id>",
|
|
963
|
+
});
|
|
964
|
+
|
|
965
|
+
if (!res.ok) {
|
|
966
|
+
throw res.error;
|
|
967
|
+
}
|
|
968
|
+
|
|
969
|
+
const { value: result } = res;
|
|
970
|
+
|
|
971
|
+
// Handle the result
|
|
972
|
+
console.log(result);
|
|
973
|
+
}
|
|
974
|
+
|
|
975
|
+
run();
|
|
976
|
+
```
|
|
977
|
+
|
|
978
|
+
### Parameters
|
|
979
|
+
|
|
980
|
+
| Parameter | Type | Required | Description |
|
|
981
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
982
|
+
| `request` | [operations.PatchPaymentPaymentRequest](../../sdk/models/operations/patchpaymentpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
983
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
984
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
985
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
986
|
+
|
|
987
|
+
### Response
|
|
988
|
+
|
|
989
|
+
**Promise\<[shared.PaymentPayment](../../sdk/models/shared/paymentpayment.md)\>**
|
|
990
|
+
|
|
991
|
+
### Errors
|
|
992
|
+
|
|
993
|
+
| Error Type | Status Code | Content Type |
|
|
994
|
+
| --------------- | --------------- | --------------- |
|
|
995
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
996
|
+
|
|
997
|
+
## removePaymentLink
|
|
998
|
+
|
|
999
|
+
Remove a link
|
|
1000
|
+
|
|
1001
|
+
### Example Usage
|
|
1002
|
+
|
|
1003
|
+
```typescript
|
|
1004
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1005
|
+
|
|
1006
|
+
const unifiedTo = new UnifiedTo({
|
|
1007
|
+
security: {
|
|
1008
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1009
|
+
},
|
|
1010
|
+
});
|
|
1011
|
+
|
|
1012
|
+
async function run() {
|
|
1013
|
+
const result = await unifiedTo.payment.removePaymentLink({
|
|
1014
|
+
connectionId: "<value>",
|
|
1015
|
+
id: "<id>",
|
|
1016
|
+
});
|
|
1017
|
+
|
|
1018
|
+
// Handle the result
|
|
1019
|
+
console.log(result);
|
|
1020
|
+
}
|
|
1021
|
+
|
|
1022
|
+
run();
|
|
1023
|
+
```
|
|
1024
|
+
|
|
1025
|
+
### Standalone function
|
|
1026
|
+
|
|
1027
|
+
The standalone function version of this method:
|
|
1028
|
+
|
|
1029
|
+
```typescript
|
|
1030
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1031
|
+
import { paymentRemovePaymentLink } from "@unified-api/typescript-sdk/funcs/paymentRemovePaymentLink.js";
|
|
1032
|
+
|
|
1033
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1034
|
+
// You can create one instance of it to use across an application.
|
|
1035
|
+
const unifiedTo = new UnifiedToCore({
|
|
1036
|
+
security: {
|
|
1037
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1038
|
+
},
|
|
1039
|
+
});
|
|
1040
|
+
|
|
1041
|
+
async function run() {
|
|
1042
|
+
const res = await paymentRemovePaymentLink(unifiedTo, {
|
|
1043
|
+
connectionId: "<value>",
|
|
1044
|
+
id: "<id>",
|
|
1045
|
+
});
|
|
1046
|
+
|
|
1047
|
+
if (!res.ok) {
|
|
1048
|
+
throw res.error;
|
|
1049
|
+
}
|
|
1050
|
+
|
|
1051
|
+
const { value: result } = res;
|
|
1052
|
+
|
|
1053
|
+
// Handle the result
|
|
1054
|
+
console.log(result);
|
|
1055
|
+
}
|
|
1056
|
+
|
|
1057
|
+
run();
|
|
1058
|
+
```
|
|
1059
|
+
|
|
1060
|
+
### Parameters
|
|
1061
|
+
|
|
1062
|
+
| Parameter | Type | Required | Description |
|
|
1063
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1064
|
+
| `request` | [operations.RemovePaymentLinkRequest](../../sdk/models/operations/removepaymentlinkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1065
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1066
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1067
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1068
|
+
|
|
1069
|
+
### Response
|
|
1070
|
+
|
|
1071
|
+
**Promise\<[operations.RemovePaymentLinkResponse](../../sdk/models/operations/removepaymentlinkresponse.md)\>**
|
|
1072
|
+
|
|
1073
|
+
### Errors
|
|
1074
|
+
|
|
1075
|
+
| Error Type | Status Code | Content Type |
|
|
1076
|
+
| --------------- | --------------- | --------------- |
|
|
1077
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1078
|
+
|
|
1079
|
+
## removePaymentPayment
|
|
1080
|
+
|
|
1081
|
+
Remove a payment
|
|
1082
|
+
|
|
1083
|
+
### Example Usage
|
|
1084
|
+
|
|
1085
|
+
```typescript
|
|
1086
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1087
|
+
|
|
1088
|
+
const unifiedTo = new UnifiedTo({
|
|
1089
|
+
security: {
|
|
1090
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1091
|
+
},
|
|
1092
|
+
});
|
|
1093
|
+
|
|
1094
|
+
async function run() {
|
|
1095
|
+
const result = await unifiedTo.payment.removePaymentPayment({
|
|
1096
|
+
connectionId: "<value>",
|
|
1097
|
+
id: "<id>",
|
|
1098
|
+
});
|
|
1099
|
+
|
|
1100
|
+
// Handle the result
|
|
1101
|
+
console.log(result);
|
|
1102
|
+
}
|
|
1103
|
+
|
|
1104
|
+
run();
|
|
1105
|
+
```
|
|
1106
|
+
|
|
1107
|
+
### Standalone function
|
|
1108
|
+
|
|
1109
|
+
The standalone function version of this method:
|
|
1110
|
+
|
|
1111
|
+
```typescript
|
|
1112
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1113
|
+
import { paymentRemovePaymentPayment } from "@unified-api/typescript-sdk/funcs/paymentRemovePaymentPayment.js";
|
|
1114
|
+
|
|
1115
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1116
|
+
// You can create one instance of it to use across an application.
|
|
1117
|
+
const unifiedTo = new UnifiedToCore({
|
|
1118
|
+
security: {
|
|
1119
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1120
|
+
},
|
|
1121
|
+
});
|
|
1122
|
+
|
|
1123
|
+
async function run() {
|
|
1124
|
+
const res = await paymentRemovePaymentPayment(unifiedTo, {
|
|
1125
|
+
connectionId: "<value>",
|
|
1126
|
+
id: "<id>",
|
|
1127
|
+
});
|
|
1128
|
+
|
|
1129
|
+
if (!res.ok) {
|
|
1130
|
+
throw res.error;
|
|
1131
|
+
}
|
|
1132
|
+
|
|
1133
|
+
const { value: result } = res;
|
|
1134
|
+
|
|
1135
|
+
// Handle the result
|
|
1136
|
+
console.log(result);
|
|
1137
|
+
}
|
|
1138
|
+
|
|
1139
|
+
run();
|
|
1140
|
+
```
|
|
1141
|
+
|
|
1142
|
+
### Parameters
|
|
1143
|
+
|
|
1144
|
+
| Parameter | Type | Required | Description |
|
|
1145
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1146
|
+
| `request` | [operations.RemovePaymentPaymentRequest](../../sdk/models/operations/removepaymentpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1147
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1148
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1149
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1150
|
+
|
|
1151
|
+
### Response
|
|
1152
|
+
|
|
1153
|
+
**Promise\<[operations.RemovePaymentPaymentResponse](../../sdk/models/operations/removepaymentpaymentresponse.md)\>**
|
|
1154
|
+
|
|
1155
|
+
### Errors
|
|
1156
|
+
|
|
1157
|
+
| Error Type | Status Code | Content Type |
|
|
1158
|
+
| --------------- | --------------- | --------------- |
|
|
1159
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1160
|
+
|
|
1161
|
+
## updatePaymentLink
|
|
1162
|
+
|
|
1163
|
+
Update a link
|
|
1164
|
+
|
|
1165
|
+
### Example Usage
|
|
1166
|
+
|
|
1167
|
+
```typescript
|
|
1168
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1169
|
+
|
|
1170
|
+
const unifiedTo = new UnifiedTo({
|
|
1171
|
+
security: {
|
|
1172
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1173
|
+
},
|
|
1174
|
+
});
|
|
1175
|
+
|
|
1176
|
+
async function run() {
|
|
1177
|
+
const result = await unifiedTo.payment.updatePaymentLink({
|
|
1178
|
+
connectionId: "<value>",
|
|
1179
|
+
id: "<id>",
|
|
1180
|
+
});
|
|
1181
|
+
|
|
1182
|
+
// Handle the result
|
|
1183
|
+
console.log(result);
|
|
1184
|
+
}
|
|
1185
|
+
|
|
1186
|
+
run();
|
|
1187
|
+
```
|
|
1188
|
+
|
|
1189
|
+
### Standalone function
|
|
1190
|
+
|
|
1191
|
+
The standalone function version of this method:
|
|
1192
|
+
|
|
1193
|
+
```typescript
|
|
1194
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1195
|
+
import { paymentUpdatePaymentLink } from "@unified-api/typescript-sdk/funcs/paymentUpdatePaymentLink.js";
|
|
1196
|
+
|
|
1197
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1198
|
+
// You can create one instance of it to use across an application.
|
|
1199
|
+
const unifiedTo = new UnifiedToCore({
|
|
1200
|
+
security: {
|
|
1201
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1202
|
+
},
|
|
1203
|
+
});
|
|
1204
|
+
|
|
1205
|
+
async function run() {
|
|
1206
|
+
const res = await paymentUpdatePaymentLink(unifiedTo, {
|
|
1207
|
+
connectionId: "<value>",
|
|
1208
|
+
id: "<id>",
|
|
1209
|
+
});
|
|
1210
|
+
|
|
1211
|
+
if (!res.ok) {
|
|
1212
|
+
throw res.error;
|
|
1213
|
+
}
|
|
1214
|
+
|
|
1215
|
+
const { value: result } = res;
|
|
1216
|
+
|
|
1217
|
+
// Handle the result
|
|
1218
|
+
console.log(result);
|
|
1219
|
+
}
|
|
1220
|
+
|
|
1221
|
+
run();
|
|
1222
|
+
```
|
|
1223
|
+
|
|
1224
|
+
### Parameters
|
|
1225
|
+
|
|
1226
|
+
| Parameter | Type | Required | Description |
|
|
1227
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1228
|
+
| `request` | [operations.UpdatePaymentLinkRequest](../../sdk/models/operations/updatepaymentlinkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1229
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1230
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1231
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1232
|
+
|
|
1233
|
+
### Response
|
|
1234
|
+
|
|
1235
|
+
**Promise\<[shared.PaymentLink](../../sdk/models/shared/paymentlink.md)\>**
|
|
1236
|
+
|
|
1237
|
+
### Errors
|
|
1238
|
+
|
|
1239
|
+
| Error Type | Status Code | Content Type |
|
|
1240
|
+
| --------------- | --------------- | --------------- |
|
|
1241
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1242
|
+
|
|
1243
|
+
## updatePaymentPayment
|
|
1244
|
+
|
|
1245
|
+
Update a payment
|
|
1246
|
+
|
|
1247
|
+
### Example Usage
|
|
1248
|
+
|
|
1249
|
+
```typescript
|
|
1250
|
+
import { UnifiedTo } from "@unified-api/typescript-sdk";
|
|
1251
|
+
|
|
1252
|
+
const unifiedTo = new UnifiedTo({
|
|
1253
|
+
security: {
|
|
1254
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1255
|
+
},
|
|
1256
|
+
});
|
|
1257
|
+
|
|
1258
|
+
async function run() {
|
|
1259
|
+
const result = await unifiedTo.payment.updatePaymentPayment({
|
|
1260
|
+
connectionId: "<value>",
|
|
1261
|
+
id: "<id>",
|
|
1262
|
+
});
|
|
1263
|
+
|
|
1264
|
+
// Handle the result
|
|
1265
|
+
console.log(result);
|
|
1266
|
+
}
|
|
1267
|
+
|
|
1268
|
+
run();
|
|
1269
|
+
```
|
|
1270
|
+
|
|
1271
|
+
### Standalone function
|
|
1272
|
+
|
|
1273
|
+
The standalone function version of this method:
|
|
1274
|
+
|
|
1275
|
+
```typescript
|
|
1276
|
+
import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
|
|
1277
|
+
import { paymentUpdatePaymentPayment } from "@unified-api/typescript-sdk/funcs/paymentUpdatePaymentPayment.js";
|
|
1278
|
+
|
|
1279
|
+
// Use `UnifiedToCore` for best tree-shaking performance.
|
|
1280
|
+
// You can create one instance of it to use across an application.
|
|
1281
|
+
const unifiedTo = new UnifiedToCore({
|
|
1282
|
+
security: {
|
|
1283
|
+
jwt: "<YOUR_API_KEY_HERE>",
|
|
1284
|
+
},
|
|
1285
|
+
});
|
|
1286
|
+
|
|
1287
|
+
async function run() {
|
|
1288
|
+
const res = await paymentUpdatePaymentPayment(unifiedTo, {
|
|
1289
|
+
connectionId: "<value>",
|
|
1290
|
+
id: "<id>",
|
|
1291
|
+
});
|
|
1292
|
+
|
|
1293
|
+
if (!res.ok) {
|
|
1294
|
+
throw res.error;
|
|
1295
|
+
}
|
|
1296
|
+
|
|
1297
|
+
const { value: result } = res;
|
|
1298
|
+
|
|
1299
|
+
// Handle the result
|
|
1300
|
+
console.log(result);
|
|
1301
|
+
}
|
|
1302
|
+
|
|
1303
|
+
run();
|
|
1304
|
+
```
|
|
1305
|
+
|
|
1306
|
+
### Parameters
|
|
1307
|
+
|
|
1308
|
+
| Parameter | Type | Required | Description |
|
|
1309
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1310
|
+
| `request` | [operations.UpdatePaymentPaymentRequest](../../sdk/models/operations/updatepaymentpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1311
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1312
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1313
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1314
|
+
|
|
1315
|
+
### Response
|
|
1316
|
+
|
|
1317
|
+
**Promise\<[shared.PaymentPayment](../../sdk/models/shared/paymentpayment.md)\>**
|
|
1318
|
+
|
|
1319
|
+
### Errors
|
|
1320
|
+
|
|
1321
|
+
| Error Type | Status Code | Content Type |
|
|
1322
|
+
| --------------- | --------------- | --------------- |
|
|
1323
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|