@unified-api/typescript-sdk 2.80.0 → 2.80.1

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.
Files changed (120) hide show
  1. package/examples/package-lock.json +1 -1
  2. package/jsr.json +1 -1
  3. package/lib/config.d.ts +3 -3
  4. package/lib/config.js +3 -3
  5. package/package.json +1 -1
  6. package/sdk/models/shared/kmspage.d.ts +2 -0
  7. package/sdk/models/shared/kmspage.d.ts.map +1 -1
  8. package/sdk/models/shared/kmspage.js +4 -0
  9. package/sdk/models/shared/kmspage.js.map +1 -1
  10. package/src/lib/config.ts +3 -3
  11. package/src/sdk/models/shared/kmspage.ts +6 -0
  12. package/docs/sdks/account/README.md +0 -489
  13. package/docs/sdks/accounting/README.md +0 -7221
  14. package/docs/sdks/activity/README.md +0 -489
  15. package/docs/sdks/apicall/README.md +0 -159
  16. package/docs/sdks/application/README.md +0 -489
  17. package/docs/sdks/applicationstatus/README.md +0 -85
  18. package/docs/sdks/ats/README.md +0 -3953
  19. package/docs/sdks/auth/README.md +0 -167
  20. package/docs/sdks/balancesheet/README.md +0 -165
  21. package/docs/sdks/bill/README.md +0 -489
  22. package/docs/sdks/branch/README.md +0 -507
  23. package/docs/sdks/busy/README.md +0 -85
  24. package/docs/sdks/calendar/README.md +0 -1713
  25. package/docs/sdks/call/README.md +0 -85
  26. package/docs/sdks/candidate/README.md +0 -489
  27. package/docs/sdks/cashflow/README.md +0 -165
  28. package/docs/sdks/category/README.md +0 -971
  29. package/docs/sdks/change/README.md +0 -165
  30. package/docs/sdks/channel/README.md +0 -165
  31. package/docs/sdks/class/README.md +0 -507
  32. package/docs/sdks/collection/README.md +0 -501
  33. package/docs/sdks/comment/README.md +0 -1495
  34. package/docs/sdks/commerce/README.md +0 -2465
  35. package/docs/sdks/commit/README.md +0 -501
  36. package/docs/sdks/company/README.md +0 -1543
  37. package/docs/sdks/connection/README.md +0 -513
  38. package/docs/sdks/contact/README.md +0 -1453
  39. package/docs/sdks/course/README.md +0 -501
  40. package/docs/sdks/creditmemo/README.md +0 -489
  41. package/docs/sdks/crm/README.md +0 -2899
  42. package/docs/sdks/customer/README.md +0 -489
  43. package/docs/sdks/deal/README.md +0 -489
  44. package/docs/sdks/device/README.md +0 -501
  45. package/docs/sdks/document/README.md +0 -489
  46. package/docs/sdks/embedding/README.md +0 -87
  47. package/docs/sdks/employee/README.md +0 -489
  48. package/docs/sdks/enrich/README.md +0 -163
  49. package/docs/sdks/event/README.md +0 -971
  50. package/docs/sdks/expense/README.md +0 -489
  51. package/docs/sdks/file/README.md +0 -489
  52. package/docs/sdks/genai/README.md +0 -325
  53. package/docs/sdks/group/README.md +0 -983
  54. package/docs/sdks/hris/README.md +0 -3251
  55. package/docs/sdks/instructor/README.md +0 -489
  56. package/docs/sdks/integration/README.md +0 -239
  57. package/docs/sdks/interview/README.md +0 -489
  58. package/docs/sdks/inventory/README.md +0 -501
  59. package/docs/sdks/invoice/README.md +0 -489
  60. package/docs/sdks/issue/README.md +0 -159
  61. package/docs/sdks/item/README.md +0 -489
  62. package/docs/sdks/job/README.md +0 -489
  63. package/docs/sdks/journal/README.md +0 -489
  64. package/docs/sdks/kms/README.md +0 -1495
  65. package/docs/sdks/lead/README.md +0 -489
  66. package/docs/sdks/link/README.md +0 -983
  67. package/docs/sdks/list/README.md +0 -489
  68. package/docs/sdks/lms/README.md +0 -1965
  69. package/docs/sdks/location/README.md +0 -983
  70. package/docs/sdks/login/README.md +0 -87
  71. package/docs/sdks/martech/README.md +0 -971
  72. package/docs/sdks/member/README.md +0 -489
  73. package/docs/sdks/message/README.md +0 -489
  74. package/docs/sdks/messaging/README.md +0 -647
  75. package/docs/sdks/metadata/README.md +0 -507
  76. package/docs/sdks/model/README.md +0 -165
  77. package/docs/sdks/note/README.md +0 -489
  78. package/docs/sdks/order/README.md +0 -489
  79. package/docs/sdks/organization/README.md +0 -647
  80. package/docs/sdks/package/README.md +0 -165
  81. package/docs/sdks/page/README.md +0 -507
  82. package/docs/sdks/passthrough/README.md +0 -647
  83. package/docs/sdks/payment/README.md +0 -1769
  84. package/docs/sdks/payout/README.md +0 -165
  85. package/docs/sdks/payslip/README.md +0 -165
  86. package/docs/sdks/person/README.md +0 -85
  87. package/docs/sdks/pipeline/README.md +0 -489
  88. package/docs/sdks/profitloss/README.md +0 -165
  89. package/docs/sdks/project/README.md +0 -489
  90. package/docs/sdks/prompt/README.md +0 -87
  91. package/docs/sdks/pullrequest/README.md +0 -489
  92. package/docs/sdks/purchaseorder/README.md +0 -489
  93. package/docs/sdks/recording/README.md +0 -647
  94. package/docs/sdks/refund/README.md +0 -165
  95. package/docs/sdks/repo/README.md +0 -2459
  96. package/docs/sdks/report/README.md +0 -165
  97. package/docs/sdks/repository/README.md +0 -501
  98. package/docs/sdks/request/README.md +0 -489
  99. package/docs/sdks/review/README.md +0 -501
  100. package/docs/sdks/salesorder/README.md +0 -489
  101. package/docs/sdks/scim/README.md +0 -983
  102. package/docs/sdks/scorecard/README.md +0 -489
  103. package/docs/sdks/space/README.md +0 -501
  104. package/docs/sdks/storage/README.md +0 -489
  105. package/docs/sdks/student/README.md +0 -489
  106. package/docs/sdks/subscription/README.md +0 -489
  107. package/docs/sdks/task/README.md +0 -1629
  108. package/docs/sdks/taxrate/README.md +0 -489
  109. package/docs/sdks/ticket/README.md +0 -489
  110. package/docs/sdks/ticketing/README.md +0 -1935
  111. package/docs/sdks/timeoff/README.md +0 -165
  112. package/docs/sdks/timeshift/README.md +0 -513
  113. package/docs/sdks/transaction/README.md +0 -489
  114. package/docs/sdks/trialbalance/README.md +0 -165
  115. package/docs/sdks/uc/README.md +0 -1543
  116. package/docs/sdks/unified/README.md +0 -1697
  117. package/docs/sdks/user/README.md +0 -489
  118. package/docs/sdks/verification/README.md +0 -647
  119. package/docs/sdks/webhook/README.md +0 -655
  120. package/examples/README.md +0 -31
@@ -1,1769 +0,0 @@
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
- * [createPaymentSubscription](#createpaymentsubscription) - Create a subscription
11
- * [getPaymentLink](#getpaymentlink) - Retrieve a link
12
- * [getPaymentPayment](#getpaymentpayment) - Retrieve a payment
13
- * [getPaymentPayout](#getpaymentpayout) - Retrieve a payout
14
- * [getPaymentRefund](#getpaymentrefund) - Retrieve a refund
15
- * [getPaymentSubscription](#getpaymentsubscription) - Retrieve a subscription
16
- * [listPaymentLinks](#listpaymentlinks) - List all links
17
- * [listPaymentPayments](#listpaymentpayments) - List all payments
18
- * [listPaymentPayouts](#listpaymentpayouts) - List all payouts
19
- * [listPaymentRefunds](#listpaymentrefunds) - List all refunds
20
- * [listPaymentSubscriptions](#listpaymentsubscriptions) - List all subscriptions
21
- * [patchPaymentLink](#patchpaymentlink) - Update a link
22
- * [patchPaymentPayment](#patchpaymentpayment) - Update a payment
23
- * [patchPaymentSubscription](#patchpaymentsubscription) - Update a subscription
24
- * [removePaymentLink](#removepaymentlink) - Remove a link
25
- * [removePaymentPayment](#removepaymentpayment) - Remove a payment
26
- * [removePaymentSubscription](#removepaymentsubscription) - Remove a subscription
27
- * [updatePaymentLink](#updatepaymentlink) - Update a link
28
- * [updatePaymentPayment](#updatepaymentpayment) - Update a payment
29
- * [updatePaymentSubscription](#updatepaymentsubscription) - Update a subscription
30
-
31
- ## createPaymentLink
32
-
33
- Create a link
34
-
35
- ### Example Usage
36
-
37
- <!-- UsageSnippet language="typescript" operationID="createPaymentLink" method="post" path="/payment/{connection_id}/link" -->
38
- ```typescript
39
- import { UnifiedTo } from "@unified-api/typescript-sdk";
40
-
41
- const unifiedTo = new UnifiedTo({
42
- security: {
43
- jwt: "<YOUR_API_KEY_HERE>",
44
- },
45
- });
46
-
47
- async function run() {
48
- const result = await unifiedTo.payment.createPaymentLink({
49
- paymentLink: {},
50
- connectionId: "<id>",
51
- });
52
-
53
- console.log(result);
54
- }
55
-
56
- run();
57
- ```
58
-
59
- ### Standalone function
60
-
61
- The standalone function version of this method:
62
-
63
- ```typescript
64
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
65
- import { linkCreatePaymentLink } from "@unified-api/typescript-sdk/funcs/linkCreatePaymentLink.js";
66
-
67
- // Use `UnifiedToCore` for best tree-shaking performance.
68
- // You can create one instance of it to use across an application.
69
- const unifiedTo = new UnifiedToCore({
70
- security: {
71
- jwt: "<YOUR_API_KEY_HERE>",
72
- },
73
- });
74
-
75
- async function run() {
76
- const res = await linkCreatePaymentLink(unifiedTo, {
77
- paymentLink: {},
78
- connectionId: "<id>",
79
- });
80
- if (res.ok) {
81
- const { value: result } = res;
82
- console.log(result);
83
- } else {
84
- console.log("linkCreatePaymentLink failed:", res.error);
85
- }
86
- }
87
-
88
- run();
89
- ```
90
-
91
- ### Parameters
92
-
93
- | Parameter | Type | Required | Description |
94
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
95
- | `request` | [operations.CreatePaymentLinkRequest](../../sdk/models/operations/createpaymentlinkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
96
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
97
- | `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. |
98
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
99
-
100
- ### Response
101
-
102
- **Promise\<[shared.PaymentLink](../../sdk/models/shared/paymentlink.md)\>**
103
-
104
- ### Errors
105
-
106
- | Error Type | Status Code | Content Type |
107
- | --------------- | --------------- | --------------- |
108
- | errors.SDKError | 4XX, 5XX | \*/\* |
109
-
110
- ## createPaymentPayment
111
-
112
- Create a payment
113
-
114
- ### Example Usage
115
-
116
- <!-- UsageSnippet language="typescript" operationID="createPaymentPayment" method="post" path="/payment/{connection_id}/payment" -->
117
- ```typescript
118
- import { UnifiedTo } from "@unified-api/typescript-sdk";
119
-
120
- const unifiedTo = new UnifiedTo({
121
- security: {
122
- jwt: "<YOUR_API_KEY_HERE>",
123
- },
124
- });
125
-
126
- async function run() {
127
- const result = await unifiedTo.payment.createPaymentPayment({
128
- paymentPayment: {},
129
- connectionId: "<id>",
130
- });
131
-
132
- console.log(result);
133
- }
134
-
135
- run();
136
- ```
137
-
138
- ### Standalone function
139
-
140
- The standalone function version of this method:
141
-
142
- ```typescript
143
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
144
- import { paymentCreatePaymentPayment } from "@unified-api/typescript-sdk/funcs/paymentCreatePaymentPayment.js";
145
-
146
- // Use `UnifiedToCore` for best tree-shaking performance.
147
- // You can create one instance of it to use across an application.
148
- const unifiedTo = new UnifiedToCore({
149
- security: {
150
- jwt: "<YOUR_API_KEY_HERE>",
151
- },
152
- });
153
-
154
- async function run() {
155
- const res = await paymentCreatePaymentPayment(unifiedTo, {
156
- paymentPayment: {},
157
- connectionId: "<id>",
158
- });
159
- if (res.ok) {
160
- const { value: result } = res;
161
- console.log(result);
162
- } else {
163
- console.log("paymentCreatePaymentPayment failed:", res.error);
164
- }
165
- }
166
-
167
- run();
168
- ```
169
-
170
- ### Parameters
171
-
172
- | Parameter | Type | Required | Description |
173
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
174
- | `request` | [operations.CreatePaymentPaymentRequest](../../sdk/models/operations/createpaymentpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
175
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
176
- | `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. |
177
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
178
-
179
- ### Response
180
-
181
- **Promise\<[shared.PaymentPayment](../../sdk/models/shared/paymentpayment.md)\>**
182
-
183
- ### Errors
184
-
185
- | Error Type | Status Code | Content Type |
186
- | --------------- | --------------- | --------------- |
187
- | errors.SDKError | 4XX, 5XX | \*/\* |
188
-
189
- ## createPaymentSubscription
190
-
191
- Create a subscription
192
-
193
- ### Example Usage
194
-
195
- <!-- UsageSnippet language="typescript" operationID="createPaymentSubscription" method="post" path="/payment/{connection_id}/subscription" -->
196
- ```typescript
197
- import { UnifiedTo } from "@unified-api/typescript-sdk";
198
-
199
- const unifiedTo = new UnifiedTo({
200
- security: {
201
- jwt: "<YOUR_API_KEY_HERE>",
202
- },
203
- });
204
-
205
- async function run() {
206
- const result = await unifiedTo.payment.createPaymentSubscription({
207
- paymentSubscription: {},
208
- connectionId: "<id>",
209
- });
210
-
211
- console.log(result);
212
- }
213
-
214
- run();
215
- ```
216
-
217
- ### Standalone function
218
-
219
- The standalone function version of this method:
220
-
221
- ```typescript
222
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
223
- import { paymentCreatePaymentSubscription } from "@unified-api/typescript-sdk/funcs/paymentCreatePaymentSubscription.js";
224
-
225
- // Use `UnifiedToCore` for best tree-shaking performance.
226
- // You can create one instance of it to use across an application.
227
- const unifiedTo = new UnifiedToCore({
228
- security: {
229
- jwt: "<YOUR_API_KEY_HERE>",
230
- },
231
- });
232
-
233
- async function run() {
234
- const res = await paymentCreatePaymentSubscription(unifiedTo, {
235
- paymentSubscription: {},
236
- connectionId: "<id>",
237
- });
238
- if (res.ok) {
239
- const { value: result } = res;
240
- console.log(result);
241
- } else {
242
- console.log("paymentCreatePaymentSubscription failed:", res.error);
243
- }
244
- }
245
-
246
- run();
247
- ```
248
-
249
- ### Parameters
250
-
251
- | Parameter | Type | Required | Description |
252
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
253
- | `request` | [operations.CreatePaymentSubscriptionRequest](../../sdk/models/operations/createpaymentsubscriptionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
254
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
255
- | `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. |
256
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
257
-
258
- ### Response
259
-
260
- **Promise\<[shared.PaymentSubscription](../../sdk/models/shared/paymentsubscription.md)\>**
261
-
262
- ### Errors
263
-
264
- | Error Type | Status Code | Content Type |
265
- | --------------- | --------------- | --------------- |
266
- | errors.SDKError | 4XX, 5XX | \*/\* |
267
-
268
- ## getPaymentLink
269
-
270
- Retrieve a link
271
-
272
- ### Example Usage
273
-
274
- <!-- UsageSnippet language="typescript" operationID="getPaymentLink" method="get" path="/payment/{connection_id}/link/{id}" -->
275
- ```typescript
276
- import { UnifiedTo } from "@unified-api/typescript-sdk";
277
-
278
- const unifiedTo = new UnifiedTo({
279
- security: {
280
- jwt: "<YOUR_API_KEY_HERE>",
281
- },
282
- });
283
-
284
- async function run() {
285
- const result = await unifiedTo.payment.getPaymentLink({
286
- connectionId: "<id>",
287
- id: "<id>",
288
- });
289
-
290
- console.log(result);
291
- }
292
-
293
- run();
294
- ```
295
-
296
- ### Standalone function
297
-
298
- The standalone function version of this method:
299
-
300
- ```typescript
301
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
302
- import { linkGetPaymentLink } from "@unified-api/typescript-sdk/funcs/linkGetPaymentLink.js";
303
-
304
- // Use `UnifiedToCore` for best tree-shaking performance.
305
- // You can create one instance of it to use across an application.
306
- const unifiedTo = new UnifiedToCore({
307
- security: {
308
- jwt: "<YOUR_API_KEY_HERE>",
309
- },
310
- });
311
-
312
- async function run() {
313
- const res = await linkGetPaymentLink(unifiedTo, {
314
- connectionId: "<id>",
315
- id: "<id>",
316
- });
317
- if (res.ok) {
318
- const { value: result } = res;
319
- console.log(result);
320
- } else {
321
- console.log("linkGetPaymentLink failed:", res.error);
322
- }
323
- }
324
-
325
- run();
326
- ```
327
-
328
- ### Parameters
329
-
330
- | Parameter | Type | Required | Description |
331
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
332
- | `request` | [operations.GetPaymentLinkRequest](../../sdk/models/operations/getpaymentlinkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
333
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
334
- | `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. |
335
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
336
-
337
- ### Response
338
-
339
- **Promise\<[shared.PaymentLink](../../sdk/models/shared/paymentlink.md)\>**
340
-
341
- ### Errors
342
-
343
- | Error Type | Status Code | Content Type |
344
- | --------------- | --------------- | --------------- |
345
- | errors.SDKError | 4XX, 5XX | \*/\* |
346
-
347
- ## getPaymentPayment
348
-
349
- Retrieve a payment
350
-
351
- ### Example Usage
352
-
353
- <!-- UsageSnippet language="typescript" operationID="getPaymentPayment" method="get" path="/payment/{connection_id}/payment/{id}" -->
354
- ```typescript
355
- import { UnifiedTo } from "@unified-api/typescript-sdk";
356
-
357
- const unifiedTo = new UnifiedTo({
358
- security: {
359
- jwt: "<YOUR_API_KEY_HERE>",
360
- },
361
- });
362
-
363
- async function run() {
364
- const result = await unifiedTo.payment.getPaymentPayment({
365
- connectionId: "<id>",
366
- id: "<id>",
367
- });
368
-
369
- console.log(result);
370
- }
371
-
372
- run();
373
- ```
374
-
375
- ### Standalone function
376
-
377
- The standalone function version of this method:
378
-
379
- ```typescript
380
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
381
- import { paymentGetPaymentPayment } from "@unified-api/typescript-sdk/funcs/paymentGetPaymentPayment.js";
382
-
383
- // Use `UnifiedToCore` for best tree-shaking performance.
384
- // You can create one instance of it to use across an application.
385
- const unifiedTo = new UnifiedToCore({
386
- security: {
387
- jwt: "<YOUR_API_KEY_HERE>",
388
- },
389
- });
390
-
391
- async function run() {
392
- const res = await paymentGetPaymentPayment(unifiedTo, {
393
- connectionId: "<id>",
394
- id: "<id>",
395
- });
396
- if (res.ok) {
397
- const { value: result } = res;
398
- console.log(result);
399
- } else {
400
- console.log("paymentGetPaymentPayment failed:", res.error);
401
- }
402
- }
403
-
404
- run();
405
- ```
406
-
407
- ### Parameters
408
-
409
- | Parameter | Type | Required | Description |
410
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
411
- | `request` | [operations.GetPaymentPaymentRequest](../../sdk/models/operations/getpaymentpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
412
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
413
- | `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. |
414
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
415
-
416
- ### Response
417
-
418
- **Promise\<[shared.PaymentPayment](../../sdk/models/shared/paymentpayment.md)\>**
419
-
420
- ### Errors
421
-
422
- | Error Type | Status Code | Content Type |
423
- | --------------- | --------------- | --------------- |
424
- | errors.SDKError | 4XX, 5XX | \*/\* |
425
-
426
- ## getPaymentPayout
427
-
428
- Retrieve a payout
429
-
430
- ### Example Usage
431
-
432
- <!-- UsageSnippet language="typescript" operationID="getPaymentPayout" method="get" path="/payment/{connection_id}/payout/{id}" -->
433
- ```typescript
434
- import { UnifiedTo } from "@unified-api/typescript-sdk";
435
-
436
- const unifiedTo = new UnifiedTo({
437
- security: {
438
- jwt: "<YOUR_API_KEY_HERE>",
439
- },
440
- });
441
-
442
- async function run() {
443
- const result = await unifiedTo.payment.getPaymentPayout({
444
- connectionId: "<id>",
445
- id: "<id>",
446
- });
447
-
448
- console.log(result);
449
- }
450
-
451
- run();
452
- ```
453
-
454
- ### Standalone function
455
-
456
- The standalone function version of this method:
457
-
458
- ```typescript
459
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
460
- import { paymentGetPaymentPayout } from "@unified-api/typescript-sdk/funcs/paymentGetPaymentPayout.js";
461
-
462
- // Use `UnifiedToCore` for best tree-shaking performance.
463
- // You can create one instance of it to use across an application.
464
- const unifiedTo = new UnifiedToCore({
465
- security: {
466
- jwt: "<YOUR_API_KEY_HERE>",
467
- },
468
- });
469
-
470
- async function run() {
471
- const res = await paymentGetPaymentPayout(unifiedTo, {
472
- connectionId: "<id>",
473
- id: "<id>",
474
- });
475
- if (res.ok) {
476
- const { value: result } = res;
477
- console.log(result);
478
- } else {
479
- console.log("paymentGetPaymentPayout failed:", res.error);
480
- }
481
- }
482
-
483
- run();
484
- ```
485
-
486
- ### Parameters
487
-
488
- | Parameter | Type | Required | Description |
489
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
490
- | `request` | [operations.GetPaymentPayoutRequest](../../sdk/models/operations/getpaymentpayoutrequest.md) | :heavy_check_mark: | The request object to use for the request. |
491
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
492
- | `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. |
493
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
494
-
495
- ### Response
496
-
497
- **Promise\<[shared.PaymentPayout](../../sdk/models/shared/paymentpayout.md)\>**
498
-
499
- ### Errors
500
-
501
- | Error Type | Status Code | Content Type |
502
- | --------------- | --------------- | --------------- |
503
- | errors.SDKError | 4XX, 5XX | \*/\* |
504
-
505
- ## getPaymentRefund
506
-
507
- Retrieve a refund
508
-
509
- ### Example Usage
510
-
511
- <!-- UsageSnippet language="typescript" operationID="getPaymentRefund" method="get" path="/payment/{connection_id}/refund/{id}" -->
512
- ```typescript
513
- import { UnifiedTo } from "@unified-api/typescript-sdk";
514
-
515
- const unifiedTo = new UnifiedTo({
516
- security: {
517
- jwt: "<YOUR_API_KEY_HERE>",
518
- },
519
- });
520
-
521
- async function run() {
522
- const result = await unifiedTo.payment.getPaymentRefund({
523
- connectionId: "<id>",
524
- id: "<id>",
525
- });
526
-
527
- console.log(result);
528
- }
529
-
530
- run();
531
- ```
532
-
533
- ### Standalone function
534
-
535
- The standalone function version of this method:
536
-
537
- ```typescript
538
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
539
- import { paymentGetPaymentRefund } from "@unified-api/typescript-sdk/funcs/paymentGetPaymentRefund.js";
540
-
541
- // Use `UnifiedToCore` for best tree-shaking performance.
542
- // You can create one instance of it to use across an application.
543
- const unifiedTo = new UnifiedToCore({
544
- security: {
545
- jwt: "<YOUR_API_KEY_HERE>",
546
- },
547
- });
548
-
549
- async function run() {
550
- const res = await paymentGetPaymentRefund(unifiedTo, {
551
- connectionId: "<id>",
552
- id: "<id>",
553
- });
554
- if (res.ok) {
555
- const { value: result } = res;
556
- console.log(result);
557
- } else {
558
- console.log("paymentGetPaymentRefund failed:", res.error);
559
- }
560
- }
561
-
562
- run();
563
- ```
564
-
565
- ### Parameters
566
-
567
- | Parameter | Type | Required | Description |
568
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
569
- | `request` | [operations.GetPaymentRefundRequest](../../sdk/models/operations/getpaymentrefundrequest.md) | :heavy_check_mark: | The request object to use for the request. |
570
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
571
- | `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. |
572
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
573
-
574
- ### Response
575
-
576
- **Promise\<[shared.PaymentRefund](../../sdk/models/shared/paymentrefund.md)\>**
577
-
578
- ### Errors
579
-
580
- | Error Type | Status Code | Content Type |
581
- | --------------- | --------------- | --------------- |
582
- | errors.SDKError | 4XX, 5XX | \*/\* |
583
-
584
- ## getPaymentSubscription
585
-
586
- Retrieve a subscription
587
-
588
- ### Example Usage
589
-
590
- <!-- UsageSnippet language="typescript" operationID="getPaymentSubscription" method="get" path="/payment/{connection_id}/subscription/{id}" -->
591
- ```typescript
592
- import { UnifiedTo } from "@unified-api/typescript-sdk";
593
-
594
- const unifiedTo = new UnifiedTo({
595
- security: {
596
- jwt: "<YOUR_API_KEY_HERE>",
597
- },
598
- });
599
-
600
- async function run() {
601
- const result = await unifiedTo.payment.getPaymentSubscription({
602
- connectionId: "<id>",
603
- id: "<id>",
604
- });
605
-
606
- console.log(result);
607
- }
608
-
609
- run();
610
- ```
611
-
612
- ### Standalone function
613
-
614
- The standalone function version of this method:
615
-
616
- ```typescript
617
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
618
- import { paymentGetPaymentSubscription } from "@unified-api/typescript-sdk/funcs/paymentGetPaymentSubscription.js";
619
-
620
- // Use `UnifiedToCore` for best tree-shaking performance.
621
- // You can create one instance of it to use across an application.
622
- const unifiedTo = new UnifiedToCore({
623
- security: {
624
- jwt: "<YOUR_API_KEY_HERE>",
625
- },
626
- });
627
-
628
- async function run() {
629
- const res = await paymentGetPaymentSubscription(unifiedTo, {
630
- connectionId: "<id>",
631
- id: "<id>",
632
- });
633
- if (res.ok) {
634
- const { value: result } = res;
635
- console.log(result);
636
- } else {
637
- console.log("paymentGetPaymentSubscription failed:", res.error);
638
- }
639
- }
640
-
641
- run();
642
- ```
643
-
644
- ### Parameters
645
-
646
- | Parameter | Type | Required | Description |
647
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
648
- | `request` | [operations.GetPaymentSubscriptionRequest](../../sdk/models/operations/getpaymentsubscriptionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
649
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
650
- | `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. |
651
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
652
-
653
- ### Response
654
-
655
- **Promise\<[shared.PaymentSubscription](../../sdk/models/shared/paymentsubscription.md)\>**
656
-
657
- ### Errors
658
-
659
- | Error Type | Status Code | Content Type |
660
- | --------------- | --------------- | --------------- |
661
- | errors.SDKError | 4XX, 5XX | \*/\* |
662
-
663
- ## listPaymentLinks
664
-
665
- List all links
666
-
667
- ### Example Usage
668
-
669
- <!-- UsageSnippet language="typescript" operationID="listPaymentLinks" method="get" path="/payment/{connection_id}/link" -->
670
- ```typescript
671
- import { UnifiedTo } from "@unified-api/typescript-sdk";
672
-
673
- const unifiedTo = new UnifiedTo({
674
- security: {
675
- jwt: "<YOUR_API_KEY_HERE>",
676
- },
677
- });
678
-
679
- async function run() {
680
- const result = await unifiedTo.payment.listPaymentLinks({
681
- connectionId: "<id>",
682
- });
683
-
684
- console.log(result);
685
- }
686
-
687
- run();
688
- ```
689
-
690
- ### Standalone function
691
-
692
- The standalone function version of this method:
693
-
694
- ```typescript
695
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
696
- import { linkListPaymentLinks } from "@unified-api/typescript-sdk/funcs/linkListPaymentLinks.js";
697
-
698
- // Use `UnifiedToCore` for best tree-shaking performance.
699
- // You can create one instance of it to use across an application.
700
- const unifiedTo = new UnifiedToCore({
701
- security: {
702
- jwt: "<YOUR_API_KEY_HERE>",
703
- },
704
- });
705
-
706
- async function run() {
707
- const res = await linkListPaymentLinks(unifiedTo, {
708
- connectionId: "<id>",
709
- });
710
- if (res.ok) {
711
- const { value: result } = res;
712
- console.log(result);
713
- } else {
714
- console.log("linkListPaymentLinks failed:", res.error);
715
- }
716
- }
717
-
718
- run();
719
- ```
720
-
721
- ### Parameters
722
-
723
- | Parameter | Type | Required | Description |
724
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
725
- | `request` | [operations.ListPaymentLinksRequest](../../sdk/models/operations/listpaymentlinksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
726
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
727
- | `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. |
728
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
729
-
730
- ### Response
731
-
732
- **Promise\<[shared.PaymentLink[]](../../models/.md)\>**
733
-
734
- ### Errors
735
-
736
- | Error Type | Status Code | Content Type |
737
- | --------------- | --------------- | --------------- |
738
- | errors.SDKError | 4XX, 5XX | \*/\* |
739
-
740
- ## listPaymentPayments
741
-
742
- List all payments
743
-
744
- ### Example Usage
745
-
746
- <!-- UsageSnippet language="typescript" operationID="listPaymentPayments" method="get" path="/payment/{connection_id}/payment" -->
747
- ```typescript
748
- import { UnifiedTo } from "@unified-api/typescript-sdk";
749
-
750
- const unifiedTo = new UnifiedTo({
751
- security: {
752
- jwt: "<YOUR_API_KEY_HERE>",
753
- },
754
- });
755
-
756
- async function run() {
757
- const result = await unifiedTo.payment.listPaymentPayments({
758
- connectionId: "<id>",
759
- });
760
-
761
- console.log(result);
762
- }
763
-
764
- run();
765
- ```
766
-
767
- ### Standalone function
768
-
769
- The standalone function version of this method:
770
-
771
- ```typescript
772
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
773
- import { paymentListPaymentPayments } from "@unified-api/typescript-sdk/funcs/paymentListPaymentPayments.js";
774
-
775
- // Use `UnifiedToCore` for best tree-shaking performance.
776
- // You can create one instance of it to use across an application.
777
- const unifiedTo = new UnifiedToCore({
778
- security: {
779
- jwt: "<YOUR_API_KEY_HERE>",
780
- },
781
- });
782
-
783
- async function run() {
784
- const res = await paymentListPaymentPayments(unifiedTo, {
785
- connectionId: "<id>",
786
- });
787
- if (res.ok) {
788
- const { value: result } = res;
789
- console.log(result);
790
- } else {
791
- console.log("paymentListPaymentPayments failed:", res.error);
792
- }
793
- }
794
-
795
- run();
796
- ```
797
-
798
- ### Parameters
799
-
800
- | Parameter | Type | Required | Description |
801
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
802
- | `request` | [operations.ListPaymentPaymentsRequest](../../sdk/models/operations/listpaymentpaymentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
803
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
804
- | `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. |
805
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
806
-
807
- ### Response
808
-
809
- **Promise\<[shared.PaymentPayment[]](../../models/.md)\>**
810
-
811
- ### Errors
812
-
813
- | Error Type | Status Code | Content Type |
814
- | --------------- | --------------- | --------------- |
815
- | errors.SDKError | 4XX, 5XX | \*/\* |
816
-
817
- ## listPaymentPayouts
818
-
819
- List all payouts
820
-
821
- ### Example Usage
822
-
823
- <!-- UsageSnippet language="typescript" operationID="listPaymentPayouts" method="get" path="/payment/{connection_id}/payout" -->
824
- ```typescript
825
- import { UnifiedTo } from "@unified-api/typescript-sdk";
826
-
827
- const unifiedTo = new UnifiedTo({
828
- security: {
829
- jwt: "<YOUR_API_KEY_HERE>",
830
- },
831
- });
832
-
833
- async function run() {
834
- const result = await unifiedTo.payment.listPaymentPayouts({
835
- connectionId: "<id>",
836
- });
837
-
838
- console.log(result);
839
- }
840
-
841
- run();
842
- ```
843
-
844
- ### Standalone function
845
-
846
- The standalone function version of this method:
847
-
848
- ```typescript
849
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
850
- import { paymentListPaymentPayouts } from "@unified-api/typescript-sdk/funcs/paymentListPaymentPayouts.js";
851
-
852
- // Use `UnifiedToCore` for best tree-shaking performance.
853
- // You can create one instance of it to use across an application.
854
- const unifiedTo = new UnifiedToCore({
855
- security: {
856
- jwt: "<YOUR_API_KEY_HERE>",
857
- },
858
- });
859
-
860
- async function run() {
861
- const res = await paymentListPaymentPayouts(unifiedTo, {
862
- connectionId: "<id>",
863
- });
864
- if (res.ok) {
865
- const { value: result } = res;
866
- console.log(result);
867
- } else {
868
- console.log("paymentListPaymentPayouts failed:", res.error);
869
- }
870
- }
871
-
872
- run();
873
- ```
874
-
875
- ### Parameters
876
-
877
- | Parameter | Type | Required | Description |
878
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
879
- | `request` | [operations.ListPaymentPayoutsRequest](../../sdk/models/operations/listpaymentpayoutsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
880
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
881
- | `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. |
882
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
883
-
884
- ### Response
885
-
886
- **Promise\<[shared.PaymentPayout[]](../../models/.md)\>**
887
-
888
- ### Errors
889
-
890
- | Error Type | Status Code | Content Type |
891
- | --------------- | --------------- | --------------- |
892
- | errors.SDKError | 4XX, 5XX | \*/\* |
893
-
894
- ## listPaymentRefunds
895
-
896
- List all refunds
897
-
898
- ### Example Usage
899
-
900
- <!-- UsageSnippet language="typescript" operationID="listPaymentRefunds" method="get" path="/payment/{connection_id}/refund" -->
901
- ```typescript
902
- import { UnifiedTo } from "@unified-api/typescript-sdk";
903
-
904
- const unifiedTo = new UnifiedTo({
905
- security: {
906
- jwt: "<YOUR_API_KEY_HERE>",
907
- },
908
- });
909
-
910
- async function run() {
911
- const result = await unifiedTo.payment.listPaymentRefunds({
912
- connectionId: "<id>",
913
- });
914
-
915
- console.log(result);
916
- }
917
-
918
- run();
919
- ```
920
-
921
- ### Standalone function
922
-
923
- The standalone function version of this method:
924
-
925
- ```typescript
926
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
927
- import { paymentListPaymentRefunds } from "@unified-api/typescript-sdk/funcs/paymentListPaymentRefunds.js";
928
-
929
- // Use `UnifiedToCore` for best tree-shaking performance.
930
- // You can create one instance of it to use across an application.
931
- const unifiedTo = new UnifiedToCore({
932
- security: {
933
- jwt: "<YOUR_API_KEY_HERE>",
934
- },
935
- });
936
-
937
- async function run() {
938
- const res = await paymentListPaymentRefunds(unifiedTo, {
939
- connectionId: "<id>",
940
- });
941
- if (res.ok) {
942
- const { value: result } = res;
943
- console.log(result);
944
- } else {
945
- console.log("paymentListPaymentRefunds failed:", res.error);
946
- }
947
- }
948
-
949
- run();
950
- ```
951
-
952
- ### Parameters
953
-
954
- | Parameter | Type | Required | Description |
955
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
956
- | `request` | [operations.ListPaymentRefundsRequest](../../sdk/models/operations/listpaymentrefundsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
957
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
958
- | `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. |
959
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
960
-
961
- ### Response
962
-
963
- **Promise\<[shared.PaymentRefund[]](../../models/.md)\>**
964
-
965
- ### Errors
966
-
967
- | Error Type | Status Code | Content Type |
968
- | --------------- | --------------- | --------------- |
969
- | errors.SDKError | 4XX, 5XX | \*/\* |
970
-
971
- ## listPaymentSubscriptions
972
-
973
- List all subscriptions
974
-
975
- ### Example Usage
976
-
977
- <!-- UsageSnippet language="typescript" operationID="listPaymentSubscriptions" method="get" path="/payment/{connection_id}/subscription" -->
978
- ```typescript
979
- import { UnifiedTo } from "@unified-api/typescript-sdk";
980
-
981
- const unifiedTo = new UnifiedTo({
982
- security: {
983
- jwt: "<YOUR_API_KEY_HERE>",
984
- },
985
- });
986
-
987
- async function run() {
988
- const result = await unifiedTo.payment.listPaymentSubscriptions({
989
- connectionId: "<id>",
990
- });
991
-
992
- console.log(result);
993
- }
994
-
995
- run();
996
- ```
997
-
998
- ### Standalone function
999
-
1000
- The standalone function version of this method:
1001
-
1002
- ```typescript
1003
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1004
- import { paymentListPaymentSubscriptions } from "@unified-api/typescript-sdk/funcs/paymentListPaymentSubscriptions.js";
1005
-
1006
- // Use `UnifiedToCore` for best tree-shaking performance.
1007
- // You can create one instance of it to use across an application.
1008
- const unifiedTo = new UnifiedToCore({
1009
- security: {
1010
- jwt: "<YOUR_API_KEY_HERE>",
1011
- },
1012
- });
1013
-
1014
- async function run() {
1015
- const res = await paymentListPaymentSubscriptions(unifiedTo, {
1016
- connectionId: "<id>",
1017
- });
1018
- if (res.ok) {
1019
- const { value: result } = res;
1020
- console.log(result);
1021
- } else {
1022
- console.log("paymentListPaymentSubscriptions failed:", res.error);
1023
- }
1024
- }
1025
-
1026
- run();
1027
- ```
1028
-
1029
- ### Parameters
1030
-
1031
- | Parameter | Type | Required | Description |
1032
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1033
- | `request` | [operations.ListPaymentSubscriptionsRequest](../../sdk/models/operations/listpaymentsubscriptionsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1034
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1035
- | `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. |
1036
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1037
-
1038
- ### Response
1039
-
1040
- **Promise\<[shared.PaymentSubscription[]](../../models/.md)\>**
1041
-
1042
- ### Errors
1043
-
1044
- | Error Type | Status Code | Content Type |
1045
- | --------------- | --------------- | --------------- |
1046
- | errors.SDKError | 4XX, 5XX | \*/\* |
1047
-
1048
- ## patchPaymentLink
1049
-
1050
- Update a link
1051
-
1052
- ### Example Usage
1053
-
1054
- <!-- UsageSnippet language="typescript" operationID="patchPaymentLink" method="patch" path="/payment/{connection_id}/link/{id}" -->
1055
- ```typescript
1056
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1057
-
1058
- const unifiedTo = new UnifiedTo({
1059
- security: {
1060
- jwt: "<YOUR_API_KEY_HERE>",
1061
- },
1062
- });
1063
-
1064
- async function run() {
1065
- const result = await unifiedTo.payment.patchPaymentLink({
1066
- paymentLink: {},
1067
- connectionId: "<id>",
1068
- id: "<id>",
1069
- });
1070
-
1071
- console.log(result);
1072
- }
1073
-
1074
- run();
1075
- ```
1076
-
1077
- ### Standalone function
1078
-
1079
- The standalone function version of this method:
1080
-
1081
- ```typescript
1082
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1083
- import { linkPatchPaymentLink } from "@unified-api/typescript-sdk/funcs/linkPatchPaymentLink.js";
1084
-
1085
- // Use `UnifiedToCore` for best tree-shaking performance.
1086
- // You can create one instance of it to use across an application.
1087
- const unifiedTo = new UnifiedToCore({
1088
- security: {
1089
- jwt: "<YOUR_API_KEY_HERE>",
1090
- },
1091
- });
1092
-
1093
- async function run() {
1094
- const res = await linkPatchPaymentLink(unifiedTo, {
1095
- paymentLink: {},
1096
- connectionId: "<id>",
1097
- id: "<id>",
1098
- });
1099
- if (res.ok) {
1100
- const { value: result } = res;
1101
- console.log(result);
1102
- } else {
1103
- console.log("linkPatchPaymentLink failed:", res.error);
1104
- }
1105
- }
1106
-
1107
- run();
1108
- ```
1109
-
1110
- ### Parameters
1111
-
1112
- | Parameter | Type | Required | Description |
1113
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1114
- | `request` | [operations.PatchPaymentLinkRequest](../../sdk/models/operations/patchpaymentlinkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1115
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1116
- | `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. |
1117
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1118
-
1119
- ### Response
1120
-
1121
- **Promise\<[shared.PaymentLink](../../sdk/models/shared/paymentlink.md)\>**
1122
-
1123
- ### Errors
1124
-
1125
- | Error Type | Status Code | Content Type |
1126
- | --------------- | --------------- | --------------- |
1127
- | errors.SDKError | 4XX, 5XX | \*/\* |
1128
-
1129
- ## patchPaymentPayment
1130
-
1131
- Update a payment
1132
-
1133
- ### Example Usage
1134
-
1135
- <!-- UsageSnippet language="typescript" operationID="patchPaymentPayment" method="patch" path="/payment/{connection_id}/payment/{id}" -->
1136
- ```typescript
1137
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1138
-
1139
- const unifiedTo = new UnifiedTo({
1140
- security: {
1141
- jwt: "<YOUR_API_KEY_HERE>",
1142
- },
1143
- });
1144
-
1145
- async function run() {
1146
- const result = await unifiedTo.payment.patchPaymentPayment({
1147
- paymentPayment: {},
1148
- connectionId: "<id>",
1149
- id: "<id>",
1150
- });
1151
-
1152
- console.log(result);
1153
- }
1154
-
1155
- run();
1156
- ```
1157
-
1158
- ### Standalone function
1159
-
1160
- The standalone function version of this method:
1161
-
1162
- ```typescript
1163
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1164
- import { paymentPatchPaymentPayment } from "@unified-api/typescript-sdk/funcs/paymentPatchPaymentPayment.js";
1165
-
1166
- // Use `UnifiedToCore` for best tree-shaking performance.
1167
- // You can create one instance of it to use across an application.
1168
- const unifiedTo = new UnifiedToCore({
1169
- security: {
1170
- jwt: "<YOUR_API_KEY_HERE>",
1171
- },
1172
- });
1173
-
1174
- async function run() {
1175
- const res = await paymentPatchPaymentPayment(unifiedTo, {
1176
- paymentPayment: {},
1177
- connectionId: "<id>",
1178
- id: "<id>",
1179
- });
1180
- if (res.ok) {
1181
- const { value: result } = res;
1182
- console.log(result);
1183
- } else {
1184
- console.log("paymentPatchPaymentPayment failed:", res.error);
1185
- }
1186
- }
1187
-
1188
- run();
1189
- ```
1190
-
1191
- ### Parameters
1192
-
1193
- | Parameter | Type | Required | Description |
1194
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1195
- | `request` | [operations.PatchPaymentPaymentRequest](../../sdk/models/operations/patchpaymentpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1196
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1197
- | `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. |
1198
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1199
-
1200
- ### Response
1201
-
1202
- **Promise\<[shared.PaymentPayment](../../sdk/models/shared/paymentpayment.md)\>**
1203
-
1204
- ### Errors
1205
-
1206
- | Error Type | Status Code | Content Type |
1207
- | --------------- | --------------- | --------------- |
1208
- | errors.SDKError | 4XX, 5XX | \*/\* |
1209
-
1210
- ## patchPaymentSubscription
1211
-
1212
- Update a subscription
1213
-
1214
- ### Example Usage
1215
-
1216
- <!-- UsageSnippet language="typescript" operationID="patchPaymentSubscription" method="patch" path="/payment/{connection_id}/subscription/{id}" -->
1217
- ```typescript
1218
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1219
-
1220
- const unifiedTo = new UnifiedTo({
1221
- security: {
1222
- jwt: "<YOUR_API_KEY_HERE>",
1223
- },
1224
- });
1225
-
1226
- async function run() {
1227
- const result = await unifiedTo.payment.patchPaymentSubscription({
1228
- paymentSubscription: {},
1229
- connectionId: "<id>",
1230
- id: "<id>",
1231
- });
1232
-
1233
- console.log(result);
1234
- }
1235
-
1236
- run();
1237
- ```
1238
-
1239
- ### Standalone function
1240
-
1241
- The standalone function version of this method:
1242
-
1243
- ```typescript
1244
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1245
- import { paymentPatchPaymentSubscription } from "@unified-api/typescript-sdk/funcs/paymentPatchPaymentSubscription.js";
1246
-
1247
- // Use `UnifiedToCore` for best tree-shaking performance.
1248
- // You can create one instance of it to use across an application.
1249
- const unifiedTo = new UnifiedToCore({
1250
- security: {
1251
- jwt: "<YOUR_API_KEY_HERE>",
1252
- },
1253
- });
1254
-
1255
- async function run() {
1256
- const res = await paymentPatchPaymentSubscription(unifiedTo, {
1257
- paymentSubscription: {},
1258
- connectionId: "<id>",
1259
- id: "<id>",
1260
- });
1261
- if (res.ok) {
1262
- const { value: result } = res;
1263
- console.log(result);
1264
- } else {
1265
- console.log("paymentPatchPaymentSubscription failed:", res.error);
1266
- }
1267
- }
1268
-
1269
- run();
1270
- ```
1271
-
1272
- ### Parameters
1273
-
1274
- | Parameter | Type | Required | Description |
1275
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1276
- | `request` | [operations.PatchPaymentSubscriptionRequest](../../sdk/models/operations/patchpaymentsubscriptionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1277
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1278
- | `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. |
1279
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1280
-
1281
- ### Response
1282
-
1283
- **Promise\<[shared.PaymentSubscription](../../sdk/models/shared/paymentsubscription.md)\>**
1284
-
1285
- ### Errors
1286
-
1287
- | Error Type | Status Code | Content Type |
1288
- | --------------- | --------------- | --------------- |
1289
- | errors.SDKError | 4XX, 5XX | \*/\* |
1290
-
1291
- ## removePaymentLink
1292
-
1293
- Remove a link
1294
-
1295
- ### Example Usage
1296
-
1297
- <!-- UsageSnippet language="typescript" operationID="removePaymentLink" method="delete" path="/payment/{connection_id}/link/{id}" -->
1298
- ```typescript
1299
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1300
-
1301
- const unifiedTo = new UnifiedTo({
1302
- security: {
1303
- jwt: "<YOUR_API_KEY_HERE>",
1304
- },
1305
- });
1306
-
1307
- async function run() {
1308
- const result = await unifiedTo.payment.removePaymentLink({
1309
- connectionId: "<id>",
1310
- id: "<id>",
1311
- });
1312
-
1313
- console.log(result);
1314
- }
1315
-
1316
- run();
1317
- ```
1318
-
1319
- ### Standalone function
1320
-
1321
- The standalone function version of this method:
1322
-
1323
- ```typescript
1324
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1325
- import { linkRemovePaymentLink } from "@unified-api/typescript-sdk/funcs/linkRemovePaymentLink.js";
1326
-
1327
- // Use `UnifiedToCore` for best tree-shaking performance.
1328
- // You can create one instance of it to use across an application.
1329
- const unifiedTo = new UnifiedToCore({
1330
- security: {
1331
- jwt: "<YOUR_API_KEY_HERE>",
1332
- },
1333
- });
1334
-
1335
- async function run() {
1336
- const res = await linkRemovePaymentLink(unifiedTo, {
1337
- connectionId: "<id>",
1338
- id: "<id>",
1339
- });
1340
- if (res.ok) {
1341
- const { value: result } = res;
1342
- console.log(result);
1343
- } else {
1344
- console.log("linkRemovePaymentLink failed:", res.error);
1345
- }
1346
- }
1347
-
1348
- run();
1349
- ```
1350
-
1351
- ### Parameters
1352
-
1353
- | Parameter | Type | Required | Description |
1354
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1355
- | `request` | [operations.RemovePaymentLinkRequest](../../sdk/models/operations/removepaymentlinkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1356
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1357
- | `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. |
1358
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1359
-
1360
- ### Response
1361
-
1362
- **Promise\<[operations.RemovePaymentLinkResponse](../../sdk/models/operations/removepaymentlinkresponse.md)\>**
1363
-
1364
- ### Errors
1365
-
1366
- | Error Type | Status Code | Content Type |
1367
- | --------------- | --------------- | --------------- |
1368
- | errors.SDKError | 4XX, 5XX | \*/\* |
1369
-
1370
- ## removePaymentPayment
1371
-
1372
- Remove a payment
1373
-
1374
- ### Example Usage
1375
-
1376
- <!-- UsageSnippet language="typescript" operationID="removePaymentPayment" method="delete" path="/payment/{connection_id}/payment/{id}" -->
1377
- ```typescript
1378
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1379
-
1380
- const unifiedTo = new UnifiedTo({
1381
- security: {
1382
- jwt: "<YOUR_API_KEY_HERE>",
1383
- },
1384
- });
1385
-
1386
- async function run() {
1387
- const result = await unifiedTo.payment.removePaymentPayment({
1388
- connectionId: "<id>",
1389
- id: "<id>",
1390
- });
1391
-
1392
- console.log(result);
1393
- }
1394
-
1395
- run();
1396
- ```
1397
-
1398
- ### Standalone function
1399
-
1400
- The standalone function version of this method:
1401
-
1402
- ```typescript
1403
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1404
- import { paymentRemovePaymentPayment } from "@unified-api/typescript-sdk/funcs/paymentRemovePaymentPayment.js";
1405
-
1406
- // Use `UnifiedToCore` for best tree-shaking performance.
1407
- // You can create one instance of it to use across an application.
1408
- const unifiedTo = new UnifiedToCore({
1409
- security: {
1410
- jwt: "<YOUR_API_KEY_HERE>",
1411
- },
1412
- });
1413
-
1414
- async function run() {
1415
- const res = await paymentRemovePaymentPayment(unifiedTo, {
1416
- connectionId: "<id>",
1417
- id: "<id>",
1418
- });
1419
- if (res.ok) {
1420
- const { value: result } = res;
1421
- console.log(result);
1422
- } else {
1423
- console.log("paymentRemovePaymentPayment failed:", res.error);
1424
- }
1425
- }
1426
-
1427
- run();
1428
- ```
1429
-
1430
- ### Parameters
1431
-
1432
- | Parameter | Type | Required | Description |
1433
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1434
- | `request` | [operations.RemovePaymentPaymentRequest](../../sdk/models/operations/removepaymentpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1435
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1436
- | `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. |
1437
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1438
-
1439
- ### Response
1440
-
1441
- **Promise\<[operations.RemovePaymentPaymentResponse](../../sdk/models/operations/removepaymentpaymentresponse.md)\>**
1442
-
1443
- ### Errors
1444
-
1445
- | Error Type | Status Code | Content Type |
1446
- | --------------- | --------------- | --------------- |
1447
- | errors.SDKError | 4XX, 5XX | \*/\* |
1448
-
1449
- ## removePaymentSubscription
1450
-
1451
- Remove a subscription
1452
-
1453
- ### Example Usage
1454
-
1455
- <!-- UsageSnippet language="typescript" operationID="removePaymentSubscription" method="delete" path="/payment/{connection_id}/subscription/{id}" -->
1456
- ```typescript
1457
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1458
-
1459
- const unifiedTo = new UnifiedTo({
1460
- security: {
1461
- jwt: "<YOUR_API_KEY_HERE>",
1462
- },
1463
- });
1464
-
1465
- async function run() {
1466
- const result = await unifiedTo.payment.removePaymentSubscription({
1467
- connectionId: "<id>",
1468
- id: "<id>",
1469
- });
1470
-
1471
- console.log(result);
1472
- }
1473
-
1474
- run();
1475
- ```
1476
-
1477
- ### Standalone function
1478
-
1479
- The standalone function version of this method:
1480
-
1481
- ```typescript
1482
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1483
- import { paymentRemovePaymentSubscription } from "@unified-api/typescript-sdk/funcs/paymentRemovePaymentSubscription.js";
1484
-
1485
- // Use `UnifiedToCore` for best tree-shaking performance.
1486
- // You can create one instance of it to use across an application.
1487
- const unifiedTo = new UnifiedToCore({
1488
- security: {
1489
- jwt: "<YOUR_API_KEY_HERE>",
1490
- },
1491
- });
1492
-
1493
- async function run() {
1494
- const res = await paymentRemovePaymentSubscription(unifiedTo, {
1495
- connectionId: "<id>",
1496
- id: "<id>",
1497
- });
1498
- if (res.ok) {
1499
- const { value: result } = res;
1500
- console.log(result);
1501
- } else {
1502
- console.log("paymentRemovePaymentSubscription failed:", res.error);
1503
- }
1504
- }
1505
-
1506
- run();
1507
- ```
1508
-
1509
- ### Parameters
1510
-
1511
- | Parameter | Type | Required | Description |
1512
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1513
- | `request` | [operations.RemovePaymentSubscriptionRequest](../../sdk/models/operations/removepaymentsubscriptionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1514
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1515
- | `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. |
1516
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1517
-
1518
- ### Response
1519
-
1520
- **Promise\<[operations.RemovePaymentSubscriptionResponse](../../sdk/models/operations/removepaymentsubscriptionresponse.md)\>**
1521
-
1522
- ### Errors
1523
-
1524
- | Error Type | Status Code | Content Type |
1525
- | --------------- | --------------- | --------------- |
1526
- | errors.SDKError | 4XX, 5XX | \*/\* |
1527
-
1528
- ## updatePaymentLink
1529
-
1530
- Update a link
1531
-
1532
- ### Example Usage
1533
-
1534
- <!-- UsageSnippet language="typescript" operationID="updatePaymentLink" method="put" path="/payment/{connection_id}/link/{id}" -->
1535
- ```typescript
1536
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1537
-
1538
- const unifiedTo = new UnifiedTo({
1539
- security: {
1540
- jwt: "<YOUR_API_KEY_HERE>",
1541
- },
1542
- });
1543
-
1544
- async function run() {
1545
- const result = await unifiedTo.payment.updatePaymentLink({
1546
- paymentLink: {},
1547
- connectionId: "<id>",
1548
- id: "<id>",
1549
- });
1550
-
1551
- console.log(result);
1552
- }
1553
-
1554
- run();
1555
- ```
1556
-
1557
- ### Standalone function
1558
-
1559
- The standalone function version of this method:
1560
-
1561
- ```typescript
1562
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1563
- import { linkUpdatePaymentLink } from "@unified-api/typescript-sdk/funcs/linkUpdatePaymentLink.js";
1564
-
1565
- // Use `UnifiedToCore` for best tree-shaking performance.
1566
- // You can create one instance of it to use across an application.
1567
- const unifiedTo = new UnifiedToCore({
1568
- security: {
1569
- jwt: "<YOUR_API_KEY_HERE>",
1570
- },
1571
- });
1572
-
1573
- async function run() {
1574
- const res = await linkUpdatePaymentLink(unifiedTo, {
1575
- paymentLink: {},
1576
- connectionId: "<id>",
1577
- id: "<id>",
1578
- });
1579
- if (res.ok) {
1580
- const { value: result } = res;
1581
- console.log(result);
1582
- } else {
1583
- console.log("linkUpdatePaymentLink failed:", res.error);
1584
- }
1585
- }
1586
-
1587
- run();
1588
- ```
1589
-
1590
- ### Parameters
1591
-
1592
- | Parameter | Type | Required | Description |
1593
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1594
- | `request` | [operations.UpdatePaymentLinkRequest](../../sdk/models/operations/updatepaymentlinkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1595
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1596
- | `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. |
1597
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1598
-
1599
- ### Response
1600
-
1601
- **Promise\<[shared.PaymentLink](../../sdk/models/shared/paymentlink.md)\>**
1602
-
1603
- ### Errors
1604
-
1605
- | Error Type | Status Code | Content Type |
1606
- | --------------- | --------------- | --------------- |
1607
- | errors.SDKError | 4XX, 5XX | \*/\* |
1608
-
1609
- ## updatePaymentPayment
1610
-
1611
- Update a payment
1612
-
1613
- ### Example Usage
1614
-
1615
- <!-- UsageSnippet language="typescript" operationID="updatePaymentPayment" method="put" path="/payment/{connection_id}/payment/{id}" -->
1616
- ```typescript
1617
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1618
-
1619
- const unifiedTo = new UnifiedTo({
1620
- security: {
1621
- jwt: "<YOUR_API_KEY_HERE>",
1622
- },
1623
- });
1624
-
1625
- async function run() {
1626
- const result = await unifiedTo.payment.updatePaymentPayment({
1627
- paymentPayment: {},
1628
- connectionId: "<id>",
1629
- id: "<id>",
1630
- });
1631
-
1632
- console.log(result);
1633
- }
1634
-
1635
- run();
1636
- ```
1637
-
1638
- ### Standalone function
1639
-
1640
- The standalone function version of this method:
1641
-
1642
- ```typescript
1643
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1644
- import { paymentUpdatePaymentPayment } from "@unified-api/typescript-sdk/funcs/paymentUpdatePaymentPayment.js";
1645
-
1646
- // Use `UnifiedToCore` for best tree-shaking performance.
1647
- // You can create one instance of it to use across an application.
1648
- const unifiedTo = new UnifiedToCore({
1649
- security: {
1650
- jwt: "<YOUR_API_KEY_HERE>",
1651
- },
1652
- });
1653
-
1654
- async function run() {
1655
- const res = await paymentUpdatePaymentPayment(unifiedTo, {
1656
- paymentPayment: {},
1657
- connectionId: "<id>",
1658
- id: "<id>",
1659
- });
1660
- if (res.ok) {
1661
- const { value: result } = res;
1662
- console.log(result);
1663
- } else {
1664
- console.log("paymentUpdatePaymentPayment failed:", res.error);
1665
- }
1666
- }
1667
-
1668
- run();
1669
- ```
1670
-
1671
- ### Parameters
1672
-
1673
- | Parameter | Type | Required | Description |
1674
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1675
- | `request` | [operations.UpdatePaymentPaymentRequest](../../sdk/models/operations/updatepaymentpaymentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1676
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1677
- | `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. |
1678
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1679
-
1680
- ### Response
1681
-
1682
- **Promise\<[shared.PaymentPayment](../../sdk/models/shared/paymentpayment.md)\>**
1683
-
1684
- ### Errors
1685
-
1686
- | Error Type | Status Code | Content Type |
1687
- | --------------- | --------------- | --------------- |
1688
- | errors.SDKError | 4XX, 5XX | \*/\* |
1689
-
1690
- ## updatePaymentSubscription
1691
-
1692
- Update a subscription
1693
-
1694
- ### Example Usage
1695
-
1696
- <!-- UsageSnippet language="typescript" operationID="updatePaymentSubscription" method="put" path="/payment/{connection_id}/subscription/{id}" -->
1697
- ```typescript
1698
- import { UnifiedTo } from "@unified-api/typescript-sdk";
1699
-
1700
- const unifiedTo = new UnifiedTo({
1701
- security: {
1702
- jwt: "<YOUR_API_KEY_HERE>",
1703
- },
1704
- });
1705
-
1706
- async function run() {
1707
- const result = await unifiedTo.payment.updatePaymentSubscription({
1708
- paymentSubscription: {},
1709
- connectionId: "<id>",
1710
- id: "<id>",
1711
- });
1712
-
1713
- console.log(result);
1714
- }
1715
-
1716
- run();
1717
- ```
1718
-
1719
- ### Standalone function
1720
-
1721
- The standalone function version of this method:
1722
-
1723
- ```typescript
1724
- import { UnifiedToCore } from "@unified-api/typescript-sdk/core.js";
1725
- import { paymentUpdatePaymentSubscription } from "@unified-api/typescript-sdk/funcs/paymentUpdatePaymentSubscription.js";
1726
-
1727
- // Use `UnifiedToCore` for best tree-shaking performance.
1728
- // You can create one instance of it to use across an application.
1729
- const unifiedTo = new UnifiedToCore({
1730
- security: {
1731
- jwt: "<YOUR_API_KEY_HERE>",
1732
- },
1733
- });
1734
-
1735
- async function run() {
1736
- const res = await paymentUpdatePaymentSubscription(unifiedTo, {
1737
- paymentSubscription: {},
1738
- connectionId: "<id>",
1739
- id: "<id>",
1740
- });
1741
- if (res.ok) {
1742
- const { value: result } = res;
1743
- console.log(result);
1744
- } else {
1745
- console.log("paymentUpdatePaymentSubscription failed:", res.error);
1746
- }
1747
- }
1748
-
1749
- run();
1750
- ```
1751
-
1752
- ### Parameters
1753
-
1754
- | Parameter | Type | Required | Description |
1755
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1756
- | `request` | [operations.UpdatePaymentSubscriptionRequest](../../sdk/models/operations/updatepaymentsubscriptionrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1757
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1758
- | `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. |
1759
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1760
-
1761
- ### Response
1762
-
1763
- **Promise\<[shared.PaymentSubscription](../../sdk/models/shared/paymentsubscription.md)\>**
1764
-
1765
- ### Errors
1766
-
1767
- | Error Type | Status Code | Content Type |
1768
- | --------------- | --------------- | --------------- |
1769
- | errors.SDKError | 4XX, 5XX | \*/\* |