@flexprice/sdk 2.1.37 → 2.1.39
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.
- package/FUNCTIONS.md +3 -6
- package/USAGE.md +1 -4
- package/docs/sdk/models/activity-actor.md +17 -0
- package/docs/sdk/models/activity-entity.md +17 -0
- package/docs/sdk/models/activity-pagination.md +17 -0
- package/docs/sdk/models/activity-response.md +25 -0
- package/docs/sdk/models/add-addon-to-subscription-response.md +22 -21
- package/docs/sdk/models/addon-association-response.md +22 -21
- package/docs/sdk/models/addon-price-sync-status-response.md +17 -0
- package/docs/sdk/models/addon-response.md +1 -0
- package/docs/sdk/models/cancel-subscription-request.md +1 -1
- package/docs/sdk/models/changed-addon-association.md +2 -1
- package/docs/sdk/models/changed-line-item.md +2 -1
- package/docs/sdk/models/checkout-configuration.md +1 -0
- package/docs/sdk/models/create-addon-response.md +1 -0
- package/docs/sdk/models/create-customer-request.md +1 -6
- package/docs/sdk/models/get-activity-request.md +17 -0
- package/docs/sdk/models/grouped-invoicing-action.md +2 -2
- package/docs/sdk/models/grouped-invoicing-change.md +16 -0
- package/docs/sdk/models/invoice-billing-reason.md +2 -2
- package/docs/sdk/models/list-activity-request.md +26 -0
- package/docs/sdk/models/list-activity-response.md +16 -0
- package/docs/sdk/models/pause-subscription-request-request.md +19 -0
- package/docs/sdk/models/pause-subscription-request.md +19 -0
- package/docs/sdk/models/pause-subscription-response.md +127 -0
- package/docs/sdk/models/payment-terms.md +1 -1
- package/docs/sdk/models/resume-subscription-request-request.md +19 -0
- package/docs/sdk/models/resume-subscription-request.md +18 -0
- package/docs/sdk/models/resume-subscription-response.md +127 -0
- package/docs/sdk/models/state.md +14 -0
- package/docs/sdk/models/sub-modify-grouped-invoicing-params.md +7 -6
- package/docs/sdk/models/subscription-pause-response.md +35 -0
- package/docs/sdk/models/sync-addon-prices-request.md +17 -0
- package/docs/sdk/models/update-customer-request-request.md +1 -7
- package/docs/sdk/models/update-customer-request.md +2 -4
- package/docs/sdks/activity/README.md +150 -0
- package/docs/sdks/addons/README.md +72 -0
- package/docs/sdks/customers/README.md +2 -8
- package/docs/sdks/subscriptions/README.md +146 -0
- package/esm/funcs/activity-get-activity.d.ts +17 -0
- package/esm/funcs/activity-get-activity.d.ts.map +1 -0
- package/esm/funcs/activity-get-activity.js +91 -0
- package/esm/funcs/activity-get-activity.js.map +1 -0
- package/esm/funcs/activity-list-activity.d.ts +17 -0
- package/esm/funcs/activity-list-activity.d.ts.map +1 -0
- package/esm/funcs/activity-list-activity.js +83 -0
- package/esm/funcs/activity-list-activity.js.map +1 -0
- package/esm/funcs/addons-sync-addon-prices.d.ts +17 -0
- package/esm/funcs/addons-sync-addon-prices.d.ts.map +1 -0
- package/esm/funcs/addons-sync-addon-prices.js +91 -0
- package/esm/funcs/addons-sync-addon-prices.js.map +1 -0
- package/esm/funcs/subscriptions-pause-subscription.d.ts +17 -0
- package/esm/funcs/subscriptions-pause-subscription.d.ts.map +1 -0
- package/esm/funcs/subscriptions-pause-subscription.js +93 -0
- package/esm/funcs/subscriptions-pause-subscription.js.map +1 -0
- package/esm/funcs/subscriptions-resume-subscription.d.ts +17 -0
- package/esm/funcs/subscriptions-resume-subscription.d.ts.map +1 -0
- package/esm/funcs/subscriptions-resume-subscription.js +93 -0
- package/esm/funcs/subscriptions-resume-subscription.js.map +1 -0
- package/esm/lib/config.d.ts +2 -2
- package/esm/lib/config.js +2 -2
- package/esm/sdk/activity.d.ts +19 -0
- package/esm/sdk/activity.d.ts.map +1 -0
- package/esm/sdk/activity.js +28 -0
- package/esm/sdk/activity.js.map +1 -0
- package/esm/sdk/addons.d.ts +7 -0
- package/esm/sdk/addons.d.ts.map +1 -1
- package/esm/sdk/addons.js +10 -0
- package/esm/sdk/addons.js.map +1 -1
- package/esm/sdk/models/activity-actor.d.ts +12 -0
- package/esm/sdk/models/activity-actor.d.ts.map +1 -0
- package/esm/sdk/models/activity-actor.js +16 -0
- package/esm/sdk/models/activity-actor.js.map +1 -0
- package/esm/sdk/models/activity-entity.d.ts +12 -0
- package/esm/sdk/models/activity-entity.d.ts.map +1 -0
- package/esm/sdk/models/activity-entity.js +16 -0
- package/esm/sdk/models/activity-entity.js.map +1 -0
- package/esm/sdk/models/activity-pagination.d.ts +12 -0
- package/esm/sdk/models/activity-pagination.d.ts.map +1 -0
- package/esm/sdk/models/activity-pagination.js +22 -0
- package/esm/sdk/models/activity-pagination.js.map +1 -0
- package/esm/sdk/models/activity-response.d.ts +26 -0
- package/esm/sdk/models/activity-response.d.ts.map +1 -0
- package/esm/sdk/models/activity-response.js +39 -0
- package/esm/sdk/models/activity-response.js.map +1 -0
- package/esm/sdk/models/add-addon-to-subscription-response.d.ts +7 -0
- package/esm/sdk/models/add-addon-to-subscription-response.d.ts.map +1 -1
- package/esm/sdk/models/add-addon-to-subscription-response.js +2 -0
- package/esm/sdk/models/add-addon-to-subscription-response.js.map +1 -1
- package/esm/sdk/models/addon-association-response.d.ts +7 -0
- package/esm/sdk/models/addon-association-response.d.ts.map +1 -1
- package/esm/sdk/models/addon-association-response.js +2 -0
- package/esm/sdk/models/addon-association-response.js.map +1 -1
- package/esm/sdk/models/addon-price-sync-status-response.d.ts +12 -0
- package/esm/sdk/models/addon-price-sync-status-response.d.ts.map +1 -0
- package/esm/sdk/models/addon-price-sync-status-response.js +22 -0
- package/esm/sdk/models/addon-price-sync-status-response.js.map +1 -0
- package/esm/sdk/models/addon-response.d.ts +2 -0
- package/esm/sdk/models/addon-response.d.ts.map +1 -1
- package/esm/sdk/models/addon-response.js +3 -0
- package/esm/sdk/models/addon-response.js.map +1 -1
- package/esm/sdk/models/cancel-subscription-request.d.ts +2 -2
- package/esm/sdk/models/cancel-subscription-request.js +2 -2
- package/esm/sdk/models/changed-addon-association.d.ts +1 -0
- package/esm/sdk/models/changed-addon-association.d.ts.map +1 -1
- package/esm/sdk/models/changed-addon-association.js +2 -0
- package/esm/sdk/models/changed-addon-association.js.map +1 -1
- package/esm/sdk/models/changed-line-item.d.ts +1 -0
- package/esm/sdk/models/changed-line-item.d.ts.map +1 -1
- package/esm/sdk/models/changed-line-item.js +2 -0
- package/esm/sdk/models/changed-line-item.js.map +1 -1
- package/esm/sdk/models/checkout-configuration.d.ts +2 -0
- package/esm/sdk/models/checkout-configuration.d.ts.map +1 -1
- package/esm/sdk/models/checkout-configuration.js +2 -0
- package/esm/sdk/models/checkout-configuration.js.map +1 -1
- package/esm/sdk/models/create-addon-response.d.ts +2 -0
- package/esm/sdk/models/create-addon-response.d.ts.map +1 -1
- package/esm/sdk/models/create-addon-response.js +3 -0
- package/esm/sdk/models/create-addon-response.js.map +1 -1
- package/esm/sdk/models/create-customer-request.d.ts +2 -2
- package/esm/sdk/models/create-customer-request.d.ts.map +1 -1
- package/esm/sdk/models/create-customer-request.js +1 -1
- package/esm/sdk/models/create-customer-request.js.map +1 -1
- package/esm/sdk/models/get-activity-op.d.ts +15 -0
- package/esm/sdk/models/get-activity-op.d.ts.map +1 -0
- package/esm/sdk/models/get-activity-op.js +12 -0
- package/esm/sdk/models/get-activity-op.js.map +1 -0
- package/esm/sdk/models/grouped-invoicing-action.d.ts +1 -0
- package/esm/sdk/models/grouped-invoicing-action.d.ts.map +1 -1
- package/esm/sdk/models/grouped-invoicing-action.js +1 -0
- package/esm/sdk/models/grouped-invoicing-action.js.map +1 -1
- package/esm/sdk/models/grouped-invoicing-change.d.ts +15 -0
- package/esm/sdk/models/grouped-invoicing-change.d.ts.map +1 -0
- package/esm/sdk/models/grouped-invoicing-change.js +20 -0
- package/esm/sdk/models/grouped-invoicing-change.js.map +1 -0
- package/esm/sdk/models/index.d.ts +17 -0
- package/esm/sdk/models/index.d.ts.map +1 -1
- package/esm/sdk/models/index.js +17 -0
- package/esm/sdk/models/index.js.map +1 -1
- package/esm/sdk/models/invoice-billing-reason.d.ts +2 -0
- package/esm/sdk/models/invoice-billing-reason.d.ts.map +1 -1
- package/esm/sdk/models/invoice-billing-reason.js +2 -0
- package/esm/sdk/models/invoice-billing-reason.js.map +1 -1
- package/esm/sdk/models/list-activity-request.d.ts +34 -0
- package/esm/sdk/models/list-activity-request.d.ts.map +1 -0
- package/esm/sdk/models/list-activity-request.js +35 -0
- package/esm/sdk/models/list-activity-request.js.map +1 -0
- package/esm/sdk/models/list-activity-response.d.ts +13 -0
- package/esm/sdk/models/list-activity-response.d.ts.map +1 -0
- package/esm/sdk/models/list-activity-response.js +17 -0
- package/esm/sdk/models/list-activity-response.js.map +1 -0
- package/esm/sdk/models/pause-subscription-op.d.ts +21 -0
- package/esm/sdk/models/pause-subscription-op.d.ts.map +1 -0
- package/esm/sdk/models/pause-subscription-op.js +14 -0
- package/esm/sdk/models/pause-subscription-op.js.map +1 -0
- package/esm/sdk/models/pause-subscription-request.d.ts +37 -0
- package/esm/sdk/models/pause-subscription-request.d.ts.map +1 -0
- package/esm/sdk/models/pause-subscription-request.js +20 -0
- package/esm/sdk/models/pause-subscription-request.js.map +1 -0
- package/esm/sdk/models/pause-subscription-response.d.ts +19 -0
- package/esm/sdk/models/pause-subscription-response.d.ts.map +1 -0
- package/esm/sdk/models/pause-subscription-response.js +17 -0
- package/esm/sdk/models/pause-subscription-response.js.map +1 -0
- package/esm/sdk/models/payment-terms.d.ts +2 -0
- package/esm/sdk/models/payment-terms.d.ts.map +1 -1
- package/esm/sdk/models/payment-terms.js +2 -0
- package/esm/sdk/models/payment-terms.js.map +1 -1
- package/esm/sdk/models/resume-subscription-op.d.ts +21 -0
- package/esm/sdk/models/resume-subscription-op.d.ts.map +1 -0
- package/esm/sdk/models/resume-subscription-op.js +14 -0
- package/esm/sdk/models/resume-subscription-op.js.map +1 -0
- package/esm/sdk/models/resume-subscription-request.d.ts +28 -0
- package/esm/sdk/models/resume-subscription-request.d.ts.map +1 -0
- package/esm/sdk/models/resume-subscription-request.js +19 -0
- package/esm/sdk/models/resume-subscription-request.js.map +1 -0
- package/esm/sdk/models/resume-subscription-response.d.ts +19 -0
- package/esm/sdk/models/resume-subscription-response.d.ts.map +1 -0
- package/esm/sdk/models/resume-subscription-response.js +17 -0
- package/esm/sdk/models/resume-subscription-response.js.map +1 -0
- package/esm/sdk/models/sub-modify-grouped-invoicing-params.d.ts +6 -0
- package/esm/sdk/models/sub-modify-grouped-invoicing-params.d.ts.map +1 -1
- package/esm/sdk/models/sub-modify-grouped-invoicing-params.js +2 -0
- package/esm/sdk/models/sub-modify-grouped-invoicing-params.js.map +1 -1
- package/esm/sdk/models/subscription-pause-response.d.ts +64 -0
- package/esm/sdk/models/subscription-pause-response.d.ts.map +1 -0
- package/esm/sdk/models/subscription-pause-response.js +55 -0
- package/esm/sdk/models/subscription-pause-response.js.map +1 -0
- package/esm/sdk/models/sync-addon-prices-op.d.ts +15 -0
- package/esm/sdk/models/sync-addon-prices-op.d.ts.map +1 -0
- package/esm/sdk/models/sync-addon-prices-op.js +12 -0
- package/esm/sdk/models/sync-addon-prices-op.js.map +1 -0
- package/esm/sdk/models/update-customer-request.d.ts +2 -2
- package/esm/sdk/models/update-customer-request.d.ts.map +1 -1
- package/esm/sdk/models/update-customer-request.js +1 -1
- package/esm/sdk/models/update-customer-request.js.map +1 -1
- package/esm/sdk/sdk.d.ts +3 -0
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +5 -0
- package/esm/sdk/sdk.js.map +1 -1
- package/esm/sdk/subscriptions.d.ts +14 -0
- package/esm/sdk/subscriptions.d.ts.map +1 -1
- package/esm/sdk/subscriptions.js +20 -0
- package/esm/sdk/subscriptions.js.map +1 -1
- package/examples/{addonsCreateAddon.example.ts → activityListActivity.example.ts} +2 -5
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/activity-get-activity.ts +181 -0
- package/src/funcs/activity-list-activity.ts +172 -0
- package/src/funcs/addons-sync-addon-prices.ts +181 -0
- package/src/funcs/subscriptions-pause-subscription.ts +187 -0
- package/src/funcs/subscriptions-resume-subscription.ts +187 -0
- package/src/lib/config.ts +2 -2
- package/src/sdk/activity.ts +45 -0
- package/src/sdk/addons.ts +18 -0
- package/src/sdk/models/activity-actor.ts +35 -0
- package/src/sdk/models/activity-entity.ts +35 -0
- package/src/sdk/models/activity-pagination.ts +44 -0
- package/src/sdk/models/activity-response.ts +85 -0
- package/src/sdk/models/add-addon-to-subscription-response.ts +9 -0
- package/src/sdk/models/addon-association-response.ts +9 -0
- package/src/sdk/models/addon-price-sync-status-response.ts +44 -0
- package/src/sdk/models/addon-response.ts +9 -0
- package/src/sdk/models/cancel-subscription-request.ts +4 -4
- package/src/sdk/models/changed-addon-association.ts +3 -0
- package/src/sdk/models/changed-line-item.ts +3 -0
- package/src/sdk/models/checkout-configuration.ts +4 -0
- package/src/sdk/models/create-addon-response.ts +9 -0
- package/src/sdk/models/create-customer-request.ts +3 -3
- package/src/sdk/models/get-activity-op.ts +33 -0
- package/src/sdk/models/grouped-invoicing-action.ts +1 -0
- package/src/sdk/models/grouped-invoicing-change.ts +47 -0
- package/src/sdk/models/index.ts +17 -0
- package/src/sdk/models/invoice-billing-reason.ts +2 -0
- package/src/sdk/models/list-activity-request.ts +78 -0
- package/src/sdk/models/list-activity-response.ts +41 -0
- package/src/sdk/models/pause-subscription-op.ts +46 -0
- package/src/sdk/models/pause-subscription-request.ts +64 -0
- package/src/sdk/models/pause-subscription-response.ts +47 -0
- package/src/sdk/models/payment-terms.ts +2 -0
- package/src/sdk/models/resume-subscription-op.ts +46 -0
- package/src/sdk/models/resume-subscription-request.ts +54 -0
- package/src/sdk/models/resume-subscription-response.ts +47 -0
- package/src/sdk/models/sub-modify-grouped-invoicing-params.ts +11 -0
- package/src/sdk/models/subscription-pause-response.ts +123 -0
- package/src/sdk/models/sync-addon-prices-op.ts +33 -0
- package/src/sdk/models/update-customer-request.ts +3 -3
- package/src/sdk/sdk.ts +6 -0
- package/src/sdk/subscriptions.ts +40 -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 {
|
|
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
|
|
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("
|
|
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.
|
|
11
|
-
lookupKey: "<value>",
|
|
12
|
-
name: "<value>",
|
|
13
|
-
});
|
|
10
|
+
const result = await flexprice.activity.listActivity({});
|
|
14
11
|
|
|
15
12
|
console.log(result);
|
|
16
13
|
}
|
|
@@ -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 |
|
|
@@ -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 |
|
|
@@ -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 |
|
|
@@ -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 |
|
|
@@ -121,24 +121,25 @@ let value: AddAddonToSubscriptionResponse = {
|
|
|
121
121
|
|
|
122
122
|
## Fields
|
|
123
123
|
|
|
124
|
-
| Field
|
|
125
|
-
|
|
|
126
|
-
| `addonId`
|
|
127
|
-
| `addonStatus`
|
|
128
|
-
| `cancellationReason`
|
|
129
|
-
| `cancelledAt`
|
|
130
|
-
| `checkoutSession`
|
|
131
|
-
| `createdAt`
|
|
132
|
-
| `createdBy`
|
|
133
|
-
| `endDate`
|
|
134
|
-
| `entityId`
|
|
135
|
-
| `entityType`
|
|
136
|
-
| `environmentId`
|
|
137
|
-
| `id`
|
|
138
|
-
| `invoice`
|
|
139
|
-
| `metadata`
|
|
140
|
-
| `startDate`
|
|
141
|
-
| `status`
|
|
142
|
-
| `
|
|
143
|
-
| `
|
|
144
|
-
| `
|
|
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 |
|
|
@@ -136,24 +136,25 @@ let value: AddonAssociationResponse = {
|
|
|
136
136
|
|
|
137
137
|
## Fields
|
|
138
138
|
|
|
139
|
-
| Field
|
|
140
|
-
|
|
|
141
|
-
| `addon`
|
|
142
|
-
| `addonId`
|
|
143
|
-
| `addonStatus`
|
|
144
|
-
| `cancellationReason`
|
|
145
|
-
| `cancelledAt`
|
|
146
|
-
| `createdAt`
|
|
147
|
-
| `createdBy`
|
|
148
|
-
| `endDate`
|
|
149
|
-
| `entityId`
|
|
150
|
-
| `entityType`
|
|
151
|
-
| `environmentId`
|
|
152
|
-
| `id`
|
|
153
|
-
| `metadata`
|
|
154
|
-
| `startDate`
|
|
155
|
-
| `status`
|
|
156
|
-
| `subscription`
|
|
157
|
-
| `
|
|
158
|
-
| `
|
|
159
|
-
| `
|
|
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 |
|
|
@@ -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 |
|
|
@@ -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 |
|
|
@@ -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
|
-
| `
|
|
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) |
|
|
@@ -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 |
|
|
@@ -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 |
|
|
@@ -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 |
|
|
@@ -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 |
|
|
@@ -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)[] | :
|
|
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 |
|
|
@@ -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 |
|
|
@@ -5,11 +5,11 @@
|
|
|
5
5
|
```typescript
|
|
6
6
|
import { GroupedInvoicingAction } from "@flexprice/sdk/sdk/models";
|
|
7
7
|
|
|
8
|
-
let value: GroupedInvoicingAction = "
|
|
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
|
```
|
|
@@ -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 |
|
|
@@ -5,11 +5,11 @@
|
|
|
5
5
|
```typescript
|
|
6
6
|
import { InvoiceBillingReason } from "@flexprice/sdk/sdk/models";
|
|
7
7
|
|
|
8
|
-
let value: InvoiceBillingReason = "
|
|
8
|
+
let value: InvoiceBillingReason = "SUBSCRIPTION_TRIAL_END";
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## Values
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
"SUBSCRIPTION_CREATE" | "SUBSCRIPTION_CYCLE" | "SUBSCRIPTION_UPDATE" | "SUBSCRIPTION_TRIAL_END" | "SUBSCRIPTION_TRIAL_START" | "PRORATION" | "MANUAL" | "AUTO_INVOICE_THRESHOLD" | "WALLET_AUTO_TOPUP"
|
|
14
|
+
"SUBSCRIPTION_CREATE" | "SUBSCRIPTION_CYCLE" | "SUBSCRIPTION_UPDATE" | "SUBSCRIPTION_TRIAL_END" | "SUBSCRIPTION_TRIAL_START" | "PRORATION" | "MANUAL" | "AUTO_INVOICE_THRESHOLD" | "WALLET_AUTO_TOPUP" | "SUBSCRIPTION_PAUSED" | "SUBSCRIPTION_RESUME"
|
|
15
15
|
```
|
|
@@ -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 |
|
|
@@ -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 |
|