@polar-sh/sdk 0.20.0 → 0.20.2

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 (129) hide show
  1. package/README.md +4 -0
  2. package/docs/sdks/polarsubscriptions/README.md +6 -5
  3. package/docs/sdks/subscriptions/README.md +165 -1
  4. package/funcs/customerPortalSubscriptionsUpdate.d.ts +1 -1
  5. package/funcs/customerPortalSubscriptionsUpdate.d.ts.map +1 -1
  6. package/funcs/customerPortalSubscriptionsUpdate.js +2 -2
  7. package/funcs/customerPortalSubscriptionsUpdate.js.map +1 -1
  8. package/funcs/productsList.d.ts.map +1 -1
  9. package/funcs/productsList.js +1 -0
  10. package/funcs/productsList.js.map +1 -1
  11. package/funcs/subscriptionsRevoke.d.ts +17 -0
  12. package/funcs/subscriptionsRevoke.d.ts.map +1 -0
  13. package/funcs/subscriptionsRevoke.js +106 -0
  14. package/funcs/subscriptionsRevoke.js.map +1 -0
  15. package/funcs/subscriptionsUpdate.d.ts +17 -0
  16. package/funcs/subscriptionsUpdate.d.ts.map +1 -0
  17. package/funcs/subscriptionsUpdate.js +109 -0
  18. package/funcs/subscriptionsUpdate.js.map +1 -0
  19. package/lib/config.d.ts +3 -3
  20. package/lib/config.js +3 -3
  21. package/models/components/customercancellationreason.d.ts +46 -0
  22. package/models/components/customercancellationreason.d.ts.map +1 -0
  23. package/models/components/customercancellationreason.js +56 -0
  24. package/models/components/customercancellationreason.js.map +1 -0
  25. package/models/components/customerordersubscription.d.ts +9 -0
  26. package/models/components/customerordersubscription.d.ts.map +1 -1
  27. package/models/components/customerordersubscription.js +17 -0
  28. package/models/components/customerordersubscription.js.map +1 -1
  29. package/models/components/customersubscription.d.ts +9 -0
  30. package/models/components/customersubscription.d.ts.map +1 -1
  31. package/models/components/customersubscription.js +17 -0
  32. package/models/components/customersubscription.js.map +1 -1
  33. package/models/components/customersubscriptioncancel.d.ts +58 -0
  34. package/models/components/customersubscriptioncancel.d.ts.map +1 -0
  35. package/models/components/customersubscriptioncancel.js +79 -0
  36. package/models/components/customersubscriptioncancel.js.map +1 -0
  37. package/models/components/customersubscriptionupdate.d.ts +4 -6
  38. package/models/components/customersubscriptionupdate.d.ts.map +1 -1
  39. package/models/components/customersubscriptionupdate.js +10 -15
  40. package/models/components/customersubscriptionupdate.js.map +1 -1
  41. package/models/components/customersubscriptionupdateprice.d.ts +32 -0
  42. package/models/components/customersubscriptionupdateprice.d.ts.map +1 -0
  43. package/models/components/customersubscriptionupdateprice.js +68 -0
  44. package/models/components/customersubscriptionupdateprice.js.map +1 -0
  45. package/models/components/index.d.ts +7 -0
  46. package/models/components/index.d.ts.map +1 -1
  47. package/models/components/index.js +7 -0
  48. package/models/components/index.js.map +1 -1
  49. package/models/components/ordersubscription.d.ts +9 -0
  50. package/models/components/ordersubscription.d.ts.map +1 -1
  51. package/models/components/ordersubscription.js +17 -0
  52. package/models/components/ordersubscription.js.map +1 -1
  53. package/models/components/subscription.d.ts +9 -0
  54. package/models/components/subscription.d.ts.map +1 -1
  55. package/models/components/subscription.js +17 -0
  56. package/models/components/subscription.js.map +1 -1
  57. package/models/components/subscriptioncancel.d.ts +80 -0
  58. package/models/components/subscriptioncancel.d.ts.map +1 -0
  59. package/models/components/subscriptioncancel.js +79 -0
  60. package/models/components/subscriptioncancel.js.map +1 -0
  61. package/models/components/subscriptionupdate.d.ts +27 -0
  62. package/models/components/subscriptionupdate.d.ts.map +1 -0
  63. package/models/components/subscriptionupdate.js +63 -0
  64. package/models/components/subscriptionupdate.js.map +1 -0
  65. package/models/components/subscriptionupdateprice.d.ts +32 -0
  66. package/models/components/subscriptionupdateprice.d.ts.map +1 -0
  67. package/models/components/subscriptionupdateprice.js +68 -0
  68. package/models/components/subscriptionupdateprice.js.map +1 -0
  69. package/models/components/webhooksubscriptioncanceledpayload.d.ts +2 -2
  70. package/models/components/webhooksubscriptionuncanceledpayload.d.ts +39 -0
  71. package/models/components/webhooksubscriptionuncanceledpayload.d.ts.map +1 -0
  72. package/models/components/webhooksubscriptionuncanceledpayload.js +62 -0
  73. package/models/components/webhooksubscriptionuncanceledpayload.js.map +1 -0
  74. package/models/operations/customerportalsubscriptionscancel.d.ts +1 -1
  75. package/models/operations/customerportalsubscriptionsget.d.ts +1 -1
  76. package/models/operations/customerportalsubscriptionsupdate.d.ts +1 -1
  77. package/models/operations/index.d.ts +2 -0
  78. package/models/operations/index.d.ts.map +1 -1
  79. package/models/operations/index.js +2 -0
  80. package/models/operations/index.js.map +1 -1
  81. package/models/operations/orderslist.d.ts +13 -13
  82. package/models/operations/orderslist.d.ts.map +1 -1
  83. package/models/operations/orderslist.js +16 -16
  84. package/models/operations/orderslist.js.map +1 -1
  85. package/models/operations/productslist.d.ts +29 -0
  86. package/models/operations/productslist.d.ts.map +1 -1
  87. package/models/operations/productslist.js +26 -1
  88. package/models/operations/productslist.js.map +1 -1
  89. package/models/operations/subscriptionsrevoke.d.ts +32 -0
  90. package/models/operations/subscriptionsrevoke.d.ts.map +1 -0
  91. package/models/operations/subscriptionsrevoke.js +59 -0
  92. package/models/operations/subscriptionsrevoke.js.map +1 -0
  93. package/models/operations/subscriptionsupdate.d.ts +35 -0
  94. package/models/operations/subscriptionsupdate.d.ts.map +1 -0
  95. package/models/operations/subscriptionsupdate.js +71 -0
  96. package/models/operations/subscriptionsupdate.js.map +1 -0
  97. package/package.json +1 -1
  98. package/sdk/subscriptions.d.ts +15 -0
  99. package/sdk/subscriptions.d.ts.map +1 -1
  100. package/sdk/subscriptions.js +20 -0
  101. package/sdk/subscriptions.js.map +1 -1
  102. package/src/funcs/customerPortalSubscriptionsUpdate.ts +4 -1
  103. package/src/funcs/productsList.ts +1 -0
  104. package/src/funcs/subscriptionsRevoke.ts +146 -0
  105. package/src/funcs/subscriptionsUpdate.ts +149 -0
  106. package/src/lib/config.ts +3 -3
  107. package/src/models/components/customercancellationreason.ts +41 -0
  108. package/src/models/components/customerordersubscription.ts +37 -0
  109. package/src/models/components/customersubscription.ts +37 -0
  110. package/src/models/components/customersubscriptioncancel.ts +118 -0
  111. package/src/models/components/customersubscriptionupdate.ts +26 -21
  112. package/src/models/components/customersubscriptionupdateprice.ts +80 -0
  113. package/src/models/components/index.ts +7 -0
  114. package/src/models/components/ordersubscription.ts +37 -0
  115. package/src/models/components/subscription.ts +37 -0
  116. package/src/models/components/subscriptioncancel.ts +144 -0
  117. package/src/models/components/subscriptionupdate.ts +78 -0
  118. package/src/models/components/subscriptionupdateprice.ts +78 -0
  119. package/src/models/components/webhooksubscriptioncanceledpayload.ts +2 -2
  120. package/src/models/components/webhooksubscriptionuncanceledpayload.ts +90 -0
  121. package/src/models/operations/customerportalsubscriptionscancel.ts +1 -1
  122. package/src/models/operations/customerportalsubscriptionsget.ts +1 -1
  123. package/src/models/operations/customerportalsubscriptionsupdate.ts +1 -1
  124. package/src/models/operations/index.ts +2 -0
  125. package/src/models/operations/orderslist.ts +28 -21
  126. package/src/models/operations/productslist.ts +60 -0
  127. package/src/models/operations/subscriptionsrevoke.ts +69 -0
  128. package/src/models/operations/subscriptionsupdate.ts +83 -0
  129. package/src/sdk/subscriptions.ts +37 -0
@@ -9,6 +9,11 @@ import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import * as components from "../components/index.js";
10
10
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
11
 
12
+ /**
13
+ * Filter by product ID.
14
+ */
15
+ export type QueryParamProductIDFilter = string | Array<string>;
16
+
12
17
  /**
13
18
  * Filter by organization ID.
14
19
  */
@@ -20,6 +25,10 @@ export type ProductsListQueryParamOrganizationIDFilter = string | Array<string>;
20
25
  export type BenefitIDFilter = string | Array<string>;
21
26
 
22
27
  export type ProductsListRequest = {
28
+ /**
29
+ * Filter by product ID.
30
+ */
31
+ id?: string | Array<string> | null | undefined;
23
32
  /**
24
33
  * Filter by organization ID.
25
34
  */
@@ -58,6 +67,54 @@ export type ProductsListResponse = {
58
67
  result: components.ListResourceProduct;
59
68
  };
60
69
 
70
+ /** @internal */
71
+ export const QueryParamProductIDFilter$inboundSchema: z.ZodType<
72
+ QueryParamProductIDFilter,
73
+ z.ZodTypeDef,
74
+ unknown
75
+ > = z.union([z.string(), z.array(z.string())]);
76
+
77
+ /** @internal */
78
+ export type QueryParamProductIDFilter$Outbound = string | Array<string>;
79
+
80
+ /** @internal */
81
+ export const QueryParamProductIDFilter$outboundSchema: z.ZodType<
82
+ QueryParamProductIDFilter$Outbound,
83
+ z.ZodTypeDef,
84
+ QueryParamProductIDFilter
85
+ > = z.union([z.string(), z.array(z.string())]);
86
+
87
+ /**
88
+ * @internal
89
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
90
+ */
91
+ export namespace QueryParamProductIDFilter$ {
92
+ /** @deprecated use `QueryParamProductIDFilter$inboundSchema` instead. */
93
+ export const inboundSchema = QueryParamProductIDFilter$inboundSchema;
94
+ /** @deprecated use `QueryParamProductIDFilter$outboundSchema` instead. */
95
+ export const outboundSchema = QueryParamProductIDFilter$outboundSchema;
96
+ /** @deprecated use `QueryParamProductIDFilter$Outbound` instead. */
97
+ export type Outbound = QueryParamProductIDFilter$Outbound;
98
+ }
99
+
100
+ export function queryParamProductIDFilterToJSON(
101
+ queryParamProductIDFilter: QueryParamProductIDFilter,
102
+ ): string {
103
+ return JSON.stringify(
104
+ QueryParamProductIDFilter$outboundSchema.parse(queryParamProductIDFilter),
105
+ );
106
+ }
107
+
108
+ export function queryParamProductIDFilterFromJSON(
109
+ jsonString: string,
110
+ ): SafeParseResult<QueryParamProductIDFilter, SDKValidationError> {
111
+ return safeParse(
112
+ jsonString,
113
+ (x) => QueryParamProductIDFilter$inboundSchema.parse(JSON.parse(x)),
114
+ `Failed to parse 'QueryParamProductIDFilter' from JSON`,
115
+ );
116
+ }
117
+
61
118
  /** @internal */
62
119
  export const ProductsListQueryParamOrganizationIDFilter$inboundSchema:
63
120
  z.ZodType<ProductsListQueryParamOrganizationIDFilter, z.ZodTypeDef, unknown> =
@@ -170,6 +227,7 @@ export const ProductsListRequest$inboundSchema: z.ZodType<
170
227
  z.ZodTypeDef,
171
228
  unknown
172
229
  > = z.object({
230
+ id: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),
173
231
  organization_id: z.nullable(z.union([z.string(), z.array(z.string())]))
174
232
  .optional(),
175
233
  query: z.nullable(z.string()).optional(),
@@ -191,6 +249,7 @@ export const ProductsListRequest$inboundSchema: z.ZodType<
191
249
 
192
250
  /** @internal */
193
251
  export type ProductsListRequest$Outbound = {
252
+ id?: string | Array<string> | null | undefined;
194
253
  organization_id?: string | Array<string> | null | undefined;
195
254
  query?: string | null | undefined;
196
255
  is_archived?: boolean | null | undefined;
@@ -207,6 +266,7 @@ export const ProductsListRequest$outboundSchema: z.ZodType<
207
266
  z.ZodTypeDef,
208
267
  ProductsListRequest
209
268
  > = z.object({
269
+ id: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),
210
270
  organizationId: z.nullable(z.union([z.string(), z.array(z.string())]))
211
271
  .optional(),
212
272
  query: z.nullable(z.string()).optional(),
@@ -0,0 +1,69 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { safeParse } from "../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+
10
+ export type SubscriptionsRevokeRequest = {
11
+ /**
12
+ * The subscription ID.
13
+ */
14
+ id: string;
15
+ };
16
+
17
+ /** @internal */
18
+ export const SubscriptionsRevokeRequest$inboundSchema: z.ZodType<
19
+ SubscriptionsRevokeRequest,
20
+ z.ZodTypeDef,
21
+ unknown
22
+ > = z.object({
23
+ id: z.string(),
24
+ });
25
+
26
+ /** @internal */
27
+ export type SubscriptionsRevokeRequest$Outbound = {
28
+ id: string;
29
+ };
30
+
31
+ /** @internal */
32
+ export const SubscriptionsRevokeRequest$outboundSchema: z.ZodType<
33
+ SubscriptionsRevokeRequest$Outbound,
34
+ z.ZodTypeDef,
35
+ SubscriptionsRevokeRequest
36
+ > = z.object({
37
+ id: z.string(),
38
+ });
39
+
40
+ /**
41
+ * @internal
42
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
43
+ */
44
+ export namespace SubscriptionsRevokeRequest$ {
45
+ /** @deprecated use `SubscriptionsRevokeRequest$inboundSchema` instead. */
46
+ export const inboundSchema = SubscriptionsRevokeRequest$inboundSchema;
47
+ /** @deprecated use `SubscriptionsRevokeRequest$outboundSchema` instead. */
48
+ export const outboundSchema = SubscriptionsRevokeRequest$outboundSchema;
49
+ /** @deprecated use `SubscriptionsRevokeRequest$Outbound` instead. */
50
+ export type Outbound = SubscriptionsRevokeRequest$Outbound;
51
+ }
52
+
53
+ export function subscriptionsRevokeRequestToJSON(
54
+ subscriptionsRevokeRequest: SubscriptionsRevokeRequest,
55
+ ): string {
56
+ return JSON.stringify(
57
+ SubscriptionsRevokeRequest$outboundSchema.parse(subscriptionsRevokeRequest),
58
+ );
59
+ }
60
+
61
+ export function subscriptionsRevokeRequestFromJSON(
62
+ jsonString: string,
63
+ ): SafeParseResult<SubscriptionsRevokeRequest, SDKValidationError> {
64
+ return safeParse(
65
+ jsonString,
66
+ (x) => SubscriptionsRevokeRequest$inboundSchema.parse(JSON.parse(x)),
67
+ `Failed to parse 'SubscriptionsRevokeRequest' from JSON`,
68
+ );
69
+ }
@@ -0,0 +1,83 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import * as components from "../components/index.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+
12
+ export type SubscriptionsUpdateRequest = {
13
+ /**
14
+ * The subscription ID.
15
+ */
16
+ id: string;
17
+ subscriptionUpdate: components.SubscriptionUpdate;
18
+ };
19
+
20
+ /** @internal */
21
+ export const SubscriptionsUpdateRequest$inboundSchema: z.ZodType<
22
+ SubscriptionsUpdateRequest,
23
+ z.ZodTypeDef,
24
+ unknown
25
+ > = z.object({
26
+ id: z.string(),
27
+ SubscriptionUpdate: components.SubscriptionUpdate$inboundSchema,
28
+ }).transform((v) => {
29
+ return remap$(v, {
30
+ "SubscriptionUpdate": "subscriptionUpdate",
31
+ });
32
+ });
33
+
34
+ /** @internal */
35
+ export type SubscriptionsUpdateRequest$Outbound = {
36
+ id: string;
37
+ SubscriptionUpdate: components.SubscriptionUpdate$Outbound;
38
+ };
39
+
40
+ /** @internal */
41
+ export const SubscriptionsUpdateRequest$outboundSchema: z.ZodType<
42
+ SubscriptionsUpdateRequest$Outbound,
43
+ z.ZodTypeDef,
44
+ SubscriptionsUpdateRequest
45
+ > = z.object({
46
+ id: z.string(),
47
+ subscriptionUpdate: components.SubscriptionUpdate$outboundSchema,
48
+ }).transform((v) => {
49
+ return remap$(v, {
50
+ subscriptionUpdate: "SubscriptionUpdate",
51
+ });
52
+ });
53
+
54
+ /**
55
+ * @internal
56
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
57
+ */
58
+ export namespace SubscriptionsUpdateRequest$ {
59
+ /** @deprecated use `SubscriptionsUpdateRequest$inboundSchema` instead. */
60
+ export const inboundSchema = SubscriptionsUpdateRequest$inboundSchema;
61
+ /** @deprecated use `SubscriptionsUpdateRequest$outboundSchema` instead. */
62
+ export const outboundSchema = SubscriptionsUpdateRequest$outboundSchema;
63
+ /** @deprecated use `SubscriptionsUpdateRequest$Outbound` instead. */
64
+ export type Outbound = SubscriptionsUpdateRequest$Outbound;
65
+ }
66
+
67
+ export function subscriptionsUpdateRequestToJSON(
68
+ subscriptionsUpdateRequest: SubscriptionsUpdateRequest,
69
+ ): string {
70
+ return JSON.stringify(
71
+ SubscriptionsUpdateRequest$outboundSchema.parse(subscriptionsUpdateRequest),
72
+ );
73
+ }
74
+
75
+ export function subscriptionsUpdateRequestFromJSON(
76
+ jsonString: string,
77
+ ): SafeParseResult<SubscriptionsUpdateRequest, SDKValidationError> {
78
+ return safeParse(
79
+ jsonString,
80
+ (x) => SubscriptionsUpdateRequest$inboundSchema.parse(JSON.parse(x)),
81
+ `Failed to parse 'SubscriptionsUpdateRequest' from JSON`,
82
+ );
83
+ }
@@ -4,7 +4,10 @@
4
4
 
5
5
  import { subscriptionsExport } from "../funcs/subscriptionsExport.js";
6
6
  import { subscriptionsList } from "../funcs/subscriptionsList.js";
7
+ import { subscriptionsRevoke } from "../funcs/subscriptionsRevoke.js";
8
+ import { subscriptionsUpdate } from "../funcs/subscriptionsUpdate.js";
7
9
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
10
+ import * as components from "../models/components/index.js";
8
11
  import * as operations from "../models/operations/index.js";
9
12
  import { unwrapAsync } from "../types/fp.js";
10
13
  import { PageIterator, unwrapResultIterator } from "../types/operations.js";
@@ -45,4 +48,38 @@ export class Subscriptions extends ClientSDK {
45
48
  options,
46
49
  ));
47
50
  }
51
+
52
+ /**
53
+ * Update Subscription
54
+ *
55
+ * @remarks
56
+ * Update a subscription.
57
+ */
58
+ async update(
59
+ request: operations.SubscriptionsUpdateRequest,
60
+ options?: RequestOptions,
61
+ ): Promise<components.Subscription> {
62
+ return unwrapAsync(subscriptionsUpdate(
63
+ this,
64
+ request,
65
+ options,
66
+ ));
67
+ }
68
+
69
+ /**
70
+ * Revoke Subscription
71
+ *
72
+ * @remarks
73
+ * Revoke a subscription, i.e cancel immediately.
74
+ */
75
+ async revoke(
76
+ request: operations.SubscriptionsRevokeRequest,
77
+ options?: RequestOptions,
78
+ ): Promise<components.Subscription> {
79
+ return unwrapAsync(subscriptionsRevoke(
80
+ this,
81
+ request,
82
+ options,
83
+ ));
84
+ }
48
85
  }