@wix/auto_sdk_subscription_subscriptions 1.0.7 → 1.0.8
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/build/cjs/index.d.ts +379 -1
- package/build/cjs/index.js +5651 -15
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +4678 -1
- package/build/cjs/index.typings.js +4714 -15
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +2373 -1
- package/build/cjs/meta.js +3612 -15
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +379 -0
- package/build/es/index.mjs +5549 -0
- package/build/es/index.mjs.map +1 -0
- package/build/{internal/cjs/src/billing-v1-subscription-subscriptions.universal.d.ts → es/index.typings.d.mts} +790 -1149
- package/build/es/index.typings.mjs +4625 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +2373 -0
- package/build/es/meta.mjs +3557 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/internal/cjs/index.d.ts +403 -1
- package/build/internal/cjs/index.js +5651 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +4702 -1
- package/build/internal/cjs/index.typings.js +4714 -15
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +2373 -1
- package/build/internal/cjs/meta.js +3612 -15
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +403 -0
- package/build/internal/es/index.mjs +5549 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/es/{src/billing-v1-subscription-subscriptions.universal.d.ts → index.typings.d.mts} +793 -1128
- package/build/internal/es/index.typings.mjs +4625 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +2373 -0
- package/build/internal/es/meta.mjs +3557 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +12 -10
- package/build/cjs/src/billing-v1-subscription-subscriptions.context.d.ts +0 -99
- package/build/cjs/src/billing-v1-subscription-subscriptions.context.js +0 -142
- package/build/cjs/src/billing-v1-subscription-subscriptions.context.js.map +0 -1
- package/build/cjs/src/billing-v1-subscription-subscriptions.http.d.ts +0 -134
- package/build/cjs/src/billing-v1-subscription-subscriptions.http.js +0 -3048
- package/build/cjs/src/billing-v1-subscription-subscriptions.http.js.map +0 -1
- package/build/cjs/src/billing-v1-subscription-subscriptions.meta.d.ts +0 -94
- package/build/cjs/src/billing-v1-subscription-subscriptions.meta.js +0 -636
- package/build/cjs/src/billing-v1-subscription-subscriptions.meta.js.map +0 -1
- package/build/cjs/src/billing-v1-subscription-subscriptions.public.d.ts +0 -273
- package/build/cjs/src/billing-v1-subscription-subscriptions.public.js +0 -769
- package/build/cjs/src/billing-v1-subscription-subscriptions.public.js.map +0 -1
- package/build/cjs/src/billing-v1-subscription-subscriptions.types.d.ts +0 -4203
- package/build/cjs/src/billing-v1-subscription-subscriptions.types.js +0 -347
- package/build/cjs/src/billing-v1-subscription-subscriptions.types.js.map +0 -1
- package/build/cjs/src/billing-v1-subscription-subscriptions.universal.d.ts +0 -5013
- package/build/cjs/src/billing-v1-subscription-subscriptions.universal.js +0 -1997
- package/build/cjs/src/billing-v1-subscription-subscriptions.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/billing-v1-subscription-subscriptions.context.d.ts +0 -99
- package/build/es/src/billing-v1-subscription-subscriptions.context.js +0 -101
- package/build/es/src/billing-v1-subscription-subscriptions.context.js.map +0 -1
- package/build/es/src/billing-v1-subscription-subscriptions.http.d.ts +0 -134
- package/build/es/src/billing-v1-subscription-subscriptions.http.js +0 -3013
- package/build/es/src/billing-v1-subscription-subscriptions.http.js.map +0 -1
- package/build/es/src/billing-v1-subscription-subscriptions.meta.d.ts +0 -94
- package/build/es/src/billing-v1-subscription-subscriptions.meta.js +0 -578
- package/build/es/src/billing-v1-subscription-subscriptions.meta.js.map +0 -1
- package/build/es/src/billing-v1-subscription-subscriptions.public.d.ts +0 -273
- package/build/es/src/billing-v1-subscription-subscriptions.public.js +0 -696
- package/build/es/src/billing-v1-subscription-subscriptions.public.js.map +0 -1
- package/build/es/src/billing-v1-subscription-subscriptions.types.d.ts +0 -4203
- package/build/es/src/billing-v1-subscription-subscriptions.types.js +0 -344
- package/build/es/src/billing-v1-subscription-subscriptions.types.js.map +0 -1
- package/build/es/src/billing-v1-subscription-subscriptions.universal.d.ts +0 -5013
- package/build/es/src/billing-v1-subscription-subscriptions.universal.js +0 -1938
- package/build/es/src/billing-v1-subscription-subscriptions.universal.js.map +0 -1
- package/build/internal/cjs/src/billing-v1-subscription-subscriptions.context.d.ts +0 -101
- package/build/internal/cjs/src/billing-v1-subscription-subscriptions.context.js +0 -142
- package/build/internal/cjs/src/billing-v1-subscription-subscriptions.context.js.map +0 -1
- package/build/internal/cjs/src/billing-v1-subscription-subscriptions.http.d.ts +0 -134
- package/build/internal/cjs/src/billing-v1-subscription-subscriptions.http.js +0 -3048
- package/build/internal/cjs/src/billing-v1-subscription-subscriptions.http.js.map +0 -1
- package/build/internal/cjs/src/billing-v1-subscription-subscriptions.meta.d.ts +0 -94
- package/build/internal/cjs/src/billing-v1-subscription-subscriptions.meta.js +0 -636
- package/build/internal/cjs/src/billing-v1-subscription-subscriptions.meta.js.map +0 -1
- package/build/internal/cjs/src/billing-v1-subscription-subscriptions.public.d.ts +0 -293
- package/build/internal/cjs/src/billing-v1-subscription-subscriptions.public.js +0 -769
- package/build/internal/cjs/src/billing-v1-subscription-subscriptions.public.js.map +0 -1
- package/build/internal/cjs/src/billing-v1-subscription-subscriptions.types.d.ts +0 -4203
- package/build/internal/cjs/src/billing-v1-subscription-subscriptions.types.js +0 -347
- package/build/internal/cjs/src/billing-v1-subscription-subscriptions.types.js.map +0 -1
- package/build/internal/cjs/src/billing-v1-subscription-subscriptions.universal.js +0 -1997
- package/build/internal/cjs/src/billing-v1-subscription-subscriptions.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/billing-v1-subscription-subscriptions.context.d.ts +0 -101
- package/build/internal/es/src/billing-v1-subscription-subscriptions.context.js +0 -101
- package/build/internal/es/src/billing-v1-subscription-subscriptions.context.js.map +0 -1
- package/build/internal/es/src/billing-v1-subscription-subscriptions.http.d.ts +0 -134
- package/build/internal/es/src/billing-v1-subscription-subscriptions.http.js +0 -3013
- package/build/internal/es/src/billing-v1-subscription-subscriptions.http.js.map +0 -1
- package/build/internal/es/src/billing-v1-subscription-subscriptions.meta.d.ts +0 -94
- package/build/internal/es/src/billing-v1-subscription-subscriptions.meta.js +0 -578
- package/build/internal/es/src/billing-v1-subscription-subscriptions.meta.js.map +0 -1
- package/build/internal/es/src/billing-v1-subscription-subscriptions.public.d.ts +0 -293
- package/build/internal/es/src/billing-v1-subscription-subscriptions.public.js +0 -696
- package/build/internal/es/src/billing-v1-subscription-subscriptions.public.js.map +0 -1
- package/build/internal/es/src/billing-v1-subscription-subscriptions.types.d.ts +0 -4203
- package/build/internal/es/src/billing-v1-subscription-subscriptions.types.js +0 -344
- package/build/internal/es/src/billing-v1-subscription-subscriptions.types.js.map +0 -1
- package/build/internal/es/src/billing-v1-subscription-subscriptions.universal.js +0 -1938
- package/build/internal/es/src/billing-v1-subscription-subscriptions.universal.js.map +0 -1
package/build/cjs/index.d.ts
CHANGED
|
@@ -1 +1,379 @@
|
|
|
1
|
-
|
|
1
|
+
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
+
import { GetSubscriptionResponse, CustomerCancelSubscriptionOptions, CustomerCancelSubscriptionResponse, CustomerCancelSubscriptionApplicationErrors, CustomerTurnOnSubscriptionAutoRenewalOptions, CustomerTurnOnAutoRenewalResponse, CustomerTurnOnSubscriptionAutoRenewalApplicationErrors, CustomerTurnOffSubscriptionAutoRenewalOptions, CustomerTurnOffAutoRenewalResponse, CustomerTurnOffSubscriptionAutoRenewalApplicationErrors, CustomerExtendSubscriptionOptions, CustomerExtendSubscriptionResponse, CustomerExtendSubscriptionApplicationErrors, CustomerQuerySubscriptionsOptions, QuerySubscriptionsResponse, UpdateSubscriptionPaymentMethodResponse, CustomerAllowedActionsResponse, CustomerListUpcomingChargesResponse, CustomerInitiatePaymentMethodSetupOptions, InitiatePaymentMethodSetupResponse, PayCycleOptions, PayCycleResponse, UpdateSubscriptionBillingDateOptions, UpdateSubscriptionBillingDateResponse, UpdateSubscriptionBillingDateApplicationErrors, ActionContext, CancelSubscriptionResponse, CancelSubscriptionApplicationErrors, PauseSubscriptionOptions, PauseSubscriptionResponse, PauseSubscriptionApplicationErrors, ResumeSubscriptionOptions, ResumeSubscriptionResponse, ResumeSubscriptionApplicationErrors, QueryV2, SearchSubscriptionsOptions, SearchSubscriptionsResponse, CountSubscriptionsOptions, CountSubscriptionsResponse, TurnOnSubscriptionAutoRenewalResponse, TurnOnSubscriptionAutoRenewalApplicationErrors, TurnOffSubscriptionAutoRenewalResponse, TurnOffSubscriptionAutoRenewalApplicationErrors, MarkLatestInvoiceAsPaidResponse, MarkLatestInvoiceAsPaidApplicationErrors, GetSubscriptionsStatsResponse, ExtendSubscriptionOptions, ExtendSubscriptionResponse, ExtendSubscriptionApplicationErrors, AllowedActionsOptions, AllowedActionsResponse, ListUpcomingChargesOptions, ListUpcomingChargesResponse, PreviewSubscriptionChargesOptions, PreviewSubscriptionChargesResponse, PreviewSubscriptionsChargesOptions, PreviewSubscriptionsChargesResponse, InitiatePaymentMethodSetupOptions, ListSubscriptionHistoryOptions, ListSubscriptionHistoryResponse, SubscriptionCanceledEnvelope, SubscriptionExtendedEnvelope, SubscriptionUpdatedEnvelope, SubscriptionAutoRenewalTurnedOffEnvelope, SubscriptionAutoRenewalTurnedOnEnvelope, SubscriptionBillingDateUpdatedEnvelope, SubscriptionLatestInvoiceMarkedAsPaidEnvelope, SubscriptionPauseScheduleCanceledEnvelope, SubscriptionPauseScheduledEnvelope, SubscriptionPausedEnvelope, SubscriptionResumeScheduleCanceledEnvelope, SubscriptionResumeScheduledEnvelope, SubscriptionResumedEnvelope } from './index.typings.js';
|
|
3
|
+
export { Action, ActionDetails, ActionEvent, ActionInitiator, ActionInitiatorWithLiterals, ActionType, ActionTypeWithLiterals, AddPausePeriodRequest, AddPausePeriodResponse, AdditionalFee, AdditionalFeeTrigger, AdditionalFeeTriggerWithLiterals, Address, AddressStreetOneOf, AggregatedTaxBreakdown, AllowedActionsRequest, AmountByStatus, ApplicationFee, ApplicationFeeValueOneOf, AttachInvoice, AutomaticRetryData, BaseEventMetadata, BillingSettings, BillingStatus, BulkItemChange, BulkUpdateSubscriptionItemsByFilterRequest, BulkUpdateSubscriptionItemsByFilterResponse, BusinessOrigin, BusinessOriginData, Cancel, CancelSubscriptionBORequest, CancelSubscriptionBOResponse, CancelSubscriptionRequest, CancelTimeCapsuleTaskRequest, CancellationInfo, CancellationInitiator, CancellationInitiatorWithLiterals, CatalogReference, Charge, CollectionMethod, CollectionMethodEnumCollectionMethod, CollectionMethodEnumCollectionMethodWithLiterals, CollectionMethodWithLiterals, Complete, ConvertSapiRequest, ConvertSapiResponse, CountByStatus, CountSubscriptionFilter, CountSubscriptionFilterStatusOneOf, CountSubscriptionsRequest, CreateRecurringInvoiceBORequest, CreateRecurringInvoiceBOResponse, CreateSubscriptionForOrderRequest, CreateSubscriptionForOrderResponse, CreateSubscriptionInStateRequest, CreateSubscriptionInStateRequestModeOneOf, CreateSubscriptionInStateResponse, CreateSubscriptionRequest, CreateSubscriptionResponse, CreationMode, CreationModeWithLiterals, CursorPaging, Cursors, CustomBillingSchedule, CustomProration, CustomProrationAmountOneOf, Customer, CustomerAllowedActionsRequest, CustomerCancelSubscriptionRequest, CustomerExtendSubscriptionRequest, CustomerIdOneOf, CustomerListUpcomingChargesRequest, CustomerTurnOffAutoRenewalRequest, CustomerTurnOnAutoRenewalRequest, Cycles, DeleteDraftSubscriptionRequest, DeleteDraftSubscriptionResponse, DeleteSubscriptionBORequest, DeleteSubscriptionBOResponse, DeleteSubscriptionRequest, DeleteSubscriptionResponse, DetachInvoice, Discount, DiscountCycles, DiscountOrigin, DiscountValueOneOf, DomainEvent, DomainEventBodyOneOf, Duration, DurationUnit, DurationUnitWithLiterals, DynamicTax, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendPolicyType, ExtendPolicyTypeWithLiterals, ExtendSubscriptionOptionsExtendPolicyOneOf, ExtendSubscriptionRequest, ExtendSubscriptionRequestExtendPolicyOneOf, ExternalCollectionDetails, FinishFreeTrialNowRequest, FinishFreeTrialNowResponse, FixSubscriptionInvoicesRequest, FixSubscriptionInvoicesRequestModeOneOf, FixSubscriptionInvoicesResponse, FixSubscriptionTimeCapsuleTasksRequest, FixSubscriptionTimeCapsuleTasksResponse, FixedPrice, FreeTrailEnded, FreeTrailStarted, FreeTrialData, FullAddressContactDetails, FullAddressDetails, FutureUpdatesRequested, GetFullSubscriptionDataRequest, GetFullSubscriptionDataResponse, GetSubscriptionAndInternalDataRequest, GetSubscriptionAndInternalDataResponse, GetSubscriptionInvoicesRequest, GetSubscriptionInvoicesResponse, GetSubscriptionRequest, GetSubscriptionsStatsRequest, GracePeriodData, GracePeriodEnded, GracePeriodStarted, HandleSubscriptionAfterInvoiceMarkedAsPaidRequest, HistoryActionInitiator, HistoryActionInitiatorWithLiterals, HistoryViewMode, HistoryViewModeWithLiterals, IdentificationData, IdentificationDataIdOneOf, IdentityType, IdentityTypeWithLiterals, InitiatePaymentMethodSetupRequest, InitiatedPaymentMethodSetup, InternalSubscriptionData, Invoice, InvoiceAction, InvoiceActionActionTypeOneOf, InvoiceApplicationFee, InvoiceApplicationFeeValueOneOf, InvoiceDiscount, InvoiceDiscountValueOneOf, InvoiceItem, InvoiceItemPaymentTypeOneOf, InvoiceShippingCharges, InvoiceStatus, InvoiceStatusWithLiterals, Item, ItemCategory, ItemCategoryWithLiterals, ItemChange, ItemTaxData, LatestInvoiceMarkedAsPaid, LatestPaymentAttempt, LineItemTaxSummary, ListSubscriptionHistoryRequest, ListUpcomingChargesRequest, MarkBillingCycleAsPaidApplicationErrors, MarkBillingCycleAsPaidOptions, MarkBillingCycleAsPaidRequest, MarkBillingCycleAsPaidResponse, MarkLatestInvoiceAsPaidRequest, MessageEnvelope, MigrationDetails, Money, MultipleSubscriptionsOnOrdersInvoice, OneTime, OrderMethod, OrderMethodWithLiterals, Origin, OriginOverride, Paging, PagingMetadataV2, PauseAt, PauseAtWithLiterals, PauseInfo, PausePeriod, PausePolicy, PausePolicyWithLiterals, PauseSubscriptionBORequest, PauseSubscriptionBOResponse, PauseSubscriptionRequest, PauseSubscriptionRequested, PayCycleRequest, PayRecurringInvoice, PaymentAttemptStatus, PaymentAttemptStatusWithLiterals, PaymentData, PaymentMethod, PaymentMethodUpdated, PaymentMode, PaymentModeWithLiterals, PaymentOrigin, PaymentSettings, PaymentSettlementMethod, PaymentSettlementMethodWithLiterals, PaymentStatus, PaymentStatusEnumPaymentStatus, PaymentStatusEnumPaymentStatusWithLiterals, PaymentStatusWithLiterals, PaymentTestMode, PaymentTestModeWithLiterals, PlatformOrigin, PreviewSubscriptionChargesOptionsSubscriptionOneOf, PreviewSubscriptionChargesRequest, PreviewSubscriptionChargesRequestSubscriptionOneOf, PreviewSubscriptionsChargesRequest, PriceAdjustment, PriceAdjustmentAdjustmentTypeOneOf, PriceAdjustmentValue, PriceAdjustmentValueAdjustmentValueTypeOneOf, PriceDetails, PricingModel, PricingModelModelOneOf, Proration, ProrationTypeOneOf, QuerySubscriptionsRequest, QueryV2PagingMethodOneOf, Recurring, RedirectUrls, Refund, RefundInfo, RefundReason, RefundReasonWithLiterals, RequestedFields, RequestedFieldsWithLiterals, Reschedule, ResetPendingUpdates, RestoreDraftSubscriptionRequest, RestoreDraftSubscriptionResponse, RestoreInfo, ResumeAt, ResumeAtWithLiterals, ResumeSubscriptionRequest, ResumeSubscriptionRequested, ReviseSubscriptionRequest, ReviseSubscriptionResponse, RevivePolicy, RevivePolicyWithLiterals, ReviveSubscriptionRequest, ReviveSubscriptionResponse, RunTimeCapsuleTaskNowRequest, ScheduleAdditionalInfo, ScheduleAdditionalInfoParamOneOf, ScheduleTimeCapsuleTaskRequest, ScheduledPauseCanceled, ScheduledResumeCanceled, SearchSubscriptionRequest, SearchSubscriptionResponse, SearchSubscriptionsOptionsPagingMethodOneOf, SearchSubscriptionsRequest, SearchSubscriptionsRequestPagingMethodOneOf, SendSubscriptionActionEventBORequest, SendSubscriptionActionEventBORequestEventOneOf, SendSubscriptionActionEventResponse, SendTimeCapsuleTaskCanceledBIRequest, SetIsMigratedEvent, SetShiftingDataRequest, SetShiftingDataResponse, ShippingCharges, SortOrder, SortOrderWithLiterals, Sorting, SortingClauses, SpecificDateSubscriptionUpdateData, Status, StatusWithLiterals, StreetAddress, Subscriber, Subscription, SubscriptionActivated, SubscriptionAutoRenewalTurnedOff, SubscriptionAutoRenewalTurnedOn, SubscriptionBackOfficeAction, SubscriptionBillingCyclePaid, SubscriptionBillingCycleStarted, SubscriptionBillingDateUpdated, SubscriptionBillingDetails, SubscriptionCanceled, SubscriptionCancellationRequested, SubscriptionCharge, SubscriptionCharges, SubscriptionCollectionMethodUpdated, SubscriptionCreated, SubscriptionCycleReadyToPay, SubscriptionCycleTriggered, SubscriptionDelayedSyncEvent, SubscriptionDeleted, SubscriptionDiff, SubscriptionEnded, SubscriptionEvent, SubscriptionEventPayloadOneOf, SubscriptionExpired, SubscriptionExtended, SubscriptionExtendedExtendPolicyOneOf, SubscriptionFrequency, SubscriptionFrequencyWithLiterals, SubscriptionHistoryEntry, SubscriptionInfo, SubscriptionInitialPurchaseCompleted, SubscriptionInvoice, SubscriptionMarkedAsPaid, SubscriptionPaused, SubscriptionPolicies, SubscriptionPolicy, SubscriptionResumed, SubscriptionRevived, SubscriptionStatus, SubscriptionStatusEnumSubscriptionStatus, SubscriptionStatusEnumSubscriptionStatusWithLiterals, SubscriptionStatusGroup, SubscriptionStatusGroupWithLiterals, SubscriptionSuspended, SubscriptionTrialPeriod, SubscriptionType, SubscriptionTypeWithLiterals, SubscriptionUpdateData, SubscriptionUpdated, Suspension, Task, TaskAction, TaskActionActionOneOf, TaskKey, Tax, TaxBreakdown, TaxData, TaxSettings, TaxSummary, TaxValueOneOf, TaxableAddressType, TaxableAddressTypeWithLiterals, TimeBasedProration, Totals, TurnOffSubscriptionAutoRenewalRequest, TurnOnSubscriptionAutoRenewalRequest, UnknownSubscriptionEvent, UnsupportedAction, UnsupportedReason, UpdateAction, UpdateActionWithLiterals, UpdateBillingDateData, UpdateFullSubscriptionRequest, UpdateFullSubscriptionResponse, UpdatePausePaidDurationRequest, UpdatePausePaidDurationResponse, UpdatePaymentMethodBORequest, UpdatePaymentMethodBOResponse, UpdatePaymentStatusRequest, UpdatePaymentStatusResponse, UpdateStatusRequest, UpdateStatusResponse, UpdateSubscriptionBillingDateRequest, UpdateSubscriptionInvoiceCycleRequest, UpdateSubscriptionInvoiceCycleResponse, UpdateSubscriptionItemsRequest, UpdateSubscriptionItemsResponse, UpdateSubscriptionOriginRequest, UpdateSubscriptionOriginResponse, UpdateSubscriptionPaymentMethodRequest, UpdateSubscriptionPoliciesRequest, UpdateSubscriptionPoliciesResponse, UpdateSubscriptionRequest, UpdateSubscriptionResponse, UpdateSubscriptionStartDateRequest, UpdateSubscriptionStartDateResponse, UpdatesApplied, V1Duration, V1Subscription, V1SubscriptionActivated, V1SubscriptionCanceled, V1SubscriptionCreated, V1SubscriptionEvent, V1SubscriptionEventEventOneOf, V1SubscriptionInitialPurchaseCompleted, V1SubscriptionResumed, V1SubscriptionStatusEnumSubscriptionStatus, V1SubscriptionStatusEnumSubscriptionStatusWithLiterals, V1SubscriptionUpdated, V2Subscription, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
|
|
4
|
+
|
|
5
|
+
declare function customerGetSubscription$1(httpClient: HttpClient): CustomerGetSubscriptionSignature;
|
|
6
|
+
interface CustomerGetSubscriptionSignature {
|
|
7
|
+
/**
|
|
8
|
+
* Identity must be a site member and customer subscription belongs to
|
|
9
|
+
*/
|
|
10
|
+
(_id: string): Promise<NonNullablePaths<GetSubscriptionResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8>>;
|
|
11
|
+
}
|
|
12
|
+
declare function customerCancelSubscription$1(httpClient: HttpClient): CustomerCancelSubscriptionSignature;
|
|
13
|
+
interface CustomerCancelSubscriptionSignature {
|
|
14
|
+
/**
|
|
15
|
+
* Identity must be a site member and customer subscription belongs to
|
|
16
|
+
*/
|
|
17
|
+
(_id: string, options?: CustomerCancelSubscriptionOptions): Promise<NonNullablePaths<CustomerCancelSubscriptionResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
|
|
18
|
+
__applicationErrorsType?: CustomerCancelSubscriptionApplicationErrors;
|
|
19
|
+
}>;
|
|
20
|
+
}
|
|
21
|
+
declare function customerTurnOnSubscriptionAutoRenewal$1(httpClient: HttpClient): CustomerTurnOnSubscriptionAutoRenewalSignature;
|
|
22
|
+
interface CustomerTurnOnSubscriptionAutoRenewalSignature {
|
|
23
|
+
/**
|
|
24
|
+
* Identity must be a site member and customer subscription belongs to
|
|
25
|
+
*/
|
|
26
|
+
(_id: string, options?: CustomerTurnOnSubscriptionAutoRenewalOptions): Promise<NonNullablePaths<CustomerTurnOnAutoRenewalResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
|
|
27
|
+
__applicationErrorsType?: CustomerTurnOnSubscriptionAutoRenewalApplicationErrors;
|
|
28
|
+
}>;
|
|
29
|
+
}
|
|
30
|
+
declare function customerTurnOffSubscriptionAutoRenewal$1(httpClient: HttpClient): CustomerTurnOffSubscriptionAutoRenewalSignature;
|
|
31
|
+
interface CustomerTurnOffSubscriptionAutoRenewalSignature {
|
|
32
|
+
/**
|
|
33
|
+
* Identity must be a site member and customer subscription belongs to
|
|
34
|
+
*/
|
|
35
|
+
(_id: string, options?: CustomerTurnOffSubscriptionAutoRenewalOptions): Promise<NonNullablePaths<CustomerTurnOffAutoRenewalResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
|
|
36
|
+
__applicationErrorsType?: CustomerTurnOffSubscriptionAutoRenewalApplicationErrors;
|
|
37
|
+
}>;
|
|
38
|
+
}
|
|
39
|
+
declare function customerExtendSubscription$1(httpClient: HttpClient): CustomerExtendSubscriptionSignature;
|
|
40
|
+
interface CustomerExtendSubscriptionSignature {
|
|
41
|
+
/** @param - The ID of the subscription to be extended */
|
|
42
|
+
(_id: string, options?: NonNullablePaths<CustomerExtendSubscriptionOptions, `billingCyclesToAdd`, 2>): Promise<NonNullablePaths<CustomerExtendSubscriptionResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
|
|
43
|
+
__applicationErrorsType?: CustomerExtendSubscriptionApplicationErrors;
|
|
44
|
+
}>;
|
|
45
|
+
}
|
|
46
|
+
declare function customerQuerySubscriptions$1(httpClient: HttpClient): CustomerQuerySubscriptionsSignature;
|
|
47
|
+
interface CustomerQuerySubscriptionsSignature {
|
|
48
|
+
/**
|
|
49
|
+
* identity must be a site member
|
|
50
|
+
*/
|
|
51
|
+
(options?: CustomerQuerySubscriptionsOptions): Promise<NonNullablePaths<QuerySubscriptionsResponse, `subscriptions` | `subscriptions.${number}.name` | `subscriptions.${number}.customer.visitorId` | `subscriptions.${number}.customer.contactId` | `subscriptions.${number}.customer.memberId` | `subscriptions.${number}.customer.accountId` | `subscriptions.${number}.status` | `subscriptions.${number}.billingSettings.currency` | `subscriptions.${number}.billingSettings.paymentMethod._id` | `subscriptions.${number}.billingSettings.collectionMethod` | `subscriptions.${number}.billingSettings.cycleDuration.unit` | `subscriptions.${number}.billingSettings.cycleAutoRenew` | `subscriptions.${number}.billingSettings.taxSettings.inclusive` | `subscriptions.${number}.billingSettings.shippingCharges.amount` | `subscriptions.${number}.billingSettings.externalCollectionDetails.collectorName` | `subscriptions.${number}.billingStatus.currentCycle` | `subscriptions.${number}.billingStatus.latestPaymentData.invoiceId` | `subscriptions.${number}.billingStatus.latestPaymentData.paymentStatus` | `subscriptions.${number}.policies.customerCanCancel` | `subscriptions.${number}.policies.businessCanExtend` | `subscriptions.${number}.policies.allowEndOfCycleCancellation` | `subscriptions.${number}.pauseInfo.pausePolicy` | `subscriptions.${number}.pauseInfo.pauseAt` | `subscriptions.${number}.pauseInfo.resumeAt` | `subscriptions.${number}.cancellationInfo.initiator` | `subscriptions.${number}.pendingUpdateData.numberOfRequests`, 6>>;
|
|
52
|
+
}
|
|
53
|
+
declare function customerUpdateSubscriptionPaymentMethod$1(httpClient: HttpClient): CustomerUpdateSubscriptionPaymentMethodSignature;
|
|
54
|
+
interface CustomerUpdateSubscriptionPaymentMethodSignature {
|
|
55
|
+
/**
|
|
56
|
+
* Update subscription's payment method.
|
|
57
|
+
* Supported only for recurring subscriptions or one time subscriptions during free trial.
|
|
58
|
+
* @param - Subscription ID
|
|
59
|
+
*/
|
|
60
|
+
(_id: string, paymentMethodId: string): Promise<NonNullablePaths<UpdateSubscriptionPaymentMethodResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8>>;
|
|
61
|
+
}
|
|
62
|
+
declare function customerAllowedActions$1(httpClient: HttpClient): CustomerAllowedActionsSignature;
|
|
63
|
+
interface CustomerAllowedActionsSignature {
|
|
64
|
+
/** */
|
|
65
|
+
(_id: string): Promise<NonNullablePaths<CustomerAllowedActionsResponse, `actions` | `actions.${number}.actionType`, 4>>;
|
|
66
|
+
}
|
|
67
|
+
declare function customerListUpcomingCharges$1(httpClient: HttpClient): CustomerListUpcomingChargesSignature;
|
|
68
|
+
interface CustomerListUpcomingChargesSignature {
|
|
69
|
+
/**
|
|
70
|
+
* List future subscriptions charges.
|
|
71
|
+
* @param - Subscription id upcoming charge to be previewed for
|
|
72
|
+
*/
|
|
73
|
+
(_id: string): Promise<NonNullablePaths<CustomerListUpcomingChargesResponse, `upcomingCharge.cycle` | `upcomingCharge.totals.totalPrice` | `upcomingCharge.totals.subtotal` | `upcomingCharge.invoiceItems` | `upcomingCharge.invoiceItems.${number}.recurring.cycleNumber` | `upcomingCharge.invoiceItems.${number}._id` | `upcomingCharge.invoiceItems.${number}.name` | `upcomingCharge.invoiceItems.${number}.catalogReference.catalogItemId` | `upcomingCharge.invoiceItems.${number}.category` | `upcomingCharge.invoiceItems.${number}.quantity` | `upcomingCharge.invoiceItems.${number}.priceDetails.price` | `upcomingCharge.invoiceItems.${number}.priceDetails.tax.amount` | `upcomingCharge.invoiceItems.${number}.priceDetails.tax.percentage` | `upcomingCharge.invoiceItems.${number}.priceDetails.discount.amount` | `upcomingCharge.invoiceItems.${number}.priceDetails.discount.percentage` | `upcomingCharge.invoiceItems.${number}.priceDetails.applicationFeeDetails.amount` | `upcomingCharge.invoiceItems.${number}.taxData.lineItemTaxSummary.aggregatedTaxAmount` | `upcomingCharge.invoiceItems.${number}.taxData.lineItemTaxSummary.aggregatedTaxRate` | `upcomingCharge.invoiceItems.${number}.taxData.lineItemTaxSummary.taxableAmount`, 7>>;
|
|
74
|
+
}
|
|
75
|
+
declare function customerInitiatePaymentMethodSetup$1(httpClient: HttpClient): CustomerInitiatePaymentMethodSetupSignature;
|
|
76
|
+
interface CustomerInitiatePaymentMethodSetupSignature {
|
|
77
|
+
/**
|
|
78
|
+
* Creates auto-charge order that can be paid by customer
|
|
79
|
+
*/
|
|
80
|
+
(_id: string, options?: CustomerInitiatePaymentMethodSetupOptions): Promise<NonNullablePaths<InitiatePaymentMethodSetupResponse, `paymentOrderId`, 2>>;
|
|
81
|
+
}
|
|
82
|
+
declare function payCycle$1(httpClient: HttpClient): PayCycleSignature;
|
|
83
|
+
interface PayCycleSignature {
|
|
84
|
+
/**
|
|
85
|
+
* This used only for automation and permitted tenants (QA & testing)
|
|
86
|
+
*/
|
|
87
|
+
(subscriptionId: string, options?: NonNullablePaths<PayCycleOptions, `tenantId`, 2>): Promise<NonNullablePaths<PayCycleResponse, `invoiceId` | `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8>>;
|
|
88
|
+
}
|
|
89
|
+
declare function getSubscription$1(httpClient: HttpClient): GetSubscriptionSignature;
|
|
90
|
+
interface GetSubscriptionSignature {
|
|
91
|
+
/**
|
|
92
|
+
* Returns a single subscription by its id
|
|
93
|
+
*/
|
|
94
|
+
(_id: string): Promise<NonNullablePaths<GetSubscriptionResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8>>;
|
|
95
|
+
}
|
|
96
|
+
declare function updateSubscriptionPaymentMethod$1(httpClient: HttpClient): UpdateSubscriptionPaymentMethodSignature;
|
|
97
|
+
interface UpdateSubscriptionPaymentMethodSignature {
|
|
98
|
+
/**
|
|
99
|
+
* Update subscription's payment method.
|
|
100
|
+
* Supported only for recurring subscriptions or one time subscriptions during free trial.
|
|
101
|
+
* @param - Subscription ID
|
|
102
|
+
*/
|
|
103
|
+
(_id: string, paymentMethodId: string): Promise<NonNullablePaths<UpdateSubscriptionPaymentMethodResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8>>;
|
|
104
|
+
}
|
|
105
|
+
declare function updateSubscriptionBillingDate$1(httpClient: HttpClient): UpdateSubscriptionBillingDateSignature;
|
|
106
|
+
interface UpdateSubscriptionBillingDateSignature {
|
|
107
|
+
/**
|
|
108
|
+
* Updates the next billing date for a subscription.
|
|
109
|
+
*
|
|
110
|
+
*
|
|
111
|
+
* Updating the billing date may add a proration charge or credit to the next
|
|
112
|
+
* invoice. The customer must pay more in case you extend the current billing
|
|
113
|
+
* cycle. They pay less in case you shorten the current billing cycle. You can
|
|
114
|
+
* choose whether BASS automatically calculates the proration amount based on
|
|
115
|
+
* the number of days added to or removed from the current billing cycle.
|
|
116
|
+
* Alternatively, you can pass a proration amount based on your own custom
|
|
117
|
+
* calculation. The custom proration amount can't exceed the total of the
|
|
118
|
+
* current billing cycle.
|
|
119
|
+
* @param - ID of the subscription to update the billing date for.
|
|
120
|
+
* @param - New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format.
|
|
121
|
+
*/
|
|
122
|
+
(_id: string, billingDate: Date, options?: UpdateSubscriptionBillingDateOptions): Promise<NonNullablePaths<UpdateSubscriptionBillingDateResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
|
|
123
|
+
__applicationErrorsType?: UpdateSubscriptionBillingDateApplicationErrors;
|
|
124
|
+
}>;
|
|
125
|
+
}
|
|
126
|
+
declare function cancelSubscription$1(httpClient: HttpClient): CancelSubscriptionSignature;
|
|
127
|
+
interface CancelSubscriptionSignature {
|
|
128
|
+
/**
|
|
129
|
+
* Cancels subscription immediately. Can be canceled by member if subscription policy allows it
|
|
130
|
+
* Only PENDING, ACTIVE or PAUSED subscriptions can be canceled
|
|
131
|
+
*/
|
|
132
|
+
(_id: string, actionContext: ActionContext): Promise<NonNullablePaths<CancelSubscriptionResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
|
|
133
|
+
__applicationErrorsType?: CancelSubscriptionApplicationErrors;
|
|
134
|
+
}>;
|
|
135
|
+
}
|
|
136
|
+
declare function pauseSubscription$1(httpClient: HttpClient): PauseSubscriptionSignature;
|
|
137
|
+
interface PauseSubscriptionSignature {
|
|
138
|
+
/**
|
|
139
|
+
* Pauses subscription now or in future. Possible to pause also payments schedule.
|
|
140
|
+
*/
|
|
141
|
+
(_id: string, options?: NonNullablePaths<PauseSubscriptionOptions, `actionContext`, 2>): Promise<NonNullablePaths<PauseSubscriptionResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
|
|
142
|
+
__applicationErrorsType?: PauseSubscriptionApplicationErrors;
|
|
143
|
+
}>;
|
|
144
|
+
}
|
|
145
|
+
declare function resumeSubscription$1(httpClient: HttpClient): ResumeSubscriptionSignature;
|
|
146
|
+
interface ResumeSubscriptionSignature {
|
|
147
|
+
/**
|
|
148
|
+
* Resumes paused subscription now or in future.
|
|
149
|
+
*/
|
|
150
|
+
(_id: string, options?: NonNullablePaths<ResumeSubscriptionOptions, `actionContext`, 2>): Promise<NonNullablePaths<ResumeSubscriptionResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
|
|
151
|
+
__applicationErrorsType?: ResumeSubscriptionApplicationErrors;
|
|
152
|
+
}>;
|
|
153
|
+
}
|
|
154
|
+
declare function querySubscriptions$1(httpClient: HttpClient): QuerySubscriptionsSignature;
|
|
155
|
+
interface QuerySubscriptionsSignature {
|
|
156
|
+
/**
|
|
157
|
+
* Lists subscriptions based on specified filters.
|
|
158
|
+
* By default non-draft subscriptions returned.
|
|
159
|
+
*/
|
|
160
|
+
(query: QueryV2): Promise<NonNullablePaths<QuerySubscriptionsResponse, `subscriptions` | `subscriptions.${number}.name` | `subscriptions.${number}.customer.visitorId` | `subscriptions.${number}.customer.contactId` | `subscriptions.${number}.customer.memberId` | `subscriptions.${number}.customer.accountId` | `subscriptions.${number}.status` | `subscriptions.${number}.billingSettings.currency` | `subscriptions.${number}.billingSettings.paymentMethod._id` | `subscriptions.${number}.billingSettings.collectionMethod` | `subscriptions.${number}.billingSettings.cycleDuration.unit` | `subscriptions.${number}.billingSettings.cycleAutoRenew` | `subscriptions.${number}.billingSettings.taxSettings.inclusive` | `subscriptions.${number}.billingSettings.shippingCharges.amount` | `subscriptions.${number}.billingSettings.externalCollectionDetails.collectorName` | `subscriptions.${number}.billingStatus.currentCycle` | `subscriptions.${number}.billingStatus.latestPaymentData.invoiceId` | `subscriptions.${number}.billingStatus.latestPaymentData.paymentStatus` | `subscriptions.${number}.policies.customerCanCancel` | `subscriptions.${number}.policies.businessCanExtend` | `subscriptions.${number}.policies.allowEndOfCycleCancellation` | `subscriptions.${number}.pauseInfo.pausePolicy` | `subscriptions.${number}.pauseInfo.pauseAt` | `subscriptions.${number}.pauseInfo.resumeAt` | `subscriptions.${number}.cancellationInfo.initiator` | `subscriptions.${number}.pendingUpdateData.numberOfRequests`, 6>>;
|
|
161
|
+
}
|
|
162
|
+
declare function searchSubscriptions$1(httpClient: HttpClient): SearchSubscriptionsSignature;
|
|
163
|
+
interface SearchSubscriptionsSignature {
|
|
164
|
+
/** */
|
|
165
|
+
(options?: SearchSubscriptionsOptions): Promise<NonNullablePaths<SearchSubscriptionsResponse, `subscriptions` | `subscriptions.${number}.name` | `subscriptions.${number}.customer.visitorId` | `subscriptions.${number}.customer.contactId` | `subscriptions.${number}.customer.memberId` | `subscriptions.${number}.customer.accountId` | `subscriptions.${number}.status` | `subscriptions.${number}.billingSettings.currency` | `subscriptions.${number}.billingSettings.paymentMethod._id` | `subscriptions.${number}.billingSettings.collectionMethod` | `subscriptions.${number}.billingSettings.cycleDuration.unit` | `subscriptions.${number}.billingSettings.cycleAutoRenew` | `subscriptions.${number}.billingSettings.taxSettings.inclusive` | `subscriptions.${number}.billingSettings.shippingCharges.amount` | `subscriptions.${number}.billingSettings.externalCollectionDetails.collectorName` | `subscriptions.${number}.billingStatus.currentCycle` | `subscriptions.${number}.billingStatus.latestPaymentData.invoiceId` | `subscriptions.${number}.billingStatus.latestPaymentData.paymentStatus` | `subscriptions.${number}.policies.customerCanCancel` | `subscriptions.${number}.policies.businessCanExtend` | `subscriptions.${number}.policies.allowEndOfCycleCancellation` | `subscriptions.${number}.pauseInfo.pausePolicy` | `subscriptions.${number}.pauseInfo.pauseAt` | `subscriptions.${number}.pauseInfo.resumeAt` | `subscriptions.${number}.cancellationInfo.initiator` | `subscriptions.${number}.pendingUpdateData.numberOfRequests`, 6>>;
|
|
166
|
+
}
|
|
167
|
+
declare function countSubscriptions$1(httpClient: HttpClient): CountSubscriptionsSignature;
|
|
168
|
+
interface CountSubscriptionsSignature {
|
|
169
|
+
/**
|
|
170
|
+
* Counts subscriptions given the provided filters. Returns the total number
|
|
171
|
+
* of subscriptions matching the filters and a count per status.
|
|
172
|
+
*
|
|
173
|
+
*
|
|
174
|
+
* You can either pass a list of statuses or a `statusGroup`, which is a
|
|
175
|
+
* pre-defined combination of statuses.
|
|
176
|
+
*
|
|
177
|
+
* If you don't provide any filters, all subscription statuses with the
|
|
178
|
+
* exception of `"DRAFT"` are counted.
|
|
179
|
+
*
|
|
180
|
+
* You may also specify a `customerId` as filter. Then, only subscriptions for
|
|
181
|
+
* this customer are counted. When providing a `customerId`, you must also
|
|
182
|
+
* specify a `paymentMethodId`.
|
|
183
|
+
*/
|
|
184
|
+
(options?: CountSubscriptionsOptions): Promise<NonNullablePaths<CountSubscriptionsResponse, `countByStatus` | `countByStatus.${number}.status` | `countByStatus.${number}.count` | `total`, 4>>;
|
|
185
|
+
}
|
|
186
|
+
declare function turnOnSubscriptionAutoRenewal$1(httpClient: HttpClient): TurnOnSubscriptionAutoRenewalSignature;
|
|
187
|
+
interface TurnOnSubscriptionAutoRenewalSignature {
|
|
188
|
+
/**
|
|
189
|
+
* Turn on auto-renew subscription in case auto-renew was turned off. The operation changes back cycle_auto_renew
|
|
190
|
+
* to true, which will ensure subscription billing will continue. Also cancellation info holding information about
|
|
191
|
+
* auto renew off will be cleared.
|
|
192
|
+
*/
|
|
193
|
+
(_id: string, actionContext: ActionContext): Promise<NonNullablePaths<TurnOnSubscriptionAutoRenewalResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
|
|
194
|
+
__applicationErrorsType?: TurnOnSubscriptionAutoRenewalApplicationErrors;
|
|
195
|
+
}>;
|
|
196
|
+
}
|
|
197
|
+
declare function turnOffSubscriptionAutoRenewal$1(httpClient: HttpClient): TurnOffSubscriptionAutoRenewalSignature;
|
|
198
|
+
interface TurnOffSubscriptionAutoRenewalSignature {
|
|
199
|
+
/**
|
|
200
|
+
* Turn off auto-renew of subscription. At next billing date subscription will be canceled.
|
|
201
|
+
* Billing settings flag cycle_auto_renew is set to false and information about this operation stored
|
|
202
|
+
* in cancellation info for future usage in cancellation.
|
|
203
|
+
*/
|
|
204
|
+
(_id: string, actionContext: ActionContext): Promise<NonNullablePaths<TurnOffSubscriptionAutoRenewalResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
|
|
205
|
+
__applicationErrorsType?: TurnOffSubscriptionAutoRenewalApplicationErrors;
|
|
206
|
+
}>;
|
|
207
|
+
}
|
|
208
|
+
declare function markLatestInvoiceAsPaid$1(httpClient: HttpClient): MarkLatestInvoiceAsPaidSignature;
|
|
209
|
+
interface MarkLatestInvoiceAsPaidSignature {
|
|
210
|
+
/**
|
|
211
|
+
* Marks the last invoice as paid used for the following scenarios:
|
|
212
|
+
* * Offline subscriptions.
|
|
213
|
+
* * Online subscriptions during grace period. The operation will convert invoice to offline, remove grace period
|
|
214
|
+
* and will send BillingCycleStarted event after invoice closing.
|
|
215
|
+
* * Online one time payment subscription with total price of zero during purchase flow.
|
|
216
|
+
* Activated event will be sent after invoice closing and subscription will be activated.
|
|
217
|
+
* @param - The ID of the offline subscription to mark as paid its latest invoice
|
|
218
|
+
* @deprecated
|
|
219
|
+
*/
|
|
220
|
+
(subscriptionId: string): Promise<NonNullablePaths<MarkLatestInvoiceAsPaidResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
|
|
221
|
+
__applicationErrorsType?: MarkLatestInvoiceAsPaidApplicationErrors;
|
|
222
|
+
}>;
|
|
223
|
+
}
|
|
224
|
+
declare function getSubscriptionsStats$1(httpClient: HttpClient): GetSubscriptionsStatsSignature;
|
|
225
|
+
interface GetSubscriptionsStatsSignature {
|
|
226
|
+
/**
|
|
227
|
+
* Returns number of subscriptions in each state.
|
|
228
|
+
*/
|
|
229
|
+
(): Promise<NonNullablePaths<GetSubscriptionsStatsResponse, `amountByStatuses` | `amountByStatuses.${number}.status` | `amountByStatuses.${number}.amount` | `total`, 4>>;
|
|
230
|
+
}
|
|
231
|
+
declare function extendSubscription$1(httpClient: HttpClient): ExtendSubscriptionSignature;
|
|
232
|
+
interface ExtendSubscriptionSignature {
|
|
233
|
+
/**
|
|
234
|
+
* Extends subscription by moving end date with or without billing cycles addition.
|
|
235
|
+
* @param - The ID of the subscription to be extended
|
|
236
|
+
*/
|
|
237
|
+
(_id: string, actionContext: ActionContext, options: ExtendSubscriptionOptions): Promise<NonNullablePaths<ExtendSubscriptionResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
|
|
238
|
+
__applicationErrorsType?: ExtendSubscriptionApplicationErrors;
|
|
239
|
+
}>;
|
|
240
|
+
}
|
|
241
|
+
declare function allowedActions$1(httpClient: HttpClient): AllowedActionsSignature;
|
|
242
|
+
interface AllowedActionsSignature {
|
|
243
|
+
/** */
|
|
244
|
+
(_id: string, options?: AllowedActionsOptions): Promise<NonNullablePaths<AllowedActionsResponse, `actions` | `actions.${number}.actionType` | `unsupportedActions` | `unsupportedActions.${number}.actionType`, 4>>;
|
|
245
|
+
}
|
|
246
|
+
declare function listUpcomingCharges$1(httpClient: HttpClient): ListUpcomingChargesSignature;
|
|
247
|
+
interface ListUpcomingChargesSignature {
|
|
248
|
+
/**
|
|
249
|
+
* List future subscriptions charges
|
|
250
|
+
* @param - Subscription id charges to be previewed for
|
|
251
|
+
*/
|
|
252
|
+
(subscriptionId: string, options?: ListUpcomingChargesOptions): Promise<NonNullablePaths<ListUpcomingChargesResponse, `upcomingCharges` | `upcomingCharges.${number}.cycle` | `upcomingCharges.${number}.totals.totalPrice` | `upcomingCharges.${number}.totals.subtotal` | `upcomingCharges.${number}.discount.amount` | `upcomingCharges.${number}.discount.percentage` | `upcomingCharges.${number}.discount.origin.appId` | `upcomingCharges.${number}.discount.origin.entityId`, 6>>;
|
|
253
|
+
}
|
|
254
|
+
declare function previewSubscriptionCharges$1(httpClient: HttpClient): PreviewSubscriptionChargesSignature;
|
|
255
|
+
interface PreviewSubscriptionChargesSignature {
|
|
256
|
+
/**
|
|
257
|
+
* Retrieves the preview of subscription charges.
|
|
258
|
+
* Returns all the charges applicable to a subscription based on the provided subscription information.
|
|
259
|
+
* @deprecated
|
|
260
|
+
*/
|
|
261
|
+
(options?: PreviewSubscriptionChargesOptions): Promise<NonNullablePaths<PreviewSubscriptionChargesResponse, `charges` | `charges.${number}.cycleFrom` | `charges.${number}.totals.totalPrice` | `charges.${number}.totals.subtotal`, 5>>;
|
|
262
|
+
}
|
|
263
|
+
declare function previewSubscriptionsCharges$1(httpClient: HttpClient): PreviewSubscriptionsChargesSignature;
|
|
264
|
+
interface PreviewSubscriptionsChargesSignature {
|
|
265
|
+
/**
|
|
266
|
+
* Retrieves the preview of subscription charges for a bulk of subscriptions.
|
|
267
|
+
* Returns all the charges applicable to all subscriptions, based on the provided subscriptions information.
|
|
268
|
+
*/
|
|
269
|
+
(options?: NonNullablePaths<PreviewSubscriptionsChargesOptions, `subscriptionsBillingDetails.${number}.billingSettings` | `subscriptionsBillingDetails.${number}.externalId` | `subscriptionsBillingDetails.${number}.items` | `subscriptionsBillingDetails.${number}.items.${number}.pricingModel`, 6>): Promise<NonNullablePaths<PreviewSubscriptionsChargesResponse, `subscriptionsCharges`, 2>>;
|
|
270
|
+
}
|
|
271
|
+
declare function initiatePaymentMethodSetup$1(httpClient: HttpClient): InitiatePaymentMethodSetupSignature;
|
|
272
|
+
interface InitiatePaymentMethodSetupSignature {
|
|
273
|
+
/**
|
|
274
|
+
* Creates authorization invoice with Moto settings in order to create
|
|
275
|
+
*/
|
|
276
|
+
(_id: string, options?: InitiatePaymentMethodSetupOptions): Promise<NonNullablePaths<InitiatePaymentMethodSetupResponse, `paymentOrderId`, 2>>;
|
|
277
|
+
}
|
|
278
|
+
declare function listSubscriptionHistory$1(httpClient: HttpClient): ListSubscriptionHistorySignature;
|
|
279
|
+
interface ListSubscriptionHistorySignature {
|
|
280
|
+
/** */
|
|
281
|
+
(subscriptionId: string, options?: ListSubscriptionHistoryOptions): Promise<NonNullablePaths<ListSubscriptionHistoryResponse, `historyEntries` | `historyEntries.${number}.entryId` | `historyEntries.${number}.slug` | `historyEntries.${number}.event.deleted.subscriptionId` | `historyEntries.${number}.event.paused.pausePolicy` | `historyEntries.${number}.event.pauseRequested.pauseAt` | `historyEntries.${number}.event.pauseRequested.pausePolicy` | `historyEntries.${number}.event.resumeRequested.resumeAt` | `historyEntries.${number}.event.extended.extensionBillingCycles` | `historyEntries.${number}.event.updatesApplied.updateAction` | `historyEntries.${number}.event.gracePeriodEnded.paymentSettlementMethod` | `historyEntries.${number}.event.paymentMethodUpdated.initiator` | `historyEntries.${number}.event.paymentMethodUpdated.paymentMode` | `historyEntries.${number}.event.collectionMethodUpdated.newCollectionMethod` | `historyEntries.${number}.event.collectionMethodUpdated.previousCollectionMethod` | `historyEntries.${number}.event.billingCyclePaid.paidCycle` | `historyEntries.${number}.event.billingCyclePaid.invoiceId` | `historyEntries.${number}.event.subscriptionBoAction.name` | `historyEntries.${number}.event.subscriptionBoAction.params`, 6>>;
|
|
282
|
+
}
|
|
283
|
+
declare const onSubscriptionCanceled$1: EventDefinition<SubscriptionCanceledEnvelope, "wix.billing.v1.subscription_canceled">;
|
|
284
|
+
declare const onSubscriptionExtended$1: EventDefinition<SubscriptionExtendedEnvelope, "wix.billing.v1.subscription_extended">;
|
|
285
|
+
declare const onSubscriptionUpdated$1: EventDefinition<SubscriptionUpdatedEnvelope, "wix.billing.v1.subscription_updated">;
|
|
286
|
+
declare const onSubscriptionAutoRenewalTurnedOff$1: EventDefinition<SubscriptionAutoRenewalTurnedOffEnvelope, "wix.billing.v1.subscription_auto_renewal_turned_off">;
|
|
287
|
+
declare const onSubscriptionAutoRenewalTurnedOn$1: EventDefinition<SubscriptionAutoRenewalTurnedOnEnvelope, "wix.billing.v1.subscription_auto_renewal_turned_on">;
|
|
288
|
+
declare const onSubscriptionBillingDateUpdated$1: EventDefinition<SubscriptionBillingDateUpdatedEnvelope, "wix.billing.v1.subscription_billing_date_updated">;
|
|
289
|
+
declare const onSubscriptionLatestInvoiceMarkedAsPaid$1: EventDefinition<SubscriptionLatestInvoiceMarkedAsPaidEnvelope, "wix.billing.v1.subscription_latest_invoice_marked_as_paid">;
|
|
290
|
+
declare const onSubscriptionPauseScheduleCanceled$1: EventDefinition<SubscriptionPauseScheduleCanceledEnvelope, "wix.billing.v1.subscription_pause_schedule_canceled">;
|
|
291
|
+
declare const onSubscriptionPauseScheduled$1: EventDefinition<SubscriptionPauseScheduledEnvelope, "wix.billing.v1.subscription_pause_scheduled">;
|
|
292
|
+
declare const onSubscriptionPaused$1: EventDefinition<SubscriptionPausedEnvelope, "wix.billing.v1.subscription_paused">;
|
|
293
|
+
declare const onSubscriptionResumeScheduleCanceled$1: EventDefinition<SubscriptionResumeScheduleCanceledEnvelope, "wix.billing.v1.subscription_resume_schedule_canceled">;
|
|
294
|
+
declare const onSubscriptionResumeScheduled$1: EventDefinition<SubscriptionResumeScheduledEnvelope, "wix.billing.v1.subscription_resume_scheduled">;
|
|
295
|
+
declare const onSubscriptionResumed$1: EventDefinition<SubscriptionResumedEnvelope, "wix.billing.v1.subscription_resumed">;
|
|
296
|
+
|
|
297
|
+
declare const customerGetSubscription: MaybeContext<BuildRESTFunction<typeof customerGetSubscription$1> & typeof customerGetSubscription$1>;
|
|
298
|
+
declare const customerCancelSubscription: MaybeContext<BuildRESTFunction<typeof customerCancelSubscription$1> & typeof customerCancelSubscription$1>;
|
|
299
|
+
declare const customerTurnOnSubscriptionAutoRenewal: MaybeContext<BuildRESTFunction<typeof customerTurnOnSubscriptionAutoRenewal$1> & typeof customerTurnOnSubscriptionAutoRenewal$1>;
|
|
300
|
+
declare const customerTurnOffSubscriptionAutoRenewal: MaybeContext<BuildRESTFunction<typeof customerTurnOffSubscriptionAutoRenewal$1> & typeof customerTurnOffSubscriptionAutoRenewal$1>;
|
|
301
|
+
declare const customerExtendSubscription: MaybeContext<BuildRESTFunction<typeof customerExtendSubscription$1> & typeof customerExtendSubscription$1>;
|
|
302
|
+
declare const customerQuerySubscriptions: MaybeContext<BuildRESTFunction<typeof customerQuerySubscriptions$1> & typeof customerQuerySubscriptions$1>;
|
|
303
|
+
declare const customerUpdateSubscriptionPaymentMethod: MaybeContext<BuildRESTFunction<typeof customerUpdateSubscriptionPaymentMethod$1> & typeof customerUpdateSubscriptionPaymentMethod$1>;
|
|
304
|
+
declare const customerAllowedActions: MaybeContext<BuildRESTFunction<typeof customerAllowedActions$1> & typeof customerAllowedActions$1>;
|
|
305
|
+
declare const customerListUpcomingCharges: MaybeContext<BuildRESTFunction<typeof customerListUpcomingCharges$1> & typeof customerListUpcomingCharges$1>;
|
|
306
|
+
declare const customerInitiatePaymentMethodSetup: MaybeContext<BuildRESTFunction<typeof customerInitiatePaymentMethodSetup$1> & typeof customerInitiatePaymentMethodSetup$1>;
|
|
307
|
+
declare const payCycle: MaybeContext<BuildRESTFunction<typeof payCycle$1> & typeof payCycle$1>;
|
|
308
|
+
declare const getSubscription: MaybeContext<BuildRESTFunction<typeof getSubscription$1> & typeof getSubscription$1>;
|
|
309
|
+
declare const updateSubscriptionPaymentMethod: MaybeContext<BuildRESTFunction<typeof updateSubscriptionPaymentMethod$1> & typeof updateSubscriptionPaymentMethod$1>;
|
|
310
|
+
declare const updateSubscriptionBillingDate: MaybeContext<BuildRESTFunction<typeof updateSubscriptionBillingDate$1> & typeof updateSubscriptionBillingDate$1>;
|
|
311
|
+
declare const cancelSubscription: MaybeContext<BuildRESTFunction<typeof cancelSubscription$1> & typeof cancelSubscription$1>;
|
|
312
|
+
declare const pauseSubscription: MaybeContext<BuildRESTFunction<typeof pauseSubscription$1> & typeof pauseSubscription$1>;
|
|
313
|
+
declare const resumeSubscription: MaybeContext<BuildRESTFunction<typeof resumeSubscription$1> & typeof resumeSubscription$1>;
|
|
314
|
+
declare const querySubscriptions: MaybeContext<BuildRESTFunction<typeof querySubscriptions$1> & typeof querySubscriptions$1>;
|
|
315
|
+
declare const searchSubscriptions: MaybeContext<BuildRESTFunction<typeof searchSubscriptions$1> & typeof searchSubscriptions$1>;
|
|
316
|
+
declare const countSubscriptions: MaybeContext<BuildRESTFunction<typeof countSubscriptions$1> & typeof countSubscriptions$1>;
|
|
317
|
+
declare const turnOnSubscriptionAutoRenewal: MaybeContext<BuildRESTFunction<typeof turnOnSubscriptionAutoRenewal$1> & typeof turnOnSubscriptionAutoRenewal$1>;
|
|
318
|
+
declare const turnOffSubscriptionAutoRenewal: MaybeContext<BuildRESTFunction<typeof turnOffSubscriptionAutoRenewal$1> & typeof turnOffSubscriptionAutoRenewal$1>;
|
|
319
|
+
declare const markLatestInvoiceAsPaid: MaybeContext<BuildRESTFunction<typeof markLatestInvoiceAsPaid$1> & typeof markLatestInvoiceAsPaid$1>;
|
|
320
|
+
declare const getSubscriptionsStats: MaybeContext<BuildRESTFunction<typeof getSubscriptionsStats$1> & typeof getSubscriptionsStats$1>;
|
|
321
|
+
declare const extendSubscription: MaybeContext<BuildRESTFunction<typeof extendSubscription$1> & typeof extendSubscription$1>;
|
|
322
|
+
declare const allowedActions: MaybeContext<BuildRESTFunction<typeof allowedActions$1> & typeof allowedActions$1>;
|
|
323
|
+
declare const listUpcomingCharges: MaybeContext<BuildRESTFunction<typeof listUpcomingCharges$1> & typeof listUpcomingCharges$1>;
|
|
324
|
+
declare const previewSubscriptionCharges: MaybeContext<BuildRESTFunction<typeof previewSubscriptionCharges$1> & typeof previewSubscriptionCharges$1>;
|
|
325
|
+
declare const previewSubscriptionsCharges: MaybeContext<BuildRESTFunction<typeof previewSubscriptionsCharges$1> & typeof previewSubscriptionsCharges$1>;
|
|
326
|
+
declare const initiatePaymentMethodSetup: MaybeContext<BuildRESTFunction<typeof initiatePaymentMethodSetup$1> & typeof initiatePaymentMethodSetup$1>;
|
|
327
|
+
declare const listSubscriptionHistory: MaybeContext<BuildRESTFunction<typeof listSubscriptionHistory$1> & typeof listSubscriptionHistory$1>;
|
|
328
|
+
/**
|
|
329
|
+
* Triggered when a subscription is canceled.
|
|
330
|
+
*/
|
|
331
|
+
declare const onSubscriptionCanceled: BuildEventDefinition<typeof onSubscriptionCanceled$1>;
|
|
332
|
+
/**
|
|
333
|
+
* Triggered when subscription has been extended
|
|
334
|
+
*/
|
|
335
|
+
declare const onSubscriptionExtended: BuildEventDefinition<typeof onSubscriptionExtended$1>;
|
|
336
|
+
/**
|
|
337
|
+
* Triggered when a subscription is updated.
|
|
338
|
+
*/
|
|
339
|
+
declare const onSubscriptionUpdated: BuildEventDefinition<typeof onSubscriptionUpdated$1>;
|
|
340
|
+
/**
|
|
341
|
+
* Triggered when a subscription cycleAutoRenew was turned off.
|
|
342
|
+
*/
|
|
343
|
+
declare const onSubscriptionAutoRenewalTurnedOff: BuildEventDefinition<typeof onSubscriptionAutoRenewalTurnedOff$1>;
|
|
344
|
+
/**
|
|
345
|
+
* Triggered when a subscription cycleAutoRenew was turned on.
|
|
346
|
+
*/
|
|
347
|
+
declare const onSubscriptionAutoRenewalTurnedOn: BuildEventDefinition<typeof onSubscriptionAutoRenewalTurnedOn$1>;
|
|
348
|
+
/**
|
|
349
|
+
* Triggered when subscription has been extended
|
|
350
|
+
*/
|
|
351
|
+
declare const onSubscriptionBillingDateUpdated: BuildEventDefinition<typeof onSubscriptionBillingDateUpdated$1>;
|
|
352
|
+
/** */
|
|
353
|
+
declare const onSubscriptionLatestInvoiceMarkedAsPaid: BuildEventDefinition<typeof onSubscriptionLatestInvoiceMarkedAsPaid$1>;
|
|
354
|
+
/**
|
|
355
|
+
* Triggered when scheduled pause canceled
|
|
356
|
+
*/
|
|
357
|
+
declare const onSubscriptionPauseScheduleCanceled: BuildEventDefinition<typeof onSubscriptionPauseScheduleCanceled$1>;
|
|
358
|
+
/**
|
|
359
|
+
* Triggered when pause subscription requested
|
|
360
|
+
*/
|
|
361
|
+
declare const onSubscriptionPauseScheduled: BuildEventDefinition<typeof onSubscriptionPauseScheduled$1>;
|
|
362
|
+
/**
|
|
363
|
+
* Triggered when a subscription is paused.
|
|
364
|
+
*/
|
|
365
|
+
declare const onSubscriptionPaused: BuildEventDefinition<typeof onSubscriptionPaused$1>;
|
|
366
|
+
/**
|
|
367
|
+
* Triggered when scheduled pause canceled
|
|
368
|
+
*/
|
|
369
|
+
declare const onSubscriptionResumeScheduleCanceled: BuildEventDefinition<typeof onSubscriptionResumeScheduleCanceled$1>;
|
|
370
|
+
/**
|
|
371
|
+
* Triggered when resume subscription requested
|
|
372
|
+
*/
|
|
373
|
+
declare const onSubscriptionResumeScheduled: BuildEventDefinition<typeof onSubscriptionResumeScheduled$1>;
|
|
374
|
+
/**
|
|
375
|
+
* Triggered when a subscription is resumed.
|
|
376
|
+
*/
|
|
377
|
+
declare const onSubscriptionResumed: BuildEventDefinition<typeof onSubscriptionResumed$1>;
|
|
378
|
+
|
|
379
|
+
export { ActionContext, AllowedActionsOptions, AllowedActionsResponse, CancelSubscriptionApplicationErrors, CancelSubscriptionResponse, CountSubscriptionsOptions, CountSubscriptionsResponse, CustomerAllowedActionsResponse, CustomerCancelSubscriptionApplicationErrors, CustomerCancelSubscriptionOptions, CustomerCancelSubscriptionResponse, CustomerExtendSubscriptionApplicationErrors, CustomerExtendSubscriptionOptions, CustomerExtendSubscriptionResponse, CustomerInitiatePaymentMethodSetupOptions, CustomerListUpcomingChargesResponse, CustomerQuerySubscriptionsOptions, CustomerTurnOffAutoRenewalResponse, CustomerTurnOffSubscriptionAutoRenewalApplicationErrors, CustomerTurnOffSubscriptionAutoRenewalOptions, CustomerTurnOnAutoRenewalResponse, CustomerTurnOnSubscriptionAutoRenewalApplicationErrors, CustomerTurnOnSubscriptionAutoRenewalOptions, ExtendSubscriptionApplicationErrors, ExtendSubscriptionOptions, ExtendSubscriptionResponse, GetSubscriptionResponse, GetSubscriptionsStatsResponse, InitiatePaymentMethodSetupOptions, InitiatePaymentMethodSetupResponse, ListSubscriptionHistoryOptions, ListSubscriptionHistoryResponse, ListUpcomingChargesOptions, ListUpcomingChargesResponse, MarkLatestInvoiceAsPaidApplicationErrors, MarkLatestInvoiceAsPaidResponse, PauseSubscriptionApplicationErrors, PauseSubscriptionOptions, PauseSubscriptionResponse, PayCycleOptions, PayCycleResponse, PreviewSubscriptionChargesOptions, PreviewSubscriptionChargesResponse, PreviewSubscriptionsChargesOptions, PreviewSubscriptionsChargesResponse, QuerySubscriptionsResponse, QueryV2, ResumeSubscriptionApplicationErrors, ResumeSubscriptionOptions, ResumeSubscriptionResponse, SearchSubscriptionsOptions, SearchSubscriptionsResponse, SubscriptionAutoRenewalTurnedOffEnvelope, SubscriptionAutoRenewalTurnedOnEnvelope, SubscriptionBillingDateUpdatedEnvelope, SubscriptionCanceledEnvelope, SubscriptionExtendedEnvelope, SubscriptionLatestInvoiceMarkedAsPaidEnvelope, SubscriptionPauseScheduleCanceledEnvelope, SubscriptionPauseScheduledEnvelope, SubscriptionPausedEnvelope, SubscriptionResumeScheduleCanceledEnvelope, SubscriptionResumeScheduledEnvelope, SubscriptionResumedEnvelope, SubscriptionUpdatedEnvelope, TurnOffSubscriptionAutoRenewalApplicationErrors, TurnOffSubscriptionAutoRenewalResponse, TurnOnSubscriptionAutoRenewalApplicationErrors, TurnOnSubscriptionAutoRenewalResponse, UpdateSubscriptionBillingDateApplicationErrors, UpdateSubscriptionBillingDateOptions, UpdateSubscriptionBillingDateResponse, UpdateSubscriptionPaymentMethodResponse, allowedActions, cancelSubscription, countSubscriptions, customerAllowedActions, customerCancelSubscription, customerExtendSubscription, customerGetSubscription, customerInitiatePaymentMethodSetup, customerListUpcomingCharges, customerQuerySubscriptions, customerTurnOffSubscriptionAutoRenewal, customerTurnOnSubscriptionAutoRenewal, customerUpdateSubscriptionPaymentMethod, extendSubscription, getSubscription, getSubscriptionsStats, initiatePaymentMethodSetup, listSubscriptionHistory, listUpcomingCharges, markLatestInvoiceAsPaid, onSubscriptionAutoRenewalTurnedOff, onSubscriptionAutoRenewalTurnedOn, onSubscriptionBillingDateUpdated, onSubscriptionCanceled, onSubscriptionExtended, onSubscriptionLatestInvoiceMarkedAsPaid, onSubscriptionPauseScheduleCanceled, onSubscriptionPauseScheduled, onSubscriptionPaused, onSubscriptionResumeScheduleCanceled, onSubscriptionResumeScheduled, onSubscriptionResumed, onSubscriptionUpdated, pauseSubscription, payCycle, previewSubscriptionCharges, previewSubscriptionsCharges, querySubscriptions, resumeSubscription, searchSubscriptions, turnOffSubscriptionAutoRenewal, turnOnSubscriptionAutoRenewal, updateSubscriptionBillingDate, updateSubscriptionPaymentMethod };
|