@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
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
# Activity
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
### Available Operations
|
|
6
|
+
|
|
7
|
+
* [listActivity](#listactivity) - List activity
|
|
8
|
+
* [getActivity](#getactivity) - Get activity
|
|
9
|
+
|
|
10
|
+
## listActivity
|
|
11
|
+
|
|
12
|
+
Use when you need the audit trail of changes to billing entities: who changed what, when, from where. Filter by entity, customer, actor, action or request; pages are newest first.
|
|
13
|
+
|
|
14
|
+
### Example Usage
|
|
15
|
+
|
|
16
|
+
<!-- UsageSnippet language="typescript" operationID="listActivity" method="post" path="/activity" -->
|
|
17
|
+
```typescript
|
|
18
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
19
|
+
|
|
20
|
+
const flexprice = new Flexprice({
|
|
21
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
async function run() {
|
|
25
|
+
const result = await flexprice.activity.listActivity({});
|
|
26
|
+
|
|
27
|
+
console.log(result);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
run();
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Standalone function
|
|
34
|
+
|
|
35
|
+
The standalone function version of this method:
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
39
|
+
import { activityListActivity } from "@flexprice/sdk/funcs/activity-list-activity.js";
|
|
40
|
+
|
|
41
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
42
|
+
// You can create one instance of it to use across an application.
|
|
43
|
+
const flexprice = new FlexpriceCore({
|
|
44
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
async function run() {
|
|
48
|
+
const res = await activityListActivity(flexprice, {});
|
|
49
|
+
if (res.ok) {
|
|
50
|
+
const { value: result } = res;
|
|
51
|
+
console.log(result);
|
|
52
|
+
} else {
|
|
53
|
+
console.log("activityListActivity failed:", res.error);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
run();
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Parameters
|
|
61
|
+
|
|
62
|
+
| Parameter | Type | Required | Description |
|
|
63
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
64
|
+
| `request` | [models.ListActivityRequest](../../sdk/models/list-activity-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
65
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
66
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
67
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
68
|
+
|
|
69
|
+
### Response
|
|
70
|
+
|
|
71
|
+
**Promise\<[models.ListActivityResponse](../../sdk/models/list-activity-response.md)\>**
|
|
72
|
+
|
|
73
|
+
### Errors
|
|
74
|
+
|
|
75
|
+
| Error Type | Status Code | Content Type |
|
|
76
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
77
|
+
| models.ErrorsErrorResponse | 400 | application/json |
|
|
78
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
79
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
80
|
+
|
|
81
|
+
## getActivity
|
|
82
|
+
|
|
83
|
+
Use when you need one activity entry with the state of the entity right after the change.
|
|
84
|
+
|
|
85
|
+
### Example Usage
|
|
86
|
+
|
|
87
|
+
<!-- UsageSnippet language="typescript" operationID="getActivity" method="get" path="/activity/{id}" -->
|
|
88
|
+
```typescript
|
|
89
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
90
|
+
|
|
91
|
+
const flexprice = new Flexprice({
|
|
92
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
async function run() {
|
|
96
|
+
const result = await flexprice.activity.getActivity("<id>");
|
|
97
|
+
|
|
98
|
+
console.log(result);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
run();
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Standalone function
|
|
105
|
+
|
|
106
|
+
The standalone function version of this method:
|
|
107
|
+
|
|
108
|
+
```typescript
|
|
109
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
110
|
+
import { activityGetActivity } from "@flexprice/sdk/funcs/activity-get-activity.js";
|
|
111
|
+
|
|
112
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
113
|
+
// You can create one instance of it to use across an application.
|
|
114
|
+
const flexprice = new FlexpriceCore({
|
|
115
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
116
|
+
});
|
|
117
|
+
|
|
118
|
+
async function run() {
|
|
119
|
+
const res = await activityGetActivity(flexprice, "<id>");
|
|
120
|
+
if (res.ok) {
|
|
121
|
+
const { value: result } = res;
|
|
122
|
+
console.log(result);
|
|
123
|
+
} else {
|
|
124
|
+
console.log("activityGetActivity failed:", res.error);
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
run();
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### Parameters
|
|
132
|
+
|
|
133
|
+
| Parameter | Type | Required | Description |
|
|
134
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
135
|
+
| `id` | *string* | :heavy_check_mark: | Activity ID |
|
|
136
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
137
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
138
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
139
|
+
|
|
140
|
+
### Response
|
|
141
|
+
|
|
142
|
+
**Promise\<[models.ActivityResponse](../../sdk/models/activity-response.md)\>**
|
|
143
|
+
|
|
144
|
+
### Errors
|
|
145
|
+
|
|
146
|
+
| Error Type | Status Code | Content Type |
|
|
147
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
148
|
+
| models.ErrorsErrorResponse | 400, 404 | application/json |
|
|
149
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
150
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* [getAddon](#getaddon) - Get addon
|
|
11
11
|
* [updateAddon](#updateaddon) - Update addon
|
|
12
12
|
* [deleteAddon](#deleteaddon) - Delete addon
|
|
13
|
+
* [syncAddonPrices](#syncaddonprices) - Synchronize addon prices
|
|
13
14
|
|
|
14
15
|
## createAddon
|
|
15
16
|
|
|
@@ -442,4 +443,75 @@ run();
|
|
|
442
443
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
443
444
|
| models.ErrorsErrorResponse | 400 | application/json |
|
|
444
445
|
| models.ErrorsErrorResponse | 500 | application/json |
|
|
446
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
447
|
+
|
|
448
|
+
## syncAddonPrices
|
|
449
|
+
|
|
450
|
+
Use when you have changed an addon's usage charges and need to push them to all active subscriptions holding the addon. Returns workflow ID.
|
|
451
|
+
|
|
452
|
+
### Example Usage
|
|
453
|
+
|
|
454
|
+
<!-- UsageSnippet language="typescript" operationID="syncAddonPrices" method="post" path="/addons/{id}/sync/subscriptions" -->
|
|
455
|
+
```typescript
|
|
456
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
457
|
+
|
|
458
|
+
const flexprice = new Flexprice({
|
|
459
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
460
|
+
});
|
|
461
|
+
|
|
462
|
+
async function run() {
|
|
463
|
+
const result = await flexprice.addons.syncAddonPrices("<id>");
|
|
464
|
+
|
|
465
|
+
console.log(result);
|
|
466
|
+
}
|
|
467
|
+
|
|
468
|
+
run();
|
|
469
|
+
```
|
|
470
|
+
|
|
471
|
+
### Standalone function
|
|
472
|
+
|
|
473
|
+
The standalone function version of this method:
|
|
474
|
+
|
|
475
|
+
```typescript
|
|
476
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
477
|
+
import { addonsSyncAddonPrices } from "@flexprice/sdk/funcs/addons-sync-addon-prices.js";
|
|
478
|
+
|
|
479
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
480
|
+
// You can create one instance of it to use across an application.
|
|
481
|
+
const flexprice = new FlexpriceCore({
|
|
482
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
483
|
+
});
|
|
484
|
+
|
|
485
|
+
async function run() {
|
|
486
|
+
const res = await addonsSyncAddonPrices(flexprice, "<id>");
|
|
487
|
+
if (res.ok) {
|
|
488
|
+
const { value: result } = res;
|
|
489
|
+
console.log(result);
|
|
490
|
+
} else {
|
|
491
|
+
console.log("addonsSyncAddonPrices failed:", res.error);
|
|
492
|
+
}
|
|
493
|
+
}
|
|
494
|
+
|
|
495
|
+
run();
|
|
496
|
+
```
|
|
497
|
+
|
|
498
|
+
### Parameters
|
|
499
|
+
|
|
500
|
+
| Parameter | Type | Required | Description |
|
|
501
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
502
|
+
| `id` | *string* | :heavy_check_mark: | Addon ID |
|
|
503
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
504
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
505
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
506
|
+
|
|
507
|
+
### Response
|
|
508
|
+
|
|
509
|
+
**Promise\<[models.ModelsTemporalWorkflowResult](../../sdk/models/models-temporal-workflow-result.md)\>**
|
|
510
|
+
|
|
511
|
+
### Errors
|
|
512
|
+
|
|
513
|
+
| Error Type | Status Code | Content Type |
|
|
514
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
515
|
+
| models.ErrorsErrorResponse | 400, 404, 422 | application/json |
|
|
516
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
445
517
|
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -32,9 +32,7 @@ const flexprice = new Flexprice({
|
|
|
32
32
|
});
|
|
33
33
|
|
|
34
34
|
async function run() {
|
|
35
|
-
const result = await flexprice.customers.updateCustomer({
|
|
36
|
-
contactPersons: [],
|
|
37
|
-
});
|
|
35
|
+
const result = await flexprice.customers.updateCustomer({});
|
|
38
36
|
|
|
39
37
|
console.log(result);
|
|
40
38
|
}
|
|
@@ -57,9 +55,7 @@ const flexprice = new FlexpriceCore({
|
|
|
57
55
|
});
|
|
58
56
|
|
|
59
57
|
async function run() {
|
|
60
|
-
const res = await customersUpdateCustomer(flexprice, {
|
|
61
|
-
contactPersons: [],
|
|
62
|
-
});
|
|
58
|
+
const res = await customersUpdateCustomer(flexprice, {});
|
|
63
59
|
if (res.ok) {
|
|
64
60
|
const { value: result } = res;
|
|
65
61
|
console.log(result);
|
|
@@ -110,7 +106,6 @@ const flexprice = new Flexprice({
|
|
|
110
106
|
|
|
111
107
|
async function run() {
|
|
112
108
|
const result = await flexprice.customers.createCustomer({
|
|
113
|
-
contactPersons: [],
|
|
114
109
|
externalId: "<id>",
|
|
115
110
|
name: "<value>",
|
|
116
111
|
});
|
|
@@ -137,7 +132,6 @@ const flexprice = new FlexpriceCore({
|
|
|
137
132
|
|
|
138
133
|
async function run() {
|
|
139
134
|
const res = await customersCreateCustomer(flexprice, {
|
|
140
|
-
contactPersons: [],
|
|
141
135
|
externalId: "<id>",
|
|
142
136
|
name: "<value>",
|
|
143
137
|
});
|
|
@@ -29,6 +29,8 @@
|
|
|
29
29
|
* [createSubscriptionLineItem](#createsubscriptionlineitem) - Create subscription line item
|
|
30
30
|
* [executeSubscriptionModify](#executesubscriptionmodify) - Execute subscription modification
|
|
31
31
|
* [previewSubscriptionModify](#previewsubscriptionmodify) - Preview subscription modification
|
|
32
|
+
* [pauseSubscription](#pausesubscription) - Pause subscription
|
|
33
|
+
* [resumeSubscription](#resumesubscription) - Resume subscription
|
|
32
34
|
* [listSubscriptionSchedules](#listsubscriptionschedules) - List subscription schedules
|
|
33
35
|
* [getSubscriptionV2](#getsubscriptionv2) - Get subscription (V2)
|
|
34
36
|
|
|
@@ -1911,6 +1913,150 @@ run();
|
|
|
1911
1913
|
| models.ErrorsErrorResponse | 500 | application/json |
|
|
1912
1914
|
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1913
1915
|
|
|
1916
|
+
## pauseSubscription
|
|
1917
|
+
|
|
1918
|
+
Use when a customer stops temporarily. Pauses an active subscription now: usage and arrear fixed charges up to the pause are billed on a closing invoice, and every paused period after it gets a $0 skipped invoice.
|
|
1919
|
+
|
|
1920
|
+
### Example Usage
|
|
1921
|
+
|
|
1922
|
+
<!-- UsageSnippet language="typescript" operationID="pauseSubscription" method="post" path="/subscriptions/{id}/pause" -->
|
|
1923
|
+
```typescript
|
|
1924
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1925
|
+
|
|
1926
|
+
const flexprice = new Flexprice({
|
|
1927
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1928
|
+
});
|
|
1929
|
+
|
|
1930
|
+
async function run() {
|
|
1931
|
+
const result = await flexprice.subscriptions.pauseSubscription("<id>", {});
|
|
1932
|
+
|
|
1933
|
+
console.log(result);
|
|
1934
|
+
}
|
|
1935
|
+
|
|
1936
|
+
run();
|
|
1937
|
+
```
|
|
1938
|
+
|
|
1939
|
+
### Standalone function
|
|
1940
|
+
|
|
1941
|
+
The standalone function version of this method:
|
|
1942
|
+
|
|
1943
|
+
```typescript
|
|
1944
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1945
|
+
import { subscriptionsPauseSubscription } from "@flexprice/sdk/funcs/subscriptions-pause-subscription.js";
|
|
1946
|
+
|
|
1947
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1948
|
+
// You can create one instance of it to use across an application.
|
|
1949
|
+
const flexprice = new FlexpriceCore({
|
|
1950
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1951
|
+
});
|
|
1952
|
+
|
|
1953
|
+
async function run() {
|
|
1954
|
+
const res = await subscriptionsPauseSubscription(flexprice, "<id>", {});
|
|
1955
|
+
if (res.ok) {
|
|
1956
|
+
const { value: result } = res;
|
|
1957
|
+
console.log(result);
|
|
1958
|
+
} else {
|
|
1959
|
+
console.log("subscriptionsPauseSubscription failed:", res.error);
|
|
1960
|
+
}
|
|
1961
|
+
}
|
|
1962
|
+
|
|
1963
|
+
run();
|
|
1964
|
+
```
|
|
1965
|
+
|
|
1966
|
+
### Parameters
|
|
1967
|
+
|
|
1968
|
+
| Parameter | Type | Required | Description |
|
|
1969
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1970
|
+
| `id` | *string* | :heavy_check_mark: | Subscription ID |
|
|
1971
|
+
| `body` | [models.PauseSubscriptionRequest](../../sdk/models/pause-subscription-request.md) | :heavy_check_mark: | Pause subscription request |
|
|
1972
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1973
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1974
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1975
|
+
|
|
1976
|
+
### Response
|
|
1977
|
+
|
|
1978
|
+
**Promise\<[models.PauseSubscriptionResponse](../../sdk/models/pause-subscription-response.md)\>**
|
|
1979
|
+
|
|
1980
|
+
### Errors
|
|
1981
|
+
|
|
1982
|
+
| Error Type | Status Code | Content Type |
|
|
1983
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
1984
|
+
| models.ErrorsErrorResponse | 400, 404 | application/json |
|
|
1985
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
1986
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1987
|
+
|
|
1988
|
+
## resumeSubscription
|
|
1989
|
+
|
|
1990
|
+
Use when a paused customer comes back. Resumes a paused subscription now on its existing billing anchor: the first period runs from the resume to the next billing date and its advance charges are invoiced at once.
|
|
1991
|
+
|
|
1992
|
+
### Example Usage
|
|
1993
|
+
|
|
1994
|
+
<!-- UsageSnippet language="typescript" operationID="resumeSubscription" method="post" path="/subscriptions/{id}/resume" -->
|
|
1995
|
+
```typescript
|
|
1996
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
1997
|
+
|
|
1998
|
+
const flexprice = new Flexprice({
|
|
1999
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2000
|
+
});
|
|
2001
|
+
|
|
2002
|
+
async function run() {
|
|
2003
|
+
const result = await flexprice.subscriptions.resumeSubscription("<id>", {});
|
|
2004
|
+
|
|
2005
|
+
console.log(result);
|
|
2006
|
+
}
|
|
2007
|
+
|
|
2008
|
+
run();
|
|
2009
|
+
```
|
|
2010
|
+
|
|
2011
|
+
### Standalone function
|
|
2012
|
+
|
|
2013
|
+
The standalone function version of this method:
|
|
2014
|
+
|
|
2015
|
+
```typescript
|
|
2016
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
2017
|
+
import { subscriptionsResumeSubscription } from "@flexprice/sdk/funcs/subscriptions-resume-subscription.js";
|
|
2018
|
+
|
|
2019
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
2020
|
+
// You can create one instance of it to use across an application.
|
|
2021
|
+
const flexprice = new FlexpriceCore({
|
|
2022
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
2023
|
+
});
|
|
2024
|
+
|
|
2025
|
+
async function run() {
|
|
2026
|
+
const res = await subscriptionsResumeSubscription(flexprice, "<id>", {});
|
|
2027
|
+
if (res.ok) {
|
|
2028
|
+
const { value: result } = res;
|
|
2029
|
+
console.log(result);
|
|
2030
|
+
} else {
|
|
2031
|
+
console.log("subscriptionsResumeSubscription failed:", res.error);
|
|
2032
|
+
}
|
|
2033
|
+
}
|
|
2034
|
+
|
|
2035
|
+
run();
|
|
2036
|
+
```
|
|
2037
|
+
|
|
2038
|
+
### Parameters
|
|
2039
|
+
|
|
2040
|
+
| Parameter | Type | Required | Description |
|
|
2041
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2042
|
+
| `id` | *string* | :heavy_check_mark: | Subscription ID |
|
|
2043
|
+
| `body` | [models.ResumeSubscriptionRequest](../../sdk/models/resume-subscription-request.md) | :heavy_check_mark: | Resume subscription request |
|
|
2044
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2045
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2046
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2047
|
+
|
|
2048
|
+
### Response
|
|
2049
|
+
|
|
2050
|
+
**Promise\<[models.ResumeSubscriptionResponse](../../sdk/models/resume-subscription-response.md)\>**
|
|
2051
|
+
|
|
2052
|
+
### Errors
|
|
2053
|
+
|
|
2054
|
+
| Error Type | Status Code | Content Type |
|
|
2055
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
2056
|
+
| models.ErrorsErrorResponse | 400, 404 | application/json |
|
|
2057
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
2058
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
2059
|
+
|
|
1914
2060
|
## listSubscriptionSchedules
|
|
1915
2061
|
|
|
1916
2062
|
Use when listing scheduled changes for a subscription (e.g. upcoming plan change or renewal). Returns all schedules for that subscription.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { FlexpriceCore } from "../core.js";
|
|
2
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
3
|
+
import { FlexPriceError } from "../sdk/models/flex-price-error.js";
|
|
4
|
+
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../sdk/models/http-client-errors.js";
|
|
5
|
+
import * as models from "../sdk/models/index.js";
|
|
6
|
+
import { ResponseValidationError } from "../sdk/models/response-validation-error.js";
|
|
7
|
+
import { SDKValidationError } from "../sdk/models/sdk-validation-error.js";
|
|
8
|
+
import { APIPromise } from "../types/async.js";
|
|
9
|
+
import { Result } from "../types/fp.js";
|
|
10
|
+
/**
|
|
11
|
+
* Get activity
|
|
12
|
+
*
|
|
13
|
+
* @remarks
|
|
14
|
+
* Use when you need one activity entry with the state of the entity right after the change.
|
|
15
|
+
*/
|
|
16
|
+
export declare function activityGetActivity(client: FlexpriceCore, id: string, options?: RequestOptions): APIPromise<Result<models.ActivityResponse, models.ErrorsErrorResponse | FlexPriceError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
17
|
+
//# sourceMappingURL=activity-get-activity.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"activity-get-activity.d.ts","sourceRoot":"","sources":["../../src/funcs/activity-get-activity.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAM3C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACnE,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,KAAK,MAAM,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,uBAAuB,EAAE,MAAM,4CAA4C,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAC3E,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,aAAa,EACrB,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,MAAM,CAAC,gBAAgB,EACrB,MAAM,CAAC,mBAAmB,GAC1B,cAAc,GACd,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
import * as z from "zod/v4-mini";
|
|
5
|
+
import { encodeSimple } from "../lib/encodings.js";
|
|
6
|
+
import { matchStatusCode } from "../lib/http.js";
|
|
7
|
+
import * as M from "../lib/matchers.js";
|
|
8
|
+
import { compactMap } from "../lib/primitives.js";
|
|
9
|
+
import { safeParse } from "../lib/schemas.js";
|
|
10
|
+
import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
|
|
11
|
+
import { pathToFunc } from "../lib/url.js";
|
|
12
|
+
import * as models from "../sdk/models/index.js";
|
|
13
|
+
import { APIPromise } from "../types/async.js";
|
|
14
|
+
/**
|
|
15
|
+
* Get activity
|
|
16
|
+
*
|
|
17
|
+
* @remarks
|
|
18
|
+
* Use when you need one activity entry with the state of the entity right after the change.
|
|
19
|
+
*/
|
|
20
|
+
export function activityGetActivity(client, id, options) {
|
|
21
|
+
return new APIPromise($do(client, id, options));
|
|
22
|
+
}
|
|
23
|
+
async function $do(client, id, options) {
|
|
24
|
+
const input = {
|
|
25
|
+
id: id,
|
|
26
|
+
};
|
|
27
|
+
const parsed = safeParse(input, (value) => z.parse(models.GetActivityRequest$outboundSchema, value), "Input validation failed");
|
|
28
|
+
if (!parsed.ok) {
|
|
29
|
+
return [parsed, { status: "invalid" }];
|
|
30
|
+
}
|
|
31
|
+
const payload = parsed.value;
|
|
32
|
+
const body = null;
|
|
33
|
+
const pathParams = {
|
|
34
|
+
id: encodeSimple("id", payload.id, {
|
|
35
|
+
explode: false,
|
|
36
|
+
charEncoding: "percent",
|
|
37
|
+
}),
|
|
38
|
+
};
|
|
39
|
+
const path = pathToFunc("/activity/{id}")(pathParams);
|
|
40
|
+
const headers = new Headers(compactMap({
|
|
41
|
+
Accept: "application/json",
|
|
42
|
+
}));
|
|
43
|
+
const secConfig = await extractSecurity(client._options.apiKeyAuth);
|
|
44
|
+
const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
|
|
45
|
+
const requestSecurity = resolveGlobalSecurity(securityInput);
|
|
46
|
+
const context = {
|
|
47
|
+
options: client._options,
|
|
48
|
+
baseURL: options?.serverURL ?? client._baseURL ?? "",
|
|
49
|
+
operationID: "getActivity",
|
|
50
|
+
oAuth2Scopes: null,
|
|
51
|
+
resolvedSecurity: requestSecurity,
|
|
52
|
+
securitySource: client._options.apiKeyAuth,
|
|
53
|
+
retryConfig: options?.retries
|
|
54
|
+
|| client._options.retryConfig
|
|
55
|
+
|| { strategy: "none" },
|
|
56
|
+
retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
|
|
57
|
+
};
|
|
58
|
+
const requestRes = client._createRequest(context, {
|
|
59
|
+
security: requestSecurity,
|
|
60
|
+
method: "GET",
|
|
61
|
+
baseURL: options?.serverURL,
|
|
62
|
+
path: path,
|
|
63
|
+
headers: headers,
|
|
64
|
+
body: body,
|
|
65
|
+
userAgent: client._options.userAgent,
|
|
66
|
+
timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
|
|
67
|
+
}, options);
|
|
68
|
+
if (!requestRes.ok) {
|
|
69
|
+
return [requestRes, { status: "invalid" }];
|
|
70
|
+
}
|
|
71
|
+
const req = requestRes.value;
|
|
72
|
+
const doResult = await client._do(req, {
|
|
73
|
+
context,
|
|
74
|
+
isErrorStatusCode: (statusCode) => matchStatusCode({ status: statusCode }, ["4XX", "5XX"]),
|
|
75
|
+
retryConfig: context.retryConfig,
|
|
76
|
+
retryCodes: context.retryCodes,
|
|
77
|
+
});
|
|
78
|
+
if (!doResult.ok) {
|
|
79
|
+
return [doResult, { status: "request-error", request: req }];
|
|
80
|
+
}
|
|
81
|
+
const response = doResult.value;
|
|
82
|
+
const responseFields = {
|
|
83
|
+
HttpMeta: { Response: response, Request: req },
|
|
84
|
+
};
|
|
85
|
+
const [result] = await M.match(M.json(200, models.ActivityResponse$inboundSchema), M.jsonErr([400, 404], models.ErrorsErrorResponse$inboundSchema), M.jsonErr(500, models.ErrorsErrorResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
|
|
86
|
+
if (!result.ok) {
|
|
87
|
+
return [result, { status: "complete", request: req, response }];
|
|
88
|
+
}
|
|
89
|
+
return [result, { status: "complete", request: req, response }];
|
|
90
|
+
}
|
|
91
|
+
//# sourceMappingURL=activity-get-activity.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"activity-get-activity.js","sourceRoot":"","sources":["../../src/funcs/activity-get-activity.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,aAAa,CAAC;AAEjC,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,CAAC,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAS3C,OAAO,KAAK,MAAM,MAAM,wBAAwB,CAAC;AAGjD,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAGxD;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,MAAqB,EACrB,EAAU,EACV,OAAwB,EAcxB;IACA,OAAO,IAAI,UAAU,CAAC,GAAG,CACvB,MAAM,EACN,EAAE,EACF,OAAO,CACR,CAAC,CAAC;AAAA,CACJ;AAED,KAAK,UAAU,GAAG,CAChB,MAAqB,EACrB,EAAU,EACV,OAAwB,EAiBxB;IACA,MAAM,KAAK,GAA8B;QACvC,EAAE,EAAE,EAAE;KACP,CAAC;IAEF,MAAM,MAAM,GAAG,SAAS,CACtB,KAAK,EACL,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,iCAAiC,EAAE,KAAK,CAAC,EACnE,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC;IAElB,MAAM,UAAU,GAAG;QACjB,EAAE,EAAE,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE;YACjC,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IACF,MAAM,IAAI,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC,UAAU,CAAC,CAAC;IAEtD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;QACrC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IACpE,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;IACzE,MAAM,eAAe,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,aAAa;QAC1B,YAAY,EAAE,IAAI;QAElB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,UAAU;QAC1C,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,iBAAiB,EAAE,CAAC,UAAkB,EAAE,EAAE,CACxC,eAAe,CAAC,EAAE,MAAM,EAAE,UAAU,EAAc,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACrE,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAY5B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,8BAA8B,CAAC,EAClD,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,iCAAiC,CAAC,EAC/D,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,iCAAiC,CAAC,EACxD,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAAA,CACjE"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { FlexpriceCore } from "../core.js";
|
|
2
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
3
|
+
import { FlexPriceError } from "../sdk/models/flex-price-error.js";
|
|
4
|
+
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../sdk/models/http-client-errors.js";
|
|
5
|
+
import * as models from "../sdk/models/index.js";
|
|
6
|
+
import { ResponseValidationError } from "../sdk/models/response-validation-error.js";
|
|
7
|
+
import { SDKValidationError } from "../sdk/models/sdk-validation-error.js";
|
|
8
|
+
import { APIPromise } from "../types/async.js";
|
|
9
|
+
import { Result } from "../types/fp.js";
|
|
10
|
+
/**
|
|
11
|
+
* List activity
|
|
12
|
+
*
|
|
13
|
+
* @remarks
|
|
14
|
+
* Use when you need the audit trail of changes to billing entities: who changed what, when, from where. Filter by entity, customer, actor, action or request; pages are newest first.
|
|
15
|
+
*/
|
|
16
|
+
export declare function activityListActivity(client: FlexpriceCore, request: models.ListActivityRequest, options?: RequestOptions): APIPromise<Result<models.ListActivityResponse, models.ErrorsErrorResponse | FlexPriceError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
17
|
+
//# sourceMappingURL=activity-list-activity.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"activity-list-activity.d.ts","sourceRoot":"","sources":["../../src/funcs/activity-list-activity.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAM3C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AACnE,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,KAAK,MAAM,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,uBAAuB,EAAE,MAAM,4CAA4C,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAC3E,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,MAAM,CAAC,mBAAmB,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,MAAM,CAAC,oBAAoB,EACzB,MAAM,CAAC,mBAAmB,GAC1B,cAAc,GACd,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}
|