@salable/sdk 1.0.47 → 1.0.49

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.
@@ -31,6 +31,11 @@ export interface MessagesRequestBuilderGetQueryParameters {
31
31
  /**
32
32
  * Returns only messages belonging to this conversation ID.
33
33
  */
34
+ conversation?: string;
35
+ /**
36
+ * Deprecated: use `conversation` instead.
37
+ * @deprecated
38
+ */
34
39
  conversationId?: string;
35
40
  /**
36
41
  * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
@@ -40,7 +45,7 @@ export interface MessagesRequestBuilderGetQueryParameters {
40
45
  /**
41
46
  * Uri template for the request builder.
42
47
  */
43
- export declare const MessagesRequestBuilderUriTemplate = "{+baseurl}/api/ai/messages{?after*,before*,conversationId*,limit*}";
48
+ export declare const MessagesRequestBuilderUriTemplate = "{+baseurl}/api/ai/messages{?after*,before*,conversation*,conversationId*,limit*}";
44
49
  /**
45
50
  * Metadata for all the requests in the request builder.
46
51
  */
@@ -76,6 +76,11 @@ export interface CartsRequestBuilderGetQueryParameters {
76
76
  /**
77
77
  * Filter by owner ID. Accepts a comma-separated list of owner IDs.
78
78
  */
79
+ owner?: string[];
80
+ /**
81
+ * Deprecated: use `owner` instead.
82
+ * @deprecated
83
+ */
79
84
  ownerId?: string[];
80
85
  /**
81
86
  * Search carts by ID.
@@ -91,7 +96,7 @@ export type GetStatusQueryParameterType = (typeof GetStatusQueryParameterTypeObj
91
96
  /**
92
97
  * Uri template for the request builder.
93
98
  */
94
- export declare const CartsRequestBuilderUriTemplate = "{+baseurl}/api/carts{?after*,before*,expand,limit*,ownerId,search*,status}";
99
+ export declare const CartsRequestBuilderUriTemplate = "{+baseurl}/api/carts{?after*,before*,expand,limit*,owner,ownerId,search*,status}";
95
100
  /**
96
101
  * Metadata for all the navigation properties in the request builder.
97
102
  */
@@ -43,7 +43,7 @@ export interface CheckoutPostRequestBody extends Parsable {
43
43
  /**
44
44
  * The billing interval for recurring charges (e.g., month, year). Required for subscription mode. Set to null for one-time payments.
45
45
  */
46
- interval?: CheckoutPostRequestBody_interval | null;
46
+ interval?: CheckoutPostRequestBody_intervalMember1 | string | null;
47
47
  /**
48
48
  * The number of intervals between billings. For example, intervalCount of 3 with interval of month represents billing every 3 months.
49
49
  */
@@ -57,7 +57,7 @@ export interface CheckoutPostRequestBody extends Parsable {
57
57
  */
58
58
  owner?: string | null;
59
59
  /**
60
- * Controls whether Stripe always collects a payment method for subscription Checkout or only collects one when payment is due. If any plans contain one-off line items, the payment method collection will fallback to `always`. Defaults to `always`.
60
+ * Whether a card is required at checkout. Applies only when trial days are set on the plan or in the checkout. `always` sets the card to be required, `if_required` sets the checkout to be cardless but cannot be used if any one-off line items are included on the plan. Defaults to the plan's product settings trial card behaviour.
61
61
  */
62
62
  paymentMethodCollection?: CheckoutPostRequestBody_paymentMethodCollection | null;
63
63
  /**
@@ -85,7 +85,9 @@ export interface CheckoutPostRequestBody_discounts extends Parsable {
85
85
  */
86
86
  promotionCode?: string | null;
87
87
  }
88
- export type CheckoutPostRequestBody_interval = (typeof CheckoutPostRequestBody_intervalObject)[keyof typeof CheckoutPostRequestBody_intervalObject];
88
+ export type CheckoutPostRequestBody_interval = CheckoutPostRequestBody_intervalMember1 | string;
89
+ export interface CheckoutPostRequestBody_intervalMember1 extends AdditionalDataHolder, Parsable {
90
+ }
89
91
  /**
90
92
  * Optionally set config for each line item by using the line item slug as the key in the object.
91
93
  */
@@ -140,6 +142,18 @@ export interface CheckoutRequestBuilder extends BaseRequestBuilder<CheckoutReque
140
142
  * @returns {CheckoutPostRequestBody_discounts}
141
143
  */
142
144
  export declare function createCheckoutPostRequestBody_discountsFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
145
+ /**
146
+ * Creates a new instance of the appropriate class based on discriminator value
147
+ * @param parseNode The parse node to use to read the discriminator value and create the object
148
+ * @returns {CheckoutPostRequestBody_intervalMember1 | string}
149
+ */
150
+ export declare function createCheckoutPostRequestBody_intervalFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
151
+ /**
152
+ * Creates a new instance of the appropriate class based on discriminator value
153
+ * @param parseNode The parse node to use to read the discriminator value and create the object
154
+ * @returns {CheckoutPostRequestBody_intervalMember1}
155
+ */
156
+ export declare function createCheckoutPostRequestBody_intervalMember1FromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
143
157
  /**
144
158
  * Creates a new instance of the appropriate class based on discriminator value
145
159
  * @param parseNode The parse node to use to read the discriminator value and create the object
@@ -176,6 +190,18 @@ export declare function deserializeIntoCheckoutPostRequestBody(checkoutPostReque
176
190
  * @returns {Record<string, (node: ParseNode) => void>}
177
191
  */
178
192
  export declare function deserializeIntoCheckoutPostRequestBody_discounts(checkoutPostRequestBody_discounts?: Partial<CheckoutPostRequestBody_discounts> | undefined): Record<string, (node: ParseNode) => void>;
193
+ /**
194
+ * The deserialization information for the current model
195
+ * @param CheckoutPostRequestBody_interval The instance to deserialize into.
196
+ * @returns {Record<string, (node: ParseNode) => void>}
197
+ */
198
+ export declare function deserializeIntoCheckoutPostRequestBody_interval(checkoutPostRequestBody_interval?: Partial<Parsable | CheckoutPostRequestBody_intervalMember1 | string> | undefined): Record<string, (node: ParseNode) => void>;
199
+ /**
200
+ * The deserialization information for the current model
201
+ * @param CheckoutPostRequestBody_intervalMember1 The instance to deserialize into.
202
+ * @returns {Record<string, (node: ParseNode) => void>}
203
+ */
204
+ export declare function deserializeIntoCheckoutPostRequestBody_intervalMember1(checkoutPostRequestBody_intervalMember1?: Partial<CheckoutPostRequestBody_intervalMember1> | undefined): Record<string, (node: ParseNode) => void>;
179
205
  /**
180
206
  * The deserialization information for the current model
181
207
  * @param CheckoutPostRequestBody_metadata The instance to deserialize into.
@@ -208,6 +234,20 @@ export declare function serializeCheckoutPostRequestBody(writer: SerializationWr
208
234
  * @param writer Serialization writer to use to serialize this model
209
235
  */
210
236
  export declare function serializeCheckoutPostRequestBody_discounts(writer: SerializationWriter, checkoutPostRequestBody_discounts?: Partial<CheckoutPostRequestBody_discounts> | undefined | null, isSerializingDerivedType?: boolean): void;
237
+ /**
238
+ * Serializes information the current object
239
+ * @param CheckoutPostRequestBody_interval The instance to serialize from.
240
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
241
+ * @param writer Serialization writer to use to serialize this model
242
+ */
243
+ export declare function serializeCheckoutPostRequestBody_interval(writer: SerializationWriter, checkoutPostRequestBody_interval?: Partial<Parsable | CheckoutPostRequestBody_intervalMember1> | undefined | null, isSerializingDerivedType?: boolean): void;
244
+ /**
245
+ * Serializes information the current object
246
+ * @param CheckoutPostRequestBody_intervalMember1 The instance to serialize from.
247
+ * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
248
+ * @param writer Serialization writer to use to serialize this model
249
+ */
250
+ export declare function serializeCheckoutPostRequestBody_intervalMember1(writer: SerializationWriter, checkoutPostRequestBody_intervalMember1?: Partial<CheckoutPostRequestBody_intervalMember1> | undefined | null, isSerializingDerivedType?: boolean): void;
211
251
  /**
212
252
  * Serializes information the current object
213
253
  * @param CheckoutPostRequestBody_metadata The instance to serialize from.
@@ -385,16 +425,7 @@ export declare const CheckoutPostRequestBody_currencyObject: {
385
425
  readonly OMR: "OMR";
386
426
  };
387
427
  /**
388
- * The billing interval for recurring charges (e.g., month, year). Required for subscription mode. Set to null for one-time payments.
389
- */
390
- export declare const CheckoutPostRequestBody_intervalObject: {
391
- readonly Day: "day";
392
- readonly Week: "week";
393
- readonly Month: "month";
394
- readonly Year: "year";
395
- };
396
- /**
397
- * Controls whether Stripe always collects a payment method for subscription Checkout or only collects one when payment is due. If any plans contain one-off line items, the payment method collection will fallback to `always`. Defaults to `always`.
428
+ * Whether a card is required at checkout. Applies only when trial days are set on the plan or in the checkout. `always` sets the card to be required, `if_required` sets the checkout to be cardless but cannot be used if any one-off line items are included on the plan. Defaults to the plan's product settings trial card behaviour.
398
429
  */
399
430
  export declare const CheckoutPostRequestBody_paymentMethodCollectionObject: {
400
431
  readonly Always: "always";
@@ -43,13 +43,18 @@ export interface CurrencyOptionsRequestBuilderGetQueryParameters {
43
43
  /**
44
44
  * Returns only currency options linked to this price ID.
45
45
  */
46
+ price?: string;
47
+ /**
48
+ * Deprecated: use `price` instead.
49
+ * @deprecated
50
+ */
46
51
  priceId?: string;
47
52
  }
48
53
  export type GetExpandQueryParameterType = (typeof GetExpandQueryParameterTypeObject)[keyof typeof GetExpandQueryParameterTypeObject];
49
54
  /**
50
55
  * Uri template for the request builder.
51
56
  */
52
- export declare const CurrencyOptionsRequestBuilderUriTemplate = "{+baseurl}/api/currency-options{?after*,before*,expand,limit*,priceId*}";
57
+ export declare const CurrencyOptionsRequestBuilderUriTemplate = "{+baseurl}/api/currency-options{?after*,before*,expand,limit*,price*,priceId*}";
53
58
  /**
54
59
  * Metadata for all the navigation properties in the request builder.
55
60
  */
@@ -38,6 +38,11 @@ export interface DestinationsRequestBuilderGetQueryParameters {
38
38
  /**
39
39
  * Returns only destinations linked to this event ID.
40
40
  */
41
+ event?: string;
42
+ /**
43
+ * Deprecated: use `event` instead.
44
+ * @deprecated
45
+ */
41
46
  eventId?: string;
42
47
  /**
43
48
  * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
@@ -47,7 +52,7 @@ export interface DestinationsRequestBuilderGetQueryParameters {
47
52
  /**
48
53
  * Uri template for the request builder.
49
54
  */
50
- export declare const DestinationsRequestBuilderUriTemplate = "{+baseurl}/api/destinations{?after*,before*,eventId*,limit*}";
55
+ export declare const DestinationsRequestBuilderUriTemplate = "{+baseurl}/api/destinations{?after*,before*,event*,eventId*,limit*}";
51
56
  /**
52
57
  * Metadata for all the navigation properties in the request builder.
53
58
  */
@@ -66,13 +66,18 @@ export interface EntitlementsRequestBuilderGetQueryParameters {
66
66
  /**
67
67
  * Returns only entitlements linked to this plan ID.
68
68
  */
69
+ plan?: string;
70
+ /**
71
+ * Deprecated: use `plan` instead.
72
+ * @deprecated
73
+ */
69
74
  planId?: string;
70
75
  search?: string;
71
76
  }
72
77
  /**
73
78
  * Uri template for the request builder.
74
79
  */
75
- export declare const EntitlementsRequestBuilderUriTemplate = "{+baseurl}/api/entitlements{?after*,before*,limit*,planId*,search*}";
80
+ export declare const EntitlementsRequestBuilderUriTemplate = "{+baseurl}/api/entitlements{?after*,before*,limit*,plan*,planId*,search*}";
76
81
  /**
77
82
  * Metadata for all the navigation properties in the request builder.
78
83
  */
@@ -28,6 +28,14 @@ export interface EventAttemptsRequestBuilder extends BaseRequestBuilder<EventAtt
28
28
  export interface EventAttemptsRequestBuilderGetQueryParameters {
29
29
  after?: string;
30
30
  before?: string;
31
+ /**
32
+ * Filter by destination ID.
33
+ */
34
+ destination?: string;
35
+ /**
36
+ * Deprecated: use `destination` instead.
37
+ * @deprecated
38
+ */
31
39
  destinationId?: string;
32
40
  /**
33
41
  * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
@@ -37,7 +45,7 @@ export interface EventAttemptsRequestBuilderGetQueryParameters {
37
45
  /**
38
46
  * Uri template for the request builder.
39
47
  */
40
- export declare const EventAttemptsRequestBuilderUriTemplate = "{+baseurl}/api/event-attempts{?after*,before*,destinationId*,limit*}";
48
+ export declare const EventAttemptsRequestBuilderUriTemplate = "{+baseurl}/api/event-attempts{?after*,before*,destination*,destinationId*,limit*}";
41
49
  /**
42
50
  * Metadata for all the requests in the request builder.
43
51
  */
@@ -57,6 +57,11 @@ export interface GranteesRequestBuilderGetQueryParameters {
57
57
  /**
58
58
  * Returns only grantees belonging to this group ID.
59
59
  */
60
+ group?: string;
61
+ /**
62
+ * Deprecated: use `group` instead.
63
+ * @deprecated
64
+ */
60
65
  groupId?: string;
61
66
  /**
62
67
  * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
@@ -67,7 +72,7 @@ export interface GranteesRequestBuilderGetQueryParameters {
67
72
  /**
68
73
  * Uri template for the request builder.
69
74
  */
70
- export declare const GranteesRequestBuilderUriTemplate = "{+baseurl}/api/grantees{?after*,before*,groupId*,limit*,search*}";
75
+ export declare const GranteesRequestBuilderUriTemplate = "{+baseurl}/api/grantees{?after*,before*,group*,groupId*,limit*,search*}";
71
76
  /**
72
77
  * Metadata for all the navigation properties in the request builder.
73
78
  */
@@ -60,6 +60,9 @@ export interface GroupsRequestBuilderGetQueryParameters {
60
60
  * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
61
61
  */
62
62
  limit?: string;
63
+ /**
64
+ * Filter by owner ID.
65
+ */
63
66
  owner?: string;
64
67
  }
65
68
  /**
@@ -42,13 +42,18 @@ export interface LineItemsRequestBuilderGetQueryParameters {
42
42
  /**
43
43
  * Returns only line items linked to this plan ID.
44
44
  */
45
+ plan?: string;
46
+ /**
47
+ * Deprecated: use `plan` instead.
48
+ * @deprecated
49
+ */
45
50
  planId?: string;
46
51
  search?: string;
47
52
  }
48
53
  /**
49
54
  * Uri template for the request builder.
50
55
  */
51
- export declare const LineItemsRequestBuilderUriTemplate = "{+baseurl}/api/line-items{?after*,before*,limit*,planId*,search*}";
56
+ export declare const LineItemsRequestBuilderUriTemplate = "{+baseurl}/api/line-items{?after*,before*,limit*,plan*,planId*,search*}";
52
57
  /**
53
58
  * Metadata for all the navigation properties in the request builder.
54
59
  */
@@ -34,12 +34,27 @@ export interface MembershipsRequestBuilder extends BaseRequestBuilder<Membership
34
34
  * List Memberships
35
35
  */
36
36
  export interface MembershipsRequestBuilderGetQueryParameters {
37
+ after?: string;
38
+ before?: string;
37
39
  expand?: GetExpandQueryParameterType[];
40
+ /**
41
+ * Returns only memberships linked to this grantee ID.
42
+ */
43
+ grantee?: string;
44
+ /**
45
+ * Deprecated: use `grantee` instead.
46
+ * @deprecated
47
+ */
48
+ granteeId?: string;
49
+ /**
50
+ * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
51
+ */
52
+ limit?: string;
38
53
  }
39
54
  /**
40
55
  * Uri template for the request builder.
41
56
  */
42
- export declare const MembershipsRequestBuilderUriTemplate = "{+baseurl}/api/memberships{?expand}";
57
+ export declare const MembershipsRequestBuilderUriTemplate = "{+baseurl}/api/memberships{?after*,before*,expand,grantee*,granteeId*,limit*}";
43
58
  export declare const GetExpandQueryParameterTypeObject: {
44
59
  readonly Group: "group";
45
60
  };
@@ -42,12 +42,20 @@ export interface OwnersRequestBuilderGetQueryParameters {
42
42
  */
43
43
  limit?: string;
44
44
  search?: string;
45
+ /**
46
+ * Filter by Stripe customer ID.
47
+ */
48
+ stripeCustomer?: string;
49
+ /**
50
+ * Deprecated: use `stripeCustomer` instead.
51
+ * @deprecated
52
+ */
45
53
  stripeCustomerId?: string;
46
54
  }
47
55
  /**
48
56
  * Uri template for the request builder.
49
57
  */
50
- export declare const OwnersRequestBuilderUriTemplate = "{+baseurl}/api/owners{?after*,before*,expand,limit*,search*,stripeCustomerId*}";
58
+ export declare const OwnersRequestBuilderUriTemplate = "{+baseurl}/api/owners{?after*,before*,expand,limit*,search*,stripeCustomer*,stripeCustomerId*}";
51
59
  export declare const GetExpandQueryParameterTypeObject: {
52
60
  readonly Subscriptions: "subscriptions";
53
61
  readonly Receipts: "receipts";
@@ -79,13 +79,18 @@ export interface PlansRequestBuilderGetQueryParameters {
79
79
  /**
80
80
  * Accepts a comma-separated list of product IDs. Returns plans belonging to any of the specified product IDs.
81
81
  */
82
+ product?: string[];
83
+ /**
84
+ * Deprecated: use `product` instead.
85
+ * @deprecated
86
+ */
82
87
  productId?: string[];
83
88
  search?: string;
84
89
  }
85
90
  /**
86
91
  * Uri template for the request builder.
87
92
  */
88
- export declare const PlansRequestBuilderUriTemplate = "{+baseurl}/api/plans{?after*,before*,currency*,expand,includeArchived*,includeFilterOptions*,interval*,intervalCount*,isActive*,limit*,productId,search*}";
93
+ export declare const PlansRequestBuilderUriTemplate = "{+baseurl}/api/plans{?after*,before*,currency*,expand,includeArchived*,includeFilterOptions*,interval*,intervalCount*,isActive*,limit*,product,productId,search*}";
89
94
  export declare const GetCurrencyQueryParameterTypeObject: {
90
95
  readonly USD: "USD";
91
96
  readonly AED: "AED";
@@ -46,19 +46,33 @@ export interface ReceiptsRequestBuilderGetQueryParameters {
46
46
  * The number of records returned in a response. Value between 1 and 100. Defaults to 25.
47
47
  */
48
48
  limit?: string;
49
+ /**
50
+ * Filter by line item ID. Accepts a comma-separated list of line item IDs.
51
+ */
49
52
  lineItems?: string[];
53
+ /**
54
+ * Filter by owner ID. Accepts a comma-separated list of owner IDs.
55
+ */
50
56
  owner?: string[];
57
+ /**
58
+ * Search by receipt ID, owner ID or value, receipt item ID, or line item ID or name.
59
+ */
51
60
  search?: string;
52
61
  sort?: string;
53
62
  /**
54
63
  * Returns only receipts linked to this subscription ID.
55
64
  */
65
+ subscription?: string;
66
+ /**
67
+ * Deprecated: use `subscription` instead.
68
+ * @deprecated
69
+ */
56
70
  subscriptionId?: string;
57
71
  }
58
72
  /**
59
73
  * Uri template for the request builder.
60
74
  */
61
- export declare const ReceiptsRequestBuilderUriTemplate = "{+baseurl}/api/receipts{?after*,before*,expand,limit*,lineItems,owner,search*,sort*,subscriptionId*}";
75
+ export declare const ReceiptsRequestBuilderUriTemplate = "{+baseurl}/api/receipts{?after*,before*,expand,limit*,lineItems,owner,search*,sort*,subscription*,subscriptionId*}";
62
76
  export declare const GetExpandQueryParameterTypeObject: {
63
77
  readonly Owner: "owner";
64
78
  };
@@ -460,7 +460,7 @@ export interface SubscriptionPlansRequestBuilderGetQueryParameters {
460
460
  */
461
461
  limit?: string;
462
462
  /**
463
- * Returns only subscription plans belonging to this owner.
463
+ * Returns only subscription plans belonging to this owner ID.
464
464
  */
465
465
  owner?: string;
466
466
  /**
@@ -304,7 +304,7 @@ export interface SubscriptionsRequestBuilderGetQueryParameters {
304
304
  */
305
305
  limit?: string;
306
306
  /**
307
- * Returns only subscriptions belonging to this owner.
307
+ * Returns only subscriptions belonging to this owner ID.
308
308
  */
309
309
  owner?: string;
310
310
  /**
@@ -314,6 +314,11 @@ export interface SubscriptionsRequestBuilderGetQueryParameters {
314
314
  /**
315
315
  * Returns subscriptions that include a subscription plan line item linked to this price ID.
316
316
  */
317
+ price?: string;
318
+ /**
319
+ * Deprecated: use `price` instead.
320
+ * @deprecated
321
+ */
317
322
  priceId?: string;
318
323
  /**
319
324
  * Accepts a comma-separated list of product IDs. Returns subscriptions that include a plan belonging to any of the specified product IDs.
@@ -334,12 +339,17 @@ export interface SubscriptionsRequestBuilderGetQueryParameters {
334
339
  /**
335
340
  * Returns subscriptions that include a subscription plan line item with this Stripe price ID.
336
341
  */
342
+ stripePrice?: string;
343
+ /**
344
+ * Deprecated: use `stripePrice` instead.
345
+ * @deprecated
346
+ */
337
347
  stripePriceId?: string;
338
348
  }
339
349
  /**
340
350
  * Uri template for the request builder.
341
351
  */
342
- export declare const SubscriptionsRequestBuilderUriTemplate = "{+baseurl}/api/subscriptions{?after*,before*,expand,id*,limit*,owner*,plans,priceId*,products,search*,sort*,status*,stripePriceId*}";
352
+ export declare const SubscriptionsRequestBuilderUriTemplate = "{+baseurl}/api/subscriptions{?after*,before*,expand,id*,limit*,owner*,plans,price*,priceId*,products,search*,sort*,status*,stripePrice*,stripePriceId*}";
343
353
  export declare const GetExpandQueryParameterTypeObject: {
344
354
  readonly Owner: "owner";
345
355
  readonly SubscriptionPlans: "subscriptionPlans";
@@ -36,6 +36,9 @@ export interface UsageRecordsRequestBuilderGetQueryParameters {
36
36
  */
37
37
  limit?: string;
38
38
  meterSlug?: string;
39
+ /**
40
+ * Owner ID to filter usage records by.
41
+ */
39
42
  owner?: string;
40
43
  sort?: GetSortQueryParameterType;
41
44
  status?: GetStatusQueryParameterType[];