@flexprice/sdk 2.1.37 → 2.1.38

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 (184) hide show
  1. package/FUNCTIONS.md +3 -6
  2. package/USAGE.md +1 -4
  3. package/docs/sdk/models/activity-actor.md +17 -0
  4. package/docs/sdk/models/activity-entity.md +17 -0
  5. package/docs/sdk/models/activity-pagination.md +17 -0
  6. package/docs/sdk/models/activity-response.md +25 -0
  7. package/docs/sdk/models/add-addon-to-subscription-response.md +22 -21
  8. package/docs/sdk/models/addon-association-response.md +22 -21
  9. package/docs/sdk/models/addon-price-sync-status-response.md +17 -0
  10. package/docs/sdk/models/addon-response.md +1 -0
  11. package/docs/sdk/models/cancel-subscription-request.md +1 -1
  12. package/docs/sdk/models/changed-addon-association.md +2 -1
  13. package/docs/sdk/models/changed-line-item.md +2 -1
  14. package/docs/sdk/models/checkout-configuration.md +1 -0
  15. package/docs/sdk/models/create-addon-response.md +1 -0
  16. package/docs/sdk/models/create-customer-request.md +1 -6
  17. package/docs/sdk/models/get-activity-request.md +17 -0
  18. package/docs/sdk/models/grouped-invoicing-action.md +2 -2
  19. package/docs/sdk/models/grouped-invoicing-change.md +16 -0
  20. package/docs/sdk/models/list-activity-request.md +26 -0
  21. package/docs/sdk/models/list-activity-response.md +16 -0
  22. package/docs/sdk/models/payment-terms.md +1 -1
  23. package/docs/sdk/models/state.md +14 -0
  24. package/docs/sdk/models/sub-modify-grouped-invoicing-params.md +7 -6
  25. package/docs/sdk/models/sync-addon-prices-request.md +17 -0
  26. package/docs/sdk/models/update-customer-request-request.md +1 -7
  27. package/docs/sdk/models/update-customer-request.md +2 -4
  28. package/docs/sdks/activity/README.md +150 -0
  29. package/docs/sdks/addons/README.md +72 -0
  30. package/docs/sdks/customers/README.md +2 -8
  31. package/esm/funcs/activity-get-activity.d.ts +17 -0
  32. package/esm/funcs/activity-get-activity.d.ts.map +1 -0
  33. package/esm/funcs/activity-get-activity.js +91 -0
  34. package/esm/funcs/activity-get-activity.js.map +1 -0
  35. package/esm/funcs/activity-list-activity.d.ts +17 -0
  36. package/esm/funcs/activity-list-activity.d.ts.map +1 -0
  37. package/esm/funcs/activity-list-activity.js +83 -0
  38. package/esm/funcs/activity-list-activity.js.map +1 -0
  39. package/esm/funcs/addons-sync-addon-prices.d.ts +17 -0
  40. package/esm/funcs/addons-sync-addon-prices.d.ts.map +1 -0
  41. package/esm/funcs/addons-sync-addon-prices.js +91 -0
  42. package/esm/funcs/addons-sync-addon-prices.js.map +1 -0
  43. package/esm/lib/config.d.ts +2 -2
  44. package/esm/lib/config.js +2 -2
  45. package/esm/sdk/activity.d.ts +19 -0
  46. package/esm/sdk/activity.d.ts.map +1 -0
  47. package/esm/sdk/activity.js +28 -0
  48. package/esm/sdk/activity.js.map +1 -0
  49. package/esm/sdk/addons.d.ts +7 -0
  50. package/esm/sdk/addons.d.ts.map +1 -1
  51. package/esm/sdk/addons.js +10 -0
  52. package/esm/sdk/addons.js.map +1 -1
  53. package/esm/sdk/models/activity-actor.d.ts +12 -0
  54. package/esm/sdk/models/activity-actor.d.ts.map +1 -0
  55. package/esm/sdk/models/activity-actor.js +16 -0
  56. package/esm/sdk/models/activity-actor.js.map +1 -0
  57. package/esm/sdk/models/activity-entity.d.ts +12 -0
  58. package/esm/sdk/models/activity-entity.d.ts.map +1 -0
  59. package/esm/sdk/models/activity-entity.js +16 -0
  60. package/esm/sdk/models/activity-entity.js.map +1 -0
  61. package/esm/sdk/models/activity-pagination.d.ts +12 -0
  62. package/esm/sdk/models/activity-pagination.d.ts.map +1 -0
  63. package/esm/sdk/models/activity-pagination.js +22 -0
  64. package/esm/sdk/models/activity-pagination.js.map +1 -0
  65. package/esm/sdk/models/activity-response.d.ts +26 -0
  66. package/esm/sdk/models/activity-response.d.ts.map +1 -0
  67. package/esm/sdk/models/activity-response.js +39 -0
  68. package/esm/sdk/models/activity-response.js.map +1 -0
  69. package/esm/sdk/models/add-addon-to-subscription-response.d.ts +7 -0
  70. package/esm/sdk/models/add-addon-to-subscription-response.d.ts.map +1 -1
  71. package/esm/sdk/models/add-addon-to-subscription-response.js +2 -0
  72. package/esm/sdk/models/add-addon-to-subscription-response.js.map +1 -1
  73. package/esm/sdk/models/addon-association-response.d.ts +7 -0
  74. package/esm/sdk/models/addon-association-response.d.ts.map +1 -1
  75. package/esm/sdk/models/addon-association-response.js +2 -0
  76. package/esm/sdk/models/addon-association-response.js.map +1 -1
  77. package/esm/sdk/models/addon-price-sync-status-response.d.ts +12 -0
  78. package/esm/sdk/models/addon-price-sync-status-response.d.ts.map +1 -0
  79. package/esm/sdk/models/addon-price-sync-status-response.js +22 -0
  80. package/esm/sdk/models/addon-price-sync-status-response.js.map +1 -0
  81. package/esm/sdk/models/addon-response.d.ts +2 -0
  82. package/esm/sdk/models/addon-response.d.ts.map +1 -1
  83. package/esm/sdk/models/addon-response.js +3 -0
  84. package/esm/sdk/models/addon-response.js.map +1 -1
  85. package/esm/sdk/models/cancel-subscription-request.d.ts +2 -2
  86. package/esm/sdk/models/cancel-subscription-request.js +2 -2
  87. package/esm/sdk/models/changed-addon-association.d.ts +1 -0
  88. package/esm/sdk/models/changed-addon-association.d.ts.map +1 -1
  89. package/esm/sdk/models/changed-addon-association.js +2 -0
  90. package/esm/sdk/models/changed-addon-association.js.map +1 -1
  91. package/esm/sdk/models/changed-line-item.d.ts +1 -0
  92. package/esm/sdk/models/changed-line-item.d.ts.map +1 -1
  93. package/esm/sdk/models/changed-line-item.js +2 -0
  94. package/esm/sdk/models/changed-line-item.js.map +1 -1
  95. package/esm/sdk/models/checkout-configuration.d.ts +2 -0
  96. package/esm/sdk/models/checkout-configuration.d.ts.map +1 -1
  97. package/esm/sdk/models/checkout-configuration.js +2 -0
  98. package/esm/sdk/models/checkout-configuration.js.map +1 -1
  99. package/esm/sdk/models/create-addon-response.d.ts +2 -0
  100. package/esm/sdk/models/create-addon-response.d.ts.map +1 -1
  101. package/esm/sdk/models/create-addon-response.js +3 -0
  102. package/esm/sdk/models/create-addon-response.js.map +1 -1
  103. package/esm/sdk/models/create-customer-request.d.ts +2 -2
  104. package/esm/sdk/models/create-customer-request.d.ts.map +1 -1
  105. package/esm/sdk/models/create-customer-request.js +1 -1
  106. package/esm/sdk/models/create-customer-request.js.map +1 -1
  107. package/esm/sdk/models/get-activity-op.d.ts +15 -0
  108. package/esm/sdk/models/get-activity-op.d.ts.map +1 -0
  109. package/esm/sdk/models/get-activity-op.js +12 -0
  110. package/esm/sdk/models/get-activity-op.js.map +1 -0
  111. package/esm/sdk/models/grouped-invoicing-action.d.ts +1 -0
  112. package/esm/sdk/models/grouped-invoicing-action.d.ts.map +1 -1
  113. package/esm/sdk/models/grouped-invoicing-action.js +1 -0
  114. package/esm/sdk/models/grouped-invoicing-action.js.map +1 -1
  115. package/esm/sdk/models/grouped-invoicing-change.d.ts +15 -0
  116. package/esm/sdk/models/grouped-invoicing-change.d.ts.map +1 -0
  117. package/esm/sdk/models/grouped-invoicing-change.js +20 -0
  118. package/esm/sdk/models/grouped-invoicing-change.js.map +1 -0
  119. package/esm/sdk/models/index.d.ts +10 -0
  120. package/esm/sdk/models/index.d.ts.map +1 -1
  121. package/esm/sdk/models/index.js +10 -0
  122. package/esm/sdk/models/index.js.map +1 -1
  123. package/esm/sdk/models/list-activity-request.d.ts +34 -0
  124. package/esm/sdk/models/list-activity-request.d.ts.map +1 -0
  125. package/esm/sdk/models/list-activity-request.js +35 -0
  126. package/esm/sdk/models/list-activity-request.js.map +1 -0
  127. package/esm/sdk/models/list-activity-response.d.ts +13 -0
  128. package/esm/sdk/models/list-activity-response.d.ts.map +1 -0
  129. package/esm/sdk/models/list-activity-response.js +17 -0
  130. package/esm/sdk/models/list-activity-response.js.map +1 -0
  131. package/esm/sdk/models/payment-terms.d.ts +2 -0
  132. package/esm/sdk/models/payment-terms.d.ts.map +1 -1
  133. package/esm/sdk/models/payment-terms.js +2 -0
  134. package/esm/sdk/models/payment-terms.js.map +1 -1
  135. package/esm/sdk/models/sub-modify-grouped-invoicing-params.d.ts +6 -0
  136. package/esm/sdk/models/sub-modify-grouped-invoicing-params.d.ts.map +1 -1
  137. package/esm/sdk/models/sub-modify-grouped-invoicing-params.js +2 -0
  138. package/esm/sdk/models/sub-modify-grouped-invoicing-params.js.map +1 -1
  139. package/esm/sdk/models/sync-addon-prices-op.d.ts +15 -0
  140. package/esm/sdk/models/sync-addon-prices-op.d.ts.map +1 -0
  141. package/esm/sdk/models/sync-addon-prices-op.js +12 -0
  142. package/esm/sdk/models/sync-addon-prices-op.js.map +1 -0
  143. package/esm/sdk/models/update-customer-request.d.ts +2 -2
  144. package/esm/sdk/models/update-customer-request.d.ts.map +1 -1
  145. package/esm/sdk/models/update-customer-request.js +1 -1
  146. package/esm/sdk/models/update-customer-request.js.map +1 -1
  147. package/esm/sdk/sdk.d.ts +3 -0
  148. package/esm/sdk/sdk.d.ts.map +1 -1
  149. package/esm/sdk/sdk.js +5 -0
  150. package/esm/sdk/sdk.js.map +1 -1
  151. package/examples/{addonsCreateAddon.example.ts → activityListActivity.example.ts} +2 -5
  152. package/jsr.json +1 -1
  153. package/package.json +1 -1
  154. package/src/funcs/activity-get-activity.ts +181 -0
  155. package/src/funcs/activity-list-activity.ts +172 -0
  156. package/src/funcs/addons-sync-addon-prices.ts +181 -0
  157. package/src/lib/config.ts +2 -2
  158. package/src/sdk/activity.ts +45 -0
  159. package/src/sdk/addons.ts +18 -0
  160. package/src/sdk/models/activity-actor.ts +35 -0
  161. package/src/sdk/models/activity-entity.ts +35 -0
  162. package/src/sdk/models/activity-pagination.ts +44 -0
  163. package/src/sdk/models/activity-response.ts +85 -0
  164. package/src/sdk/models/add-addon-to-subscription-response.ts +9 -0
  165. package/src/sdk/models/addon-association-response.ts +9 -0
  166. package/src/sdk/models/addon-price-sync-status-response.ts +44 -0
  167. package/src/sdk/models/addon-response.ts +9 -0
  168. package/src/sdk/models/cancel-subscription-request.ts +4 -4
  169. package/src/sdk/models/changed-addon-association.ts +3 -0
  170. package/src/sdk/models/changed-line-item.ts +3 -0
  171. package/src/sdk/models/checkout-configuration.ts +4 -0
  172. package/src/sdk/models/create-addon-response.ts +9 -0
  173. package/src/sdk/models/create-customer-request.ts +3 -3
  174. package/src/sdk/models/get-activity-op.ts +33 -0
  175. package/src/sdk/models/grouped-invoicing-action.ts +1 -0
  176. package/src/sdk/models/grouped-invoicing-change.ts +47 -0
  177. package/src/sdk/models/index.ts +10 -0
  178. package/src/sdk/models/list-activity-request.ts +78 -0
  179. package/src/sdk/models/list-activity-response.ts +41 -0
  180. package/src/sdk/models/payment-terms.ts +2 -0
  181. package/src/sdk/models/sub-modify-grouped-invoicing-params.ts +11 -0
  182. package/src/sdk/models/sync-addon-prices-op.ts +33 -0
  183. package/src/sdk/models/update-customer-request.ts +3 -3
  184. package/src/sdk/sdk.ts +6 -0
package/FUNCTIONS.md CHANGED
@@ -20,7 +20,7 @@ specific category of applications.
20
20
 
21
21
  ```typescript
22
22
  import { FlexpriceCore } from "@flexprice/sdk/core.js";
23
- import { addonsCreateAddon } from "@flexprice/sdk/funcs/addons-create-addon.js";
23
+ import { activityListActivity } from "@flexprice/sdk/funcs/activity-list-activity.js";
24
24
 
25
25
  // Use `FlexpriceCore` for best tree-shaking performance.
26
26
  // You can create one instance of it to use across an application.
@@ -29,15 +29,12 @@ const flexprice = new FlexpriceCore({
29
29
  });
30
30
 
31
31
  async function run() {
32
- const res = await addonsCreateAddon(flexprice, {
33
- lookupKey: "<value>",
34
- name: "<value>",
35
- });
32
+ const res = await activityListActivity(flexprice, {});
36
33
  if (res.ok) {
37
34
  const { value: result } = res;
38
35
  console.log(result);
39
36
  } else {
40
- console.log("addonsCreateAddon failed:", res.error);
37
+ console.log("activityListActivity failed:", res.error);
41
38
  }
42
39
  }
43
40
 
package/USAGE.md CHANGED
@@ -7,10 +7,7 @@ const flexprice = new Flexprice({
7
7
  });
8
8
 
9
9
  async function run() {
10
- const result = await flexprice.addons.createAddon({
11
- lookupKey: "<value>",
12
- name: "<value>",
13
- });
10
+ const result = await flexprice.activity.listActivity({});
14
11
 
15
12
  console.log(result);
16
13
  }
package/docs/sdk/models/activity-actor.md ADDED
@@ -0,0 +1,17 @@
1
+ # ActivityActor
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ActivityActor } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ActivityActor = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------ | ------------------ | ------------------ | ------------------ |
15
+ | `id` | *string* | :heavy_minus_sign: | N/A |
16
+ | `label` | *string* | :heavy_minus_sign: | N/A |
17
+ | `type` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/activity-entity.md ADDED
@@ -0,0 +1,17 @@
1
+ # ActivityEntity
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ActivityEntity } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ActivityEntity = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------ | ------------------ | ------------------ | ------------------ |
15
+ | `id` | *string* | :heavy_minus_sign: | N/A |
16
+ | `label` | *string* | :heavy_minus_sign: | N/A |
17
+ | `type` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/activity-pagination.md ADDED
@@ -0,0 +1,17 @@
1
+ # ActivityPagination
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ActivityPagination } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ActivityPagination = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ------------------ | ------------------ | ------------------ | ------------------ |
15
+ | `hasMore` | *boolean* | :heavy_minus_sign: | N/A |
16
+ | `limit` | *number* | :heavy_minus_sign: | N/A |
17
+ | `nextCursor` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/activity-response.md ADDED
@@ -0,0 +1,25 @@
1
+ # ActivityResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ActivityResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ActivityResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `action` | *string* | :heavy_minus_sign: | N/A |
16
+ | `actor` | [models.ActivityActor](../../sdk/models/activity-actor.md) | :heavy_minus_sign: | N/A |
17
+ | `customerId` | *string* | :heavy_minus_sign: | N/A |
18
+ | `entity` | [models.ActivityEntity](../../sdk/models/activity-entity.md) | :heavy_minus_sign: | N/A |
19
+ | `id` | *string* | :heavy_minus_sign: | N/A |
20
+ | `ip` | *string* | :heavy_minus_sign: | N/A |
21
+ | `occurredAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
22
+ | `requestId` | *string* | :heavy_minus_sign: | N/A |
23
+ | `source` | *string* | :heavy_minus_sign: | N/A |
24
+ | `state` | [models.State](../../sdk/models/state.md) | :heavy_minus_sign: | N/A |
25
+ | `userAgent` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/add-addon-to-subscription-response.md CHANGED
@@ -121,24 +121,25 @@ let value: AddAddonToSubscriptionResponse = {
121
121
 
122
122
  ## Fields
123
123
 
124
- | Field | Type | Required | Description |
125
- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
126
- | `addonId` | *string* | :heavy_minus_sign: | N/A |
127
- | `addonStatus` | [models.AddonStatus](../../sdk/models/addon-status.md) | :heavy_minus_sign: | N/A |
128
- | `cancellationReason` | *string* | :heavy_minus_sign: | N/A |
129
- | `cancelledAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
130
- | `checkoutSession` | [models.CheckoutSessionResponse](../../sdk/models/checkout-session-response.md) | :heavy_minus_sign: | N/A |
131
- | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
132
- | `createdBy` | *string* | :heavy_minus_sign: | N/A |
133
- | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
134
- | `entityId` | *string* | :heavy_minus_sign: | N/A |
135
- | `entityType` | [models.AddonAssociationEntityType](../../sdk/models/addon-association-entity-type.md) | :heavy_minus_sign: | N/A |
136
- | `environmentId` | *string* | :heavy_minus_sign: | N/A |
137
- | `id` | *string* | :heavy_minus_sign: | N/A |
138
- | `invoice` | [models.InvoiceResponse](../../sdk/models/invoice-response.md) | :heavy_minus_sign: | N/A |
139
- | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
140
- | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
141
- | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
142
- | `tenantId` | *string* | :heavy_minus_sign: | N/A |
143
- | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
144
- | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
124
+ | Field | Type | Required | Description |
125
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
126
+ | `addonId` | *string* | :heavy_minus_sign: | N/A |
127
+ | `addonStatus` | [models.AddonStatus](../../sdk/models/addon-status.md) | :heavy_minus_sign: | N/A |
128
+ | `cancellationReason` | *string* | :heavy_minus_sign: | N/A |
129
+ | `cancelledAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
130
+ | `checkoutSession` | [models.CheckoutSessionResponse](../../sdk/models/checkout-session-response.md) | :heavy_minus_sign: | N/A |
131
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
132
+ | `createdBy` | *string* | :heavy_minus_sign: | N/A |
133
+ | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
134
+ | `entityId` | *string* | :heavy_minus_sign: | N/A |
135
+ | `entityType` | [models.AddonAssociationEntityType](../../sdk/models/addon-association-entity-type.md) | :heavy_minus_sign: | N/A |
136
+ | `environmentId` | *string* | :heavy_minus_sign: | N/A |
137
+ | `id` | *string* | :heavy_minus_sign: | N/A |
138
+ | `invoice` | [models.InvoiceResponse](../../sdk/models/invoice-response.md) | :heavy_minus_sign: | N/A |
139
+ | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
140
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
141
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
142
+ | `syncedPriceSequence` | *number* | :heavy_minus_sign: | SyncedPriceSequence is the addon price sequence this association's line items<br/>have been reconciled up to. Written only by the addon usage-price sync. |
143
+ | `tenantId` | *string* | :heavy_minus_sign: | N/A |
144
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
145
+ | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/addon-association-response.md CHANGED
@@ -136,24 +136,25 @@ let value: AddonAssociationResponse = {
136
136
 
137
137
  ## Fields
138
138
 
139
- | Field | Type | Required | Description |
140
- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
141
- | `addon` | [models.AddonResponse](../../sdk/models/addon-response.md) | :heavy_minus_sign: | N/A |
142
- | `addonId` | *string* | :heavy_minus_sign: | N/A |
143
- | `addonStatus` | [models.AddonStatus](../../sdk/models/addon-status.md) | :heavy_minus_sign: | N/A |
144
- | `cancellationReason` | *string* | :heavy_minus_sign: | N/A |
145
- | `cancelledAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
146
- | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
147
- | `createdBy` | *string* | :heavy_minus_sign: | N/A |
148
- | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
149
- | `entityId` | *string* | :heavy_minus_sign: | N/A |
150
- | `entityType` | [models.AddonAssociationEntityType](../../sdk/models/addon-association-entity-type.md) | :heavy_minus_sign: | N/A |
151
- | `environmentId` | *string* | :heavy_minus_sign: | N/A |
152
- | `id` | *string* | :heavy_minus_sign: | N/A |
153
- | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
154
- | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
155
- | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
156
- | `subscription` | [models.SubscriptionResponse](../../sdk/models/subscription-response.md) | :heavy_minus_sign: | N/A |
157
- | `tenantId` | *string* | :heavy_minus_sign: | N/A |
158
- | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
159
- | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
139
+ | Field | Type | Required | Description |
140
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
141
+ | `addon` | [models.AddonResponse](../../sdk/models/addon-response.md) | :heavy_minus_sign: | N/A |
142
+ | `addonId` | *string* | :heavy_minus_sign: | N/A |
143
+ | `addonStatus` | [models.AddonStatus](../../sdk/models/addon-status.md) | :heavy_minus_sign: | N/A |
144
+ | `cancellationReason` | *string* | :heavy_minus_sign: | N/A |
145
+ | `cancelledAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
146
+ | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
147
+ | `createdBy` | *string* | :heavy_minus_sign: | N/A |
148
+ | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
149
+ | `entityId` | *string* | :heavy_minus_sign: | N/A |
150
+ | `entityType` | [models.AddonAssociationEntityType](../../sdk/models/addon-association-entity-type.md) | :heavy_minus_sign: | N/A |
151
+ | `environmentId` | *string* | :heavy_minus_sign: | N/A |
152
+ | `id` | *string* | :heavy_minus_sign: | N/A |
153
+ | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
154
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
155
+ | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
156
+ | `subscription` | [models.SubscriptionResponse](../../sdk/models/subscription-response.md) | :heavy_minus_sign: | N/A |
157
+ | `syncedPriceSequence` | *number* | :heavy_minus_sign: | SyncedPriceSequence is the addon price sequence this association's line items<br/>have been reconciled up to. Written only by the addon usage-price sync. |
158
+ | `tenantId` | *string* | :heavy_minus_sign: | N/A |
159
+ | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
160
+ | `updatedBy` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/addon-price-sync-status-response.md ADDED
@@ -0,0 +1,17 @@
1
+ # AddonPriceSyncStatusResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { AddonPriceSyncStatusResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: AddonPriceSyncStatusResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | -------------------------- | -------------------------- | -------------------------- | -------------------------- |
15
+ | `currentSequence` | *number* | :heavy_minus_sign: | N/A |
16
+ | `synced` | *boolean* | :heavy_minus_sign: | N/A |
17
+ | `unsyncedAssociationCount` | *number* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/addon-response.md CHANGED
@@ -71,6 +71,7 @@ let value: AddonResponse = {
71
71
  | `lookupKey` | *string* | :heavy_minus_sign: | N/A |
72
72
  | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
73
73
  | `name` | *string* | :heavy_minus_sign: | N/A |
74
+ | `priceSyncStatus` | [models.AddonPriceSyncStatusResponse](../../sdk/models/addon-price-sync-status-response.md) | :heavy_minus_sign: | N/A |
74
75
  | `prices` | [models.PriceResponse](../../sdk/models/price-response.md)[] | :heavy_minus_sign: | Optional expanded fields |
75
76
  | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
76
77
  | `tenantId` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/cancel-subscription-request.md CHANGED
@@ -15,7 +15,7 @@ let value: CancelSubscriptionRequest = {
15
15
  | Field | Type | Required | Description |
16
16
  | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
17
  | `cancelAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | CancelAt is the exact date/time when the subscription should be cancelled.<br/>Required for cancellation_type "scheduled_date"; optional for "immediate" (past dates only — backdated cancellation).<br/>For "scheduled_date", accepts both future dates (deferred cancellation) and past dates (backdated cancellation).<br/>For "immediate", accepts past/current dates only; use "scheduled_date" for future dates. |
18
- | `cancelImmediatelyInovicePolicy` | [models.CancelImmediatelyInvoicePolicy](../../sdk/models/cancel-immediately-invoice-policy.md) | :heavy_minus_sign: | N/A |
18
+ | `cancelImmediatelyInvoicePolicy` | [models.CancelImmediatelyInvoicePolicy](../../sdk/models/cancel-immediately-invoice-policy.md) | :heavy_minus_sign: | N/A |
19
19
  | `cancellationType` | [models.CancellationType](../../sdk/models/cancellation-type.md) | :heavy_check_mark: | N/A |
20
20
  | `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_minus_sign: | N/A |
21
21
  | `reason` | *string* | :heavy_minus_sign: | Reason for cancellation (for audit and business intelligence) |
package/docs/sdk/models/changed-addon-association.md CHANGED
@@ -17,4 +17,5 @@ let value: ChangedAddonAssociation = {};
17
17
  | `changeAction` | [models.ChangedAddonAssociationAction](../../sdk/models/changed-addon-association-action.md) | :heavy_minus_sign: | created \| ended |
18
18
  | `endDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
19
19
  | `id` | *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 |
20
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
21
+ | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/changed-line-item.md CHANGED
@@ -17,4 +17,5 @@ let value: ChangedLineItem = {};
17
17
  | `id` | *string* | :heavy_minus_sign: | N/A |
18
18
  | `priceId` | *string* | :heavy_minus_sign: | N/A |
19
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 |
20
+ | `startDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
21
+ | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/checkout-configuration.md CHANGED
@@ -12,6 +12,7 @@ let value: CheckoutConfiguration = {};
12
12
 
13
13
  | Field | Type | Required | Description |
14
14
  | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
15
+ | `addAddonBatchParams` | [models.AddAddonParams](../../sdk/models/add-addon-params.md)[] | :heavy_minus_sign: | N/A |
15
16
  | `addAddonParams` | [models.AddAddonParams](../../sdk/models/add-addon-params.md) | :heavy_minus_sign: | N/A |
16
17
  | `createSubscriptionParams` | [models.CreateSubscriptionParams](../../sdk/models/create-subscription-params.md) | :heavy_minus_sign: | N/A |
17
18
  | `modifySubscriptionParams` | [models.ModifySubscriptionParams](../../sdk/models/modify-subscription-params.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-addon-response.md CHANGED
@@ -71,6 +71,7 @@ let value: CreateAddonResponse = {
71
71
  | `lookupKey` | *string* | :heavy_minus_sign: | N/A |
72
72
  | `metadata` | Record<string, *any*> | :heavy_minus_sign: | N/A |
73
73
  | `name` | *string* | :heavy_minus_sign: | N/A |
74
+ | `priceSyncStatus` | [models.AddonPriceSyncStatusResponse](../../sdk/models/addon-price-sync-status-response.md) | :heavy_minus_sign: | N/A |
74
75
  | `prices` | [models.PriceResponse](../../sdk/models/price-response.md)[] | :heavy_minus_sign: | Optional expanded fields |
75
76
  | `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
76
77
  | `tenantId` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/create-customer-request.md CHANGED
@@ -8,11 +8,6 @@ Request object for creating a new customer in the system
8
8
  import { CreateCustomerRequest } from "@flexprice/sdk/sdk/models";
9
9
 
10
10
  let value: CreateCustomerRequest = {
11
- contactPersons: [
12
- {
13
- firstName: "Ryan",
14
- },
15
- ],
16
11
  externalId: "<id>",
17
12
  name: "<value>",
18
13
  };
@@ -30,7 +25,7 @@ let value: CreateCustomerRequest = {
30
25
  | `addressState` | *string* | :heavy_minus_sign: | address_state is the state, province, or region name with maximum 100 characters |
31
26
  | `billingCurrency` | *string* | :heavy_minus_sign: | billing_currency is the fiat currency invoices are issued in; empty means the charge currency is used as-is |
32
27
  | `contact` | *string* | :heavy_minus_sign: | contact is an optional contact number for the customer (e.g. phone) |
33
- | `contactPersons` | [models.CustomerContactPerson](../../sdk/models/customer-contact-person.md)[] | :heavy_check_mark: | contact_persons are people at the customer; at most one may be primary |
28
+ | `contactPersons` | [models.CustomerContactPerson](../../sdk/models/customer-contact-person.md)[] | :heavy_minus_sign: | contact_persons are people at the customer; at most one may be primary |
34
29
  | `email` | *string* | :heavy_minus_sign: | email is the customer's email address and must be a valid email format if provided |
35
30
  | `externalId` | *string* | :heavy_check_mark: | external_id is the unique identifier from your system to reference this customer (required) |
36
31
  | `integrationEntityMapping` | [models.CreateEntityIntegrationMappingRequest](../../sdk/models/create-entity-integration-mapping-request.md)[] | :heavy_minus_sign: | integration_entity_mapping contains provider integration mappings for this customer |
package/docs/sdk/models/get-activity-request.md ADDED
@@ -0,0 +1,17 @@
1
+ # GetActivityRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { GetActivityRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: GetActivityRequest = {
9
+ id: "<id>",
10
+ };
11
+ ```
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Description |
16
+ | ------------------ | ------------------ | ------------------ | ------------------ |
17
+ | `id` | *string* | :heavy_check_mark: | Activity ID |
package/docs/sdk/models/grouped-invoicing-action.md CHANGED
@@ -5,11 +5,11 @@
5
5
  ```typescript
6
6
  import { GroupedInvoicingAction } from "@flexprice/sdk/sdk/models";
7
7
 
8
- let value: GroupedInvoicingAction = "remove";
8
+ let value: GroupedInvoicingAction = "modify";
9
9
  ```
10
10
 
11
11
  ## Values
12
12
 
13
13
  ```typescript
14
- "add" | "remove"
14
+ "add" | "remove" | "modify"
15
15
  ```
package/docs/sdk/models/grouped-invoicing-change.md ADDED
@@ -0,0 +1,16 @@
1
+ # GroupedInvoicingChange
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { GroupedInvoicingChange } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: GroupedInvoicingChange = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
15
+ | `addonBulkParams` | [models.SubModifyBulkAddonParams](../../sdk/models/sub-modify-bulk-addon-params.md) | :heavy_minus_sign: | N/A |
16
+ | `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
package/docs/sdk/models/list-activity-request.md ADDED
@@ -0,0 +1,26 @@
1
+ # ListActivityRequest
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListActivityRequest } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListActivityRequest = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15
+ | `actions` | *string*[] | :heavy_minus_sign: | N/A |
16
+ | `actorId` | *string* | :heavy_minus_sign: | N/A |
17
+ | `actorTypes` | *string*[] | :heavy_minus_sign: | N/A |
18
+ | `cursor` | *string* | :heavy_minus_sign: | N/A |
19
+ | `customerId` | *string* | :heavy_minus_sign: | N/A |
20
+ | `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
21
+ | `entityId` | *string* | :heavy_minus_sign: | N/A |
22
+ | `entityType` | *string* | :heavy_minus_sign: | N/A |
23
+ | `expand` | *string*[] | :heavy_minus_sign: | N/A |
24
+ | `limit` | *number* | :heavy_minus_sign: | N/A |
25
+ | `requestId` | *string* | :heavy_minus_sign: | N/A |
26
+ | `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/list-activity-response.md ADDED
@@ -0,0 +1,16 @@
1
+ # ListActivityResponse
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { ListActivityResponse } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: ListActivityResponse = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
15
+ | `items` | [models.ActivityResponse](../../sdk/models/activity-response.md)[] | :heavy_minus_sign: | N/A |
16
+ | `pagination` | [models.ActivityPagination](../../sdk/models/activity-pagination.md) | :heavy_minus_sign: | N/A |
package/docs/sdk/models/payment-terms.md CHANGED
@@ -13,5 +13,5 @@ let value: PaymentTerms = "30 NET";
13
13
  ## Values
14
14
 
15
15
  ```typescript
16
- "15 NET" | "30 NET" | "45 NET" | "60 NET" | "75 NET" | "90 NET" | Unrecognized<string>
16
+ "15 NET" | "30 NET" | "45 NET" | "60 NET" | "75 NET" | "90 NET" | "END_OF_MONTH" | "END_OF_NEXT_MONTH" | Unrecognized<string>
17
17
  ```
package/docs/sdk/models/state.md ADDED
@@ -0,0 +1,14 @@
1
+ # State
2
+
3
+ ## Example Usage
4
+
5
+ ```typescript
6
+ import { State } from "@flexprice/sdk/sdk/models";
7
+
8
+ let value: State = {};
9
+ ```
10
+
11
+ ## Fields
12
+
13
+ | Field | Type | Required | Description |
14
+ | ----------- | ----------- | ----------- | ----------- |