@openrails/billing-ui 0.241.0 → 0.243.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.
- package/CHANGELOG.md +27 -11
- package/README.md +41 -8
- package/dist/admin/billing-admin.d.ts +3 -0
- package/dist/admin/components/app-sidebar.d.ts +1 -0
- package/dist/admin/components/confirm.d.ts +4 -0
- package/dist/admin/components/cursor-pager.d.ts +8 -0
- package/dist/admin/components/data-table.d.ts +14 -0
- package/dist/admin/components/fact-card.d.ts +5 -0
- package/dist/admin/components/form-field-errors.d.ts +3 -0
- package/dist/admin/components/linked-table-row.d.ts +5 -0
- package/dist/admin/components/logo.d.ts +3 -0
- package/dist/admin/components/no-access.d.ts +3 -0
- package/dist/admin/components/no-merchants.d.ts +1 -0
- package/dist/admin/components/notification-bell.d.ts +2 -0
- package/dist/admin/components/route-error.d.ts +3 -0
- package/dist/admin/components/site-header.d.ts +9 -0
- package/dist/admin/components/status-badge.d.ts +3 -0
- package/dist/admin/components/typed-confirm-dialog.d.ts +11 -0
- package/dist/admin/components/ui/alert-dialog.d.ts +18 -0
- package/dist/admin/components/ui/avatar.d.ts +11 -0
- package/dist/admin/components/ui/badge.d.ts +7 -0
- package/dist/admin/components/ui/breadcrumb.d.ts +10 -0
- package/dist/admin/components/ui/button.d.ts +8 -0
- package/dist/admin/components/ui/card.d.ts +11 -0
- package/dist/admin/components/ui/chart.d.ts +44 -0
- package/dist/admin/components/ui/dialog.d.ts +17 -0
- package/dist/admin/components/ui/dropdown-menu.d.ts +29 -0
- package/dist/admin/components/ui/input.d.ts +3 -0
- package/dist/admin/components/ui/label.d.ts +3 -0
- package/dist/admin/components/ui/select.d.ts +15 -0
- package/dist/admin/components/ui/separator.d.ts +3 -0
- package/dist/admin/components/ui/sheet.d.ts +14 -0
- package/dist/admin/components/ui/sidebar.d.ts +63 -0
- package/dist/admin/components/ui/skeleton.d.ts +2 -0
- package/dist/admin/components/ui/sonner.d.ts +3 -0
- package/dist/admin/components/ui/switch.d.ts +5 -0
- package/dist/admin/components/ui/table.d.ts +10 -0
- package/dist/admin/components/ui/tabs.d.ts +10 -0
- package/dist/admin/components/ui/textarea.d.ts +3 -0
- package/dist/admin/components/ui/tooltip.d.ts +6 -0
- package/dist/admin/context.d.ts +1193 -0
- package/dist/admin/hooks/use-mobile.d.ts +1 -0
- package/dist/admin/index.d.ts +5 -0
- package/dist/admin/layouts/app-layout.d.ts +4 -0
- package/dist/admin/lib/api/client.d.ts +64 -0
- package/dist/admin/lib/api/copilot.d.ts +6 -0
- package/dist/admin/lib/api/credit-endpoints.d.ts +8 -0
- package/dist/admin/lib/api/credit-types.d.ts +9 -0
- package/dist/admin/lib/api/endpoints.d.ts +133 -0
- package/dist/admin/lib/api/index.d.ts +89 -0
- package/dist/admin/lib/api/invoice-profile-endpoints.d.ts +6 -0
- package/dist/admin/lib/api/metrics.d.ts +68 -0
- package/dist/admin/lib/api/order-endpoints.d.ts +21 -0
- package/dist/admin/lib/api/types.d.ts +122 -0
- package/dist/admin/lib/auth.d.ts +6 -0
- package/dist/admin/lib/capabilities.d.ts +13 -0
- package/dist/admin/lib/chunk-error.d.ts +1 -0
- package/dist/admin/lib/confirm.d.ts +11 -0
- package/dist/admin/lib/credit-queries.d.ts +23 -0
- package/dist/admin/lib/csv.d.ts +3 -0
- package/dist/admin/lib/cursor-pages.d.ts +13 -0
- package/dist/admin/lib/dialog-width.d.ts +6 -0
- package/dist/admin/lib/dom.d.ts +1 -0
- package/dist/admin/lib/duration.d.ts +3 -0
- package/dist/admin/lib/format.d.ts +23 -0
- package/dist/admin/lib/mount.d.ts +6 -0
- package/dist/admin/lib/mutations.d.ts +125 -0
- package/dist/admin/lib/order-queries.d.ts +29 -0
- package/dist/admin/lib/queries.d.ts +369 -0
- package/dist/admin/lib/query-client.d.ts +3 -0
- package/dist/admin/lib/toast.d.ts +10 -0
- package/dist/admin/lib/utils.d.ts +2 -0
- package/dist/admin/messages.d.ts +670 -0
- package/dist/admin/navigation.d.ts +14 -0
- package/dist/admin/pages/catalog/application-dialog.d.ts +2 -0
- package/dist/admin/pages/catalog/copilot-panel.d.ts +4 -0
- package/dist/admin/pages/catalog/index.d.ts +4 -0
- package/dist/admin/pages/catalog/meter-form.d.ts +6 -0
- package/dist/admin/pages/catalog/metering-model.d.ts +67 -0
- package/dist/admin/pages/catalog/metering.d.ts +3 -0
- package/dist/admin/pages/catalog/price-detail.d.ts +2 -0
- package/dist/admin/pages/catalog/price-format.d.ts +3 -0
- package/dist/admin/pages/catalog/price-wizard-logic.d.ts +20 -0
- package/dist/admin/pages/catalog/price-wizard.d.ts +10 -0
- package/dist/admin/pages/catalog/psp-links.d.ts +10 -0
- package/dist/admin/pages/catalog/rate-card-editor.d.ts +10 -0
- package/dist/admin/pages/customers/credit-form.d.ts +14 -0
- package/dist/admin/pages/customers/credits.d.ts +5 -0
- package/dist/admin/pages/customers/default-card-badges.d.ts +3 -0
- package/dist/admin/pages/customers/detail.d.ts +5 -0
- package/dist/admin/pages/customers/grant-duration.d.ts +32 -0
- package/dist/admin/pages/customers/index.d.ts +2 -0
- package/dist/admin/pages/customers/invoice-profile-model.d.ts +18 -0
- package/dist/admin/pages/customers/invoice-profile.d.ts +9 -0
- package/dist/admin/pages/dashboard/index.d.ts +2 -0
- package/dist/admin/pages/dashboard/lib.d.ts +48 -0
- package/dist/admin/pages/dashboard/range-picker.d.ts +1 -0
- package/dist/admin/pages/dashboard/range.d.ts +34 -0
- package/dist/admin/pages/dashboard/reports-model.d.ts +29 -0
- package/dist/admin/pages/dashboard/reports.d.ts +2 -0
- package/dist/admin/pages/dashboard/use-range.d.ts +5 -0
- package/dist/admin/pages/dashboard/widget-editor.d.ts +8 -0
- package/dist/admin/pages/dashboard/widget-tile.d.ts +9 -0
- package/dist/admin/pages/dashboard/widget-viz.d.ts +12 -0
- package/dist/admin/pages/ops/index.d.ts +2 -0
- package/dist/admin/pages/orders/detail.d.ts +5 -0
- package/dist/admin/pages/orders/index.d.ts +1 -0
- package/dist/admin/pages/orders/model.d.ts +7 -0
- package/dist/admin/pages/payments/attempts.d.ts +7 -0
- package/dist/admin/pages/payments/detail.d.ts +2 -0
- package/dist/admin/pages/payments/health-model.d.ts +149 -0
- package/dist/admin/pages/payments/health.d.ts +2 -0
- package/dist/admin/pages/payments/index.d.ts +2 -0
- package/dist/admin/pages/settings/configuration-edit.d.ts +9 -0
- package/dist/admin/pages/settings/index.d.ts +9 -0
- package/dist/admin/pages/settings/notifications.d.ts +2 -0
- package/dist/admin/pages/settings/setting-fields.d.ts +20 -0
- package/dist/admin/pages/subscriptions/change-subscription-dialog.d.ts +16 -0
- package/dist/admin/pages/subscriptions/detail.d.ts +2 -0
- package/dist/admin/pages/subscriptions/dunning.d.ts +2 -0
- package/dist/admin/pages/subscriptions/index.d.ts +2 -0
- package/dist/admin/pages/subscriptions/subscription-change-options.d.ts +23 -0
- package/dist/admin/pages/subscriptions/views.d.ts +15 -0
- package/dist/admin/router.d.ts +32 -0
- package/dist/admin/routes.d.ts +5 -0
- package/dist/admin/summary.d.ts +27 -0
- package/dist/admin/theme.d.ts +2 -0
- package/dist/admin/types.d.ts +56 -0
- package/dist/admin/ui-context.d.ts +14 -0
- package/dist/admin-attempts-lAoW-Urd.js +419 -0
- package/dist/admin-attempts-lAoW-Urd.js.map +1 -0
- package/dist/admin-auth-DQGHtt0j.js +14 -0
- package/dist/admin-auth-DQGHtt0j.js.map +1 -0
- package/dist/admin-badge-DR5-1qd8.js +31 -0
- package/dist/admin-badge-DR5-1qd8.js.map +1 -0
- package/dist/admin-button-CTL3DgOt.js +46 -0
- package/dist/admin-button-CTL3DgOt.js.map +1 -0
- package/dist/admin-capabilities-BuigAgtm.js +59 -0
- package/dist/admin-capabilities-BuigAgtm.js.map +1 -0
- package/dist/admin-card-bzAks3-3.js +51 -0
- package/dist/admin-card-bzAks3-3.js.map +1 -0
- package/dist/admin-catalog-CC7I4n0_.js +1189 -0
- package/dist/admin-catalog-CC7I4n0_.js.map +1 -0
- package/dist/admin-confirm-katGq0Qo.js +12 -0
- package/dist/admin-confirm-katGq0Qo.js.map +1 -0
- package/dist/admin-csv-CPoNZj2D.js +16 -0
- package/dist/admin-csv-CPoNZj2D.js.map +1 -0
- package/dist/admin-customers-D8u5gq3M.js +160 -0
- package/dist/admin-customers-D8u5gq3M.js.map +1 -0
- package/dist/admin-dashboard-DqqFjOzq.js +420 -0
- package/dist/admin-dashboard-DqqFjOzq.js.map +1 -0
- package/dist/admin-data-table-qfXLOFmN.js +96 -0
- package/dist/admin-data-table-qfXLOFmN.js.map +1 -0
- package/dist/admin-detail-5aNNvrc0.js +324 -0
- package/dist/admin-detail-5aNNvrc0.js.map +1 -0
- package/dist/admin-detail-7p684Uyc.js +342 -0
- package/dist/admin-detail-7p684Uyc.js.map +1 -0
- package/dist/admin-detail-CGOyqs7s.js +1312 -0
- package/dist/admin-detail-CGOyqs7s.js.map +1 -0
- package/dist/admin-detail-DUAJQg8G.js +710 -0
- package/dist/admin-detail-DUAJQg8G.js.map +1 -0
- package/dist/admin-dialog-BjuKI5Hp.js +88 -0
- package/dist/admin-dialog-BjuKI5Hp.js.map +1 -0
- package/dist/admin-dialog-width-BPrgdYlj.js +6 -0
- package/dist/admin-dialog-width-BPrgdYlj.js.map +1 -0
- package/dist/admin-dom-uMmZzRvU.js +149 -0
- package/dist/admin-dom-uMmZzRvU.js.map +1 -0
- package/dist/admin-dropdown-menu-BW1D_h6s.js +69 -0
- package/dist/admin-dropdown-menu-BW1D_h6s.js.map +1 -0
- package/dist/admin-dunning-B2zgtrOo.js +10 -0
- package/dist/admin-dunning-B2zgtrOo.js.map +1 -0
- package/dist/admin-fact-card-DO_fHosg.js +20 -0
- package/dist/admin-fact-card-DO_fHosg.js.map +1 -0
- package/dist/admin-form-field-errors-hbUMIriS.js +14 -0
- package/dist/admin-form-field-errors-hbUMIriS.js.map +1 -0
- package/dist/admin-format-DoohJ7Fg.js +136 -0
- package/dist/admin-format-DoohJ7Fg.js.map +1 -0
- package/dist/admin-health-B4jN2LwR.js +983 -0
- package/dist/admin-health-B4jN2LwR.js.map +1 -0
- package/dist/admin-input-CcfQfJFN.js +17 -0
- package/dist/admin-input-CcfQfJFN.js.map +1 -0
- package/dist/admin-invoice-profile-model-Cgjy3zV8.js +53 -0
- package/dist/admin-invoice-profile-model-Cgjy3zV8.js.map +1 -0
- package/dist/admin-label-BiEN5cjb.js +15 -0
- package/dist/admin-label-BiEN5cjb.js.map +1 -0
- package/dist/admin-linked-table-row-BsaUruCN.js +26 -0
- package/dist/admin-linked-table-row-BsaUruCN.js.map +1 -0
- package/dist/admin-metering-BGAXbT23.js +1702 -0
- package/dist/admin-metering-BGAXbT23.js.map +1 -0
- package/dist/admin-ops-B3mcr76u.js +217 -0
- package/dist/admin-ops-B3mcr76u.js.map +1 -0
- package/dist/admin-orders-dxC99Idl.js +192 -0
- package/dist/admin-orders-dxC99Idl.js.map +1 -0
- package/dist/admin-payments-Bs7HSfP0.js +246 -0
- package/dist/admin-payments-Bs7HSfP0.js.map +1 -0
- package/dist/admin-price-detail-DRquxpA9.js +482 -0
- package/dist/admin-price-detail-DRquxpA9.js.map +1 -0
- package/dist/admin-price-format-DM1qORWI.js +44 -0
- package/dist/admin-price-format-DM1qORWI.js.map +1 -0
- package/dist/admin-price-wizard-CI7K-2Nz.js +357 -0
- package/dist/admin-price-wizard-CI7K-2Nz.js.map +1 -0
- package/dist/admin-range-picker-Dr2M1EZr.js +192 -0
- package/dist/admin-range-picker-Dr2M1EZr.js.map +1 -0
- package/dist/admin-reports-CywKLiSA.js +320 -0
- package/dist/admin-reports-CywKLiSA.js.map +1 -0
- package/dist/admin-select-DBgprVW6.js +81 -0
- package/dist/admin-select-DBgprVW6.js.map +1 -0
- package/dist/admin-settings-Bmoy95uO.js +1434 -0
- package/dist/admin-settings-Bmoy95uO.js.map +1 -0
- package/dist/admin-skeleton-DsM7crYi.js +14 -0
- package/dist/admin-skeleton-DsM7crYi.js.map +1 -0
- package/dist/admin-status-badge-BFPgo71d.js +38 -0
- package/dist/admin-status-badge-BFPgo71d.js.map +1 -0
- package/dist/admin-subscriptions-CLYc_HEV.js +301 -0
- package/dist/admin-subscriptions-CLYc_HEV.js.map +1 -0
- package/dist/admin-switch-BJUxLCsa.js +20 -0
- package/dist/admin-switch-BJUxLCsa.js.map +1 -0
- package/dist/admin-table-CH9TrXJf.js +61 -0
- package/dist/admin-table-CH9TrXJf.js.map +1 -0
- package/dist/admin-tabs-528FJMjt.js +46 -0
- package/dist/admin-tabs-528FJMjt.js.map +1 -0
- package/dist/admin-textarea-DEz38RaI.js +15 -0
- package/dist/admin-textarea-DEz38RaI.js.map +1 -0
- package/dist/admin-typed-confirm-dialog-DU7m9-O7.js +66 -0
- package/dist/admin-typed-confirm-dialog-DU7m9-O7.js.map +1 -0
- package/dist/admin-utils-BK4Vh1o_.js +1809 -0
- package/dist/admin-utils-BK4Vh1o_.js.map +1 -0
- package/dist/admin-widget-viz-Da48c-Zf.js +581 -0
- package/dist/admin-widget-viz-Da48c-Zf.js.map +1 -0
- package/dist/admin.css +3 -0
- package/dist/admin.js +2164 -0
- package/dist/admin.js.map +1 -0
- package/dist/appearance.d.ts +1 -1
- package/dist/client/generated/error-codes.d.ts +1 -1
- package/dist/client/generated/routes.d.ts +2156 -189
- package/dist/client/generated/wire.d.ts +1265 -50
- package/dist/client/types.d.ts +0 -1
- package/dist/{client-Cxz_miQj.js → client-PjivPHmE.js} +2 -3
- package/dist/client-PjivPHmE.js.map +1 -0
- package/dist/client.js +1 -1
- package/dist/{hooks-aKefXeMO.js → hooks-Ckd8F2JF.js} +8 -8
- package/dist/hooks-Ckd8F2JF.js.map +1 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.js +12 -12
- package/dist/index.js.map +1 -1
- package/dist/lib/{offer-label.d.ts → price-label.d.ts} +1 -1
- package/dist/locales/de.js +1 -1
- package/dist/locales/de.js.map +1 -1
- package/dist/locales/en.d.ts +1 -1
- package/dist/locales/en.js +1 -1
- package/dist/locales/en.js.map +1 -1
- package/dist/locales/es.js +1 -1
- package/dist/locales/es.js.map +1 -1
- package/dist/locales/ja.js +1 -1
- package/dist/locales/ja.js.map +1 -1
- package/dist/locales/ko.js +1 -1
- package/dist/locales/ko.js.map +1 -1
- package/dist/locales/zh.js +1 -1
- package/dist/locales/zh.js.map +1 -1
- package/dist/{offers.d.ts → product-list.d.ts} +5 -5
- package/dist/react.js +1 -1
- package/dist/styles.css +1 -1
- package/package.json +28 -6
- package/dist/client-Cxz_miQj.js.map +0 -1
- package/dist/hooks-aKefXeMO.js.map +0 -1
|
@@ -9,6 +9,7 @@ export type OpenRailsRoute = {
|
|
|
9
9
|
} | null;
|
|
10
10
|
sensitive: boolean;
|
|
11
11
|
mountedWhen: string | null;
|
|
12
|
+
consoleOnly?: true;
|
|
12
13
|
request: string | null;
|
|
13
14
|
responses: Readonly<Record<number, string | null>>;
|
|
14
15
|
errors: readonly string[];
|
|
@@ -197,6 +198,126 @@ export declare const OPENRAILS_ROUTES: readonly [{
|
|
|
197
198
|
};
|
|
198
199
|
readonly errors: readonly ["invalid_param", "order_not_payable", "resource_conflict", "resource_not_found", "service_unavailable"];
|
|
199
200
|
readonly errorSets: readonly ["tier:public", "request"];
|
|
201
|
+
}, {
|
|
202
|
+
readonly method: "POST";
|
|
203
|
+
readonly path: "/v1/app/orders/preview";
|
|
204
|
+
readonly group: "app";
|
|
205
|
+
readonly auth: "application";
|
|
206
|
+
readonly permission: {
|
|
207
|
+
readonly merchant: "merchant:orders:manage";
|
|
208
|
+
readonly root: "root:orders:manage";
|
|
209
|
+
};
|
|
210
|
+
readonly sensitive: false;
|
|
211
|
+
readonly mountedWhen: null;
|
|
212
|
+
readonly request: "PreviewOrderParams";
|
|
213
|
+
readonly responses: {
|
|
214
|
+
readonly 200: "OrderPreview";
|
|
215
|
+
};
|
|
216
|
+
readonly errors: readonly ["already_owned", "invalid_param", "order_line_unavailable", "quantity_not_allowed", "resource_not_found", "service_unavailable"];
|
|
217
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
218
|
+
}, {
|
|
219
|
+
readonly method: "POST";
|
|
220
|
+
readonly path: "/v1/app/orders";
|
|
221
|
+
readonly group: "app";
|
|
222
|
+
readonly auth: "application";
|
|
223
|
+
readonly permission: {
|
|
224
|
+
readonly merchant: "merchant:orders:manage";
|
|
225
|
+
readonly root: "root:orders:manage";
|
|
226
|
+
};
|
|
227
|
+
readonly sensitive: false;
|
|
228
|
+
readonly mountedWhen: null;
|
|
229
|
+
readonly request: "CreateOrderParams";
|
|
230
|
+
readonly responses: {
|
|
231
|
+
readonly 200: "Order";
|
|
232
|
+
readonly 201: "Order";
|
|
233
|
+
};
|
|
234
|
+
readonly errors: readonly ["already_owned", "checkout_embed_origins_required", "idempotency_key_in_use", "idempotency_key_required", "idempotency_key_reused", "invalid_param", "order_line_unavailable", "quantity_not_allowed", "resource_not_found", "service_unavailable"];
|
|
235
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
236
|
+
}, {
|
|
237
|
+
readonly method: "POST";
|
|
238
|
+
readonly path: "/v1/app/orders/{id}/cancel";
|
|
239
|
+
readonly group: "app";
|
|
240
|
+
readonly auth: "application";
|
|
241
|
+
readonly permission: {
|
|
242
|
+
readonly merchant: "merchant:orders:manage";
|
|
243
|
+
readonly root: "root:orders:manage";
|
|
244
|
+
};
|
|
245
|
+
readonly sensitive: false;
|
|
246
|
+
readonly mountedWhen: null;
|
|
247
|
+
readonly request: null;
|
|
248
|
+
readonly responses: {
|
|
249
|
+
readonly 200: "Order";
|
|
250
|
+
};
|
|
251
|
+
readonly errors: readonly ["order_not_cancelable", "resource_not_found", "service_unavailable"];
|
|
252
|
+
readonly errorSets: readonly ["tier:application"];
|
|
253
|
+
}, {
|
|
254
|
+
readonly method: "GET";
|
|
255
|
+
readonly path: "/v1/admin/orders";
|
|
256
|
+
readonly group: "admin";
|
|
257
|
+
readonly auth: "merchant";
|
|
258
|
+
readonly permission: {
|
|
259
|
+
readonly merchant: "merchant:customer:read";
|
|
260
|
+
readonly root: "root:customer:read";
|
|
261
|
+
};
|
|
262
|
+
readonly sensitive: false;
|
|
263
|
+
readonly mountedWhen: null;
|
|
264
|
+
readonly request: null;
|
|
265
|
+
readonly responses: {
|
|
266
|
+
readonly 200: "ListPage<Order>";
|
|
267
|
+
};
|
|
268
|
+
readonly errors: readonly ["invalid_cursor", "invalid_query", "service_unavailable"];
|
|
269
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
270
|
+
}, {
|
|
271
|
+
readonly method: "GET";
|
|
272
|
+
readonly path: "/v1/admin/orders/{id}";
|
|
273
|
+
readonly group: "admin";
|
|
274
|
+
readonly auth: "merchant";
|
|
275
|
+
readonly permission: {
|
|
276
|
+
readonly merchant: "merchant:customer:read";
|
|
277
|
+
readonly root: "root:customer:read";
|
|
278
|
+
};
|
|
279
|
+
readonly sensitive: false;
|
|
280
|
+
readonly mountedWhen: null;
|
|
281
|
+
readonly request: null;
|
|
282
|
+
readonly responses: {
|
|
283
|
+
readonly 200: "Order";
|
|
284
|
+
};
|
|
285
|
+
readonly errors: readonly ["resource_not_found", "service_unavailable"];
|
|
286
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
287
|
+
}, {
|
|
288
|
+
readonly method: "POST";
|
|
289
|
+
readonly path: "/v1/admin/orders/{id}/waive-balance";
|
|
290
|
+
readonly group: "admin";
|
|
291
|
+
readonly auth: "merchant";
|
|
292
|
+
readonly permission: {
|
|
293
|
+
readonly merchant: "merchant:customer:manage";
|
|
294
|
+
readonly root: "root:customer:manage";
|
|
295
|
+
};
|
|
296
|
+
readonly sensitive: false;
|
|
297
|
+
readonly mountedWhen: null;
|
|
298
|
+
readonly request: null;
|
|
299
|
+
readonly responses: {
|
|
300
|
+
readonly 200: "Order";
|
|
301
|
+
};
|
|
302
|
+
readonly errors: readonly ["order_action_not_allowed", "resource_not_found", "service_unavailable"];
|
|
303
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
304
|
+
}, {
|
|
305
|
+
readonly method: "POST";
|
|
306
|
+
readonly path: "/v1/admin/orders/{id}/mark-uncollectible";
|
|
307
|
+
readonly group: "admin";
|
|
308
|
+
readonly auth: "merchant";
|
|
309
|
+
readonly permission: {
|
|
310
|
+
readonly merchant: "merchant:customer:manage";
|
|
311
|
+
readonly root: "root:customer:manage";
|
|
312
|
+
};
|
|
313
|
+
readonly sensitive: false;
|
|
314
|
+
readonly mountedWhen: null;
|
|
315
|
+
readonly request: null;
|
|
316
|
+
readonly responses: {
|
|
317
|
+
readonly 200: "Order";
|
|
318
|
+
};
|
|
319
|
+
readonly errors: readonly ["order_action_not_allowed", "resource_not_found", "service_unavailable"];
|
|
320
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
200
321
|
}, {
|
|
201
322
|
readonly method: "GET";
|
|
202
323
|
readonly path: "/v1/me/cart";
|
|
@@ -255,277 +376,482 @@ export declare const OPENRAILS_ROUTES: readonly [{
|
|
|
255
376
|
readonly errorSets: readonly ["tier:public", "request"];
|
|
256
377
|
}, {
|
|
257
378
|
readonly method: "POST";
|
|
258
|
-
readonly path: "/v1/
|
|
259
|
-
readonly group: "
|
|
260
|
-
readonly auth: "
|
|
261
|
-
readonly permission:
|
|
379
|
+
readonly path: "/v1/catalog/apply";
|
|
380
|
+
readonly group: "catalog";
|
|
381
|
+
readonly auth: "merchant";
|
|
382
|
+
readonly permission: {
|
|
383
|
+
readonly merchant: "merchant:catalog:manage";
|
|
384
|
+
readonly root: "root:catalog:manage";
|
|
385
|
+
};
|
|
262
386
|
readonly sensitive: false;
|
|
263
387
|
readonly mountedWhen: null;
|
|
264
|
-
readonly request: "
|
|
388
|
+
readonly request: "Application";
|
|
265
389
|
readonly responses: {
|
|
266
|
-
readonly 200: "
|
|
390
|
+
readonly 200: "CatalogApplicationReceipt";
|
|
267
391
|
};
|
|
268
|
-
readonly errors: readonly ["
|
|
269
|
-
readonly errorSets: readonly ["tier:
|
|
392
|
+
readonly errors: readonly ["catalog_benefit_overlap", "catalog_revision_conflict", "price_not_sellable", "product_not_found", "product_tier_group_conflict", "product_tier_group_in_use", "resource_conflict", "revision_mismatch"];
|
|
393
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
270
394
|
}, {
|
|
271
|
-
readonly method: "
|
|
272
|
-
readonly path: "/v1/
|
|
273
|
-
readonly group: "
|
|
274
|
-
readonly auth: "
|
|
275
|
-
readonly permission:
|
|
395
|
+
readonly method: "GET";
|
|
396
|
+
readonly path: "/v1/catalog/meters";
|
|
397
|
+
readonly group: "catalog";
|
|
398
|
+
readonly auth: "merchant";
|
|
399
|
+
readonly permission: {
|
|
400
|
+
readonly merchant: "merchant:catalog:read";
|
|
401
|
+
readonly root: "root:catalog:read";
|
|
402
|
+
};
|
|
276
403
|
readonly sensitive: false;
|
|
277
404
|
readonly mountedWhen: null;
|
|
278
405
|
readonly request: null;
|
|
279
406
|
readonly responses: {
|
|
280
|
-
readonly 200: "
|
|
407
|
+
readonly 200: "ListPage<Meter>";
|
|
281
408
|
};
|
|
282
|
-
readonly errors: readonly [
|
|
283
|
-
readonly errorSets: readonly ["tier:
|
|
409
|
+
readonly errors: readonly [];
|
|
410
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
411
|
+
}, {
|
|
412
|
+
readonly method: "GET";
|
|
413
|
+
readonly path: "/v1/catalog/meters/{key}";
|
|
414
|
+
readonly group: "catalog";
|
|
415
|
+
readonly auth: "merchant";
|
|
416
|
+
readonly permission: {
|
|
417
|
+
readonly merchant: "merchant:catalog:read";
|
|
418
|
+
readonly root: "root:catalog:read";
|
|
419
|
+
};
|
|
420
|
+
readonly sensitive: false;
|
|
421
|
+
readonly mountedWhen: null;
|
|
422
|
+
readonly request: null;
|
|
423
|
+
readonly responses: {
|
|
424
|
+
readonly 200: "Meter";
|
|
425
|
+
};
|
|
426
|
+
readonly errors: readonly ["default_rate_card_not_found", "meter_in_use", "meter_rate_card_conflict", "rate_card_product_not_found", "revision_mismatch", "usage_meter_invalid", "usage_meter_not_found", "usage_rate_card_invalid"];
|
|
427
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
284
428
|
}, {
|
|
285
429
|
readonly method: "PUT";
|
|
286
|
-
readonly path: "/v1/
|
|
287
|
-
readonly group: "
|
|
288
|
-
readonly auth: "
|
|
289
|
-
readonly permission:
|
|
430
|
+
readonly path: "/v1/catalog/meters/{key}";
|
|
431
|
+
readonly group: "catalog";
|
|
432
|
+
readonly auth: "merchant";
|
|
433
|
+
readonly permission: {
|
|
434
|
+
readonly merchant: "merchant:catalog:manage";
|
|
435
|
+
readonly root: "root:catalog:manage";
|
|
436
|
+
};
|
|
290
437
|
readonly sensitive: false;
|
|
291
438
|
readonly mountedWhen: null;
|
|
292
|
-
readonly request: "
|
|
439
|
+
readonly request: "SetMeterParams";
|
|
293
440
|
readonly responses: {
|
|
294
|
-
readonly 200: "
|
|
441
|
+
readonly 200: "Meter";
|
|
295
442
|
};
|
|
296
|
-
readonly errors: readonly ["
|
|
297
|
-
readonly errorSets: readonly ["tier:
|
|
443
|
+
readonly errors: readonly ["default_rate_card_not_found", "meter_in_use", "meter_rate_card_conflict", "rate_card_product_not_found", "revision_mismatch", "usage_meter_invalid", "usage_meter_not_found", "usage_rate_card_invalid"];
|
|
444
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
298
445
|
}, {
|
|
299
|
-
readonly method: "
|
|
300
|
-
readonly path: "/v1/
|
|
301
|
-
readonly group: "
|
|
302
|
-
readonly auth: "
|
|
303
|
-
readonly permission:
|
|
446
|
+
readonly method: "POST";
|
|
447
|
+
readonly path: "/v1/console/catalog/ask";
|
|
448
|
+
readonly group: "catalog";
|
|
449
|
+
readonly auth: "merchant";
|
|
450
|
+
readonly permission: {
|
|
451
|
+
readonly merchant: "merchant:catalog:read";
|
|
452
|
+
readonly root: "root:catalog:read";
|
|
453
|
+
};
|
|
454
|
+
readonly sensitive: false;
|
|
455
|
+
readonly mountedWhen: "catalog_copilot";
|
|
456
|
+
readonly consoleOnly: true;
|
|
457
|
+
readonly request: "AskCatalogParams";
|
|
458
|
+
readonly responses: {
|
|
459
|
+
readonly 200: "CatalogAnswer";
|
|
460
|
+
};
|
|
461
|
+
readonly errors: readonly ["invalid_param", "model_unavailable", "rate_limit_exceeded", "service_unavailable"];
|
|
462
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
463
|
+
}, {
|
|
464
|
+
readonly method: "POST";
|
|
465
|
+
readonly path: "/v1/catalog/products";
|
|
466
|
+
readonly group: "catalog";
|
|
467
|
+
readonly auth: "merchant";
|
|
468
|
+
readonly permission: {
|
|
469
|
+
readonly merchant: "merchant:catalog:manage";
|
|
470
|
+
readonly root: "root:catalog:manage";
|
|
471
|
+
};
|
|
304
472
|
readonly sensitive: false;
|
|
305
473
|
readonly mountedWhen: null;
|
|
306
|
-
readonly request:
|
|
474
|
+
readonly request: "CreateProductParams";
|
|
307
475
|
readonly responses: {
|
|
308
|
-
readonly
|
|
476
|
+
readonly 201: "Product";
|
|
309
477
|
};
|
|
310
|
-
readonly errors: readonly ["
|
|
311
|
-
readonly errorSets: readonly ["tier:
|
|
478
|
+
readonly errors: readonly ["catalog_benefit_overlap", "product_not_found", "product_tier_group_conflict", "product_tier_group_in_use", "resource_conflict", "revision_mismatch"];
|
|
479
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
312
480
|
}, {
|
|
313
481
|
readonly method: "GET";
|
|
314
|
-
readonly path: "/v1/
|
|
315
|
-
readonly group: "
|
|
316
|
-
readonly auth: "
|
|
317
|
-
readonly permission:
|
|
482
|
+
readonly path: "/v1/catalog/products";
|
|
483
|
+
readonly group: "catalog";
|
|
484
|
+
readonly auth: "merchant";
|
|
485
|
+
readonly permission: {
|
|
486
|
+
readonly merchant: "merchant:catalog:read";
|
|
487
|
+
readonly root: "root:catalog:read";
|
|
488
|
+
};
|
|
318
489
|
readonly sensitive: false;
|
|
319
490
|
readonly mountedWhen: null;
|
|
320
491
|
readonly request: null;
|
|
321
492
|
readonly responses: {
|
|
322
|
-
readonly 200: "
|
|
493
|
+
readonly 200: "ListPage<Product>";
|
|
323
494
|
};
|
|
324
|
-
readonly errors: readonly ["
|
|
325
|
-
readonly errorSets: readonly ["tier:
|
|
495
|
+
readonly errors: readonly ["catalog_benefit_overlap", "product_not_found", "product_tier_group_conflict", "product_tier_group_in_use", "resource_conflict", "revision_mismatch"];
|
|
496
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
326
497
|
}, {
|
|
327
|
-
readonly method: "
|
|
328
|
-
readonly path: "/v1/
|
|
329
|
-
readonly group: "
|
|
330
|
-
readonly auth: "
|
|
331
|
-
readonly permission:
|
|
498
|
+
readonly method: "GET";
|
|
499
|
+
readonly path: "/v1/catalog/products/{id}";
|
|
500
|
+
readonly group: "catalog";
|
|
501
|
+
readonly auth: "merchant";
|
|
502
|
+
readonly permission: {
|
|
503
|
+
readonly merchant: "merchant:catalog:read";
|
|
504
|
+
readonly root: "root:catalog:read";
|
|
505
|
+
};
|
|
332
506
|
readonly sensitive: false;
|
|
333
507
|
readonly mountedWhen: null;
|
|
334
|
-
readonly request:
|
|
508
|
+
readonly request: null;
|
|
335
509
|
readonly responses: {
|
|
336
|
-
readonly 200: "
|
|
337
|
-
readonly 202: "SubscriptionRetryNowResult";
|
|
510
|
+
readonly 200: "Product";
|
|
338
511
|
};
|
|
339
|
-
readonly errors: readonly ["
|
|
340
|
-
readonly errorSets: readonly ["tier:
|
|
512
|
+
readonly errors: readonly ["catalog_benefit_overlap", "product_not_found", "product_tier_group_conflict", "product_tier_group_in_use", "resource_conflict", "revision_mismatch"];
|
|
513
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
341
514
|
}, {
|
|
342
|
-
readonly method: "
|
|
343
|
-
readonly path: "/v1/
|
|
344
|
-
readonly group: "
|
|
345
|
-
readonly auth: "
|
|
346
|
-
readonly permission:
|
|
515
|
+
readonly method: "PATCH";
|
|
516
|
+
readonly path: "/v1/catalog/products/{id}";
|
|
517
|
+
readonly group: "catalog";
|
|
518
|
+
readonly auth: "merchant";
|
|
519
|
+
readonly permission: {
|
|
520
|
+
readonly merchant: "merchant:catalog:manage";
|
|
521
|
+
readonly root: "root:catalog:manage";
|
|
522
|
+
};
|
|
347
523
|
readonly sensitive: false;
|
|
348
524
|
readonly mountedWhen: null;
|
|
349
|
-
readonly request: "
|
|
525
|
+
readonly request: "UpdateProductParams";
|
|
350
526
|
readonly responses: {
|
|
351
|
-
readonly 200: "
|
|
352
|
-
readonly 202: "SubscriptionChange";
|
|
527
|
+
readonly 200: "Product";
|
|
353
528
|
};
|
|
354
|
-
readonly errors: readonly ["
|
|
355
|
-
readonly errorSets: readonly ["tier:
|
|
529
|
+
readonly errors: readonly ["catalog_benefit_overlap", "product_not_found", "product_tier_group_conflict", "product_tier_group_in_use", "resource_conflict", "revision_mismatch"];
|
|
530
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
356
531
|
}, {
|
|
357
|
-
readonly method: "
|
|
358
|
-
readonly path: "/v1/
|
|
359
|
-
readonly group: "
|
|
360
|
-
readonly auth: "
|
|
361
|
-
readonly permission:
|
|
532
|
+
readonly method: "DELETE";
|
|
533
|
+
readonly path: "/v1/catalog/products/{id}";
|
|
534
|
+
readonly group: "catalog";
|
|
535
|
+
readonly auth: "merchant";
|
|
536
|
+
readonly permission: {
|
|
537
|
+
readonly merchant: "merchant:catalog:manage";
|
|
538
|
+
readonly root: "root:catalog:manage";
|
|
539
|
+
};
|
|
362
540
|
readonly sensitive: false;
|
|
363
541
|
readonly mountedWhen: null;
|
|
364
542
|
readonly request: null;
|
|
365
543
|
readonly responses: {
|
|
366
|
-
readonly
|
|
367
|
-
readonly 202: "SubscriptionChange";
|
|
544
|
+
readonly 204: null;
|
|
368
545
|
};
|
|
369
|
-
readonly errors: readonly ["
|
|
370
|
-
readonly errorSets: readonly ["tier:
|
|
546
|
+
readonly errors: readonly ["product_in_use", "product_not_found"];
|
|
547
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
371
548
|
}, {
|
|
372
549
|
readonly method: "POST";
|
|
373
|
-
readonly path: "/v1/
|
|
374
|
-
readonly group: "
|
|
375
|
-
readonly auth: "
|
|
376
|
-
readonly permission:
|
|
550
|
+
readonly path: "/v1/catalog/prices";
|
|
551
|
+
readonly group: "catalog";
|
|
552
|
+
readonly auth: "merchant";
|
|
553
|
+
readonly permission: {
|
|
554
|
+
readonly merchant: "merchant:catalog:manage";
|
|
555
|
+
readonly root: "root:catalog:manage";
|
|
556
|
+
};
|
|
377
557
|
readonly sensitive: false;
|
|
378
558
|
readonly mountedWhen: null;
|
|
379
|
-
readonly request: "
|
|
559
|
+
readonly request: "CreatePriceParams";
|
|
380
560
|
readonly responses: {
|
|
381
|
-
readonly
|
|
561
|
+
readonly 201: "Price";
|
|
382
562
|
};
|
|
383
|
-
readonly errors: readonly ["
|
|
384
|
-
readonly errorSets: readonly ["tier:
|
|
563
|
+
readonly errors: readonly ["catalog_benefit_overlap", "price_key_cadence_conflict", "price_key_not_found", "price_not_found", "product_not_found", "resource_conflict", "revision_mismatch", "trial_unsupported_on_rail"];
|
|
564
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
385
565
|
}, {
|
|
386
566
|
readonly method: "GET";
|
|
387
|
-
readonly path: "/v1/
|
|
388
|
-
readonly group: "
|
|
389
|
-
readonly auth: "
|
|
390
|
-
readonly permission:
|
|
567
|
+
readonly path: "/v1/catalog/prices";
|
|
568
|
+
readonly group: "catalog";
|
|
569
|
+
readonly auth: "merchant";
|
|
570
|
+
readonly permission: {
|
|
571
|
+
readonly merchant: "merchant:catalog:read";
|
|
572
|
+
readonly root: "root:catalog:read";
|
|
573
|
+
};
|
|
391
574
|
readonly sensitive: false;
|
|
392
575
|
readonly mountedWhen: null;
|
|
393
576
|
readonly request: null;
|
|
394
577
|
readonly responses: {
|
|
395
|
-
readonly 200: "ListPage<
|
|
578
|
+
readonly 200: "ListPage<Price>";
|
|
396
579
|
};
|
|
397
|
-
readonly errors: readonly ["
|
|
398
|
-
readonly errorSets: readonly ["tier:
|
|
580
|
+
readonly errors: readonly ["catalog_benefit_overlap", "price_key_cadence_conflict", "price_key_not_found", "price_not_found", "product_not_found", "resource_conflict", "revision_mismatch", "trial_unsupported_on_rail"];
|
|
581
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
399
582
|
}, {
|
|
400
583
|
readonly method: "GET";
|
|
401
|
-
readonly path: "/v1/
|
|
402
|
-
readonly group: "
|
|
403
|
-
readonly auth: "
|
|
404
|
-
readonly permission:
|
|
584
|
+
readonly path: "/v1/catalog/prices/{id}";
|
|
585
|
+
readonly group: "catalog";
|
|
586
|
+
readonly auth: "merchant";
|
|
587
|
+
readonly permission: {
|
|
588
|
+
readonly merchant: "merchant:catalog:read";
|
|
589
|
+
readonly root: "root:catalog:read";
|
|
590
|
+
};
|
|
405
591
|
readonly sensitive: false;
|
|
406
592
|
readonly mountedWhen: null;
|
|
407
593
|
readonly request: null;
|
|
408
594
|
readonly responses: {
|
|
409
|
-
readonly 200: "
|
|
595
|
+
readonly 200: "Price";
|
|
410
596
|
};
|
|
411
|
-
readonly errors: readonly [];
|
|
412
|
-
readonly errorSets: readonly ["tier:
|
|
597
|
+
readonly errors: readonly ["catalog_benefit_overlap", "price_key_cadence_conflict", "price_key_not_found", "price_not_found", "product_not_found", "resource_conflict", "revision_mismatch", "trial_unsupported_on_rail"];
|
|
598
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
413
599
|
}, {
|
|
414
600
|
readonly method: "GET";
|
|
415
|
-
readonly path: "/v1/
|
|
416
|
-
readonly group: "
|
|
417
|
-
readonly auth: "
|
|
418
|
-
readonly permission:
|
|
601
|
+
readonly path: "/v1/catalog/prices/{id}/history";
|
|
602
|
+
readonly group: "catalog";
|
|
603
|
+
readonly auth: "merchant";
|
|
604
|
+
readonly permission: {
|
|
605
|
+
readonly merchant: "merchant:catalog:read";
|
|
606
|
+
readonly root: "root:catalog:read";
|
|
607
|
+
};
|
|
419
608
|
readonly sensitive: false;
|
|
420
609
|
readonly mountedWhen: null;
|
|
421
610
|
readonly request: null;
|
|
422
611
|
readonly responses: {
|
|
423
|
-
readonly 200: "ListPage<
|
|
612
|
+
readonly 200: "ListPage<PriceKeyMovement>";
|
|
424
613
|
};
|
|
425
|
-
readonly errors: readonly ["
|
|
426
|
-
readonly errorSets: readonly ["tier:
|
|
614
|
+
readonly errors: readonly ["catalog_benefit_overlap", "price_key_cadence_conflict", "price_key_not_found", "price_not_found", "product_not_found", "resource_conflict", "revision_mismatch", "trial_unsupported_on_rail"];
|
|
615
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
616
|
+
}, {
|
|
617
|
+
readonly method: "PATCH";
|
|
618
|
+
readonly path: "/v1/catalog/prices/{id}";
|
|
619
|
+
readonly group: "catalog";
|
|
620
|
+
readonly auth: "merchant";
|
|
621
|
+
readonly permission: {
|
|
622
|
+
readonly merchant: "merchant:catalog:manage";
|
|
623
|
+
readonly root: "root:catalog:manage";
|
|
624
|
+
};
|
|
625
|
+
readonly sensitive: false;
|
|
626
|
+
readonly mountedWhen: null;
|
|
627
|
+
readonly request: "UpdatePriceParams";
|
|
628
|
+
readonly responses: {
|
|
629
|
+
readonly 200: "Price";
|
|
630
|
+
};
|
|
631
|
+
readonly errors: readonly ["catalog_benefit_overlap", "price_key_cadence_conflict", "price_key_not_found", "price_not_found", "product_not_found", "resource_conflict", "revision_mismatch", "trial_unsupported_on_rail"];
|
|
632
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
427
633
|
}, {
|
|
428
634
|
readonly method: "GET";
|
|
429
|
-
readonly path: "/v1/
|
|
430
|
-
readonly group: "
|
|
431
|
-
readonly auth: "
|
|
432
|
-
readonly permission:
|
|
635
|
+
readonly path: "/v1/admin/subscriptions";
|
|
636
|
+
readonly group: "admin";
|
|
637
|
+
readonly auth: "merchant";
|
|
638
|
+
readonly permission: {
|
|
639
|
+
readonly merchant: "merchant:customer:read";
|
|
640
|
+
readonly root: "root:customer:read";
|
|
641
|
+
};
|
|
433
642
|
readonly sensitive: false;
|
|
434
643
|
readonly mountedWhen: null;
|
|
435
644
|
readonly request: null;
|
|
436
645
|
readonly responses: {
|
|
437
|
-
readonly 200: "
|
|
646
|
+
readonly 200: "ListPage<Subscription>";
|
|
438
647
|
};
|
|
439
|
-
readonly errors: readonly ["
|
|
440
|
-
readonly errorSets: readonly ["tier:
|
|
648
|
+
readonly errors: readonly ["invalid_cursor", "invalid_param", "invalid_query"];
|
|
649
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
441
650
|
}, {
|
|
442
651
|
readonly method: "GET";
|
|
443
|
-
readonly path: "/v1/
|
|
444
|
-
readonly group: "
|
|
445
|
-
readonly auth: "
|
|
446
|
-
readonly permission:
|
|
652
|
+
readonly path: "/v1/admin/subscriptions/{id}";
|
|
653
|
+
readonly group: "admin";
|
|
654
|
+
readonly auth: "merchant";
|
|
655
|
+
readonly permission: {
|
|
656
|
+
readonly merchant: "merchant:customer:read";
|
|
657
|
+
readonly root: "root:customer:read";
|
|
658
|
+
};
|
|
447
659
|
readonly sensitive: false;
|
|
448
660
|
readonly mountedWhen: null;
|
|
449
661
|
readonly request: null;
|
|
450
662
|
readonly responses: {
|
|
451
|
-
readonly 200: "
|
|
663
|
+
readonly 200: "Subscription";
|
|
452
664
|
};
|
|
453
|
-
readonly errors: readonly ["
|
|
454
|
-
readonly errorSets: readonly ["tier:
|
|
665
|
+
readonly errors: readonly ["invalid_param", "subscription_not_found"];
|
|
666
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
455
667
|
}, {
|
|
456
|
-
readonly method: "
|
|
457
|
-
readonly path: "/v1/
|
|
458
|
-
readonly group: "
|
|
459
|
-
readonly auth: "
|
|
460
|
-
readonly permission:
|
|
668
|
+
readonly method: "POST";
|
|
669
|
+
readonly path: "/v1/admin/subscriptions/{id}/cancel";
|
|
670
|
+
readonly group: "admin";
|
|
671
|
+
readonly auth: "merchant";
|
|
672
|
+
readonly permission: {
|
|
673
|
+
readonly merchant: "merchant:customer:manage";
|
|
674
|
+
readonly root: "root:customer:manage";
|
|
675
|
+
};
|
|
461
676
|
readonly sensitive: false;
|
|
462
677
|
readonly mountedWhen: null;
|
|
463
|
-
readonly request: "
|
|
678
|
+
readonly request: "CancelSubscriptionParams";
|
|
464
679
|
readonly responses: {
|
|
465
|
-
readonly 200: "
|
|
680
|
+
readonly 200: "Subscription";
|
|
466
681
|
};
|
|
467
|
-
readonly errors: readonly ["
|
|
468
|
-
readonly errorSets: readonly ["tier:
|
|
682
|
+
readonly errors: readonly ["cancel_unsupported_on_rail", "customer_action_required", "invalid_param", "payment_in_progress", "provider_cancel_held", "resource_conflict", "subscription_not_active", "subscription_not_found"];
|
|
683
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
469
684
|
}, {
|
|
470
|
-
readonly method: "
|
|
471
|
-
readonly path: "/v1/
|
|
472
|
-
readonly group: "
|
|
473
|
-
readonly auth: "
|
|
474
|
-
readonly permission:
|
|
685
|
+
readonly method: "POST";
|
|
686
|
+
readonly path: "/v1/admin/subscriptions/{id}/resume";
|
|
687
|
+
readonly group: "admin";
|
|
688
|
+
readonly auth: "merchant";
|
|
689
|
+
readonly permission: {
|
|
690
|
+
readonly merchant: "merchant:customer:manage";
|
|
691
|
+
readonly root: "root:customer:manage";
|
|
692
|
+
};
|
|
475
693
|
readonly sensitive: false;
|
|
476
694
|
readonly mountedWhen: null;
|
|
477
695
|
readonly request: null;
|
|
478
696
|
readonly responses: {
|
|
479
|
-
readonly 200: "
|
|
697
|
+
readonly 200: "Subscription";
|
|
480
698
|
};
|
|
481
|
-
readonly errors: readonly ["
|
|
482
|
-
readonly errorSets: readonly ["tier:
|
|
699
|
+
readonly errors: readonly ["invalid_param", "subscription_not_found"];
|
|
700
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
483
701
|
}, {
|
|
484
702
|
readonly method: "POST";
|
|
485
|
-
readonly path: "/v1/
|
|
486
|
-
readonly group: "
|
|
487
|
-
readonly auth: "
|
|
488
|
-
readonly permission:
|
|
703
|
+
readonly path: "/v1/admin/subscriptions/{id}/change";
|
|
704
|
+
readonly group: "admin";
|
|
705
|
+
readonly auth: "merchant";
|
|
706
|
+
readonly permission: {
|
|
707
|
+
readonly merchant: "merchant:customer:manage";
|
|
708
|
+
readonly root: "root:customer:manage";
|
|
709
|
+
};
|
|
489
710
|
readonly sensitive: false;
|
|
490
711
|
readonly mountedWhen: null;
|
|
491
|
-
readonly request: "
|
|
712
|
+
readonly request: "ChangeSubscriptionParams";
|
|
492
713
|
readonly responses: {
|
|
493
|
-
readonly
|
|
714
|
+
readonly 200: "SubscriptionChange";
|
|
715
|
+
readonly 202: "SubscriptionChange";
|
|
494
716
|
};
|
|
495
|
-
readonly errors: readonly ["
|
|
496
|
-
readonly errorSets: readonly ["tier:
|
|
717
|
+
readonly errors: readonly ["card_declined", "customer_action_required", "customer_email_required", "invalid_param", "payment_duplicate_refused", "payment_method_stale", "payment_provider_rejected", "price_change_currency_mismatch", "price_not_found", "product_not_found", "quantity_not_allowed", "rebill_terms_committed", "resource_conflict", "resource_not_found", "scheduled_change_exists", "service_unavailable", "stored_credential_required", "subscription_change_already_scheduled", "subscription_change_credit_exceeds_price", "subscription_change_cycle_unknown", "subscription_change_idempotency_conflict", "subscription_change_idempotency_key_required", "subscription_change_in_flight", "subscription_change_period_unknown", "subscription_change_provider_conflict", "subscription_change_refused", "subscription_change_renewal_due", "subscription_change_requires_linked_plan", "subscription_change_target_inactive", "subscription_change_unsupported_on_rail", "subscription_not_active", "subscription_not_found"];
|
|
718
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
497
719
|
}, {
|
|
498
|
-
readonly method: "
|
|
499
|
-
readonly path: "/v1/
|
|
500
|
-
readonly group: "
|
|
501
|
-
readonly auth: "
|
|
502
|
-
readonly permission:
|
|
720
|
+
readonly method: "POST";
|
|
721
|
+
readonly path: "/v1/admin/subscriptions/{id}/change/preview";
|
|
722
|
+
readonly group: "admin";
|
|
723
|
+
readonly auth: "merchant";
|
|
724
|
+
readonly permission: {
|
|
725
|
+
readonly merchant: "merchant:customer:read";
|
|
726
|
+
readonly root: "root:customer:read";
|
|
727
|
+
};
|
|
503
728
|
readonly sensitive: false;
|
|
504
729
|
readonly mountedWhen: null;
|
|
505
|
-
readonly request: "
|
|
730
|
+
readonly request: "ChangeSubscriptionParams";
|
|
506
731
|
readonly responses: {
|
|
507
|
-
readonly 200: "
|
|
732
|
+
readonly 200: "SubscriptionChangePreview";
|
|
508
733
|
};
|
|
509
|
-
readonly errors: readonly ["
|
|
510
|
-
readonly errorSets: readonly ["tier:
|
|
734
|
+
readonly errors: readonly ["card_declined", "customer_action_required", "customer_email_required", "invalid_param", "payment_method_stale", "payment_provider_rejected", "price_change_currency_mismatch", "price_not_found", "product_not_found", "quantity_not_allowed", "resource_conflict", "resource_not_found", "service_unavailable", "subscription_change_already_scheduled", "subscription_change_credit_exceeds_price", "subscription_change_cycle_unknown", "subscription_change_in_flight", "subscription_change_period_unknown", "subscription_change_provider_conflict", "subscription_change_renewal_due", "subscription_change_requires_linked_plan", "subscription_change_target_inactive", "subscription_change_unsupported_on_rail", "subscription_not_active", "subscription_not_found"];
|
|
735
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
511
736
|
}, {
|
|
512
|
-
readonly method: "
|
|
513
|
-
readonly path: "/v1/
|
|
737
|
+
readonly method: "PUT";
|
|
738
|
+
readonly path: "/v1/admin/subscriptions/{id}/payment-method";
|
|
739
|
+
readonly group: "admin";
|
|
740
|
+
readonly auth: "merchant";
|
|
741
|
+
readonly permission: {
|
|
742
|
+
readonly merchant: "merchant:customer:manage";
|
|
743
|
+
readonly root: "root:customer:manage";
|
|
744
|
+
};
|
|
745
|
+
readonly sensitive: false;
|
|
746
|
+
readonly mountedWhen: null;
|
|
747
|
+
readonly request: "SetSubscriptionPaymentMethodParams";
|
|
748
|
+
readonly responses: {
|
|
749
|
+
readonly 200: "Subscription";
|
|
750
|
+
};
|
|
751
|
+
readonly errors: readonly ["card_declined", "default_payment_method_required", "invalid_param", "payment_method_not_psp_vaulted", "payment_method_psp_mismatch", "payment_method_same_vault", "payment_method_stale", "payment_provider_rejected", "rebill_terms_committed", "resource_conflict", "resource_not_found", "service_unavailable"];
|
|
752
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
753
|
+
}, {
|
|
754
|
+
readonly method: "POST";
|
|
755
|
+
readonly path: "/v1/catalog/price-migrations";
|
|
756
|
+
readonly group: "catalog";
|
|
757
|
+
readonly auth: "merchant";
|
|
758
|
+
readonly permission: {
|
|
759
|
+
readonly merchant: "merchant:catalog:manage";
|
|
760
|
+
readonly root: "root:catalog:manage";
|
|
761
|
+
};
|
|
762
|
+
readonly sensitive: false;
|
|
763
|
+
readonly mountedWhen: null;
|
|
764
|
+
readonly request: "CreatePriceMigrationParams";
|
|
765
|
+
readonly responses: {
|
|
766
|
+
readonly 201: "PriceMigration";
|
|
767
|
+
};
|
|
768
|
+
readonly errors: readonly ["invalid_param", "price_change_currency_mismatch", "price_change_target_archived", "price_key_not_found", "price_not_found", "product_not_found"];
|
|
769
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
770
|
+
}, {
|
|
771
|
+
readonly method: "POST";
|
|
772
|
+
readonly path: "/v1/catalog/price-migrations/preview";
|
|
773
|
+
readonly group: "catalog";
|
|
774
|
+
readonly auth: "merchant";
|
|
775
|
+
readonly permission: {
|
|
776
|
+
readonly merchant: "merchant:catalog:read";
|
|
777
|
+
readonly root: "root:catalog:read";
|
|
778
|
+
};
|
|
779
|
+
readonly sensitive: false;
|
|
780
|
+
readonly mountedWhen: null;
|
|
781
|
+
readonly request: "CreatePriceMigrationParams";
|
|
782
|
+
readonly responses: {
|
|
783
|
+
readonly 200: "PriceMigrationPreview";
|
|
784
|
+
};
|
|
785
|
+
readonly errors: readonly ["invalid_param", "price_change_currency_mismatch", "price_change_target_archived", "price_key_not_found", "price_not_found", "product_not_found"];
|
|
786
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
787
|
+
}, {
|
|
788
|
+
readonly method: "GET";
|
|
789
|
+
readonly path: "/v1/catalog/price-migrations";
|
|
790
|
+
readonly group: "catalog";
|
|
791
|
+
readonly auth: "merchant";
|
|
792
|
+
readonly permission: {
|
|
793
|
+
readonly merchant: "merchant:catalog:read";
|
|
794
|
+
readonly root: "root:catalog:read";
|
|
795
|
+
};
|
|
796
|
+
readonly sensitive: false;
|
|
797
|
+
readonly mountedWhen: null;
|
|
798
|
+
readonly request: null;
|
|
799
|
+
readonly responses: {
|
|
800
|
+
readonly 200: "ListPage<PriceMigration>";
|
|
801
|
+
};
|
|
802
|
+
readonly errors: readonly ["invalid_cursor", "invalid_param", "invalid_query"];
|
|
803
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
804
|
+
}, {
|
|
805
|
+
readonly method: "GET";
|
|
806
|
+
readonly path: "/v1/catalog/price-migrations/{id}";
|
|
807
|
+
readonly group: "catalog";
|
|
808
|
+
readonly auth: "merchant";
|
|
809
|
+
readonly permission: {
|
|
810
|
+
readonly merchant: "merchant:catalog:read";
|
|
811
|
+
readonly root: "root:catalog:read";
|
|
812
|
+
};
|
|
813
|
+
readonly sensitive: false;
|
|
814
|
+
readonly mountedWhen: null;
|
|
815
|
+
readonly request: null;
|
|
816
|
+
readonly responses: {
|
|
817
|
+
readonly 200: "PriceMigration";
|
|
818
|
+
};
|
|
819
|
+
readonly errors: readonly ["invalid_param", "price_migration_not_found"];
|
|
820
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
821
|
+
}, {
|
|
822
|
+
readonly method: "POST";
|
|
823
|
+
readonly path: "/v1/catalog/price-migrations/{id}/cancel";
|
|
824
|
+
readonly group: "catalog";
|
|
825
|
+
readonly auth: "merchant";
|
|
826
|
+
readonly permission: {
|
|
827
|
+
readonly merchant: "merchant:catalog:manage";
|
|
828
|
+
readonly root: "root:catalog:manage";
|
|
829
|
+
};
|
|
830
|
+
readonly sensitive: false;
|
|
831
|
+
readonly mountedWhen: null;
|
|
832
|
+
readonly request: null;
|
|
833
|
+
readonly responses: {
|
|
834
|
+
readonly 200: "PriceMigrationCancel";
|
|
835
|
+
};
|
|
836
|
+
readonly errors: readonly ["invalid_param", "price_migration_not_found", "rebill_terms_committed"];
|
|
837
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
838
|
+
}, {
|
|
839
|
+
readonly method: "POST";
|
|
840
|
+
readonly path: "/v1/me/subscriptions/{id}/cancel";
|
|
514
841
|
readonly group: "customer";
|
|
515
842
|
readonly auth: "customer";
|
|
516
843
|
readonly permission: null;
|
|
517
844
|
readonly sensitive: false;
|
|
518
845
|
readonly mountedWhen: null;
|
|
519
|
-
readonly request:
|
|
846
|
+
readonly request: "CustomerCancelSubscriptionParams";
|
|
520
847
|
readonly responses: {
|
|
521
|
-
readonly
|
|
522
|
-
readonly 204: null;
|
|
848
|
+
readonly 200: "Subscription";
|
|
523
849
|
};
|
|
524
|
-
readonly errors: readonly ["invalid_param", "
|
|
525
|
-
readonly errorSets: readonly ["tier:customer"];
|
|
850
|
+
readonly errors: readonly ["authentication_required", "cancel_unsupported_on_rail", "invalid_param", "payment_in_progress", "provider_cancel_held", "service_unavailable", "solana_rpc_unavailable", "solana_transaction_refused", "subscription_not_active", "subscription_not_found"];
|
|
851
|
+
readonly errorSets: readonly ["tier:customer", "request"];
|
|
526
852
|
}, {
|
|
527
853
|
readonly method: "POST";
|
|
528
|
-
readonly path: "/v1/me/
|
|
854
|
+
readonly path: "/v1/me/subscriptions/{id}/resume";
|
|
529
855
|
readonly group: "customer";
|
|
530
856
|
readonly auth: "customer";
|
|
531
857
|
readonly permission: null;
|
|
@@ -533,27 +859,27 @@ export declare const OPENRAILS_ROUTES: readonly [{
|
|
|
533
859
|
readonly mountedWhen: null;
|
|
534
860
|
readonly request: null;
|
|
535
861
|
readonly responses: {
|
|
536
|
-
readonly 200: "
|
|
862
|
+
readonly 200: "Subscription";
|
|
537
863
|
};
|
|
538
|
-
readonly errors: readonly ["
|
|
864
|
+
readonly errors: readonly ["authentication_required", "invalid_param", "service_unavailable", "subscription_not_found"];
|
|
539
865
|
readonly errorSets: readonly ["tier:customer"];
|
|
540
866
|
}, {
|
|
541
|
-
readonly method: "
|
|
542
|
-
readonly path: "/v1/me/
|
|
867
|
+
readonly method: "PUT";
|
|
868
|
+
readonly path: "/v1/me/subscriptions/{id}/payment-method";
|
|
543
869
|
readonly group: "customer";
|
|
544
870
|
readonly auth: "customer";
|
|
545
871
|
readonly permission: null;
|
|
546
872
|
readonly sensitive: false;
|
|
547
|
-
readonly mountedWhen:
|
|
548
|
-
readonly request:
|
|
873
|
+
readonly mountedWhen: null;
|
|
874
|
+
readonly request: "SetSubscriptionPaymentMethodParams";
|
|
549
875
|
readonly responses: {
|
|
550
|
-
readonly 200: "
|
|
876
|
+
readonly 200: "Subscription";
|
|
551
877
|
};
|
|
552
|
-
readonly errors: readonly ["invalid_param", "resource_not_found", "
|
|
553
|
-
readonly errorSets: readonly ["tier:customer"];
|
|
878
|
+
readonly errors: readonly ["authentication_required", "card_declined", "default_payment_method_required", "invalid_param", "payment_method_not_psp_vaulted", "payment_method_psp_mismatch", "payment_method_same_vault", "payment_method_stale", "payment_provider_rejected", "rebill_terms_committed", "resource_conflict", "resource_not_found", "service_unavailable"];
|
|
879
|
+
readonly errorSets: readonly ["tier:customer", "request"];
|
|
554
880
|
}, {
|
|
555
881
|
readonly method: "GET";
|
|
556
|
-
readonly path: "/v1/me/
|
|
882
|
+
readonly path: "/v1/me/subscriptions";
|
|
557
883
|
readonly group: "customer";
|
|
558
884
|
readonly auth: "customer";
|
|
559
885
|
readonly permission: null;
|
|
@@ -561,13 +887,13 @@ export declare const OPENRAILS_ROUTES: readonly [{
|
|
|
561
887
|
readonly mountedWhen: null;
|
|
562
888
|
readonly request: null;
|
|
563
889
|
readonly responses: {
|
|
564
|
-
readonly 200: "ListPage<
|
|
890
|
+
readonly 200: "ListPage<Subscription>";
|
|
565
891
|
};
|
|
566
|
-
readonly errors: readonly ["invalid_cursor"];
|
|
892
|
+
readonly errors: readonly ["authentication_required", "invalid_cursor", "invalid_query"];
|
|
567
893
|
readonly errorSets: readonly ["tier:customer", "request"];
|
|
568
894
|
}, {
|
|
569
|
-
readonly method: "
|
|
570
|
-
readonly path: "/v1/me/
|
|
895
|
+
readonly method: "GET";
|
|
896
|
+
readonly path: "/v1/me/subscriptions/{id}";
|
|
571
897
|
readonly group: "customer";
|
|
572
898
|
readonly auth: "customer";
|
|
573
899
|
readonly permission: null;
|
|
@@ -575,67 +901,1708 @@ export declare const OPENRAILS_ROUTES: readonly [{
|
|
|
575
901
|
readonly mountedWhen: null;
|
|
576
902
|
readonly request: null;
|
|
577
903
|
readonly responses: {
|
|
578
|
-
readonly 200: "
|
|
904
|
+
readonly 200: "Subscription";
|
|
579
905
|
};
|
|
580
|
-
readonly errors: readonly ["
|
|
906
|
+
readonly errors: readonly ["authentication_required", "invalid_param", "resource_not_found", "subscription_not_found"];
|
|
581
907
|
readonly errorSets: readonly ["tier:customer"];
|
|
582
908
|
}, {
|
|
583
|
-
readonly method: "
|
|
584
|
-
readonly path: "/v1/me/
|
|
909
|
+
readonly method: "POST";
|
|
910
|
+
readonly path: "/v1/me/subscriptions/{id}/retry-now";
|
|
585
911
|
readonly group: "customer";
|
|
586
912
|
readonly auth: "customer";
|
|
587
913
|
readonly permission: null;
|
|
588
914
|
readonly sensitive: false;
|
|
589
915
|
readonly mountedWhen: null;
|
|
590
|
-
readonly request:
|
|
916
|
+
readonly request: "RetrySubscriptionNowParams";
|
|
591
917
|
readonly responses: {
|
|
592
|
-
readonly 200: "
|
|
918
|
+
readonly 200: "SubscriptionRetryNowResult";
|
|
919
|
+
readonly 202: "SubscriptionRetryNowResult";
|
|
593
920
|
};
|
|
594
|
-
readonly errors: readonly ["
|
|
921
|
+
readonly errors: readonly ["authentication_required", "card_declined", "customer_action_required", "customer_payment_unsupported", "invalid_param", "invalid_payment_method", "payment_idempotency_conflict", "payment_in_progress", "payment_not_retryable", "payment_provider_rejected", "rebill_terms_committed", "resource_conflict", "resource_not_found", "service_unavailable", "subscription_not_found"];
|
|
595
922
|
readonly errorSets: readonly ["tier:customer", "request"];
|
|
596
923
|
}, {
|
|
597
924
|
readonly method: "POST";
|
|
598
|
-
readonly path: "/v1/me/
|
|
925
|
+
readonly path: "/v1/me/subscriptions/{id}/change";
|
|
599
926
|
readonly group: "customer";
|
|
600
927
|
readonly auth: "customer";
|
|
601
928
|
readonly permission: null;
|
|
602
929
|
readonly sensitive: false;
|
|
603
930
|
readonly mountedWhen: null;
|
|
604
|
-
readonly request: "
|
|
931
|
+
readonly request: "CustomerChangeSubscriptionParams";
|
|
605
932
|
readonly responses: {
|
|
606
|
-
readonly 200: "
|
|
933
|
+
readonly 200: "SubscriptionChange";
|
|
934
|
+
readonly 202: "SubscriptionChange";
|
|
607
935
|
};
|
|
608
|
-
readonly errors: readonly ["invalid_param"];
|
|
936
|
+
readonly errors: readonly ["authentication_required", "card_declined", "customer_action_required", "customer_email_required", "invalid_param", "payment_duplicate_refused", "payment_method_stale", "payment_provider_rejected", "price_change_currency_mismatch", "price_not_found", "product_not_found", "quantity_not_allowed", "rebill_terms_committed", "resource_conflict", "resource_not_found", "scheduled_change_exists", "service_unavailable", "solana_rpc_unavailable", "solana_transaction_refused", "subscription_change_already_scheduled", "subscription_change_credit_exceeds_price", "subscription_change_cycle_unknown", "subscription_change_idempotency_conflict", "subscription_change_idempotency_key_required", "subscription_change_in_flight", "subscription_change_period_unknown", "subscription_change_provider_conflict", "subscription_change_refused", "subscription_change_renewal_due", "subscription_change_requires_linked_plan", "subscription_change_target_inactive", "subscription_change_unsupported_on_rail", "subscription_not_active", "subscription_not_found"];
|
|
609
937
|
readonly errorSets: readonly ["tier:customer", "request"];
|
|
610
938
|
}, {
|
|
611
939
|
readonly method: "POST";
|
|
612
|
-
readonly path: "/v1/me/
|
|
940
|
+
readonly path: "/v1/me/subscriptions/{id}/confirm";
|
|
613
941
|
readonly group: "customer";
|
|
614
942
|
readonly auth: "customer";
|
|
615
943
|
readonly permission: null;
|
|
616
944
|
readonly sensitive: false;
|
|
617
|
-
readonly mountedWhen:
|
|
945
|
+
readonly mountedWhen: null;
|
|
618
946
|
readonly request: null;
|
|
619
947
|
readonly responses: {
|
|
620
|
-
readonly
|
|
948
|
+
readonly 200: "SubscriptionChange";
|
|
949
|
+
readonly 202: "SubscriptionChange";
|
|
621
950
|
};
|
|
622
|
-
readonly errors: readonly ["service_unavailable"];
|
|
951
|
+
readonly errors: readonly ["authentication_required", "card_declined", "customer_session_required", "invalid_param", "payment_not_found", "payment_provider_rejected", "resource_conflict", "resource_not_found", "service_unavailable", "subscription_change_refused", "subscription_not_found"];
|
|
623
952
|
readonly errorSets: readonly ["tier:customer"];
|
|
624
953
|
}, {
|
|
625
954
|
readonly method: "POST";
|
|
626
|
-
readonly path: "/v1/me/
|
|
955
|
+
readonly path: "/v1/me/subscriptions/{id}/change/preview";
|
|
627
956
|
readonly group: "customer";
|
|
628
957
|
readonly auth: "customer";
|
|
629
958
|
readonly permission: null;
|
|
630
959
|
readonly sensitive: false;
|
|
631
|
-
readonly mountedWhen:
|
|
632
|
-
readonly request: "
|
|
960
|
+
readonly mountedWhen: null;
|
|
961
|
+
readonly request: "PreviewSubscriptionChangeParams";
|
|
633
962
|
readonly responses: {
|
|
634
|
-
readonly 200: "
|
|
635
|
-
readonly 201: "CustomerLink";
|
|
963
|
+
readonly 200: "SubscriptionChangePreview";
|
|
636
964
|
};
|
|
637
|
-
readonly errors: readonly ["
|
|
965
|
+
readonly errors: readonly ["authentication_required", "card_declined", "customer_email_required", "invalid_param", "payment_method_stale", "payment_provider_rejected", "price_change_currency_mismatch", "price_not_found", "product_not_found", "quantity_not_allowed", "resource_conflict", "resource_not_found", "service_unavailable", "subscription_change_already_scheduled", "subscription_change_credit_exceeds_price", "subscription_change_cycle_unknown", "subscription_change_in_flight", "subscription_change_period_unknown", "subscription_change_provider_conflict", "subscription_change_renewal_due", "subscription_change_requires_linked_plan", "subscription_change_target_inactive", "subscription_change_unsupported_on_rail", "subscription_not_active", "subscription_not_found"];
|
|
966
|
+
readonly errorSets: readonly ["tier:customer", "request"];
|
|
967
|
+
}, {
|
|
968
|
+
readonly method: "GET";
|
|
969
|
+
readonly path: "/v1/admin/entitlements";
|
|
970
|
+
readonly group: "admin";
|
|
971
|
+
readonly auth: "merchant";
|
|
972
|
+
readonly permission: {
|
|
973
|
+
readonly merchant: "merchant:customer:read";
|
|
974
|
+
readonly root: "root:customer:read";
|
|
975
|
+
};
|
|
976
|
+
readonly sensitive: false;
|
|
977
|
+
readonly mountedWhen: null;
|
|
978
|
+
readonly request: null;
|
|
979
|
+
readonly responses: {
|
|
980
|
+
readonly 200: "ListPage<CustomerEntitlement>";
|
|
981
|
+
};
|
|
982
|
+
readonly errors: readonly ["invalid_cursor", "invalid_param", "invalid_query", "service_credential_customer_scope_denied"];
|
|
983
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
984
|
+
}, {
|
|
985
|
+
readonly method: "POST";
|
|
986
|
+
readonly path: "/v1/app/entitlements/check";
|
|
987
|
+
readonly group: "app";
|
|
988
|
+
readonly auth: "application";
|
|
989
|
+
readonly permission: {
|
|
990
|
+
readonly merchant: "merchant:entitlements:read";
|
|
991
|
+
readonly root: "root:entitlements:read";
|
|
992
|
+
};
|
|
993
|
+
readonly sensitive: false;
|
|
994
|
+
readonly mountedWhen: null;
|
|
995
|
+
readonly request: "CheckEntitlementsParams";
|
|
996
|
+
readonly responses: {
|
|
997
|
+
readonly 200: "EntitlementCheck";
|
|
998
|
+
};
|
|
999
|
+
readonly errors: readonly ["invalid_param", "service_credential_customer_scope_denied"];
|
|
1000
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
1001
|
+
}, {
|
|
1002
|
+
readonly method: "GET";
|
|
1003
|
+
readonly path: "/v1/admin/product-access";
|
|
1004
|
+
readonly group: "admin";
|
|
1005
|
+
readonly auth: "merchant";
|
|
1006
|
+
readonly permission: {
|
|
1007
|
+
readonly merchant: "merchant:customer:read";
|
|
1008
|
+
readonly root: "root:customer:read";
|
|
1009
|
+
};
|
|
1010
|
+
readonly sensitive: false;
|
|
1011
|
+
readonly mountedWhen: null;
|
|
1012
|
+
readonly request: null;
|
|
1013
|
+
readonly responses: {
|
|
1014
|
+
readonly 200: "ListPage<ProductAccessGrant>";
|
|
1015
|
+
};
|
|
1016
|
+
readonly errors: readonly ["invalid_cursor", "invalid_param", "invalid_query", "service_credential_customer_scope_denied"];
|
|
1017
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1018
|
+
}, {
|
|
1019
|
+
readonly method: "POST";
|
|
1020
|
+
readonly path: "/v1/admin/product-access";
|
|
1021
|
+
readonly group: "admin";
|
|
1022
|
+
readonly auth: "merchant";
|
|
1023
|
+
readonly permission: {
|
|
1024
|
+
readonly merchant: "merchant:customer:manage";
|
|
1025
|
+
readonly root: "root:customer:manage";
|
|
1026
|
+
};
|
|
1027
|
+
readonly sensitive: false;
|
|
1028
|
+
readonly mountedWhen: null;
|
|
1029
|
+
readonly request: "CreateProductAccessBatchParams";
|
|
1030
|
+
readonly responses: {
|
|
1031
|
+
readonly 201: "CreateProductAccessBatchResult";
|
|
1032
|
+
};
|
|
1033
|
+
readonly errors: readonly ["authentication_required", "idempotency_key_reused", "invalid_param", "resource_not_found", "service_credential_customer_scope_denied"];
|
|
1034
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1035
|
+
}, {
|
|
1036
|
+
readonly method: "POST";
|
|
1037
|
+
readonly path: "/v1/admin/product-access/{id}/revoke";
|
|
1038
|
+
readonly group: "admin";
|
|
1039
|
+
readonly auth: "merchant";
|
|
1040
|
+
readonly permission: {
|
|
1041
|
+
readonly merchant: "merchant:customer:manage";
|
|
1042
|
+
readonly root: "root:customer:manage";
|
|
1043
|
+
};
|
|
1044
|
+
readonly sensitive: false;
|
|
1045
|
+
readonly mountedWhen: null;
|
|
1046
|
+
readonly request: "RevokeProductAccessParams";
|
|
1047
|
+
readonly responses: {
|
|
1048
|
+
readonly 204: null;
|
|
1049
|
+
};
|
|
1050
|
+
readonly errors: readonly ["invalid_param", "resource_not_found"];
|
|
1051
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1052
|
+
}, {
|
|
1053
|
+
readonly method: "GET";
|
|
1054
|
+
readonly path: "/v1/me/entitlements";
|
|
1055
|
+
readonly group: "customer";
|
|
1056
|
+
readonly auth: "customer";
|
|
1057
|
+
readonly permission: null;
|
|
1058
|
+
readonly sensitive: false;
|
|
1059
|
+
readonly mountedWhen: null;
|
|
1060
|
+
readonly request: null;
|
|
1061
|
+
readonly responses: {
|
|
1062
|
+
readonly 200: "ListPage<CustomerEntitlement>";
|
|
1063
|
+
};
|
|
1064
|
+
readonly errors: readonly ["authentication_required", "invalid_cursor", "invalid_param", "invalid_query"];
|
|
638
1065
|
readonly errorSets: readonly ["tier:customer", "request"];
|
|
1066
|
+
}, {
|
|
1067
|
+
readonly method: "GET";
|
|
1068
|
+
readonly path: "/v1/admin/customers";
|
|
1069
|
+
readonly group: "admin";
|
|
1070
|
+
readonly auth: "merchant";
|
|
1071
|
+
readonly permission: {
|
|
1072
|
+
readonly merchant: "merchant:customer:read";
|
|
1073
|
+
readonly root: "root:customer:read";
|
|
1074
|
+
};
|
|
1075
|
+
readonly sensitive: false;
|
|
1076
|
+
readonly mountedWhen: null;
|
|
1077
|
+
readonly request: null;
|
|
1078
|
+
readonly responses: {
|
|
1079
|
+
readonly 200: "ListPage<Customer>";
|
|
1080
|
+
};
|
|
1081
|
+
readonly errors: readonly ["invalid_cursor", "service_unavailable"];
|
|
1082
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1083
|
+
}, {
|
|
1084
|
+
readonly method: "GET";
|
|
1085
|
+
readonly path: "/v1/admin/customers/{customer_id}";
|
|
1086
|
+
readonly group: "admin";
|
|
1087
|
+
readonly auth: "merchant";
|
|
1088
|
+
readonly permission: {
|
|
1089
|
+
readonly merchant: "merchant:customer:read";
|
|
1090
|
+
readonly root: "root:customer:read";
|
|
1091
|
+
};
|
|
1092
|
+
readonly sensitive: false;
|
|
1093
|
+
readonly mountedWhen: null;
|
|
1094
|
+
readonly request: null;
|
|
1095
|
+
readonly responses: {
|
|
1096
|
+
readonly 200: "Customer";
|
|
1097
|
+
};
|
|
1098
|
+
readonly errors: readonly ["customer_not_found", "invalid_customer_id", "service_credential_customer_scope_denied", "service_unavailable"];
|
|
1099
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
1100
|
+
}, {
|
|
1101
|
+
readonly method: "PATCH";
|
|
1102
|
+
readonly path: "/v1/admin/customers/{customer_id}";
|
|
1103
|
+
readonly group: "admin";
|
|
1104
|
+
readonly auth: "merchant";
|
|
1105
|
+
readonly permission: {
|
|
1106
|
+
readonly merchant: "merchant:customer:manage";
|
|
1107
|
+
readonly root: "root:customer:manage";
|
|
1108
|
+
};
|
|
1109
|
+
readonly sensitive: false;
|
|
1110
|
+
readonly mountedWhen: null;
|
|
1111
|
+
readonly request: "UpdateCustomerParams";
|
|
1112
|
+
readonly responses: {
|
|
1113
|
+
readonly 200: "Customer";
|
|
1114
|
+
};
|
|
1115
|
+
readonly errors: readonly ["billing_policy_not_found", "currency_unsupported", "invalid_customer_id", "invalid_param", "service_credential_customer_scope_denied", "service_unavailable"];
|
|
1116
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1117
|
+
}, {
|
|
1118
|
+
readonly method: "POST";
|
|
1119
|
+
readonly path: "/v1/admin/credit-grants";
|
|
1120
|
+
readonly group: "admin";
|
|
1121
|
+
readonly auth: "merchant";
|
|
1122
|
+
readonly permission: {
|
|
1123
|
+
readonly merchant: "merchant:customer:manage";
|
|
1124
|
+
readonly root: "root:customer:manage";
|
|
1125
|
+
};
|
|
1126
|
+
readonly sensitive: false;
|
|
1127
|
+
readonly mountedWhen: null;
|
|
1128
|
+
readonly request: "CreateCreditGrantBatchParams";
|
|
1129
|
+
readonly responses: {
|
|
1130
|
+
readonly 201: "CreateCreditGrantBatchResult";
|
|
1131
|
+
readonly 200: "CreateCreditGrantBatchResult";
|
|
1132
|
+
};
|
|
1133
|
+
readonly errors: readonly ["currency_unsupported", "idempotency_key_reused", "invalid_param", "service_credential_customer_scope_denied"];
|
|
1134
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1135
|
+
}, {
|
|
1136
|
+
readonly method: "GET";
|
|
1137
|
+
readonly path: "/v1/admin/credit-grants";
|
|
1138
|
+
readonly group: "admin";
|
|
1139
|
+
readonly auth: "merchant";
|
|
1140
|
+
readonly permission: {
|
|
1141
|
+
readonly merchant: "merchant:customer:read";
|
|
1142
|
+
readonly root: "root:customer:read";
|
|
1143
|
+
};
|
|
1144
|
+
readonly sensitive: false;
|
|
1145
|
+
readonly mountedWhen: null;
|
|
1146
|
+
readonly request: null;
|
|
1147
|
+
readonly responses: {
|
|
1148
|
+
readonly 200: "ListPage<CreditGrant>";
|
|
1149
|
+
};
|
|
1150
|
+
readonly errors: readonly ["invalid_cursor", "invalid_customer_id", "service_credential_customer_scope_denied"];
|
|
1151
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1152
|
+
}, {
|
|
1153
|
+
readonly method: "GET";
|
|
1154
|
+
readonly path: "/v1/admin/credit-grants/{id}";
|
|
1155
|
+
readonly group: "admin";
|
|
1156
|
+
readonly auth: "merchant";
|
|
1157
|
+
readonly permission: {
|
|
1158
|
+
readonly merchant: "merchant:customer:read";
|
|
1159
|
+
readonly root: "root:customer:read";
|
|
1160
|
+
};
|
|
1161
|
+
readonly sensitive: false;
|
|
1162
|
+
readonly mountedWhen: null;
|
|
1163
|
+
readonly request: null;
|
|
1164
|
+
readonly responses: {
|
|
1165
|
+
readonly 200: "CreditGrant";
|
|
1166
|
+
};
|
|
1167
|
+
readonly errors: readonly ["credit_grant_not_found", "invalid_param"];
|
|
1168
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
1169
|
+
}, {
|
|
1170
|
+
readonly method: "POST";
|
|
1171
|
+
readonly path: "/v1/admin/credit-grants/{id}/revoke";
|
|
1172
|
+
readonly group: "admin";
|
|
1173
|
+
readonly auth: "merchant";
|
|
1174
|
+
readonly permission: {
|
|
1175
|
+
readonly merchant: "merchant:customer:manage";
|
|
1176
|
+
readonly root: "root:customer:manage";
|
|
1177
|
+
};
|
|
1178
|
+
readonly sensitive: false;
|
|
1179
|
+
readonly mountedWhen: null;
|
|
1180
|
+
readonly request: "RevokeCreditGrantParams";
|
|
1181
|
+
readonly responses: {
|
|
1182
|
+
readonly 200: "CreditGrant";
|
|
1183
|
+
};
|
|
1184
|
+
readonly errors: readonly ["credit_grant_held", "credit_grant_not_found", "credit_grant_unavailable", "invalid_param"];
|
|
1185
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1186
|
+
}, {
|
|
1187
|
+
readonly method: "GET";
|
|
1188
|
+
readonly path: "/v1/admin/customers/{customer_id}/balance/transactions";
|
|
1189
|
+
readonly group: "admin";
|
|
1190
|
+
readonly auth: "merchant";
|
|
1191
|
+
readonly permission: {
|
|
1192
|
+
readonly merchant: "merchant:customer:read";
|
|
1193
|
+
readonly root: "root:customer:read";
|
|
1194
|
+
};
|
|
1195
|
+
readonly sensitive: false;
|
|
1196
|
+
readonly mountedWhen: null;
|
|
1197
|
+
readonly request: null;
|
|
1198
|
+
readonly responses: {
|
|
1199
|
+
readonly 200: "ListPage<BalanceTransaction>";
|
|
1200
|
+
};
|
|
1201
|
+
readonly errors: readonly ["currency_unsupported", "invalid_cursor", "invalid_customer_id", "service_credential_customer_scope_denied"];
|
|
1202
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1203
|
+
}, {
|
|
1204
|
+
readonly method: "GET";
|
|
1205
|
+
readonly path: "/v1/admin/customers/{customer_id}/balance";
|
|
1206
|
+
readonly group: "admin";
|
|
1207
|
+
readonly auth: "merchant";
|
|
1208
|
+
readonly permission: {
|
|
1209
|
+
readonly merchant: "merchant:customer:read";
|
|
1210
|
+
readonly root: "root:customer:read";
|
|
1211
|
+
};
|
|
1212
|
+
readonly sensitive: false;
|
|
1213
|
+
readonly mountedWhen: null;
|
|
1214
|
+
readonly request: null;
|
|
1215
|
+
readonly responses: {
|
|
1216
|
+
readonly 200: "Balance";
|
|
1217
|
+
};
|
|
1218
|
+
readonly errors: readonly ["currency_unsupported", "invalid_customer_id", "service_credential_customer_scope_denied"];
|
|
1219
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1220
|
+
}, {
|
|
1221
|
+
readonly method: "GET";
|
|
1222
|
+
readonly path: "/v1/me";
|
|
1223
|
+
readonly group: "customer";
|
|
1224
|
+
readonly auth: "customer";
|
|
1225
|
+
readonly permission: null;
|
|
1226
|
+
readonly sensitive: false;
|
|
1227
|
+
readonly mountedWhen: null;
|
|
1228
|
+
readonly request: null;
|
|
1229
|
+
readonly responses: {
|
|
1230
|
+
readonly 200: "CustomerAccount";
|
|
1231
|
+
};
|
|
1232
|
+
readonly errors: readonly [];
|
|
1233
|
+
readonly errorSets: readonly ["tier:customer"];
|
|
1234
|
+
}, {
|
|
1235
|
+
readonly method: "GET";
|
|
1236
|
+
readonly path: "/v1/me/balance/transactions";
|
|
1237
|
+
readonly group: "customer";
|
|
1238
|
+
readonly auth: "customer";
|
|
1239
|
+
readonly permission: null;
|
|
1240
|
+
readonly sensitive: false;
|
|
1241
|
+
readonly mountedWhen: null;
|
|
1242
|
+
readonly request: null;
|
|
1243
|
+
readonly responses: {
|
|
1244
|
+
readonly 200: "ListPage<BalanceTransaction>";
|
|
1245
|
+
};
|
|
1246
|
+
readonly errors: readonly ["currency_unsupported", "invalid_cursor"];
|
|
1247
|
+
readonly errorSets: readonly ["tier:customer", "request"];
|
|
1248
|
+
}, {
|
|
1249
|
+
readonly method: "GET";
|
|
1250
|
+
readonly path: "/v1/app/admissions/{request_id}";
|
|
1251
|
+
readonly group: "app";
|
|
1252
|
+
readonly auth: "application";
|
|
1253
|
+
readonly permission: {
|
|
1254
|
+
readonly merchant: "merchant:usage:read";
|
|
1255
|
+
readonly root: "root:usage:read";
|
|
1256
|
+
};
|
|
1257
|
+
readonly sensitive: false;
|
|
1258
|
+
readonly mountedWhen: null;
|
|
1259
|
+
readonly request: null;
|
|
1260
|
+
readonly responses: {
|
|
1261
|
+
readonly 200: "Admission";
|
|
1262
|
+
};
|
|
1263
|
+
readonly errors: readonly ["admission_not_found", "invalid_param", "service_unavailable"];
|
|
1264
|
+
readonly errorSets: readonly ["tier:application"];
|
|
1265
|
+
}, {
|
|
1266
|
+
readonly method: "GET";
|
|
1267
|
+
readonly path: "/v1/app/admissions";
|
|
1268
|
+
readonly group: "app";
|
|
1269
|
+
readonly auth: "application";
|
|
1270
|
+
readonly permission: {
|
|
1271
|
+
readonly merchant: "merchant:usage:read";
|
|
1272
|
+
readonly root: "root:usage:read";
|
|
1273
|
+
};
|
|
1274
|
+
readonly sensitive: false;
|
|
1275
|
+
readonly mountedWhen: null;
|
|
1276
|
+
readonly request: null;
|
|
1277
|
+
readonly responses: {
|
|
1278
|
+
readonly 200: "ListPage<Admission>";
|
|
1279
|
+
};
|
|
1280
|
+
readonly errors: readonly ["currency_unsupported", "invalid_cursor", "invalid_query"];
|
|
1281
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
1282
|
+
}, {
|
|
1283
|
+
readonly method: "GET";
|
|
1284
|
+
readonly path: "/v1/app/usage-events/{id}";
|
|
1285
|
+
readonly group: "app";
|
|
1286
|
+
readonly auth: "application";
|
|
1287
|
+
readonly permission: {
|
|
1288
|
+
readonly merchant: "merchant:usage:read";
|
|
1289
|
+
readonly root: "root:usage:read";
|
|
1290
|
+
};
|
|
1291
|
+
readonly sensitive: false;
|
|
1292
|
+
readonly mountedWhen: null;
|
|
1293
|
+
readonly request: null;
|
|
1294
|
+
readonly responses: {
|
|
1295
|
+
readonly 200: "UsageEvent";
|
|
1296
|
+
};
|
|
1297
|
+
readonly errors: readonly ["invalid_param", "resource_not_found"];
|
|
1298
|
+
readonly errorSets: readonly ["tier:application"];
|
|
1299
|
+
}, {
|
|
1300
|
+
readonly method: "GET";
|
|
1301
|
+
readonly path: "/v1/app/usage-events";
|
|
1302
|
+
readonly group: "app";
|
|
1303
|
+
readonly auth: "application";
|
|
1304
|
+
readonly permission: {
|
|
1305
|
+
readonly merchant: "merchant:usage:read";
|
|
1306
|
+
readonly root: "root:usage:read";
|
|
1307
|
+
};
|
|
1308
|
+
readonly sensitive: false;
|
|
1309
|
+
readonly mountedWhen: null;
|
|
1310
|
+
readonly request: null;
|
|
1311
|
+
readonly responses: {
|
|
1312
|
+
readonly 200: "ListPage<UsageEvent>";
|
|
1313
|
+
};
|
|
1314
|
+
readonly errors: readonly ["currency_unsupported", "invalid_cursor", "invalid_query"];
|
|
1315
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
1316
|
+
}, {
|
|
1317
|
+
readonly method: "POST";
|
|
1318
|
+
readonly path: "/v1/app/admissions";
|
|
1319
|
+
readonly group: "app";
|
|
1320
|
+
readonly auth: "application";
|
|
1321
|
+
readonly permission: {
|
|
1322
|
+
readonly merchant: "merchant:usage:manage";
|
|
1323
|
+
readonly root: "root:usage:manage";
|
|
1324
|
+
};
|
|
1325
|
+
readonly sensitive: false;
|
|
1326
|
+
readonly mountedWhen: null;
|
|
1327
|
+
readonly request: "AdmitBatchParams";
|
|
1328
|
+
readonly responses: {
|
|
1329
|
+
readonly 200: "AdmitBatchResult";
|
|
1330
|
+
};
|
|
1331
|
+
readonly errors: readonly ["invalid_param"];
|
|
1332
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
1333
|
+
}, {
|
|
1334
|
+
readonly method: "POST";
|
|
1335
|
+
readonly path: "/v1/app/admissions/capture";
|
|
1336
|
+
readonly group: "app";
|
|
1337
|
+
readonly auth: "application";
|
|
1338
|
+
readonly permission: {
|
|
1339
|
+
readonly merchant: "merchant:usage:manage";
|
|
1340
|
+
readonly root: "root:usage:manage";
|
|
1341
|
+
};
|
|
1342
|
+
readonly sensitive: false;
|
|
1343
|
+
readonly mountedWhen: null;
|
|
1344
|
+
readonly request: "CaptureAdmissionBatchParams";
|
|
1345
|
+
readonly responses: {
|
|
1346
|
+
readonly 200: "CaptureBatchResult";
|
|
1347
|
+
};
|
|
1348
|
+
readonly errors: readonly ["invalid_param"];
|
|
1349
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
1350
|
+
}, {
|
|
1351
|
+
readonly method: "POST";
|
|
1352
|
+
readonly path: "/v1/app/admissions/release";
|
|
1353
|
+
readonly group: "app";
|
|
1354
|
+
readonly auth: "application";
|
|
1355
|
+
readonly permission: {
|
|
1356
|
+
readonly merchant: "merchant:usage:manage";
|
|
1357
|
+
readonly root: "root:usage:manage";
|
|
1358
|
+
};
|
|
1359
|
+
readonly sensitive: false;
|
|
1360
|
+
readonly mountedWhen: null;
|
|
1361
|
+
readonly request: "ReleaseAdmissionBatchParams";
|
|
1362
|
+
readonly responses: {
|
|
1363
|
+
readonly 200: "AdmissionBatchResult";
|
|
1364
|
+
};
|
|
1365
|
+
readonly errors: readonly ["invalid_param"];
|
|
1366
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
1367
|
+
}, {
|
|
1368
|
+
readonly method: "POST";
|
|
1369
|
+
readonly path: "/v1/app/admissions/extend";
|
|
1370
|
+
readonly group: "app";
|
|
1371
|
+
readonly auth: "application";
|
|
1372
|
+
readonly permission: {
|
|
1373
|
+
readonly merchant: "merchant:usage:manage";
|
|
1374
|
+
readonly root: "root:usage:manage";
|
|
1375
|
+
};
|
|
1376
|
+
readonly sensitive: false;
|
|
1377
|
+
readonly mountedWhen: null;
|
|
1378
|
+
readonly request: "ExtendAdmissionBatchParams";
|
|
1379
|
+
readonly responses: {
|
|
1380
|
+
readonly 200: "AdmissionBatchResult";
|
|
1381
|
+
};
|
|
1382
|
+
readonly errors: readonly ["invalid_param"];
|
|
1383
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
1384
|
+
}, {
|
|
1385
|
+
readonly method: "POST";
|
|
1386
|
+
readonly path: "/v1/app/usage-events";
|
|
1387
|
+
readonly group: "app";
|
|
1388
|
+
readonly auth: "application";
|
|
1389
|
+
readonly permission: {
|
|
1390
|
+
readonly merchant: "merchant:usage:manage";
|
|
1391
|
+
readonly root: "root:usage:manage";
|
|
1392
|
+
};
|
|
1393
|
+
readonly sensitive: false;
|
|
1394
|
+
readonly mountedWhen: null;
|
|
1395
|
+
readonly request: "RecordUsageBatchParams";
|
|
1396
|
+
readonly responses: {
|
|
1397
|
+
readonly 200: "RecordUsageBatchResult";
|
|
1398
|
+
};
|
|
1399
|
+
readonly errors: readonly ["invalid_param"];
|
|
1400
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
1401
|
+
}, {
|
|
1402
|
+
readonly method: "GET";
|
|
1403
|
+
readonly path: "/v1/me/usage";
|
|
1404
|
+
readonly group: "customer";
|
|
1405
|
+
readonly auth: "customer";
|
|
1406
|
+
readonly permission: null;
|
|
1407
|
+
readonly sensitive: false;
|
|
1408
|
+
readonly mountedWhen: null;
|
|
1409
|
+
readonly request: null;
|
|
1410
|
+
readonly responses: {
|
|
1411
|
+
readonly 200: "Usage";
|
|
1412
|
+
};
|
|
1413
|
+
readonly errors: readonly ["currency_unsupported", "invalid_cursor"];
|
|
1414
|
+
readonly errorSets: readonly ["tier:customer", "request"];
|
|
1415
|
+
}, {
|
|
1416
|
+
readonly method: "POST";
|
|
1417
|
+
readonly path: "/v1/app/running-charges";
|
|
1418
|
+
readonly group: "app";
|
|
1419
|
+
readonly auth: "application";
|
|
1420
|
+
readonly permission: {
|
|
1421
|
+
readonly merchant: "merchant:usage:manage";
|
|
1422
|
+
readonly root: "root:usage:manage";
|
|
1423
|
+
};
|
|
1424
|
+
readonly sensitive: false;
|
|
1425
|
+
readonly mountedWhen: null;
|
|
1426
|
+
readonly request: "StartRunningChargeParams";
|
|
1427
|
+
readonly responses: {
|
|
1428
|
+
readonly 201: "RunningCharge";
|
|
1429
|
+
readonly 200: "RunningCharge";
|
|
1430
|
+
};
|
|
1431
|
+
readonly errors: readonly ["currency_unsupported", "idempotency_key_reused", "insufficient_credits", "invalid_param"];
|
|
1432
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
1433
|
+
}, {
|
|
1434
|
+
readonly method: "POST";
|
|
1435
|
+
readonly path: "/v1/app/running-charges/{reference}/stop";
|
|
1436
|
+
readonly group: "app";
|
|
1437
|
+
readonly auth: "application";
|
|
1438
|
+
readonly permission: {
|
|
1439
|
+
readonly merchant: "merchant:usage:manage";
|
|
1440
|
+
readonly root: "root:usage:manage";
|
|
1441
|
+
};
|
|
1442
|
+
readonly sensitive: false;
|
|
1443
|
+
readonly mountedWhen: null;
|
|
1444
|
+
readonly request: "StopRunningChargeParams";
|
|
1445
|
+
readonly responses: {
|
|
1446
|
+
readonly 200: "RunningCharge";
|
|
1447
|
+
};
|
|
1448
|
+
readonly errors: readonly ["idempotency_key_reused", "invalid_param", "running_charge_not_found"];
|
|
1449
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
1450
|
+
}, {
|
|
1451
|
+
readonly method: "GET";
|
|
1452
|
+
readonly path: "/v1/app/running-charges/{reference}";
|
|
1453
|
+
readonly group: "app";
|
|
1454
|
+
readonly auth: "application";
|
|
1455
|
+
readonly permission: {
|
|
1456
|
+
readonly merchant: "merchant:usage:read";
|
|
1457
|
+
readonly root: "root:usage:read";
|
|
1458
|
+
};
|
|
1459
|
+
readonly sensitive: false;
|
|
1460
|
+
readonly mountedWhen: null;
|
|
1461
|
+
readonly request: null;
|
|
1462
|
+
readonly responses: {
|
|
1463
|
+
readonly 200: "RunningCharge";
|
|
1464
|
+
};
|
|
1465
|
+
readonly errors: readonly ["running_charge_not_found"];
|
|
1466
|
+
readonly errorSets: readonly ["tier:application"];
|
|
1467
|
+
}, {
|
|
1468
|
+
readonly method: "GET";
|
|
1469
|
+
readonly path: "/v1/app/running-charges";
|
|
1470
|
+
readonly group: "app";
|
|
1471
|
+
readonly auth: "application";
|
|
1472
|
+
readonly permission: {
|
|
1473
|
+
readonly merchant: "merchant:usage:read";
|
|
1474
|
+
readonly root: "root:usage:read";
|
|
1475
|
+
};
|
|
1476
|
+
readonly sensitive: false;
|
|
1477
|
+
readonly mountedWhen: null;
|
|
1478
|
+
readonly request: null;
|
|
1479
|
+
readonly responses: {
|
|
1480
|
+
readonly 200: "ListPage<RunningCharge>";
|
|
1481
|
+
};
|
|
1482
|
+
readonly errors: readonly ["invalid_cursor", "invalid_query"];
|
|
1483
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
1484
|
+
}, {
|
|
1485
|
+
readonly method: "POST";
|
|
1486
|
+
readonly path: "/v1/admin/payments";
|
|
1487
|
+
readonly group: "admin";
|
|
1488
|
+
readonly auth: "merchant";
|
|
1489
|
+
readonly permission: {
|
|
1490
|
+
readonly merchant: "merchant:customer:manage";
|
|
1491
|
+
readonly root: "root:customer:manage";
|
|
1492
|
+
};
|
|
1493
|
+
readonly sensitive: false;
|
|
1494
|
+
readonly mountedWhen: null;
|
|
1495
|
+
readonly request: "RecordExternalPaymentParams";
|
|
1496
|
+
readonly responses: {
|
|
1497
|
+
readonly 200: "Payment";
|
|
1498
|
+
readonly 201: "Payment";
|
|
1499
|
+
};
|
|
1500
|
+
readonly errors: readonly ["idempotency_key_reused", "invalid_param", "order_action_not_allowed", "order_has_recurring_line", "order_not_payable", "order_payment_in_progress", "payment_exceeds_due", "resource_not_found", "service_unavailable"];
|
|
1501
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1502
|
+
}, {
|
|
1503
|
+
readonly method: "GET";
|
|
1504
|
+
readonly path: "/v1/admin/payments";
|
|
1505
|
+
readonly group: "admin";
|
|
1506
|
+
readonly auth: "merchant";
|
|
1507
|
+
readonly permission: {
|
|
1508
|
+
readonly merchant: "merchant:customer:read";
|
|
1509
|
+
readonly root: "root:customer:read";
|
|
1510
|
+
};
|
|
1511
|
+
readonly sensitive: false;
|
|
1512
|
+
readonly mountedWhen: null;
|
|
1513
|
+
readonly request: null;
|
|
1514
|
+
readonly responses: {
|
|
1515
|
+
readonly 200: "ListPage<Payment>";
|
|
1516
|
+
};
|
|
1517
|
+
readonly errors: readonly ["invalid_cursor"];
|
|
1518
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1519
|
+
}, {
|
|
1520
|
+
readonly method: "GET";
|
|
1521
|
+
readonly path: "/v1/admin/payments/{id}";
|
|
1522
|
+
readonly group: "admin";
|
|
1523
|
+
readonly auth: "merchant";
|
|
1524
|
+
readonly permission: {
|
|
1525
|
+
readonly merchant: "merchant:customer:read";
|
|
1526
|
+
readonly root: "root:customer:read";
|
|
1527
|
+
};
|
|
1528
|
+
readonly sensitive: false;
|
|
1529
|
+
readonly mountedWhen: null;
|
|
1530
|
+
readonly request: null;
|
|
1531
|
+
readonly responses: {
|
|
1532
|
+
readonly 200: "Payment";
|
|
1533
|
+
};
|
|
1534
|
+
readonly errors: readonly ["invalid_param", "resource_not_found"];
|
|
1535
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
1536
|
+
}, {
|
|
1537
|
+
readonly method: "POST";
|
|
1538
|
+
readonly path: "/v1/admin/payments/{id}/refunds";
|
|
1539
|
+
readonly group: "admin";
|
|
1540
|
+
readonly auth: "merchant";
|
|
1541
|
+
readonly permission: {
|
|
1542
|
+
readonly merchant: "merchant:customer:manage";
|
|
1543
|
+
readonly root: "root:customer:manage";
|
|
1544
|
+
};
|
|
1545
|
+
readonly sensitive: false;
|
|
1546
|
+
readonly mountedWhen: null;
|
|
1547
|
+
readonly request: "RefundPaymentParams";
|
|
1548
|
+
readonly responses: {
|
|
1549
|
+
readonly 201: "Payment";
|
|
1550
|
+
readonly 202: "Payment";
|
|
1551
|
+
};
|
|
1552
|
+
readonly errors: readonly ["idempotency_key_required", "idempotency_key_reused", "invalid_param", "payment_not_found", "payment_not_refundable", "provider_cancel_held", "rebill_terms_committed", "refund_failed", "refund_rail_unavailable", "refund_unsupported", "resource_conflict", "resource_not_found"];
|
|
1553
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1554
|
+
}, {
|
|
1555
|
+
readonly method: "GET";
|
|
1556
|
+
readonly path: "/v1/admin/payment-attempts";
|
|
1557
|
+
readonly group: "admin";
|
|
1558
|
+
readonly auth: "merchant";
|
|
1559
|
+
readonly permission: {
|
|
1560
|
+
readonly merchant: "merchant:customer:read";
|
|
1561
|
+
readonly root: "root:customer:read";
|
|
1562
|
+
};
|
|
1563
|
+
readonly sensitive: false;
|
|
1564
|
+
readonly mountedWhen: null;
|
|
1565
|
+
readonly request: null;
|
|
1566
|
+
readonly responses: {
|
|
1567
|
+
readonly 200: "ListPage<PaymentAttempt>";
|
|
1568
|
+
};
|
|
1569
|
+
readonly errors: readonly ["invalid_cursor"];
|
|
1570
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1571
|
+
}, {
|
|
1572
|
+
readonly method: "GET";
|
|
1573
|
+
readonly path: "/v1/admin/payment-attempts/{id}";
|
|
1574
|
+
readonly group: "admin";
|
|
1575
|
+
readonly auth: "merchant";
|
|
1576
|
+
readonly permission: {
|
|
1577
|
+
readonly merchant: "merchant:customer:read";
|
|
1578
|
+
readonly root: "root:customer:read";
|
|
1579
|
+
};
|
|
1580
|
+
readonly sensitive: false;
|
|
1581
|
+
readonly mountedWhen: null;
|
|
1582
|
+
readonly request: null;
|
|
1583
|
+
readonly responses: {
|
|
1584
|
+
readonly 200: "PaymentAttempt";
|
|
1585
|
+
};
|
|
1586
|
+
readonly errors: readonly ["invalid_param", "resource_not_found"];
|
|
1587
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
1588
|
+
}, {
|
|
1589
|
+
readonly method: "GET";
|
|
1590
|
+
readonly path: "/v1/admin/renewals";
|
|
1591
|
+
readonly group: "admin";
|
|
1592
|
+
readonly auth: "merchant";
|
|
1593
|
+
readonly permission: {
|
|
1594
|
+
readonly merchant: "merchant:customer:read";
|
|
1595
|
+
readonly root: "root:customer:read";
|
|
1596
|
+
};
|
|
1597
|
+
readonly sensitive: false;
|
|
1598
|
+
readonly mountedWhen: null;
|
|
1599
|
+
readonly request: null;
|
|
1600
|
+
readonly responses: {
|
|
1601
|
+
readonly 200: "ListPage<Renewal>";
|
|
1602
|
+
};
|
|
1603
|
+
readonly errors: readonly ["invalid_cursor"];
|
|
1604
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1605
|
+
}, {
|
|
1606
|
+
readonly method: "GET";
|
|
1607
|
+
readonly path: "/v1/admin/renewals/{id}";
|
|
1608
|
+
readonly group: "admin";
|
|
1609
|
+
readonly auth: "merchant";
|
|
1610
|
+
readonly permission: {
|
|
1611
|
+
readonly merchant: "merchant:customer:read";
|
|
1612
|
+
readonly root: "root:customer:read";
|
|
1613
|
+
};
|
|
1614
|
+
readonly sensitive: false;
|
|
1615
|
+
readonly mountedWhen: null;
|
|
1616
|
+
readonly request: null;
|
|
1617
|
+
readonly responses: {
|
|
1618
|
+
readonly 200: "Renewal";
|
|
1619
|
+
};
|
|
1620
|
+
readonly errors: readonly ["invalid_param", "resource_not_found"];
|
|
1621
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
1622
|
+
}, {
|
|
1623
|
+
readonly method: "GET";
|
|
1624
|
+
readonly path: "/v1/me/payments";
|
|
1625
|
+
readonly group: "customer";
|
|
1626
|
+
readonly auth: "customer";
|
|
1627
|
+
readonly permission: null;
|
|
1628
|
+
readonly sensitive: false;
|
|
1629
|
+
readonly mountedWhen: null;
|
|
1630
|
+
readonly request: null;
|
|
1631
|
+
readonly responses: {
|
|
1632
|
+
readonly 200: "ListPage<Payment>";
|
|
1633
|
+
};
|
|
1634
|
+
readonly errors: readonly ["invalid_cursor"];
|
|
1635
|
+
readonly errorSets: readonly ["tier:customer", "request"];
|
|
1636
|
+
}, {
|
|
1637
|
+
readonly method: "GET";
|
|
1638
|
+
readonly path: "/v1/admin/customers/{customer_id}/payment-methods";
|
|
1639
|
+
readonly group: "admin";
|
|
1640
|
+
readonly auth: "merchant";
|
|
1641
|
+
readonly permission: {
|
|
1642
|
+
readonly merchant: "merchant:customer:read";
|
|
1643
|
+
readonly root: "root:customer:read";
|
|
1644
|
+
};
|
|
1645
|
+
readonly sensitive: false;
|
|
1646
|
+
readonly mountedWhen: null;
|
|
1647
|
+
readonly request: null;
|
|
1648
|
+
readonly responses: {
|
|
1649
|
+
readonly 200: "ListPage<PaymentMethod>";
|
|
1650
|
+
};
|
|
1651
|
+
readonly errors: readonly ["invalid_cursor", "invalid_param"];
|
|
1652
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1653
|
+
}, {
|
|
1654
|
+
readonly method: "PUT";
|
|
1655
|
+
readonly path: "/v1/me/default-payment-methods/{currency}";
|
|
1656
|
+
readonly group: "customer";
|
|
1657
|
+
readonly auth: "customer";
|
|
1658
|
+
readonly permission: null;
|
|
1659
|
+
readonly sensitive: false;
|
|
1660
|
+
readonly mountedWhen: null;
|
|
1661
|
+
readonly request: "SetDefaultPaymentMethodParams";
|
|
1662
|
+
readonly responses: {
|
|
1663
|
+
readonly 200: "DefaultPaymentMethod";
|
|
1664
|
+
};
|
|
1665
|
+
readonly errors: readonly ["authentication_required", "card_declined", "default_payment_method_invalid", "invalid_param", "payment_method_not_psp_vaulted", "payment_method_psp_mismatch", "payment_method_same_vault", "payment_method_stale", "payment_provider_rejected", "rebill_terms_committed", "resource_conflict", "resource_not_found", "service_unavailable"];
|
|
1666
|
+
readonly errorSets: readonly ["tier:customer", "request"];
|
|
1667
|
+
}, {
|
|
1668
|
+
readonly method: "GET";
|
|
1669
|
+
readonly path: "/v1/me/payment-methods";
|
|
1670
|
+
readonly group: "customer";
|
|
1671
|
+
readonly auth: "customer";
|
|
1672
|
+
readonly permission: null;
|
|
1673
|
+
readonly sensitive: false;
|
|
1674
|
+
readonly mountedWhen: null;
|
|
1675
|
+
readonly request: null;
|
|
1676
|
+
readonly responses: {
|
|
1677
|
+
readonly 200: "ListPage<PaymentMethod>";
|
|
1678
|
+
};
|
|
1679
|
+
readonly errors: readonly ["invalid_cursor"];
|
|
1680
|
+
readonly errorSets: readonly ["tier:customer", "request"];
|
|
1681
|
+
}, {
|
|
1682
|
+
readonly method: "POST";
|
|
1683
|
+
readonly path: "/v1/me/payment-methods";
|
|
1684
|
+
readonly group: "customer";
|
|
1685
|
+
readonly auth: "customer";
|
|
1686
|
+
readonly permission: null;
|
|
1687
|
+
readonly sensitive: false;
|
|
1688
|
+
readonly mountedWhen: null;
|
|
1689
|
+
readonly request: "CreatePaymentMethodParams";
|
|
1690
|
+
readonly responses: {
|
|
1691
|
+
readonly 201: "PaymentMethod";
|
|
1692
|
+
};
|
|
1693
|
+
readonly errors: readonly ["card_attempts_blocked", "card_declined", "card_not_saved", "card_requires_https", "invalid_param", "payment_duplicate_refused", "payment_method_stale", "payment_provider_rejected", "provider_outcome_unknown", "service_unavailable"];
|
|
1694
|
+
readonly errorSets: readonly ["tier:customer", "request"];
|
|
1695
|
+
}, {
|
|
1696
|
+
readonly method: "PATCH";
|
|
1697
|
+
readonly path: "/v1/me/payment-methods/{id}";
|
|
1698
|
+
readonly group: "customer";
|
|
1699
|
+
readonly auth: "customer";
|
|
1700
|
+
readonly permission: null;
|
|
1701
|
+
readonly sensitive: false;
|
|
1702
|
+
readonly mountedWhen: null;
|
|
1703
|
+
readonly request: "UpdatePaymentMethodParams";
|
|
1704
|
+
readonly responses: {
|
|
1705
|
+
readonly 200: "PaymentMethod";
|
|
1706
|
+
};
|
|
1707
|
+
readonly errors: readonly ["card_requires_https", "invalid_param", "payment_method_not_usable", "payment_method_update_unsupported", "payment_provider_rejected", "provider_outcome_unknown", "resource_not_found", "service_unavailable"];
|
|
1708
|
+
readonly errorSets: readonly ["tier:customer", "request"];
|
|
1709
|
+
}, {
|
|
1710
|
+
readonly method: "DELETE";
|
|
1711
|
+
readonly path: "/v1/me/payment-methods/{id}";
|
|
1712
|
+
readonly group: "customer";
|
|
1713
|
+
readonly auth: "customer";
|
|
1714
|
+
readonly permission: null;
|
|
1715
|
+
readonly sensitive: false;
|
|
1716
|
+
readonly mountedWhen: null;
|
|
1717
|
+
readonly request: null;
|
|
1718
|
+
readonly responses: {
|
|
1719
|
+
readonly 202: null;
|
|
1720
|
+
readonly 204: null;
|
|
1721
|
+
};
|
|
1722
|
+
readonly errors: readonly ["invalid_param", "payment_method_delete_failed", "payment_method_delete_unsupported", "rate_limit_exceeded", "resource_conflict", "resource_not_found", "service_unavailable"];
|
|
1723
|
+
readonly errorSets: readonly ["tier:customer"];
|
|
1724
|
+
}, {
|
|
1725
|
+
readonly method: "POST";
|
|
1726
|
+
readonly path: "/v1/me/payment-methods/{id}/confirm";
|
|
1727
|
+
readonly group: "customer";
|
|
1728
|
+
readonly auth: "customer";
|
|
1729
|
+
readonly permission: null;
|
|
1730
|
+
readonly sensitive: false;
|
|
1731
|
+
readonly mountedWhen: null;
|
|
1732
|
+
readonly request: null;
|
|
1733
|
+
readonly responses: {
|
|
1734
|
+
readonly 200: "PaymentMethod";
|
|
1735
|
+
};
|
|
1736
|
+
readonly errors: readonly ["card_declined", "payment_provider_rejected", "resource_not_found", "service_unavailable"];
|
|
1737
|
+
readonly errorSets: readonly ["tier:customer"];
|
|
1738
|
+
}, {
|
|
1739
|
+
readonly method: "POST";
|
|
1740
|
+
readonly path: "/v1/me/stripe/billing-portal-sessions";
|
|
1741
|
+
readonly group: "customer";
|
|
1742
|
+
readonly auth: "customer";
|
|
1743
|
+
readonly permission: null;
|
|
1744
|
+
readonly sensitive: false;
|
|
1745
|
+
readonly mountedWhen: "stripe_portal";
|
|
1746
|
+
readonly request: null;
|
|
1747
|
+
readonly responses: {
|
|
1748
|
+
readonly 200: "StripePortalSession";
|
|
1749
|
+
};
|
|
1750
|
+
readonly errors: readonly ["invalid_param", "resource_not_found", "route_not_found"];
|
|
1751
|
+
readonly errorSets: readonly ["tier:customer"];
|
|
1752
|
+
}, {
|
|
1753
|
+
readonly method: "GET";
|
|
1754
|
+
readonly path: "/v1/me/agreements";
|
|
1755
|
+
readonly group: "customer";
|
|
1756
|
+
readonly auth: "customer";
|
|
1757
|
+
readonly permission: null;
|
|
1758
|
+
readonly sensitive: false;
|
|
1759
|
+
readonly mountedWhen: null;
|
|
1760
|
+
readonly request: null;
|
|
1761
|
+
readonly responses: {
|
|
1762
|
+
readonly 200: "ListPage<Agreement>";
|
|
1763
|
+
};
|
|
1764
|
+
readonly errors: readonly ["invalid_cursor"];
|
|
1765
|
+
readonly errorSets: readonly ["tier:customer", "request"];
|
|
1766
|
+
}, {
|
|
1767
|
+
readonly method: "POST";
|
|
1768
|
+
readonly path: "/v1/me/agreements/{id}/revoke";
|
|
1769
|
+
readonly group: "customer";
|
|
1770
|
+
readonly auth: "customer";
|
|
1771
|
+
readonly permission: null;
|
|
1772
|
+
readonly sensitive: false;
|
|
1773
|
+
readonly mountedWhen: null;
|
|
1774
|
+
readonly request: null;
|
|
1775
|
+
readonly responses: {
|
|
1776
|
+
readonly 200: "AgreementRevocation";
|
|
1777
|
+
};
|
|
1778
|
+
readonly errors: readonly ["cancel_unsupported_on_rail", "customer_action_required", "invalid_param", "payment_in_progress", "provider_cancel_held", "resource_not_found", "service_unavailable", "subscription_not_active"];
|
|
1779
|
+
readonly errorSets: readonly ["tier:customer"];
|
|
1780
|
+
}, {
|
|
1781
|
+
readonly method: "GET";
|
|
1782
|
+
readonly path: "/v1/merchant/psps";
|
|
1783
|
+
readonly group: "merchant_config";
|
|
1784
|
+
readonly auth: "merchant";
|
|
1785
|
+
readonly permission: {
|
|
1786
|
+
readonly merchant: "merchant:config:read";
|
|
1787
|
+
readonly root: "root:config:read";
|
|
1788
|
+
};
|
|
1789
|
+
readonly sensitive: false;
|
|
1790
|
+
readonly mountedWhen: null;
|
|
1791
|
+
readonly request: null;
|
|
1792
|
+
readonly responses: {
|
|
1793
|
+
readonly 200: "ListPage<PSP>";
|
|
1794
|
+
};
|
|
1795
|
+
readonly errors: readonly ["invalid_cursor", "invalid_param", "invalid_query", "service_unavailable"];
|
|
1796
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1797
|
+
}, {
|
|
1798
|
+
readonly method: "POST";
|
|
1799
|
+
readonly path: "/v1/merchant/psps";
|
|
1800
|
+
readonly group: "merchant_config";
|
|
1801
|
+
readonly auth: "merchant";
|
|
1802
|
+
readonly permission: {
|
|
1803
|
+
readonly merchant: "merchant:config:manage";
|
|
1804
|
+
readonly root: "root:config:manage";
|
|
1805
|
+
};
|
|
1806
|
+
readonly sensitive: false;
|
|
1807
|
+
readonly mountedWhen: "merchant_config_edits";
|
|
1808
|
+
readonly request: "CreatePSPParams";
|
|
1809
|
+
readonly responses: {
|
|
1810
|
+
readonly 201: "PSP";
|
|
1811
|
+
};
|
|
1812
|
+
readonly errors: readonly ["invalid_param", "psp_claim_requires_proof", "psp_credentials_rejected", "psp_exists", "psp_key_taken", "revision_mismatch", "service_unavailable"];
|
|
1813
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1814
|
+
}, {
|
|
1815
|
+
readonly method: "GET";
|
|
1816
|
+
readonly path: "/v1/merchant/psps/{id}";
|
|
1817
|
+
readonly group: "merchant_config";
|
|
1818
|
+
readonly auth: "merchant";
|
|
1819
|
+
readonly permission: {
|
|
1820
|
+
readonly merchant: "merchant:config:read";
|
|
1821
|
+
readonly root: "root:config:read";
|
|
1822
|
+
};
|
|
1823
|
+
readonly sensitive: false;
|
|
1824
|
+
readonly mountedWhen: null;
|
|
1825
|
+
readonly request: null;
|
|
1826
|
+
readonly responses: {
|
|
1827
|
+
readonly 200: "PSP";
|
|
1828
|
+
};
|
|
1829
|
+
readonly errors: readonly ["invalid_param", "psp_not_found", "service_unavailable"];
|
|
1830
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
1831
|
+
}, {
|
|
1832
|
+
readonly method: "PATCH";
|
|
1833
|
+
readonly path: "/v1/merchant/psps/{id}";
|
|
1834
|
+
readonly group: "merchant_config";
|
|
1835
|
+
readonly auth: "merchant";
|
|
1836
|
+
readonly permission: {
|
|
1837
|
+
readonly merchant: "merchant:config:manage";
|
|
1838
|
+
readonly root: "root:config:manage";
|
|
1839
|
+
};
|
|
1840
|
+
readonly sensitive: false;
|
|
1841
|
+
readonly mountedWhen: "merchant_config_edits";
|
|
1842
|
+
readonly request: "UpdatePSPParams";
|
|
1843
|
+
readonly responses: {
|
|
1844
|
+
readonly 200: "PSP";
|
|
1845
|
+
};
|
|
1846
|
+
readonly errors: readonly ["invalid_param", "psp_credentials_rejected", "psp_last_active", "psp_not_found", "revision_mismatch", "service_unavailable"];
|
|
1847
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1848
|
+
}, {
|
|
1849
|
+
readonly method: "POST";
|
|
1850
|
+
readonly path: "/v1/merchant/psps/routing-preview";
|
|
1851
|
+
readonly group: "merchant_config";
|
|
1852
|
+
readonly auth: "merchant";
|
|
1853
|
+
readonly permission: {
|
|
1854
|
+
readonly merchant: "merchant:config:read";
|
|
1855
|
+
readonly root: "root:config:read";
|
|
1856
|
+
};
|
|
1857
|
+
readonly sensitive: false;
|
|
1858
|
+
readonly mountedWhen: null;
|
|
1859
|
+
readonly request: "PreviewPSPRoutingParams";
|
|
1860
|
+
readonly responses: {
|
|
1861
|
+
readonly 200: "PSPRoutingPreview";
|
|
1862
|
+
};
|
|
1863
|
+
readonly errors: readonly ["invalid_param"];
|
|
1864
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1865
|
+
}, {
|
|
1866
|
+
readonly method: "POST";
|
|
1867
|
+
readonly path: "/v1/merchant/psps/refresh";
|
|
1868
|
+
readonly group: "merchant_config";
|
|
1869
|
+
readonly auth: "merchant";
|
|
1870
|
+
readonly permission: {
|
|
1871
|
+
readonly merchant: "merchant:config:manage";
|
|
1872
|
+
readonly root: "root:config:manage";
|
|
1873
|
+
};
|
|
1874
|
+
readonly sensitive: false;
|
|
1875
|
+
readonly mountedWhen: null;
|
|
1876
|
+
readonly request: null;
|
|
1877
|
+
readonly responses: {
|
|
1878
|
+
readonly 202: "PSPRefresh";
|
|
1879
|
+
};
|
|
1880
|
+
readonly errors: readonly ["service_unavailable"];
|
|
1881
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
1882
|
+
}, {
|
|
1883
|
+
readonly method: "POST";
|
|
1884
|
+
readonly path: "/v1/webhooks/{rail}/{account_id}";
|
|
1885
|
+
readonly group: "webhooks";
|
|
1886
|
+
readonly auth: "provider_signature";
|
|
1887
|
+
readonly permission: null;
|
|
1888
|
+
readonly sensitive: false;
|
|
1889
|
+
readonly mountedWhen: null;
|
|
1890
|
+
readonly request: "application/json";
|
|
1891
|
+
readonly responses: {
|
|
1892
|
+
readonly 200: "WebhookReceipt";
|
|
1893
|
+
};
|
|
1894
|
+
readonly errors: readonly ["authentication_required", "invalid_param", "resource_access_denied", "service_unavailable", "webhook_account_mismatch"];
|
|
1895
|
+
readonly errorSets: readonly ["tier:provider_signature", "request"];
|
|
1896
|
+
}, {
|
|
1897
|
+
readonly method: "GET";
|
|
1898
|
+
readonly path: "/v1/merchant/configuration";
|
|
1899
|
+
readonly group: "merchant_config";
|
|
1900
|
+
readonly auth: "merchant";
|
|
1901
|
+
readonly permission: {
|
|
1902
|
+
readonly merchant: "merchant:config:read";
|
|
1903
|
+
readonly root: "root:config:read";
|
|
1904
|
+
};
|
|
1905
|
+
readonly sensitive: false;
|
|
1906
|
+
readonly mountedWhen: null;
|
|
1907
|
+
readonly request: null;
|
|
1908
|
+
readonly responses: {
|
|
1909
|
+
readonly 200: "MerchantConfigurationState";
|
|
1910
|
+
};
|
|
1911
|
+
readonly errors: readonly [];
|
|
1912
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
1913
|
+
}, {
|
|
1914
|
+
readonly method: "PATCH";
|
|
1915
|
+
readonly path: "/v1/merchant/configuration";
|
|
1916
|
+
readonly group: "merchant_config";
|
|
1917
|
+
readonly auth: "merchant";
|
|
1918
|
+
readonly permission: {
|
|
1919
|
+
readonly merchant: "merchant:config:manage";
|
|
1920
|
+
readonly root: "root:config:manage";
|
|
1921
|
+
};
|
|
1922
|
+
readonly sensitive: false;
|
|
1923
|
+
readonly mountedWhen: "merchant_config_edits";
|
|
1924
|
+
readonly request: "UpdateMerchantConfigurationParams";
|
|
1925
|
+
readonly responses: {
|
|
1926
|
+
readonly 200: "MerchantConfigurationState";
|
|
1927
|
+
};
|
|
1928
|
+
readonly errors: readonly ["invalid_param", "revision_mismatch", "service_unavailable"];
|
|
1929
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1930
|
+
}, {
|
|
1931
|
+
readonly method: "GET";
|
|
1932
|
+
readonly path: "/v1/merchant/alert-webhooks";
|
|
1933
|
+
readonly group: "merchant_config";
|
|
1934
|
+
readonly auth: "merchant";
|
|
1935
|
+
readonly permission: {
|
|
1936
|
+
readonly merchant: "merchant:config:read";
|
|
1937
|
+
readonly root: "root:config:read";
|
|
1938
|
+
};
|
|
1939
|
+
readonly sensitive: false;
|
|
1940
|
+
readonly mountedWhen: null;
|
|
1941
|
+
readonly request: null;
|
|
1942
|
+
readonly responses: {
|
|
1943
|
+
readonly 200: "ListPage<AlertWebhook>";
|
|
1944
|
+
};
|
|
1945
|
+
readonly errors: readonly ["service_unavailable"];
|
|
1946
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1947
|
+
}, {
|
|
1948
|
+
readonly method: "POST";
|
|
1949
|
+
readonly path: "/v1/merchant/alert-webhooks";
|
|
1950
|
+
readonly group: "merchant_config";
|
|
1951
|
+
readonly auth: "merchant";
|
|
1952
|
+
readonly permission: {
|
|
1953
|
+
readonly merchant: "merchant:config:manage";
|
|
1954
|
+
readonly root: "root:config:manage";
|
|
1955
|
+
};
|
|
1956
|
+
readonly sensitive: false;
|
|
1957
|
+
readonly mountedWhen: "merchant_config_edits";
|
|
1958
|
+
readonly request: "CreateAlertWebhookParams";
|
|
1959
|
+
readonly responses: {
|
|
1960
|
+
readonly 201: "AlertWebhook";
|
|
1961
|
+
};
|
|
1962
|
+
readonly errors: readonly ["service_unavailable", "webhook_invalid"];
|
|
1963
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1964
|
+
}, {
|
|
1965
|
+
readonly method: "DELETE";
|
|
1966
|
+
readonly path: "/v1/merchant/alert-webhooks/{id}";
|
|
1967
|
+
readonly group: "merchant_config";
|
|
1968
|
+
readonly auth: "merchant";
|
|
1969
|
+
readonly permission: {
|
|
1970
|
+
readonly merchant: "merchant:config:manage";
|
|
1971
|
+
readonly root: "root:config:manage";
|
|
1972
|
+
};
|
|
1973
|
+
readonly sensitive: false;
|
|
1974
|
+
readonly mountedWhen: "merchant_config_edits";
|
|
1975
|
+
readonly request: null;
|
|
1976
|
+
readonly responses: {
|
|
1977
|
+
readonly 204: null;
|
|
1978
|
+
};
|
|
1979
|
+
readonly errors: readonly ["invalid_param", "resource_not_found", "service_unavailable"];
|
|
1980
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
1981
|
+
}, {
|
|
1982
|
+
readonly method: "PATCH";
|
|
1983
|
+
readonly path: "/v1/merchant/alert-webhooks/{id}";
|
|
1984
|
+
readonly group: "merchant_config";
|
|
1985
|
+
readonly auth: "merchant";
|
|
1986
|
+
readonly permission: {
|
|
1987
|
+
readonly merchant: "merchant:config:manage";
|
|
1988
|
+
readonly root: "root:config:manage";
|
|
1989
|
+
};
|
|
1990
|
+
readonly sensitive: false;
|
|
1991
|
+
readonly mountedWhen: "merchant_config_edits";
|
|
1992
|
+
readonly request: "UpdateAlertWebhookParams";
|
|
1993
|
+
readonly responses: {
|
|
1994
|
+
readonly 200: "AlertWebhook";
|
|
1995
|
+
};
|
|
1996
|
+
readonly errors: readonly ["invalid_param", "resource_not_found", "service_unavailable", "webhook_invalid"];
|
|
1997
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
1998
|
+
}, {
|
|
1999
|
+
readonly method: "GET";
|
|
2000
|
+
readonly path: "/v1/merchant/billing-archive";
|
|
2001
|
+
readonly group: "merchant_config";
|
|
2002
|
+
readonly auth: "merchant";
|
|
2003
|
+
readonly permission: {
|
|
2004
|
+
readonly merchant: "merchant:config:manage";
|
|
2005
|
+
readonly root: "root:config:manage";
|
|
2006
|
+
};
|
|
2007
|
+
readonly sensitive: false;
|
|
2008
|
+
readonly mountedWhen: null;
|
|
2009
|
+
readonly request: null;
|
|
2010
|
+
readonly responses: {
|
|
2011
|
+
readonly 200: "application/x-ndjson";
|
|
2012
|
+
};
|
|
2013
|
+
readonly errors: readonly ["billing_archive_unavailable", "billing_archive_unsupported_state"];
|
|
2014
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
2015
|
+
}, {
|
|
2016
|
+
readonly method: "POST";
|
|
2017
|
+
readonly path: "/v1/merchant/billing-archive";
|
|
2018
|
+
readonly group: "merchant_config";
|
|
2019
|
+
readonly auth: "merchant";
|
|
2020
|
+
readonly permission: {
|
|
2021
|
+
readonly merchant: "merchant:config:manage";
|
|
2022
|
+
readonly root: "root:config:manage";
|
|
2023
|
+
};
|
|
2024
|
+
readonly sensitive: false;
|
|
2025
|
+
readonly mountedWhen: null;
|
|
2026
|
+
readonly request: "application/x-ndjson";
|
|
2027
|
+
readonly responses: {
|
|
2028
|
+
readonly 200: "BillingArchiveImport";
|
|
2029
|
+
};
|
|
2030
|
+
readonly errors: readonly ["billing_archive_integrity", "billing_archive_invalid_artifact", "billing_archive_merchant_mismatch", "billing_archive_not_empty", "billing_archive_unavailable", "billing_archive_unsupported_state", "request_body_too_large"];
|
|
2031
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
2032
|
+
}, {
|
|
2033
|
+
readonly method: "POST";
|
|
2034
|
+
readonly path: "/v1/merchant/billing-import";
|
|
2035
|
+
readonly group: "merchant_config";
|
|
2036
|
+
readonly auth: "merchant";
|
|
2037
|
+
readonly permission: {
|
|
2038
|
+
readonly merchant: "merchant:config:manage";
|
|
2039
|
+
readonly root: "root:config:manage";
|
|
2040
|
+
};
|
|
2041
|
+
readonly sensitive: false;
|
|
2042
|
+
readonly mountedWhen: null;
|
|
2043
|
+
readonly request: "DeclaredBilling";
|
|
2044
|
+
readonly responses: {
|
|
2045
|
+
readonly 200: "BillingImportResult";
|
|
2046
|
+
};
|
|
2047
|
+
readonly errors: readonly ["as_of_required", "invalid_param", "invalid_psp_reference", "resource_conflict"];
|
|
2048
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
2049
|
+
}, {
|
|
2050
|
+
readonly method: "POST";
|
|
2051
|
+
readonly path: "/v1/app/notification-consumers/{name}";
|
|
2052
|
+
readonly group: "app";
|
|
2053
|
+
readonly auth: "application";
|
|
2054
|
+
readonly permission: {
|
|
2055
|
+
readonly merchant: "merchant:events:read";
|
|
2056
|
+
readonly root: "root:events:read";
|
|
2057
|
+
};
|
|
2058
|
+
readonly sensitive: false;
|
|
2059
|
+
readonly mountedWhen: null;
|
|
2060
|
+
readonly request: null;
|
|
2061
|
+
readonly responses: {
|
|
2062
|
+
readonly 204: null;
|
|
2063
|
+
};
|
|
2064
|
+
readonly errors: readonly ["invalid_param"];
|
|
2065
|
+
readonly errorSets: readonly ["tier:application"];
|
|
2066
|
+
}, {
|
|
2067
|
+
readonly method: "GET";
|
|
2068
|
+
readonly path: "/v1/app/notification-consumers/{name}/events";
|
|
2069
|
+
readonly group: "app";
|
|
2070
|
+
readonly auth: "application";
|
|
2071
|
+
readonly permission: {
|
|
2072
|
+
readonly merchant: "merchant:events:read";
|
|
2073
|
+
readonly root: "root:events:read";
|
|
2074
|
+
};
|
|
2075
|
+
readonly sensitive: false;
|
|
2076
|
+
readonly mountedWhen: null;
|
|
2077
|
+
readonly request: null;
|
|
2078
|
+
readonly responses: {
|
|
2079
|
+
readonly 200: "NotificationEvents";
|
|
2080
|
+
};
|
|
2081
|
+
readonly errors: readonly ["invalid_param", "resource_not_found"];
|
|
2082
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
2083
|
+
}, {
|
|
2084
|
+
readonly method: "POST";
|
|
2085
|
+
readonly path: "/v1/app/notification-consumers/{name}/acknowledge";
|
|
2086
|
+
readonly group: "app";
|
|
2087
|
+
readonly auth: "application";
|
|
2088
|
+
readonly permission: {
|
|
2089
|
+
readonly merchant: "merchant:events:read";
|
|
2090
|
+
readonly root: "root:events:read";
|
|
2091
|
+
};
|
|
2092
|
+
readonly sensitive: false;
|
|
2093
|
+
readonly mountedWhen: null;
|
|
2094
|
+
readonly request: "AcknowledgeNotificationEventsParams";
|
|
2095
|
+
readonly responses: {
|
|
2096
|
+
readonly 204: null;
|
|
2097
|
+
};
|
|
2098
|
+
readonly errors: readonly ["invalid_param", "resource_not_found"];
|
|
2099
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
2100
|
+
}, {
|
|
2101
|
+
readonly method: "DELETE";
|
|
2102
|
+
readonly path: "/v1/app/notification-consumers/{name}";
|
|
2103
|
+
readonly group: "app";
|
|
2104
|
+
readonly auth: "application";
|
|
2105
|
+
readonly permission: {
|
|
2106
|
+
readonly merchant: "merchant:events:read";
|
|
2107
|
+
readonly root: "root:events:read";
|
|
2108
|
+
};
|
|
2109
|
+
readonly sensitive: false;
|
|
2110
|
+
readonly mountedWhen: null;
|
|
2111
|
+
readonly request: null;
|
|
2112
|
+
readonly responses: {
|
|
2113
|
+
readonly 204: null;
|
|
2114
|
+
};
|
|
2115
|
+
readonly errors: readonly ["invalid_param"];
|
|
2116
|
+
readonly errorSets: readonly ["tier:application"];
|
|
2117
|
+
}, {
|
|
2118
|
+
readonly method: "GET";
|
|
2119
|
+
readonly path: "/v1/app/host-events";
|
|
2120
|
+
readonly group: "app";
|
|
2121
|
+
readonly auth: "application";
|
|
2122
|
+
readonly permission: {
|
|
2123
|
+
readonly merchant: "merchant:events:read";
|
|
2124
|
+
readonly root: "root:events:read";
|
|
2125
|
+
};
|
|
2126
|
+
readonly sensitive: false;
|
|
2127
|
+
readonly mountedWhen: null;
|
|
2128
|
+
readonly request: null;
|
|
2129
|
+
readonly responses: {
|
|
2130
|
+
readonly 200: "ListPage<HostEvent>";
|
|
2131
|
+
};
|
|
2132
|
+
readonly errors: readonly ["invalid_cursor", "invalid_host_event_request"];
|
|
2133
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
2134
|
+
}, {
|
|
2135
|
+
readonly method: "POST";
|
|
2136
|
+
readonly path: "/v1/app/host-events/acknowledge";
|
|
2137
|
+
readonly group: "app";
|
|
2138
|
+
readonly auth: "application";
|
|
2139
|
+
readonly permission: {
|
|
2140
|
+
readonly merchant: "merchant:events:read";
|
|
2141
|
+
readonly root: "root:events:read";
|
|
2142
|
+
};
|
|
2143
|
+
readonly sensitive: false;
|
|
2144
|
+
readonly mountedWhen: null;
|
|
2145
|
+
readonly request: "AcknowledgeHostEventsParams";
|
|
2146
|
+
readonly responses: {
|
|
2147
|
+
readonly 200: "HostEventLookup";
|
|
2148
|
+
};
|
|
2149
|
+
readonly errors: readonly ["invalid_param"];
|
|
2150
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
2151
|
+
}, {
|
|
2152
|
+
readonly method: "GET";
|
|
2153
|
+
readonly path: "/v1/admin/access";
|
|
2154
|
+
readonly group: "access";
|
|
2155
|
+
readonly auth: "signed_in";
|
|
2156
|
+
readonly permission: null;
|
|
2157
|
+
readonly sensitive: false;
|
|
2158
|
+
readonly mountedWhen: null;
|
|
2159
|
+
readonly request: null;
|
|
2160
|
+
readonly responses: {
|
|
2161
|
+
readonly 200: "AdminAccess";
|
|
2162
|
+
};
|
|
2163
|
+
readonly errors: readonly [];
|
|
2164
|
+
readonly errorSets: readonly ["tier:signed_in"];
|
|
2165
|
+
}, {
|
|
2166
|
+
readonly method: "POST";
|
|
2167
|
+
readonly path: "/v1/metrics/query";
|
|
2168
|
+
readonly group: "metrics";
|
|
2169
|
+
readonly auth: "merchant";
|
|
2170
|
+
readonly permission: {
|
|
2171
|
+
readonly merchant: "merchant:metrics:read";
|
|
2172
|
+
readonly root: "root:metrics:read";
|
|
2173
|
+
};
|
|
2174
|
+
readonly sensitive: false;
|
|
2175
|
+
readonly mountedWhen: null;
|
|
2176
|
+
readonly request: "MetricsQuery";
|
|
2177
|
+
readonly responses: {
|
|
2178
|
+
readonly 200: "MetricsResult";
|
|
2179
|
+
};
|
|
2180
|
+
readonly errors: readonly ["metrics_query_invalid", "service_unavailable"];
|
|
2181
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
2182
|
+
}, {
|
|
2183
|
+
readonly method: "GET";
|
|
2184
|
+
readonly path: "/v1/metrics/schema";
|
|
2185
|
+
readonly group: "metrics";
|
|
2186
|
+
readonly auth: "merchant";
|
|
2187
|
+
readonly permission: {
|
|
2188
|
+
readonly merchant: "merchant:metrics:read";
|
|
2189
|
+
readonly root: "root:metrics:read";
|
|
2190
|
+
};
|
|
2191
|
+
readonly sensitive: false;
|
|
2192
|
+
readonly mountedWhen: null;
|
|
2193
|
+
readonly request: null;
|
|
2194
|
+
readonly responses: {
|
|
2195
|
+
readonly 200: "MetricsSchema";
|
|
2196
|
+
};
|
|
2197
|
+
readonly errors: readonly [];
|
|
2198
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
2199
|
+
}, {
|
|
2200
|
+
readonly method: "GET";
|
|
2201
|
+
readonly path: "/v1/metrics/dashboard";
|
|
2202
|
+
readonly group: "metrics";
|
|
2203
|
+
readonly auth: "merchant";
|
|
2204
|
+
readonly permission: {
|
|
2205
|
+
readonly merchant: "merchant:metrics:read";
|
|
2206
|
+
readonly root: "root:metrics:read";
|
|
2207
|
+
};
|
|
2208
|
+
readonly sensitive: false;
|
|
2209
|
+
readonly mountedWhen: null;
|
|
2210
|
+
readonly request: null;
|
|
2211
|
+
readonly responses: {
|
|
2212
|
+
readonly 200: "Dashboard";
|
|
2213
|
+
};
|
|
2214
|
+
readonly errors: readonly ["service_unavailable"];
|
|
2215
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
2216
|
+
}, {
|
|
2217
|
+
readonly method: "PUT";
|
|
2218
|
+
readonly path: "/v1/merchant/dashboard";
|
|
2219
|
+
readonly group: "merchant_config";
|
|
2220
|
+
readonly auth: "merchant";
|
|
2221
|
+
readonly permission: {
|
|
2222
|
+
readonly merchant: "merchant:config:manage";
|
|
2223
|
+
readonly root: "root:config:manage";
|
|
2224
|
+
};
|
|
2225
|
+
readonly sensitive: false;
|
|
2226
|
+
readonly mountedWhen: null;
|
|
2227
|
+
readonly request: "SetDashboardParams";
|
|
2228
|
+
readonly responses: {
|
|
2229
|
+
readonly 200: "Dashboard";
|
|
2230
|
+
};
|
|
2231
|
+
readonly errors: readonly ["dashboard_invalid", "service_unavailable"];
|
|
2232
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
2233
|
+
}, {
|
|
2234
|
+
readonly method: "GET";
|
|
2235
|
+
readonly path: "/v1/merchant/findings";
|
|
2236
|
+
readonly group: "merchant_config";
|
|
2237
|
+
readonly auth: "merchant";
|
|
2238
|
+
readonly permission: {
|
|
2239
|
+
readonly merchant: "merchant:config:read";
|
|
2240
|
+
readonly root: "root:config:read";
|
|
2241
|
+
};
|
|
2242
|
+
readonly sensitive: false;
|
|
2243
|
+
readonly mountedWhen: null;
|
|
2244
|
+
readonly request: null;
|
|
2245
|
+
readonly responses: {
|
|
2246
|
+
readonly 200: "ListPage<Finding>";
|
|
2247
|
+
};
|
|
2248
|
+
readonly errors: readonly ["invalid_cursor", "service_unavailable"];
|
|
2249
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
2250
|
+
}, {
|
|
2251
|
+
readonly method: "GET";
|
|
2252
|
+
readonly path: "/v1/merchant/findings/{id}";
|
|
2253
|
+
readonly group: "merchant_config";
|
|
2254
|
+
readonly auth: "merchant";
|
|
2255
|
+
readonly permission: {
|
|
2256
|
+
readonly merchant: "merchant:config:read";
|
|
2257
|
+
readonly root: "root:config:read";
|
|
2258
|
+
};
|
|
2259
|
+
readonly sensitive: false;
|
|
2260
|
+
readonly mountedWhen: null;
|
|
2261
|
+
readonly request: null;
|
|
2262
|
+
readonly responses: {
|
|
2263
|
+
readonly 200: "Finding";
|
|
2264
|
+
};
|
|
2265
|
+
readonly errors: readonly ["invalid_param", "resource_not_found", "service_unavailable"];
|
|
2266
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
2267
|
+
}, {
|
|
2268
|
+
readonly method: "POST";
|
|
2269
|
+
readonly path: "/v1/merchant/findings/{id}/resolve";
|
|
2270
|
+
readonly group: "merchant_config";
|
|
2271
|
+
readonly auth: "merchant";
|
|
2272
|
+
readonly permission: {
|
|
2273
|
+
readonly merchant: "merchant:config:manage";
|
|
2274
|
+
readonly root: "root:config:manage";
|
|
2275
|
+
};
|
|
2276
|
+
readonly sensitive: false;
|
|
2277
|
+
readonly mountedWhen: null;
|
|
2278
|
+
readonly request: "ResolveFindingParams";
|
|
2279
|
+
readonly responses: {
|
|
2280
|
+
readonly 200: "FindingResolution";
|
|
2281
|
+
};
|
|
2282
|
+
readonly errors: readonly ["finding_action_failed", "finding_not_actionable", "idempotency_key_reused", "invalid_param", "payment_not_found", "payment_not_refundable", "provider_cancel_held", "rebill_terms_committed", "refund_failed", "refund_rail_unavailable", "refund_unsupported", "resource_conflict", "resource_not_found", "service_unavailable"];
|
|
2283
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
2284
|
+
}, {
|
|
2285
|
+
readonly method: "GET";
|
|
2286
|
+
readonly path: "/v1/merchant/provisioning-tokens";
|
|
2287
|
+
readonly group: "merchant_config";
|
|
2288
|
+
readonly auth: "merchant";
|
|
2289
|
+
readonly permission: {
|
|
2290
|
+
readonly merchant: "merchant:config:read";
|
|
2291
|
+
readonly root: "root:config:read";
|
|
2292
|
+
};
|
|
2293
|
+
readonly sensitive: false;
|
|
2294
|
+
readonly mountedWhen: "customer_provisioning";
|
|
2295
|
+
readonly request: null;
|
|
2296
|
+
readonly responses: {
|
|
2297
|
+
readonly 200: "ListPage<ProvisioningToken>";
|
|
2298
|
+
};
|
|
2299
|
+
readonly errors: readonly [];
|
|
2300
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
2301
|
+
}, {
|
|
2302
|
+
readonly method: "POST";
|
|
2303
|
+
readonly path: "/v1/merchant/provisioning-tokens";
|
|
2304
|
+
readonly group: "merchant_config";
|
|
2305
|
+
readonly auth: "merchant";
|
|
2306
|
+
readonly permission: {
|
|
2307
|
+
readonly merchant: "merchant:config:manage";
|
|
2308
|
+
readonly root: "root:config:manage";
|
|
2309
|
+
};
|
|
2310
|
+
readonly sensitive: false;
|
|
2311
|
+
readonly mountedWhen: "customer_provisioning";
|
|
2312
|
+
readonly request: "CreateProvisioningTokenParams";
|
|
2313
|
+
readonly responses: {
|
|
2314
|
+
readonly 201: "CreatedProvisioningToken";
|
|
2315
|
+
};
|
|
2316
|
+
readonly errors: readonly ["invalid_param"];
|
|
2317
|
+
readonly errorSets: readonly ["tier:merchant", "request"];
|
|
2318
|
+
}, {
|
|
2319
|
+
readonly method: "DELETE";
|
|
2320
|
+
readonly path: "/v1/merchant/provisioning-tokens/{id}";
|
|
2321
|
+
readonly group: "merchant_config";
|
|
2322
|
+
readonly auth: "merchant";
|
|
2323
|
+
readonly permission: {
|
|
2324
|
+
readonly merchant: "merchant:config:manage";
|
|
2325
|
+
readonly root: "root:config:manage";
|
|
2326
|
+
};
|
|
2327
|
+
readonly sensitive: false;
|
|
2328
|
+
readonly mountedWhen: "customer_provisioning";
|
|
2329
|
+
readonly request: null;
|
|
2330
|
+
readonly responses: {
|
|
2331
|
+
readonly 204: null;
|
|
2332
|
+
};
|
|
2333
|
+
readonly errors: readonly ["invalid_param", "resource_not_found"];
|
|
2334
|
+
readonly errorSets: readonly ["tier:merchant"];
|
|
2335
|
+
}, {
|
|
2336
|
+
readonly method: "POST";
|
|
2337
|
+
readonly path: "/v1/me/network-link/challenges";
|
|
2338
|
+
readonly group: "customer";
|
|
2339
|
+
readonly auth: "customer";
|
|
2340
|
+
readonly permission: null;
|
|
2341
|
+
readonly sensitive: false;
|
|
2342
|
+
readonly mountedWhen: "customer_network";
|
|
2343
|
+
readonly request: null;
|
|
2344
|
+
readonly responses: {
|
|
2345
|
+
readonly 201: "NetworkLinkChallenge";
|
|
2346
|
+
};
|
|
2347
|
+
readonly errors: readonly ["service_unavailable"];
|
|
2348
|
+
readonly errorSets: readonly ["tier:customer"];
|
|
2349
|
+
}, {
|
|
2350
|
+
readonly method: "POST";
|
|
2351
|
+
readonly path: "/v1/me/network-link";
|
|
2352
|
+
readonly group: "customer";
|
|
2353
|
+
readonly auth: "customer";
|
|
2354
|
+
readonly permission: null;
|
|
2355
|
+
readonly sensitive: false;
|
|
2356
|
+
readonly mountedWhen: "customer_network";
|
|
2357
|
+
readonly request: "CreateNetworkLinkParams";
|
|
2358
|
+
readonly responses: {
|
|
2359
|
+
readonly 200: "CustomerLink";
|
|
2360
|
+
readonly 201: "CustomerLink";
|
|
2361
|
+
};
|
|
2362
|
+
readonly errors: readonly ["network_account_linked", "network_link_challenge_invalid", "network_link_conflict", "network_terms_required", "service_unavailable"];
|
|
2363
|
+
readonly errorSets: readonly ["tier:customer", "request"];
|
|
2364
|
+
}, {
|
|
2365
|
+
readonly method: "GET";
|
|
2366
|
+
readonly path: "/v1/app/customers";
|
|
2367
|
+
readonly group: "app";
|
|
2368
|
+
readonly auth: "application";
|
|
2369
|
+
readonly permission: {
|
|
2370
|
+
readonly merchant: "merchant:customers:read";
|
|
2371
|
+
readonly root: "root:customers:read";
|
|
2372
|
+
};
|
|
2373
|
+
readonly sensitive: false;
|
|
2374
|
+
readonly mountedWhen: "customer_network";
|
|
2375
|
+
readonly request: null;
|
|
2376
|
+
readonly responses: {
|
|
2377
|
+
readonly 200: "ListPage<Customer>";
|
|
2378
|
+
};
|
|
2379
|
+
readonly errors: readonly ["service_unavailable"];
|
|
2380
|
+
readonly errorSets: readonly ["tier:application", "request"];
|
|
2381
|
+
}, {
|
|
2382
|
+
readonly method: "GET";
|
|
2383
|
+
readonly path: "/v1/network/links";
|
|
2384
|
+
readonly group: "network";
|
|
2385
|
+
readonly auth: "network";
|
|
2386
|
+
readonly permission: null;
|
|
2387
|
+
readonly sensitive: false;
|
|
2388
|
+
readonly mountedWhen: "customer_network";
|
|
2389
|
+
readonly request: null;
|
|
2390
|
+
readonly responses: {
|
|
2391
|
+
readonly 200: "ListPage<NetworkLink>";
|
|
2392
|
+
};
|
|
2393
|
+
readonly errors: readonly ["invalid_cursor", "service_unavailable"];
|
|
2394
|
+
readonly errorSets: readonly ["tier:network", "request"];
|
|
2395
|
+
}, {
|
|
2396
|
+
readonly method: "GET";
|
|
2397
|
+
readonly path: "/v1/network/subscriptions";
|
|
2398
|
+
readonly group: "network";
|
|
2399
|
+
readonly auth: "network";
|
|
2400
|
+
readonly permission: null;
|
|
2401
|
+
readonly sensitive: false;
|
|
2402
|
+
readonly mountedWhen: "customer_network";
|
|
2403
|
+
readonly request: null;
|
|
2404
|
+
readonly responses: {
|
|
2405
|
+
readonly 200: "ListPage<NetworkSubscription>";
|
|
2406
|
+
};
|
|
2407
|
+
readonly errors: readonly ["invalid_cursor", "service_unavailable"];
|
|
2408
|
+
readonly errorSets: readonly ["tier:network", "request"];
|
|
2409
|
+
}, {
|
|
2410
|
+
readonly method: "GET";
|
|
2411
|
+
readonly path: "/v1/network/orders";
|
|
2412
|
+
readonly group: "network";
|
|
2413
|
+
readonly auth: "network";
|
|
2414
|
+
readonly permission: null;
|
|
2415
|
+
readonly sensitive: false;
|
|
2416
|
+
readonly mountedWhen: "customer_network";
|
|
2417
|
+
readonly request: null;
|
|
2418
|
+
readonly responses: {
|
|
2419
|
+
readonly 200: "ListPage<NetworkOrder>";
|
|
2420
|
+
};
|
|
2421
|
+
readonly errors: readonly ["invalid_cursor", "service_unavailable"];
|
|
2422
|
+
readonly errorSets: readonly ["tier:network", "request"];
|
|
2423
|
+
}, {
|
|
2424
|
+
readonly method: "DELETE";
|
|
2425
|
+
readonly path: "/v1/network/links/{link_id}";
|
|
2426
|
+
readonly group: "network";
|
|
2427
|
+
readonly auth: "network";
|
|
2428
|
+
readonly permission: null;
|
|
2429
|
+
readonly sensitive: true;
|
|
2430
|
+
readonly mountedWhen: "customer_network";
|
|
2431
|
+
readonly request: null;
|
|
2432
|
+
readonly responses: {
|
|
2433
|
+
readonly 204: null;
|
|
2434
|
+
};
|
|
2435
|
+
readonly errors: readonly ["invalid_param", "network_link_in_use", "service_unavailable"];
|
|
2436
|
+
readonly errorSets: readonly ["tier:network"];
|
|
2437
|
+
}, {
|
|
2438
|
+
readonly method: "GET";
|
|
2439
|
+
readonly path: "/v1/network/links/{link_id}/subscriptions/{id}";
|
|
2440
|
+
readonly group: "network";
|
|
2441
|
+
readonly auth: "network";
|
|
2442
|
+
readonly permission: null;
|
|
2443
|
+
readonly sensitive: false;
|
|
2444
|
+
readonly mountedWhen: "customer_network";
|
|
2445
|
+
readonly request: null;
|
|
2446
|
+
readonly responses: {
|
|
2447
|
+
readonly 200: "Subscription";
|
|
2448
|
+
};
|
|
2449
|
+
readonly errors: readonly ["authentication_required", "invalid_param", "resource_not_found", "subscription_not_found"];
|
|
2450
|
+
readonly errorSets: readonly ["tier:network"];
|
|
2451
|
+
}, {
|
|
2452
|
+
readonly method: "POST";
|
|
2453
|
+
readonly path: "/v1/network/links/{link_id}/subscriptions/{id}/cancel";
|
|
2454
|
+
readonly group: "network";
|
|
2455
|
+
readonly auth: "network";
|
|
2456
|
+
readonly permission: null;
|
|
2457
|
+
readonly sensitive: true;
|
|
2458
|
+
readonly mountedWhen: "customer_network";
|
|
2459
|
+
readonly request: "CustomerCancelSubscriptionParams";
|
|
2460
|
+
readonly responses: {
|
|
2461
|
+
readonly 200: "Subscription";
|
|
2462
|
+
};
|
|
2463
|
+
readonly errors: readonly ["authentication_required", "cancel_unsupported_on_rail", "invalid_param", "payment_in_progress", "provider_cancel_held", "service_unavailable", "solana_rpc_unavailable", "solana_transaction_refused", "subscription_not_active", "subscription_not_found"];
|
|
2464
|
+
readonly errorSets: readonly ["tier:network", "request"];
|
|
2465
|
+
}, {
|
|
2466
|
+
readonly method: "POST";
|
|
2467
|
+
readonly path: "/v1/network/links/{link_id}/subscriptions/{id}/resume";
|
|
2468
|
+
readonly group: "network";
|
|
2469
|
+
readonly auth: "network";
|
|
2470
|
+
readonly permission: null;
|
|
2471
|
+
readonly sensitive: true;
|
|
2472
|
+
readonly mountedWhen: "customer_network";
|
|
2473
|
+
readonly request: null;
|
|
2474
|
+
readonly responses: {
|
|
2475
|
+
readonly 200: "Subscription";
|
|
2476
|
+
};
|
|
2477
|
+
readonly errors: readonly ["authentication_required", "invalid_param", "service_unavailable", "subscription_not_found"];
|
|
2478
|
+
readonly errorSets: readonly ["tier:network"];
|
|
2479
|
+
}, {
|
|
2480
|
+
readonly method: "PUT";
|
|
2481
|
+
readonly path: "/v1/network/links/{link_id}/subscriptions/{id}/payment-method";
|
|
2482
|
+
readonly group: "network";
|
|
2483
|
+
readonly auth: "network";
|
|
2484
|
+
readonly permission: null;
|
|
2485
|
+
readonly sensitive: true;
|
|
2486
|
+
readonly mountedWhen: "customer_network";
|
|
2487
|
+
readonly request: "SetSubscriptionPaymentMethodParams";
|
|
2488
|
+
readonly responses: {
|
|
2489
|
+
readonly 200: "Subscription";
|
|
2490
|
+
};
|
|
2491
|
+
readonly errors: readonly ["authentication_required", "card_declined", "default_payment_method_required", "invalid_param", "payment_method_not_psp_vaulted", "payment_method_psp_mismatch", "payment_method_same_vault", "payment_method_stale", "payment_provider_rejected", "rebill_terms_committed", "resource_conflict", "resource_not_found", "service_unavailable"];
|
|
2492
|
+
readonly errorSets: readonly ["tier:network", "request"];
|
|
2493
|
+
}, {
|
|
2494
|
+
readonly method: "GET";
|
|
2495
|
+
readonly path: "/v1/network/links/{link_id}/payment-methods";
|
|
2496
|
+
readonly group: "network";
|
|
2497
|
+
readonly auth: "network";
|
|
2498
|
+
readonly permission: null;
|
|
2499
|
+
readonly sensitive: false;
|
|
2500
|
+
readonly mountedWhen: "customer_network";
|
|
2501
|
+
readonly request: null;
|
|
2502
|
+
readonly responses: {
|
|
2503
|
+
readonly 200: "ListPage<PaymentMethod>";
|
|
2504
|
+
};
|
|
2505
|
+
readonly errors: readonly ["invalid_cursor"];
|
|
2506
|
+
readonly errorSets: readonly ["tier:network", "request"];
|
|
2507
|
+
}, {
|
|
2508
|
+
readonly method: "POST";
|
|
2509
|
+
readonly path: "/v1/network/links/{link_id}/payment-methods";
|
|
2510
|
+
readonly group: "network";
|
|
2511
|
+
readonly auth: "network";
|
|
2512
|
+
readonly permission: null;
|
|
2513
|
+
readonly sensitive: true;
|
|
2514
|
+
readonly mountedWhen: "customer_network";
|
|
2515
|
+
readonly request: "CreatePaymentMethodParams";
|
|
2516
|
+
readonly responses: {
|
|
2517
|
+
readonly 201: "PaymentMethod";
|
|
2518
|
+
};
|
|
2519
|
+
readonly errors: readonly ["card_attempts_blocked", "card_declined", "card_not_saved", "card_requires_https", "invalid_param", "payment_duplicate_refused", "payment_method_stale", "payment_provider_rejected", "provider_outcome_unknown", "service_unavailable"];
|
|
2520
|
+
readonly errorSets: readonly ["tier:network", "request"];
|
|
2521
|
+
}, {
|
|
2522
|
+
readonly method: "DELETE";
|
|
2523
|
+
readonly path: "/v1/network/links/{link_id}/payment-methods/{id}";
|
|
2524
|
+
readonly group: "network";
|
|
2525
|
+
readonly auth: "network";
|
|
2526
|
+
readonly permission: null;
|
|
2527
|
+
readonly sensitive: true;
|
|
2528
|
+
readonly mountedWhen: "customer_network";
|
|
2529
|
+
readonly request: null;
|
|
2530
|
+
readonly responses: {
|
|
2531
|
+
readonly 202: null;
|
|
2532
|
+
readonly 204: null;
|
|
2533
|
+
};
|
|
2534
|
+
readonly errors: readonly ["invalid_param", "payment_method_delete_failed", "payment_method_delete_unsupported", "rate_limit_exceeded", "resource_conflict", "resource_not_found", "service_unavailable"];
|
|
2535
|
+
readonly errorSets: readonly ["tier:network"];
|
|
2536
|
+
}, {
|
|
2537
|
+
readonly method: "GET";
|
|
2538
|
+
readonly path: "/v1/network/links/{link_id}/orders/{id}";
|
|
2539
|
+
readonly group: "network";
|
|
2540
|
+
readonly auth: "network";
|
|
2541
|
+
readonly permission: null;
|
|
2542
|
+
readonly sensitive: false;
|
|
2543
|
+
readonly mountedWhen: "customer_network";
|
|
2544
|
+
readonly request: null;
|
|
2545
|
+
readonly responses: {
|
|
2546
|
+
readonly 200: "Order";
|
|
2547
|
+
};
|
|
2548
|
+
readonly errors: readonly ["resource_not_found", "service_unavailable"];
|
|
2549
|
+
readonly errorSets: readonly ["tier:network"];
|
|
2550
|
+
}, {
|
|
2551
|
+
readonly method: "POST";
|
|
2552
|
+
readonly path: "/v1/network/links/{link_id}/orders/{id}/pay";
|
|
2553
|
+
readonly group: "network";
|
|
2554
|
+
readonly auth: "network";
|
|
2555
|
+
readonly permission: null;
|
|
2556
|
+
readonly sensitive: true;
|
|
2557
|
+
readonly mountedWhen: "customer_network";
|
|
2558
|
+
readonly request: "PayOrderParams";
|
|
2559
|
+
readonly responses: {
|
|
2560
|
+
readonly 200: "Order";
|
|
2561
|
+
};
|
|
2562
|
+
readonly errors: readonly ["card_attempts_blocked", "card_declined", "customer_action_required", "idempotency_key_in_use", "idempotency_key_required", "idempotency_key_reused", "invalid_param", "order_not_payable", "order_payment_in_progress", "order_total_changed", "payment_failed", "payment_method_stale", "payment_option_unavailable", "payment_provider_rejected", "resource_conflict", "resource_not_found", "service_unavailable"];
|
|
2563
|
+
readonly errorSets: readonly ["tier:network", "request"];
|
|
2564
|
+
}, {
|
|
2565
|
+
readonly method: "POST";
|
|
2566
|
+
readonly path: "/v1/network/links/{link_id}/orders/{id}/confirm";
|
|
2567
|
+
readonly group: "network";
|
|
2568
|
+
readonly auth: "network";
|
|
2569
|
+
readonly permission: null;
|
|
2570
|
+
readonly sensitive: true;
|
|
2571
|
+
readonly mountedWhen: "customer_network";
|
|
2572
|
+
readonly request: null;
|
|
2573
|
+
readonly responses: {
|
|
2574
|
+
readonly 200: "Order";
|
|
2575
|
+
};
|
|
2576
|
+
readonly errors: readonly ["card_declined", "customer_action_required", "customer_session_required", "invalid_param", "payment_failed", "resource_conflict", "resource_not_found", "service_unavailable"];
|
|
2577
|
+
readonly errorSets: readonly ["tier:network"];
|
|
2578
|
+
}, {
|
|
2579
|
+
readonly method: "GET";
|
|
2580
|
+
readonly path: "/v1/network/links/{link_id}/agreements";
|
|
2581
|
+
readonly group: "network";
|
|
2582
|
+
readonly auth: "network";
|
|
2583
|
+
readonly permission: null;
|
|
2584
|
+
readonly sensitive: false;
|
|
2585
|
+
readonly mountedWhen: "customer_network";
|
|
2586
|
+
readonly request: null;
|
|
2587
|
+
readonly responses: {
|
|
2588
|
+
readonly 200: "ListPage<Agreement>";
|
|
2589
|
+
};
|
|
2590
|
+
readonly errors: readonly ["invalid_cursor"];
|
|
2591
|
+
readonly errorSets: readonly ["tier:network", "request"];
|
|
2592
|
+
}, {
|
|
2593
|
+
readonly method: "POST";
|
|
2594
|
+
readonly path: "/v1/network/links/{link_id}/agreements/{id}/revoke";
|
|
2595
|
+
readonly group: "network";
|
|
2596
|
+
readonly auth: "network";
|
|
2597
|
+
readonly permission: null;
|
|
2598
|
+
readonly sensitive: true;
|
|
2599
|
+
readonly mountedWhen: "customer_network";
|
|
2600
|
+
readonly request: null;
|
|
2601
|
+
readonly responses: {
|
|
2602
|
+
readonly 200: "AgreementRevocation";
|
|
2603
|
+
};
|
|
2604
|
+
readonly errors: readonly ["cancel_unsupported_on_rail", "customer_action_required", "invalid_param", "payment_in_progress", "provider_cancel_held", "resource_not_found", "service_unavailable", "subscription_not_active"];
|
|
2605
|
+
readonly errorSets: readonly ["tier:network"];
|
|
639
2606
|
}];
|
|
640
2607
|
export declare const OPENRAILS_ERROR_SETS: Readonly<Record<string, readonly string[]>>;
|
|
641
2608
|
export type OpenRailsRouteKey = `${(typeof OPENRAILS_ROUTES)[number]["method"]} ${(typeof OPENRAILS_ROUTES)[number]["path"]}`;
|