@flexprice/sdk 2.0.11 → 2.0.13
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/README.md +78 -0
- package/docs/sdk/models/dto-create-customer-request.md +0 -1
- package/docs/sdk/models/dto-customer-response.md +1 -0
- package/docs/sdk/models/dto-invoice-response.md +1 -0
- package/docs/sdk/models/{dto-create-entity-integration-mapping-request.md → dto-link-integration-mapping-request.md} +4 -4
- package/docs/sdk/models/dto-link-integration-mapping-response.md +15 -0
- package/docs/sdk/models/dto-update-customer-request.md +0 -1
- package/docs/sdk/models/invoice-status.md +1 -1
- package/docs/sdk/models/schedule-draft-finalization-response.md +16 -0
- package/docs/sdk/models/scheduled-task-interval.md +1 -1
- package/docs/sdk/models/webhook-dto-alert-webhook-payload.md +1 -1
- package/docs/sdk/models/webhook-dto-communication-webhook-payload.md +1 -1
- package/docs/sdk/models/webhook-dto-credit-note-webhook-payload.md +1 -1
- package/docs/sdk/models/webhook-dto-customer-webhook-payload.md +1 -1
- package/docs/sdk/models/webhook-dto-entitlement-webhook-payload.md +1 -1
- package/docs/sdk/models/webhook-dto-feature-webhook-payload.md +1 -1
- package/docs/sdk/models/webhook-dto-invoice-webhook-payload.md +1 -1
- package/docs/sdk/models/webhook-dto-payment-webhook-payload.md +1 -1
- package/docs/sdk/models/webhook-dto-subscription-phase-webhook-payload.md +1 -1
- package/docs/sdk/models/webhook-dto-subscription-webhook-payload.md +1 -1
- package/docs/sdk/models/webhook-dto-transaction-webhook-payload.md +1 -1
- package/docs/sdk/models/webhook-dto-wallet-webhook-payload.md +1 -1
- package/docs/sdk/models/webhook-event-name.md +17 -0
- package/docs/sdks/integrations/README.md +18 -235
- package/docs/sdks/scheduledtasks/README.md +73 -2
- package/esm/funcs/coupons-create-coupon.d.ts +2 -0
- package/esm/funcs/coupons-create-coupon.d.ts.map +1 -1
- package/esm/funcs/coupons-create-coupon.js +3 -1
- package/esm/funcs/coupons-create-coupon.js.map +1 -1
- package/esm/funcs/coupons-delete-coupon.d.ts +2 -0
- package/esm/funcs/coupons-delete-coupon.d.ts.map +1 -1
- package/esm/funcs/coupons-delete-coupon.js +3 -1
- package/esm/funcs/coupons-delete-coupon.js.map +1 -1
- package/esm/funcs/coupons-update-coupon.d.ts +2 -0
- package/esm/funcs/coupons-update-coupon.d.ts.map +1 -1
- package/esm/funcs/coupons-update-coupon.js +3 -1
- package/esm/funcs/coupons-update-coupon.js.map +1 -1
- package/esm/funcs/credit-notes-create-credit-note.d.ts +2 -0
- package/esm/funcs/credit-notes-create-credit-note.d.ts.map +1 -1
- package/esm/funcs/credit-notes-create-credit-note.js +3 -1
- package/esm/funcs/credit-notes-create-credit-note.js.map +1 -1
- package/esm/funcs/credit-notes-process-credit-note.d.ts +2 -0
- package/esm/funcs/credit-notes-process-credit-note.d.ts.map +1 -1
- package/esm/funcs/credit-notes-process-credit-note.js +3 -1
- package/esm/funcs/credit-notes-process-credit-note.js.map +1 -1
- package/esm/funcs/credit-notes-void-credit-note.d.ts +2 -0
- package/esm/funcs/credit-notes-void-credit-note.d.ts.map +1 -1
- package/esm/funcs/credit-notes-void-credit-note.js +3 -1
- package/esm/funcs/credit-notes-void-credit-note.js.map +1 -1
- package/esm/funcs/{integrations-get-integration.d.ts → integrations-link-integration-mapping.d.ts} +4 -4
- package/esm/funcs/integrations-link-integration-mapping.d.ts.map +1 -0
- package/esm/funcs/{entity-integration-mappings-create-entity-integration-mapping.js → integrations-link-integration-mapping.js} +9 -9
- package/esm/funcs/integrations-link-integration-mapping.js.map +1 -0
- package/esm/funcs/scheduled-tasks-schedule-draft-finalization.d.ts +17 -0
- package/esm/funcs/scheduled-tasks-schedule-draft-finalization.d.ts.map +1 -0
- package/esm/funcs/{integrations-list-linked-integrations.js → scheduled-tasks-schedule-draft-finalization.js} +9 -9
- package/esm/funcs/scheduled-tasks-schedule-draft-finalization.js.map +1 -0
- package/esm/lib/config.d.ts +3 -3
- package/esm/lib/config.js +3 -3
- package/esm/lib/config.js.map +1 -1
- package/esm/lib/security.d.ts +1 -1
- package/esm/lib/security.d.ts.map +1 -1
- package/esm/lib/security.js +19 -8
- package/esm/lib/security.js.map +1 -1
- package/esm/sdk/integrations.d.ts +3 -24
- package/esm/sdk/integrations.d.ts.map +1 -1
- package/esm/sdk/integrations.js +5 -35
- package/esm/sdk/integrations.js.map +1 -1
- package/esm/sdk/models/dto-create-customer-request.d.ts +0 -6
- package/esm/sdk/models/dto-create-customer-request.d.ts.map +1 -1
- package/esm/sdk/models/dto-create-customer-request.js +0 -3
- package/esm/sdk/models/dto-create-customer-request.js.map +1 -1
- package/esm/sdk/models/dto-customer-response.d.ts +2 -0
- package/esm/sdk/models/dto-customer-response.d.ts.map +1 -1
- package/esm/sdk/models/dto-customer-response.js +2 -0
- package/esm/sdk/models/dto-customer-response.js.map +1 -1
- package/esm/sdk/models/dto-invoice-response.d.ts +4 -0
- package/esm/sdk/models/dto-invoice-response.d.ts.map +1 -1
- package/esm/sdk/models/dto-invoice-response.js +2 -0
- package/esm/sdk/models/dto-invoice-response.js.map +1 -1
- package/esm/sdk/models/dto-link-integration-mapping-request.d.ts +25 -0
- package/esm/sdk/models/dto-link-integration-mapping-request.d.ts.map +1 -0
- package/esm/sdk/models/{dto-create-entity-integration-mapping-request.js → dto-link-integration-mapping-request.js} +4 -4
- package/esm/sdk/models/dto-link-integration-mapping-request.js.map +1 -0
- package/esm/sdk/models/dto-link-integration-mapping-response.d.ts +11 -0
- package/esm/sdk/models/dto-link-integration-mapping-response.d.ts.map +1 -0
- package/esm/sdk/models/dto-link-integration-mapping-response.js +15 -0
- package/esm/sdk/models/dto-link-integration-mapping-response.js.map +1 -0
- package/esm/sdk/models/dto-update-customer-request.d.ts +0 -6
- package/esm/sdk/models/dto-update-customer-request.d.ts.map +1 -1
- package/esm/sdk/models/dto-update-customer-request.js +0 -3
- package/esm/sdk/models/dto-update-customer-request.js.map +1 -1
- package/esm/sdk/models/index.d.ts +4 -8
- package/esm/sdk/models/index.d.ts.map +1 -1
- package/esm/sdk/models/index.js +4 -8
- package/esm/sdk/models/index.js.map +1 -1
- package/esm/sdk/models/invoice-status.d.ts +1 -0
- package/esm/sdk/models/invoice-status.d.ts.map +1 -1
- package/esm/sdk/models/invoice-status.js +1 -0
- package/esm/sdk/models/invoice-status.js.map +1 -1
- package/esm/sdk/models/schedule-draft-finalization-op.d.ts +11 -0
- package/esm/sdk/models/schedule-draft-finalization-op.d.ts.map +1 -0
- package/esm/sdk/models/schedule-draft-finalization-op.js +11 -0
- package/esm/sdk/models/schedule-draft-finalization-op.js.map +1 -0
- package/esm/sdk/models/scheduled-task-interval.d.ts +1 -0
- package/esm/sdk/models/scheduled-task-interval.d.ts.map +1 -1
- package/esm/sdk/models/scheduled-task-interval.js +1 -0
- package/esm/sdk/models/scheduled-task-interval.js.map +1 -1
- package/esm/sdk/models/secret-provider.d.ts +0 -2
- package/esm/sdk/models/secret-provider.d.ts.map +1 -1
- package/esm/sdk/models/secret-provider.js +0 -2
- package/esm/sdk/models/secret-provider.js.map +1 -1
- package/esm/sdk/models/webhook-dto-alert-webhook-payload.d.ts +2 -1
- package/esm/sdk/models/webhook-dto-alert-webhook-payload.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-alert-webhook-payload.js +2 -1
- package/esm/sdk/models/webhook-dto-alert-webhook-payload.js.map +1 -1
- package/esm/sdk/models/webhook-dto-communication-webhook-payload.d.ts +2 -1
- package/esm/sdk/models/webhook-dto-communication-webhook-payload.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-communication-webhook-payload.js +2 -1
- package/esm/sdk/models/webhook-dto-communication-webhook-payload.js.map +1 -1
- package/esm/sdk/models/webhook-dto-credit-note-webhook-payload.d.ts +2 -1
- package/esm/sdk/models/webhook-dto-credit-note-webhook-payload.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-credit-note-webhook-payload.js +2 -1
- package/esm/sdk/models/webhook-dto-credit-note-webhook-payload.js.map +1 -1
- package/esm/sdk/models/webhook-dto-customer-webhook-payload.d.ts +2 -1
- package/esm/sdk/models/webhook-dto-customer-webhook-payload.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-customer-webhook-payload.js +2 -1
- package/esm/sdk/models/webhook-dto-customer-webhook-payload.js.map +1 -1
- package/esm/sdk/models/webhook-dto-entitlement-webhook-payload.d.ts +2 -1
- package/esm/sdk/models/webhook-dto-entitlement-webhook-payload.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-entitlement-webhook-payload.js +2 -1
- package/esm/sdk/models/webhook-dto-entitlement-webhook-payload.js.map +1 -1
- package/esm/sdk/models/webhook-dto-feature-webhook-payload.d.ts +2 -1
- package/esm/sdk/models/webhook-dto-feature-webhook-payload.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-feature-webhook-payload.js +2 -1
- package/esm/sdk/models/webhook-dto-feature-webhook-payload.js.map +1 -1
- package/esm/sdk/models/webhook-dto-invoice-webhook-payload.d.ts +2 -1
- package/esm/sdk/models/webhook-dto-invoice-webhook-payload.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-invoice-webhook-payload.js +2 -1
- package/esm/sdk/models/webhook-dto-invoice-webhook-payload.js.map +1 -1
- package/esm/sdk/models/webhook-dto-payment-webhook-payload.d.ts +2 -1
- package/esm/sdk/models/webhook-dto-payment-webhook-payload.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-payment-webhook-payload.js +2 -1
- package/esm/sdk/models/webhook-dto-payment-webhook-payload.js.map +1 -1
- package/esm/sdk/models/webhook-dto-subscription-phase-webhook-payload.d.ts +2 -1
- package/esm/sdk/models/webhook-dto-subscription-phase-webhook-payload.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-subscription-phase-webhook-payload.js +2 -1
- package/esm/sdk/models/webhook-dto-subscription-phase-webhook-payload.js.map +1 -1
- package/esm/sdk/models/webhook-dto-subscription-webhook-payload.d.ts +2 -1
- package/esm/sdk/models/webhook-dto-subscription-webhook-payload.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-subscription-webhook-payload.js +2 -1
- package/esm/sdk/models/webhook-dto-subscription-webhook-payload.js.map +1 -1
- package/esm/sdk/models/webhook-dto-transaction-webhook-payload.d.ts +2 -1
- package/esm/sdk/models/webhook-dto-transaction-webhook-payload.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-transaction-webhook-payload.js +2 -1
- package/esm/sdk/models/webhook-dto-transaction-webhook-payload.js.map +1 -1
- package/esm/sdk/models/webhook-dto-wallet-webhook-payload.d.ts +2 -1
- package/esm/sdk/models/webhook-dto-wallet-webhook-payload.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-wallet-webhook-payload.js +2 -1
- package/esm/sdk/models/webhook-dto-wallet-webhook-payload.js.map +1 -1
- package/esm/sdk/models/webhook-event-name.d.ts +51 -0
- package/esm/sdk/models/webhook-event-name.d.ts.map +1 -0
- package/esm/sdk/models/webhook-event-name.js +52 -0
- package/esm/sdk/models/webhook-event-name.js.map +1 -0
- package/esm/sdk/scheduled-tasks.d.ts +7 -0
- package/esm/sdk/scheduled-tasks.d.ts.map +1 -1
- package/esm/sdk/scheduled-tasks.js +10 -0
- package/esm/sdk/scheduled-tasks.js.map +1 -1
- package/esm/sdk/sdk.d.ts +2 -5
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +4 -9
- package/esm/sdk/sdk.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/coupons-create-coupon.ts +3 -1
- package/src/funcs/coupons-delete-coupon.ts +3 -1
- package/src/funcs/coupons-update-coupon.ts +3 -1
- package/src/funcs/credit-notes-create-credit-note.ts +3 -1
- package/src/funcs/credit-notes-process-credit-note.ts +3 -1
- package/src/funcs/credit-notes-void-credit-note.ts +3 -1
- package/src/funcs/{entity-integration-mappings-create-entity-integration-mapping.ts → integrations-link-integration-mapping.ts} +14 -17
- package/src/funcs/{integrations-list-linked-integrations.ts → scheduled-tasks-schedule-draft-finalization.ts} +12 -11
- package/src/lib/config.ts +3 -3
- package/src/lib/security.ts +14 -2
- package/src/sdk/integrations.ts +8 -62
- package/src/sdk/models/dto-create-customer-request.ts +0 -16
- package/src/sdk/models/dto-customer-response.ts +8 -0
- package/src/sdk/models/dto-invoice-response.ts +6 -0
- package/src/sdk/models/dto-link-integration-mapping-request.ts +59 -0
- package/src/sdk/models/dto-link-integration-mapping-response.ts +35 -0
- package/src/sdk/models/dto-update-customer-request.ts +0 -16
- package/src/sdk/models/index.ts +4 -8
- package/src/sdk/models/invoice-status.ts +1 -0
- package/src/sdk/models/schedule-draft-finalization-op.ts +29 -0
- package/src/sdk/models/scheduled-task-interval.ts +1 -0
- package/src/sdk/models/secret-provider.ts +0 -5
- package/src/sdk/models/webhook-dto-alert-webhook-payload.ts +6 -2
- package/src/sdk/models/webhook-dto-communication-webhook-payload.ts +6 -2
- package/src/sdk/models/webhook-dto-credit-note-webhook-payload.ts +6 -2
- package/src/sdk/models/webhook-dto-customer-webhook-payload.ts +6 -2
- package/src/sdk/models/webhook-dto-entitlement-webhook-payload.ts +6 -2
- package/src/sdk/models/webhook-dto-feature-webhook-payload.ts +6 -2
- package/src/sdk/models/webhook-dto-invoice-webhook-payload.ts +6 -2
- package/src/sdk/models/webhook-dto-payment-webhook-payload.ts +6 -2
- package/src/sdk/models/webhook-dto-subscription-phase-webhook-payload.ts +6 -2
- package/src/sdk/models/webhook-dto-subscription-webhook-payload.ts +6 -2
- package/src/sdk/models/webhook-dto-transaction-webhook-payload.ts +6 -2
- package/src/sdk/models/webhook-dto-wallet-webhook-payload.ts +6 -2
- package/src/sdk/models/webhook-event-name.ts +60 -0
- package/src/sdk/scheduled-tasks.ts +16 -0
- package/src/sdk/sdk.ts +5 -13
- package/docs/sdk/models/create-or-update-integration-request.md +0 -26
- package/docs/sdk/models/delete-entity-integration-mapping-request.md +0 -17
- package/docs/sdk/models/delete-integration-request.md +0 -17
- package/docs/sdk/models/dto-create-integration-request.md +0 -21
- package/docs/sdk/models/dto-integration-entity-mapping.md +0 -21
- package/docs/sdk/models/dto-linked-integrations-response.md +0 -15
- package/docs/sdk/models/get-integration-request.md +0 -17
- package/docs/sdk/models/provider.md +0 -17
- package/docs/sdks/entityintegrationmappings/README.md +0 -160
- package/esm/funcs/entity-integration-mappings-create-entity-integration-mapping.d.ts +0 -17
- package/esm/funcs/entity-integration-mappings-create-entity-integration-mapping.d.ts.map +0 -1
- package/esm/funcs/entity-integration-mappings-create-entity-integration-mapping.js.map +0 -1
- package/esm/funcs/entity-integration-mappings-delete-entity-integration-mapping.d.ts +0 -17
- package/esm/funcs/entity-integration-mappings-delete-entity-integration-mapping.d.ts.map +0 -1
- package/esm/funcs/entity-integration-mappings-delete-entity-integration-mapping.js +0 -90
- package/esm/funcs/entity-integration-mappings-delete-entity-integration-mapping.js.map +0 -1
- package/esm/funcs/integrations-create-or-update-integration.d.ts +0 -17
- package/esm/funcs/integrations-create-or-update-integration.d.ts.map +0 -1
- package/esm/funcs/integrations-create-or-update-integration.js +0 -92
- package/esm/funcs/integrations-create-or-update-integration.js.map +0 -1
- package/esm/funcs/integrations-delete-integration.d.ts +0 -17
- package/esm/funcs/integrations-delete-integration.d.ts.map +0 -1
- package/esm/funcs/integrations-delete-integration.js +0 -90
- package/esm/funcs/integrations-delete-integration.js.map +0 -1
- package/esm/funcs/integrations-get-integration.d.ts.map +0 -1
- package/esm/funcs/integrations-get-integration.js +0 -90
- package/esm/funcs/integrations-get-integration.js.map +0 -1
- package/esm/funcs/integrations-list-linked-integrations.d.ts +0 -17
- package/esm/funcs/integrations-list-linked-integrations.d.ts.map +0 -1
- package/esm/funcs/integrations-list-linked-integrations.js.map +0 -1
- package/esm/sdk/entity-integration-mappings.d.ts +0 -19
- package/esm/sdk/entity-integration-mappings.d.ts.map +0 -1
- package/esm/sdk/entity-integration-mappings.js +0 -28
- package/esm/sdk/entity-integration-mappings.js.map +0 -1
- package/esm/sdk/models/create-or-update-integration-op.d.ts +0 -21
- package/esm/sdk/models/create-or-update-integration-op.d.ts.map +0 -1
- package/esm/sdk/models/create-or-update-integration-op.js +0 -14
- package/esm/sdk/models/create-or-update-integration-op.js.map +0 -1
- package/esm/sdk/models/delete-entity-integration-mapping-op.d.ts +0 -15
- package/esm/sdk/models/delete-entity-integration-mapping-op.d.ts.map +0 -1
- package/esm/sdk/models/delete-entity-integration-mapping-op.js +0 -12
- package/esm/sdk/models/delete-entity-integration-mapping-op.js.map +0 -1
- package/esm/sdk/models/delete-integration-op.d.ts +0 -15
- package/esm/sdk/models/delete-integration-op.d.ts.map +0 -1
- package/esm/sdk/models/delete-integration-op.js +0 -12
- package/esm/sdk/models/delete-integration-op.js.map +0 -1
- package/esm/sdk/models/dto-create-entity-integration-mapping-request.d.ts +0 -25
- package/esm/sdk/models/dto-create-entity-integration-mapping-request.d.ts.map +0 -1
- package/esm/sdk/models/dto-create-entity-integration-mapping-request.js.map +0 -1
- package/esm/sdk/models/dto-create-integration-request.d.ts +0 -21
- package/esm/sdk/models/dto-create-integration-request.d.ts.map +0 -1
- package/esm/sdk/models/dto-create-integration-request.js +0 -15
- package/esm/sdk/models/dto-create-integration-request.js.map +0 -1
- package/esm/sdk/models/dto-integration-entity-mapping.d.ts +0 -38
- package/esm/sdk/models/dto-integration-entity-mapping.d.ts.map +0 -1
- package/esm/sdk/models/dto-integration-entity-mapping.js +0 -23
- package/esm/sdk/models/dto-integration-entity-mapping.js.map +0 -1
- package/esm/sdk/models/dto-linked-integrations-response.d.ts +0 -10
- package/esm/sdk/models/dto-linked-integrations-response.d.ts.map +0 -1
- package/esm/sdk/models/dto-linked-integrations-response.js +0 -14
- package/esm/sdk/models/dto-linked-integrations-response.js.map +0 -1
- package/esm/sdk/models/get-integration-op.d.ts +0 -15
- package/esm/sdk/models/get-integration-op.d.ts.map +0 -1
- package/esm/sdk/models/get-integration-op.js +0 -12
- package/esm/sdk/models/get-integration-op.js.map +0 -1
- package/src/funcs/entity-integration-mappings-delete-entity-integration-mapping.ts +0 -183
- package/src/funcs/integrations-create-or-update-integration.ts +0 -187
- package/src/funcs/integrations-delete-integration.ts +0 -179
- package/src/funcs/integrations-get-integration.ts +0 -181
- package/src/sdk/entity-integration-mappings.ts +0 -45
- package/src/sdk/models/create-or-update-integration-op.ts +0 -46
- package/src/sdk/models/delete-entity-integration-mapping-op.ts +0 -36
- package/src/sdk/models/delete-integration-op.ts +0 -33
- package/src/sdk/models/dto-create-entity-integration-mapping-request.ts +0 -61
- package/src/sdk/models/dto-create-integration-request.ts +0 -42
- package/src/sdk/models/dto-integration-entity-mapping.ts +0 -63
- package/src/sdk/models/dto-linked-integrations-response.ts +0 -31
- package/src/sdk/models/get-integration-op.ts +0 -33
|
@@ -12,10 +12,14 @@ import {
|
|
|
12
12
|
DtoCreditNoteResponse$inboundSchema,
|
|
13
13
|
} from "./dto-credit-note-response.js";
|
|
14
14
|
import { SDKValidationError } from "./sdk-validation-error.js";
|
|
15
|
+
import {
|
|
16
|
+
WebhookEventName,
|
|
17
|
+
WebhookEventName$inboundSchema,
|
|
18
|
+
} from "./webhook-event-name.js";
|
|
15
19
|
|
|
16
20
|
export type WebhookDtoCreditNoteWebhookPayload = {
|
|
17
21
|
creditNote?: DtoCreditNoteResponse | undefined;
|
|
18
|
-
eventType?:
|
|
22
|
+
eventType?: WebhookEventName | undefined;
|
|
19
23
|
};
|
|
20
24
|
|
|
21
25
|
/** @internal */
|
|
@@ -25,7 +29,7 @@ export const WebhookDtoCreditNoteWebhookPayload$inboundSchema: z.ZodMiniType<
|
|
|
25
29
|
> = z.pipe(
|
|
26
30
|
z.object({
|
|
27
31
|
credit_note: types.optional(DtoCreditNoteResponse$inboundSchema),
|
|
28
|
-
event_type: types.optional(
|
|
32
|
+
event_type: types.optional(WebhookEventName$inboundSchema),
|
|
29
33
|
}),
|
|
30
34
|
z.transform((v) => {
|
|
31
35
|
return remap$(v, {
|
|
@@ -12,13 +12,17 @@ import {
|
|
|
12
12
|
DtoCustomerResponse$inboundSchema,
|
|
13
13
|
} from "./dto-customer-response.js";
|
|
14
14
|
import { SDKValidationError } from "./sdk-validation-error.js";
|
|
15
|
+
import {
|
|
16
|
+
WebhookEventName,
|
|
17
|
+
WebhookEventName$inboundSchema,
|
|
18
|
+
} from "./webhook-event-name.js";
|
|
15
19
|
|
|
16
20
|
export type WebhookDtoCustomerWebhookPayload = {
|
|
17
21
|
/**
|
|
18
22
|
* Customer response object containing all customer information
|
|
19
23
|
*/
|
|
20
24
|
customer?: DtoCustomerResponse | undefined;
|
|
21
|
-
eventType?:
|
|
25
|
+
eventType?: WebhookEventName | undefined;
|
|
22
26
|
};
|
|
23
27
|
|
|
24
28
|
/** @internal */
|
|
@@ -28,7 +32,7 @@ export const WebhookDtoCustomerWebhookPayload$inboundSchema: z.ZodMiniType<
|
|
|
28
32
|
> = z.pipe(
|
|
29
33
|
z.object({
|
|
30
34
|
customer: types.optional(DtoCustomerResponse$inboundSchema),
|
|
31
|
-
event_type: types.optional(
|
|
35
|
+
event_type: types.optional(WebhookEventName$inboundSchema),
|
|
32
36
|
}),
|
|
33
37
|
z.transform((v) => {
|
|
34
38
|
return remap$(v, {
|
|
@@ -12,10 +12,14 @@ import {
|
|
|
12
12
|
DtoEntitlementResponse$inboundSchema,
|
|
13
13
|
} from "./dto-entitlement-response.js";
|
|
14
14
|
import { SDKValidationError } from "./sdk-validation-error.js";
|
|
15
|
+
import {
|
|
16
|
+
WebhookEventName,
|
|
17
|
+
WebhookEventName$inboundSchema,
|
|
18
|
+
} from "./webhook-event-name.js";
|
|
15
19
|
|
|
16
20
|
export type WebhookDtoEntitlementWebhookPayload = {
|
|
17
21
|
entitlement?: DtoEntitlementResponse | undefined;
|
|
18
|
-
eventType?:
|
|
22
|
+
eventType?: WebhookEventName | undefined;
|
|
19
23
|
};
|
|
20
24
|
|
|
21
25
|
/** @internal */
|
|
@@ -25,7 +29,7 @@ export const WebhookDtoEntitlementWebhookPayload$inboundSchema: z.ZodMiniType<
|
|
|
25
29
|
> = z.pipe(
|
|
26
30
|
z.object({
|
|
27
31
|
entitlement: types.optional(DtoEntitlementResponse$inboundSchema),
|
|
28
|
-
event_type: types.optional(
|
|
32
|
+
event_type: types.optional(WebhookEventName$inboundSchema),
|
|
29
33
|
}),
|
|
30
34
|
z.transform((v) => {
|
|
31
35
|
return remap$(v, {
|
|
@@ -12,9 +12,13 @@ import {
|
|
|
12
12
|
DtoFeatureResponse$inboundSchema,
|
|
13
13
|
} from "./dto-feature-response.js";
|
|
14
14
|
import { SDKValidationError } from "./sdk-validation-error.js";
|
|
15
|
+
import {
|
|
16
|
+
WebhookEventName,
|
|
17
|
+
WebhookEventName$inboundSchema,
|
|
18
|
+
} from "./webhook-event-name.js";
|
|
15
19
|
|
|
16
20
|
export type WebhookDtoFeatureWebhookPayload = {
|
|
17
|
-
eventType?:
|
|
21
|
+
eventType?: WebhookEventName | undefined;
|
|
18
22
|
feature?: DtoFeatureResponse | undefined;
|
|
19
23
|
};
|
|
20
24
|
|
|
@@ -24,7 +28,7 @@ export const WebhookDtoFeatureWebhookPayload$inboundSchema: z.ZodMiniType<
|
|
|
24
28
|
unknown
|
|
25
29
|
> = z.pipe(
|
|
26
30
|
z.object({
|
|
27
|
-
event_type: types.optional(
|
|
31
|
+
event_type: types.optional(WebhookEventName$inboundSchema),
|
|
28
32
|
feature: types.optional(DtoFeatureResponse$inboundSchema),
|
|
29
33
|
}),
|
|
30
34
|
z.transform((v) => {
|
|
@@ -12,9 +12,13 @@ import {
|
|
|
12
12
|
DtoInvoiceResponse$inboundSchema,
|
|
13
13
|
} from "./dto-invoice-response.js";
|
|
14
14
|
import { SDKValidationError } from "./sdk-validation-error.js";
|
|
15
|
+
import {
|
|
16
|
+
WebhookEventName,
|
|
17
|
+
WebhookEventName$inboundSchema,
|
|
18
|
+
} from "./webhook-event-name.js";
|
|
15
19
|
|
|
16
20
|
export type WebhookDtoInvoiceWebhookPayload = {
|
|
17
|
-
eventType?:
|
|
21
|
+
eventType?: WebhookEventName | undefined;
|
|
18
22
|
invoice?: DtoInvoiceResponse | undefined;
|
|
19
23
|
};
|
|
20
24
|
|
|
@@ -24,7 +28,7 @@ export const WebhookDtoInvoiceWebhookPayload$inboundSchema: z.ZodMiniType<
|
|
|
24
28
|
unknown
|
|
25
29
|
> = z.pipe(
|
|
26
30
|
z.object({
|
|
27
|
-
event_type: types.optional(
|
|
31
|
+
event_type: types.optional(WebhookEventName$inboundSchema),
|
|
28
32
|
invoice: types.optional(DtoInvoiceResponse$inboundSchema),
|
|
29
33
|
}),
|
|
30
34
|
z.transform((v) => {
|
|
@@ -12,9 +12,13 @@ import {
|
|
|
12
12
|
DtoPaymentResponse$inboundSchema,
|
|
13
13
|
} from "./dto-payment-response.js";
|
|
14
14
|
import { SDKValidationError } from "./sdk-validation-error.js";
|
|
15
|
+
import {
|
|
16
|
+
WebhookEventName,
|
|
17
|
+
WebhookEventName$inboundSchema,
|
|
18
|
+
} from "./webhook-event-name.js";
|
|
15
19
|
|
|
16
20
|
export type WebhookDtoPaymentWebhookPayload = {
|
|
17
|
-
eventType?:
|
|
21
|
+
eventType?: WebhookEventName | undefined;
|
|
18
22
|
payment?: DtoPaymentResponse | undefined;
|
|
19
23
|
};
|
|
20
24
|
|
|
@@ -24,7 +28,7 @@ export const WebhookDtoPaymentWebhookPayload$inboundSchema: z.ZodMiniType<
|
|
|
24
28
|
unknown
|
|
25
29
|
> = z.pipe(
|
|
26
30
|
z.object({
|
|
27
|
-
event_type: types.optional(
|
|
31
|
+
event_type: types.optional(WebhookEventName$inboundSchema),
|
|
28
32
|
payment: types.optional(DtoPaymentResponse$inboundSchema),
|
|
29
33
|
}),
|
|
30
34
|
z.transform((v) => {
|
|
@@ -12,9 +12,13 @@ import {
|
|
|
12
12
|
DtoSubscriptionPhaseResponse$inboundSchema,
|
|
13
13
|
} from "./dto-subscription-phase-response.js";
|
|
14
14
|
import { SDKValidationError } from "./sdk-validation-error.js";
|
|
15
|
+
import {
|
|
16
|
+
WebhookEventName,
|
|
17
|
+
WebhookEventName$inboundSchema,
|
|
18
|
+
} from "./webhook-event-name.js";
|
|
15
19
|
|
|
16
20
|
export type WebhookDtoSubscriptionPhaseWebhookPayload = {
|
|
17
|
-
eventType?:
|
|
21
|
+
eventType?: WebhookEventName | undefined;
|
|
18
22
|
phase?: DtoSubscriptionPhaseResponse | undefined;
|
|
19
23
|
};
|
|
20
24
|
|
|
@@ -22,7 +26,7 @@ export type WebhookDtoSubscriptionPhaseWebhookPayload = {
|
|
|
22
26
|
export const WebhookDtoSubscriptionPhaseWebhookPayload$inboundSchema:
|
|
23
27
|
z.ZodMiniType<WebhookDtoSubscriptionPhaseWebhookPayload, unknown> = z.pipe(
|
|
24
28
|
z.object({
|
|
25
|
-
event_type: types.optional(
|
|
29
|
+
event_type: types.optional(WebhookEventName$inboundSchema),
|
|
26
30
|
phase: types.optional(DtoSubscriptionPhaseResponse$inboundSchema),
|
|
27
31
|
}),
|
|
28
32
|
z.transform((v) => {
|
|
@@ -12,9 +12,13 @@ import {
|
|
|
12
12
|
DtoSubscriptionResponse$inboundSchema,
|
|
13
13
|
} from "./dto-subscription-response.js";
|
|
14
14
|
import { SDKValidationError } from "./sdk-validation-error.js";
|
|
15
|
+
import {
|
|
16
|
+
WebhookEventName,
|
|
17
|
+
WebhookEventName$inboundSchema,
|
|
18
|
+
} from "./webhook-event-name.js";
|
|
15
19
|
|
|
16
20
|
export type WebhookDtoSubscriptionWebhookPayload = {
|
|
17
|
-
eventType?:
|
|
21
|
+
eventType?: WebhookEventName | undefined;
|
|
18
22
|
subscription?: DtoSubscriptionResponse | undefined;
|
|
19
23
|
};
|
|
20
24
|
|
|
@@ -24,7 +28,7 @@ export const WebhookDtoSubscriptionWebhookPayload$inboundSchema: z.ZodMiniType<
|
|
|
24
28
|
unknown
|
|
25
29
|
> = z.pipe(
|
|
26
30
|
z.object({
|
|
27
|
-
event_type: types.optional(
|
|
31
|
+
event_type: types.optional(WebhookEventName$inboundSchema),
|
|
28
32
|
subscription: types.optional(DtoSubscriptionResponse$inboundSchema),
|
|
29
33
|
}),
|
|
30
34
|
z.transform((v) => {
|
|
@@ -16,9 +16,13 @@ import {
|
|
|
16
16
|
DtoWalletTransactionResponse$inboundSchema,
|
|
17
17
|
} from "./dto-wallet-transaction-response.js";
|
|
18
18
|
import { SDKValidationError } from "./sdk-validation-error.js";
|
|
19
|
+
import {
|
|
20
|
+
WebhookEventName,
|
|
21
|
+
WebhookEventName$inboundSchema,
|
|
22
|
+
} from "./webhook-event-name.js";
|
|
19
23
|
|
|
20
24
|
export type WebhookDtoTransactionWebhookPayload = {
|
|
21
|
-
eventType?:
|
|
25
|
+
eventType?: WebhookEventName | undefined;
|
|
22
26
|
transaction?: DtoWalletTransactionResponse | undefined;
|
|
23
27
|
wallet?: DtoWalletResponse | undefined;
|
|
24
28
|
};
|
|
@@ -29,7 +33,7 @@ export const WebhookDtoTransactionWebhookPayload$inboundSchema: z.ZodMiniType<
|
|
|
29
33
|
unknown
|
|
30
34
|
> = z.pipe(
|
|
31
35
|
z.object({
|
|
32
|
-
event_type: types.optional(
|
|
36
|
+
event_type: types.optional(WebhookEventName$inboundSchema),
|
|
33
37
|
transaction: types.optional(DtoWalletTransactionResponse$inboundSchema),
|
|
34
38
|
wallet: types.optional(DtoWalletResponse$inboundSchema),
|
|
35
39
|
}),
|
|
@@ -20,6 +20,10 @@ import {
|
|
|
20
20
|
WebhookDtoWalletAlertInfo,
|
|
21
21
|
WebhookDtoWalletAlertInfo$inboundSchema,
|
|
22
22
|
} from "./webhook-dto-wallet-alert-info.js";
|
|
23
|
+
import {
|
|
24
|
+
WebhookEventName,
|
|
25
|
+
WebhookEventName$inboundSchema,
|
|
26
|
+
} from "./webhook-event-name.js";
|
|
23
27
|
|
|
24
28
|
export type WebhookDtoWalletWebhookPayload = {
|
|
25
29
|
alert?: WebhookDtoWalletAlertInfo | undefined;
|
|
@@ -27,7 +31,7 @@ export type WebhookDtoWalletWebhookPayload = {
|
|
|
27
31
|
* Customer response object containing all customer information
|
|
28
32
|
*/
|
|
29
33
|
customer?: DtoCustomerResponse | undefined;
|
|
30
|
-
eventType?:
|
|
34
|
+
eventType?: WebhookEventName | undefined;
|
|
31
35
|
wallet?: DtoWalletResponse | undefined;
|
|
32
36
|
};
|
|
33
37
|
|
|
@@ -39,7 +43,7 @@ export const WebhookDtoWalletWebhookPayload$inboundSchema: z.ZodMiniType<
|
|
|
39
43
|
z.object({
|
|
40
44
|
alert: types.optional(WebhookDtoWalletAlertInfo$inboundSchema),
|
|
41
45
|
customer: types.optional(DtoCustomerResponse$inboundSchema),
|
|
42
|
-
event_type: types.optional(
|
|
46
|
+
event_type: types.optional(WebhookEventName$inboundSchema),
|
|
43
47
|
wallet: types.optional(DtoWalletResponse$inboundSchema),
|
|
44
48
|
}),
|
|
45
49
|
z.transform((v) => {
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v4-mini";
|
|
6
|
+
import * as openEnums from "../../types/enums.js";
|
|
7
|
+
import { OpenEnum } from "../../types/enums.js";
|
|
8
|
+
|
|
9
|
+
export const WebhookEventName = {
|
|
10
|
+
InvoiceCreateDrafted: "invoice.create.drafted",
|
|
11
|
+
SubscriptionCreated: "subscription.created",
|
|
12
|
+
SubscriptionDraftCreated: "subscription.draft.created",
|
|
13
|
+
SubscriptionActivated: "subscription.activated",
|
|
14
|
+
SubscriptionUpdated: "subscription.updated",
|
|
15
|
+
SubscriptionPaused: "subscription.paused",
|
|
16
|
+
SubscriptionCancelled: "subscription.cancelled",
|
|
17
|
+
SubscriptionResumed: "subscription.resumed",
|
|
18
|
+
SubscriptionPhaseCreated: "subscription.phase.created",
|
|
19
|
+
SubscriptionPhaseUpdated: "subscription.phase.updated",
|
|
20
|
+
SubscriptionPhaseDeleted: "subscription.phase.deleted",
|
|
21
|
+
FeatureCreated: "feature.created",
|
|
22
|
+
FeatureUpdated: "feature.updated",
|
|
23
|
+
FeatureDeleted: "feature.deleted",
|
|
24
|
+
FeatureWalletBalanceAlert: "feature.wallet_balance.alert",
|
|
25
|
+
EntitlementCreated: "entitlement.created",
|
|
26
|
+
EntitlementUpdated: "entitlement.updated",
|
|
27
|
+
EntitlementDeleted: "entitlement.deleted",
|
|
28
|
+
WalletCreated: "wallet.created",
|
|
29
|
+
WalletUpdated: "wallet.updated",
|
|
30
|
+
WalletTerminated: "wallet.terminated",
|
|
31
|
+
WalletTransactionCreated: "wallet.transaction.created",
|
|
32
|
+
PaymentCreated: "payment.created",
|
|
33
|
+
PaymentUpdated: "payment.updated",
|
|
34
|
+
PaymentFailed: "payment.failed",
|
|
35
|
+
PaymentSuccess: "payment.success",
|
|
36
|
+
PaymentPending: "payment.pending",
|
|
37
|
+
CustomerCreated: "customer.created",
|
|
38
|
+
CustomerUpdated: "customer.updated",
|
|
39
|
+
CustomerDeleted: "customer.deleted",
|
|
40
|
+
InvoiceUpdateFinalized: "invoice.update.finalized",
|
|
41
|
+
InvoiceUpdatePayment: "invoice.update.payment",
|
|
42
|
+
InvoiceUpdateVoided: "invoice.update.voided",
|
|
43
|
+
InvoiceUpdate: "invoice.update",
|
|
44
|
+
InvoicePaymentOverdue: "invoice.payment.overdue",
|
|
45
|
+
WalletCreditBalanceDropped: "wallet.credit_balance.dropped",
|
|
46
|
+
WalletCreditBalanceRecovered: "wallet.credit_balance.recovered",
|
|
47
|
+
WalletOngoingBalanceDropped: "wallet.ongoing_balance.dropped",
|
|
48
|
+
WalletOngoingBalanceRecovered: "wallet.ongoing_balance.recovered",
|
|
49
|
+
SubscriptionRenewalDue: "subscription.renewal.due",
|
|
50
|
+
InvoiceCommunicationTriggered: "invoice.communication.triggered",
|
|
51
|
+
CreditNoteCreated: "credit_note.created",
|
|
52
|
+
CreditNoteUpdated: "credit_note.updated",
|
|
53
|
+
} as const;
|
|
54
|
+
export type WebhookEventName = OpenEnum<typeof WebhookEventName>;
|
|
55
|
+
|
|
56
|
+
/** @internal */
|
|
57
|
+
export const WebhookEventName$inboundSchema: z.ZodMiniType<
|
|
58
|
+
WebhookEventName,
|
|
59
|
+
unknown
|
|
60
|
+
> = openEnums.inboundSchema(WebhookEventName);
|
|
@@ -6,6 +6,7 @@ import { scheduledTasksCreateScheduledTask } from "../funcs/scheduled-tasks-crea
|
|
|
6
6
|
import { scheduledTasksDeleteScheduledTask } from "../funcs/scheduled-tasks-delete-scheduled-task.js";
|
|
7
7
|
import { scheduledTasksGetScheduledTask } from "../funcs/scheduled-tasks-get-scheduled-task.js";
|
|
8
8
|
import { scheduledTasksListScheduledTasks } from "../funcs/scheduled-tasks-list-scheduled-tasks.js";
|
|
9
|
+
import { scheduledTasksScheduleDraftFinalization } from "../funcs/scheduled-tasks-schedule-draft-finalization.js";
|
|
9
10
|
import { scheduledTasksScheduleUpdateBillingPeriod } from "../funcs/scheduled-tasks-schedule-update-billing-period.js";
|
|
10
11
|
import { scheduledTasksTriggerScheduledTaskRun } from "../funcs/scheduled-tasks-trigger-scheduled-task-run.js";
|
|
11
12
|
import { scheduledTasksUpdateScheduledTask } from "../funcs/scheduled-tasks-update-scheduled-task.js";
|
|
@@ -48,6 +49,21 @@ export class ScheduledTasks extends ClientSDK {
|
|
|
48
49
|
));
|
|
49
50
|
}
|
|
50
51
|
|
|
52
|
+
/**
|
|
53
|
+
* Schedule draft finalization
|
|
54
|
+
*
|
|
55
|
+
* @remarks
|
|
56
|
+
* Triggers the draft invoice finalization workflow that scans computed draft invoices whose finalization delay has elapsed and finalizes them (assign invoice number, sync to vendors, attempt payment).
|
|
57
|
+
*/
|
|
58
|
+
async scheduleDraftFinalization(
|
|
59
|
+
options?: RequestOptions,
|
|
60
|
+
): Promise<models.ScheduleDraftFinalizationResponse> {
|
|
61
|
+
return unwrapAsync(scheduledTasksScheduleDraftFinalization(
|
|
62
|
+
this,
|
|
63
|
+
options,
|
|
64
|
+
));
|
|
65
|
+
}
|
|
66
|
+
|
|
51
67
|
/**
|
|
52
68
|
* Schedule update billing period
|
|
53
69
|
*
|
package/src/sdk/sdk.ts
CHANGED
|
@@ -11,7 +11,6 @@ import { CreditGrants } from "./credit-grants.js";
|
|
|
11
11
|
import { CreditNotes } from "./credit-notes.js";
|
|
12
12
|
import { Customers } from "./customers.js";
|
|
13
13
|
import { Entitlements } from "./entitlements.js";
|
|
14
|
-
import { EntityIntegrationMappings } from "./entity-integration-mappings.js";
|
|
15
14
|
import { Events } from "./events.js";
|
|
16
15
|
import { Features } from "./features.js";
|
|
17
16
|
import { Groups } from "./groups.js";
|
|
@@ -85,13 +84,6 @@ export class Flexprice extends ClientSDK {
|
|
|
85
84
|
return (this._invoices ??= new Invoices(this._options));
|
|
86
85
|
}
|
|
87
86
|
|
|
88
|
-
private _entityIntegrationMappings?: EntityIntegrationMappings;
|
|
89
|
-
get entityIntegrationMappings(): EntityIntegrationMappings {
|
|
90
|
-
return (this._entityIntegrationMappings ??= new EntityIntegrationMappings(
|
|
91
|
-
this._options,
|
|
92
|
-
));
|
|
93
|
-
}
|
|
94
|
-
|
|
95
87
|
private _events?: Events;
|
|
96
88
|
get events(): Events {
|
|
97
89
|
return (this._events ??= new Events(this._options));
|
|
@@ -107,6 +99,11 @@ export class Flexprice extends ClientSDK {
|
|
|
107
99
|
return (this._groups ??= new Groups(this._options));
|
|
108
100
|
}
|
|
109
101
|
|
|
102
|
+
private _integrations?: Integrations;
|
|
103
|
+
get integrations(): Integrations {
|
|
104
|
+
return (this._integrations ??= new Integrations(this._options));
|
|
105
|
+
}
|
|
106
|
+
|
|
110
107
|
private _payments?: Payments;
|
|
111
108
|
get payments(): Payments {
|
|
112
109
|
return (this._payments ??= new Payments(this._options));
|
|
@@ -137,11 +134,6 @@ export class Flexprice extends ClientSDK {
|
|
|
137
134
|
return (this._secrets ??= new Secrets(this._options));
|
|
138
135
|
}
|
|
139
136
|
|
|
140
|
-
private _integrations?: Integrations;
|
|
141
|
-
get integrations(): Integrations {
|
|
142
|
-
return (this._integrations ??= new Integrations(this._options));
|
|
143
|
-
}
|
|
144
|
-
|
|
145
137
|
private _subscriptions?: Subscriptions;
|
|
146
138
|
get subscriptions(): Subscriptions {
|
|
147
139
|
return (this._subscriptions ??= new Subscriptions(this._options));
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# CreateOrUpdateIntegrationRequest
|
|
2
|
-
|
|
3
|
-
## Example Usage
|
|
4
|
-
|
|
5
|
-
```typescript
|
|
6
|
-
import { CreateOrUpdateIntegrationRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
-
|
|
8
|
-
let value: CreateOrUpdateIntegrationRequest = {
|
|
9
|
-
provider: "<value>",
|
|
10
|
-
body: {
|
|
11
|
-
credentials: {
|
|
12
|
-
"key": "<value>",
|
|
13
|
-
"key1": "<value>",
|
|
14
|
-
},
|
|
15
|
-
name: "<value>",
|
|
16
|
-
provider: "quickbooks",
|
|
17
|
-
},
|
|
18
|
-
};
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
## Fields
|
|
22
|
-
|
|
23
|
-
| Field | Type | Required | Description |
|
|
24
|
-
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
|
25
|
-
| `provider` | *string* | :heavy_check_mark: | Integration provider |
|
|
26
|
-
| `body` | [models.DtoCreateIntegrationRequest](../../sdk/models/dto-create-integration-request.md) | :heavy_check_mark: | Integration creation request |
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
# DeleteEntityIntegrationMappingRequest
|
|
2
|
-
|
|
3
|
-
## Example Usage
|
|
4
|
-
|
|
5
|
-
```typescript
|
|
6
|
-
import { DeleteEntityIntegrationMappingRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
-
|
|
8
|
-
let value: DeleteEntityIntegrationMappingRequest = {
|
|
9
|
-
id: "<id>",
|
|
10
|
-
};
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Fields
|
|
14
|
-
|
|
15
|
-
| Field | Type | Required | Description |
|
|
16
|
-
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
|
|
17
|
-
| `id` | *string* | :heavy_check_mark: | Entity integration mapping ID |
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
# DeleteIntegrationRequest
|
|
2
|
-
|
|
3
|
-
## Example Usage
|
|
4
|
-
|
|
5
|
-
```typescript
|
|
6
|
-
import { DeleteIntegrationRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
-
|
|
8
|
-
let value: DeleteIntegrationRequest = {
|
|
9
|
-
id: "<id>",
|
|
10
|
-
};
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Fields
|
|
14
|
-
|
|
15
|
-
| Field | Type | Required | Description |
|
|
16
|
-
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
17
|
-
| `id` | *string* | :heavy_check_mark: | Integration ID |
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
# DtoCreateIntegrationRequest
|
|
2
|
-
|
|
3
|
-
## Example Usage
|
|
4
|
-
|
|
5
|
-
```typescript
|
|
6
|
-
import { DtoCreateIntegrationRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
-
|
|
8
|
-
let value: DtoCreateIntegrationRequest = {
|
|
9
|
-
credentials: {},
|
|
10
|
-
name: "<value>",
|
|
11
|
-
provider: "s3",
|
|
12
|
-
};
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Fields
|
|
16
|
-
|
|
17
|
-
| Field | Type | Required | Description |
|
|
18
|
-
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
|
19
|
-
| `credentials` | Record<string, *string*> | :heavy_check_mark: | N/A |
|
|
20
|
-
| `name` | *string* | :heavy_check_mark: | N/A |
|
|
21
|
-
| `provider` | [models.SecretProvider](../../sdk/models/secret-provider.md) | :heavy_check_mark: | N/A |
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
# DtoIntegrationEntityMapping
|
|
2
|
-
|
|
3
|
-
Integration entity mapping for external provider systems
|
|
4
|
-
|
|
5
|
-
## Example Usage
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
import { DtoIntegrationEntityMapping } from "@flexprice/sdk/sdk/models";
|
|
9
|
-
|
|
10
|
-
let value: DtoIntegrationEntityMapping = {
|
|
11
|
-
id: "<id>",
|
|
12
|
-
provider: "stripe",
|
|
13
|
-
};
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
## Fields
|
|
17
|
-
|
|
18
|
-
| Field | Type | Required | Description |
|
|
19
|
-
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
20
|
-
| `id` | *string* | :heavy_check_mark: | id is the external entity ID from the provider |
|
|
21
|
-
| `provider` | [models.Provider](../../sdk/models/provider.md) | :heavy_check_mark: | provider is the integration provider name (e.g., "stripe", "razorpay") |
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# DtoLinkedIntegrationsResponse
|
|
2
|
-
|
|
3
|
-
## Example Usage
|
|
4
|
-
|
|
5
|
-
```typescript
|
|
6
|
-
import { DtoLinkedIntegrationsResponse } from "@flexprice/sdk/sdk/models";
|
|
7
|
-
|
|
8
|
-
let value: DtoLinkedIntegrationsResponse = {};
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Fields
|
|
12
|
-
|
|
13
|
-
| Field | Type | Required | Description |
|
|
14
|
-
| ------------------ | ------------------ | ------------------ | ------------------ |
|
|
15
|
-
| `providers` | *string*[] | :heavy_minus_sign: | N/A |
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
# GetIntegrationRequest
|
|
2
|
-
|
|
3
|
-
## Example Usage
|
|
4
|
-
|
|
5
|
-
```typescript
|
|
6
|
-
import { GetIntegrationRequest } from "@flexprice/sdk/sdk/models";
|
|
7
|
-
|
|
8
|
-
let value: GetIntegrationRequest = {
|
|
9
|
-
provider: "<value>",
|
|
10
|
-
};
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Fields
|
|
14
|
-
|
|
15
|
-
| Field | Type | Required | Description |
|
|
16
|
-
| -------------------- | -------------------- | -------------------- | -------------------- |
|
|
17
|
-
| `provider` | *string* | :heavy_check_mark: | Integration provider |
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
# Provider
|
|
2
|
-
|
|
3
|
-
provider is the integration provider name (e.g., "stripe", "razorpay")
|
|
4
|
-
|
|
5
|
-
## Example Usage
|
|
6
|
-
|
|
7
|
-
```typescript
|
|
8
|
-
import { Provider } from "@flexprice/sdk/sdk/models";
|
|
9
|
-
|
|
10
|
-
let value: Provider = "stripe";
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Values
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
"stripe" | "razorpay" | "paypal"
|
|
17
|
-
```
|