pkg-sdk-test 0.0.14 → 0.0.15

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 (75) hide show
  1. package/README.md +295 -0
  2. package/dist/cjs/BaseClient.js +3 -3
  3. package/dist/cjs/Client.d.ts +4 -4
  4. package/dist/cjs/Client.js +3 -3
  5. package/dist/cjs/api/errors/BadRequestError.d.ts +3 -3
  6. package/dist/cjs/api/errors/BadRequestError.js +1 -1
  7. package/dist/cjs/api/errors/InternalServerError.d.ts +3 -3
  8. package/dist/cjs/api/errors/InternalServerError.js +1 -1
  9. package/dist/cjs/api/errors/NotFoundError.d.ts +3 -3
  10. package/dist/cjs/api/errors/NotFoundError.js +1 -1
  11. package/dist/cjs/api/errors/UnauthorizedError.d.ts +3 -3
  12. package/dist/cjs/api/errors/UnauthorizedError.js +1 -1
  13. package/dist/cjs/api/resources/payments/client/Client.d.ts +23 -23
  14. package/dist/cjs/api/resources/payments/client/Client.js +37 -37
  15. package/dist/cjs/api/resources/payments/client/requests/CryptopayCreatePaymentRequest.d.ts +2 -2
  16. package/dist/cjs/api/resources/payments/client/requests/CryptopaySimulatePaymentRequest.d.ts +2 -2
  17. package/dist/cjs/api/resources/payments/client/requests/GetV1PaymentsRequest.d.ts +1 -1
  18. package/dist/cjs/api/resources/payments/types/GetV1PaymentsPaymentIdResponse.d.ts +2 -2
  19. package/dist/cjs/api/resources/staticWallets/client/Client.d.ts +23 -23
  20. package/dist/cjs/api/resources/staticWallets/client/Client.js +32 -32
  21. package/dist/cjs/api/types/CryptopayListPaymentsResponse.d.ts +2 -2
  22. package/dist/cjs/api/types/CryptopayListStaticDepositsResponse.d.ts +2 -2
  23. package/dist/cjs/api/types/CryptopayListStaticWalletsResponse.d.ts +2 -2
  24. package/dist/cjs/api/types/CryptopayPaymentResponse.d.ts +5 -5
  25. package/dist/cjs/api/types/CryptopayPublicPaymentResponse.d.ts +4 -4
  26. package/dist/cjs/auth/HeaderAuthProvider.js +1 -1
  27. package/dist/cjs/errors/{SuwardApiError.d.ts → SuwardSDKError.d.ts} +1 -1
  28. package/dist/cjs/errors/{SuwardApiError.js → SuwardSDKError.js} +4 -4
  29. package/dist/{esm/errors/SuwardApiTimeoutError.d.mts → cjs/errors/SuwardSDKTimeoutError.d.ts} +1 -1
  30. package/dist/cjs/errors/{SuwardApiTimeoutError.js → SuwardSDKTimeoutError.js} +4 -4
  31. package/dist/cjs/errors/handleNonStatusCodeError.js +5 -5
  32. package/dist/cjs/errors/index.d.ts +2 -2
  33. package/dist/cjs/errors/index.js +5 -5
  34. package/dist/cjs/index.d.ts +3 -3
  35. package/dist/cjs/index.js +5 -5
  36. package/dist/cjs/version.d.ts +1 -1
  37. package/dist/cjs/version.js +1 -1
  38. package/dist/esm/BaseClient.mjs +3 -3
  39. package/dist/esm/Client.d.mts +4 -4
  40. package/dist/esm/Client.mjs +1 -1
  41. package/dist/esm/api/errors/BadRequestError.d.mts +3 -3
  42. package/dist/esm/api/errors/BadRequestError.mjs +1 -1
  43. package/dist/esm/api/errors/InternalServerError.d.mts +3 -3
  44. package/dist/esm/api/errors/InternalServerError.mjs +1 -1
  45. package/dist/esm/api/errors/NotFoundError.d.mts +3 -3
  46. package/dist/esm/api/errors/NotFoundError.mjs +1 -1
  47. package/dist/esm/api/errors/UnauthorizedError.d.mts +3 -3
  48. package/dist/esm/api/errors/UnauthorizedError.mjs +1 -1
  49. package/dist/esm/api/resources/payments/client/Client.d.mts +23 -23
  50. package/dist/esm/api/resources/payments/client/Client.mjs +37 -37
  51. package/dist/esm/api/resources/payments/client/requests/CryptopayCreatePaymentRequest.d.mts +2 -2
  52. package/dist/esm/api/resources/payments/client/requests/CryptopaySimulatePaymentRequest.d.mts +2 -2
  53. package/dist/esm/api/resources/payments/client/requests/GetV1PaymentsRequest.d.mts +1 -1
  54. package/dist/esm/api/resources/payments/types/GetV1PaymentsPaymentIdResponse.d.mts +2 -2
  55. package/dist/esm/api/resources/staticWallets/client/Client.d.mts +23 -23
  56. package/dist/esm/api/resources/staticWallets/client/Client.mjs +32 -32
  57. package/dist/esm/api/types/CryptopayListPaymentsResponse.d.mts +2 -2
  58. package/dist/esm/api/types/CryptopayListStaticDepositsResponse.d.mts +2 -2
  59. package/dist/esm/api/types/CryptopayListStaticWalletsResponse.d.mts +2 -2
  60. package/dist/esm/api/types/CryptopayPaymentResponse.d.mts +5 -5
  61. package/dist/esm/api/types/CryptopayPublicPaymentResponse.d.mts +4 -4
  62. package/dist/esm/auth/HeaderAuthProvider.mjs +1 -1
  63. package/dist/esm/errors/{SuwardApiError.d.mts → SuwardSDKError.d.mts} +1 -1
  64. package/dist/esm/errors/{SuwardApiError.mjs → SuwardSDKError.mjs} +2 -2
  65. package/dist/{cjs/errors/SuwardApiTimeoutError.d.ts → esm/errors/SuwardSDKTimeoutError.d.mts} +1 -1
  66. package/dist/esm/errors/{SuwardApiTimeoutError.mjs → SuwardSDKTimeoutError.mjs} +2 -2
  67. package/dist/esm/errors/handleNonStatusCodeError.mjs +5 -5
  68. package/dist/esm/errors/index.d.mts +2 -2
  69. package/dist/esm/errors/index.mjs +2 -2
  70. package/dist/esm/index.d.mts +3 -3
  71. package/dist/esm/index.mjs +3 -3
  72. package/dist/esm/version.d.mts +1 -1
  73. package/dist/esm/version.mjs +1 -1
  74. package/package.json +86 -82
  75. package/reference.md +698 -0
package/reference.md ADDED
@@ -0,0 +1,698 @@
1
+ # Reference
2
+ ## Payments
3
+ <details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">listPayments</a>({ ...params }) -> SuwardSDK.CryptopayListPaymentsResponse</code></summary>
4
+ <dl>
5
+ <dd>
6
+
7
+ #### 📝 Description
8
+
9
+ <dl>
10
+ <dd>
11
+
12
+ <dl>
13
+ <dd>
14
+
15
+ List payments for a project
16
+ </dd>
17
+ </dl>
18
+ </dd>
19
+ </dl>
20
+
21
+ #### 🔌 Usage
22
+
23
+ <dl>
24
+ <dd>
25
+
26
+ <dl>
27
+ <dd>
28
+
29
+ ```typescript
30
+ await client.payments.listPayments();
31
+
32
+ ```
33
+ </dd>
34
+ </dl>
35
+ </dd>
36
+ </dl>
37
+
38
+ #### ⚙️ Parameters
39
+
40
+ <dl>
41
+ <dd>
42
+
43
+ <dl>
44
+ <dd>
45
+
46
+ **request:** `SuwardSDK.GetV1PaymentsRequest`
47
+
48
+ </dd>
49
+ </dl>
50
+
51
+ <dl>
52
+ <dd>
53
+
54
+ **requestOptions:** `PaymentsClient.RequestOptions`
55
+
56
+ </dd>
57
+ </dl>
58
+ </dd>
59
+ </dl>
60
+
61
+
62
+ </dd>
63
+ </dl>
64
+ </details>
65
+
66
+ <details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">createPayment</a>({ ...params }) -> SuwardSDK.CryptopayPaymentResponse</code></summary>
67
+ <dl>
68
+ <dd>
69
+
70
+ #### 📝 Description
71
+
72
+ <dl>
73
+ <dd>
74
+
75
+ <dl>
76
+ <dd>
77
+
78
+ Create a new payment
79
+ </dd>
80
+ </dl>
81
+ </dd>
82
+ </dl>
83
+
84
+ #### 🔌 Usage
85
+
86
+ <dl>
87
+ <dd>
88
+
89
+ <dl>
90
+ <dd>
91
+
92
+ ```typescript
93
+ await client.payments.createPayment();
94
+
95
+ ```
96
+ </dd>
97
+ </dl>
98
+ </dd>
99
+ </dl>
100
+
101
+ #### ⚙️ Parameters
102
+
103
+ <dl>
104
+ <dd>
105
+
106
+ <dl>
107
+ <dd>
108
+
109
+ **request:** `SuwardSDK.CryptopayCreatePaymentRequest`
110
+
111
+ </dd>
112
+ </dl>
113
+
114
+ <dl>
115
+ <dd>
116
+
117
+ **requestOptions:** `PaymentsClient.RequestOptions`
118
+
119
+ </dd>
120
+ </dl>
121
+ </dd>
122
+ </dl>
123
+
124
+
125
+ </dd>
126
+ </dl>
127
+ </details>
128
+
129
+ <details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">getPayment</a>({ ...params }) -> SuwardSDK.GetV1PaymentsPaymentIdResponse</code></summary>
130
+ <dl>
131
+ <dd>
132
+
133
+ #### 📝 Description
134
+
135
+ <dl>
136
+ <dd>
137
+
138
+ <dl>
139
+ <dd>
140
+
141
+ Returns full payment details when called with an API key (merchant view).
142
+ Returns limited payment details when called without an API key (customer view).
143
+ </dd>
144
+ </dl>
145
+ </dd>
146
+ </dl>
147
+
148
+ #### 🔌 Usage
149
+
150
+ <dl>
151
+ <dd>
152
+
153
+ <dl>
154
+ <dd>
155
+
156
+ ```typescript
157
+ await client.payments.getPayment({
158
+ paymentId: "paymentId"
159
+ });
160
+
161
+ ```
162
+ </dd>
163
+ </dl>
164
+ </dd>
165
+ </dl>
166
+
167
+ #### ⚙️ Parameters
168
+
169
+ <dl>
170
+ <dd>
171
+
172
+ <dl>
173
+ <dd>
174
+
175
+ **request:** `SuwardSDK.GetV1PaymentsPaymentIdRequest`
176
+
177
+ </dd>
178
+ </dl>
179
+
180
+ <dl>
181
+ <dd>
182
+
183
+ **requestOptions:** `PaymentsClient.RequestOptions`
184
+
185
+ </dd>
186
+ </dl>
187
+ </dd>
188
+ </dl>
189
+
190
+
191
+ </dd>
192
+ </dl>
193
+ </details>
194
+
195
+ <details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">cancelPayment</a>({ ...params }) -> SuwardSDK.CryptopayPaymentResponse</code></summary>
196
+ <dl>
197
+ <dd>
198
+
199
+ #### 📝 Description
200
+
201
+ <dl>
202
+ <dd>
203
+
204
+ <dl>
205
+ <dd>
206
+
207
+ Cancel a payment
208
+ </dd>
209
+ </dl>
210
+ </dd>
211
+ </dl>
212
+
213
+ #### 🔌 Usage
214
+
215
+ <dl>
216
+ <dd>
217
+
218
+ <dl>
219
+ <dd>
220
+
221
+ ```typescript
222
+ await client.payments.cancelPayment({
223
+ paymentId: "paymentId"
224
+ });
225
+
226
+ ```
227
+ </dd>
228
+ </dl>
229
+ </dd>
230
+ </dl>
231
+
232
+ #### ⚙️ Parameters
233
+
234
+ <dl>
235
+ <dd>
236
+
237
+ <dl>
238
+ <dd>
239
+
240
+ **request:** `SuwardSDK.PostV1PaymentsPaymentIdCancelRequest`
241
+
242
+ </dd>
243
+ </dl>
244
+
245
+ <dl>
246
+ <dd>
247
+
248
+ **requestOptions:** `PaymentsClient.RequestOptions`
249
+
250
+ </dd>
251
+ </dl>
252
+ </dd>
253
+ </dl>
254
+
255
+
256
+ </dd>
257
+ </dl>
258
+ </details>
259
+
260
+ <details><summary><code>client.payments.<a href="/src/api/resources/payments/client/Client.ts">simulatePayment</a>({ ...params }) -> SuwardSDK.CryptopayPaymentResponse</code></summary>
261
+ <dl>
262
+ <dd>
263
+
264
+ #### 📝 Description
265
+
266
+ <dl>
267
+ <dd>
268
+
269
+ <dl>
270
+ <dd>
271
+
272
+ Simulate payment status change (test mode only)
273
+ </dd>
274
+ </dl>
275
+ </dd>
276
+ </dl>
277
+
278
+ #### 🔌 Usage
279
+
280
+ <dl>
281
+ <dd>
282
+
283
+ <dl>
284
+ <dd>
285
+
286
+ ```typescript
287
+ await client.payments.simulatePayment({
288
+ paymentId: "paymentId"
289
+ });
290
+
291
+ ```
292
+ </dd>
293
+ </dl>
294
+ </dd>
295
+ </dl>
296
+
297
+ #### ⚙️ Parameters
298
+
299
+ <dl>
300
+ <dd>
301
+
302
+ <dl>
303
+ <dd>
304
+
305
+ **request:** `SuwardSDK.CryptopaySimulatePaymentRequest`
306
+
307
+ </dd>
308
+ </dl>
309
+
310
+ <dl>
311
+ <dd>
312
+
313
+ **requestOptions:** `PaymentsClient.RequestOptions`
314
+
315
+ </dd>
316
+ </dl>
317
+ </dd>
318
+ </dl>
319
+
320
+
321
+ </dd>
322
+ </dl>
323
+ </details>
324
+
325
+ ## StaticWallets
326
+ <details><summary><code>client.staticWallets.<a href="/src/api/resources/staticWallets/client/Client.ts">listStaticWallets</a>() -> SuwardSDK.CryptopayListStaticWalletsResponse</code></summary>
327
+ <dl>
328
+ <dd>
329
+
330
+ #### 🔌 Usage
331
+
332
+ <dl>
333
+ <dd>
334
+
335
+ <dl>
336
+ <dd>
337
+
338
+ ```typescript
339
+ await client.staticWallets.listStaticWallets();
340
+
341
+ ```
342
+ </dd>
343
+ </dl>
344
+ </dd>
345
+ </dl>
346
+
347
+ #### ⚙️ Parameters
348
+
349
+ <dl>
350
+ <dd>
351
+
352
+ <dl>
353
+ <dd>
354
+
355
+ **requestOptions:** `StaticWalletsClient.RequestOptions`
356
+
357
+ </dd>
358
+ </dl>
359
+ </dd>
360
+ </dl>
361
+
362
+
363
+ </dd>
364
+ </dl>
365
+ </details>
366
+
367
+ <details><summary><code>client.staticWallets.<a href="/src/api/resources/staticWallets/client/Client.ts">createStaticWallet</a>({ ...params }) -> SuwardSDK.CryptopayStaticWalletResponse</code></summary>
368
+ <dl>
369
+ <dd>
370
+
371
+ #### 📝 Description
372
+
373
+ <dl>
374
+ <dd>
375
+
376
+ <dl>
377
+ <dd>
378
+
379
+ Create a reusable deposit address with an accepted-asset allow-list
380
+ </dd>
381
+ </dl>
382
+ </dd>
383
+ </dl>
384
+
385
+ #### 🔌 Usage
386
+
387
+ <dl>
388
+ <dd>
389
+
390
+ <dl>
391
+ <dd>
392
+
393
+ ```typescript
394
+ await client.staticWallets.createStaticWallet();
395
+
396
+ ```
397
+ </dd>
398
+ </dl>
399
+ </dd>
400
+ </dl>
401
+
402
+ #### ⚙️ Parameters
403
+
404
+ <dl>
405
+ <dd>
406
+
407
+ <dl>
408
+ <dd>
409
+
410
+ **request:** `SuwardSDK.CryptopayCreateStaticWalletRequest`
411
+
412
+ </dd>
413
+ </dl>
414
+
415
+ <dl>
416
+ <dd>
417
+
418
+ **requestOptions:** `StaticWalletsClient.RequestOptions`
419
+
420
+ </dd>
421
+ </dl>
422
+ </dd>
423
+ </dl>
424
+
425
+
426
+ </dd>
427
+ </dl>
428
+ </details>
429
+
430
+ <details><summary><code>client.staticWallets.<a href="/src/api/resources/staticWallets/client/Client.ts">getStaticWallet</a>({ ...params }) -> SuwardSDK.CryptopayStaticWalletResponse</code></summary>
431
+ <dl>
432
+ <dd>
433
+
434
+ #### 🔌 Usage
435
+
436
+ <dl>
437
+ <dd>
438
+
439
+ <dl>
440
+ <dd>
441
+
442
+ ```typescript
443
+ await client.staticWallets.getStaticWallet({
444
+ staticWalletId: "staticWalletId"
445
+ });
446
+
447
+ ```
448
+ </dd>
449
+ </dl>
450
+ </dd>
451
+ </dl>
452
+
453
+ #### ⚙️ Parameters
454
+
455
+ <dl>
456
+ <dd>
457
+
458
+ <dl>
459
+ <dd>
460
+
461
+ **request:** `SuwardSDK.GetV1StaticWalletsStaticWalletIdRequest`
462
+
463
+ </dd>
464
+ </dl>
465
+
466
+ <dl>
467
+ <dd>
468
+
469
+ **requestOptions:** `StaticWalletsClient.RequestOptions`
470
+
471
+ </dd>
472
+ </dl>
473
+ </dd>
474
+ </dl>
475
+
476
+
477
+ </dd>
478
+ </dl>
479
+ </details>
480
+
481
+ <details><summary><code>client.staticWallets.<a href="/src/api/resources/staticWallets/client/Client.ts">deleteStaticWallet</a>({ ...params }) -> Record&lt;string, boolean&gt;</code></summary>
482
+ <dl>
483
+ <dd>
484
+
485
+ #### 🔌 Usage
486
+
487
+ <dl>
488
+ <dd>
489
+
490
+ <dl>
491
+ <dd>
492
+
493
+ ```typescript
494
+ await client.staticWallets.deleteStaticWallet({
495
+ staticWalletId: "staticWalletId"
496
+ });
497
+
498
+ ```
499
+ </dd>
500
+ </dl>
501
+ </dd>
502
+ </dl>
503
+
504
+ #### ⚙️ Parameters
505
+
506
+ <dl>
507
+ <dd>
508
+
509
+ <dl>
510
+ <dd>
511
+
512
+ **request:** `SuwardSDK.DeleteV1StaticWalletsStaticWalletIdRequest`
513
+
514
+ </dd>
515
+ </dl>
516
+
517
+ <dl>
518
+ <dd>
519
+
520
+ **requestOptions:** `StaticWalletsClient.RequestOptions`
521
+
522
+ </dd>
523
+ </dl>
524
+ </dd>
525
+ </dl>
526
+
527
+
528
+ </dd>
529
+ </dl>
530
+ </details>
531
+
532
+ <details><summary><code>client.staticWallets.<a href="/src/api/resources/staticWallets/client/Client.ts">updateStaticWallet</a>({ ...params }) -> SuwardSDK.CryptopayStaticWalletResponse</code></summary>
533
+ <dl>
534
+ <dd>
535
+
536
+ #### 🔌 Usage
537
+
538
+ <dl>
539
+ <dd>
540
+
541
+ <dl>
542
+ <dd>
543
+
544
+ ```typescript
545
+ await client.staticWallets.updateStaticWallet({
546
+ staticWalletId: "staticWalletId"
547
+ });
548
+
549
+ ```
550
+ </dd>
551
+ </dl>
552
+ </dd>
553
+ </dl>
554
+
555
+ #### ⚙️ Parameters
556
+
557
+ <dl>
558
+ <dd>
559
+
560
+ <dl>
561
+ <dd>
562
+
563
+ **request:** `SuwardSDK.CryptopayUpdateStaticWalletRequest`
564
+
565
+ </dd>
566
+ </dl>
567
+
568
+ <dl>
569
+ <dd>
570
+
571
+ **requestOptions:** `StaticWalletsClient.RequestOptions`
572
+
573
+ </dd>
574
+ </dl>
575
+ </dd>
576
+ </dl>
577
+
578
+
579
+ </dd>
580
+ </dl>
581
+ </details>
582
+
583
+ <details><summary><code>client.staticWallets.<a href="/src/api/resources/staticWallets/client/Client.ts">listStaticWalletDeposits</a>({ ...params }) -> SuwardSDK.CryptopayListStaticDepositsResponse</code></summary>
584
+ <dl>
585
+ <dd>
586
+
587
+ #### 🔌 Usage
588
+
589
+ <dl>
590
+ <dd>
591
+
592
+ <dl>
593
+ <dd>
594
+
595
+ ```typescript
596
+ await client.staticWallets.listStaticWalletDeposits({
597
+ staticWalletId: "staticWalletId"
598
+ });
599
+
600
+ ```
601
+ </dd>
602
+ </dl>
603
+ </dd>
604
+ </dl>
605
+
606
+ #### ⚙️ Parameters
607
+
608
+ <dl>
609
+ <dd>
610
+
611
+ <dl>
612
+ <dd>
613
+
614
+ **request:** `SuwardSDK.GetV1StaticWalletsStaticWalletIdDepositsRequest`
615
+
616
+ </dd>
617
+ </dl>
618
+
619
+ <dl>
620
+ <dd>
621
+
622
+ **requestOptions:** `StaticWalletsClient.RequestOptions`
623
+
624
+ </dd>
625
+ </dl>
626
+ </dd>
627
+ </dl>
628
+
629
+
630
+ </dd>
631
+ </dl>
632
+ </details>
633
+
634
+ <details><summary><code>client.staticWallets.<a href="/src/api/resources/staticWallets/client/Client.ts">simulateStaticWalletDeposit</a>({ ...params }) -> SuwardSDK.CryptopayStaticDepositResponse</code></summary>
635
+ <dl>
636
+ <dd>
637
+
638
+ #### 📝 Description
639
+
640
+ <dl>
641
+ <dd>
642
+
643
+ <dl>
644
+ <dd>
645
+
646
+ Drive a synthetic deposit through its lifecycle on a test wallet (no on-chain activity, no balance credit). Test wallets only.
647
+ </dd>
648
+ </dl>
649
+ </dd>
650
+ </dl>
651
+
652
+ #### 🔌 Usage
653
+
654
+ <dl>
655
+ <dd>
656
+
657
+ <dl>
658
+ <dd>
659
+
660
+ ```typescript
661
+ await client.staticWallets.simulateStaticWalletDeposit({
662
+ staticWalletId: "staticWalletId"
663
+ });
664
+
665
+ ```
666
+ </dd>
667
+ </dl>
668
+ </dd>
669
+ </dl>
670
+
671
+ #### ⚙️ Parameters
672
+
673
+ <dl>
674
+ <dd>
675
+
676
+ <dl>
677
+ <dd>
678
+
679
+ **request:** `SuwardSDK.CryptopaySimulateStaticDepositRequest`
680
+
681
+ </dd>
682
+ </dl>
683
+
684
+ <dl>
685
+ <dd>
686
+
687
+ **requestOptions:** `StaticWalletsClient.RequestOptions`
688
+
689
+ </dd>
690
+ </dl>
691
+ </dd>
692
+ </dl>
693
+
694
+
695
+ </dd>
696
+ </dl>
697
+ </details>
698
+