@salable/sdk 1.0.22 → 1.0.24

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 (70) hide show
  1. package/dist/index.es.js +397 -151
  2. package/dist/index.es.js.map +1 -1
  3. package/dist/index.js +397 -151
  4. package/dist/index.js.map +1 -1
  5. package/dist/sdk/api/apiKeys/index.d.ts +4 -0
  6. package/dist/sdk/api/apiKeys/item/index.d.ts +2 -16
  7. package/dist/sdk/api/cartItems/index.d.ts +2 -0
  8. package/dist/sdk/api/cartItems/item/index.d.ts +1 -0
  9. package/dist/sdk/api/carts/index.d.ts +3 -2
  10. package/dist/sdk/api/carts/item/checkout/index.d.ts +1 -0
  11. package/dist/sdk/api/carts/item/index.d.ts +3 -0
  12. package/dist/sdk/api/checkout/index.d.ts +3 -2
  13. package/dist/sdk/api/currencyOptions/index.d.ts +2 -1
  14. package/dist/sdk/api/currencyOptions/item/index.d.ts +2 -0
  15. package/dist/sdk/api/destinations/index.d.ts +2 -2
  16. package/dist/sdk/api/destinations/item/index.d.ts +4 -0
  17. package/dist/sdk/api/entitlements/index.d.ts +3 -0
  18. package/dist/sdk/api/entitlements/item/index.d.ts +5 -0
  19. package/dist/sdk/api/eventAttempts/index.d.ts +2 -18
  20. package/dist/sdk/api/events/index.d.ts +2 -0
  21. package/dist/sdk/api/events/item/index.d.ts +2 -0
  22. package/dist/sdk/api/grantees/index.d.ts +3 -0
  23. package/dist/sdk/api/grantees/item/index.d.ts +5 -0
  24. package/dist/sdk/api/groups/index.d.ts +3 -0
  25. package/dist/sdk/api/groups/item/grantees/index.d.ts +1 -0
  26. package/dist/sdk/api/groups/item/index.d.ts +5 -0
  27. package/dist/sdk/api/lineItems/index.d.ts +2 -0
  28. package/dist/sdk/api/lineItems/item/index.d.ts +3 -0
  29. package/dist/sdk/api/memberships/index.d.ts +2 -1
  30. package/dist/sdk/api/memberships/item/index.d.ts +2 -0
  31. package/dist/sdk/api/meters/index.d.ts +2 -0
  32. package/dist/sdk/api/owners/index.d.ts +2 -0
  33. package/dist/sdk/api/owners/item/index.d.ts +15 -1
  34. package/dist/sdk/api/owners/item/portal/index.d.ts +36 -0
  35. package/dist/sdk/api/paymentIntegrations/index.d.ts +5 -0
  36. package/dist/sdk/api/paymentIntegrations/item/onboarding/index.d.ts +1 -0
  37. package/dist/sdk/api/plans/index.d.ts +4 -0
  38. package/dist/sdk/api/plans/item/index.d.ts +5 -0
  39. package/dist/sdk/api/plans/save/index.d.ts +1 -0
  40. package/dist/sdk/api/prices/index.d.ts +2 -0
  41. package/dist/sdk/api/prices/item/index.d.ts +4 -0
  42. package/dist/sdk/api/products/copyToLiveMode/index.d.ts +1 -0
  43. package/dist/sdk/api/products/exportEscaped/item/index.d.ts +1 -0
  44. package/dist/sdk/api/products/importEscaped/index.d.ts +1 -1
  45. package/dist/sdk/api/products/index.d.ts +3 -2
  46. package/dist/sdk/api/products/item/index.d.ts +3 -0
  47. package/dist/sdk/api/receipts/index.d.ts +2 -0
  48. package/dist/sdk/api/receipts/item/index.d.ts +2 -0
  49. package/dist/sdk/api/stripe/accountSession/index.d.ts +1 -0
  50. package/dist/sdk/api/subscriptionPlanLineItems/item/index.d.ts +2 -0
  51. package/dist/sdk/api/subscriptionPlanLineItems/item/sync/index.d.ts +1 -0
  52. package/dist/sdk/api/subscriptionPlans/index.d.ts +17 -3
  53. package/dist/sdk/api/subscriptionPlans/item/index.d.ts +17 -1
  54. package/dist/sdk/api/subscriptionPlans/item/seats/index.d.ts +1 -0
  55. package/dist/sdk/api/subscriptions/batch/index.d.ts +1 -0
  56. package/dist/sdk/api/subscriptions/index.d.ts +2 -0
  57. package/dist/sdk/api/subscriptions/item/autoRenew/index.d.ts +1 -0
  58. package/dist/sdk/api/subscriptions/item/index.d.ts +2 -20
  59. package/dist/sdk/api/subscriptions/item/invoices/index.d.ts +1 -0
  60. package/dist/sdk/api/subscriptions/item/items/index.d.ts +1 -0
  61. package/dist/sdk/api/subscriptions/item/portal/index.d.ts +10 -6
  62. package/dist/sdk/api/tierTags/index.d.ts +3 -1
  63. package/dist/sdk/api/tiers/index.d.ts +2 -1
  64. package/dist/sdk/api/tiers/item/index.d.ts +3 -0
  65. package/dist/sdk/api/usage/record/index.d.ts +5 -2
  66. package/dist/sdk/api/usageRecords/index.d.ts +1 -0
  67. package/dist/sdk/api/webhooks/index.d.ts +2 -2
  68. package/dist/sdk/api/webhooks/item/index.d.ts +6 -0
  69. package/dist/sdk/models/index.d.ts +600 -190
  70. package/package.json +1 -1
@@ -1,28 +1,32 @@
1
- import { type CreatePortalRequestSchema, type CreatePortalResponseSchema } from '../../../../models/index.js';
1
+ import { type CreateSubscriptionPortalRequestSchema, type CreateSubscriptionPortalResponseSchema } from '../../../../models/index.js';
2
2
  import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
3
3
  /**
4
4
  * Builds and executes requests for operations under /api/subscriptions/{id}/portal
5
5
  */
6
6
  export interface PortalRequestBuilder extends BaseRequestBuilder<PortalRequestBuilder> {
7
7
  /**
8
- * Creates a Stripe billing portal session for the specified subscription, returning a URL to redirect the customer to. The portal features available are configured per request.
8
+ * **Deprecated — use [POST /api/owners/{id}/portal](#tag/owners/POST/api/owners/{id}/portal) instead.**Creates a Stripe billing portal session for the specified subscription, returning a URL to redirect the customer to. The portal features available are configured per request.
9
9
  * @param body The request body
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
- * @returns {Promise<CreatePortalResponseSchema>}
11
+ * @returns {Promise<CreateSubscriptionPortalResponseSchema>}
12
12
  * @throws {ErrorResponseBody} error when the service returns a 400 status code
13
13
  * @throws {ErrorResponseBody} error when the service returns a 401 status code
14
14
  * @throws {ErrorResponseBody} error when the service returns a 403 status code
15
15
  * @throws {ErrorResponseBody} error when the service returns a 404 status code
16
16
  * @throws {ErrorResponseBody} error when the service returns a 405 status code
17
+ * @throws {ErrorResponseBody} error when the service returns a 429 status code
18
+ * @throws {ErrorResponseBody} error when the service returns a 500 status code
19
+ * @deprecated
17
20
  */
18
- post(body: CreatePortalRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<CreatePortalResponseSchema | undefined>;
21
+ post(body: CreateSubscriptionPortalRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<CreateSubscriptionPortalResponseSchema | undefined>;
19
22
  /**
20
- * Creates a Stripe billing portal session for the specified subscription, returning a URL to redirect the customer to. The portal features available are configured per request.
23
+ * **Deprecated — use [POST /api/owners/{id}/portal](#tag/owners/POST/api/owners/{id}/portal) instead.**Creates a Stripe billing portal session for the specified subscription, returning a URL to redirect the customer to. The portal features available are configured per request.
21
24
  * @param body The request body
22
25
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
23
26
  * @returns {RequestInformation}
27
+ * @deprecated
24
28
  */
25
- toPostRequestInformation(body: CreatePortalRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
29
+ toPostRequestInformation(body: CreateSubscriptionPortalRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
26
30
  }
27
31
  /**
28
32
  * Uri template for the request builder.
@@ -8,9 +8,10 @@ export interface TierTagsRequestBuilder extends BaseRequestBuilder<TierTagsReque
8
8
  * List Tier Tags
9
9
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
10
10
  * @returns {Promise<GetTierTagsListSchema>}
11
+ * @throws {ErrorResponseBody} error when the service returns a 400 status code
11
12
  * @throws {ErrorResponseBody} error when the service returns a 401 status code
12
- * @throws {ErrorResponseBody} error when the service returns a 403 status code
13
13
  * @throws {ErrorResponseBody} error when the service returns a 405 status code
14
+ * @throws {ErrorResponseBody} error when the service returns a 429 status code
14
15
  * @throws {ErrorResponseBody} error when the service returns a 500 status code
15
16
  */
16
17
  get(requestConfiguration?: RequestConfiguration<TierTagsRequestBuilderGetQueryParameters> | undefined): Promise<GetTierTagsListSchema | undefined>;
@@ -22,6 +23,7 @@ export interface TierTagsRequestBuilder extends BaseRequestBuilder<TierTagsReque
22
23
  * @throws {ErrorResponseBody} error when the service returns a 400 status code
23
24
  * @throws {ErrorResponseBody} error when the service returns a 401 status code
24
25
  * @throws {ErrorResponseBody} error when the service returns a 405 status code
26
+ * @throws {ErrorResponseBody} error when the service returns a 429 status code
25
27
  * @throws {ErrorResponseBody} error when the service returns a 500 status code
26
28
  */
27
29
  post(body: CreateTierTagRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<CreateTierTagSchema | undefined>;
@@ -15,9 +15,10 @@ export interface TiersRequestBuilder extends BaseRequestBuilder<TiersRequestBuil
15
15
  * List Tiers
16
16
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
17
17
  * @returns {Promise<GetTierListSchema>}
18
+ * @throws {ErrorResponseBody} error when the service returns a 400 status code
18
19
  * @throws {ErrorResponseBody} error when the service returns a 401 status code
19
- * @throws {ErrorResponseBody} error when the service returns a 403 status code
20
20
  * @throws {ErrorResponseBody} error when the service returns a 405 status code
21
+ * @throws {ErrorResponseBody} error when the service returns a 429 status code
21
22
  * @throws {ErrorResponseBody} error when the service returns a 500 status code
22
23
  */
23
24
  get(requestConfiguration?: RequestConfiguration<TiersRequestBuilderGetQueryParameters> | undefined): Promise<GetTierListSchema | undefined>;
@@ -8,9 +8,12 @@ export interface TiersItemRequestBuilder extends BaseRequestBuilder<TiersItemReq
8
8
  * Retrieve Tier
9
9
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
10
10
  * @returns {Promise<GetTierDetailSchema>}
11
+ * @throws {ErrorResponseBody} error when the service returns a 400 status code
11
12
  * @throws {ErrorResponseBody} error when the service returns a 401 status code
12
13
  * @throws {ErrorResponseBody} error when the service returns a 403 status code
14
+ * @throws {ErrorResponseBody} error when the service returns a 404 status code
13
15
  * @throws {ErrorResponseBody} error when the service returns a 405 status code
16
+ * @throws {ErrorResponseBody} error when the service returns a 429 status code
14
17
  * @throws {ErrorResponseBody} error when the service returns a 500 status code
15
18
  */
16
19
  get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<GetTierDetailSchema | undefined>;
@@ -5,18 +5,21 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
5
5
  */
6
6
  export interface RecordRequestBuilder extends BaseRequestBuilder<RecordRequestBuilder> {
7
7
  /**
8
- * Increment usage on a line item for an owner. The request will be sent to a queue where it will be processed.
8
+ * Increment usage on a line item for an owner. The request will be sent to a queue where it will be processed. Use /usage-records to confirm the usage was incremented.
9
9
  * @param body The request body
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @throws {ErrorResponseBody} error when the service returns a 400 status code
12
12
  * @throws {ErrorResponseBody} error when the service returns a 401 status code
13
13
  * @throws {ErrorResponseBody} error when the service returns a 403 status code
14
+ * @throws {ErrorResponseBody} error when the service returns a 404 status code
14
15
  * @throws {ErrorResponseBody} error when the service returns a 405 status code
16
+ * @throws {ErrorResponseBody} error when the service returns a 409 status code
17
+ * @throws {ErrorResponseBody} error when the service returns a 429 status code
15
18
  * @throws {ErrorResponseBody} error when the service returns a 500 status code
16
19
  */
17
20
  post(body: RecordUsageRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
18
21
  /**
19
- * Increment usage on a line item for an owner. The request will be sent to a queue where it will be processed.
22
+ * Increment usage on a line item for an owner. The request will be sent to a queue where it will be processed. Use /usage-records to confirm the usage was incremented.
20
23
  * @param body The request body
21
24
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
22
25
  * @returns {RequestInformation}
@@ -14,6 +14,7 @@ export interface UsageRecordsRequestBuilder extends BaseRequestBuilder<UsageReco
14
14
  * @throws {ErrorResponseBody} error when the service returns a 401 status code
15
15
  * @throws {ErrorResponseBody} error when the service returns a 403 status code
16
16
  * @throws {ErrorResponseBody} error when the service returns a 405 status code
17
+ * @throws {ErrorResponseBody} error when the service returns a 429 status code
17
18
  * @throws {ErrorResponseBody} error when the service returns a 500 status code
18
19
  */
19
20
  get(requestConfiguration?: RequestConfiguration<UsageRecordsRequestBuilderGetQueryParameters> | undefined): Promise<GetUsageListSchema | undefined>;
@@ -18,8 +18,8 @@ export interface WebhooksRequestBuilder extends BaseRequestBuilder<WebhooksReque
18
18
  * @returns {Promise<GetWebhookListSchema>}
19
19
  * @throws {ErrorResponseBody} error when the service returns a 400 status code
20
20
  * @throws {ErrorResponseBody} error when the service returns a 401 status code
21
- * @throws {ErrorResponseBody} error when the service returns a 403 status code
22
21
  * @throws {ErrorResponseBody} error when the service returns a 405 status code
22
+ * @throws {ErrorResponseBody} error when the service returns a 429 status code
23
23
  * @throws {ErrorResponseBody} error when the service returns a 500 status code
24
24
  */
25
25
  get(requestConfiguration?: RequestConfiguration<WebhooksRequestBuilderGetQueryParameters> | undefined): Promise<GetWebhookListSchema | undefined>;
@@ -30,8 +30,8 @@ export interface WebhooksRequestBuilder extends BaseRequestBuilder<WebhooksReque
30
30
  * @returns {Promise<CreateWebhookRequestResponseSchema>}
31
31
  * @throws {ErrorResponseBody} error when the service returns a 400 status code
32
32
  * @throws {ErrorResponseBody} error when the service returns a 401 status code
33
- * @throws {ErrorResponseBody} error when the service returns a 403 status code
34
33
  * @throws {ErrorResponseBody} error when the service returns a 405 status code
34
+ * @throws {ErrorResponseBody} error when the service returns a 429 status code
35
35
  * @throws {ErrorResponseBody} error when the service returns a 500 status code
36
36
  */
37
37
  post(body: CreateWebhookRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<CreateWebhookRequestResponseSchema | undefined>;
@@ -11,7 +11,9 @@ export interface WebhooksItemRequestBuilder extends BaseRequestBuilder<WebhooksI
11
11
  * @throws {ErrorResponseBody} error when the service returns a 400 status code
12
12
  * @throws {ErrorResponseBody} error when the service returns a 401 status code
13
13
  * @throws {ErrorResponseBody} error when the service returns a 403 status code
14
+ * @throws {ErrorResponseBody} error when the service returns a 404 status code
14
15
  * @throws {ErrorResponseBody} error when the service returns a 405 status code
16
+ * @throws {ErrorResponseBody} error when the service returns a 429 status code
15
17
  * @throws {ErrorResponseBody} error when the service returns a 500 status code
16
18
  */
17
19
  delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
@@ -22,7 +24,9 @@ export interface WebhooksItemRequestBuilder extends BaseRequestBuilder<WebhooksI
22
24
  * @throws {ErrorResponseBody} error when the service returns a 400 status code
23
25
  * @throws {ErrorResponseBody} error when the service returns a 401 status code
24
26
  * @throws {ErrorResponseBody} error when the service returns a 403 status code
27
+ * @throws {ErrorResponseBody} error when the service returns a 404 status code
25
28
  * @throws {ErrorResponseBody} error when the service returns a 405 status code
29
+ * @throws {ErrorResponseBody} error when the service returns a 429 status code
26
30
  * @throws {ErrorResponseBody} error when the service returns a 500 status code
27
31
  */
28
32
  get(requestConfiguration?: RequestConfiguration<WebhooksItemRequestBuilderGetQueryParameters> | undefined): Promise<GetWebhookDetailSchema | undefined>;
@@ -33,7 +37,9 @@ export interface WebhooksItemRequestBuilder extends BaseRequestBuilder<WebhooksI
33
37
  * @throws {ErrorResponseBody} error when the service returns a 400 status code
34
38
  * @throws {ErrorResponseBody} error when the service returns a 401 status code
35
39
  * @throws {ErrorResponseBody} error when the service returns a 403 status code
40
+ * @throws {ErrorResponseBody} error when the service returns a 404 status code
36
41
  * @throws {ErrorResponseBody} error when the service returns a 405 status code
42
+ * @throws {ErrorResponseBody} error when the service returns a 429 status code
37
43
  * @throws {ErrorResponseBody} error when the service returns a 500 status code
38
44
  */
39
45
  patch(body: UpdateWebhookRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;