@whooshbang/contracts 2.0.0-rc.6 → 2.0.0-rc.7
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 +8 -0
- package/contract-manifest.json +40 -42
- package/dist/generated/artifact-index.d.ts +34 -34
- package/dist/generated/artifact-index.js +39 -41
- package/dist/generated/artifact-index.js.map +1 -1
- package/dist/generated/validators-standalone.d.ts +391 -404
- package/dist/generated/validators-standalone.js +8115 -6262
- package/dist/generated/validators-standalone.js.map +1 -1
- package/dist/generated/validators.d.ts +9 -10
- package/dist/generated/validators.js +9 -10
- package/dist/generated/validators.js.map +1 -1
- package/dist/generated/whooshbang-v1.d.ts +166 -59
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/fixtures/core-v1/fixture-index.json +54 -71
- package/fixtures/core-v1/requests/update-billing-receipt-email.json +3 -0
- package/fixtures/core-v1/scenarios/api-credential-invalid-indistinguishable.json +1 -1
- package/fixtures/core-v1/scenarios/api-credential-one-time-reveal.json +1 -1
- package/fixtures/core-v1/scenarios/api-credential-revocation-replay.json +1 -1
- package/fixtures/core-v1/scenarios/api-credential-rotation-overlap.json +1 -1
- package/fixtures/core-v1/scenarios/cancellation-too-late.json +1 -1
- package/fixtures/core-v1/scenarios/cross-organization-project.json +1 -1
- package/fixtures/core-v1/scenarios/cross-project-resource.json +1 -1
- package/fixtures/core-v1/scenarios/environment-mismatch.json +1 -1
- package/fixtures/core-v1/scenarios/idempotency-conflict.json +1 -1
- package/fixtures/core-v1/scenarios/idempotency-equivalent-replay.json +1 -1
- package/fixtures/core-v1/scenarios/malformed-bearer.json +1 -1
- package/fixtures/core-v1/scenarios/metadata-overrun.json +1 -1
- package/fixtures/core-v1/scenarios/missing-scope.json +1 -1
- package/fixtures/core-v1/scenarios/project-create-equivalent-replay.json +1 -1
- package/fixtures/core-v1/scenarios/project-slug-conflict.json +1 -1
- package/fixtures/core-v1/scenarios/provider-outcome-unknown.json +1 -1
- package/fixtures/core-v1/scenarios/subscription-activation-replay.json +1 -1
- package/fixtures/core-v1/scenarios/subscription-authorization-capability-opacity.json +1 -1
- package/fixtures/core-v1/scenarios/subscription-cross-connection-callback-rejected.json +1 -1
- package/fixtures/core-v1/scenarios/subscription-expired-replay.json +1 -1
- package/fixtures/core-v1/scenarios/subscription-selected-connection-replay.json +1 -1
- package/fixtures/core-v1/success/auto-top-up-settings.json +2 -2
- package/fixtures/core-v1/success/billing-account.json +4 -2
- package/fixtures/core-v1/success/billing-entitlements.json +3 -4
- package/fixtures/core-v1/success/billing-invoices.json +33 -0
- package/fixtures/core-v1/success/card-setup.json +7 -0
- package/fixtures/core-v1/success/credit-purchase.json +15 -0
- package/fixtures/core-v1/success/reconcile-card-setup.json +12 -0
- package/fixtures/core-v1/success/subscription-change.json +3 -1
- package/fixtures/interaction-machine-v1/scenarios/ack-conflict.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/ack-cross-machine.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/ack-out-of-order.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/ack-replay.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/ambiguous-free-text.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/callback-token-opacity.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/credential-registration-conflict.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/credential-registration-replay.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/credential-revocation-replay.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/credential-rotation.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/first-credential-activates.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/interaction-duplicate.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/interaction-expired.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/interaction-mismatch.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/interaction-retired.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/interaction-stale.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/machine-admin-denied.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/machine-bound-message-create.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/machine-cancel-denied.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/machine-crash-before-ack.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/machine-notifier-mismatch.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/machine-other-message-read.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/machine-owned-message-read.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/machine-subscriber-mismatch.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/poll-uncommitted-cursor-rejected.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/project-credential-machine-endpoint-denied.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/quarantine-integrity-rejected.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/quarantine-signature-rejected.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/quarantine-valid.json +1 -1
- package/fixtures/interaction-machine-v1/scenarios/revoked-machine-credential.json +1 -1
- package/fixtures/recipient-experience-v1/scenarios/membership-broadcast-snapshot.json +1 -1
- package/fixtures/recipient-experience-v1/scenarios/preferred-binding-resolution.json +1 -1
- package/fixtures/recipient-experience-v1/scenarios/recipient-session-security.json +1 -1
- package/fixtures/recipient-experience-v1/scenarios/subscriber-initial-groups-transaction.json +1 -1
- package/openapi/generated/whooshbang-v1.bundle.json +548 -470
- package/openapi/whooshbang-v1.yaml +193 -331
- package/package.json +1 -1
- package/schemas/core-scenario.schema.json +1 -1
- package/schemas/events/agent-binding-degraded-v1.schema.json +1 -1
- package/schemas/events/interaction-expired-v1.schema.json +1 -1
- package/schemas/events/interaction-received-v1.schema.json +1 -1
- package/schemas/events/message-delivered-v1.schema.json +1 -1
- package/schemas/events/message-expired-v1.schema.json +1 -1
- package/schemas/events/message-failed-v1.schema.json +1 -1
- package/schemas/events/message-provider-accepted-v1.schema.json +1 -1
- package/schemas/events/subscription-activated-v1.schema.json +1 -1
- package/schemas/events/subscription-revoked-v1.schema.json +1 -1
- package/schemas/events/whooshbang-event-v1.schema.json +1 -1
- package/schemas/fixture-index.schema.json +1 -1
- package/schemas/interaction-machine-scenario.schema.json +1 -1
- package/schemas/interaction-v1.schema.json +1 -1
- package/schemas/machine-v1.schema.json +1 -1
- package/schemas/provider-capabilities-v1.schema.json +1 -1
- package/schemas/webhooks/webhook-delivery-case-v1.schema.json +1 -1
- package/schemas/webhooks/webhook-signing-vector-v1.schema.json +1 -1
- package/schemas/whooshbang-v1.schema.json +505 -243
- package/fixtures/core-v1/success/auto-top-up-setup.json +0 -5
- package/fixtures/core-v1/success/billing-portal-session.json +0 -3
- package/fixtures/core-v1/success/reconcile-auto-top-up-setup.json +0 -17
- package/fixtures/core-v1/success/reconcile-subscription-checkout.json +0 -35
- package/fixtures/core-v1/success/reconcile-wallet-checkout.json +0 -36
- package/fixtures/core-v1/success/subscription-checkout.json +0 -5
- package/fixtures/core-v1/success/wallet-checkout.json +0 -5
- /package/fixtures/core-v1/requests/{create-wallet-checkout.json → create-credit-purchase.json} +0 -0
- /package/fixtures/core-v1/requests/{create-subscription-checkout.json → create-subscription-change.json} +0 -0
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
/**
|
|
6
6
|
* Public request, resource, summary, and Problem Details models for the WhooshBang V1 REST API.
|
|
7
7
|
*/
|
|
8
|
-
export type WhooshBangV1ContractDocument = OrganizationProjection | CloseOrganizationRequest | OrganizationClosureResult | CreateProjectRequest | Project | UpdateProjectRequest | PrivacyMode | ProjectCollection | RecipientCopyOverrideCollection | UpdateRecipientCopyOverrideRequest | CreateApiCredentialRequest | RotateApiCredentialRequest | ApiCredential | ApiCredentialCollection | ApiCredentialSecretReveal | ApiCredentialRotation | CreateOrganizationCredentialRequest | RotateOrganizationCredentialRequest | OrganizationCredential | OrganizationCredentialCollection | OrganizationCredentialSecretReveal | OrganizationCredentialRotation | CreateCustomerEndpointRequest | CustomerEndpoint | CustomerEndpointCollection | CustomerEndpointMutationResult | CustomerEndpointAttemptCollection | CustomerEndpointVerificationChallenge | CreateSubscriptionLinkRequest | SubscriptionLink | CreateMessageRequest | Message | Problem | IdempotencyKey | ProviderCapabilitiesCollection | ProviderInstallationCollection | EmailDomainCollection | CreateEmailDomainRequest | CreateEmailBindingImportRequest | EmailBindingImportJob | ConnectionProviderCollection | ChannelConnection | ChannelConnectionCollection | CreateChannelConnectionRequest | UpdateChannelConnectionRequest | RotateChannelConnectionCredentialRequest | NotifierConnectionCollection | AttachNotifierConnectionRequest | ConnectionTest | ConnectionTestCollection | CreateConnectionTestRequest | CustomerApplicationManifest | ProjectRecipientExperience | UpdateProjectRecipientExperienceRequest | RecipientBrandLogoUpload | NotificationImageAsset | EnvironmentRecipientExperience | UpdateEnvironmentRecipientExperienceRequest | SubscriberChannelSettings | AcknowledgeEmailRemediationRequest | CreateRecipientSessionRequest | CreateRecipientSessionResponse | RecipientSession | CreateProviderHandoffRequest | ProviderHandoff | RecipientHandoffCompletion | SetPreferredBindingRequest | PreferredBinding | CreateSubscriberRequest | UpdateSubscriberRequest | SubscriberCollection | Subscriber | SubscriberDataExport | CreateSubscriberGroupRequest | SubscriberGroup | SubscriberGroupCollection | SubscriberGroupMembership | SubscriberGroupMembershipCollection | CreateGroupBroadcastRequest | GroupBroadcast | AssertEmailConsentRequest | BindingSummary | UsageReport | MessageListEntry | MessageListPage | MessageDeliveryTimelineEntry | RetainedMessageContent | MessageDeliveryHistory | InteractionTimelineEntry | InteractionTimeline | UpdateEmailSenderRequest | CustomerEventDeliveryAttempt | CustomerEventDeliveryHistory | DeliveryHolds | MachineClientOperations | MachineClientOperationsList | RecipientCopyCatalogue | MessageNotificationImage | BillingAccount |
|
|
8
|
+
export type WhooshBangV1ContractDocument = OrganizationProjection | CloseOrganizationRequest | OrganizationClosureResult | CreateProjectRequest | Project | UpdateProjectRequest | PrivacyMode | ProjectCollection | RecipientCopyOverrideCollection | UpdateRecipientCopyOverrideRequest | CreateApiCredentialRequest | RotateApiCredentialRequest | ApiCredential | ApiCredentialCollection | ApiCredentialSecretReveal | ApiCredentialRotation | CreateOrganizationCredentialRequest | RotateOrganizationCredentialRequest | OrganizationCredential | OrganizationCredentialCollection | OrganizationCredentialSecretReveal | OrganizationCredentialRotation | CreateCustomerEndpointRequest | CustomerEndpoint | CustomerEndpointCollection | CustomerEndpointMutationResult | CustomerEndpointAttemptCollection | CustomerEndpointVerificationChallenge | CreateSubscriptionLinkRequest | SubscriptionLink | CreateMessageRequest | Message | Problem | IdempotencyKey | ProviderCapabilitiesCollection | ProviderInstallationCollection | EmailDomainCollection | CreateEmailDomainRequest | CreateEmailBindingImportRequest | EmailBindingImportJob | ConnectionProviderCollection | ChannelConnection | ChannelConnectionCollection | CreateChannelConnectionRequest | UpdateChannelConnectionRequest | RotateChannelConnectionCredentialRequest | NotifierConnectionCollection | AttachNotifierConnectionRequest | ConnectionTest | ConnectionTestCollection | CreateConnectionTestRequest | CustomerApplicationManifest | ProjectRecipientExperience | UpdateProjectRecipientExperienceRequest | RecipientBrandLogoUpload | NotificationImageAsset | EnvironmentRecipientExperience | UpdateEnvironmentRecipientExperienceRequest | SubscriberChannelSettings | AcknowledgeEmailRemediationRequest | CreateRecipientSessionRequest | CreateRecipientSessionResponse | RecipientSession | CreateProviderHandoffRequest | ProviderHandoff | RecipientHandoffCompletion | SetPreferredBindingRequest | PreferredBinding | CreateSubscriberRequest | UpdateSubscriberRequest | SubscriberCollection | Subscriber | SubscriberDataExport | CreateSubscriberGroupRequest | SubscriberGroup | SubscriberGroupCollection | SubscriberGroupMembership | SubscriberGroupMembershipCollection | CreateGroupBroadcastRequest | GroupBroadcast | AssertEmailConsentRequest | BindingSummary | UsageReport | MessageListEntry | MessageListPage | MessageDeliveryTimelineEntry | RetainedMessageContent | MessageDeliveryHistory | InteractionTimelineEntry | InteractionTimeline | UpdateEmailSenderRequest | CustomerEventDeliveryAttempt | CustomerEventDeliveryHistory | DeliveryHolds | MachineClientOperations | MachineClientOperationsList | RecipientCopyCatalogue | MessageNotificationImage | BillingAccount | BillingCard | CardSetup | CreateCreditPurchaseRequest | CreditPurchase | BillingInvoice | BillingInvoiceCollection | UpdateBillingReceiptEmailRequest | BillingEntitlements | SubscriptionSelection | ProjectAttribution | UpdateProjectAttributionRequest | BillingProjectSlots | AssignBillingProjectSlotsRequest | UpdateAutoTopUpSettingsRequest | AutoTopUpSettings | SubscriptionChange | ConfirmSubscriptionChangeRequest;
|
|
9
9
|
/**
|
|
10
10
|
* An opaque identifier. Its shape, ordering, and embedded content are not public promises.
|
|
11
11
|
*/
|
|
@@ -2415,24 +2415,6 @@ export type MachineScopeSummary = [
|
|
|
2415
2415
|
("machine-messages:write" | "machine-messages:read" | "machine-events:read" | "machine-events:ack"),
|
|
2416
2416
|
("machine-messages:write" | "machine-messages:read" | "machine-events:read" | "machine-events:ack")
|
|
2417
2417
|
];
|
|
2418
|
-
/**
|
|
2419
|
-
* Account subscription selection for initial Checkout or a quoted change. Additional project quantities have a technical Checkout bound. The server selects approved prices and allowances. Attribution is included on Team and Agency; PAYG may purchase the account-wide add-on.
|
|
2420
|
-
*/
|
|
2421
|
-
export type CreateSubscriptionCheckoutRequest = CreateSubscriptionCheckoutRequest1 & {
|
|
2422
|
-
plan: "payg" | "team" | "agency";
|
|
2423
|
-
hide_attribution: boolean;
|
|
2424
|
-
additional_projects: number;
|
|
2425
|
-
};
|
|
2426
|
-
export type CreateSubscriptionCheckoutRequest1 = {
|
|
2427
|
-
plan?: "team" | "agency";
|
|
2428
|
-
[k: string]: unknown;
|
|
2429
|
-
} | {
|
|
2430
|
-
hide_attribution?: true;
|
|
2431
|
-
[k: string]: unknown;
|
|
2432
|
-
} | {
|
|
2433
|
-
additional_projects?: number;
|
|
2434
|
-
[k: string]: unknown;
|
|
2435
|
-
};
|
|
2436
2418
|
/**
|
|
2437
2419
|
* The current Clerk organization projected as a WhooshBang tenant. Clerk organization and user identifiers are not public fields.
|
|
2438
2420
|
*/
|
|
@@ -7797,7 +7779,7 @@ export interface MessageNotificationImage {
|
|
|
7797
7779
|
data_base64: string;
|
|
7798
7780
|
}
|
|
7799
7781
|
/**
|
|
7800
|
-
* Shared account
|
|
7782
|
+
* Shared account message credit. Bonus funds core sends only; shared email draws purchased or starter credit. Amounts are exact USD decimal strings. Negative purchased or bonus balances retain refund debt and are not spendable.
|
|
7801
7783
|
*/
|
|
7802
7784
|
export interface BillingAccount {
|
|
7803
7785
|
currency: "USD";
|
|
@@ -7808,23 +7790,128 @@ export interface BillingAccount {
|
|
|
7808
7790
|
available_email_credit_usd: string;
|
|
7809
7791
|
core_price_per_1000_usd: "3.000000";
|
|
7810
7792
|
shared_email_price_per_1000_usd: "1.000000";
|
|
7811
|
-
|
|
7793
|
+
/**
|
|
7794
|
+
* Whether this deployment can take card payments now. When false, credit, plans and add-ons cannot be bought.
|
|
7795
|
+
*/
|
|
7796
|
+
purchases_available: boolean;
|
|
7812
7797
|
packs: {
|
|
7813
7798
|
purchase_cents: 500 | 1000 | 2500 | 5000 | 10000;
|
|
7814
7799
|
core_credit_usd: string;
|
|
7815
7800
|
}[];
|
|
7801
|
+
card: null | BillingCard;
|
|
7802
|
+
/**
|
|
7803
|
+
* Where receipts and invoices are emailed. Null sends none.
|
|
7804
|
+
*/
|
|
7805
|
+
receipt_email: null | EmailAddress;
|
|
7816
7806
|
}
|
|
7817
|
-
|
|
7818
|
-
|
|
7807
|
+
/**
|
|
7808
|
+
* The organization's one default card. It pays for credit, automatic top-up, plans and add-ons. Only the brand, last four digits and expiry are ever returned.
|
|
7809
|
+
*/
|
|
7810
|
+
export interface BillingCard {
|
|
7811
|
+
brand: string;
|
|
7812
|
+
last_four: string;
|
|
7813
|
+
exp_month: number;
|
|
7814
|
+
exp_year: number;
|
|
7819
7815
|
}
|
|
7820
|
-
|
|
7816
|
+
/**
|
|
7817
|
+
* A card form session. A person enters the card in the embeddable payment form mounted with client_secret and publishable_key, then reconciles. A complete setup makes that card the one default card. client_secret is present only while open.
|
|
7818
|
+
*/
|
|
7819
|
+
export interface CardSetup {
|
|
7821
7820
|
id: string;
|
|
7822
7821
|
status: "open" | "complete" | "expired";
|
|
7823
|
-
|
|
7822
|
+
client_secret: string | null;
|
|
7823
|
+
publishable_key: string | null;
|
|
7824
|
+
card: null | BillingCard;
|
|
7825
|
+
}
|
|
7826
|
+
/**
|
|
7827
|
+
* Buy one credit pack now with the default card. The amount is the explicit approval of the charge.
|
|
7828
|
+
*/
|
|
7829
|
+
export interface CreateCreditPurchaseRequest {
|
|
7830
|
+
purchase_cents: 500 | 1000 | 2500 | 5000 | 10000;
|
|
7831
|
+
}
|
|
7832
|
+
/**
|
|
7833
|
+
* A credit pack charged to the default card. paid means the credit is in the balance. requires_action means the card issuer asks the customer to confirm in the payment form using client_secret; reconcile afterwards. A failed purchase charged nothing; start a new one after updating the card.
|
|
7834
|
+
*/
|
|
7835
|
+
export interface CreditPurchase {
|
|
7836
|
+
id: string;
|
|
7837
|
+
purchase_cents: 500 | 1000 | 2500 | 5000 | 10000;
|
|
7838
|
+
credit_usd: string;
|
|
7839
|
+
status: "processing" | "requires_action" | "paid" | "failed";
|
|
7840
|
+
failure: ("card_declined" | "authentication_failed") | null;
|
|
7841
|
+
client_secret: string | null;
|
|
7842
|
+
/**
|
|
7843
|
+
* The public key the payment form uses with client_secret. Present only with client_secret.
|
|
7844
|
+
*/
|
|
7845
|
+
publishable_key: string | null;
|
|
7846
|
+
card: BillingCard;
|
|
7847
|
+
}
|
|
7848
|
+
/**
|
|
7849
|
+
* One charge or credit grant. Credit purchases carry purchase_cents; recurring invoices carry their items and paid period. document_url downloads the invoice PDF or opens the receipt.
|
|
7850
|
+
*/
|
|
7851
|
+
export interface BillingInvoice {
|
|
7852
|
+
id: string;
|
|
7853
|
+
kind: "credit" | "automatic_top_up" | "recurring" | "welcome_credit";
|
|
7854
|
+
created_at: string;
|
|
7855
|
+
amount_usd: string;
|
|
7856
|
+
status: "paid" | "open" | "void" | "uncollectible" | "refunded" | "free";
|
|
7857
|
+
purchase_cents: (500 | 1000 | 2500 | 5000 | 10000) | null;
|
|
7858
|
+
/**
|
|
7859
|
+
* @maxItems 3
|
|
7860
|
+
*/
|
|
7861
|
+
items: [] | [
|
|
7862
|
+
{
|
|
7863
|
+
kind: "team" | "agency" | "attribution" | "project";
|
|
7864
|
+
quantity: number;
|
|
7865
|
+
}
|
|
7866
|
+
] | [
|
|
7867
|
+
{
|
|
7868
|
+
kind: "team" | "agency" | "attribution" | "project";
|
|
7869
|
+
quantity: number;
|
|
7870
|
+
},
|
|
7871
|
+
{
|
|
7872
|
+
kind: "team" | "agency" | "attribution" | "project";
|
|
7873
|
+
quantity: number;
|
|
7874
|
+
}
|
|
7875
|
+
] | [
|
|
7876
|
+
{
|
|
7877
|
+
kind: "team" | "agency" | "attribution" | "project";
|
|
7878
|
+
quantity: number;
|
|
7879
|
+
},
|
|
7880
|
+
{
|
|
7881
|
+
kind: "team" | "agency" | "attribution" | "project";
|
|
7882
|
+
quantity: number;
|
|
7883
|
+
},
|
|
7884
|
+
{
|
|
7885
|
+
kind: "team" | "agency" | "attribution" | "project";
|
|
7886
|
+
quantity: number;
|
|
7887
|
+
}
|
|
7888
|
+
];
|
|
7889
|
+
period_start: string | null;
|
|
7890
|
+
period_end: string | null;
|
|
7891
|
+
document_url: string | null;
|
|
7892
|
+
document_kind: ("invoice" | "receipt") | null;
|
|
7893
|
+
}
|
|
7894
|
+
/**
|
|
7895
|
+
* A page of invoices and receipts, newest first.
|
|
7896
|
+
*/
|
|
7897
|
+
export interface BillingInvoiceCollection {
|
|
7898
|
+
/**
|
|
7899
|
+
* @maxItems 100
|
|
7900
|
+
*/
|
|
7901
|
+
items: BillingInvoice[];
|
|
7902
|
+
next_cursor?: string;
|
|
7903
|
+
page?: ListPageNumber;
|
|
7904
|
+
page_size?: ListPageSize;
|
|
7905
|
+
total?: ListTotal;
|
|
7824
7906
|
}
|
|
7825
|
-
|
|
7826
|
-
|
|
7827
|
-
|
|
7907
|
+
/**
|
|
7908
|
+
* Where receipts and invoices are emailed. Null stops them.
|
|
7909
|
+
*/
|
|
7910
|
+
export interface UpdateBillingReceiptEmailRequest {
|
|
7911
|
+
/**
|
|
7912
|
+
* The receipt address, or null.
|
|
7913
|
+
*/
|
|
7914
|
+
email: null | EmailAddress;
|
|
7828
7915
|
}
|
|
7829
7916
|
export interface BillingEntitlements {
|
|
7830
7917
|
/**
|
|
@@ -7838,7 +7925,10 @@ export interface BillingEntitlements {
|
|
|
7838
7925
|
live_notifications_remaining: string;
|
|
7839
7926
|
shared_emails_remaining: string;
|
|
7840
7927
|
allowance_period_end: string | null;
|
|
7841
|
-
|
|
7928
|
+
/**
|
|
7929
|
+
* Whether plans and add-ons can be bought now. False when the deployment has no recurring catalog or cannot take payments.
|
|
7930
|
+
*/
|
|
7931
|
+
recurring_available: boolean;
|
|
7842
7932
|
offers: {
|
|
7843
7933
|
kind: "team" | "agency" | "attribution" | "project";
|
|
7844
7934
|
monthly_price_usd: string;
|
|
@@ -7847,19 +7937,29 @@ export interface BillingEntitlements {
|
|
|
7847
7937
|
included_projects: number;
|
|
7848
7938
|
hide_attribution: boolean;
|
|
7849
7939
|
}[];
|
|
7850
|
-
pending_subscription_checkout_id: string | null;
|
|
7851
|
-
subscription_management_available: boolean;
|
|
7852
7940
|
has_subscription: boolean;
|
|
7853
7941
|
pending_subscription_change_id?: string | null;
|
|
7942
|
+
/**
|
|
7943
|
+
* A recurring charge the default card did not pay. Paid access continues until the paid boundary; another attempt follows at next_attempt_at, or none when null. Update the card to settle it.
|
|
7944
|
+
*/
|
|
7945
|
+
payment_issue: null | {
|
|
7946
|
+
amount_usd: string;
|
|
7947
|
+
next_attempt_at: string | null;
|
|
7948
|
+
};
|
|
7854
7949
|
}
|
|
7855
|
-
|
|
7856
|
-
|
|
7857
|
-
|
|
7858
|
-
|
|
7859
|
-
|
|
7860
|
-
|
|
7861
|
-
|
|
7862
|
-
|
|
7950
|
+
/**
|
|
7951
|
+
* An account's recurring selection: a plan, branding removal and extra projects. The server selects approved prices and allowances. Branding removal is included on Team and Agency; Pay as you go may add it. Choosing Pay as you go with nothing else ends every recurring charge at the paid boundary.
|
|
7952
|
+
*/
|
|
7953
|
+
export interface SubscriptionSelection {
|
|
7954
|
+
plan: "payg" | "team" | "agency";
|
|
7955
|
+
/**
|
|
7956
|
+
* Remove WhooshBang branding from recipient emails, messages and subscription pages.
|
|
7957
|
+
*/
|
|
7958
|
+
hide_attribution: boolean;
|
|
7959
|
+
/**
|
|
7960
|
+
* Extra projects beyond the plan's included projects, each billed monthly.
|
|
7961
|
+
*/
|
|
7962
|
+
additional_projects: number;
|
|
7863
7963
|
}
|
|
7864
7964
|
/**
|
|
7865
7965
|
* The saved project preference and current server-enforced paid entitlement. Expiry restores visible attribution without changing sender identity, consent, unsubscribe or answer controls.
|
|
@@ -7872,9 +7972,6 @@ export interface ProjectAttribution {
|
|
|
7872
7972
|
export interface UpdateProjectAttributionRequest {
|
|
7873
7973
|
hide_attribution: boolean;
|
|
7874
7974
|
}
|
|
7875
|
-
export interface BillingPortalSession {
|
|
7876
|
-
portal_url: string;
|
|
7877
|
-
}
|
|
7878
7975
|
/**
|
|
7879
7976
|
* Reusable account project slots. After a downgrade the oldest requested projects retain active slots. Unassigned projects retain data, accepted delivery and answers; new live sends require an active slot.
|
|
7880
7977
|
*/
|
|
@@ -7904,6 +8001,9 @@ export interface UpdateAutoTopUpSettingsRequest {
|
|
|
7904
8001
|
trigger_cents: number;
|
|
7905
8002
|
monthly_cap_cents: number;
|
|
7906
8003
|
}
|
|
8004
|
+
/**
|
|
8005
|
+
* Automatic top-up is off by default. When on, the default card buys the selected pack whenever credit falls below the trigger. The monthly cap counts pending and paid purchases started in each UTC calendar month; refunds do not restore it. Turning it off stops future purchases; one already processing may finish. needs_card means there is no default card yet.
|
|
8006
|
+
*/
|
|
7907
8007
|
export interface AutoTopUpSettings {
|
|
7908
8008
|
enabled: boolean;
|
|
7909
8009
|
purchase_cents: 500 | 1000 | 2500 | 5000 | 10000;
|
|
@@ -7912,35 +8012,42 @@ export interface AutoTopUpSettings {
|
|
|
7912
8012
|
available: boolean;
|
|
7913
8013
|
monthly_reserved_cents: number;
|
|
7914
8014
|
state: "disabled" | "needs_card" | "ready" | "processing" | "card_update_required" | "monthly_cap_reached";
|
|
7915
|
-
|
|
7916
|
-
|
|
7917
|
-
|
|
8015
|
+
card: null | BillingCard;
|
|
8016
|
+
/**
|
|
8017
|
+
* The most recent paid automatic purchase, if any.
|
|
8018
|
+
*/
|
|
8019
|
+
last_purchase: null | {
|
|
8020
|
+
id: string;
|
|
8021
|
+
purchase_cents: 500 | 1000 | 2500 | 5000 | 10000;
|
|
8022
|
+
credit_usd: string;
|
|
8023
|
+
completed_at: string;
|
|
7918
8024
|
};
|
|
7919
|
-
pending_setup_id: string | null;
|
|
7920
|
-
}
|
|
7921
|
-
export interface AutoTopUpSetup {
|
|
7922
|
-
id: string;
|
|
7923
|
-
status: "open" | "complete" | "expired";
|
|
7924
|
-
checkout_url: string | null;
|
|
7925
|
-
}
|
|
7926
|
-
export interface ReconcileAutoTopUpSetupResult {
|
|
7927
|
-
outcome: "applied" | "unpaid" | "ignored";
|
|
7928
|
-
settings: AutoTopUpSettings;
|
|
7929
8025
|
}
|
|
7930
8026
|
/**
|
|
7931
|
-
* An owned
|
|
8027
|
+
* An owned recurring selection. A reserved quote has not charged anything. start buys the first plan or add-on; upgrade charges now, resets the cycle and credits unused paid time; boundary reductions start at the existing paid boundary. Confirm the exact immediate charge; the default card pays it. Processing or pending changes are recovered, never repeated.
|
|
7932
8028
|
*/
|
|
7933
8029
|
export interface SubscriptionChange {
|
|
7934
8030
|
id: string;
|
|
7935
|
-
kind: "upgrade" | "boundary";
|
|
8031
|
+
kind: "start" | "upgrade" | "boundary";
|
|
7936
8032
|
status: "reserved" | "processing" | "pending" | "scheduled" | "applied" | "expired";
|
|
7937
|
-
selection:
|
|
8033
|
+
selection: SubscriptionSelection;
|
|
7938
8034
|
monthly_price_usd: string;
|
|
7939
8035
|
charge_now_usd: string | null;
|
|
7940
8036
|
unused_time_credit_usd: string | null;
|
|
7941
8037
|
effective_at: string | null;
|
|
7942
8038
|
expires_at: string;
|
|
7943
|
-
|
|
8039
|
+
/**
|
|
8040
|
+
* Present only while the card issuer asks the customer to confirm this charge in the payment form.
|
|
8041
|
+
*/
|
|
8042
|
+
client_secret: string | null;
|
|
8043
|
+
/**
|
|
8044
|
+
* The public key the payment form uses with client_secret. Present only with client_secret.
|
|
8045
|
+
*/
|
|
8046
|
+
publishable_key: string | null;
|
|
8047
|
+
/**
|
|
8048
|
+
* Why the last charge attempt failed. Update the card, then confirm again.
|
|
8049
|
+
*/
|
|
8050
|
+
failure: ("card_declined" | "authentication_failed") | null;
|
|
7944
8051
|
}
|
|
7945
8052
|
export interface ConfirmSubscriptionChangeRequest {
|
|
7946
8053
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -15,12 +15,12 @@ export type { MachineCredentialCrypto, MachineCredentialMaterial, MachineCredent
|
|
|
15
15
|
export type { RejectedWebhookSignature, VerifiedWebhookSignature, VerifyWebhookSignatureOptions, WebhookCrypto, WebhookHeaderEntry, WebhookHeaderRecord, WebhookHeaders, WebhookSignatureVerification, WebhookVerificationFailureReason, } from "./webhook-signature.js";
|
|
16
16
|
export type { ConsumeVerifiedWebhookOptions, DuplicateWebhookConsumption, ProcessedWebhookConsumption, RejectedWebhookConsumption, WebhookConsumptionResult, WebhookConsumerRejectionReason, WebhookDeduplicationInput, WebhookDeduplicationOutcome, WebhookDeduplicationStore, } from "./webhook-consumer.js";
|
|
17
17
|
export type { AcceptedWebhookDelivery, ClassifyWebhookDeliveryOptions, HttpDeliveryOutcome, NetworkFailureOutcome, RetryWebhookDelivery, TerminalWebhookDelivery, WebhookDeliveryClassification, WebhookDeliveryOutcome, WebhookDeliveryRetryReason, WebhookDeliveryTerminalReason, } from "./webhook-delivery.js";
|
|
18
|
-
export { contractValidationErrors, validateOrganizationCredential, validateOrganizationCredentialCollection, validateOrganizationCredentialRotation, validateOrganizationCredentialSecretReveal, validateBillingProjectSlots, validateAssignBillingProjectSlotsRequest,
|
|
18
|
+
export { contractValidationErrors, validateOrganizationCredential, validateOrganizationCredentialCollection, validateOrganizationCredentialRotation, validateOrganizationCredentialSecretReveal, validateBillingProjectSlots, validateAssignBillingProjectSlotsRequest, validateSubscriptionChange, validateConfirmSubscriptionChangeRequest, validateBillingEntitlements, validateSubscriptionSelection, validateProjectAttribution, validateUpdateProjectAttributionRequest, validateUpdateAutoTopUpSettingsRequest, validateAutoTopUpSettings, validateBillingAccount, validateBillingCard, validateCardSetup, validateCreateCreditPurchaseRequest, validateCreditPurchase, validateBillingInvoice, validateBillingInvoiceCollection, validateUpdateBillingReceiptEmailRequest, validateOrganizationProjection, validateApiCredential, validateApiCredentialCollection, validateApiCredentialRotation, validateApiCredentialSecretReveal, validateAssertEmailConsentRequest, validateBindingSummary, validateCreateOrganizationCredentialRequest, validateCreateApiCredentialRequest, validateChannelConnection, validateChannelConnectionCollection, validateConnectionProviderCollection, validateCreateChannelConnectionRequest, validateUpdateChannelConnectionRequest, validateRotateChannelConnectionCredentialRequest, validateConnectionTest, validateConnectionTestCollection, validateUsageReport, validateCreateConnectionTestRequest, validateCustomerApplicationManifest, validateAttachNotifierConnectionRequest, validateNotifierConnectionCollection, validateProjectRecipientExperience, validateRecipientBrandLogoUpload, validateNotificationImageAsset, validateUpdateProjectRecipientExperienceRequest, validateEnvironmentRecipientExperience, validateUpdateEnvironmentRecipientExperienceRequest, validateSubscriberChannelSettings, validateAcknowledgeEmailRemediationRequest, validateCreateRecipientSessionRequest, validateCreateRecipientSessionResponse, validateRecipientSession, validateCreateProviderHandoffRequest, validateProviderHandoff, validateRecipientHandoffCompletion, validateSetPreferredBindingRequest, validatePreferredBinding, validateCreateSubscriberRequest, validateSubscriber, validateUpdateSubscriberRequest, validateSubscriberCollection, validateSubscriberDataExport, validateCloseOrganizationRequest, validateOrganizationClosureResult, validateCreateSubscriberGroupRequest, validateUpdateSubscriberGroupRequest, validateSubscriberGroup, validateSubscriberGroupCollection, validateSubscriberGroupMembership, validateSubscriberGroupMembershipCollection, validateCreateGroupBroadcastRequest, validateGroupBroadcast, validateCreateCustomerEndpointRequest, validateCreateProjectRequest, validateUpdateProjectRequest, validateCreateMachineClientRequest, validateCreateMessageRequest, validateCreateSubscriptionLinkRequest, validateDeliveryAttemptSummary, validateCustomerEndpoint, validateCustomerEndpointAttemptCollection, validateCustomerEndpointCollection, validateCustomerEndpointMutationResult, validateCustomerEndpointVerificationChallenge, validateIdempotencyKey, validateAgentBindingDegradedEvent, validateInteractionEvent, validateInteractionExpiredEvent, validateInteractionReceivedEvent, validateInteractionRequest, validateInteractionSummary, validateMachineClient, validateMachineCredential, validateMachineCredentialBearer, validateMachineEventAckRequest, validateMachineEventAckResponse, validateMachineEventPollResponse, validateMessage, validateMessageListEntry, validateMessageListPage, validateMessageDeliveryTimelineEntry, validateRetainedMessageContent, validateMessageDeliveryHistory, validateInteractionTimelineEntry, validateInteractionTimeline, validateUpdateEmailSenderRequest, validateCustomerEventDeliveryAttempt, validateCustomerEventDeliveryHistory, validateDeliveryHolds, validateMachineClientOperations, validateMachineClientOperationsList, validateRecipientCopyCatalogue, validateMessageNotificationImage, validateMessageDeliveredEvent, validateMessageExpiredEvent, validateMessageFailedEvent, validateMessageProviderAcceptedEvent, validateWhooshBangEvent, validateProblem, validateProject, validateProjectCollection, validateRecipientCopyOverride, validateRecipientCopyOverrideCollection, validateProviderCallbackToken, validateProviderCapabilities, validateProviderCapabilitiesCollection, validateProviderInstallationCollection, validateEmailDomainCollection, validateCreateEmailDomainRequest, validateCreateEmailBindingImportRequest, validateEmailBindingImportJob, validateRegisterMachineCredentialRequest, validateRotateOrganizationCredentialRequest, validateRotateApiCredentialRequest, validateRotateCustomerEndpointRequest, validateSubscriptionActivatedEvent, validateSubscriptionAssertedEvent, validateSubscriptionLink, validateSubscriptionRevokedEvent, validateSubscriptionAssertedRevokedEvent, validateUpdateRecipientCopyOverrideRequest, validateWebhookDeliveryCaseSet, validateWebhookSigningVectorSet, } from "./generated/validators.js";
|
|
19
19
|
export type { Artifact, ContractManifest, FixtureSet, GeneratedArtifact, } from "./generated/contract-manifest.js";
|
|
20
20
|
export type { AgentBindingDegradedData, AgentBindingDegradedEvent, ConfirmInteractionResponse as CustomerEventConfirmInteractionResponse, InteractionExpiredData, InteractionExpiredEvent, InteractionReceivedData, InteractionReceivedEvent, InteractionResponse as CustomerEventInteractionResponse, MessageDeliveredData, MessageDeliveredEvent, MessageExpiredData, MessageExpiredEvent, MessageFailedData, MessageFailedEvent, MessageProviderAcceptedData, MessageProviderAcceptedEvent, WhooshBangEventV1ContractDocument, SelectInteractionResponse as CustomerEventSelectInteractionResponse, SubscriptionActivatedData, SubscriptionActivatedEvent, SubscriptionAssertedEvent, SubscriptionRevokedData, SubscriptionRevokedEvent, SubscriptionAssertedRevokedEvent, InputInteractionResponse as CustomerEventInputInteractionResponse, } from "./generated/whooshbang-event-v1.js";
|
|
21
21
|
export type { WebhookDeliveryCaseSetV1, DeliveryCase as WebhookDeliveryFixtureCase, } from "./generated/webhook-delivery-case-v1.js";
|
|
22
22
|
export type { WebhookSigningVectorSetV1, VerificationCase as WebhookSigningVerificationCase, } from "./generated/webhook-signing-vector-v1.js";
|
|
23
|
-
export type { OrganizationCredential, OrganizationCredentialCollection, OrganizationCredentialId, OrganizationCredentialPrefix, OrganizationCredentialRotation, OrganizationCredentialScope, OrganizationCredentialScopeSet, OrganizationCredentialSecret, OrganizationCredentialSecretReveal, OrganizationMembershipSummary, BillingProjectSlots, AssignBillingProjectSlotsRequest,
|
|
23
|
+
export type { OrganizationCredential, OrganizationCredentialCollection, OrganizationCredentialId, OrganizationCredentialPrefix, OrganizationCredentialRotation, OrganizationCredentialScope, OrganizationCredentialScopeSet, OrganizationCredentialSecret, OrganizationCredentialSecretReveal, OrganizationMembershipSummary, BillingProjectSlots, AssignBillingProjectSlotsRequest, SubscriptionChange, ConfirmSubscriptionChangeRequest, BillingEntitlements, SubscriptionSelection, ProjectAttribution, UpdateProjectAttributionRequest, UpdateAutoTopUpSettingsRequest, AutoTopUpSettings, BillingAccount, BillingCard, CardSetup, CreateCreditPurchaseRequest, CreditPurchase, BillingInvoice, BillingInvoiceCollection, UpdateBillingReceiptEmailRequest, OrganizationProjection, OrganizationRole, ApiCredential, ApiCredentialCollection, ApiCredentialId, ApiCredentialPrefix, ApiCredentialRotation, ApiCredentialScope, ApiCredentialScopeSet, ApiCredentialSecret, ApiCredentialSecretReveal, AssertEmailConsentRequest, BindingSummary, Channel, ClassifiedError, CreateOrganizationCredentialRequest, CreateApiCredentialRequest, ChannelConnection, ChannelConnectionCollection, ChannelConnectionSetup, ChannelConnectionSetupStatus, ChannelConnectionStatus, ConnectionLifecycleOperation, ConnectionProvider, ConnectionProviderCollection, CreateChannelConnectionRequest, AttachNotifierConnectionRequest, NotifierConnectionCollection, NotifierConnectionRoute, ProjectRecipientExperience, RecipientBrandAssetId, RecipientBrandLogoAsset, RecipientBrandLogoUpload, NotificationImage, NotificationImageAsset, NotificationImageAssetId, UpdateProjectRecipientExperienceRequest, EnvironmentRecipientExperience, UpdateEnvironmentRecipientExperienceRequest, RecipientBrand, ReturnDestination, SubscriberChannelSettings, AcknowledgeEmailRemediationRequest, SharedEmailStatus, EmailVerificationSummary, CreateRecipientSessionRequest, CreateRecipientSessionResponse, RecipientSession, RecipientPanelCopyOverrides, RecipientSessionCapability, RecipientSessionCapabilityPrefix, RecipientSessionOperation, RecipientChannelSummary, CreateProviderHandoffRequest, ProviderHandoff, ProviderHandoffCompletionMode, RecipientHandoffCompletion, SetPreferredBindingRequest, PreferredBinding, CreateSubscriberRequest, Subscriber, UpdateSubscriberRequest, SubscriberCollection, SubscriberDataExport, SubscriberDataExportRecord, SubscriberDataExportExcludedControllerData, CloseOrganizationRequest, OrganizationClosureProviderAction, OrganizationClosureResult, DeveloperKey, CreateSubscriberGroupRequest, UpdateSubscriberGroupRequest, SubscriberGroup, SubscriberGroupCollection, SubscriberGroupMembership, SubscriberGroupMembershipCollection, CreateGroupBroadcastRequest, BroadcastAggregate, GroupBroadcast, BroadcastMessageProvenance, ProviderHealthState, ProviderFailure, ProviderInstallationStatus, ProviderInstallationSummary, RotateChannelConnectionCredentialRequest, ConnectionTest, ConnectionTestCollection, ConnectionTestEvidence, UsageBucket, UsageDate, UsageGroupCount, UsageGrouping, UsageReport, ConnectionTestFailureCode, ConnectionTestKind, ConnectionTestStatus, CreateConnectionTestRequest, CustomerApplicationManifest, SharedProviderIdentity, SuggestedBotUsername, UpdateChannelConnectionRequest, CreateCustomerEndpointRequest, CreateMessageRequest, CreateProjectRequest, UpdateProjectRequest, PrivacyMode, DefaultNotifierSummary, CreateSubscriptionLinkRequest, DeliveryAttemptSummary, CustomerEndpoint, CustomerEndpointAttemptCollection, CustomerEndpointAttemptDiagnostic, CustomerEndpointCollection, CustomerEndpointFailure, CustomerEndpointMutationResult, CustomerEndpointSecret, CustomerEndpointStatus, CustomerEndpointVerificationChallenge, CustomerEventType, Environment, IdempotencyKey, Message, MessageListEntry, MessageListPage, MessageDeliveryTimelineEntry, RetainedMessageContent, MessageDeliveryHistory, InteractionTimelineEntry, InteractionTimeline, UpdateEmailSenderRequest, CustomerEventDeliveryAttempt, CustomerEventDeliveryHistory, DeliveryHolds, MachineClientOperations, MachineClientOperationsList, RecipientCopyCatalogue, MessageNotificationImage, MessageState, WhooshBangV1ContractDocument, Problem, ProblemCode, Project, ProjectCollection, ProjectEnvironment, ProviderCapabilitiesCollection, ProviderInstallation, ProviderInstallationCollection, EmailAddress, EmailBindingConsent, EmailBindingImportRow, EmailDeliveryPolicy, EmailDisplayName, EmailDnsRecord, EmailDomain, EmailDomainCapabilities, EmailDomainCapabilityState, EmailDomainCollection, EmailDomainGuide, EmailDomainLifecycle, EmailDomainName, EmailLocalPart, EmailSubjectPolicy, CreateEmailDomainRequest, CreateEmailBindingImportRequest, EmailBindingImportJob, RecipientCopyKey, RecipientCopyOverride, RecipientCopyOverrideCollection, RecipientCopyOverrideValue, RecipientLanguage, TimeZone, RotateOrganizationCredentialRequest, RotateApiCredentialRequest, RotateCustomerEndpointRequest, SubscriptionLink, UpdateRecipientCopyOverrideRequest, } from "./generated/whooshbang-v1.js";
|
|
24
24
|
export type HostedChannelConnectionSetup = NonNullable<import("./generated/whooshbang-v1.js").HostedChannelConnection["authorization_setup"]>;
|
|
25
25
|
export type ChannelConnectionMode = import("./generated/whooshbang-v1.js").ChannelConnection["mode"];
|
|
26
26
|
export type ChannelConnectionProvider = import("./generated/whooshbang-v1.js").ChannelConnection["provider"];
|
package/dist/index.js
CHANGED
|
@@ -8,5 +8,5 @@ export { RECIPIENT_BRAND_DEFAULT_ACCENT_COLOR } from "./recipient-brand.js";
|
|
|
8
8
|
export { normalizeNotificationImage, NOTIFICATION_IMAGE_CONTENT_TYPE, NOTIFICATION_IMAGE_MAX_BYTES, NOTIFICATION_IMAGE_MAX_DIMENSION, NOTIFICATION_IMAGE_MAX_PIXELS, NotificationImageError, } from "./notification-image.js";
|
|
9
9
|
export { canonicalIanaTimeZone } from "./time-zone.js";
|
|
10
10
|
export { CUSTOMIZABLE_RECIPIENT_COPY_KEYS, CUSTOMIZABLE_RECIPIENT_PANEL_COPY_KEYS, isCustomizableRecipientCopyKey, recipientCopyOverrideIssues, recipientCopyOverrideMaximumLength, RECIPIENT_COPY_OVERRIDE_HOSTED_ACTION_MAX_LENGTH, RECIPIENT_COPY_OVERRIDE_MAX_LENGTH, } from "./recipient-copy-policy.js";
|
|
11
|
-
export { contractValidationErrors, validateOrganizationCredential, validateOrganizationCredentialCollection, validateOrganizationCredentialRotation, validateOrganizationCredentialSecretReveal, validateBillingProjectSlots, validateAssignBillingProjectSlotsRequest,
|
|
11
|
+
export { contractValidationErrors, validateOrganizationCredential, validateOrganizationCredentialCollection, validateOrganizationCredentialRotation, validateOrganizationCredentialSecretReveal, validateBillingProjectSlots, validateAssignBillingProjectSlotsRequest, validateSubscriptionChange, validateConfirmSubscriptionChangeRequest, validateBillingEntitlements, validateSubscriptionSelection, validateProjectAttribution, validateUpdateProjectAttributionRequest, validateUpdateAutoTopUpSettingsRequest, validateAutoTopUpSettings, validateBillingAccount, validateBillingCard, validateCardSetup, validateCreateCreditPurchaseRequest, validateCreditPurchase, validateBillingInvoice, validateBillingInvoiceCollection, validateUpdateBillingReceiptEmailRequest, validateOrganizationProjection, validateApiCredential, validateApiCredentialCollection, validateApiCredentialRotation, validateApiCredentialSecretReveal, validateAssertEmailConsentRequest, validateBindingSummary, validateCreateOrganizationCredentialRequest, validateCreateApiCredentialRequest, validateChannelConnection, validateChannelConnectionCollection, validateConnectionProviderCollection, validateCreateChannelConnectionRequest, validateUpdateChannelConnectionRequest, validateRotateChannelConnectionCredentialRequest, validateConnectionTest, validateConnectionTestCollection, validateUsageReport, validateCreateConnectionTestRequest, validateCustomerApplicationManifest, validateAttachNotifierConnectionRequest, validateNotifierConnectionCollection, validateProjectRecipientExperience, validateRecipientBrandLogoUpload, validateNotificationImageAsset, validateUpdateProjectRecipientExperienceRequest, validateEnvironmentRecipientExperience, validateUpdateEnvironmentRecipientExperienceRequest, validateSubscriberChannelSettings, validateAcknowledgeEmailRemediationRequest, validateCreateRecipientSessionRequest, validateCreateRecipientSessionResponse, validateRecipientSession, validateCreateProviderHandoffRequest, validateProviderHandoff, validateRecipientHandoffCompletion, validateSetPreferredBindingRequest, validatePreferredBinding, validateCreateSubscriberRequest, validateSubscriber, validateUpdateSubscriberRequest, validateSubscriberCollection, validateSubscriberDataExport, validateCloseOrganizationRequest, validateOrganizationClosureResult, validateCreateSubscriberGroupRequest, validateUpdateSubscriberGroupRequest, validateSubscriberGroup, validateSubscriberGroupCollection, validateSubscriberGroupMembership, validateSubscriberGroupMembershipCollection, validateCreateGroupBroadcastRequest, validateGroupBroadcast, validateCreateCustomerEndpointRequest, validateCreateProjectRequest, validateUpdateProjectRequest, validateCreateMachineClientRequest, validateCreateMessageRequest, validateCreateSubscriptionLinkRequest, validateDeliveryAttemptSummary, validateCustomerEndpoint, validateCustomerEndpointAttemptCollection, validateCustomerEndpointCollection, validateCustomerEndpointMutationResult, validateCustomerEndpointVerificationChallenge, validateIdempotencyKey, validateAgentBindingDegradedEvent, validateInteractionEvent, validateInteractionExpiredEvent, validateInteractionReceivedEvent, validateInteractionRequest, validateInteractionSummary, validateMachineClient, validateMachineCredential, validateMachineCredentialBearer, validateMachineEventAckRequest, validateMachineEventAckResponse, validateMachineEventPollResponse, validateMessage, validateMessageListEntry, validateMessageListPage, validateMessageDeliveryTimelineEntry, validateRetainedMessageContent, validateMessageDeliveryHistory, validateInteractionTimelineEntry, validateInteractionTimeline, validateUpdateEmailSenderRequest, validateCustomerEventDeliveryAttempt, validateCustomerEventDeliveryHistory, validateDeliveryHolds, validateMachineClientOperations, validateMachineClientOperationsList, validateRecipientCopyCatalogue, validateMessageNotificationImage, validateMessageDeliveredEvent, validateMessageExpiredEvent, validateMessageFailedEvent, validateMessageProviderAcceptedEvent, validateWhooshBangEvent, validateProblem, validateProject, validateProjectCollection, validateRecipientCopyOverride, validateRecipientCopyOverrideCollection, validateProviderCallbackToken, validateProviderCapabilities, validateProviderCapabilitiesCollection, validateProviderInstallationCollection, validateEmailDomainCollection, validateCreateEmailDomainRequest, validateCreateEmailBindingImportRequest, validateEmailBindingImportJob, validateRegisterMachineCredentialRequest, validateRotateOrganizationCredentialRequest, validateRotateApiCredentialRequest, validateRotateCustomerEndpointRequest, validateSubscriptionActivatedEvent, validateSubscriptionAssertedEvent, validateSubscriptionLink, validateSubscriptionRevokedEvent, validateSubscriptionAssertedRevokedEvent, validateUpdateRecipientCopyOverrideRequest, validateWebhookDeliveryCaseSet, validateWebhookSigningVectorSet, } from "./generated/validators.js";
|
|
12
12
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,eAAe,GAChB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,+BAA+B,EAC/B,4BAA4B,GAC7B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,2CAA2C,EAC3C,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,sBAAsB,EACtB,mCAAmC,GACpC,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,8BAA8B,EAC9B,6BAA6B,EAC7B,mCAAmC,EACnC,sBAAsB,EACtB,2BAA2B,GAC5B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,2BAA2B,EAC3B,iCAAiC,EACjC,kCAAkC,EAClC,oCAAoC,EACpC,+BAA+B,EAC/B,uBAAuB,GACxB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,oCAAoC,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EACL,0BAA0B,EAC1B,+BAA+B,EAC/B,4BAA4B,EAC5B,gCAAgC,EAChC,6BAA6B,EAC7B,sBAAsB,GACvB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EACL,gCAAgC,EAChC,sCAAsC,EACtC,8BAA8B,EAC9B,2BAA2B,EAC3B,kCAAkC,EAClC,gDAAgD,EAChD,kCAAkC,GACnC,MAAM,4BAA4B,CAAC;AA+CpC,OAAO,EACL,wBAAwB,EACxB,8BAA8B,EAC9B,wCAAwC,EACxC,sCAAsC,EACtC,0CAA0C,EAC1C,2BAA2B,EAC3B,wCAAwC,EACxC,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,eAAe,GAChB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,+BAA+B,EAC/B,4BAA4B,GAC7B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,2CAA2C,EAC3C,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,sBAAsB,EACtB,mCAAmC,GACpC,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,8BAA8B,EAC9B,6BAA6B,EAC7B,mCAAmC,EACnC,sBAAsB,EACtB,2BAA2B,GAC5B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,2BAA2B,EAC3B,iCAAiC,EACjC,kCAAkC,EAClC,oCAAoC,EACpC,+BAA+B,EAC/B,uBAAuB,GACxB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,oCAAoC,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EACL,0BAA0B,EAC1B,+BAA+B,EAC/B,4BAA4B,EAC5B,gCAAgC,EAChC,6BAA6B,EAC7B,sBAAsB,GACvB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EACL,gCAAgC,EAChC,sCAAsC,EACtC,8BAA8B,EAC9B,2BAA2B,EAC3B,kCAAkC,EAClC,gDAAgD,EAChD,kCAAkC,GACnC,MAAM,4BAA4B,CAAC;AA+CpC,OAAO,EACL,wBAAwB,EACxB,8BAA8B,EAC9B,wCAAwC,EACxC,sCAAsC,EACtC,0CAA0C,EAC1C,2BAA2B,EAC3B,wCAAwC,EACxC,0BAA0B,EAC1B,wCAAwC,EACxC,2BAA2B,EAC3B,6BAA6B,EAC7B,0BAA0B,EAC1B,uCAAuC,EACvC,sCAAsC,EACtC,yBAAyB,EACzB,sBAAsB,EACtB,mBAAmB,EACnB,iBAAiB,EACjB,mCAAmC,EACnC,sBAAsB,EACtB,sBAAsB,EACtB,gCAAgC,EAChC,wCAAwC,EACxC,8BAA8B,EAC9B,qBAAqB,EACrB,+BAA+B,EAC/B,6BAA6B,EAC7B,iCAAiC,EACjC,iCAAiC,EACjC,sBAAsB,EACtB,2CAA2C,EAC3C,kCAAkC,EAClC,yBAAyB,EACzB,mCAAmC,EACnC,oCAAoC,EACpC,sCAAsC,EACtC,sCAAsC,EACtC,gDAAgD,EAChD,sBAAsB,EACtB,gCAAgC,EAChC,mBAAmB,EACnB,mCAAmC,EACnC,mCAAmC,EACnC,uCAAuC,EACvC,oCAAoC,EACpC,kCAAkC,EAClC,gCAAgC,EAChC,8BAA8B,EAC9B,+CAA+C,EAC/C,sCAAsC,EACtC,mDAAmD,EACnD,iCAAiC,EACjC,0CAA0C,EAC1C,qCAAqC,EACrC,sCAAsC,EACtC,wBAAwB,EACxB,oCAAoC,EACpC,uBAAuB,EACvB,kCAAkC,EAClC,kCAAkC,EAClC,wBAAwB,EACxB,+BAA+B,EAC/B,kBAAkB,EAClB,+BAA+B,EAC/B,4BAA4B,EAC5B,4BAA4B,EAC5B,gCAAgC,EAChC,iCAAiC,EACjC,oCAAoC,EACpC,oCAAoC,EACpC,uBAAuB,EACvB,iCAAiC,EACjC,iCAAiC,EACjC,2CAA2C,EAC3C,mCAAmC,EACnC,sBAAsB,EACtB,qCAAqC,EACrC,4BAA4B,EAC5B,4BAA4B,EAC5B,kCAAkC,EAClC,4BAA4B,EAC5B,qCAAqC,EACrC,8BAA8B,EAC9B,wBAAwB,EACxB,yCAAyC,EACzC,kCAAkC,EAClC,sCAAsC,EACtC,6CAA6C,EAC7C,sBAAsB,EACtB,iCAAiC,EACjC,wBAAwB,EACxB,+BAA+B,EAC/B,gCAAgC,EAChC,0BAA0B,EAC1B,0BAA0B,EAC1B,qBAAqB,EACrB,yBAAyB,EACzB,+BAA+B,EAC/B,8BAA8B,EAC9B,+BAA+B,EAC/B,gCAAgC,EAChC,eAAe,EACf,wBAAwB,EACxB,uBAAuB,EACvB,oCAAoC,EACpC,8BAA8B,EAC9B,8BAA8B,EAC9B,gCAAgC,EAChC,2BAA2B,EAC3B,gCAAgC,EAChC,oCAAoC,EACpC,oCAAoC,EACpC,qBAAqB,EACrB,+BAA+B,EAC/B,mCAAmC,EACnC,8BAA8B,EAC9B,gCAAgC,EAChC,6BAA6B,EAC7B,2BAA2B,EAC3B,0BAA0B,EAC1B,oCAAoC,EACpC,uBAAuB,EACvB,eAAe,EACf,eAAe,EACf,yBAAyB,EACzB,6BAA6B,EAC7B,uCAAuC,EACvC,6BAA6B,EAC7B,4BAA4B,EAC5B,sCAAsC,EACtC,sCAAsC,EACtC,6BAA6B,EAC7B,gCAAgC,EAChC,uCAAuC,EACvC,6BAA6B,EAC7B,wCAAwC,EACxC,2CAA2C,EAC3C,kCAAkC,EAClC,qCAAqC,EACrC,kCAAkC,EAClC,iCAAiC,EACjC,wBAAwB,EACxB,gCAAgC,EAChC,wCAAwC,EACxC,0CAA0C,EAC1C,8BAA8B,EAC9B,+BAA+B,GAChC,MAAM,2BAA2B,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"contract_version": "2.0.0-rc.
|
|
2
|
+
"contract_version": "2.0.0-rc.7",
|
|
3
3
|
"fixtures": [
|
|
4
4
|
{
|
|
5
5
|
"id": "create-project.request",
|
|
@@ -1918,29 +1918,6 @@
|
|
|
1918
1918
|
"operation_id": "getBillingAccount",
|
|
1919
1919
|
"status_code": 200
|
|
1920
1920
|
},
|
|
1921
|
-
{
|
|
1922
|
-
"id": "create-wallet-checkout.request",
|
|
1923
|
-
"kind": "request",
|
|
1924
|
-
"path": "fixtures/core-v1/requests/create-wallet-checkout.json",
|
|
1925
|
-
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/CreateWalletCheckoutRequest",
|
|
1926
|
-
"operation_id": "createWalletCheckout"
|
|
1927
|
-
},
|
|
1928
|
-
{
|
|
1929
|
-
"id": "wallet-checkout.success",
|
|
1930
|
-
"kind": "success",
|
|
1931
|
-
"path": "fixtures/core-v1/success/wallet-checkout.json",
|
|
1932
|
-
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/WalletCheckout",
|
|
1933
|
-
"operation_id": "createWalletCheckout",
|
|
1934
|
-
"status_code": 201
|
|
1935
|
-
},
|
|
1936
|
-
{
|
|
1937
|
-
"id": "reconcile-wallet-checkout.success",
|
|
1938
|
-
"kind": "success",
|
|
1939
|
-
"path": "fixtures/core-v1/success/reconcile-wallet-checkout.json",
|
|
1940
|
-
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/ReconcileWalletCheckoutResult",
|
|
1941
|
-
"operation_id": "reconcileWalletCheckout",
|
|
1942
|
-
"status_code": 200
|
|
1943
|
-
},
|
|
1944
1921
|
{
|
|
1945
1922
|
"id": "billing-entitlements.success",
|
|
1946
1923
|
"kind": "success",
|
|
@@ -1949,29 +1926,6 @@
|
|
|
1949
1926
|
"operation_id": "getBillingEntitlements",
|
|
1950
1927
|
"status_code": 200
|
|
1951
1928
|
},
|
|
1952
|
-
{
|
|
1953
|
-
"id": "create-subscription-checkout.request",
|
|
1954
|
-
"kind": "request",
|
|
1955
|
-
"path": "fixtures/core-v1/requests/create-subscription-checkout.json",
|
|
1956
|
-
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/CreateSubscriptionCheckoutRequest",
|
|
1957
|
-
"operation_id": "createSubscriptionCheckout"
|
|
1958
|
-
},
|
|
1959
|
-
{
|
|
1960
|
-
"id": "subscription-checkout.success",
|
|
1961
|
-
"kind": "success",
|
|
1962
|
-
"path": "fixtures/core-v1/success/subscription-checkout.json",
|
|
1963
|
-
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/SubscriptionCheckout",
|
|
1964
|
-
"operation_id": "createSubscriptionCheckout",
|
|
1965
|
-
"status_code": 201
|
|
1966
|
-
},
|
|
1967
|
-
{
|
|
1968
|
-
"id": "reconcile-subscription-checkout.success",
|
|
1969
|
-
"kind": "success",
|
|
1970
|
-
"path": "fixtures/core-v1/success/reconcile-subscription-checkout.json",
|
|
1971
|
-
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/ReconcileSubscriptionCheckoutResult",
|
|
1972
|
-
"operation_id": "reconcileSubscriptionCheckout",
|
|
1973
|
-
"status_code": 200
|
|
1974
|
-
},
|
|
1975
1929
|
{
|
|
1976
1930
|
"id": "project-attribution.success",
|
|
1977
1931
|
"kind": "success",
|
|
@@ -1987,14 +1941,6 @@
|
|
|
1987
1941
|
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/UpdateProjectAttributionRequest",
|
|
1988
1942
|
"operation_id": "updateProjectAttribution"
|
|
1989
1943
|
},
|
|
1990
|
-
{
|
|
1991
|
-
"id": "billing-portal-session.success",
|
|
1992
|
-
"kind": "success",
|
|
1993
|
-
"path": "fixtures/core-v1/success/billing-portal-session.json",
|
|
1994
|
-
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/BillingPortalSession",
|
|
1995
|
-
"operation_id": "createBillingPortalSession",
|
|
1996
|
-
"status_code": 201
|
|
1997
|
-
},
|
|
1998
1944
|
{
|
|
1999
1945
|
"id": "billing-project-slots.success",
|
|
2000
1946
|
"kind": "success",
|
|
@@ -2025,22 +1971,6 @@
|
|
|
2025
1971
|
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/UpdateAutoTopUpSettingsRequest",
|
|
2026
1972
|
"operation_id": "updateAutoTopUpSettings"
|
|
2027
1973
|
},
|
|
2028
|
-
{
|
|
2029
|
-
"id": "auto-top-up-setup.success",
|
|
2030
|
-
"kind": "success",
|
|
2031
|
-
"path": "fixtures/core-v1/success/auto-top-up-setup.json",
|
|
2032
|
-
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/AutoTopUpSetup",
|
|
2033
|
-
"operation_id": "createAutoTopUpSetup",
|
|
2034
|
-
"status_code": 201
|
|
2035
|
-
},
|
|
2036
|
-
{
|
|
2037
|
-
"id": "reconcile-auto-top-up-setup.success",
|
|
2038
|
-
"kind": "success",
|
|
2039
|
-
"path": "fixtures/core-v1/success/reconcile-auto-top-up-setup.json",
|
|
2040
|
-
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/ReconcileAutoTopUpSetupResult",
|
|
2041
|
-
"operation_id": "reconcileAutoTopUpSetup",
|
|
2042
|
-
"status_code": 200
|
|
2043
|
-
},
|
|
2044
1974
|
{
|
|
2045
1975
|
"id": "confirm-subscription-change.request",
|
|
2046
1976
|
"kind": "request",
|
|
@@ -2055,6 +1985,59 @@
|
|
|
2055
1985
|
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/SubscriptionChange",
|
|
2056
1986
|
"operation_id": "createSubscriptionChange",
|
|
2057
1987
|
"status_code": 201
|
|
1988
|
+
},
|
|
1989
|
+
{
|
|
1990
|
+
"id": "create-subscription-change.request",
|
|
1991
|
+
"kind": "request",
|
|
1992
|
+
"path": "fixtures/core-v1/requests/create-subscription-change.json",
|
|
1993
|
+
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/SubscriptionSelection",
|
|
1994
|
+
"operation_id": "createSubscriptionChange"
|
|
1995
|
+
},
|
|
1996
|
+
{
|
|
1997
|
+
"id": "card-setup.success",
|
|
1998
|
+
"kind": "success",
|
|
1999
|
+
"path": "fixtures/core-v1/success/card-setup.json",
|
|
2000
|
+
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/CardSetup",
|
|
2001
|
+
"operation_id": "createCardSetup",
|
|
2002
|
+
"status_code": 201
|
|
2003
|
+
},
|
|
2004
|
+
{
|
|
2005
|
+
"id": "reconcile-card-setup.success",
|
|
2006
|
+
"kind": "success",
|
|
2007
|
+
"path": "fixtures/core-v1/success/reconcile-card-setup.json",
|
|
2008
|
+
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/CardSetup",
|
|
2009
|
+
"operation_id": "reconcileCardSetup",
|
|
2010
|
+
"status_code": 200
|
|
2011
|
+
},
|
|
2012
|
+
{
|
|
2013
|
+
"id": "create-credit-purchase.request",
|
|
2014
|
+
"kind": "request",
|
|
2015
|
+
"path": "fixtures/core-v1/requests/create-credit-purchase.json",
|
|
2016
|
+
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/CreateCreditPurchaseRequest",
|
|
2017
|
+
"operation_id": "createCreditPurchase"
|
|
2018
|
+
},
|
|
2019
|
+
{
|
|
2020
|
+
"id": "credit-purchase.success",
|
|
2021
|
+
"kind": "success",
|
|
2022
|
+
"path": "fixtures/core-v1/success/credit-purchase.json",
|
|
2023
|
+
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/CreditPurchase",
|
|
2024
|
+
"operation_id": "createCreditPurchase",
|
|
2025
|
+
"status_code": 201
|
|
2026
|
+
},
|
|
2027
|
+
{
|
|
2028
|
+
"id": "billing-invoices.success",
|
|
2029
|
+
"kind": "success",
|
|
2030
|
+
"path": "fixtures/core-v1/success/billing-invoices.json",
|
|
2031
|
+
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/BillingInvoiceCollection",
|
|
2032
|
+
"operation_id": "listBillingInvoices",
|
|
2033
|
+
"status_code": 200
|
|
2034
|
+
},
|
|
2035
|
+
{
|
|
2036
|
+
"id": "update-billing-receipt-email.request",
|
|
2037
|
+
"kind": "request",
|
|
2038
|
+
"path": "fixtures/core-v1/requests/update-billing-receipt-email.json",
|
|
2039
|
+
"schema_ref": "schemas/whooshbang-v1.schema.json#/$defs/UpdateBillingReceiptEmailRequest",
|
|
2040
|
+
"operation_id": "updateBillingReceiptEmail"
|
|
2058
2041
|
}
|
|
2059
2042
|
]
|
|
2060
2043
|
}
|