@wix/auto_sdk_subscription_subscriptions 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/billing-v1-subscription-subscriptions.context.d.ts +99 -0
  11. package/build/cjs/src/billing-v1-subscription-subscriptions.context.js +141 -0
  12. package/build/cjs/src/billing-v1-subscription-subscriptions.context.js.map +1 -0
  13. package/build/cjs/src/billing-v1-subscription-subscriptions.http.d.ts +134 -0
  14. package/build/cjs/src/billing-v1-subscription-subscriptions.http.js +3048 -0
  15. package/build/cjs/src/billing-v1-subscription-subscriptions.http.js.map +1 -0
  16. package/build/cjs/src/billing-v1-subscription-subscriptions.meta.d.ts +94 -0
  17. package/build/cjs/src/billing-v1-subscription-subscriptions.meta.js +636 -0
  18. package/build/cjs/src/billing-v1-subscription-subscriptions.meta.js.map +1 -0
  19. package/build/cjs/src/billing-v1-subscription-subscriptions.public.d.ts +273 -0
  20. package/build/cjs/src/billing-v1-subscription-subscriptions.public.js +768 -0
  21. package/build/cjs/src/billing-v1-subscription-subscriptions.public.js.map +1 -0
  22. package/build/cjs/src/billing-v1-subscription-subscriptions.types.d.ts +3618 -0
  23. package/build/cjs/src/billing-v1-subscription-subscriptions.types.js +337 -0
  24. package/build/cjs/src/billing-v1-subscription-subscriptions.types.js.map +1 -0
  25. package/build/cjs/src/billing-v1-subscription-subscriptions.universal.d.ts +4355 -0
  26. package/build/cjs/src/billing-v1-subscription-subscriptions.universal.js +1985 -0
  27. package/build/cjs/src/billing-v1-subscription-subscriptions.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/billing-v1-subscription-subscriptions.context.d.ts +99 -0
  39. package/build/es/src/billing-v1-subscription-subscriptions.context.js +101 -0
  40. package/build/es/src/billing-v1-subscription-subscriptions.context.js.map +1 -0
  41. package/build/es/src/billing-v1-subscription-subscriptions.http.d.ts +134 -0
  42. package/build/es/src/billing-v1-subscription-subscriptions.http.js +3013 -0
  43. package/build/es/src/billing-v1-subscription-subscriptions.http.js.map +1 -0
  44. package/build/es/src/billing-v1-subscription-subscriptions.meta.d.ts +94 -0
  45. package/build/es/src/billing-v1-subscription-subscriptions.meta.js +578 -0
  46. package/build/es/src/billing-v1-subscription-subscriptions.meta.js.map +1 -0
  47. package/build/es/src/billing-v1-subscription-subscriptions.public.d.ts +273 -0
  48. package/build/es/src/billing-v1-subscription-subscriptions.public.js +696 -0
  49. package/build/es/src/billing-v1-subscription-subscriptions.public.js.map +1 -0
  50. package/build/es/src/billing-v1-subscription-subscriptions.types.d.ts +3618 -0
  51. package/build/es/src/billing-v1-subscription-subscriptions.types.js +334 -0
  52. package/build/es/src/billing-v1-subscription-subscriptions.types.js.map +1 -0
  53. package/build/es/src/billing-v1-subscription-subscriptions.universal.d.ts +4355 -0
  54. package/build/es/src/billing-v1-subscription-subscriptions.universal.js +1926 -0
  55. package/build/es/src/billing-v1-subscription-subscriptions.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.context.d.ts +101 -0
  66. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.context.js +141 -0
  67. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.context.js.map +1 -0
  68. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.http.d.ts +134 -0
  69. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.http.js +3048 -0
  70. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.http.js.map +1 -0
  71. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.meta.d.ts +94 -0
  72. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.meta.js +636 -0
  73. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.meta.js.map +1 -0
  74. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.public.d.ts +293 -0
  75. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.public.js +768 -0
  76. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.public.js.map +1 -0
  77. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.types.d.ts +3618 -0
  78. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.types.js +337 -0
  79. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.types.js.map +1 -0
  80. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.universal.d.ts +4379 -0
  81. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.universal.js +1985 -0
  82. package/build/internal/cjs/src/billing-v1-subscription-subscriptions.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/billing-v1-subscription-subscriptions.context.d.ts +101 -0
  93. package/build/internal/es/src/billing-v1-subscription-subscriptions.context.js +101 -0
  94. package/build/internal/es/src/billing-v1-subscription-subscriptions.context.js.map +1 -0
  95. package/build/internal/es/src/billing-v1-subscription-subscriptions.http.d.ts +134 -0
  96. package/build/internal/es/src/billing-v1-subscription-subscriptions.http.js +3013 -0
  97. package/build/internal/es/src/billing-v1-subscription-subscriptions.http.js.map +1 -0
  98. package/build/internal/es/src/billing-v1-subscription-subscriptions.meta.d.ts +94 -0
  99. package/build/internal/es/src/billing-v1-subscription-subscriptions.meta.js +578 -0
  100. package/build/internal/es/src/billing-v1-subscription-subscriptions.meta.js.map +1 -0
  101. package/build/internal/es/src/billing-v1-subscription-subscriptions.public.d.ts +293 -0
  102. package/build/internal/es/src/billing-v1-subscription-subscriptions.public.js +696 -0
  103. package/build/internal/es/src/billing-v1-subscription-subscriptions.public.js.map +1 -0
  104. package/build/internal/es/src/billing-v1-subscription-subscriptions.types.d.ts +3618 -0
  105. package/build/internal/es/src/billing-v1-subscription-subscriptions.types.js +334 -0
  106. package/build/internal/es/src/billing-v1-subscription-subscriptions.types.js.map +1 -0
  107. package/build/internal/es/src/billing-v1-subscription-subscriptions.universal.d.ts +4379 -0
  108. package/build/internal/es/src/billing-v1-subscription-subscriptions.universal.js +1926 -0
  109. package/build/internal/es/src/billing-v1-subscription-subscriptions.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,273 @@
1
+ import { EventDefinition, HttpClient } from '@wix/sdk-types';
2
+ import { ActionContext, AllowedActionsOptions, AllowedActionsResponse, AllowedActionsResponseNonNullableFields, CancelSubscriptionResponse, CancelSubscriptionResponseNonNullableFields, CountSubscriptionsOptions, CountSubscriptionsResponse, CountSubscriptionsResponseNonNullableFields, CustomerAllowedActionsResponse, CustomerAllowedActionsResponseNonNullableFields, CustomerCancelSubscriptionOptions, CustomerCancelSubscriptionResponse, CustomerCancelSubscriptionResponseNonNullableFields, CustomerExtendSubscriptionOptions, CustomerExtendSubscriptionResponse, CustomerExtendSubscriptionResponseNonNullableFields, CustomerInitiatePaymentMethodSetupOptions, CustomerListUpcomingChargesResponse, CustomerListUpcomingChargesResponseNonNullableFields, CustomerQuerySubscriptionsOptions, CustomerTurnOffAutoRenewalResponse, CustomerTurnOffAutoRenewalResponseNonNullableFields, CustomerTurnOffSubscriptionAutoRenewalOptions, CustomerTurnOnAutoRenewalResponse, CustomerTurnOnAutoRenewalResponseNonNullableFields, CustomerTurnOnSubscriptionAutoRenewalOptions, ExtendSubscriptionOptions, ExtendSubscriptionResponse, ExtendSubscriptionResponseNonNullableFields, GetSubscriptionResponse, GetSubscriptionResponseNonNullableFields, GetSubscriptionsStatsResponse, GetSubscriptionsStatsResponseNonNullableFields, InitiatePaymentMethodSetupOptions, InitiatePaymentMethodSetupResponse, InitiatePaymentMethodSetupResponseNonNullableFields, ListSubscriptionHistoryOptions, ListSubscriptionHistoryResponse, ListSubscriptionHistoryResponseNonNullableFields, ListUpcomingChargesOptions, ListUpcomingChargesResponse, ListUpcomingChargesResponseNonNullableFields, MarkLatestInvoiceAsPaidResponse, MarkLatestInvoiceAsPaidResponseNonNullableFields, PauseSubscriptionOptions, PauseSubscriptionResponse, PauseSubscriptionResponseNonNullableFields, PayCycleOptions, PayCycleResponse, PayCycleResponseNonNullableFields, PreviewSubscriptionChargesOptions, PreviewSubscriptionChargesResponse, PreviewSubscriptionChargesResponseNonNullableFields, PreviewSubscriptionsChargesOptions, PreviewSubscriptionsChargesResponse, PreviewSubscriptionsChargesResponseNonNullableFields, QuerySubscriptionsResponse, QuerySubscriptionsResponseNonNullableFields, QueryV2, ResumeSubscriptionOptions, ResumeSubscriptionResponse, ResumeSubscriptionResponseNonNullableFields, SearchSubscriptionsOptions, SearchSubscriptionsResponse, SearchSubscriptionsResponseNonNullableFields, SubscriptionAutoRenewalTurnedOffEnvelope, SubscriptionAutoRenewalTurnedOnEnvelope, SubscriptionBillingDateUpdatedEnvelope, SubscriptionCanceledEnvelope, SubscriptionExtendedEnvelope, SubscriptionLatestInvoiceMarkedAsPaidEnvelope, SubscriptionPauseScheduleCanceledEnvelope, SubscriptionPauseScheduledEnvelope, SubscriptionPausedEnvelope, SubscriptionResumeScheduleCanceledEnvelope, SubscriptionResumeScheduledEnvelope, SubscriptionResumedEnvelope, SubscriptionUpdatedEnvelope, TurnOffSubscriptionAutoRenewalResponse, TurnOffSubscriptionAutoRenewalResponseNonNullableFields, TurnOnSubscriptionAutoRenewalResponse, TurnOnSubscriptionAutoRenewalResponseNonNullableFields, UpdateSubscriptionBillingDateOptions, UpdateSubscriptionBillingDateResponse, UpdateSubscriptionBillingDateResponseNonNullableFields, UpdateSubscriptionPaymentMethodResponse, UpdateSubscriptionPaymentMethodResponseNonNullableFields } from './billing-v1-subscription-subscriptions.universal.js';
3
+ export declare const __metadata: {
4
+ PACKAGE_NAME: string;
5
+ };
6
+ export declare function listSubscriptionHistory(httpClient: HttpClient): ListSubscriptionHistorySignature;
7
+ interface ListSubscriptionHistorySignature {
8
+ /** */
9
+ (subscriptionId: string, options?: ListSubscriptionHistoryOptions | undefined): Promise<ListSubscriptionHistoryResponse & ListSubscriptionHistoryResponseNonNullableFields>;
10
+ }
11
+ export declare function customerGetSubscription(httpClient: HttpClient): CustomerGetSubscriptionSignature;
12
+ interface CustomerGetSubscriptionSignature {
13
+ /**
14
+ * Identity must be a site member and customer subscription belongs to
15
+ */
16
+ (_id: string): Promise<GetSubscriptionResponse & GetSubscriptionResponseNonNullableFields>;
17
+ }
18
+ export declare function customerCancelSubscription(httpClient: HttpClient): CustomerCancelSubscriptionSignature;
19
+ interface CustomerCancelSubscriptionSignature {
20
+ /**
21
+ * Identity must be a site member and customer subscription belongs to
22
+ */
23
+ (_id: string, options?: CustomerCancelSubscriptionOptions | undefined): Promise<CustomerCancelSubscriptionResponse & CustomerCancelSubscriptionResponseNonNullableFields>;
24
+ }
25
+ export declare function customerTurnOnSubscriptionAutoRenewal(httpClient: HttpClient): CustomerTurnOnSubscriptionAutoRenewalSignature;
26
+ interface CustomerTurnOnSubscriptionAutoRenewalSignature {
27
+ /**
28
+ * Identity must be a site member and customer subscription belongs to
29
+ */
30
+ (_id: string, options?: CustomerTurnOnSubscriptionAutoRenewalOptions | undefined): Promise<CustomerTurnOnAutoRenewalResponse & CustomerTurnOnAutoRenewalResponseNonNullableFields>;
31
+ }
32
+ export declare function customerTurnOffSubscriptionAutoRenewal(httpClient: HttpClient): CustomerTurnOffSubscriptionAutoRenewalSignature;
33
+ interface CustomerTurnOffSubscriptionAutoRenewalSignature {
34
+ /**
35
+ * Identity must be a site member and customer subscription belongs to
36
+ */
37
+ (_id: string, options?: CustomerTurnOffSubscriptionAutoRenewalOptions | undefined): Promise<CustomerTurnOffAutoRenewalResponse & CustomerTurnOffAutoRenewalResponseNonNullableFields>;
38
+ }
39
+ export declare function customerExtendSubscription(httpClient: HttpClient): CustomerExtendSubscriptionSignature;
40
+ interface CustomerExtendSubscriptionSignature {
41
+ /** @param - The ID of the subscription to be extended */
42
+ (_id: string, options?: CustomerExtendSubscriptionOptions | undefined): Promise<CustomerExtendSubscriptionResponse & CustomerExtendSubscriptionResponseNonNullableFields>;
43
+ }
44
+ export declare function customerQuerySubscriptions(httpClient: HttpClient): CustomerQuerySubscriptionsSignature;
45
+ interface CustomerQuerySubscriptionsSignature {
46
+ /**
47
+ * identity must be a site member
48
+ */
49
+ (options?: CustomerQuerySubscriptionsOptions | undefined): Promise<QuerySubscriptionsResponse & QuerySubscriptionsResponseNonNullableFields>;
50
+ }
51
+ export declare function customerUpdateSubscriptionPaymentMethod(httpClient: HttpClient): CustomerUpdateSubscriptionPaymentMethodSignature;
52
+ interface CustomerUpdateSubscriptionPaymentMethodSignature {
53
+ /**
54
+ * Update subscription's payment method.
55
+ * Supported only for recurring subscriptions or one time subscriptions during free trial.
56
+ * @param - Subscription ID
57
+ */
58
+ (_id: string, paymentMethodId: string): Promise<UpdateSubscriptionPaymentMethodResponse & UpdateSubscriptionPaymentMethodResponseNonNullableFields>;
59
+ }
60
+ export declare function customerAllowedActions(httpClient: HttpClient): CustomerAllowedActionsSignature;
61
+ interface CustomerAllowedActionsSignature {
62
+ /** */
63
+ (_id: string): Promise<CustomerAllowedActionsResponse & CustomerAllowedActionsResponseNonNullableFields>;
64
+ }
65
+ export declare function customerListUpcomingCharges(httpClient: HttpClient): CustomerListUpcomingChargesSignature;
66
+ interface CustomerListUpcomingChargesSignature {
67
+ /**
68
+ * List future subscriptions charges.
69
+ * @param - Subscription id upcoming charge to be previewed for
70
+ */
71
+ (_id: string): Promise<CustomerListUpcomingChargesResponse & CustomerListUpcomingChargesResponseNonNullableFields>;
72
+ }
73
+ export declare function customerInitiatePaymentMethodSetup(httpClient: HttpClient): CustomerInitiatePaymentMethodSetupSignature;
74
+ interface CustomerInitiatePaymentMethodSetupSignature {
75
+ /**
76
+ * Creates auto-charge order that can be paid by customer
77
+ */
78
+ (_id: string, options?: CustomerInitiatePaymentMethodSetupOptions | undefined): Promise<InitiatePaymentMethodSetupResponse & InitiatePaymentMethodSetupResponseNonNullableFields>;
79
+ }
80
+ export declare function getSubscription(httpClient: HttpClient): GetSubscriptionSignature;
81
+ interface GetSubscriptionSignature {
82
+ /**
83
+ * Returns a single subscription by its id
84
+ */
85
+ (_id: string): Promise<GetSubscriptionResponse & GetSubscriptionResponseNonNullableFields>;
86
+ }
87
+ export declare function updateSubscriptionPaymentMethod(httpClient: HttpClient): UpdateSubscriptionPaymentMethodSignature;
88
+ interface UpdateSubscriptionPaymentMethodSignature {
89
+ /**
90
+ * Update subscription's payment method.
91
+ * Supported only for recurring subscriptions or one time subscriptions during free trial.
92
+ * @param - Subscription ID
93
+ */
94
+ (_id: string, paymentMethodId: string): Promise<UpdateSubscriptionPaymentMethodResponse & UpdateSubscriptionPaymentMethodResponseNonNullableFields>;
95
+ }
96
+ export declare function updateSubscriptionBillingDate(httpClient: HttpClient): UpdateSubscriptionBillingDateSignature;
97
+ interface UpdateSubscriptionBillingDateSignature {
98
+ /**
99
+ * Updates the next billing date for a subscription.
100
+ *
101
+ *
102
+ * Updating the billing date may add a proration charge or credit to the next
103
+ * invoice. The customer must pay more in case you extend the current billing
104
+ * cycle. They pay less in case you shorten the current billing cycle. You can
105
+ * choose whether BASS automatically calculates the proration amount based on
106
+ * the number of days added to or removed from the current billing cycle.
107
+ * Alternatively, you can pass a proration amount based on your own custom
108
+ * calculation. The custom proration amount can't exceed the total of the
109
+ * current billing cycle.
110
+ * @param - ID of the subscription to update the billing date for.
111
+ * @param - New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format.
112
+ */
113
+ (_id: string, billingDate: Date | null, options?: UpdateSubscriptionBillingDateOptions | undefined): Promise<UpdateSubscriptionBillingDateResponse & UpdateSubscriptionBillingDateResponseNonNullableFields>;
114
+ }
115
+ export declare function cancelSubscription(httpClient: HttpClient): CancelSubscriptionSignature;
116
+ interface CancelSubscriptionSignature {
117
+ /**
118
+ * Cancels subscription immediately. Can be canceled by member if subscription policy allows it
119
+ * Only PENDING, ACTIVE or PAUSED subscriptions can be canceled
120
+ */
121
+ (_id: string, actionContext: ActionContext): Promise<CancelSubscriptionResponse & CancelSubscriptionResponseNonNullableFields>;
122
+ }
123
+ export declare function pauseSubscription(httpClient: HttpClient): PauseSubscriptionSignature;
124
+ interface PauseSubscriptionSignature {
125
+ /**
126
+ * Pauses subscription now or in future. Possible to pause also payments schedule.
127
+ */
128
+ (_id: string, options?: PauseSubscriptionOptions | undefined): Promise<PauseSubscriptionResponse & PauseSubscriptionResponseNonNullableFields>;
129
+ }
130
+ export declare function resumeSubscription(httpClient: HttpClient): ResumeSubscriptionSignature;
131
+ interface ResumeSubscriptionSignature {
132
+ /**
133
+ * Resumes paused subscription now or in future.
134
+ */
135
+ (_id: string, options?: ResumeSubscriptionOptions | undefined): Promise<ResumeSubscriptionResponse & ResumeSubscriptionResponseNonNullableFields>;
136
+ }
137
+ export declare function querySubscriptions(httpClient: HttpClient): QuerySubscriptionsSignature;
138
+ interface QuerySubscriptionsSignature {
139
+ /**
140
+ * Lists subscriptions based on specified filters.
141
+ * By default non-draft subscriptions returned.
142
+ */
143
+ (query: QueryV2): Promise<QuerySubscriptionsResponse & QuerySubscriptionsResponseNonNullableFields>;
144
+ }
145
+ export declare function searchSubscriptions(httpClient: HttpClient): SearchSubscriptionsSignature;
146
+ interface SearchSubscriptionsSignature {
147
+ /** */
148
+ (options?: SearchSubscriptionsOptions | undefined): Promise<SearchSubscriptionsResponse & SearchSubscriptionsResponseNonNullableFields>;
149
+ }
150
+ export declare function countSubscriptions(httpClient: HttpClient): CountSubscriptionsSignature;
151
+ interface CountSubscriptionsSignature {
152
+ /**
153
+ * Counts subscriptions given the provided filters. Returns the total number
154
+ * of subscriptions matching the filters and a count per status.
155
+ *
156
+ *
157
+ * You can either pass a list of statuses or a `statusGroup`, which is a
158
+ * pre-defined combination of statuses.
159
+ *
160
+ * If you don't provide any filters, all subscription statuses with the
161
+ * exception of `"DRAFT"` are counted.
162
+ *
163
+ * You may also specify a `customerId` as filter. Then, only subscriptions for
164
+ * this customer are counted. When providing a `customerId`, you must also
165
+ * specify a `paymentMethodId`.
166
+ */
167
+ (options?: CountSubscriptionsOptions | undefined): Promise<CountSubscriptionsResponse & CountSubscriptionsResponseNonNullableFields>;
168
+ }
169
+ export declare function turnOnSubscriptionAutoRenewal(httpClient: HttpClient): TurnOnSubscriptionAutoRenewalSignature;
170
+ interface TurnOnSubscriptionAutoRenewalSignature {
171
+ /**
172
+ * Turn on auto-renew subscription in case auto-renew was turned off. The operation changes back cycle_auto_renew
173
+ * to true, which will ensure subscription billing will continue. Also cancellation info holding information about
174
+ * auto renew off will be cleared.
175
+ */
176
+ (_id: string, actionContext: ActionContext): Promise<TurnOnSubscriptionAutoRenewalResponse & TurnOnSubscriptionAutoRenewalResponseNonNullableFields>;
177
+ }
178
+ export declare function turnOffSubscriptionAutoRenewal(httpClient: HttpClient): TurnOffSubscriptionAutoRenewalSignature;
179
+ interface TurnOffSubscriptionAutoRenewalSignature {
180
+ /**
181
+ * Turn off auto-renew of subscription. At next billing date subscription will be canceled.
182
+ * Billing settings flag cycle_auto_renew is set to false and information about this operation stored
183
+ * in cancellation info for future usage in cancellation.
184
+ */
185
+ (_id: string, actionContext: ActionContext): Promise<TurnOffSubscriptionAutoRenewalResponse & TurnOffSubscriptionAutoRenewalResponseNonNullableFields>;
186
+ }
187
+ export declare function markLatestInvoiceAsPaid(httpClient: HttpClient): MarkLatestInvoiceAsPaidSignature;
188
+ interface MarkLatestInvoiceAsPaidSignature {
189
+ /**
190
+ * Marks the last invoice as paid used for the following scenarios:
191
+ * * Offline subscriptions.
192
+ * * Online subscriptions during grace period. The operation will convert invoice to offline, remove grace period
193
+ * and will send BillingCycleStarted event after invoice closing.
194
+ * * Online one time payment subscription with total price of zero during purchase flow.
195
+ * Activated event will be sent after invoice closing and subscription will be activated.
196
+ * @param - The ID of the offline subscription to mark as paid its latest invoice
197
+ * @deprecated
198
+ */
199
+ (subscriptionId: string): Promise<MarkLatestInvoiceAsPaidResponse & MarkLatestInvoiceAsPaidResponseNonNullableFields>;
200
+ }
201
+ export declare function getSubscriptionsStats(httpClient: HttpClient): GetSubscriptionsStatsSignature;
202
+ interface GetSubscriptionsStatsSignature {
203
+ /**
204
+ * Returns number of subscriptions in each state.
205
+ */
206
+ (): Promise<GetSubscriptionsStatsResponse & GetSubscriptionsStatsResponseNonNullableFields>;
207
+ }
208
+ export declare function extendSubscription(httpClient: HttpClient): ExtendSubscriptionSignature;
209
+ interface ExtendSubscriptionSignature {
210
+ /**
211
+ * Extends subscription by moving end date with or without billing cycles addition.
212
+ * @param - The ID of the subscription to be extended
213
+ */
214
+ (_id: string, actionContext: ActionContext, options?: ExtendSubscriptionOptions | undefined): Promise<ExtendSubscriptionResponse & ExtendSubscriptionResponseNonNullableFields>;
215
+ }
216
+ export declare function allowedActions(httpClient: HttpClient): AllowedActionsSignature;
217
+ interface AllowedActionsSignature {
218
+ /** */
219
+ (_id: string, options?: AllowedActionsOptions | undefined): Promise<AllowedActionsResponse & AllowedActionsResponseNonNullableFields>;
220
+ }
221
+ export declare function listUpcomingCharges(httpClient: HttpClient): ListUpcomingChargesSignature;
222
+ interface ListUpcomingChargesSignature {
223
+ /**
224
+ * List future subscriptions charges
225
+ * @param - Subscription id charges to be previewed for
226
+ */
227
+ (subscriptionId: string, options?: ListUpcomingChargesOptions | undefined): Promise<ListUpcomingChargesResponse & ListUpcomingChargesResponseNonNullableFields>;
228
+ }
229
+ export declare function previewSubscriptionCharges(httpClient: HttpClient): PreviewSubscriptionChargesSignature;
230
+ interface PreviewSubscriptionChargesSignature {
231
+ /**
232
+ * Retrieves the preview of subscription charges.
233
+ * Returns all the charges applicable to a subscription based on the provided subscription information.
234
+ * @deprecated
235
+ */
236
+ (options: PreviewSubscriptionChargesOptions): Promise<PreviewSubscriptionChargesResponse & PreviewSubscriptionChargesResponseNonNullableFields>;
237
+ }
238
+ export declare function previewSubscriptionsCharges(httpClient: HttpClient): PreviewSubscriptionsChargesSignature;
239
+ interface PreviewSubscriptionsChargesSignature {
240
+ /**
241
+ * Retrieves the preview of subscription charges for a bulk of subscriptions.
242
+ * Returns all the charges applicable to all subscriptions, based on the provided subscriptions information.
243
+ */
244
+ (options?: PreviewSubscriptionsChargesOptions | undefined): Promise<PreviewSubscriptionsChargesResponse & PreviewSubscriptionsChargesResponseNonNullableFields>;
245
+ }
246
+ export declare function initiatePaymentMethodSetup(httpClient: HttpClient): InitiatePaymentMethodSetupSignature;
247
+ interface InitiatePaymentMethodSetupSignature {
248
+ /**
249
+ * Creates authorization invoice with Moto settings in order to create
250
+ */
251
+ (_id: string, options?: InitiatePaymentMethodSetupOptions | undefined): Promise<InitiatePaymentMethodSetupResponse & InitiatePaymentMethodSetupResponseNonNullableFields>;
252
+ }
253
+ export declare function payCycle(httpClient: HttpClient): PayCycleSignature;
254
+ interface PayCycleSignature {
255
+ /**
256
+ * This used only for automation and permitted tenants (QA & testing)
257
+ */
258
+ (subscriptionId: string, options?: PayCycleOptions | undefined): Promise<PayCycleResponse & PayCycleResponseNonNullableFields>;
259
+ }
260
+ export declare const onSubscriptionCanceled: EventDefinition<SubscriptionCanceledEnvelope, "wix.billing.v1.subscription_canceled">;
261
+ export declare const onSubscriptionExtended: EventDefinition<SubscriptionExtendedEnvelope, "wix.billing.v1.subscription_extended">;
262
+ export declare const onSubscriptionUpdated: EventDefinition<SubscriptionUpdatedEnvelope, "wix.billing.v1.subscription_updated">;
263
+ export declare const onSubscriptionAutoRenewalTurnedOff: EventDefinition<SubscriptionAutoRenewalTurnedOffEnvelope, "wix.billing.v1.subscription_auto_renewal_turned_off">;
264
+ export declare const onSubscriptionAutoRenewalTurnedOn: EventDefinition<SubscriptionAutoRenewalTurnedOnEnvelope, "wix.billing.v1.subscription_auto_renewal_turned_on">;
265
+ export declare const onSubscriptionBillingDateUpdated: EventDefinition<SubscriptionBillingDateUpdatedEnvelope, "wix.billing.v1.subscription_billing_date_updated">;
266
+ export declare const onSubscriptionLatestInvoiceMarkedAsPaid: EventDefinition<SubscriptionLatestInvoiceMarkedAsPaidEnvelope, "wix.billing.v1.subscription_latest_invoice_marked_as_paid">;
267
+ export declare const onSubscriptionPauseScheduleCanceled: EventDefinition<SubscriptionPauseScheduleCanceledEnvelope, "wix.billing.v1.subscription_pause_schedule_canceled">;
268
+ export declare const onSubscriptionPauseScheduled: EventDefinition<SubscriptionPauseScheduledEnvelope, "wix.billing.v1.subscription_pause_scheduled">;
269
+ export declare const onSubscriptionPaused: EventDefinition<SubscriptionPausedEnvelope, "wix.billing.v1.subscription_paused">;
270
+ export declare const onSubscriptionResumeScheduleCanceled: EventDefinition<SubscriptionResumeScheduleCanceledEnvelope, "wix.billing.v1.subscription_resume_schedule_canceled">;
271
+ export declare const onSubscriptionResumeScheduled: EventDefinition<SubscriptionResumeScheduledEnvelope, "wix.billing.v1.subscription_resume_scheduled">;
272
+ export declare const onSubscriptionResumed: EventDefinition<SubscriptionResumedEnvelope, "wix.billing.v1.subscription_resumed">;
273
+ export { Action, ActionContext, ActionDetails, ActionEvent, ActionInitiator, ActionType, AddPausePeriodRequest, AddPausePeriodResponse, AdditionalFee, AdditionalFeeTrigger, Address, AddressStreetOneOf, AggregatedTaxBreakdown, AllowedActionsOptions, AllowedActionsRequest, AllowedActionsResponse, AllowedActionsResponseNonNullableFields, AmountByStatus, ApplicationFee, ApplicationFeeValueOneOf, AttachInvoice, AutomaticRetryData, BaseEventMetadata, BillingSettings, BillingStatus, BulkItemChange, BulkUpdateSubscriptionItemsByFilterRequest, BulkUpdateSubscriptionItemsByFilterResponse, BusinessOrigin, BusinessOriginData, Cancel, CancelSubscriptionBORequest, CancelSubscriptionBOResponse, CancelSubscriptionRequest, CancelSubscriptionResponse, CancelSubscriptionResponseNonNullableFields, CancelTimeCapsuleTaskRequest, CancellationInfo, CancellationInitiator, CatalogReference, Charge, CollectionMethod, CollectionMethodEnumCollectionMethod, Complete, ConvertSapiRequest, ConvertSapiResponse, CountByStatus, CountSubscriptionFilter, CountSubscriptionFilterStatusOneOf, CountSubscriptionsOptions, CountSubscriptionsRequest, CountSubscriptionsResponse, CountSubscriptionsResponseNonNullableFields, CreateRecurringInvoiceBORequest, CreateRecurringInvoiceBOResponse, CreateSubscriptionForOrderRequest, CreateSubscriptionForOrderResponse, CreateSubscriptionInStateRequest, CreateSubscriptionInStateRequestModeOneOf, CreateSubscriptionInStateResponse, CreateSubscriptionRequest, CreateSubscriptionResponse, CreationMode, CursorPaging, Cursors, CustomBillingSchedule, CustomProration, CustomProrationAmountOneOf, Customer, CustomerAllowedActionsRequest, CustomerAllowedActionsResponse, CustomerAllowedActionsResponseNonNullableFields, CustomerCancelSubscriptionOptions, CustomerCancelSubscriptionRequest, CustomerCancelSubscriptionResponse, CustomerCancelSubscriptionResponseNonNullableFields, CustomerExtendSubscriptionOptions, CustomerExtendSubscriptionRequest, CustomerExtendSubscriptionResponse, CustomerExtendSubscriptionResponseNonNullableFields, CustomerIdOneOf, CustomerInitiatePaymentMethodSetupOptions, CustomerListUpcomingChargesRequest, CustomerListUpcomingChargesResponse, CustomerListUpcomingChargesResponseNonNullableFields, CustomerQuerySubscriptionsOptions, CustomerTurnOffAutoRenewalRequest, CustomerTurnOffAutoRenewalResponse, CustomerTurnOffAutoRenewalResponseNonNullableFields, CustomerTurnOffSubscriptionAutoRenewalOptions, CustomerTurnOnAutoRenewalRequest, CustomerTurnOnAutoRenewalResponse, CustomerTurnOnAutoRenewalResponseNonNullableFields, CustomerTurnOnSubscriptionAutoRenewalOptions, Cycles, DeleteDraftSubscriptionRequest, DeleteDraftSubscriptionResponse, DeleteSubscriptionBORequest, DeleteSubscriptionBOResponse, DeleteSubscriptionRequest, DeleteSubscriptionResponse, DetachInvoice, Discount, DiscountCycles, DiscountOrigin, DiscountValueOneOf, DomainEvent, DomainEventBodyOneOf, Duration, DurationUnit, DynamicTax, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendPolicyType, ExtendSubscriptionOptions, ExtendSubscriptionRequest, ExtendSubscriptionRequestExtendPolicyOneOf, ExtendSubscriptionResponse, ExtendSubscriptionResponseNonNullableFields, ExternalCollectionDetails, FinishFreeTrialNowRequest, FinishFreeTrialNowResponse, FixSubscriptionInvoicesRequest, FixSubscriptionInvoicesRequestModeOneOf, FixSubscriptionInvoicesResponse, FixedPrice, FreeTrailEnded, FreeTrailStarted, FreeTrialData, FullAddressContactDetails, FullAddressDetails, FutureUpdatesRequested, GetFullSubscriptionDataRequest, GetFullSubscriptionDataResponse, GetSubscriptionAndInternalDataRequest, GetSubscriptionAndInternalDataResponse, GetSubscriptionInvoicesRequest, GetSubscriptionInvoicesResponse, GetSubscriptionRequest, GetSubscriptionResponse, GetSubscriptionResponseNonNullableFields, GetSubscriptionsStatsRequest, GetSubscriptionsStatsResponse, GetSubscriptionsStatsResponseNonNullableFields, GracePeriodData, GracePeriodEnded, GracePeriodStarted, HandleSubscriptionAfterInvoiceMarkedAsPaidRequest, HistoryActionInitiator, HistoryViewMode, IdentificationData, IdentificationDataIdOneOf, IdentityType, InitiatePaymentMethodSetupOptions, InitiatePaymentMethodSetupRequest, InitiatePaymentMethodSetupResponse, InitiatePaymentMethodSetupResponseNonNullableFields, InitiatedPaymentMethodSetup, InternalSubscriptionData, Invoice, InvoiceAction, InvoiceActionActionTypeOneOf, InvoiceApplicationFee, InvoiceApplicationFeeValueOneOf, InvoiceDiscount, InvoiceDiscountValueOneOf, InvoiceItem, InvoiceItemPaymentTypeOneOf, InvoiceMarkedAsPaid, InvoiceShippingCharges, InvoiceStatus, Item, ItemCategory, ItemChange, ItemTaxData, LatestInvoiceMarkedAsPaid, LatestPaymentAttempt, LineItemTaxSummary, ListSubscriptionHistoryOptions, ListSubscriptionHistoryRequest, ListSubscriptionHistoryResponse, ListSubscriptionHistoryResponseNonNullableFields, ListUpcomingChargesOptions, ListUpcomingChargesRequest, ListUpcomingChargesResponse, ListUpcomingChargesResponseNonNullableFields, MarkInvoiceAsPaidOptions, MarkInvoiceAsPaidRequest, MarkInvoiceAsPaidResponse, MarkInvoiceAsPaidResponseNonNullableFields, MarkLatestInvoiceAsPaidRequest, MarkLatestInvoiceAsPaidResponse, MarkLatestInvoiceAsPaidResponseNonNullableFields, MessageEnvelope, MigrationDetails, Money, MultipleSubscriptionsOnOrdersInvoice, OneTime, OrderMethod, Origin, OriginOverride, Paging, PagingMetadataV2, PauseAt, PauseInfo, PausePeriod, PausePolicy, PauseSubscriptionBORequest, PauseSubscriptionBOResponse, PauseSubscriptionOptions, PauseSubscriptionRequest, PauseSubscriptionRequested, PauseSubscriptionResponse, PauseSubscriptionResponseNonNullableFields, PayCycleOptions, PayCycleRequest, PayCycleResponse, PayCycleResponseNonNullableFields, PayRecurringInvoice, PaymentAttemptStatus, PaymentData, PaymentMethod, PaymentMethodUpdated, PaymentMode, PaymentOrigin, PaymentSettings, PaymentSettlementMethod, PaymentStatus, PaymentStatusEnumPaymentStatus, PaymentTestMode, PlatformOrigin, PreviewSubscriptionChargesOptions, PreviewSubscriptionChargesRequest, PreviewSubscriptionChargesRequestSubscriptionOneOf, PreviewSubscriptionChargesResponse, PreviewSubscriptionChargesResponseNonNullableFields, PreviewSubscriptionsChargesOptions, PreviewSubscriptionsChargesRequest, PreviewSubscriptionsChargesResponse, PreviewSubscriptionsChargesResponseNonNullableFields, PriceAdjustment, PriceAdjustmentAdjustmentTypeOneOf, PriceAdjustmentValue, PriceAdjustmentValueAdjustmentValueTypeOneOf, PriceDetails, PricingModel, PricingModelModelOneOf, Proration, ProrationTypeOneOf, QuerySubscriptionsRequest, QuerySubscriptionsResponse, QuerySubscriptionsResponseNonNullableFields, QueryV2, QueryV2PagingMethodOneOf, Recurring, RedirectUrls, RequestedFields, Reschedule, ResetPendingUpdates, RestoreDraftSubscriptionRequest, RestoreDraftSubscriptionResponse, RestoreInfo, ResumeAt, ResumeSubscriptionOptions, ResumeSubscriptionRequest, ResumeSubscriptionRequested, ResumeSubscriptionResponse, ResumeSubscriptionResponseNonNullableFields, ReviseSubscriptionRequest, ReviseSubscriptionResponse, RevivePolicy, ReviveSubscriptionRequest, ReviveSubscriptionResponse, RunTimeCapsuleTaskNowRequest, ScheduleAdditionalInfo, ScheduleAdditionalInfoParamOneOf, ScheduleTimeCapsuleTaskRequest, ScheduledPauseCanceled, ScheduledResumeCanceled, SearchSubscriptionRequest, SearchSubscriptionResponse, SearchSubscriptionsOptions, SearchSubscriptionsRequest, SearchSubscriptionsRequestPagingMethodOneOf, SearchSubscriptionsResponse, SearchSubscriptionsResponseNonNullableFields, SendSubscriptionActionEventBORequest, SendSubscriptionActionEventBORequestEventOneOf, SendSubscriptionActionEventResponse, SendTimeCapsuleTaskCanceledBIRequest, SetIsMigratedEvent, SetShiftingDataRequest, SetShiftingDataResponse, ShippingCharges, SortOrder, Sorting, SortingClauses, SpecificDateSubscriptionUpdateData, Status, StreetAddress, Subscriber, Subscription, SubscriptionActivated, SubscriptionAutoRenewalTurnedOff, SubscriptionAutoRenewalTurnedOffEnvelope, SubscriptionAutoRenewalTurnedOn, SubscriptionAutoRenewalTurnedOnEnvelope, SubscriptionBackOfficeAction, SubscriptionBillingCycleStarted, SubscriptionBillingDateUpdated, SubscriptionBillingDateUpdatedEnvelope, SubscriptionBillingDetails, SubscriptionCanceled, SubscriptionCanceledEnvelope, SubscriptionCancellationRequested, SubscriptionCharge, SubscriptionCharges, SubscriptionCollectionMethodUpdated, SubscriptionCreated, SubscriptionCycleReadyToPay, SubscriptionCycleTriggered, SubscriptionDelayedSyncEvent, SubscriptionDeleted, SubscriptionDiff, SubscriptionEnded, SubscriptionEvent, SubscriptionEventPayloadOneOf, SubscriptionExpired, SubscriptionExtended, SubscriptionExtendedEnvelope, SubscriptionExtendedExtendPolicyOneOf, SubscriptionFrequency, SubscriptionHistoryEntry, SubscriptionInfo, SubscriptionInitialPurchaseCompleted, SubscriptionInvoice, SubscriptionLatestInvoiceMarkedAsPaidEnvelope, SubscriptionMarkedAsPaid, SubscriptionPauseScheduleCanceledEnvelope, SubscriptionPauseScheduledEnvelope, SubscriptionPaused, SubscriptionPausedEnvelope, SubscriptionPolicies, SubscriptionPolicy, SubscriptionResumeScheduleCanceledEnvelope, SubscriptionResumeScheduledEnvelope, SubscriptionResumed, SubscriptionResumedEnvelope, SubscriptionRevived, SubscriptionStatus, SubscriptionStatusEnumSubscriptionStatus, SubscriptionStatusGroup, SubscriptionSuspended, SubscriptionTrialPeriod, SubscriptionType, SubscriptionUpdateData, SubscriptionUpdated, SubscriptionUpdatedEnvelope, Suspension, Task, TaskAction, TaskActionActionOneOf, TaskKey, Tax, TaxBreakdown, TaxData, TaxSettings, TaxSummary, TaxValueOneOf, TaxableAddressType, TimeBasedProration, Totals, TurnOffSubscriptionAutoRenewalRequest, TurnOffSubscriptionAutoRenewalResponse, TurnOffSubscriptionAutoRenewalResponseNonNullableFields, TurnOnSubscriptionAutoRenewalRequest, TurnOnSubscriptionAutoRenewalResponse, TurnOnSubscriptionAutoRenewalResponseNonNullableFields, UnknownSubscriptionEvent, UnsupportedAction, UnsupportedReason, UpdateAction, UpdateBillingDateData, UpdateFullSubscriptionRequest, UpdateFullSubscriptionResponse, UpdatePausePaidDurationRequest, UpdatePausePaidDurationResponse, UpdatePaymentMethodBORequest, UpdatePaymentMethodBOResponse, UpdatePaymentStatusRequest, UpdatePaymentStatusResponse, UpdateStatusRequest, UpdateStatusResponse, UpdateSubscriptionBillingDateOptions, UpdateSubscriptionBillingDateRequest, UpdateSubscriptionBillingDateResponse, UpdateSubscriptionBillingDateResponseNonNullableFields, UpdateSubscriptionInvoiceCycleRequest, UpdateSubscriptionInvoiceCycleResponse, UpdateSubscriptionItemsRequest, UpdateSubscriptionItemsResponse, UpdateSubscriptionOriginRequest, UpdateSubscriptionOriginResponse, UpdateSubscriptionPaymentMethodRequest, UpdateSubscriptionPaymentMethodResponse, UpdateSubscriptionPaymentMethodResponseNonNullableFields, UpdateSubscriptionPoliciesRequest, UpdateSubscriptionPoliciesResponse, UpdateSubscriptionRequest, UpdateSubscriptionResponse, UpdateSubscriptionStartDateRequest, UpdateSubscriptionStartDateResponse, UpdatesApplied, V1Duration, V1Subscription, V1SubscriptionActivated, V1SubscriptionCanceled, V1SubscriptionCreated, V1SubscriptionEvent, V1SubscriptionEventEventOneOf, V1SubscriptionInitialPurchaseCompleted, V1SubscriptionResumed, V1SubscriptionStatusEnumSubscriptionStatus, V1SubscriptionUpdated, V2Subscription, WebhookIdentityType, } from './billing-v1-subscription-subscriptions.universal.js';