@flexprice/sdk 2.1.1 → 2.1.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 (233) hide show
  1. package/docs/sdk/models/billing-cadence.md +1 -3
  2. package/docs/sdk/models/billing-period.md +1 -1
  3. package/docs/sdk/models/changed-invoice.md +17 -0
  4. package/docs/sdk/models/changed-line-item.md +20 -0
  5. package/docs/sdk/models/changed-resources.md +17 -0
  6. package/docs/sdk/models/changed-subscription.md +17 -0
  7. package/docs/sdk/models/create-price-request.md +7 -9
  8. package/docs/sdk/models/create-subscription-request.md +2 -4
  9. package/docs/sdk/models/execute-subscription-change-request.md +2 -2
  10. package/docs/sdk/models/execute-subscription-modify-request-request.md +21 -0
  11. package/docs/sdk/models/execute-subscription-modify-request.md +6 -6
  12. package/docs/sdk/models/invoice-filter.md +1 -0
  13. package/docs/sdk/models/invoice-response.md +1 -0
  14. package/docs/sdk/models/line-item-quantity-change.md +20 -0
  15. package/docs/sdk/models/meter-usage-analytics-request.md +30 -0
  16. package/docs/sdk/models/meter-usage-analytics-response.md +30 -0
  17. package/docs/sdk/models/meter-usage-point.md +21 -0
  18. package/docs/sdk/models/meter-usage-query-request.md +28 -0
  19. package/docs/sdk/models/meter-usage-query-response.md +30 -0
  20. package/docs/sdk/models/preview-subscription-change-request.md +2 -2
  21. package/docs/sdk/models/preview-subscription-modify-request.md +21 -0
  22. package/docs/sdk/models/secret-provider.md +2 -2
  23. package/docs/sdk/models/{execute-subscription-inheritance-request.md → sub-modify-inheritance-request.md} +3 -3
  24. package/docs/sdk/models/sub-modify-quantity-change-request.md +22 -0
  25. package/docs/sdk/models/subscription-change-request.md +1 -1
  26. package/docs/sdk/models/subscription-modify-response.md +25 -0
  27. package/docs/sdk/models/subscription-modify-type.md +15 -0
  28. package/docs/sdk/models/subscription-phase-create-request.md +9 -8
  29. package/docs/sdk/models/subscription-price-create-request.md +3 -5
  30. package/docs/sdk/models/window-size.md +2 -2
  31. package/docs/sdks/invoices/README.md +76 -0
  32. package/docs/sdks/meterusage/README.md +182 -0
  33. package/docs/sdks/prices/README.md +12 -14
  34. package/docs/sdks/subscriptions/README.md +101 -22
  35. package/esm/funcs/invoices-get-meter-usage-preview-invoice.d.ts +17 -0
  36. package/esm/funcs/invoices-get-meter-usage-preview-invoice.d.ts.map +1 -0
  37. package/esm/funcs/invoices-get-meter-usage-preview-invoice.js +82 -0
  38. package/esm/funcs/invoices-get-meter-usage-preview-invoice.js.map +1 -0
  39. package/esm/funcs/meter-usage-get-meter-usage-analytics.d.ts +17 -0
  40. package/esm/funcs/meter-usage-get-meter-usage-analytics.d.ts.map +1 -0
  41. package/esm/funcs/meter-usage-get-meter-usage-analytics.js +82 -0
  42. package/esm/funcs/meter-usage-get-meter-usage-analytics.js.map +1 -0
  43. package/esm/funcs/meter-usage-query-meter-usage.d.ts +17 -0
  44. package/esm/funcs/meter-usage-query-meter-usage.d.ts.map +1 -0
  45. package/esm/funcs/meter-usage-query-meter-usage.js +82 -0
  46. package/esm/funcs/meter-usage-query-meter-usage.js.map +1 -0
  47. package/esm/funcs/subscriptions-execute-subscription-modify.d.ts +3 -3
  48. package/esm/funcs/subscriptions-execute-subscription-modify.d.ts.map +1 -1
  49. package/esm/funcs/subscriptions-execute-subscription-modify.js +4 -4
  50. package/esm/funcs/subscriptions-execute-subscription-modify.js.map +1 -1
  51. package/esm/funcs/subscriptions-preview-subscription-modify.d.ts +17 -0
  52. package/esm/funcs/subscriptions-preview-subscription-modify.d.ts.map +1 -0
  53. package/esm/funcs/subscriptions-preview-subscription-modify.js +92 -0
  54. package/esm/funcs/subscriptions-preview-subscription-modify.js.map +1 -0
  55. package/esm/lib/config.d.ts +3 -3
  56. package/esm/lib/config.js +3 -3
  57. package/esm/lib/config.js.map +1 -1
  58. package/esm/lib/encodings.d.ts +1 -0
  59. package/esm/lib/encodings.d.ts.map +1 -1
  60. package/esm/lib/encodings.js +6 -0
  61. package/esm/lib/encodings.js.map +1 -1
  62. package/esm/sdk/invoices.d.ts +7 -0
  63. package/esm/sdk/invoices.d.ts.map +1 -1
  64. package/esm/sdk/invoices.js +10 -0
  65. package/esm/sdk/invoices.js.map +1 -1
  66. package/esm/sdk/meter-usage.d.ts +19 -0
  67. package/esm/sdk/meter-usage.d.ts.map +1 -0
  68. package/esm/sdk/meter-usage.js +28 -0
  69. package/esm/sdk/meter-usage.js.map +1 -0
  70. package/esm/sdk/models/billing-cadence.d.ts +4 -5
  71. package/esm/sdk/models/billing-cadence.d.ts.map +1 -1
  72. package/esm/sdk/models/billing-cadence.js +3 -4
  73. package/esm/sdk/models/billing-cadence.js.map +1 -1
  74. package/esm/sdk/models/billing-period.d.ts +1 -0
  75. package/esm/sdk/models/billing-period.d.ts.map +1 -1
  76. package/esm/sdk/models/billing-period.js +1 -0
  77. package/esm/sdk/models/billing-period.js.map +1 -1
  78. package/esm/sdk/models/changed-invoice.d.ts +15 -0
  79. package/esm/sdk/models/changed-invoice.d.ts.map +1 -0
  80. package/esm/sdk/models/changed-invoice.js +16 -0
  81. package/esm/sdk/models/changed-invoice.js.map +1 -0
  82. package/esm/sdk/models/changed-line-item.d.ts +18 -0
  83. package/esm/sdk/models/changed-line-item.d.ts.map +1 -0
  84. package/esm/sdk/models/changed-line-item.js +27 -0
  85. package/esm/sdk/models/changed-line-item.js.map +1 -0
  86. package/esm/sdk/models/changed-resources.d.ts +15 -0
  87. package/esm/sdk/models/changed-resources.d.ts.map +1 -0
  88. package/esm/sdk/models/changed-resources.js +24 -0
  89. package/esm/sdk/models/changed-resources.js.map +1 -0
  90. package/esm/sdk/models/changed-subscription.d.ts +16 -0
  91. package/esm/sdk/models/changed-subscription.d.ts.map +1 -0
  92. package/esm/sdk/models/changed-subscription.js +17 -0
  93. package/esm/sdk/models/changed-subscription.js.map +1 -0
  94. package/esm/sdk/models/create-price-request.d.ts +0 -3
  95. package/esm/sdk/models/create-price-request.d.ts.map +1 -1
  96. package/esm/sdk/models/create-price-request.js +0 -3
  97. package/esm/sdk/models/create-price-request.js.map +1 -1
  98. package/esm/sdk/models/create-subscription-request.d.ts +0 -3
  99. package/esm/sdk/models/create-subscription-request.d.ts.map +1 -1
  100. package/esm/sdk/models/create-subscription-request.js +0 -3
  101. package/esm/sdk/models/create-subscription-request.js.map +1 -1
  102. package/esm/sdk/models/execute-subscription-modify-op.d.ts +8 -8
  103. package/esm/sdk/models/execute-subscription-modify-op.d.ts.map +1 -1
  104. package/esm/sdk/models/execute-subscription-modify-op.js +5 -5
  105. package/esm/sdk/models/execute-subscription-modify-op.js.map +1 -1
  106. package/esm/sdk/models/execute-subscription-modify-request.d.ts +19 -0
  107. package/esm/sdk/models/execute-subscription-modify-request.d.ts.map +1 -0
  108. package/esm/sdk/models/execute-subscription-modify-request.js +23 -0
  109. package/esm/sdk/models/execute-subscription-modify-request.js.map +1 -0
  110. package/esm/sdk/models/index.d.ts +16 -1
  111. package/esm/sdk/models/index.d.ts.map +1 -1
  112. package/esm/sdk/models/index.js +16 -1
  113. package/esm/sdk/models/index.js.map +1 -1
  114. package/esm/sdk/models/invoice-filter.d.ts +5 -0
  115. package/esm/sdk/models/invoice-filter.d.ts.map +1 -1
  116. package/esm/sdk/models/invoice-filter.js +2 -0
  117. package/esm/sdk/models/invoice-filter.js.map +1 -1
  118. package/esm/sdk/models/invoice-response.d.ts +7 -0
  119. package/esm/sdk/models/invoice-response.d.ts.map +1 -1
  120. package/esm/sdk/models/invoice-response.js +2 -0
  121. package/esm/sdk/models/invoice-response.js.map +1 -1
  122. package/esm/sdk/models/line-item-quantity-change.d.ts +22 -0
  123. package/esm/sdk/models/line-item-quantity-change.d.ts.map +1 -0
  124. package/esm/sdk/models/line-item-quantity-change.js +19 -0
  125. package/esm/sdk/models/line-item-quantity-change.js.map +1 -0
  126. package/esm/sdk/models/meter-usage-analytics-request.d.ts +26 -0
  127. package/esm/sdk/models/meter-usage-analytics-request.d.ts.map +1 -0
  128. package/esm/sdk/models/meter-usage-analytics-request.js +31 -0
  129. package/esm/sdk/models/meter-usage-analytics-request.js.map +1 -0
  130. package/esm/sdk/models/meter-usage-analytics-response.d.ts +11 -0
  131. package/esm/sdk/models/meter-usage-analytics-response.d.ts.map +1 -0
  132. package/esm/sdk/models/meter-usage-analytics-response.js +15 -0
  133. package/esm/sdk/models/meter-usage-analytics-response.js.map +1 -0
  134. package/esm/sdk/models/meter-usage-point.d.ts +12 -0
  135. package/esm/sdk/models/meter-usage-point.d.ts.map +1 -0
  136. package/esm/sdk/models/meter-usage-point.js +21 -0
  137. package/esm/sdk/models/meter-usage-point.js.map +1 -0
  138. package/esm/sdk/models/meter-usage-query-request.d.ts +26 -0
  139. package/esm/sdk/models/meter-usage-query-request.d.ts.map +1 -0
  140. package/esm/sdk/models/meter-usage-query-request.js +31 -0
  141. package/esm/sdk/models/meter-usage-query-request.js.map +1 -0
  142. package/esm/sdk/models/meter-usage-query-response.d.ts +16 -0
  143. package/esm/sdk/models/meter-usage-query-response.d.ts.map +1 -0
  144. package/esm/sdk/models/meter-usage-query-response.js +28 -0
  145. package/esm/sdk/models/meter-usage-query-response.js.map +1 -0
  146. package/esm/sdk/models/preview-subscription-modify-op.d.ts +21 -0
  147. package/esm/sdk/models/preview-subscription-modify-op.d.ts.map +1 -0
  148. package/esm/sdk/models/preview-subscription-modify-op.js +14 -0
  149. package/esm/sdk/models/preview-subscription-modify-op.js.map +1 -0
  150. package/esm/sdk/models/secret-provider.d.ts +1 -0
  151. package/esm/sdk/models/secret-provider.d.ts.map +1 -1
  152. package/esm/sdk/models/secret-provider.js +1 -0
  153. package/esm/sdk/models/secret-provider.js.map +1 -1
  154. package/esm/sdk/models/sub-modify-inheritance-request.d.ts +12 -0
  155. package/esm/sdk/models/sub-modify-inheritance-request.d.ts.map +1 -0
  156. package/esm/sdk/models/{execute-subscription-inheritance-request.js → sub-modify-inheritance-request.js} +4 -4
  157. package/esm/sdk/models/sub-modify-inheritance-request.js.map +1 -0
  158. package/esm/sdk/models/sub-modify-quantity-change-request.d.ts +13 -0
  159. package/esm/sdk/models/sub-modify-quantity-change-request.d.ts.map +1 -0
  160. package/esm/sdk/models/sub-modify-quantity-change-request.js +18 -0
  161. package/esm/sdk/models/sub-modify-quantity-change-request.js.map +1 -0
  162. package/esm/sdk/models/subscription-modify-response.d.ts +13 -0
  163. package/esm/sdk/models/subscription-modify-response.d.ts.map +1 -0
  164. package/esm/sdk/models/subscription-modify-response.js +22 -0
  165. package/esm/sdk/models/subscription-modify-response.js.map +1 -0
  166. package/esm/sdk/models/subscription-modify-type.d.ts +10 -0
  167. package/esm/sdk/models/subscription-modify-type.d.ts.map +1 -0
  168. package/esm/sdk/models/subscription-modify-type.js +11 -0
  169. package/esm/sdk/models/subscription-modify-type.js.map +1 -0
  170. package/esm/sdk/models/subscription-phase-create-request.d.ts +9 -0
  171. package/esm/sdk/models/subscription-phase-create-request.d.ts.map +1 -1
  172. package/esm/sdk/models/subscription-phase-create-request.js +3 -0
  173. package/esm/sdk/models/subscription-phase-create-request.js.map +1 -1
  174. package/esm/sdk/models/subscription-price-create-request.d.ts +0 -3
  175. package/esm/sdk/models/subscription-price-create-request.d.ts.map +1 -1
  176. package/esm/sdk/models/subscription-price-create-request.js +0 -3
  177. package/esm/sdk/models/subscription-price-create-request.js.map +1 -1
  178. package/esm/sdk/models/window-size.d.ts +1 -1
  179. package/esm/sdk/models/window-size.js +1 -1
  180. package/esm/sdk/models/window-size.js.map +1 -1
  181. package/esm/sdk/sdk.d.ts +3 -0
  182. package/esm/sdk/sdk.d.ts.map +1 -1
  183. package/esm/sdk/sdk.js +5 -0
  184. package/esm/sdk/sdk.js.map +1 -1
  185. package/esm/sdk/subscriptions.d.ts +10 -3
  186. package/esm/sdk/subscriptions.d.ts.map +1 -1
  187. package/esm/sdk/subscriptions.js +12 -2
  188. package/esm/sdk/subscriptions.js.map +1 -1
  189. package/jsr.json +1 -1
  190. package/package.json +1 -1
  191. package/src/funcs/invoices-get-meter-usage-preview-invoice.ts +170 -0
  192. package/src/funcs/meter-usage-get-meter-usage-analytics.ts +170 -0
  193. package/src/funcs/meter-usage-query-meter-usage.ts +170 -0
  194. package/src/funcs/subscriptions-execute-subscription-modify.ts +13 -10
  195. package/src/funcs/subscriptions-preview-subscription-modify.ts +185 -0
  196. package/src/lib/config.ts +3 -3
  197. package/src/lib/encodings.ts +9 -0
  198. package/src/sdk/invoices.ts +18 -0
  199. package/src/sdk/meter-usage.ts +45 -0
  200. package/src/sdk/models/billing-cadence.ts +8 -12
  201. package/src/sdk/models/billing-period.ts +1 -0
  202. package/src/sdk/models/changed-invoice.ts +38 -0
  203. package/src/sdk/models/changed-line-item.ts +55 -0
  204. package/src/sdk/models/changed-resources.ts +55 -0
  205. package/src/sdk/models/changed-subscription.ts +42 -0
  206. package/src/sdk/models/create-price-request.ts +0 -8
  207. package/src/sdk/models/create-subscription-request.ts +0 -8
  208. package/src/sdk/models/execute-subscription-modify-op.ts +22 -20
  209. package/src/sdk/models/execute-subscription-modify-request.ts +63 -0
  210. package/src/sdk/models/index.ts +16 -1
  211. package/src/sdk/models/invoice-filter.ts +7 -0
  212. package/src/sdk/models/invoice-response.ts +9 -0
  213. package/src/sdk/models/line-item-quantity-change.ts +52 -0
  214. package/src/sdk/models/meter-usage-analytics-request.ts +69 -0
  215. package/src/sdk/models/meter-usage-analytics-response.ts +35 -0
  216. package/src/sdk/models/meter-usage-point.ts +43 -0
  217. package/src/sdk/models/meter-usage-query-request.ts +69 -0
  218. package/src/sdk/models/meter-usage-query-response.ts +58 -0
  219. package/src/sdk/models/preview-subscription-modify-op.ts +46 -0
  220. package/src/sdk/models/secret-provider.ts +1 -0
  221. package/src/sdk/models/sub-modify-inheritance-request.ts +41 -0
  222. package/src/sdk/models/sub-modify-quantity-change-request.ts +45 -0
  223. package/src/sdk/models/subscription-modify-response.ts +49 -0
  224. package/src/sdk/models/subscription-modify-type.ts +17 -0
  225. package/src/sdk/models/subscription-phase-create-request.ts +17 -0
  226. package/src/sdk/models/subscription-price-create-request.ts +0 -8
  227. package/src/sdk/models/window-size.ts +1 -1
  228. package/src/sdk/sdk.ts +6 -0
  229. package/src/sdk/subscriptions.ts +24 -4
  230. package/esm/sdk/models/execute-subscription-inheritance-request.d.ts +0 -12
  231. package/esm/sdk/models/execute-subscription-inheritance-request.d.ts.map +0 -1
  232. package/esm/sdk/models/execute-subscription-inheritance-request.js.map +0 -1
  233. package/src/sdk/models/execute-subscription-inheritance-request.ts +0 -42
package/docs/sdk/models/billing-cadence.md CHANGED
@@ -6,12 +6,10 @@
6
6
  import { BillingCadence } from "@flexprice/sdk/sdk/models";
7
7
 
8
8
  let value: BillingCadence = "RECURRING";
9
-
10
- // Open enum: unrecognized values are captured as Unrecognized<string>
11
9
  ```
12
10
 
13
11
  ## Values
14
12
 
15
13
  ```typescript
16
- "RECURRING" | "ONETIME" | Unrecognized<string>
14
+ "RECURRING"
17
15
  ```
package/docs/sdk/models/billing-period.md CHANGED
@@ -13,5 +13,5 @@ let value: BillingPeriod = "MONTHLY";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "MONTHLY" | "ANNUAL" | "WEEKLY" | "DAILY" | "QUARTERLY" | "HALF_YEARLY" | Unrecognized<string>
16
+ "MONTHLY" | "ANNUAL" | "WEEKLY" | "DAILY" | "QUARTERLY" | "HALF_YEARLY" | "ONETIME" | Unrecognized<string>
17
17
  ```
package/docs/sdk/models/changed-invoice.md ADDED
@@ -0,0 +1,17 @@
1
+ # ChangedInvoice
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ChangedInvoice } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ChangedInvoice = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------- | --------------------------- | --------------------------- | --------------------------- |
15
+ | `action` | *string* | :heavy_minus_sign: | "created" \| "wallet_credit" |
16
+ | `id` | *string* | :heavy_minus_sign: | N/A |
17
+ | `status` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/changed-line-item.md ADDED
@@ -0,0 +1,20 @@
1
+ # ChangedLineItem
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ChangedLineItem } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ChangedLineItem = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `changeAction` | *string* | :heavy_minus_sign: | "created" \| "updated" \| "ended" |
16
+ | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
17
+ | `id` | *string* | :heavy_minus_sign: | N/A |
18
+ | `priceId` | *string* | :heavy_minus_sign: | N/A |
19
+ | `quantity` | *string* | :heavy_minus_sign: | N/A |
20
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/changed-resources.md ADDED
@@ -0,0 +1,17 @@
1
+ # ChangedResources
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ChangedResources } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ChangedResources = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
15
+ | `invoices` | [models.ChangedInvoice](../../sdk/models/changed-invoice.md)[] | :heavy_minus_sign: | N/A |
16
+ | `lineItems` | [models.ChangedLineItem](../../sdk/models/changed-line-item.md)[] | :heavy_minus_sign: | N/A |
17
+ | `subscriptions` | [models.ChangedSubscription](../../sdk/models/changed-subscription.md)[] | :heavy_minus_sign: | N/A |
package/docs/sdk/models/changed-subscription.md ADDED
@@ -0,0 +1,17 @@
1
+ # ChangedSubscription
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ChangedSubscription } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ChangedSubscription = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
15
+ | `action` | *string* | :heavy_minus_sign: | "created" \| "updated" |
16
+ | `id` | *string* | :heavy_minus_sign: | N/A |
17
+ | `status` | [models.SubscriptionStatus](../../sdk/models/subscription-status.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-price-request.md CHANGED
@@ -6,15 +6,14 @@
6
6
  import { CreatePriceRequest } from "@flexprice/sdk/sdk/models";
7
7
 
8
8
  let value: CreatePriceRequest = {
9
- billingCadence: "RECURRING",
10
- billingModel: "FLAT_FEE",
11
- billingPeriod: "QUARTERLY",
12
- currency: "Namibia Dollar",
9
+ billingModel: "PACKAGE",
10
+ billingPeriod: "ANNUAL",
11
+ currency: "Swedish Krona",
13
12
  entityId: "<id>",
14
- entityType: "PRICE",
15
- invoiceCadence: "ARREAR",
16
- priceUnitType: "CUSTOM",
17
- type: "USAGE",
13
+ entityType: "COSTSHEET",
14
+ invoiceCadence: "ADVANCE",
15
+ priceUnitType: "FIAT",
16
+ type: "FIXED",
18
17
  };
19
18
  ```
20
19
 
@@ -23,7 +22,6 @@ let value: CreatePriceRequest = {
23
22
  | Field | Type | Required | Description |
24
23
  | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
25
24
  | `amount` | *string* | :heavy_minus_sign: | N/A |
26
- | `billingCadence` | [models.BillingCadence](../../sdk/models/billing-cadence.md) | :heavy_check_mark: | N/A |
27
25
  | `billingModel` | [models.BillingModel](../../sdk/models/billing-model.md) | :heavy_check_mark: | N/A |
28
26
  | `billingPeriod` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_check_mark: | N/A |
29
27
  | `billingPeriodCount` | *number* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-subscription-request.md CHANGED
@@ -6,9 +6,8 @@
6
6
  import { CreateSubscriptionRequest } from "@flexprice/sdk/sdk/models";
7
7
 
8
8
  let value: CreateSubscriptionRequest = {
9
- billingCadence: "ONETIME",
10
- billingPeriod: "HALF_YEARLY",
11
- currency: "Zimbabwe Dollar",
9
+ billingPeriod: "ONETIME",
10
+ currency: "East Caribbean Dollar",
12
11
  planId: "<id>",
13
12
  };
14
13
  ```
@@ -18,7 +17,6 @@ let value: CreateSubscriptionRequest = {
18
17
  | Field | Type | Required | Description |
19
18
  | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
20
19
  | `addons` | [models.AddAddonToSubscriptionRequest](../../sdk/models/add-addon-to-subscription-request.md)[] | :heavy_minus_sign: | Addons represents addons to be added to the subscription during creation |
21
- | `billingCadence` | [models.BillingCadence](../../sdk/models/billing-cadence.md) | :heavy_check_mark: | N/A |
22
20
  | `billingCycle` | [models.BillingCycle](../../sdk/models/billing-cycle.md) | :heavy_minus_sign: | N/A |
23
21
  | `billingPeriod` | [models.BillingPeriod](../../sdk/models/billing-period.md) | :heavy_check_mark: | N/A |
24
22
  | `billingPeriodCount` | *number* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/execute-subscription-change-request.md CHANGED
@@ -10,8 +10,8 @@ let value: ExecuteSubscriptionChangeRequest = {
10
10
  body: {
11
11
  billingCadence: "RECURRING",
12
12
  billingCycle: "anniversary",
13
- billingPeriod: "QUARTERLY",
14
- prorationBehavior: "create_prorations",
13
+ billingPeriod: "WEEKLY",
14
+ prorationBehavior: "none",
15
15
  targetPlanId: "<id>",
16
16
  },
17
17
  };
package/docs/sdk/models/execute-subscription-modify-request-request.md ADDED
@@ -0,0 +1,21 @@
1
+ # ExecuteSubscriptionModifyRequestRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ExecuteSubscriptionModifyRequestRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ExecuteSubscriptionModifyRequestRequest = {
9
+ id: "<id>",
10
+ body: {
11
+ type: "quantity_change",
12
+ },
13
+ };
14
+ ```
15
+
16
+ ## Fields
17
+
18
+ | Field | Type | Required | Description |
19
+ | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
20
+ | `id` | *string* | :heavy_check_mark: | Subscription ID |
21
+ | `body` | [models.ExecuteSubscriptionModifyRequest](../../sdk/models/execute-subscription-modify-request.md) | :heavy_check_mark: | Modification request |
package/docs/sdk/models/execute-subscription-modify-request.md CHANGED
@@ -6,14 +6,14 @@
6
6
  import { ExecuteSubscriptionModifyRequest } from "@flexprice/sdk/sdk/models";
7
7
 
8
8
  let value: ExecuteSubscriptionModifyRequest = {
9
- id: "<id>",
10
- body: {},
9
+ type: "quantity_change",
11
10
  };
12
11
  ```
13
12
 
14
13
  ## Fields
15
14
 
16
- | Field | Type | Required | Description |
17
- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
18
- | `id` | *string* | :heavy_check_mark: | Subscription ID |
19
- | `body` | [models.ExecuteSubscriptionInheritanceRequest](../../sdk/models/execute-subscription-inheritance-request.md) | :heavy_check_mark: | External customer IDs to inherit |
15
+ | Field | Type | Required | Description |
16
+ | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
17
+ | `inheritanceParams` | [models.SubModifyInheritanceRequest](../../sdk/models/sub-modify-inheritance-request.md) | :heavy_minus_sign: | N/A |
18
+ | `quantityChangeParams` | [models.SubModifyQuantityChangeRequest](../../sdk/models/sub-modify-quantity-change-request.md) | :heavy_minus_sign: | N/A |
19
+ | `type` | [models.SubscriptionModifyType](../../sdk/models/subscription-modify-type.md) | :heavy_check_mark: | N/A |
package/docs/sdk/models/invoice-filter.md CHANGED
@@ -34,4 +34,5 @@ let value: InvoiceFilter = {};
34
34
  | `sort` | [models.SortCondition](../../sdk/models/sort-condition.md)[] | :heavy_minus_sign: | N/A |
35
35
  | `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
36
36
  | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
37
+ | `subscriptionCustomerId` | *string*[] | :heavy_minus_sign: | subscription_customer_id filters invoices by the subscription owner's customer ID |
37
38
  | `subscriptionId` | *string* | :heavy_minus_sign: | subscription_id filters invoices generated for a specific subscription<br/>Only returns invoices that were created as part of the specified subscription's billing |
package/docs/sdk/models/invoice-response.md CHANGED
@@ -56,6 +56,7 @@ let value: InvoiceResponse = {
56
56
  | `refundedAmount` | *string* | :heavy_minus_sign: | refunded_amount is the total sum of credit notes of type "refund".<br/>These are actual refunds issued to the customer. |
57
57
  | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
58
58
  | `subscription` | [models.SubscriptionResponse](../../sdk/models/subscription-response.md) | :heavy_minus_sign: | N/A |
59
+ | `subscriptionCustomerId` | *string* | :heavy_minus_sign: | subscription_customer_id is the subscription owner's customer ID (Subscription.CustomerID).<br/>It may differ from customer_id when the subscription uses an invoicing customer. Set internally; nullable in DB. |
59
60
  | `subscriptionId` | *string* | :heavy_minus_sign: | subscription_id is the ID of the subscription this invoice is associated with (only present for subscription-based invoices) |
60
61
  | `subtotal` | *string* | :heavy_minus_sign: | subtotal is the sum of all line items before any taxes, discounts, or additional fees |
61
62
  | `taxes` | [models.TaxAppliedResponse](../../sdk/models/tax-applied-response.md)[] | :heavy_minus_sign: | tax_applied_records contains the tax applied records associated with this invoice |
package/docs/sdk/models/line-item-quantity-change.md ADDED
@@ -0,0 +1,20 @@
1
+ # LineItemQuantityChange
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { LineItemQuantityChange } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: LineItemQuantityChange = {
9
+ id: "<id>",
10
+ quantity: "<value>",
11
+ };
12
+ ```
13
+
14
+ ## Fields
15
+
16
+ | Field | Type | Required | Description |
17
+ | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
18
+ | `effectiveDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | EffectiveDate is when the quantity change takes effect.<br/>If omitted, the change is effective immediately (now). |
19
+ | `id` | *string* | :heavy_check_mark: | N/A |
20
+ | `quantity` | *string* | :heavy_check_mark: | N/A |
package/docs/sdk/models/meter-usage-analytics-request.md ADDED
@@ -0,0 +1,30 @@
1
+ # MeterUsageAnalyticsRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { MeterUsageAnalyticsRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: MeterUsageAnalyticsRequest = {
9
+ aggregationType: "SUM",
10
+ endTime: new Date("2024-02-01T00:00:00Z"),
11
+ externalCustomerId: "cust_123",
12
+ meterIds: [
13
+ "mtr_abc",
14
+ "mtr_def",
15
+ ],
16
+ startTime: new Date("2024-01-01T00:00:00Z"),
17
+ };
18
+ ```
19
+
20
+ ## Fields
21
+
22
+ | Field | Type | Required | Description | Example |
23
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
24
+ | `aggregationType` | [models.AggregationType](../../sdk/models/aggregation-type.md) | :heavy_check_mark: | N/A | |
25
+ | `billingAnchor` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | |
26
+ | `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | 2024-02-01T00:00:00Z |
27
+ | `externalCustomerId` | *string* | :heavy_check_mark: | N/A | cust_123 |
28
+ | `meterIds` | *string*[] | :heavy_check_mark: | N/A | [<br/>"mtr_abc",<br/>"mtr_def"<br/>] |
29
+ | `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | 2024-01-01T00:00:00Z |
30
+ | `windowSize` | [models.WindowSize](../../sdk/models/window-size.md) | :heavy_minus_sign: | N/A | |
package/docs/sdk/models/meter-usage-analytics-response.md ADDED
@@ -0,0 +1,30 @@
1
+ # MeterUsageAnalyticsResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { MeterUsageAnalyticsResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: MeterUsageAnalyticsResponse = {
9
+ items: [
10
+ {
11
+ eventCount: 42,
12
+ meterId: "mtr_abc",
13
+ points: [
14
+ {
15
+ eventCount: 10,
16
+ timestamp: "2024-01-01T00:00:00Z",
17
+ value: "100.0000",
18
+ },
19
+ ],
20
+ totalValue: "1234.5678",
21
+ },
22
+ ],
23
+ };
24
+ ```
25
+
26
+ ## Fields
27
+
28
+ | Field | Type | Required | Description |
29
+ | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
30
+ | `items` | [models.MeterUsageQueryResponse](../../sdk/models/meter-usage-query-response.md)[] | :heavy_minus_sign: | N/A |
package/docs/sdk/models/meter-usage-point.md ADDED
@@ -0,0 +1,21 @@
1
+ # MeterUsagePoint
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { MeterUsagePoint } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: MeterUsagePoint = {
9
+ eventCount: 10,
10
+ timestamp: "2024-01-01T00:00:00Z",
11
+ value: "100.0000",
12
+ };
13
+ ```
14
+
15
+ ## Fields
16
+
17
+ | Field | Type | Required | Description | Example |
18
+ | -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
19
+ | `eventCount` | *number* | :heavy_minus_sign: | N/A | 10 |
20
+ | `timestamp` | *string* | :heavy_minus_sign: | N/A | 2024-01-01T00:00:00Z |
21
+ | `value` | *string* | :heavy_minus_sign: | N/A | 100.0000 |
package/docs/sdk/models/meter-usage-query-request.md ADDED
@@ -0,0 +1,28 @@
1
+ # MeterUsageQueryRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { MeterUsageQueryRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: MeterUsageQueryRequest = {
9
+ aggregationType: "MAX",
10
+ billingAnchor: new Date("2024-01-15T00:00:00Z"),
11
+ endTime: new Date("2024-02-01T00:00:00Z"),
12
+ externalCustomerId: "cust_123",
13
+ meterId: "mtr_abc",
14
+ startTime: new Date("2024-01-01T00:00:00Z"),
15
+ };
16
+ ```
17
+
18
+ ## Fields
19
+
20
+ | Field | Type | Required | Description | Example |
21
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
22
+ | `aggregationType` | [models.AggregationType](../../sdk/models/aggregation-type.md) | :heavy_check_mark: | N/A | |
23
+ | `billingAnchor` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | 2024-01-15T00:00:00Z |
24
+ | `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | 2024-02-01T00:00:00Z |
25
+ | `externalCustomerId` | *string* | :heavy_check_mark: | N/A | cust_123 |
26
+ | `meterId` | *string* | :heavy_check_mark: | N/A | mtr_abc |
27
+ | `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | 2024-01-01T00:00:00Z |
28
+ | `windowSize` | [models.WindowSize](../../sdk/models/window-size.md) | :heavy_minus_sign: | N/A | |
package/docs/sdk/models/meter-usage-query-response.md ADDED
@@ -0,0 +1,30 @@
1
+ # MeterUsageQueryResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { MeterUsageQueryResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: MeterUsageQueryResponse = {
9
+ eventCount: 42,
10
+ meterId: "mtr_abc",
11
+ points: [
12
+ {
13
+ eventCount: 10,
14
+ timestamp: "2024-01-01T00:00:00Z",
15
+ value: "100.0000",
16
+ },
17
+ ],
18
+ totalValue: "1234.5678",
19
+ };
20
+ ```
21
+
22
+ ## Fields
23
+
24
+ | Field | Type | Required | Description | Example |
25
+ | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
26
+ | `aggregationType` | [models.AggregationType](../../sdk/models/aggregation-type.md) | :heavy_minus_sign: | N/A | |
27
+ | `eventCount` | *number* | :heavy_minus_sign: | N/A | 42 |
28
+ | `meterId` | *string* | :heavy_minus_sign: | N/A | mtr_abc |
29
+ | `points` | [models.MeterUsagePoint](../../sdk/models/meter-usage-point.md)[] | :heavy_minus_sign: | N/A | |
30
+ | `totalValue` | *string* | :heavy_minus_sign: | N/A | 1234.5678 |
package/docs/sdk/models/preview-subscription-change-request.md CHANGED
@@ -10,8 +10,8 @@ let value: PreviewSubscriptionChangeRequest = {
10
10
  body: {
11
11
  billingCadence: "RECURRING",
12
12
  billingCycle: "anniversary",
13
- billingPeriod: "QUARTERLY",
14
- prorationBehavior: "create_prorations",
13
+ billingPeriod: "WEEKLY",
14
+ prorationBehavior: "none",
15
15
  targetPlanId: "<id>",
16
16
  },
17
17
  };
package/docs/sdk/models/preview-subscription-modify-request.md ADDED
@@ -0,0 +1,21 @@
1
+ # PreviewSubscriptionModifyRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { PreviewSubscriptionModifyRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: PreviewSubscriptionModifyRequest = {
9
+ id: "<id>",
10
+ body: {
11
+ type: "quantity_change",
12
+ },
13
+ };
14
+ ```
15
+
16
+ ## Fields
17
+
18
+ | Field | Type | Required | Description |
19
+ | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
20
+ | `id` | *string* | :heavy_check_mark: | Subscription ID |
21
+ | `body` | [models.ExecuteSubscriptionModifyRequest](../../sdk/models/execute-subscription-modify-request.md) | :heavy_check_mark: | Modification preview request |
package/docs/sdk/models/secret-provider.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ```typescript
6
6
  import { SecretProvider } from "@flexprice/sdk/sdk/models";
7
7
 
8
- let value: SecretProvider = "chargebee";
8
+ let value: SecretProvider = "quickbooks";
9
9
 
10
10
  // Open enum: unrecognized values are captured as Unrecognized<string>
11
11
  ```
@@ -13,5 +13,5 @@ let value: SecretProvider = "chargebee";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "flexprice" | "stripe" | "s3" | "hubspot" | "razorpay" | "chargebee" | "quickbooks" | "nomod" | "moyasar" | "paddle" | Unrecognized<string>
16
+ "flexprice" | "stripe" | "s3" | "hubspot" | "razorpay" | "chargebee" | "quickbooks" | "zoho_books" | "nomod" | "moyasar" | "paddle" | Unrecognized<string>
17
17
  ```
package/docs/sdk/models/{execute-subscription-inheritance-request.md → sub-modify-inheritance-request.md} RENAMED
@@ -1,11 +1,11 @@
1
- # ExecuteSubscriptionInheritanceRequest
1
+ # SubModifyInheritanceRequest
2
2
 
3
3
  ## Example Usage
4
4
 
5
5
  ```typescript
6
- import { ExecuteSubscriptionInheritanceRequest } from "@flexprice/sdk/sdk/models";
6
+ import { SubModifyInheritanceRequest } from "@flexprice/sdk/sdk/models";
7
7
 
8
- let value: ExecuteSubscriptionInheritanceRequest = {};
8
+ let value: SubModifyInheritanceRequest = {};
9
9
  ```
10
10
 
11
11
  ## Fields
package/docs/sdk/models/sub-modify-quantity-change-request.md ADDED
@@ -0,0 +1,22 @@
1
+ # SubModifyQuantityChangeRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SubModifyQuantityChangeRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: SubModifyQuantityChangeRequest = {
9
+ lineItems: [
10
+ {
11
+ id: "<id>",
12
+ quantity: "<value>",
13
+ },
14
+ ],
15
+ };
16
+ ```
17
+
18
+ ## Fields
19
+
20
+ | Field | Type | Required | Description |
21
+ | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
22
+ | `lineItems` | [models.LineItemQuantityChange](../../sdk/models/line-item-quantity-change.md)[] | :heavy_check_mark: | N/A |
package/docs/sdk/models/subscription-change-request.md CHANGED
@@ -10,7 +10,7 @@ import { SubscriptionChangeRequest } from "@flexprice/sdk/sdk/models";
10
10
  let value: SubscriptionChangeRequest = {
11
11
  billingCadence: "RECURRING",
12
12
  billingCycle: "anniversary",
13
- billingPeriod: "MONTHLY",
13
+ billingPeriod: "ANNUAL",
14
14
  prorationBehavior: "create_prorations",
15
15
  targetPlanId: "<id>",
16
16
  };
package/docs/sdk/models/subscription-modify-response.md ADDED
@@ -0,0 +1,25 @@
1
+ # SubscriptionModifyResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SubscriptionModifyResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: SubscriptionModifyResponse = {
9
+ subscription: {
10
+ latestInvoice: {
11
+ subscription: {
12
+ plan: {},
13
+ },
14
+ },
15
+ plan: {},
16
+ },
17
+ };
18
+ ```
19
+
20
+ ## Fields
21
+
22
+ | Field | Type | Required | Description |
23
+ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
24
+ | `changedResources` | [models.ChangedResources](../../sdk/models/changed-resources.md) | :heavy_minus_sign: | N/A |
25
+ | `subscription` | [models.SubscriptionResponse](../../sdk/models/subscription-response.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/subscription-modify-type.md ADDED
@@ -0,0 +1,15 @@
1
+ # SubscriptionModifyType
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { SubscriptionModifyType } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: SubscriptionModifyType = "quantity_change";
9
+ ```
10
+
11
+ ## Values
12
+
13
+ ```typescript
14
+ "inheritance" | "quantity_change"
15
+ ```