@salable/sdk 1.0.0-beta.1

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 (86) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +93 -0
  3. package/dist/index.d.ts +5 -0
  4. package/dist/index.es.js +19915 -0
  5. package/dist/index.es.js.map +1 -0
  6. package/dist/index.js +19917 -0
  7. package/dist/index.js.map +1 -0
  8. package/dist/sdk/api/apiKeys/index.d.ts +66 -0
  9. package/dist/sdk/api/apiKeys/item/index.d.ts +48 -0
  10. package/dist/sdk/api/cartItems/index.d.ts +131 -0
  11. package/dist/sdk/api/cartItems/item/index.d.ts +31 -0
  12. package/dist/sdk/api/carts/batch/index.d.ts +36 -0
  13. package/dist/sdk/api/carts/index.d.ts +88 -0
  14. package/dist/sdk/api/carts/item/checkout/index.d.ts +35 -0
  15. package/dist/sdk/api/carts/item/index.d.ts +78 -0
  16. package/dist/sdk/api/checkout/index.d.ts +360 -0
  17. package/dist/sdk/api/currencyOptions/index.d.ts +56 -0
  18. package/dist/sdk/api/currencyOptions/item/index.d.ts +42 -0
  19. package/dist/sdk/api/destinations/index.d.ts +52 -0
  20. package/dist/sdk/api/destinations/item/index.d.ts +58 -0
  21. package/dist/sdk/api/entitlements/check/index.d.ts +40 -0
  22. package/dist/sdk/api/entitlements/index.d.ts +74 -0
  23. package/dist/sdk/api/entitlements/item/index.d.ts +67 -0
  24. package/dist/sdk/api/eventAttempts/index.d.ts +57 -0
  25. package/dist/sdk/api/events/index.d.ts +60 -0
  26. package/dist/sdk/api/events/item/index.d.ts +42 -0
  27. package/dist/sdk/api/grantees/index.d.ts +68 -0
  28. package/dist/sdk/api/grantees/item/index.d.ts +77 -0
  29. package/dist/sdk/api/groups/index.d.ts +73 -0
  30. package/dist/sdk/api/groups/item/grantees/index.d.ts +53 -0
  31. package/dist/sdk/api/groups/item/index.d.ts +88 -0
  32. package/dist/sdk/api/index.d.ts +164 -0
  33. package/dist/sdk/api/lineItems/index.d.ts +51 -0
  34. package/dist/sdk/api/lineItems/item/archive/index.d.ts +32 -0
  35. package/dist/sdk/api/lineItems/item/index.d.ts +109 -0
  36. package/dist/sdk/api/memberships/index.d.ts +52 -0
  37. package/dist/sdk/api/memberships/item/index.d.ts +42 -0
  38. package/dist/sdk/api/meters/index.d.ts +39 -0
  39. package/dist/sdk/api/owners/index.d.ts +51 -0
  40. package/dist/sdk/api/owners/item/index.d.ts +63 -0
  41. package/dist/sdk/api/paymentIntegrations/index.d.ts +91 -0
  42. package/dist/sdk/api/paymentIntegrations/item/index.d.ts +40 -0
  43. package/dist/sdk/api/paymentIntegrations/item/onboarding/index.d.ts +32 -0
  44. package/dist/sdk/api/plans/index.d.ts +236 -0
  45. package/dist/sdk/api/plans/item/archive/index.d.ts +32 -0
  46. package/dist/sdk/api/plans/item/index.d.ts +97 -0
  47. package/dist/sdk/api/plans/save/index.d.ts +33 -0
  48. package/dist/sdk/api/prices/index.d.ts +49 -0
  49. package/dist/sdk/api/prices/item/archive/index.d.ts +32 -0
  50. package/dist/sdk/api/prices/item/index.d.ts +57 -0
  51. package/dist/sdk/api/products/exportEscaped/index.d.ts +21 -0
  52. package/dist/sdk/api/products/exportEscaped/item/index.d.ts +32 -0
  53. package/dist/sdk/api/products/importEscaped/index.d.ts +32 -0
  54. package/dist/sdk/api/products/index.d.ts +92 -0
  55. package/dist/sdk/api/products/item/archive/index.d.ts +32 -0
  56. package/dist/sdk/api/products/item/index.d.ts +90 -0
  57. package/dist/sdk/api/receipts/index.d.ts +59 -0
  58. package/dist/sdk/api/receipts/item/index.d.ts +43 -0
  59. package/dist/sdk/api/signingKeys/index.d.ts +31 -0
  60. package/dist/sdk/api/stripe/accountSession/index.d.ts +31 -0
  61. package/dist/sdk/api/stripe/index.d.ts +19 -0
  62. package/dist/sdk/api/subscriptionPlanLineItems/index.d.ts +21 -0
  63. package/dist/sdk/api/subscriptionPlanLineItems/item/index.d.ts +86 -0
  64. package/dist/sdk/api/subscriptionPlanLineItems/item/sync/index.d.ts +31 -0
  65. package/dist/sdk/api/subscriptionPlans/index.d.ts +447 -0
  66. package/dist/sdk/api/subscriptionPlans/item/index.d.ts +1138 -0
  67. package/dist/sdk/api/subscriptionPlans/item/seats/index.d.ts +58 -0
  68. package/dist/sdk/api/subscriptions/batch/index.d.ts +35 -0
  69. package/dist/sdk/api/subscriptions/index.d.ts +312 -0
  70. package/dist/sdk/api/subscriptions/item/autoRenew/index.d.ts +43 -0
  71. package/dist/sdk/api/subscriptions/item/cancel/index.d.ts +32 -0
  72. package/dist/sdk/api/subscriptions/item/index.d.ts +90 -0
  73. package/dist/sdk/api/subscriptions/item/invoices/index.d.ts +33 -0
  74. package/dist/sdk/api/subscriptions/item/items/index.d.ts +34 -0
  75. package/dist/sdk/api/subscriptions/item/portal/index.d.ts +34 -0
  76. package/dist/sdk/api/tierTags/index.d.ts +58 -0
  77. package/dist/sdk/api/tiers/index.d.ts +50 -0
  78. package/dist/sdk/api/tiers/item/index.d.ts +31 -0
  79. package/dist/sdk/api/usage/index.d.ts +19 -0
  80. package/dist/sdk/api/usage/record/index.d.ts +33 -0
  81. package/dist/sdk/api/usageRecords/index.d.ts +55 -0
  82. package/dist/sdk/api/webhooks/index.d.ts +72 -0
  83. package/dist/sdk/api/webhooks/item/index.d.ts +77 -0
  84. package/dist/sdk/models/index.d.ts +16552 -0
  85. package/dist/sdk/salable.d.ts +24 -0
  86. package/package.json +48 -0
@@ -0,0 +1,58 @@
1
+ import { type AdditionalDataHolder, type BaseRequestBuilder, type Parsable, type ParseNode, type RequestConfiguration, type RequestInformation, type RequestsMetadata, type SerializationWriter } from '@microsoft/kiota-abstractions';
2
+ /**
3
+ * Creates a new instance of the appropriate class based on discriminator value
4
+ * @param parseNode The parse node to use to read the discriminator value and create the object
5
+ * @returns {SeatsPutRequestBody}
6
+ */
7
+ export declare function createSeatsPutRequestBodyFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
8
+ /**
9
+ * The deserialization information for the current model
10
+ * @param SeatsPutRequestBody The instance to deserialize into.
11
+ * @returns {Record<string, (node: ParseNode) => void>}
12
+ */
13
+ export declare function deserializeIntoSeatsPutRequestBody(seatsPutRequestBody?: Partial<SeatsPutRequestBody> | undefined): Record<string, (node: ParseNode) => void>;
14
+ export interface SeatsPutRequestBody extends AdditionalDataHolder, Parsable {
15
+ /**
16
+ * The new quantity of the item. The quantity cannot exceed minimum or maximum seat limits.
17
+ */
18
+ quantity?: number | null;
19
+ }
20
+ /**
21
+ * Builds and executes requests for operations under /api/subscription-plans/{id}/seats
22
+ */
23
+ export interface SeatsRequestBuilder extends BaseRequestBuilder<SeatsRequestBuilder> {
24
+ /**
25
+ * Update Subscription Plan Seats
26
+ * @param body The request body
27
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
28
+ * @throws {ErrorResponseBody} error when the service returns a 400 status code
29
+ * @throws {ErrorResponseBody} error when the service returns a 401 status code
30
+ * @throws {ErrorResponseBody} error when the service returns a 403 status code
31
+ * @throws {ErrorResponseBody} error when the service returns a 404 status code
32
+ * @throws {ErrorResponseBody} error when the service returns a 405 status code
33
+ * @throws {ErrorResponseBody} error when the service returns a 500 status code
34
+ */
35
+ put(body: SeatsPutRequestBody, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
36
+ /**
37
+ * Update Subscription Plan Seats
38
+ * @param body The request body
39
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
40
+ * @returns {RequestInformation}
41
+ */
42
+ toPutRequestInformation(body: SeatsPutRequestBody, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
43
+ }
44
+ /**
45
+ * Serializes information the current object
46
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
47
+ * @param SeatsPutRequestBody The instance to serialize from.
48
+ * @param writer Serialization writer to use to serialize this model
49
+ */
50
+ export declare function serializeSeatsPutRequestBody(writer: SerializationWriter, seatsPutRequestBody?: Partial<SeatsPutRequestBody> | undefined | null, isSerializingDerivedType?: boolean): void;
51
+ /**
52
+ * Uri template for the request builder.
53
+ */
54
+ export declare const SeatsRequestBuilderUriTemplate = "{+baseurl}/api/subscription-plans/{id}/seats";
55
+ /**
56
+ * Metadata for all the requests in the request builder.
57
+ */
58
+ export declare const SeatsRequestBuilderRequestsMetadata: RequestsMetadata;
@@ -0,0 +1,35 @@
1
+ import { type BatchSubscriptionActionsRequestSchema, type BatchSubscriptionActionsResponseSchema } from '../../../models/index.js';
2
+ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
3
+ /**
4
+ * Builds and executes requests for operations under /api/subscriptions/batch
5
+ */
6
+ export interface BatchRequestBuilder extends BaseRequestBuilder<BatchRequestBuilder> {
7
+ /**
8
+ * Perform batch actions on multiple subscriptions. Supports cancel, enable-auto-renew, disable-auto-renew, and delete (test mode only). Returns detailed results for each subscription including success, failure, or skip status.
9
+ * @param body The request body
10
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
+ * @returns {Promise<BatchSubscriptionActionsResponseSchema>}
12
+ * @throws {ErrorResponseBody} error when the service returns a 400 status code
13
+ * @throws {ErrorResponseBody} error when the service returns a 401 status code
14
+ * @throws {ErrorResponseBody} error when the service returns a 403 status code
15
+ * @throws {ErrorResponseBody} error when the service returns a 405 status code
16
+ * @throws {ErrorResponseBody} error when the service returns a 429 status code
17
+ * @throws {ErrorResponseBody} error when the service returns a 500 status code
18
+ */
19
+ post(body: BatchSubscriptionActionsRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<BatchSubscriptionActionsResponseSchema | undefined>;
20
+ /**
21
+ * Perform batch actions on multiple subscriptions. Supports cancel, enable-auto-renew, disable-auto-renew, and delete (test mode only). Returns detailed results for each subscription including success, failure, or skip status.
22
+ * @param body The request body
23
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
24
+ * @returns {RequestInformation}
25
+ */
26
+ toPostRequestInformation(body: BatchSubscriptionActionsRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
27
+ }
28
+ /**
29
+ * Uri template for the request builder.
30
+ */
31
+ export declare const BatchRequestBuilderUriTemplate = "{+baseurl}/api/subscriptions/batch";
32
+ /**
33
+ * Metadata for all the requests in the request builder.
34
+ */
35
+ export declare const BatchRequestBuilderRequestsMetadata: RequestsMetadata;
@@ -0,0 +1,312 @@
1
+ import { type GetSubscriptionListSchema } from '../../models/index.js';
2
+ import { type BatchRequestBuilder } from './batch/index.js';
3
+ import { type SubscriptionsItemRequestBuilder } from './item/index.js';
4
+ import { type AdditionalDataHolder, type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type Parsable, type ParseNode, type RequestConfiguration, type RequestInformation, type RequestsMetadata, type SerializationWriter, type UntypedNode } from '@microsoft/kiota-abstractions';
5
+ /**
6
+ * Creates a new instance of the appropriate class based on discriminator value
7
+ * @param parseNode The parse node to use to read the discriminator value and create the object
8
+ * @returns {SubscriptionsPostRequestBody_plans_metadata}
9
+ */
10
+ export declare function createSubscriptionsPostRequestBody_plans_metadataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
11
+ /**
12
+ * Creates a new instance of the appropriate class based on discriminator value
13
+ * @param parseNode The parse node to use to read the discriminator value and create the object
14
+ * @returns {SubscriptionsPostRequestBody_plans}
15
+ */
16
+ export declare function createSubscriptionsPostRequestBody_plansFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
17
+ /**
18
+ * Creates a new instance of the appropriate class based on discriminator value
19
+ * @param parseNode The parse node to use to read the discriminator value and create the object
20
+ * @returns {SubscriptionsPostRequestBody}
21
+ */
22
+ export declare function createSubscriptionsPostRequestBodyFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
23
+ /**
24
+ * Creates a new instance of the appropriate class based on discriminator value
25
+ * @param parseNode The parse node to use to read the discriminator value and create the object
26
+ * @returns {SubscriptionsPostResponse_data}
27
+ */
28
+ export declare function createSubscriptionsPostResponse_dataFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
29
+ /**
30
+ * Creates a new instance of the appropriate class based on discriminator value
31
+ * @param parseNode The parse node to use to read the discriminator value and create the object
32
+ * @returns {SubscriptionsPostResponse}
33
+ */
34
+ export declare function createSubscriptionsPostResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
35
+ /**
36
+ * The deserialization information for the current model
37
+ * @param SubscriptionsPostRequestBody The instance to deserialize into.
38
+ * @returns {Record<string, (node: ParseNode) => void>}
39
+ */
40
+ export declare function deserializeIntoSubscriptionsPostRequestBody(subscriptionsPostRequestBody?: Partial<SubscriptionsPostRequestBody> | undefined): Record<string, (node: ParseNode) => void>;
41
+ /**
42
+ * The deserialization information for the current model
43
+ * @param SubscriptionsPostRequestBody_plans The instance to deserialize into.
44
+ * @returns {Record<string, (node: ParseNode) => void>}
45
+ */
46
+ export declare function deserializeIntoSubscriptionsPostRequestBody_plans(subscriptionsPostRequestBody_plans?: Partial<SubscriptionsPostRequestBody_plans> | undefined): Record<string, (node: ParseNode) => void>;
47
+ /**
48
+ * The deserialization information for the current model
49
+ * @param SubscriptionsPostRequestBody_plans_metadata The instance to deserialize into.
50
+ * @returns {Record<string, (node: ParseNode) => void>}
51
+ */
52
+ export declare function deserializeIntoSubscriptionsPostRequestBody_plans_metadata(subscriptionsPostRequestBody_plans_metadata?: Partial<SubscriptionsPostRequestBody_plans_metadata> | undefined): Record<string, (node: ParseNode) => void>;
53
+ /**
54
+ * The deserialization information for the current model
55
+ * @param SubscriptionsPostResponse The instance to deserialize into.
56
+ * @returns {Record<string, (node: ParseNode) => void>}
57
+ */
58
+ export declare function deserializeIntoSubscriptionsPostResponse(subscriptionsPostResponse?: Partial<SubscriptionsPostResponse> | undefined): Record<string, (node: ParseNode) => void>;
59
+ /**
60
+ * The deserialization information for the current model
61
+ * @param SubscriptionsPostResponse_data The instance to deserialize into.
62
+ * @returns {Record<string, (node: ParseNode) => void>}
63
+ */
64
+ export declare function deserializeIntoSubscriptionsPostResponse_data(subscriptionsPostResponse_data?: Partial<SubscriptionsPostResponse_data> | undefined): Record<string, (node: ParseNode) => void>;
65
+ export type GetExpandQueryParameterType = (typeof GetExpandQueryParameterTypeObject)[keyof typeof GetExpandQueryParameterTypeObject];
66
+ /**
67
+ * Serializes information the current object
68
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
69
+ * @param SubscriptionsPostRequestBody The instance to serialize from.
70
+ * @param writer Serialization writer to use to serialize this model
71
+ */
72
+ export declare function serializeSubscriptionsPostRequestBody(writer: SerializationWriter, subscriptionsPostRequestBody?: Partial<SubscriptionsPostRequestBody> | undefined | null, isSerializingDerivedType?: boolean): void;
73
+ /**
74
+ * Serializes information the current object
75
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
76
+ * @param SubscriptionsPostRequestBody_plans The instance to serialize from.
77
+ * @param writer Serialization writer to use to serialize this model
78
+ */
79
+ export declare function serializeSubscriptionsPostRequestBody_plans(writer: SerializationWriter, subscriptionsPostRequestBody_plans?: Partial<SubscriptionsPostRequestBody_plans> | undefined | null, isSerializingDerivedType?: boolean): void;
80
+ /**
81
+ * Serializes information the current object
82
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
83
+ * @param SubscriptionsPostRequestBody_plans_metadata The instance to serialize from.
84
+ * @param writer Serialization writer to use to serialize this model
85
+ */
86
+ export declare function serializeSubscriptionsPostRequestBody_plans_metadata(writer: SerializationWriter, subscriptionsPostRequestBody_plans_metadata?: Partial<SubscriptionsPostRequestBody_plans_metadata> | undefined | null, isSerializingDerivedType?: boolean): void;
87
+ /**
88
+ * Serializes information the current object
89
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
90
+ * @param SubscriptionsPostResponse The instance to serialize from.
91
+ * @param writer Serialization writer to use to serialize this model
92
+ */
93
+ export declare function serializeSubscriptionsPostResponse(writer: SerializationWriter, subscriptionsPostResponse?: Partial<SubscriptionsPostResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
94
+ /**
95
+ * Serializes information the current object
96
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
97
+ * @param SubscriptionsPostResponse_data The instance to serialize from.
98
+ * @param writer Serialization writer to use to serialize this model
99
+ */
100
+ export declare function serializeSubscriptionsPostResponse_data(writer: SerializationWriter, subscriptionsPostResponse_data?: Partial<SubscriptionsPostResponse_data> | undefined | null, isSerializingDerivedType?: boolean): void;
101
+ export interface SubscriptionsPostRequestBody extends Parsable {
102
+ /**
103
+ * The cancelAtPeriodEnd property
104
+ */
105
+ cancelAtPeriodEnd?: boolean | null;
106
+ /**
107
+ * The expiryDate property
108
+ */
109
+ expiryDate?: Date | null;
110
+ /**
111
+ * The grantee property
112
+ */
113
+ grantee?: string | null;
114
+ /**
115
+ * The interval property
116
+ */
117
+ interval?: SubscriptionsPostRequestBody_interval | null;
118
+ /**
119
+ * The intervalCount property
120
+ */
121
+ intervalCount?: number | null;
122
+ /**
123
+ * The isPerpetual property
124
+ */
125
+ isPerpetual?: boolean | null;
126
+ /**
127
+ * The owner property
128
+ */
129
+ owner?: string | null;
130
+ /**
131
+ * The plans property
132
+ */
133
+ plans?: SubscriptionsPostRequestBody_plans[] | null;
134
+ }
135
+ export type SubscriptionsPostRequestBody_interval = (typeof SubscriptionsPostRequestBody_intervalObject)[keyof typeof SubscriptionsPostRequestBody_intervalObject];
136
+ export interface SubscriptionsPostRequestBody_plans extends Parsable {
137
+ /**
138
+ * The metadata property
139
+ */
140
+ metadata?: SubscriptionsPostRequestBody_plans_metadata | null;
141
+ /**
142
+ * The planId property
143
+ */
144
+ planId?: string | null;
145
+ }
146
+ export interface SubscriptionsPostRequestBody_plans_metadata extends AdditionalDataHolder, Parsable {
147
+ }
148
+ export interface SubscriptionsPostResponse extends AdditionalDataHolder, Parsable {
149
+ /**
150
+ * The data property
151
+ */
152
+ data?: SubscriptionsPostResponse_data | null;
153
+ /**
154
+ * The type property
155
+ */
156
+ type?: string | null;
157
+ }
158
+ export interface SubscriptionsPostResponse_data extends Parsable {
159
+ /**
160
+ * The cancelAtPeriodEnd property
161
+ */
162
+ cancelAtPeriodEnd?: boolean | null;
163
+ /**
164
+ * The cancelledAt property
165
+ */
166
+ cancelledAt?: string | null;
167
+ /**
168
+ * The createdAt property
169
+ */
170
+ createdAt?: string | null;
171
+ /**
172
+ * The currencyShortCode property
173
+ */
174
+ currencyShortCode?: string | null;
175
+ /**
176
+ * The customerId property
177
+ */
178
+ customerId?: string | null;
179
+ /**
180
+ * The id property
181
+ */
182
+ id?: string | null;
183
+ /**
184
+ * The interval property
185
+ */
186
+ interval?: UntypedNode | null;
187
+ /**
188
+ * The intervalCount property
189
+ */
190
+ intervalCount?: number | null;
191
+ /**
192
+ * The isPerpetual property
193
+ */
194
+ isPerpetual?: boolean | null;
195
+ /**
196
+ * The isSalableOnly property
197
+ */
198
+ isSalableOnly?: boolean | null;
199
+ /**
200
+ * The organisation property
201
+ */
202
+ organisation?: string | null;
203
+ /**
204
+ * The ownerId property
205
+ */
206
+ ownerId?: string | null;
207
+ /**
208
+ * The startDate property
209
+ */
210
+ startDate?: string | null;
211
+ /**
212
+ * The status property
213
+ */
214
+ status?: string | null;
215
+ /**
216
+ * The stripeSubscriptionId property
217
+ */
218
+ stripeSubscriptionId?: string | null;
219
+ /**
220
+ * The updatedAt property
221
+ */
222
+ updatedAt?: string | null;
223
+ }
224
+ /**
225
+ * Builds and executes requests for operations under /api/subscriptions
226
+ */
227
+ export interface SubscriptionsRequestBuilder extends BaseRequestBuilder<SubscriptionsRequestBuilder> {
228
+ /**
229
+ * The batch property
230
+ */
231
+ get batch(): BatchRequestBuilder;
232
+ /**
233
+ * Gets an item from the ApiSdk.api.subscriptions.item collection
234
+ * @param id Resource ID
235
+ * @returns {SubscriptionsItemRequestBuilder}
236
+ */
237
+ byId(id: string): SubscriptionsItemRequestBuilder;
238
+ /**
239
+ * List Subscriptions
240
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
241
+ * @returns {Promise<GetSubscriptionListSchema>}
242
+ * @throws {ErrorResponseBody} error when the service returns a 401 status code
243
+ * @throws {ErrorResponseBody} error when the service returns a 405 status code
244
+ * @throws {ErrorResponseBody} error when the service returns a 500 status code
245
+ */
246
+ get(requestConfiguration?: RequestConfiguration<SubscriptionsRequestBuilderGetQueryParameters> | undefined): Promise<GetSubscriptionListSchema | undefined>;
247
+ /**
248
+ * Creates a Salable Only Subscription
249
+ * @param body The request body
250
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
251
+ * @returns {Promise<SubscriptionsPostResponse>}
252
+ * @throws {ErrorResponseBody} error when the service returns a 400 status code
253
+ * @throws {ErrorResponseBody} error when the service returns a 401 status code
254
+ * @throws {ErrorResponseBody} error when the service returns a 405 status code
255
+ * @throws {ErrorResponseBody} error when the service returns a 429 status code
256
+ * @throws {ErrorResponseBody} error when the service returns a 500 status code
257
+ */
258
+ post(body: SubscriptionsPostRequestBody, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SubscriptionsPostResponse | undefined>;
259
+ /**
260
+ * List Subscriptions
261
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
262
+ * @returns {RequestInformation}
263
+ */
264
+ toGetRequestInformation(requestConfiguration?: RequestConfiguration<SubscriptionsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
265
+ /**
266
+ * Creates a Salable Only Subscription
267
+ * @param body The request body
268
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
269
+ * @returns {RequestInformation}
270
+ */
271
+ toPostRequestInformation(body: SubscriptionsPostRequestBody, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
272
+ }
273
+ /**
274
+ * List Subscriptions
275
+ */
276
+ export interface SubscriptionsRequestBuilderGetQueryParameters {
277
+ after?: string;
278
+ before?: string;
279
+ expand?: GetExpandQueryParameterType[];
280
+ id?: string;
281
+ limit?: string;
282
+ owner?: string;
283
+ plans?: string[];
284
+ priceId?: string;
285
+ products?: string[];
286
+ search?: string;
287
+ sort?: string;
288
+ status?: string;
289
+ stripePriceId?: string;
290
+ }
291
+ /**
292
+ * Uri template for the request builder.
293
+ */
294
+ export declare const SubscriptionsRequestBuilderUriTemplate = "{+baseurl}/api/subscriptions{?after*,before*,expand,id*,limit*,owner*,plans,priceId*,products,search*,sort*,status*,stripePriceId*}";
295
+ export declare const GetExpandQueryParameterTypeObject: {
296
+ readonly Owner: "owner";
297
+ readonly SubscriptionPlans: "subscriptionPlans";
298
+ };
299
+ export declare const SubscriptionsPostRequestBody_intervalObject: {
300
+ readonly Day: "day";
301
+ readonly Week: "week";
302
+ readonly Month: "month";
303
+ readonly Year: "year";
304
+ };
305
+ /**
306
+ * Metadata for all the navigation properties in the request builder.
307
+ */
308
+ export declare const SubscriptionsRequestBuilderNavigationMetadata: Record<Exclude<keyof SubscriptionsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
309
+ /**
310
+ * Metadata for all the requests in the request builder.
311
+ */
312
+ export declare const SubscriptionsRequestBuilderRequestsMetadata: RequestsMetadata;
@@ -0,0 +1,43 @@
1
+ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
2
+ /**
3
+ * Builds and executes requests for operations under /api/subscriptions/{id}/auto-renew
4
+ */
5
+ export interface AutoRenewRequestBuilder extends BaseRequestBuilder<AutoRenewRequestBuilder> {
6
+ /**
7
+ * Update Subscription Auto Renew
8
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
9
+ * @throws {ErrorResponseBody} error when the service returns a 400 status code
10
+ * @throws {ErrorResponseBody} error when the service returns a 401 status code
11
+ * @throws {ErrorResponseBody} error when the service returns a 403 status code
12
+ * @throws {ErrorResponseBody} error when the service returns a 404 status code
13
+ * @throws {ErrorResponseBody} error when the service returns a 405 status code
14
+ * @throws {ErrorResponseBody} error when the service returns a 500 status code
15
+ */
16
+ put(requestConfiguration?: RequestConfiguration<AutoRenewRequestBuilderPutQueryParameters> | undefined): Promise<void>;
17
+ /**
18
+ * Update Subscription Auto Renew
19
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
20
+ * @returns {RequestInformation}
21
+ */
22
+ toPutRequestInformation(requestConfiguration?: RequestConfiguration<AutoRenewRequestBuilderPutQueryParameters> | undefined): RequestInformation;
23
+ }
24
+ /**
25
+ * Update Subscription Auto Renew
26
+ */
27
+ export interface AutoRenewRequestBuilderPutQueryParameters {
28
+ id?: string;
29
+ status?: PutStatusQueryParameterType;
30
+ }
31
+ export type PutStatusQueryParameterType = (typeof PutStatusQueryParameterTypeObject)[keyof typeof PutStatusQueryParameterTypeObject];
32
+ /**
33
+ * Uri template for the request builder.
34
+ */
35
+ export declare const AutoRenewRequestBuilderUriTemplate = "{+baseurl}/api/subscriptions/{id}/auto-renew?id={id}&status={status}";
36
+ /**
37
+ * Metadata for all the requests in the request builder.
38
+ */
39
+ export declare const AutoRenewRequestBuilderRequestsMetadata: RequestsMetadata;
40
+ export declare const PutStatusQueryParameterTypeObject: {
41
+ readonly Enable: "enable";
42
+ readonly Disable: "disable";
43
+ };
@@ -0,0 +1,32 @@
1
+ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
2
+ /**
3
+ * Builds and executes requests for operations under /api/subscriptions/{id}/cancel
4
+ */
5
+ export interface CancelRequestBuilder extends BaseRequestBuilder<CancelRequestBuilder> {
6
+ /**
7
+ * Cancels a subscription but keeps the record. For recurring subscriptions, this cancels the subscription on Stripe with proration. For perpetual subscriptions, this updates the local status to canceled.
8
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
9
+ * @throws {ErrorResponseBody} error when the service returns a 400 status code
10
+ * @throws {ErrorResponseBody} error when the service returns a 401 status code
11
+ * @throws {ErrorResponseBody} error when the service returns a 403 status code
12
+ * @throws {ErrorResponseBody} error when the service returns a 404 status code
13
+ * @throws {ErrorResponseBody} error when the service returns a 405 status code
14
+ * @throws {ErrorResponseBody} error when the service returns a 429 status code
15
+ * @throws {ErrorResponseBody} error when the service returns a 500 status code
16
+ */
17
+ post(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
18
+ /**
19
+ * Cancels a subscription but keeps the record. For recurring subscriptions, this cancels the subscription on Stripe with proration. For perpetual subscriptions, this updates the local status to canceled.
20
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
21
+ * @returns {RequestInformation}
22
+ */
23
+ toPostRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
24
+ }
25
+ /**
26
+ * Uri template for the request builder.
27
+ */
28
+ export declare const CancelRequestBuilderUriTemplate = "{+baseurl}/api/subscriptions/{id}/cancel";
29
+ /**
30
+ * Metadata for all the requests in the request builder.
31
+ */
32
+ export declare const CancelRequestBuilderRequestsMetadata: RequestsMetadata;
@@ -0,0 +1,90 @@
1
+ import { type GetSubscriptionDetailSchema } from '../../../models/index.js';
2
+ import { type AutoRenewRequestBuilder } from './autoRenew/index.js';
3
+ import { type CancelRequestBuilder } from './cancel/index.js';
4
+ import { type InvoicesRequestBuilder } from './invoices/index.js';
5
+ import { type ItemsRequestBuilder } from './items/index.js';
6
+ import { type PortalRequestBuilder } from './portal/index.js';
7
+ import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
8
+ export type GetExpandQueryParameterType = (typeof GetExpandQueryParameterTypeObject)[keyof typeof GetExpandQueryParameterTypeObject];
9
+ /**
10
+ * Builds and executes requests for operations under /api/subscriptions/{id}
11
+ */
12
+ export interface SubscriptionsItemRequestBuilder extends BaseRequestBuilder<SubscriptionsItemRequestBuilder> {
13
+ /**
14
+ * The autoRenew property
15
+ */
16
+ get autoRenew(): AutoRenewRequestBuilder;
17
+ /**
18
+ * The cancel property
19
+ */
20
+ get cancel(): CancelRequestBuilder;
21
+ /**
22
+ * The invoices property
23
+ */
24
+ get invoices(): InvoicesRequestBuilder;
25
+ /**
26
+ * The items property
27
+ */
28
+ get items(): ItemsRequestBuilder;
29
+ /**
30
+ * The portal property
31
+ */
32
+ get portal(): PortalRequestBuilder;
33
+ /**
34
+ * Permanently deletes a subscription. This endpoint is only available in test mode. For recurring subscriptions that are not already canceled, this will first cancel the subscription on Stripe before deleting it.
35
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
36
+ * @throws {ErrorResponseBody} error when the service returns a 400 status code
37
+ * @throws {ErrorResponseBody} error when the service returns a 401 status code
38
+ * @throws {ErrorResponseBody} error when the service returns a 403 status code
39
+ * @throws {ErrorResponseBody} error when the service returns a 404 status code
40
+ * @throws {ErrorResponseBody} error when the service returns a 405 status code
41
+ * @throws {ErrorResponseBody} error when the service returns a 429 status code
42
+ * @throws {ErrorResponseBody} error when the service returns a 500 status code
43
+ */
44
+ delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
45
+ /**
46
+ * Retrieve Subscription
47
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
48
+ * @returns {Promise<GetSubscriptionDetailSchema>}
49
+ * @throws {ErrorResponseBody} error when the service returns a 400 status code
50
+ * @throws {ErrorResponseBody} error when the service returns a 401 status code
51
+ * @throws {ErrorResponseBody} error when the service returns a 403 status code
52
+ * @throws {ErrorResponseBody} error when the service returns a 404 status code
53
+ * @throws {ErrorResponseBody} error when the service returns a 405 status code
54
+ */
55
+ get(requestConfiguration?: RequestConfiguration<SubscriptionsItemRequestBuilderGetQueryParameters> | undefined): Promise<GetSubscriptionDetailSchema | undefined>;
56
+ /**
57
+ * Permanently deletes a subscription. This endpoint is only available in test mode. For recurring subscriptions that are not already canceled, this will first cancel the subscription on Stripe before deleting it.
58
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
59
+ * @returns {RequestInformation}
60
+ */
61
+ toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
62
+ /**
63
+ * Retrieve Subscription
64
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
65
+ * @returns {RequestInformation}
66
+ */
67
+ toGetRequestInformation(requestConfiguration?: RequestConfiguration<SubscriptionsItemRequestBuilderGetQueryParameters> | undefined): RequestInformation;
68
+ }
69
+ /**
70
+ * Retrieve Subscription
71
+ */
72
+ export interface SubscriptionsItemRequestBuilderGetQueryParameters {
73
+ expand?: GetExpandQueryParameterType[];
74
+ }
75
+ /**
76
+ * Uri template for the request builder.
77
+ */
78
+ export declare const SubscriptionsItemRequestBuilderUriTemplate = "{+baseurl}/api/subscriptions/{id}{?expand}";
79
+ export declare const GetExpandQueryParameterTypeObject: {
80
+ readonly Owner: "owner";
81
+ readonly SubscriptionPlans: "subscriptionPlans";
82
+ };
83
+ /**
84
+ * Metadata for all the navigation properties in the request builder.
85
+ */
86
+ export declare const SubscriptionsItemRequestBuilderNavigationMetadata: Record<Exclude<keyof SubscriptionsItemRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
87
+ /**
88
+ * Metadata for all the requests in the request builder.
89
+ */
90
+ export declare const SubscriptionsItemRequestBuilderRequestsMetadata: RequestsMetadata;
@@ -0,0 +1,33 @@
1
+ import { type GetSubscriptionInvoicesSchema } from '../../../../models/index.js';
2
+ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
3
+ /**
4
+ * Builds and executes requests for operations under /api/subscriptions/{id}/invoices
5
+ */
6
+ export interface InvoicesRequestBuilder extends BaseRequestBuilder<InvoicesRequestBuilder> {
7
+ /**
8
+ * List Subscription Invoices
9
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
10
+ * @returns {Promise<GetSubscriptionInvoicesSchema>}
11
+ * @throws {ErrorResponseBody} error when the service returns a 400 status code
12
+ * @throws {ErrorResponseBody} error when the service returns a 401 status code
13
+ * @throws {ErrorResponseBody} error when the service returns a 403 status code
14
+ * @throws {ErrorResponseBody} error when the service returns a 404 status code
15
+ * @throws {ErrorResponseBody} error when the service returns a 405 status code
16
+ * @throws {ErrorResponseBody} error when the service returns a 500 status code
17
+ */
18
+ get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<GetSubscriptionInvoicesSchema | undefined>;
19
+ /**
20
+ * List Subscription Invoices
21
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
22
+ * @returns {RequestInformation}
23
+ */
24
+ toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
25
+ }
26
+ /**
27
+ * Uri template for the request builder.
28
+ */
29
+ export declare const InvoicesRequestBuilderUriTemplate = "{+baseurl}/api/subscriptions/{id}/invoices";
30
+ /**
31
+ * Metadata for all the requests in the request builder.
32
+ */
33
+ export declare const InvoicesRequestBuilderRequestsMetadata: RequestsMetadata;
@@ -0,0 +1,34 @@
1
+ import { type UpdateSubscriptionItemsRequestSchema } from '../../../../models/index.js';
2
+ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
3
+ /**
4
+ * Builds and executes requests for operations under /api/subscriptions/{id}/items
5
+ */
6
+ export interface ItemsRequestBuilder extends BaseRequestBuilder<ItemsRequestBuilder> {
7
+ /**
8
+ * Add, remove or replace items on a subscription.
9
+ * @param body The request body
10
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
+ * @throws {ErrorResponseBody} error when the service returns a 400 status code
12
+ * @throws {ErrorResponseBody} error when the service returns a 401 status code
13
+ * @throws {ErrorResponseBody} error when the service returns a 403 status code
14
+ * @throws {ErrorResponseBody} error when the service returns a 404 status code
15
+ * @throws {ErrorResponseBody} error when the service returns a 405 status code
16
+ * @throws {ErrorResponseBody} error when the service returns a 500 status code
17
+ */
18
+ put(body: UpdateSubscriptionItemsRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
19
+ /**
20
+ * Add, remove or replace items on a subscription.
21
+ * @param body The request body
22
+ * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
23
+ * @returns {RequestInformation}
24
+ */
25
+ toPutRequestInformation(body: UpdateSubscriptionItemsRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
26
+ }
27
+ /**
28
+ * Uri template for the request builder.
29
+ */
30
+ export declare const ItemsRequestBuilderUriTemplate = "{+baseurl}/api/subscriptions/{id}/items";
31
+ /**
32
+ * Metadata for all the requests in the request builder.
33
+ */
34
+ export declare const ItemsRequestBuilderRequestsMetadata: RequestsMetadata;