@rebilly/api 0.0.0 → 0.1.0

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.
@@ -0,0 +1,1907 @@
1
+ import { ApiError, TimeoutError } from "./runtime/errors.js";
2
+ import { defaultRetryOn } from "./runtime/retry.js";
3
+ import { createClient } from "./runtime/factory.js";
4
+ //#region src/storefront-client.ts
5
+ /**
6
+ * Storefront APIs (vlatest)
7
+ * # Introduction
8
+ * [comment]: <> (x-product-description-placeholder)
9
+ * The Rebilly API is built on HTTP and is RESTful.
10
+ * It has predictable resource URLs and returns HTTP response codes to indicate errors.
11
+ * It also accepts and returns JSON in the HTTP body.
12
+ * Use your favorite HTTP/REST library in your programming language when using this API,
13
+ * or use one of the Rebilly SDKs,
14
+ * which are available in [PHP](https://github.com/Rebilly/rebilly-php) and [JavaScript](https://www.npmjs.com/package/rebilly-js-sdk).
15
+ *
16
+ * Every action in the [Rebilly UI](https://app.rebilly.com) is supported by an API which is documented and available for use, so that you may automate any necessary workflows or processes.
17
+ * This API reference documentation contains the most commonly integrated resources.
18
+ *
19
+ * # Authentication
20
+ *
21
+ * Rebilly offers four forms of authentication: secret key, publishable key, JSON Web Tokens, and public signature key.
22
+ *
23
+ * - Secret API key: Use to make requests from the server side.
24
+ * Never share these keys.
25
+ * Keep them guarded and secure.
26
+ * - Publishable API key: Use in your client-side code to tokenize payment information.
27
+ * - JWT: Use to make short-life tokens that expire after a set period of time.
28
+ *
29
+ * ## Manage API keys
30
+ *
31
+ * To create or manage API keys, select one of the following:
32
+ *
33
+ * - Use the Rebilly UI: see [Manage API keys](https://www.rebilly.com/docs/dev-docs/api-keys/#manage-api-keys)
34
+ * - Use the Rebilly API: see the [API key operations](https://www.rebilly.com/catalog/all/api-keys).
35
+ *
36
+ * For more information on API keys, see [API keys](https://www.rebilly.com/docs/concepts-and-features/concept/api-keys).
37
+ *
38
+ * # Errors
39
+ * Rebilly follows the error response format proposed in [RFC 9457](https://tools.ietf.org/html/rfc9457), which is also known as Problem Details for HTTP APIs.
40
+ * As with any API responses, your client must be prepared to gracefully handle additional members of the response.
41
+ *
42
+ * # SDKs
43
+ *
44
+ * Rebilly provides a JavaScript SDK and a PHP SDK to help interact with the Rebilly API.
45
+ * However, no SDK is required to use the API.
46
+ *
47
+ * Rebilly also provides [FramePay](https://www.rebilly.com/docs/developer-docs/framepay/),
48
+ * a client-side iFrame-based solution, to help create payment tokens while minimizing PCI DSS compliance burdens
49
+ * and maximizing your customization ability.
50
+ * [FramePay](https://www.rebilly.com/docs/developer-docs/framepay/) interacts with the [payment tokens creation operation](https://www.rebilly.com/catalog/all/payment-tokens/posttoken).
51
+ *
52
+ * ## JavaScript SDK
53
+ *
54
+ * For installation and usage instructions, see [SDKs](https://www.rebilly.com/docs/dev-docs/sdks/).
55
+ * All JavaScript SDK code examples are included in the API reference documentation.
56
+ *
57
+ * ## PHP SDK
58
+ *
59
+ * For installation and usage instructions, see [SDKs](https://www.rebilly.com/docs/dev-docs/sdks/).
60
+ * All SDK code examples are included in the API reference documentation.
61
+ * To use them, you must configure the `$client` as follows:
62
+ *
63
+ * ```php
64
+ * $client = new Rebilly\Client([
65
+ * 'apiKey' => 'YourApiKeyHere',
66
+ * 'baseUrl' => 'https://api.rebilly.com',
67
+ * ]);
68
+ * ```
69
+ *
70
+ * # Get started
71
+ *
72
+ * The full [Rebilly API](https://www.rebilly.com/catalog/all/) has over 500 operations.
73
+ * This is likely more than you may need to implement your use cases.
74
+ * If you would like to implement a particular use case,
75
+ * [contact Rebilly](https://www.rebilly.com/support/) for guidance and feedback on the best API operations to use for the task.
76
+ *
77
+ * To integrate Rebilly, and learn about related resources and concepts,
78
+ * see [Get started](https://www.rebilly.com/docs/dev-docs#get-started).
79
+ *
80
+ * To create and manage API keys, see [API keys](https://www.rebilly.com/docs/dev-docs/api-keys/).
81
+ *
82
+ * # Rate limits
83
+ *
84
+ * Rate limits apply to the organization, not to the API key.
85
+ *
86
+ * API responses for rate-limited operations include `Rate-Limit-Limit` and `Rate-Limit-Remaining`.
87
+ * `Rate-Limit-Limit` is the maximum number of requests available at one time.
88
+ * `Rate-Limit-Remaining` is the number of requests still available.
89
+ *
90
+ * A request over the limit returns `429 Too Many Requests`.
91
+ * The response includes `Retry-After` and `Rate-Limit-Retry-After`.
92
+ * Both values are the number of seconds to wait before retrying.
93
+ *
94
+ */
95
+ /**
96
+ * The wire-shape descriptor for every operation, keyed by operationId — the data the
97
+ * runtime routes requests by. Also minification-safe static metadata (method, path,
98
+ * tags) for cache keys, tracing span names, and request logging.
99
+ */
100
+ var OPERATIONS = {
101
+ StorefrontGetAccount: {
102
+ id: "StorefrontGetAccount",
103
+ method: "GET",
104
+ path: "/storefront/account",
105
+ tags: ["Storefront account"],
106
+ params: [{
107
+ name: "expand",
108
+ in: "query"
109
+ }],
110
+ security: [[{
111
+ scheme: "CustomerJWT",
112
+ kind: "bearer"
113
+ }]]
114
+ },
115
+ StorefrontPatchAccount: {
116
+ id: "StorefrontPatchAccount",
117
+ method: "PATCH",
118
+ path: "/storefront/account",
119
+ tags: ["Storefront account"],
120
+ body: { contentType: "application/json" },
121
+ security: [[{
122
+ scheme: "CustomerJWT",
123
+ kind: "bearer"
124
+ }]],
125
+ responseHeaders: [{
126
+ name: "rate-limit-limit",
127
+ key: "rateLimitLimit",
128
+ type: "number"
129
+ }, {
130
+ name: "rate-limit-remaining",
131
+ key: "rateLimitRemaining",
132
+ type: "number"
133
+ }]
134
+ },
135
+ StorefrontPostForgotPassword: {
136
+ id: "StorefrontPostForgotPassword",
137
+ method: "POST",
138
+ path: "/storefront/account/forgot-password",
139
+ tags: ["Storefront account"],
140
+ body: { contentType: "application/json" },
141
+ responseKind: "void",
142
+ security: [[{
143
+ scheme: "PublishableApiKey",
144
+ kind: "apiKey",
145
+ name: "Authorization",
146
+ in: "header"
147
+ }]],
148
+ responseHeaders: [{
149
+ name: "rate-limit-limit",
150
+ key: "rateLimitLimit",
151
+ type: "number"
152
+ }, {
153
+ name: "rate-limit-remaining",
154
+ key: "rateLimitRemaining",
155
+ type: "number"
156
+ }]
157
+ },
158
+ StorefrontPatchAccountPassword: {
159
+ id: "StorefrontPatchAccountPassword",
160
+ method: "PATCH",
161
+ path: "/storefront/account/password",
162
+ tags: ["Storefront account"],
163
+ body: { contentType: "application/json" },
164
+ security: [[{
165
+ scheme: "CustomerJWT",
166
+ kind: "bearer"
167
+ }]],
168
+ responseHeaders: [{
169
+ name: "rate-limit-limit",
170
+ key: "rateLimitLimit",
171
+ type: "number"
172
+ }, {
173
+ name: "rate-limit-remaining",
174
+ key: "rateLimitRemaining",
175
+ type: "number"
176
+ }]
177
+ },
178
+ StorefrontPostAccountResendVerification: {
179
+ id: "StorefrontPostAccountResendVerification",
180
+ method: "POST",
181
+ path: "/storefront/account/resend-verification",
182
+ tags: ["Storefront account"],
183
+ body: { contentType: "application/json" },
184
+ responseKind: "void",
185
+ security: [[{
186
+ scheme: "PublishableApiKey",
187
+ kind: "apiKey",
188
+ name: "Authorization",
189
+ in: "header"
190
+ }]],
191
+ responseHeaders: [{
192
+ name: "rate-limit-limit",
193
+ key: "rateLimitLimit",
194
+ type: "number"
195
+ }, {
196
+ name: "rate-limit-remaining",
197
+ key: "rateLimitRemaining",
198
+ type: "number"
199
+ }]
200
+ },
201
+ StorefrontPostResetPassword: {
202
+ id: "StorefrontPostResetPassword",
203
+ method: "POST",
204
+ path: "/storefront/account/reset-password/{token}",
205
+ tags: ["Storefront account"],
206
+ params: [{
207
+ name: "token",
208
+ in: "path"
209
+ }],
210
+ body: { contentType: "application/json" },
211
+ security: [[{
212
+ scheme: "PublishableApiKey",
213
+ kind: "apiKey",
214
+ name: "Authorization",
215
+ in: "header"
216
+ }]],
217
+ responseHeaders: [
218
+ {
219
+ name: "location",
220
+ key: "location",
221
+ type: "string"
222
+ },
223
+ {
224
+ name: "rate-limit-limit",
225
+ key: "rateLimitLimit",
226
+ type: "number"
227
+ },
228
+ {
229
+ name: "rate-limit-remaining",
230
+ key: "rateLimitRemaining",
231
+ type: "number"
232
+ }
233
+ ]
234
+ },
235
+ StorefrontPostAccountVerification: {
236
+ id: "StorefrontPostAccountVerification",
237
+ method: "POST",
238
+ path: "/storefront/account/verification/{token}",
239
+ tags: ["Storefront account"],
240
+ params: [{
241
+ name: "token",
242
+ in: "path"
243
+ }],
244
+ responseKind: "void",
245
+ security: [[{
246
+ scheme: "PublishableApiKey",
247
+ kind: "apiKey",
248
+ name: "Authorization",
249
+ in: "header"
250
+ }]],
251
+ responseHeaders: [{
252
+ name: "rate-limit-limit",
253
+ key: "rateLimitLimit",
254
+ type: "number"
255
+ }, {
256
+ name: "rate-limit-remaining",
257
+ key: "rateLimitRemaining",
258
+ type: "number"
259
+ }]
260
+ },
261
+ StorefrontGetBillingPortal: {
262
+ id: "StorefrontGetBillingPortal",
263
+ method: "GET",
264
+ path: "/storefront/billing-portals/{slug}",
265
+ tags: ["Storefront billing portals"],
266
+ params: [{
267
+ name: "slug",
268
+ in: "path"
269
+ }]
270
+ },
271
+ StorefrontGetDepositStrategy: {
272
+ id: "StorefrontGetDepositStrategy",
273
+ method: "GET",
274
+ path: "/storefront/deposit-strategies/{id}",
275
+ tags: ["Storefront deposits"],
276
+ params: [{
277
+ name: "id",
278
+ in: "path"
279
+ }],
280
+ security: [[{
281
+ scheme: "CustomerJWT",
282
+ kind: "bearer"
283
+ }]]
284
+ },
285
+ StorefrontGetDepositRequest: {
286
+ id: "StorefrontGetDepositRequest",
287
+ method: "GET",
288
+ path: "/storefront/deposit-requests/{id}",
289
+ tags: ["Storefront deposits"],
290
+ params: [{
291
+ name: "id",
292
+ in: "path"
293
+ }, {
294
+ name: "expand",
295
+ in: "query"
296
+ }],
297
+ security: [[{
298
+ scheme: "CustomerJWT",
299
+ kind: "bearer"
300
+ }]]
301
+ },
302
+ StorefrontGetCashier: {
303
+ id: "StorefrontGetCashier",
304
+ method: "GET",
305
+ path: "/storefront/cashiers/{id}",
306
+ tags: ["Storefront cashiers"],
307
+ params: [{
308
+ name: "id",
309
+ in: "path"
310
+ }],
311
+ security: [[{
312
+ scheme: "CustomerJWT",
313
+ kind: "bearer"
314
+ }]]
315
+ },
316
+ StorefrontPostDeposit: {
317
+ id: "StorefrontPostDeposit",
318
+ method: "POST",
319
+ path: "/storefront/deposit",
320
+ tags: ["Storefront deposits"],
321
+ body: { contentType: "application/json" },
322
+ security: [[{
323
+ scheme: "CustomerJWT",
324
+ kind: "bearer"
325
+ }]],
326
+ responseHeaders: [
327
+ {
328
+ name: "location",
329
+ key: "location",
330
+ type: "string"
331
+ },
332
+ {
333
+ name: "rate-limit-limit",
334
+ key: "rateLimitLimit",
335
+ type: "number"
336
+ },
337
+ {
338
+ name: "rate-limit-remaining",
339
+ key: "rateLimitRemaining",
340
+ type: "number"
341
+ }
342
+ ]
343
+ },
344
+ StorefrontGetCheckoutForm: {
345
+ id: "StorefrontGetCheckoutForm",
346
+ method: "GET",
347
+ path: "/storefront/checkout-forms/{id}",
348
+ tags: ["Storefront checkout forms"],
349
+ params: [{
350
+ name: "id",
351
+ in: "path"
352
+ }]
353
+ },
354
+ StorefrontGetCustomFieldCollection: {
355
+ id: "StorefrontGetCustomFieldCollection",
356
+ method: "GET",
357
+ path: "/storefront/custom-fields/{resource}",
358
+ tags: ["Storefront custom fields"],
359
+ params: [
360
+ {
361
+ name: "resource",
362
+ in: "path"
363
+ },
364
+ {
365
+ name: "limit",
366
+ in: "query"
367
+ },
368
+ {
369
+ name: "offset",
370
+ in: "query"
371
+ }
372
+ ],
373
+ security: [[{
374
+ scheme: "CustomerJWT",
375
+ kind: "bearer"
376
+ }], [{
377
+ scheme: "PublishableApiKey",
378
+ kind: "apiKey",
379
+ name: "Authorization",
380
+ in: "header"
381
+ }]]
382
+ },
383
+ StorefrontGetInvoiceCollection: {
384
+ id: "StorefrontGetInvoiceCollection",
385
+ method: "GET",
386
+ path: "/storefront/invoices",
387
+ tags: ["Storefront invoices"],
388
+ params: [
389
+ {
390
+ name: "filter",
391
+ in: "query"
392
+ },
393
+ {
394
+ name: "sort",
395
+ in: "query",
396
+ style: "form",
397
+ explode: false
398
+ },
399
+ {
400
+ name: "limit",
401
+ in: "query"
402
+ },
403
+ {
404
+ name: "offset",
405
+ in: "query"
406
+ },
407
+ {
408
+ name: "q",
409
+ in: "query"
410
+ },
411
+ {
412
+ name: "expand",
413
+ in: "query"
414
+ }
415
+ ],
416
+ security: [[{
417
+ scheme: "CustomerJWT",
418
+ kind: "bearer"
419
+ }]],
420
+ responseHeaders: [
421
+ {
422
+ name: "pagination-total",
423
+ key: "paginationTotal",
424
+ type: "number"
425
+ },
426
+ {
427
+ name: "pagination-limit",
428
+ key: "paginationLimit",
429
+ type: "number"
430
+ },
431
+ {
432
+ name: "pagination-offset",
433
+ key: "paginationOffset",
434
+ type: "number"
435
+ }
436
+ ]
437
+ },
438
+ StorefrontGetInvoice: {
439
+ id: "StorefrontGetInvoice",
440
+ method: "GET",
441
+ path: "/storefront/invoices/{id}",
442
+ tags: ["Storefront invoices"],
443
+ params: [{
444
+ name: "id",
445
+ in: "path"
446
+ }, {
447
+ name: "expand",
448
+ in: "query"
449
+ }],
450
+ security: [[{
451
+ scheme: "CustomerJWT",
452
+ kind: "bearer"
453
+ }]]
454
+ },
455
+ StorefrontPatchInvoice: {
456
+ id: "StorefrontPatchInvoice",
457
+ method: "PATCH",
458
+ path: "/storefront/invoices/{id}",
459
+ tags: ["Storefront invoices"],
460
+ params: [{
461
+ name: "id",
462
+ in: "path"
463
+ }],
464
+ body: { contentType: "application/json" },
465
+ security: [[{
466
+ scheme: "CustomerJWT",
467
+ kind: "bearer"
468
+ }]],
469
+ responseHeaders: [{
470
+ name: "rate-limit-limit",
471
+ key: "rateLimitLimit",
472
+ type: "number"
473
+ }, {
474
+ name: "rate-limit-remaining",
475
+ key: "rateLimitRemaining",
476
+ type: "number"
477
+ }]
478
+ },
479
+ StorefrontGetOrderUpcomingInvoice: {
480
+ id: "StorefrontGetOrderUpcomingInvoice",
481
+ method: "GET",
482
+ path: "/storefront/orders/{id}/upcoming-invoice",
483
+ tags: ["Storefront orders"],
484
+ params: [{
485
+ name: "id",
486
+ in: "path"
487
+ }, {
488
+ name: "expand",
489
+ in: "query"
490
+ }],
491
+ security: [[{
492
+ scheme: "CustomerJWT",
493
+ kind: "bearer"
494
+ }]]
495
+ },
496
+ StorefrontPostKycDocument: {
497
+ id: "StorefrontPostKycDocument",
498
+ method: "POST",
499
+ path: "/storefront/kyc-documents",
500
+ tags: ["Storefront KYC documents"],
501
+ body: { contentType: "application/json" },
502
+ security: [[{
503
+ scheme: "CustomerJWT",
504
+ kind: "bearer"
505
+ }]],
506
+ responseHeaders: [
507
+ {
508
+ name: "location",
509
+ key: "location",
510
+ type: "string"
511
+ },
512
+ {
513
+ name: "rate-limit-limit",
514
+ key: "rateLimitLimit",
515
+ type: "number"
516
+ },
517
+ {
518
+ name: "rate-limit-remaining",
519
+ key: "rateLimitRemaining",
520
+ type: "number"
521
+ }
522
+ ]
523
+ },
524
+ StorefrontGetKycDocument: {
525
+ id: "StorefrontGetKycDocument",
526
+ method: "GET",
527
+ path: "/storefront/kyc-documents/{id}",
528
+ tags: ["Storefront KYC documents"],
529
+ params: [{
530
+ name: "id",
531
+ in: "path"
532
+ }],
533
+ security: [[{
534
+ scheme: "CustomerJWT",
535
+ kind: "bearer"
536
+ }]]
537
+ },
538
+ StorefrontPatchKycDocument: {
539
+ id: "StorefrontPatchKycDocument",
540
+ method: "PATCH",
541
+ path: "/storefront/kyc-documents/{id}",
542
+ tags: ["Storefront KYC documents"],
543
+ params: [{
544
+ name: "id",
545
+ in: "path"
546
+ }],
547
+ body: { contentType: "application/json" },
548
+ security: [[{
549
+ scheme: "CustomerJWT",
550
+ kind: "bearer"
551
+ }]],
552
+ responseHeaders: [{
553
+ name: "rate-limit-limit",
554
+ key: "rateLimitLimit",
555
+ type: "number"
556
+ }, {
557
+ name: "rate-limit-remaining",
558
+ key: "rateLimitRemaining",
559
+ type: "number"
560
+ }]
561
+ },
562
+ StorefrontGetKycRequest: {
563
+ id: "StorefrontGetKycRequest",
564
+ method: "GET",
565
+ path: "/storefront/kyc-requests/{id}",
566
+ tags: ["Storefront KYC documents"],
567
+ params: [{
568
+ name: "id",
569
+ in: "path"
570
+ }, {
571
+ name: "expand",
572
+ in: "query"
573
+ }],
574
+ security: [[{
575
+ scheme: "CustomerJWT",
576
+ kind: "bearer"
577
+ }]]
578
+ },
579
+ StorefrontPostKycLivenessSession: {
580
+ id: "StorefrontPostKycLivenessSession",
581
+ method: "POST",
582
+ path: "/storefront/kyc-liveness-sessions",
583
+ tags: ["Storefront KYC documents"],
584
+ body: { contentType: "application/json" },
585
+ security: [[{
586
+ scheme: "CustomerJWT",
587
+ kind: "bearer"
588
+ }]],
589
+ responseHeaders: [
590
+ {
591
+ name: "location",
592
+ key: "location",
593
+ type: "string"
594
+ },
595
+ {
596
+ name: "rate-limit-limit",
597
+ key: "rateLimitLimit",
598
+ type: "number"
599
+ },
600
+ {
601
+ name: "rate-limit-remaining",
602
+ key: "rateLimitRemaining",
603
+ type: "number"
604
+ }
605
+ ]
606
+ },
607
+ StorefrontGetKycLivenessSession: {
608
+ id: "StorefrontGetKycLivenessSession",
609
+ method: "GET",
610
+ path: "/storefront/kyc-liveness-sessions/{id}",
611
+ tags: ["Storefront KYC documents"],
612
+ params: [{
613
+ name: "id",
614
+ in: "path"
615
+ }],
616
+ security: [[{
617
+ scheme: "CustomerJWT",
618
+ kind: "bearer"
619
+ }]]
620
+ },
621
+ StorefrontPostKycLivenessSessionFinish: {
622
+ id: "StorefrontPostKycLivenessSessionFinish",
623
+ method: "POST",
624
+ path: "/storefront/kyc-liveness-sessions/{id}/finish",
625
+ tags: ["Storefront KYC documents"],
626
+ params: [{
627
+ name: "id",
628
+ in: "path"
629
+ }],
630
+ security: [[{
631
+ scheme: "CustomerJWT",
632
+ kind: "bearer"
633
+ }]],
634
+ responseHeaders: [
635
+ {
636
+ name: "location",
637
+ key: "location",
638
+ type: "string"
639
+ },
640
+ {
641
+ name: "rate-limit-limit",
642
+ key: "rateLimitLimit",
643
+ type: "number"
644
+ },
645
+ {
646
+ name: "rate-limit-remaining",
647
+ key: "rateLimitRemaining",
648
+ type: "number"
649
+ }
650
+ ]
651
+ },
652
+ StorefrontPostLogin: {
653
+ id: "StorefrontPostLogin",
654
+ method: "POST",
655
+ path: "/storefront/login",
656
+ tags: ["Storefront account"],
657
+ body: { contentType: "application/json" },
658
+ security: [[{
659
+ scheme: "PublishableApiKey",
660
+ kind: "apiKey",
661
+ name: "Authorization",
662
+ in: "header"
663
+ }]],
664
+ responseHeaders: [
665
+ {
666
+ name: "location",
667
+ key: "location",
668
+ type: "string"
669
+ },
670
+ {
671
+ name: "rate-limit-limit",
672
+ key: "rateLimitLimit",
673
+ type: "number"
674
+ },
675
+ {
676
+ name: "rate-limit-remaining",
677
+ key: "rateLimitRemaining",
678
+ type: "number"
679
+ }
680
+ ]
681
+ },
682
+ StorefrontPostLogout: {
683
+ id: "StorefrontPostLogout",
684
+ method: "POST",
685
+ path: "/storefront/logout",
686
+ tags: ["Storefront account"],
687
+ responseKind: "void",
688
+ security: [[{
689
+ scheme: "CustomerJWT",
690
+ kind: "bearer"
691
+ }]],
692
+ responseHeaders: [{
693
+ name: "rate-limit-limit",
694
+ key: "rateLimitLimit",
695
+ type: "number"
696
+ }, {
697
+ name: "rate-limit-remaining",
698
+ key: "rateLimitRemaining",
699
+ type: "number"
700
+ }]
701
+ },
702
+ StorefrontGetOrderCollection: {
703
+ id: "StorefrontGetOrderCollection",
704
+ method: "GET",
705
+ path: "/storefront/orders",
706
+ tags: ["Storefront orders"],
707
+ params: [
708
+ {
709
+ name: "filter",
710
+ in: "query"
711
+ },
712
+ {
713
+ name: "sort",
714
+ in: "query",
715
+ style: "form",
716
+ explode: false
717
+ },
718
+ {
719
+ name: "limit",
720
+ in: "query"
721
+ },
722
+ {
723
+ name: "offset",
724
+ in: "query"
725
+ },
726
+ {
727
+ name: "q",
728
+ in: "query"
729
+ },
730
+ {
731
+ name: "expand",
732
+ in: "query"
733
+ }
734
+ ],
735
+ security: [[{
736
+ scheme: "CustomerJWT",
737
+ kind: "bearer"
738
+ }]],
739
+ responseHeaders: [
740
+ {
741
+ name: "pagination-total",
742
+ key: "paginationTotal",
743
+ type: "number"
744
+ },
745
+ {
746
+ name: "pagination-limit",
747
+ key: "paginationLimit",
748
+ type: "number"
749
+ },
750
+ {
751
+ name: "pagination-offset",
752
+ key: "paginationOffset",
753
+ type: "number"
754
+ }
755
+ ]
756
+ },
757
+ StorefrontGetOrder: {
758
+ id: "StorefrontGetOrder",
759
+ method: "GET",
760
+ path: "/storefront/orders/{id}",
761
+ tags: ["Storefront orders"],
762
+ params: [{
763
+ name: "id",
764
+ in: "path"
765
+ }, {
766
+ name: "expand",
767
+ in: "query"
768
+ }],
769
+ security: [[{
770
+ scheme: "CustomerJWT",
771
+ kind: "bearer"
772
+ }]]
773
+ },
774
+ StorefrontPatchOrder: {
775
+ id: "StorefrontPatchOrder",
776
+ method: "PATCH",
777
+ path: "/storefront/orders/{id}",
778
+ tags: ["Storefront orders"],
779
+ params: [{
780
+ name: "id",
781
+ in: "path"
782
+ }],
783
+ body: { contentType: "application/json" },
784
+ security: [[{
785
+ scheme: "CustomerJWT",
786
+ kind: "bearer"
787
+ }]],
788
+ responseHeaders: [{
789
+ name: "rate-limit-limit",
790
+ key: "rateLimitLimit",
791
+ type: "number"
792
+ }, {
793
+ name: "rate-limit-remaining",
794
+ key: "rateLimitRemaining",
795
+ type: "number"
796
+ }]
797
+ },
798
+ StorefrontPostOrderCancellation: {
799
+ id: "StorefrontPostOrderCancellation",
800
+ method: "POST",
801
+ path: "/storefront/orders/{id}/cancellation",
802
+ tags: ["Storefront orders"],
803
+ params: [{
804
+ name: "id",
805
+ in: "path"
806
+ }],
807
+ body: { contentType: "application/json" },
808
+ security: [[{
809
+ scheme: "CustomerJWT",
810
+ kind: "bearer"
811
+ }]],
812
+ responseHeaders: [
813
+ {
814
+ name: "location",
815
+ key: "location",
816
+ type: "string"
817
+ },
818
+ {
819
+ name: "rate-limit-limit",
820
+ key: "rateLimitLimit",
821
+ type: "number"
822
+ },
823
+ {
824
+ name: "rate-limit-remaining",
825
+ key: "rateLimitRemaining",
826
+ type: "number"
827
+ }
828
+ ]
829
+ },
830
+ StorefrontPostOrderPause: {
831
+ id: "StorefrontPostOrderPause",
832
+ method: "POST",
833
+ path: "/storefront/orders/{id}/pause",
834
+ tags: ["Storefront orders"],
835
+ params: [{
836
+ name: "id",
837
+ in: "path"
838
+ }],
839
+ body: { contentType: "application/json" },
840
+ security: [[{
841
+ scheme: "CustomerJWT",
842
+ kind: "bearer"
843
+ }]],
844
+ responseHeaders: [
845
+ {
846
+ name: "location",
847
+ key: "location",
848
+ type: "string"
849
+ },
850
+ {
851
+ name: "rate-limit-limit",
852
+ key: "rateLimitLimit",
853
+ type: "number"
854
+ },
855
+ {
856
+ name: "rate-limit-remaining",
857
+ key: "rateLimitRemaining",
858
+ type: "number"
859
+ }
860
+ ]
861
+ },
862
+ StorefrontPostSubscriptionItemsChange: {
863
+ id: "StorefrontPostSubscriptionItemsChange",
864
+ method: "POST",
865
+ path: "/storefront/subscriptions/{id}/change-items",
866
+ tags: ["Storefront orders"],
867
+ params: [{
868
+ name: "id",
869
+ in: "path"
870
+ }],
871
+ body: { contentType: "application/json" },
872
+ security: [[{
873
+ scheme: "CustomerJWT",
874
+ kind: "bearer"
875
+ }]],
876
+ responseHeaders: [
877
+ {
878
+ name: "location",
879
+ key: "location",
880
+ type: "string"
881
+ },
882
+ {
883
+ name: "rate-limit-limit",
884
+ key: "rateLimitLimit",
885
+ type: "number"
886
+ },
887
+ {
888
+ name: "rate-limit-remaining",
889
+ key: "rateLimitRemaining",
890
+ type: "number"
891
+ }
892
+ ]
893
+ },
894
+ StorefrontGetOrderChangeCollection: {
895
+ id: "StorefrontGetOrderChangeCollection",
896
+ method: "GET",
897
+ path: "/storefront/order-changes",
898
+ tags: ["Storefront orders"],
899
+ params: [
900
+ {
901
+ name: "limit",
902
+ in: "query"
903
+ },
904
+ {
905
+ name: "offset",
906
+ in: "query"
907
+ },
908
+ {
909
+ name: "filter",
910
+ in: "query"
911
+ }
912
+ ],
913
+ security: [[{
914
+ scheme: "CustomerJWT",
915
+ kind: "bearer"
916
+ }]],
917
+ responseHeaders: [
918
+ {
919
+ name: "pagination-total",
920
+ key: "paginationTotal",
921
+ type: "number"
922
+ },
923
+ {
924
+ name: "pagination-limit",
925
+ key: "paginationLimit",
926
+ type: "number"
927
+ },
928
+ {
929
+ name: "pagination-offset",
930
+ key: "paginationOffset",
931
+ type: "number"
932
+ }
933
+ ]
934
+ },
935
+ StorefrontDeleteOrderChange: {
936
+ id: "StorefrontDeleteOrderChange",
937
+ method: "DELETE",
938
+ path: "/storefront/order-changes/{id}",
939
+ tags: ["Storefront orders"],
940
+ params: [{
941
+ name: "id",
942
+ in: "path"
943
+ }],
944
+ responseKind: "void",
945
+ security: [[{
946
+ scheme: "CustomerJWT",
947
+ kind: "bearer"
948
+ }]],
949
+ responseHeaders: [{
950
+ name: "rate-limit-limit",
951
+ key: "rateLimitLimit",
952
+ type: "number"
953
+ }, {
954
+ name: "rate-limit-remaining",
955
+ key: "rateLimitRemaining",
956
+ type: "number"
957
+ }]
958
+ },
959
+ StorefrontPostSubscriptionReactivation: {
960
+ id: "StorefrontPostSubscriptionReactivation",
961
+ method: "POST",
962
+ path: "/storefront/subscription-reactivations",
963
+ tags: ["Storefront orders"],
964
+ body: { contentType: "application/json" },
965
+ security: [[{
966
+ scheme: "CustomerJWT",
967
+ kind: "bearer"
968
+ }]]
969
+ },
970
+ StorefrontPostPayment: {
971
+ id: "StorefrontPostPayment",
972
+ method: "POST",
973
+ path: "/storefront/payment",
974
+ tags: ["Storefront purchases"],
975
+ body: { contentType: "application/json" },
976
+ security: [[{
977
+ scheme: "CustomerJWT",
978
+ kind: "bearer"
979
+ }], [{
980
+ scheme: "PublishableApiKey",
981
+ kind: "apiKey",
982
+ name: "Authorization",
983
+ in: "header"
984
+ }]],
985
+ responseHeaders: [{
986
+ name: "rate-limit-limit",
987
+ key: "rateLimitLimit",
988
+ type: "number"
989
+ }, {
990
+ name: "rate-limit-remaining",
991
+ key: "rateLimitRemaining",
992
+ type: "number"
993
+ }]
994
+ },
995
+ StorefrontGetPaymentInstrumentCollection: {
996
+ id: "StorefrontGetPaymentInstrumentCollection",
997
+ method: "GET",
998
+ path: "/storefront/payment-instruments",
999
+ tags: ["Storefront payment instruments"],
1000
+ params: [
1001
+ {
1002
+ name: "filter",
1003
+ in: "query"
1004
+ },
1005
+ {
1006
+ name: "sort",
1007
+ in: "query",
1008
+ style: "form",
1009
+ explode: false
1010
+ },
1011
+ {
1012
+ name: "limit",
1013
+ in: "query"
1014
+ },
1015
+ {
1016
+ name: "offset",
1017
+ in: "query"
1018
+ },
1019
+ {
1020
+ name: "q",
1021
+ in: "query"
1022
+ }
1023
+ ],
1024
+ security: [[{
1025
+ scheme: "CustomerJWT",
1026
+ kind: "bearer"
1027
+ }]],
1028
+ responseHeaders: [
1029
+ {
1030
+ name: "pagination-total",
1031
+ key: "paginationTotal",
1032
+ type: "number"
1033
+ },
1034
+ {
1035
+ name: "pagination-limit",
1036
+ key: "paginationLimit",
1037
+ type: "number"
1038
+ },
1039
+ {
1040
+ name: "pagination-offset",
1041
+ key: "paginationOffset",
1042
+ type: "number"
1043
+ }
1044
+ ]
1045
+ },
1046
+ StorefrontPostPaymentInstrument: {
1047
+ id: "StorefrontPostPaymentInstrument",
1048
+ method: "POST",
1049
+ path: "/storefront/payment-instruments",
1050
+ tags: ["Storefront payment instruments"],
1051
+ body: { contentType: "application/json" },
1052
+ security: [[{
1053
+ scheme: "CustomerJWT",
1054
+ kind: "bearer"
1055
+ }], [{
1056
+ scheme: "PublishableApiKey",
1057
+ kind: "apiKey",
1058
+ name: "Authorization",
1059
+ in: "header"
1060
+ }]],
1061
+ responseHeaders: [
1062
+ {
1063
+ name: "location",
1064
+ key: "location",
1065
+ type: "string"
1066
+ },
1067
+ {
1068
+ name: "rate-limit-limit",
1069
+ key: "rateLimitLimit",
1070
+ type: "number"
1071
+ },
1072
+ {
1073
+ name: "rate-limit-remaining",
1074
+ key: "rateLimitRemaining",
1075
+ type: "number"
1076
+ }
1077
+ ]
1078
+ },
1079
+ StorefrontGetPaymentInstrument: {
1080
+ id: "StorefrontGetPaymentInstrument",
1081
+ method: "GET",
1082
+ path: "/storefront/payment-instruments/{id}",
1083
+ tags: ["Storefront payment instruments"],
1084
+ params: [
1085
+ {
1086
+ name: "id",
1087
+ in: "path"
1088
+ },
1089
+ {
1090
+ name: "limit",
1091
+ in: "query"
1092
+ },
1093
+ {
1094
+ name: "offset",
1095
+ in: "query"
1096
+ }
1097
+ ],
1098
+ security: [[{
1099
+ scheme: "CustomerJWT",
1100
+ kind: "bearer"
1101
+ }]],
1102
+ responseHeaders: [
1103
+ {
1104
+ name: "pagination-total",
1105
+ key: "paginationTotal",
1106
+ type: "number"
1107
+ },
1108
+ {
1109
+ name: "pagination-limit",
1110
+ key: "paginationLimit",
1111
+ type: "number"
1112
+ },
1113
+ {
1114
+ name: "pagination-offset",
1115
+ key: "paginationOffset",
1116
+ type: "number"
1117
+ }
1118
+ ]
1119
+ },
1120
+ StorefrontPatchPaymentInstrument: {
1121
+ id: "StorefrontPatchPaymentInstrument",
1122
+ method: "PATCH",
1123
+ path: "/storefront/payment-instruments/{id}",
1124
+ tags: ["Storefront payment instruments"],
1125
+ params: [{
1126
+ name: "id",
1127
+ in: "path"
1128
+ }],
1129
+ body: { contentType: "application/json" },
1130
+ security: [[{
1131
+ scheme: "CustomerJWT",
1132
+ kind: "bearer"
1133
+ }]],
1134
+ responseHeaders: [{
1135
+ name: "rate-limit-limit",
1136
+ key: "rateLimitLimit",
1137
+ type: "number"
1138
+ }, {
1139
+ name: "rate-limit-remaining",
1140
+ key: "rateLimitRemaining",
1141
+ type: "number"
1142
+ }]
1143
+ },
1144
+ StorefrontPostPaymentInstrumentDeactivation: {
1145
+ id: "StorefrontPostPaymentInstrumentDeactivation",
1146
+ method: "POST",
1147
+ path: "/storefront/payment-instruments/{id}/deactivation",
1148
+ tags: ["Storefront payment instruments"],
1149
+ params: [{
1150
+ name: "id",
1151
+ in: "path"
1152
+ }],
1153
+ security: [[{
1154
+ scheme: "CustomerJWT",
1155
+ kind: "bearer"
1156
+ }]],
1157
+ responseHeaders: [
1158
+ {
1159
+ name: "location",
1160
+ key: "location",
1161
+ type: "string"
1162
+ },
1163
+ {
1164
+ name: "rate-limit-limit",
1165
+ key: "rateLimitLimit",
1166
+ type: "number"
1167
+ },
1168
+ {
1169
+ name: "rate-limit-remaining",
1170
+ key: "rateLimitRemaining",
1171
+ type: "number"
1172
+ }
1173
+ ]
1174
+ },
1175
+ StorefrontGetPaymentInstrumentSetup: {
1176
+ id: "StorefrontGetPaymentInstrumentSetup",
1177
+ method: "GET",
1178
+ path: "/storefront/payment-instruments/{id}/setup",
1179
+ tags: ["Storefront payment instruments"],
1180
+ params: [{
1181
+ name: "id",
1182
+ in: "path"
1183
+ }],
1184
+ security: [[{
1185
+ scheme: "CustomerJWT",
1186
+ kind: "bearer"
1187
+ }]]
1188
+ },
1189
+ StorefrontPostPaymentInstrumentSetup: {
1190
+ id: "StorefrontPostPaymentInstrumentSetup",
1191
+ method: "POST",
1192
+ path: "/storefront/payment-instruments/{id}/setup",
1193
+ tags: ["Storefront payment instruments"],
1194
+ params: [{
1195
+ name: "id",
1196
+ in: "path"
1197
+ }],
1198
+ body: { contentType: "application/json" },
1199
+ security: [[{
1200
+ scheme: "CustomerJWT",
1201
+ kind: "bearer"
1202
+ }]],
1203
+ responseHeaders: [
1204
+ {
1205
+ name: "location",
1206
+ key: "location",
1207
+ type: "string"
1208
+ },
1209
+ {
1210
+ name: "rate-limit-limit",
1211
+ key: "rateLimitLimit",
1212
+ type: "number"
1213
+ },
1214
+ {
1215
+ name: "rate-limit-remaining",
1216
+ key: "rateLimitRemaining",
1217
+ type: "number"
1218
+ }
1219
+ ]
1220
+ },
1221
+ StorefrontGetPayoutRequestCollection: {
1222
+ id: "StorefrontGetPayoutRequestCollection",
1223
+ method: "GET",
1224
+ path: "/storefront/payout-requests",
1225
+ tags: ["Storefront transactions"],
1226
+ params: [
1227
+ {
1228
+ name: "filter",
1229
+ in: "query"
1230
+ },
1231
+ {
1232
+ name: "sort",
1233
+ in: "query",
1234
+ style: "form",
1235
+ explode: false
1236
+ },
1237
+ {
1238
+ name: "limit",
1239
+ in: "query"
1240
+ },
1241
+ {
1242
+ name: "offset",
1243
+ in: "query"
1244
+ },
1245
+ {
1246
+ name: "q",
1247
+ in: "query"
1248
+ }
1249
+ ],
1250
+ security: [[{
1251
+ scheme: "CustomerJWT",
1252
+ kind: "bearer"
1253
+ }]],
1254
+ responseHeaders: [
1255
+ {
1256
+ name: "pagination-total",
1257
+ key: "paginationTotal",
1258
+ type: "number"
1259
+ },
1260
+ {
1261
+ name: "pagination-limit",
1262
+ key: "paginationLimit",
1263
+ type: "number"
1264
+ },
1265
+ {
1266
+ name: "pagination-offset",
1267
+ key: "paginationOffset",
1268
+ type: "number"
1269
+ }
1270
+ ]
1271
+ },
1272
+ StorefrontPostPayoutRequest: {
1273
+ id: "StorefrontPostPayoutRequest",
1274
+ method: "POST",
1275
+ path: "/storefront/payout-requests",
1276
+ tags: ["Storefront transactions"],
1277
+ body: { contentType: "application/json" },
1278
+ security: [[{
1279
+ scheme: "CustomerJWT",
1280
+ kind: "bearer"
1281
+ }]],
1282
+ responseHeaders: [{
1283
+ name: "location",
1284
+ key: "location",
1285
+ type: "string"
1286
+ }]
1287
+ },
1288
+ StorefrontGetPayoutRequest: {
1289
+ id: "StorefrontGetPayoutRequest",
1290
+ method: "GET",
1291
+ path: "/storefront/payout-requests/{id}",
1292
+ tags: ["Storefront transactions"],
1293
+ params: [{
1294
+ name: "id",
1295
+ in: "path"
1296
+ }],
1297
+ security: [[{
1298
+ scheme: "CustomerJWT",
1299
+ kind: "bearer"
1300
+ }]]
1301
+ },
1302
+ StorefrontPatchPayoutRequest: {
1303
+ id: "StorefrontPatchPayoutRequest",
1304
+ method: "PATCH",
1305
+ path: "/storefront/payout-requests/{id}",
1306
+ tags: ["Storefront transactions"],
1307
+ params: [{
1308
+ name: "id",
1309
+ in: "path"
1310
+ }],
1311
+ body: { contentType: "application/json" },
1312
+ security: [[{
1313
+ scheme: "CustomerJWT",
1314
+ kind: "bearer"
1315
+ }]],
1316
+ responseHeaders: [{
1317
+ name: "rate-limit-limit",
1318
+ key: "rateLimitLimit",
1319
+ type: "number"
1320
+ }, {
1321
+ name: "rate-limit-remaining",
1322
+ key: "rateLimitRemaining",
1323
+ type: "number"
1324
+ }]
1325
+ },
1326
+ StorefrontPostPayoutRequestCancellation: {
1327
+ id: "StorefrontPostPayoutRequestCancellation",
1328
+ method: "POST",
1329
+ path: "/storefront/payout-request-cancellations",
1330
+ tags: ["Storefront cashiers"],
1331
+ body: { contentType: "application/json" },
1332
+ security: [[{
1333
+ scheme: "CustomerJWT",
1334
+ kind: "bearer"
1335
+ }]]
1336
+ },
1337
+ StorefrontGetPlanCollection: {
1338
+ id: "StorefrontGetPlanCollection",
1339
+ method: "GET",
1340
+ path: "/storefront/plans",
1341
+ tags: ["Storefront plans"],
1342
+ params: [
1343
+ {
1344
+ name: "filter",
1345
+ in: "query"
1346
+ },
1347
+ {
1348
+ name: "sort",
1349
+ in: "query",
1350
+ style: "form",
1351
+ explode: false
1352
+ },
1353
+ {
1354
+ name: "limit",
1355
+ in: "query"
1356
+ },
1357
+ {
1358
+ name: "offset",
1359
+ in: "query"
1360
+ },
1361
+ {
1362
+ name: "q",
1363
+ in: "query"
1364
+ },
1365
+ {
1366
+ name: "expand",
1367
+ in: "query"
1368
+ }
1369
+ ],
1370
+ security: [[{
1371
+ scheme: "CustomerJWT",
1372
+ kind: "bearer"
1373
+ }], [{
1374
+ scheme: "PublishableApiKey",
1375
+ kind: "apiKey",
1376
+ name: "Authorization",
1377
+ in: "header"
1378
+ }]],
1379
+ responseHeaders: [
1380
+ {
1381
+ name: "pagination-total",
1382
+ key: "paginationTotal",
1383
+ type: "number"
1384
+ },
1385
+ {
1386
+ name: "pagination-limit",
1387
+ key: "paginationLimit",
1388
+ type: "number"
1389
+ },
1390
+ {
1391
+ name: "pagination-offset",
1392
+ key: "paginationOffset",
1393
+ type: "number"
1394
+ }
1395
+ ]
1396
+ },
1397
+ StorefrontGetPlan: {
1398
+ id: "StorefrontGetPlan",
1399
+ method: "GET",
1400
+ path: "/storefront/plans/{id}",
1401
+ tags: ["Storefront plans"],
1402
+ params: [{
1403
+ name: "id",
1404
+ in: "path"
1405
+ }, {
1406
+ name: "expand",
1407
+ in: "query"
1408
+ }],
1409
+ security: [[{
1410
+ scheme: "CustomerJWT",
1411
+ kind: "bearer"
1412
+ }], [{
1413
+ scheme: "PublishableApiKey",
1414
+ kind: "apiKey",
1415
+ name: "Authorization",
1416
+ in: "header"
1417
+ }]]
1418
+ },
1419
+ StorefrontGetProductCollection: {
1420
+ id: "StorefrontGetProductCollection",
1421
+ method: "GET",
1422
+ path: "/storefront/products",
1423
+ tags: ["Storefront products"],
1424
+ params: [
1425
+ {
1426
+ name: "filter",
1427
+ in: "query"
1428
+ },
1429
+ {
1430
+ name: "sort",
1431
+ in: "query",
1432
+ style: "form",
1433
+ explode: false
1434
+ },
1435
+ {
1436
+ name: "limit",
1437
+ in: "query"
1438
+ },
1439
+ {
1440
+ name: "offset",
1441
+ in: "query"
1442
+ },
1443
+ {
1444
+ name: "q",
1445
+ in: "query"
1446
+ }
1447
+ ],
1448
+ security: [[{
1449
+ scheme: "CustomerJWT",
1450
+ kind: "bearer"
1451
+ }], [{
1452
+ scheme: "PublishableApiKey",
1453
+ kind: "apiKey",
1454
+ name: "Authorization",
1455
+ in: "header"
1456
+ }]],
1457
+ responseHeaders: [
1458
+ {
1459
+ name: "pagination-total",
1460
+ key: "paginationTotal",
1461
+ type: "number"
1462
+ },
1463
+ {
1464
+ name: "pagination-limit",
1465
+ key: "paginationLimit",
1466
+ type: "number"
1467
+ },
1468
+ {
1469
+ name: "pagination-offset",
1470
+ key: "paginationOffset",
1471
+ type: "number"
1472
+ }
1473
+ ]
1474
+ },
1475
+ StorefrontGetProduct: {
1476
+ id: "StorefrontGetProduct",
1477
+ method: "GET",
1478
+ path: "/storefront/products/{id}",
1479
+ tags: ["Storefront products"],
1480
+ params: [{
1481
+ name: "id",
1482
+ in: "path"
1483
+ }],
1484
+ security: [[{
1485
+ scheme: "CustomerJWT",
1486
+ kind: "bearer"
1487
+ }], [{
1488
+ scheme: "PublishableApiKey",
1489
+ kind: "apiKey",
1490
+ name: "Authorization",
1491
+ in: "header"
1492
+ }]]
1493
+ },
1494
+ StorefrontPostPurchase: {
1495
+ id: "StorefrontPostPurchase",
1496
+ method: "POST",
1497
+ path: "/storefront/purchase",
1498
+ tags: ["Storefront purchases"],
1499
+ body: { contentType: "application/json" },
1500
+ security: [[{
1501
+ scheme: "CustomerJWT",
1502
+ kind: "bearer"
1503
+ }], [{
1504
+ scheme: "PublishableApiKey",
1505
+ kind: "apiKey",
1506
+ name: "Authorization",
1507
+ in: "header"
1508
+ }]],
1509
+ responseHeaders: [
1510
+ {
1511
+ name: "location",
1512
+ key: "location",
1513
+ type: "string"
1514
+ },
1515
+ {
1516
+ name: "rate-limit-limit",
1517
+ key: "rateLimitLimit",
1518
+ type: "number"
1519
+ },
1520
+ {
1521
+ name: "rate-limit-remaining",
1522
+ key: "rateLimitRemaining",
1523
+ type: "number"
1524
+ }
1525
+ ]
1526
+ },
1527
+ StorefrontPostPreviewPurchase: {
1528
+ id: "StorefrontPostPreviewPurchase",
1529
+ method: "POST",
1530
+ path: "/storefront/preview-purchase",
1531
+ tags: ["Storefront purchases"],
1532
+ body: { contentType: "application/json" },
1533
+ security: [[{
1534
+ scheme: "CustomerJWT",
1535
+ kind: "bearer"
1536
+ }], [{
1537
+ scheme: "PublishableApiKey",
1538
+ kind: "apiKey",
1539
+ name: "Authorization",
1540
+ in: "header"
1541
+ }]],
1542
+ responseHeaders: [{
1543
+ name: "rate-limit-limit",
1544
+ key: "rateLimitLimit",
1545
+ type: "number"
1546
+ }, {
1547
+ name: "rate-limit-remaining",
1548
+ key: "rateLimitRemaining",
1549
+ type: "number"
1550
+ }]
1551
+ },
1552
+ StorefrontGetQuote: {
1553
+ id: "StorefrontGetQuote",
1554
+ method: "GET",
1555
+ path: "/storefront/quotes/{id}",
1556
+ tags: ["Storefront quotes"],
1557
+ params: [
1558
+ {
1559
+ name: "id",
1560
+ in: "path"
1561
+ },
1562
+ {
1563
+ name: "expand",
1564
+ in: "query"
1565
+ },
1566
+ {
1567
+ name: "Accept",
1568
+ in: "header"
1569
+ }
1570
+ ],
1571
+ security: [[{
1572
+ scheme: "CustomerJWT",
1573
+ kind: "bearer"
1574
+ }]]
1575
+ },
1576
+ StorefrontPostQuoteAcceptance: {
1577
+ id: "StorefrontPostQuoteAcceptance",
1578
+ method: "POST",
1579
+ path: "/storefront/quotes/{id}/accept",
1580
+ tags: ["Storefront quotes"],
1581
+ params: [{
1582
+ name: "id",
1583
+ in: "path"
1584
+ }],
1585
+ security: [[{
1586
+ scheme: "CustomerJWT",
1587
+ kind: "bearer"
1588
+ }]],
1589
+ responseHeaders: [{
1590
+ name: "rate-limit-limit",
1591
+ key: "rateLimitLimit",
1592
+ type: "number"
1593
+ }, {
1594
+ name: "rate-limit-remaining",
1595
+ key: "rateLimitRemaining",
1596
+ type: "number"
1597
+ }]
1598
+ },
1599
+ StorefrontPostQuoteRejection: {
1600
+ id: "StorefrontPostQuoteRejection",
1601
+ method: "POST",
1602
+ path: "/storefront/quotes/{id}/reject",
1603
+ tags: ["Storefront quotes"],
1604
+ params: [{
1605
+ name: "id",
1606
+ in: "path"
1607
+ }],
1608
+ security: [[{
1609
+ scheme: "CustomerJWT",
1610
+ kind: "bearer"
1611
+ }]],
1612
+ responseHeaders: [{
1613
+ name: "rate-limit-limit",
1614
+ key: "rateLimitLimit",
1615
+ type: "number"
1616
+ }, {
1617
+ name: "rate-limit-remaining",
1618
+ key: "rateLimitRemaining",
1619
+ type: "number"
1620
+ }]
1621
+ },
1622
+ StorefrontPostReadyToPay: {
1623
+ id: "StorefrontPostReadyToPay",
1624
+ method: "POST",
1625
+ path: "/storefront/ready-to-pay",
1626
+ tags: ["Storefront purchases"],
1627
+ body: { contentType: "application/json" },
1628
+ security: [[{
1629
+ scheme: "CustomerJWT",
1630
+ kind: "bearer"
1631
+ }], [{
1632
+ scheme: "PublishableApiKey",
1633
+ kind: "apiKey",
1634
+ name: "Authorization",
1635
+ in: "header"
1636
+ }]],
1637
+ responseHeaders: [{
1638
+ name: "rate-limit-limit",
1639
+ key: "rateLimitLimit",
1640
+ type: "number"
1641
+ }, {
1642
+ name: "rate-limit-remaining",
1643
+ key: "rateLimitRemaining",
1644
+ type: "number"
1645
+ }]
1646
+ },
1647
+ StorefrontPostReadyToPayout: {
1648
+ id: "StorefrontPostReadyToPayout",
1649
+ method: "POST",
1650
+ path: "/storefront/ready-to-payout",
1651
+ tags: ["Storefront purchases"],
1652
+ body: { contentType: "application/json" },
1653
+ security: [[{
1654
+ scheme: "CustomerJWT",
1655
+ kind: "bearer"
1656
+ }]],
1657
+ responseHeaders: [{
1658
+ name: "rate-limit-limit",
1659
+ key: "rateLimitLimit",
1660
+ type: "number"
1661
+ }, {
1662
+ name: "rate-limit-remaining",
1663
+ key: "rateLimitRemaining",
1664
+ type: "number"
1665
+ }]
1666
+ },
1667
+ StorefrontPostRegister: {
1668
+ id: "StorefrontPostRegister",
1669
+ method: "POST",
1670
+ path: "/storefront/register",
1671
+ tags: ["Storefront account"],
1672
+ body: { contentType: "application/json" },
1673
+ security: [[{
1674
+ scheme: "PublishableApiKey",
1675
+ kind: "apiKey",
1676
+ name: "Authorization",
1677
+ in: "header"
1678
+ }]],
1679
+ responseHeaders: [
1680
+ {
1681
+ name: "location",
1682
+ key: "location",
1683
+ type: "string"
1684
+ },
1685
+ {
1686
+ name: "rate-limit-limit",
1687
+ key: "rateLimitLimit",
1688
+ type: "number"
1689
+ },
1690
+ {
1691
+ name: "rate-limit-remaining",
1692
+ key: "rateLimitRemaining",
1693
+ type: "number"
1694
+ }
1695
+ ]
1696
+ },
1697
+ StorefrontPostSubscription: {
1698
+ id: "StorefrontPostSubscription",
1699
+ method: "POST",
1700
+ path: "/storefront/subscriptions",
1701
+ tags: ["Storefront orders"],
1702
+ body: { contentType: "application/json" },
1703
+ security: [[{
1704
+ scheme: "CustomerJWT",
1705
+ kind: "bearer"
1706
+ }]],
1707
+ responseHeaders: [
1708
+ {
1709
+ name: "location",
1710
+ key: "location",
1711
+ type: "string"
1712
+ },
1713
+ {
1714
+ name: "rate-limit-limit",
1715
+ key: "rateLimitLimit",
1716
+ type: "number"
1717
+ },
1718
+ {
1719
+ name: "rate-limit-remaining",
1720
+ key: "rateLimitRemaining",
1721
+ type: "number"
1722
+ }
1723
+ ]
1724
+ },
1725
+ StorefrontGetTransactionCollection: {
1726
+ id: "StorefrontGetTransactionCollection",
1727
+ method: "GET",
1728
+ path: "/storefront/transactions",
1729
+ tags: ["Storefront transactions"],
1730
+ params: [
1731
+ {
1732
+ name: "limit",
1733
+ in: "query"
1734
+ },
1735
+ {
1736
+ name: "offset",
1737
+ in: "query"
1738
+ },
1739
+ {
1740
+ name: "filter",
1741
+ in: "query"
1742
+ },
1743
+ {
1744
+ name: "q",
1745
+ in: "query"
1746
+ },
1747
+ {
1748
+ name: "sort",
1749
+ in: "query",
1750
+ style: "form",
1751
+ explode: false
1752
+ }
1753
+ ],
1754
+ security: [[{
1755
+ scheme: "CustomerJWT",
1756
+ kind: "bearer"
1757
+ }]],
1758
+ responseHeaders: [
1759
+ {
1760
+ name: "pagination-total",
1761
+ key: "paginationTotal",
1762
+ type: "number"
1763
+ },
1764
+ {
1765
+ name: "pagination-limit",
1766
+ key: "paginationLimit",
1767
+ type: "number"
1768
+ },
1769
+ {
1770
+ name: "pagination-offset",
1771
+ key: "paginationOffset",
1772
+ type: "number"
1773
+ }
1774
+ ]
1775
+ },
1776
+ StorefrontGetTransaction: {
1777
+ id: "StorefrontGetTransaction",
1778
+ method: "GET",
1779
+ path: "/storefront/transactions/{id}",
1780
+ tags: ["Storefront transactions"],
1781
+ params: [{
1782
+ name: "id",
1783
+ in: "path"
1784
+ }],
1785
+ security: [[{
1786
+ scheme: "CustomerJWT",
1787
+ kind: "bearer"
1788
+ }]]
1789
+ },
1790
+ StorefrontGetTransactionDccOffer: {
1791
+ id: "StorefrontGetTransactionDccOffer",
1792
+ method: "GET",
1793
+ path: "/storefront/transactions/{id}/dcc",
1794
+ tags: ["Storefront transactions"],
1795
+ params: [{
1796
+ name: "id",
1797
+ in: "path"
1798
+ }],
1799
+ security: [[{
1800
+ scheme: "CustomerJWT",
1801
+ kind: "bearer"
1802
+ }]]
1803
+ },
1804
+ StorefrontPatchTransactionDccOffer: {
1805
+ id: "StorefrontPatchTransactionDccOffer",
1806
+ method: "PATCH",
1807
+ path: "/storefront/transactions/{id}/dcc",
1808
+ tags: ["Storefront transactions"],
1809
+ params: [{
1810
+ name: "id",
1811
+ in: "path"
1812
+ }],
1813
+ body: { contentType: "application/json" },
1814
+ security: [[{
1815
+ scheme: "CustomerJWT",
1816
+ kind: "bearer"
1817
+ }]],
1818
+ responseHeaders: [{
1819
+ name: "rate-limit-limit",
1820
+ key: "rateLimitLimit",
1821
+ type: "number"
1822
+ }, {
1823
+ name: "rate-limit-remaining",
1824
+ key: "rateLimitRemaining",
1825
+ type: "number"
1826
+ }]
1827
+ },
1828
+ StorefrontPostKycRequestContinue: {
1829
+ id: "StorefrontPostKycRequestContinue",
1830
+ method: "POST",
1831
+ path: "/storefront/transactions/{id}/{token}/continue",
1832
+ tags: ["Storefront transactions"],
1833
+ params: [{
1834
+ name: "id",
1835
+ in: "path"
1836
+ }, {
1837
+ name: "token",
1838
+ in: "path"
1839
+ }],
1840
+ security: [[{
1841
+ scheme: "CustomerJWT",
1842
+ kind: "bearer"
1843
+ }]],
1844
+ responseHeaders: [{
1845
+ name: "rate-limit-limit",
1846
+ key: "rateLimitLimit",
1847
+ type: "number"
1848
+ }, {
1849
+ name: "rate-limit-remaining",
1850
+ key: "rateLimitRemaining",
1851
+ type: "number"
1852
+ }]
1853
+ },
1854
+ StorefrontPostKycRequestBypass: {
1855
+ id: "StorefrontPostKycRequestBypass",
1856
+ method: "POST",
1857
+ path: "/storefront/transactions/{id}/{token}/bypass",
1858
+ tags: ["Storefront transactions"],
1859
+ params: [{
1860
+ name: "id",
1861
+ in: "path"
1862
+ }, {
1863
+ name: "token",
1864
+ in: "path"
1865
+ }],
1866
+ security: [[{
1867
+ scheme: "CustomerJWT",
1868
+ kind: "bearer"
1869
+ }]],
1870
+ responseHeaders: [{
1871
+ name: "rate-limit-limit",
1872
+ key: "rateLimitLimit",
1873
+ type: "number"
1874
+ }, {
1875
+ name: "rate-limit-remaining",
1876
+ key: "rateLimitRemaining",
1877
+ type: "number"
1878
+ }]
1879
+ },
1880
+ StorefrontGetWebsite: {
1881
+ id: "StorefrontGetWebsite",
1882
+ method: "GET",
1883
+ path: "/storefront/websites/{id}",
1884
+ tags: ["Storefront websites"],
1885
+ params: [{
1886
+ name: "id",
1887
+ in: "path"
1888
+ }],
1889
+ security: [[{
1890
+ scheme: "CustomerJWT",
1891
+ kind: "bearer"
1892
+ }], [{
1893
+ scheme: "PublishableApiKey",
1894
+ kind: "apiKey",
1895
+ name: "Authorization",
1896
+ in: "header"
1897
+ }]]
1898
+ }
1899
+ };
1900
+ var client = createClient(OPERATIONS, {
1901
+ serverUrl: "https://api-sandbox.rebilly.com/organizations/{organizationId}",
1902
+ clientHeader: "redocly-client-generator"
1903
+ });
1904
+ var { configure, use } = client;
1905
+ var { StorefrontGetAccount, StorefrontPatchAccount, StorefrontPostForgotPassword, StorefrontPatchAccountPassword, StorefrontPostAccountResendVerification, StorefrontPostResetPassword, StorefrontPostAccountVerification, StorefrontGetBillingPortal, StorefrontGetDepositStrategy, StorefrontGetDepositRequest, StorefrontGetCashier, StorefrontPostDeposit, StorefrontGetCheckoutForm, StorefrontGetCustomFieldCollection, StorefrontGetInvoiceCollection, StorefrontGetInvoice, StorefrontPatchInvoice, StorefrontGetOrderUpcomingInvoice, StorefrontPostKycDocument, StorefrontGetKycDocument, StorefrontPatchKycDocument, StorefrontGetKycRequest, StorefrontPostKycLivenessSession, StorefrontGetKycLivenessSession, StorefrontPostKycLivenessSessionFinish, StorefrontPostLogin, StorefrontPostLogout, StorefrontGetOrderCollection, StorefrontGetOrder, StorefrontPatchOrder, StorefrontPostOrderCancellation, StorefrontPostOrderPause, StorefrontPostSubscriptionItemsChange, StorefrontGetOrderChangeCollection, StorefrontDeleteOrderChange, StorefrontPostSubscriptionReactivation, StorefrontPostPayment, StorefrontGetPaymentInstrumentCollection, StorefrontPostPaymentInstrument, StorefrontGetPaymentInstrument, StorefrontPatchPaymentInstrument, StorefrontPostPaymentInstrumentDeactivation, StorefrontGetPaymentInstrumentSetup, StorefrontPostPaymentInstrumentSetup, StorefrontGetPayoutRequestCollection, StorefrontPostPayoutRequest, StorefrontGetPayoutRequest, StorefrontPatchPayoutRequest, StorefrontPostPayoutRequestCancellation, StorefrontGetPlanCollection, StorefrontGetPlan, StorefrontGetProductCollection, StorefrontGetProduct, StorefrontPostPurchase, StorefrontPostPreviewPurchase, StorefrontGetQuote, StorefrontPostQuoteAcceptance, StorefrontPostQuoteRejection, StorefrontPostReadyToPay, StorefrontPostReadyToPayout, StorefrontPostRegister, StorefrontPostSubscription, StorefrontGetTransactionCollection, StorefrontGetTransaction, StorefrontGetTransactionDccOffer, StorefrontPatchTransactionDccOffer, StorefrontPostKycRequestContinue, StorefrontPostKycRequestBypass, StorefrontGetWebsite } = client;
1906
+ //#endregion
1907
+ export { ApiError, OPERATIONS, TimeoutError, client, createClient, defaultRetryOn };