@flexprice/sdk 2.1.24 → 2.1.26
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/docs/sdk/models/billing-period-behaviour.md +17 -0
- package/docs/sdk/models/billing-period-config.md +18 -0
- package/docs/sdk/models/create-entitlement-request.md +22 -21
- package/docs/sdk/models/create-entity-integration-mapping-request.md +1 -1
- package/docs/sdk/models/credit-grant-application-response.md +1 -1
- package/docs/sdk/models/entitlement-grant-allocation-behavior.md +17 -0
- package/docs/sdk/models/entitlement-grant-duration-unit.md +1 -1
- package/docs/sdk/models/entitlement-response.md +34 -33
- package/docs/sdk/models/entity-change-behaviour.md +2 -2
- package/docs/sdk/models/entity-change-policy.md +4 -4
- package/docs/sdk/models/entity-change-result.md +6 -6
- package/docs/sdk/models/integration-entity-type.md +2 -2
- package/docs/sdk/models/invoice-sync-settings.md +6 -3
- package/docs/sdk/models/link-integration-mapping-request.md +1 -1
- package/docs/sdk/models/list-usage-records-response.md +16 -0
- package/docs/sdk/models/metadata-custom-field-source.md +17 -0
- package/docs/sdk/models/metadata-custom-field.md +17 -0
- package/docs/sdk/models/on-pending-schedule-policy.md +15 -0
- package/docs/sdk/models/plan-price-sync-status-response.md +17 -0
- package/docs/sdk/models/plan-response.md +1 -0
- package/docs/sdk/models/price-feature-response.md +15 -0
- package/docs/sdk/models/price-response.md +1 -0
- package/docs/sdk/models/service-period-custom-fields.md +16 -0
- package/docs/sdk/models/subscription-change-billing-period-result.md +18 -0
- package/docs/sdk/models/subscription-change-conflict-policies.md +15 -0
- package/docs/sdk/models/subscription-change-entity-type.md +17 -0
- package/docs/sdk/models/subscription-change-v2-request.md +11 -7
- package/docs/sdk/models/subscription-change-v2-response.md +16 -11
- package/docs/sdk/models/update-entitlement-request.md +1 -0
- package/docs/sdk/models/usage-record-filter-order.md +15 -0
- package/docs/sdk/models/usage-record-filter.md +31 -0
- package/docs/sdk/models/usage-record-response.md +33 -0
- package/docs/sdk/models/usage-record-sync-entry.md +20 -0
- package/docs/sdks/costs/README.md +0 -72
- package/docs/sdks/integrations/README.md +4 -4
- package/docs/sdks/prices/README.md +1 -1
- package/docs/sdks/subscriptions/README.md +8 -0
- package/docs/sdks/usagerecords/README.md +78 -0
- package/esm/funcs/prices-get-price-by-lookup-key.js +1 -1
- package/esm/funcs/prices-get-price-by-lookup-key.js.map +1 -1
- package/esm/funcs/subscriptions-execute-subscription-plan-change-v2.d.ts +8 -0
- package/esm/funcs/subscriptions-execute-subscription-plan-change-v2.d.ts.map +1 -1
- package/esm/funcs/subscriptions-execute-subscription-plan-change-v2.js +8 -0
- package/esm/funcs/subscriptions-execute-subscription-plan-change-v2.js.map +1 -1
- package/esm/funcs/usage-records-post-usage-records-search.d.ts +17 -0
- package/esm/funcs/usage-records-post-usage-records-search.d.ts.map +1 -0
- package/esm/funcs/{costs-get-detailed-cost-analytics-v2.js → usage-records-post-usage-records-search.js} +8 -8
- package/esm/funcs/usage-records-post-usage-records-search.js.map +1 -0
- package/esm/lib/config.d.ts +3 -3
- package/esm/lib/config.js +3 -3
- package/esm/sdk/costs.d.ts +0 -7
- package/esm/sdk/costs.d.ts.map +1 -1
- package/esm/sdk/costs.js +0 -10
- package/esm/sdk/costs.js.map +1 -1
- package/esm/sdk/models/billing-period-behaviour.d.ts +13 -0
- package/esm/sdk/models/billing-period-behaviour.d.ts.map +1 -0
- package/esm/sdk/models/billing-period-behaviour.js +14 -0
- package/esm/sdk/models/billing-period-behaviour.js.map +1 -0
- package/esm/sdk/models/billing-period-config.d.ts +20 -0
- package/esm/sdk/models/billing-period-config.d.ts.map +1 -0
- package/esm/sdk/models/billing-period-config.js +25 -0
- package/esm/sdk/models/billing-period-config.js.map +1 -0
- package/esm/sdk/models/create-entitlement-request.d.ts +3 -0
- package/esm/sdk/models/create-entitlement-request.d.ts.map +1 -1
- package/esm/sdk/models/create-entitlement-request.js +3 -0
- package/esm/sdk/models/create-entitlement-request.js.map +1 -1
- package/esm/sdk/models/credit-grant-application-response.d.ts +1 -1
- package/esm/sdk/models/credit-grant-application-response.js +1 -1
- package/esm/sdk/models/entitlement-grant-allocation-behavior.d.ts +12 -0
- package/esm/sdk/models/entitlement-grant-allocation-behavior.d.ts.map +1 -0
- package/esm/sdk/models/entitlement-grant-allocation-behavior.js +13 -0
- package/esm/sdk/models/entitlement-grant-allocation-behavior.js.map +1 -0
- package/esm/sdk/models/entitlement-grant-duration-unit.d.ts +1 -0
- package/esm/sdk/models/entitlement-grant-duration-unit.d.ts.map +1 -1
- package/esm/sdk/models/entitlement-grant-duration-unit.js +1 -0
- package/esm/sdk/models/entitlement-grant-duration-unit.js.map +1 -1
- package/esm/sdk/models/entitlement-response.d.ts +3 -1
- package/esm/sdk/models/entitlement-response.d.ts.map +1 -1
- package/esm/sdk/models/entitlement-response.js +4 -1
- package/esm/sdk/models/entitlement-response.js.map +1 -1
- package/esm/sdk/models/entity-change-behaviour.d.ts +1 -0
- package/esm/sdk/models/entity-change-behaviour.d.ts.map +1 -1
- package/esm/sdk/models/entity-change-behaviour.js +1 -0
- package/esm/sdk/models/entity-change-behaviour.js.map +1 -1
- package/esm/sdk/models/entity-change-policy.d.ts +3 -0
- package/esm/sdk/models/entity-change-policy.d.ts.map +1 -1
- package/esm/sdk/models/entity-change-policy.js.map +1 -1
- package/esm/sdk/models/entity-change-result.d.ts +2 -2
- package/esm/sdk/models/entity-change-result.d.ts.map +1 -1
- package/esm/sdk/models/entity-change-result.js +2 -2
- package/esm/sdk/models/entity-change-result.js.map +1 -1
- package/esm/sdk/models/index.d.ts +16 -0
- package/esm/sdk/models/index.d.ts.map +1 -1
- package/esm/sdk/models/index.js +16 -0
- package/esm/sdk/models/index.js.map +1 -1
- package/esm/sdk/models/integration-entity-type.d.ts +1 -0
- package/esm/sdk/models/integration-entity-type.d.ts.map +1 -1
- package/esm/sdk/models/integration-entity-type.js +1 -0
- package/esm/sdk/models/integration-entity-type.js.map +1 -1
- package/esm/sdk/models/invoice-sync-settings.d.ts +19 -0
- package/esm/sdk/models/invoice-sync-settings.d.ts.map +1 -1
- package/esm/sdk/models/invoice-sync-settings.js +8 -0
- package/esm/sdk/models/invoice-sync-settings.js.map +1 -1
- package/esm/sdk/models/list-usage-records-response.d.ts +13 -0
- package/esm/sdk/models/list-usage-records-response.d.ts.map +1 -0
- package/esm/sdk/models/list-usage-records-response.js +17 -0
- package/esm/sdk/models/list-usage-records-response.js.map +1 -0
- package/esm/sdk/models/metadata-custom-field-source.d.ts +10 -0
- package/esm/sdk/models/metadata-custom-field-source.d.ts.map +1 -0
- package/esm/sdk/models/metadata-custom-field-source.js +11 -0
- package/esm/sdk/models/metadata-custom-field-source.js.map +1 -0
- package/esm/sdk/models/metadata-custom-field.d.ts +13 -0
- package/esm/sdk/models/metadata-custom-field.d.ts.map +1 -0
- package/esm/sdk/models/metadata-custom-field.js +22 -0
- package/esm/sdk/models/metadata-custom-field.js.map +1 -0
- package/esm/sdk/models/on-pending-schedule-policy.d.ts +10 -0
- package/esm/sdk/models/on-pending-schedule-policy.d.ts.map +1 -0
- package/esm/sdk/models/on-pending-schedule-policy.js +11 -0
- package/esm/sdk/models/on-pending-schedule-policy.js.map +1 -0
- package/esm/sdk/models/plan-price-sync-status-response.d.ts +12 -0
- package/esm/sdk/models/plan-price-sync-status-response.d.ts.map +1 -0
- package/esm/sdk/models/plan-price-sync-status-response.js +22 -0
- package/esm/sdk/models/plan-price-sync-status-response.js.map +1 -0
- package/esm/sdk/models/plan-response.d.ts +2 -0
- package/esm/sdk/models/plan-response.d.ts.map +1 -1
- package/esm/sdk/models/plan-response.js +3 -0
- package/esm/sdk/models/plan-response.js.map +1 -1
- package/esm/sdk/models/price-feature-response.d.ts +11 -0
- package/esm/sdk/models/price-feature-response.d.ts.map +1 -0
- package/esm/sdk/models/price-feature-response.js +20 -0
- package/esm/sdk/models/price-feature-response.js.map +1 -0
- package/esm/sdk/models/price-response.d.ts +2 -0
- package/esm/sdk/models/price-response.d.ts.map +1 -1
- package/esm/sdk/models/price-response.js +2 -0
- package/esm/sdk/models/price-response.js.map +1 -1
- package/esm/sdk/models/service-period-custom-fields.d.ts +11 -0
- package/esm/sdk/models/service-period-custom-fields.d.ts.map +1 -0
- package/esm/sdk/models/service-period-custom-fields.js +21 -0
- package/esm/sdk/models/service-period-custom-fields.js.map +1 -0
- package/esm/sdk/models/subscription-change-billing-period-result.d.ts +14 -0
- package/esm/sdk/models/subscription-change-billing-period-result.d.ts.map +1 -0
- package/esm/sdk/models/subscription-change-billing-period-result.js +25 -0
- package/esm/sdk/models/subscription-change-billing-period-result.js.map +1 -0
- package/esm/sdk/models/subscription-change-conflict-policies.d.ts +13 -0
- package/esm/sdk/models/subscription-change-conflict-policies.d.ts.map +1 -0
- package/esm/sdk/models/subscription-change-conflict-policies.js +18 -0
- package/esm/sdk/models/subscription-change-conflict-policies.js.map +1 -0
- package/esm/sdk/models/subscription-change-entity-type.d.ts +13 -0
- package/esm/sdk/models/subscription-change-entity-type.d.ts.map +1 -0
- package/esm/sdk/models/subscription-change-entity-type.js +14 -0
- package/esm/sdk/models/subscription-change-entity-type.js.map +1 -0
- package/esm/sdk/models/subscription-change-v2-request.d.ts +12 -0
- package/esm/sdk/models/subscription-change-v2-request.d.ts.map +1 -1
- package/esm/sdk/models/subscription-change-v2-request.js +12 -0
- package/esm/sdk/models/subscription-change-v2-request.js.map +1 -1
- package/esm/sdk/models/subscription-change-v2-response.d.ts +18 -0
- package/esm/sdk/models/subscription-change-v2-response.d.ts.map +1 -1
- package/esm/sdk/models/subscription-change-v2-response.js +11 -0
- package/esm/sdk/models/subscription-change-v2-response.js.map +1 -1
- package/esm/sdk/models/update-entitlement-request.d.ts +3 -0
- package/esm/sdk/models/update-entitlement-request.d.ts.map +1 -1
- package/esm/sdk/models/update-entitlement-request.js +3 -0
- package/esm/sdk/models/update-entitlement-request.js.map +1 -1
- package/esm/sdk/models/usage-record-filter.d.ts +67 -0
- package/esm/sdk/models/usage-record-filter.d.ts.map +1 -0
- package/esm/sdk/models/usage-record-filter.js +49 -0
- package/esm/sdk/models/usage-record-filter.js.map +1 -0
- package/esm/sdk/models/usage-record-response.d.ts +32 -0
- package/esm/sdk/models/usage-record-response.d.ts.map +1 -0
- package/esm/sdk/models/usage-record-response.js +50 -0
- package/esm/sdk/models/usage-record-response.js.map +1 -0
- package/esm/sdk/models/usage-record-sync-entry.d.ts +32 -0
- package/esm/sdk/models/usage-record-sync-entry.d.ts.map +1 -0
- package/esm/sdk/models/usage-record-sync-entry.js +28 -0
- package/esm/sdk/models/usage-record-sync-entry.js.map +1 -0
- 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 +8 -0
- package/esm/sdk/subscriptions.d.ts.map +1 -1
- package/esm/sdk/subscriptions.js +8 -0
- package/esm/sdk/subscriptions.js.map +1 -1
- package/esm/sdk/usage-records.d.ts +12 -0
- package/esm/sdk/usage-records.d.ts.map +1 -0
- package/esm/sdk/usage-records.js +18 -0
- package/esm/sdk/usage-records.js.map +1 -0
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/prices-get-price-by-lookup-key.ts +1 -1
- package/src/funcs/subscriptions-execute-subscription-plan-change-v2.ts +8 -0
- package/src/funcs/{costs-get-detailed-cost-analytics-v2.ts → usage-records-post-usage-records-search.ts} +12 -12
- package/src/lib/config.ts +3 -3
- package/src/sdk/costs.ts +0 -18
- package/src/sdk/models/billing-period-behaviour.ts +25 -0
- package/src/sdk/models/billing-period-config.ts +57 -0
- package/src/sdk/models/create-entitlement-request.ts +10 -0
- package/src/sdk/models/credit-grant-application-response.ts +2 -2
- package/src/sdk/models/entitlement-grant-allocation-behavior.ts +26 -0
- package/src/sdk/models/entitlement-grant-duration-unit.ts +1 -0
- package/src/sdk/models/entitlement-response.ts +11 -2
- package/src/sdk/models/entity-change-behaviour.ts +1 -0
- package/src/sdk/models/entity-change-policy.ts +3 -0
- package/src/sdk/models/entity-change-result.ts +5 -5
- package/src/sdk/models/index.ts +16 -0
- package/src/sdk/models/integration-entity-type.ts +1 -0
- package/src/sdk/models/invoice-sync-settings.ts +35 -0
- package/src/sdk/models/list-usage-records-response.ts +41 -0
- package/src/sdk/models/metadata-custom-field-source.ts +21 -0
- package/src/sdk/models/metadata-custom-field.ts +47 -0
- package/src/sdk/models/on-pending-schedule-policy.ts +19 -0
- package/src/sdk/models/plan-price-sync-status-response.ts +44 -0
- package/src/sdk/models/plan-response.ts +9 -0
- package/src/sdk/models/price-feature-response.ts +43 -0
- package/src/sdk/models/price-response.ts +6 -0
- package/src/sdk/models/service-period-custom-fields.ts +42 -0
- package/src/sdk/models/subscription-change-billing-period-result.ts +52 -0
- package/src/sdk/models/subscription-change-conflict-policies.ts +44 -0
- package/src/sdk/models/subscription-change-entity-type.ts +24 -0
- package/src/sdk/models/subscription-change-v2-request.ts +35 -0
- package/src/sdk/models/subscription-change-v2-response.ts +33 -0
- package/src/sdk/models/update-entitlement-request.ts +10 -0
- package/src/sdk/models/usage-record-filter.ts +130 -0
- package/src/sdk/models/usage-record-response.ts +93 -0
- package/src/sdk/models/usage-record-sync-entry.ts +70 -0
- package/src/sdk/sdk.ts +6 -0
- package/src/sdk/subscriptions.ts +8 -0
- package/src/sdk/usage-records.ts +27 -0
- package/esm/funcs/costs-get-detailed-cost-analytics-v2.d.ts +0 -17
- package/esm/funcs/costs-get-detailed-cost-analytics-v2.d.ts.map +0 -1
- package/esm/funcs/costs-get-detailed-cost-analytics-v2.js.map +0 -1
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# SubscriptionChangeBillingPeriodResult
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { SubscriptionChangeBillingPeriodResult } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: SubscriptionChangeBillingPeriodResult = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `behaviour` | [models.BillingPeriodBehaviour](../../sdk/models/billing-period-behaviour.md) | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `billingAnchor` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `currentPeriodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `currentPeriodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# SubscriptionChangeConflictPolicies
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { SubscriptionChangeConflictPolicies } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: SubscriptionChangeConflictPolicies = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
|
15
|
+
| `onPendingSchedule` | [models.OnPendingSchedulePolicy](../../sdk/models/on-pending-schedule-policy.md) | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# SubscriptionChangeEntityType
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { SubscriptionChangeEntityType } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: SubscriptionChangeEntityType = "addon";
|
|
9
|
+
|
|
10
|
+
// Open enum: unrecognized values are captured as Unrecognized<string>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Values
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
"plan" | "addon" | "credit_grant" | "entitlement" | "entitlement_grant" | Unrecognized<string>
|
|
17
|
+
```
|
|
@@ -13,10 +13,14 @@ let value: SubscriptionChangeV2Request = {
|
|
|
13
13
|
|
|
14
14
|
## Fields
|
|
15
15
|
|
|
16
|
-
| Field
|
|
17
|
-
|
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
16
|
+
| Field | Type | Required | Description |
|
|
17
|
+
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
|
18
|
+
| `billingPeriodBehaviour` | [models.BillingPeriodBehaviour](../../sdk/models/billing-period-behaviour.md) | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `billingPeriodConfig` | [models.BillingPeriodConfig](../../sdk/models/billing-period-config.md) | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `changeAt` | [models.ScheduleType](../../sdk/models/schedule-type.md) | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `entityPolicies` | [models.SubscriptionChangeEntityPolicies](../../sdk/models/subscription-change-entity-policies.md) | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `idempotencyKey` | *string* | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
24
|
+
| `onConflictPolicies` | [models.SubscriptionChangeConflictPolicies](../../sdk/models/subscription-change-conflict-policies.md) | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `prorationBehavior` | [models.ProrationBehavior](../../sdk/models/proration-behavior.md) | :heavy_check_mark: | N/A |
|
|
26
|
+
| `targetPlanId` | *string* | :heavy_check_mark: | N/A |
|
|
@@ -235,14 +235,19 @@ let value: SubscriptionChangeV2Response = {
|
|
|
235
235
|
|
|
236
236
|
## Fields
|
|
237
237
|
|
|
238
|
-
| Field
|
|
239
|
-
|
|
|
240
|
-
| `
|
|
241
|
-
| `
|
|
242
|
-
| `
|
|
243
|
-
| `
|
|
244
|
-
| `
|
|
245
|
-
| `
|
|
246
|
-
| `
|
|
247
|
-
| `
|
|
248
|
-
| `
|
|
238
|
+
| Field | Type | Required | Description |
|
|
239
|
+
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
240
|
+
| `billingPeriod` | [models.SubscriptionChangeBillingPeriodResult](../../sdk/models/subscription-change-billing-period-result.md) | :heavy_minus_sign: | N/A |
|
|
241
|
+
| `changeType` | [models.SubscriptionChangeType](../../sdk/models/subscription-change-type.md) | :heavy_minus_sign: | N/A |
|
|
242
|
+
| `changedResources` | [models.ChangedResources](../../sdk/models/changed-resources.md) | :heavy_minus_sign: | N/A |
|
|
243
|
+
| `effectiveAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
244
|
+
| `entityChanges` | [models.EntityChangeResult](../../sdk/models/entity-change-result.md)[] | :heavy_minus_sign: | N/A |
|
|
245
|
+
| `fromPlan` | [models.PlanSummary](../../sdk/models/plan-summary.md) | :heavy_minus_sign: | N/A |
|
|
246
|
+
| `isScheduled` | *boolean* | :heavy_minus_sign: | IsScheduled is true when the change was deferred to the period end instead<br/>of being applied immediately. |
|
|
247
|
+
| `metadata` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
|
248
|
+
| `scheduleId` | *string* | :heavy_minus_sign: | N/A |
|
|
249
|
+
| `scheduledAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
250
|
+
| `subscription` | [models.SubscriptionResponse](../../sdk/models/subscription-response.md) | :heavy_minus_sign: | N/A |
|
|
251
|
+
| `supersededSchedules` | *string*[] | :heavy_minus_sign: | SupersededSchedules lists the plan-change schedules this request cancelled under<br/>on_conflict_policies.on_pending_schedule. Preview reports what execute would cancel. |
|
|
252
|
+
| `toPlan` | [models.PlanSummary](../../sdk/models/plan-summary.md) | :heavy_minus_sign: | N/A |
|
|
253
|
+
| `warnings` | *string*[] | :heavy_minus_sign: | N/A |
|
|
@@ -15,6 +15,7 @@ let value: UpdateEntitlementRequest = {};
|
|
|
15
15
|
| `aggregationMode` | [models.EntitlementAggregationMode](../../sdk/models/entitlement-aggregation-mode.md) | :heavy_minus_sign: | N/A |
|
|
16
16
|
| `clearGrantConfig` | *boolean* | :heavy_minus_sign: | Grant config — nil fields leave the current value alone.<br/>ClearGrantConfig=true wipes the whole grant config (back to a legacy entitlement). |
|
|
17
17
|
| `configValue` | Record<string, *any*> | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `grantAllocationBehavior` | [models.EntitlementGrantAllocationBehavior](../../sdk/models/entitlement-grant-allocation-behavior.md) | :heavy_minus_sign: | N/A |
|
|
18
19
|
| `grantDurationUnit` | [models.EntitlementGrantDurationUnit](../../sdk/models/entitlement-grant-duration-unit.md) | :heavy_minus_sign: | N/A |
|
|
19
20
|
| `grantDurationValue` | *number* | :heavy_minus_sign: | N/A |
|
|
20
21
|
| `grantMeasure` | [models.EntitlementGrantMeasure](../../sdk/models/entitlement-grant-measure.md) | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# UsageRecordFilter
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { UsageRecordFilter } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: UsageRecordFilter = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
15
|
+
| `currency` | *string* | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `customerExternalId` | *string* | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `customerId` | *string* | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `endTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `expand` | *string* | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `filters` | [models.FilterCondition](../../sdk/models/filter-condition.md)[] | :heavy_minus_sign: | Generic predicate and ordering escape hatch, for comparisons that have no dedicated field<br/>below — a range such as period_end at or after a cutoff goes here. |
|
|
21
|
+
| `limit` | *number* | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `offset` | *number* | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `order` | [models.UsageRecordFilterOrder](../../sdk/models/usage-record-filter-order.md) | :heavy_minus_sign: | N/A |
|
|
24
|
+
| `periodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `periodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Exact-match on the window boundaries. Together with SubscriptionID these identify a single row:<br/>they are the columns the table's unique index is built on. |
|
|
26
|
+
| `planId` | *string* | :heavy_minus_sign: | N/A |
|
|
27
|
+
| `sort` | [models.SortCondition](../../sdk/models/sort-condition.md)[] | :heavy_minus_sign: | N/A |
|
|
28
|
+
| `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
29
|
+
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
30
|
+
| `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
|
|
31
|
+
| `synced` | *boolean* | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# UsageRecordResponse
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { UsageRecordResponse } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: UsageRecordResponse = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `amount` | *number* | :heavy_minus_sign: | N/A |
|
|
16
|
+
| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
17
|
+
| `createdBy` | *string* | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `currency` | *string* | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `customerExternalId` | *string* | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `customerId` | *string* | :heavy_minus_sign: | N/A |
|
|
21
|
+
| `environmentId` | *string* | :heavy_minus_sign: | N/A |
|
|
22
|
+
| `id` | *string* | :heavy_minus_sign: | N/A |
|
|
23
|
+
| `periodEnd` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
24
|
+
| `periodStart` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
25
|
+
| `planId` | *string* | :heavy_minus_sign: | N/A |
|
|
26
|
+
| `quantity` | *number* | :heavy_minus_sign: | N/A |
|
|
27
|
+
| `status` | [models.Status](../../sdk/models/status.md) | :heavy_minus_sign: | N/A |
|
|
28
|
+
| `subscriptionId` | *string* | :heavy_minus_sign: | N/A |
|
|
29
|
+
| `synced` | *boolean* | :heavy_minus_sign: | N/A |
|
|
30
|
+
| `syncs` | Record<string, [models.UsageRecordSyncEntry](../../sdk/models/usage-record-sync-entry.md)> | :heavy_minus_sign: | N/A |
|
|
31
|
+
| `tenantId` | *string* | :heavy_minus_sign: | N/A |
|
|
32
|
+
| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
|
33
|
+
| `updatedBy` | *string* | :heavy_minus_sign: | N/A |
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UsageRecordSyncEntry
|
|
2
|
+
|
|
3
|
+
## Example Usage
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { UsageRecordSyncEntry } from "@flexprice/sdk/sdk/models";
|
|
7
|
+
|
|
8
|
+
let value: UsageRecordSyncEntry = {};
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Description |
|
|
14
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
15
|
+
| `agreementId` | *string* | :heavy_minus_sign: | AgreementID is the subscription's identifier on this marketplace: license_arn on AWS,<br/>usage_reporting_id on GCP, resource_id on Azure. It records which agreement the usage was<br/>billed against, which stays meaningful after the connection that reported it is replaced. |
|
|
16
|
+
| `connectionId` | *string* | :heavy_minus_sign: | ConnectionID is the connection that reported this entry, kept for tracing which credentials<br/>were used. It is deliberately not part of the map key: a replaced connection must not make an<br/>already reported record look unreported. |
|
|
17
|
+
| `reportingId` | *string* | :heavy_minus_sign: | N/A |
|
|
18
|
+
| `skipReason` | *string* | :heavy_minus_sign: | N/A |
|
|
19
|
+
| `skipped` | *boolean* | :heavy_minus_sign: | N/A |
|
|
20
|
+
| `syncedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | SyncedAt is when the marketplace accepted the record. Zero on a skip, since nothing was sent. |
|
|
@@ -7,7 +7,6 @@
|
|
|
7
7
|
* [createCostsheet](#createcostsheet) - Create costsheet
|
|
8
8
|
* [getActiveCostsheet](#getactivecostsheet) - Get active costsheet
|
|
9
9
|
* [getDetailedCostAnalytics](#getdetailedcostanalytics) - Get combined revenue and cost analytics
|
|
10
|
-
* [getDetailedCostAnalyticsV2](#getdetailedcostanalyticsv2) - Get combined revenue and cost analytics (V2)
|
|
11
10
|
* [queryCostsheet](#querycostsheet) - Query costsheets
|
|
12
11
|
* [getCostsheet](#getcostsheet) - Get costsheet
|
|
13
12
|
* [updateCostsheet](#updatecostsheet) - Update costsheet
|
|
@@ -229,77 +228,6 @@ run();
|
|
|
229
228
|
| models.ErrorsErrorResponse | 500 | application/json |
|
|
230
229
|
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
231
230
|
|
|
232
|
-
## getDetailedCostAnalyticsV2
|
|
233
|
-
|
|
234
|
-
Use when you need the same revenue/cost/ROI analytics but computed from the costsheet usage-tracking pipeline (e.g. for consistency with usage-based cost data).
|
|
235
|
-
|
|
236
|
-
### Example Usage
|
|
237
|
-
|
|
238
|
-
<!-- UsageSnippet language="typescript" operationID="getDetailedCostAnalyticsV2" method="post" path="/costs/analytics-v2" -->
|
|
239
|
-
```typescript
|
|
240
|
-
import { Flexprice } from "@flexprice/sdk";
|
|
241
|
-
|
|
242
|
-
const flexprice = new Flexprice({
|
|
243
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
244
|
-
});
|
|
245
|
-
|
|
246
|
-
async function run() {
|
|
247
|
-
const result = await flexprice.costs.getDetailedCostAnalyticsV2({});
|
|
248
|
-
|
|
249
|
-
console.log(result);
|
|
250
|
-
}
|
|
251
|
-
|
|
252
|
-
run();
|
|
253
|
-
```
|
|
254
|
-
|
|
255
|
-
### Standalone function
|
|
256
|
-
|
|
257
|
-
The standalone function version of this method:
|
|
258
|
-
|
|
259
|
-
```typescript
|
|
260
|
-
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
261
|
-
import { costsGetDetailedCostAnalyticsV2 } from "@flexprice/sdk/funcs/costs-get-detailed-cost-analytics-v2.js";
|
|
262
|
-
|
|
263
|
-
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
264
|
-
// You can create one instance of it to use across an application.
|
|
265
|
-
const flexprice = new FlexpriceCore({
|
|
266
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
267
|
-
});
|
|
268
|
-
|
|
269
|
-
async function run() {
|
|
270
|
-
const res = await costsGetDetailedCostAnalyticsV2(flexprice, {});
|
|
271
|
-
if (res.ok) {
|
|
272
|
-
const { value: result } = res;
|
|
273
|
-
console.log(result);
|
|
274
|
-
} else {
|
|
275
|
-
console.log("costsGetDetailedCostAnalyticsV2 failed:", res.error);
|
|
276
|
-
}
|
|
277
|
-
}
|
|
278
|
-
|
|
279
|
-
run();
|
|
280
|
-
```
|
|
281
|
-
|
|
282
|
-
### Parameters
|
|
283
|
-
|
|
284
|
-
| Parameter | Type | Required | Description |
|
|
285
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
286
|
-
| `request` | [models.GetCostAnalyticsRequest](../../sdk/models/get-cost-analytics-request.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
287
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
288
|
-
| `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. |
|
|
289
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
290
|
-
|
|
291
|
-
### Response
|
|
292
|
-
|
|
293
|
-
**Promise\<[models.GetDetailedCostAnalyticsResponse](../../sdk/models/get-detailed-cost-analytics-response.md)\>**
|
|
294
|
-
|
|
295
|
-
### Errors
|
|
296
|
-
|
|
297
|
-
| Error Type | Status Code | Content Type |
|
|
298
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
299
|
-
| models.ErrorsErrorResponse | 400 | application/json |
|
|
300
|
-
| models.ErrorsErrorResponse | 500 | application/json |
|
|
301
|
-
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
302
|
-
|
|
303
231
|
## queryCostsheet
|
|
304
232
|
|
|
305
233
|
Use when listing or searching costsheets (e.g. admin catalog). Returns a paginated list; supports filtering and sorting.
|
|
@@ -95,7 +95,7 @@ const flexprice = new Flexprice({
|
|
|
95
95
|
async function run() {
|
|
96
96
|
const result = await flexprice.integrations.linkIntegrationMapping({
|
|
97
97
|
entityId: "<id>",
|
|
98
|
-
entityType: "
|
|
98
|
+
entityType: "invoice_line_item",
|
|
99
99
|
providerEntityId: "<id>",
|
|
100
100
|
providerType: "<value>",
|
|
101
101
|
});
|
|
@@ -123,7 +123,7 @@ const flexprice = new FlexpriceCore({
|
|
|
123
123
|
async function run() {
|
|
124
124
|
const res = await integrationsLinkIntegrationMapping(flexprice, {
|
|
125
125
|
entityId: "<id>",
|
|
126
|
-
entityType: "
|
|
126
|
+
entityType: "invoice_line_item",
|
|
127
127
|
providerEntityId: "<id>",
|
|
128
128
|
providerType: "<value>",
|
|
129
129
|
});
|
|
@@ -176,7 +176,7 @@ const flexprice = new Flexprice({
|
|
|
176
176
|
async function run() {
|
|
177
177
|
const result = await flexprice.integrations.delinkIntegrationMapping({
|
|
178
178
|
entityId: "<id>",
|
|
179
|
-
entityType: "
|
|
179
|
+
entityType: "price",
|
|
180
180
|
providerType: "<value>",
|
|
181
181
|
});
|
|
182
182
|
|
|
@@ -203,7 +203,7 @@ const flexprice = new FlexpriceCore({
|
|
|
203
203
|
async function run() {
|
|
204
204
|
const res = await integrationsDelinkIntegrationMapping(flexprice, {
|
|
205
205
|
entityId: "<id>",
|
|
206
|
-
entityType: "
|
|
206
|
+
entityType: "price",
|
|
207
207
|
providerType: "<value>",
|
|
208
208
|
});
|
|
209
209
|
if (res.ok) {
|
|
@@ -243,7 +243,7 @@ run();
|
|
|
243
243
|
|
|
244
244
|
| Error Type | Status Code | Content Type |
|
|
245
245
|
| -------------------------- | -------------------------- | -------------------------- |
|
|
246
|
-
| models.ErrorsErrorResponse | 400
|
|
246
|
+
| models.ErrorsErrorResponse | 400, 404 | application/json |
|
|
247
247
|
| models.ErrorsErrorResponse | 500 | application/json |
|
|
248
248
|
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
249
249
|
|
|
@@ -1174,6 +1174,14 @@ run();
|
|
|
1174
1174
|
|
|
1175
1175
|
Change a subscription's plan in place. Subscription id, billing anchor and period bounds are preserved; line items are sliced and settled in one transaction.
|
|
1176
1176
|
|
|
1177
|
+
change_at controls timing. Omitted or 'immediate' applies the change now. 'end_of_period' records a pending schedule that executes at the subscription's current period end: the response returns is_scheduled, schedule_id and scheduled_at instead of a completed change, and nothing is swapped or billed until the boundary.
|
|
1178
|
+
|
|
1179
|
+
scheduled_at is resolved from the subscription's current period end at request time. If that period end is already in the past (a backdated start date, a resumed pause, or worker downtime can all leave a subscription behind), the change is due immediately and fires on the next billing scan rather than a period away — inspect scheduled_at to see this.
|
|
1180
|
+
|
|
1181
|
+
Only one plan change may be pending per subscription. By default (on_conflict_policies.on_pending_schedule = 'reject') a second request returns 400; cancel the existing schedule via POST /subscriptions/schedules/{schedule_id}/cancel first. Pending schedules are listable via GET /subscriptions/{id}/schedules.
|
|
1182
|
+
|
|
1183
|
+
Set on_conflict_policies.on_pending_schedule to 'supersede' to replace the queued change instead: the pending schedule is cancelled and this request applied in the same transaction, so both land or neither does. The cancelled schedule ids are returned in superseded_schedules, and preview reports the same list without writing.
|
|
1184
|
+
|
|
1177
1185
|
### Example Usage
|
|
1178
1186
|
|
|
1179
1187
|
<!-- UsageSnippet language="typescript" operationID="executeSubscriptionPlanChangeV2" method="post" path="/subscriptions/{id}/change/v2/execute" -->
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
# UsageRecords
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
### Available Operations
|
|
6
|
+
|
|
7
|
+
* [postUsageRecordsSearch](#postusagerecordssearch) - List usage records
|
|
8
|
+
|
|
9
|
+
## postUsageRecordsSearch
|
|
10
|
+
|
|
11
|
+
Lists usage records. Also accepts filters/sort for a filtered query.
|
|
12
|
+
|
|
13
|
+
### Example Usage
|
|
14
|
+
|
|
15
|
+
<!-- UsageSnippet language="typescript" operationID="post_/usage-records/search" method="post" path="/usage-records/search" -->
|
|
16
|
+
```typescript
|
|
17
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
18
|
+
|
|
19
|
+
const flexprice = new Flexprice({
|
|
20
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
async function run() {
|
|
24
|
+
const result = await flexprice.usageRecords.postUsageRecordsSearch({});
|
|
25
|
+
|
|
26
|
+
console.log(result);
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
run();
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Standalone function
|
|
33
|
+
|
|
34
|
+
The standalone function version of this method:
|
|
35
|
+
|
|
36
|
+
```typescript
|
|
37
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
38
|
+
import { usageRecordsPostUsageRecordsSearch } from "@flexprice/sdk/funcs/usage-records-post-usage-records-search.js";
|
|
39
|
+
|
|
40
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
41
|
+
// You can create one instance of it to use across an application.
|
|
42
|
+
const flexprice = new FlexpriceCore({
|
|
43
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
44
|
+
});
|
|
45
|
+
|
|
46
|
+
async function run() {
|
|
47
|
+
const res = await usageRecordsPostUsageRecordsSearch(flexprice, {});
|
|
48
|
+
if (res.ok) {
|
|
49
|
+
const { value: result } = res;
|
|
50
|
+
console.log(result);
|
|
51
|
+
} else {
|
|
52
|
+
console.log("usageRecordsPostUsageRecordsSearch failed:", res.error);
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
run();
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Parameters
|
|
60
|
+
|
|
61
|
+
| Parameter | Type | Required | Description |
|
|
62
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
63
|
+
| `request` | [models.UsageRecordFilter](../../sdk/models/usage-record-filter.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
64
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
65
|
+
| `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. |
|
|
66
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
67
|
+
|
|
68
|
+
### Response
|
|
69
|
+
|
|
70
|
+
**Promise\<[models.ListUsageRecordsResponse](../../sdk/models/list-usage-records-response.md)\>**
|
|
71
|
+
|
|
72
|
+
### Errors
|
|
73
|
+
|
|
74
|
+
| Error Type | Status Code | Content Type |
|
|
75
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
76
|
+
| models.ErrorsErrorResponse | 400 | application/json |
|
|
77
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
78
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -82,7 +82,7 @@ async function $do(client, lookupKey, options) {
|
|
|
82
82
|
const responseFields = {
|
|
83
83
|
HttpMeta: { Response: response, Request: req },
|
|
84
84
|
};
|
|
85
|
-
const [result] = await M.match(M.json(200, models.PriceResponse$inboundSchema), M.jsonErr(400, models.ErrorsErrorResponse$inboundSchema), M.jsonErr(500, models.ErrorsErrorResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
|
|
85
|
+
const [result] = await M.match(M.json(200, models.PriceResponse$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
86
|
if (!result.ok) {
|
|
87
87
|
return [result, { status: "complete", request: req, response }];
|
|
88
88
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"prices-get-price-by-lookup-key.js","sourceRoot":"","sources":["../../src/funcs/prices-get-price-by-lookup-key.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,yBAAyB,CACvC,MAAqB,EACrB,SAAiB,EACjB,OAAwB,EAcxB;IACA,OAAO,IAAI,UAAU,CAAC,GAAG,CACvB,MAAM,EACN,SAAS,EACT,OAAO,CACR,CAAC,CAAC;AAAA,CACJ;AAED,KAAK,UAAU,GAAG,CAChB,MAAqB,EACrB,SAAiB,EACjB,OAAwB,EAiBxB;IACA,MAAM,KAAK,GAAsC;QAC/C,SAAS,EAAE,SAAS;KACrB,CAAC;IAEF,MAAM,MAAM,GAAG,SAAS,CACtB,KAAK,EACL,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,yCAAyC,EAAE,KAAK,CAAC,EAC3E,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,UAAU,EAAE,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,UAAU,EAAE;YACzD,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IACF,MAAM,IAAI,GAAG,UAAU,CAAC,6BAA6B,CAAC,CAAC,UAAU,CAAC,CAAC;IAEnE,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,qBAAqB;QAClC,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,2BAA2B,CAAC,EAC/C,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,iCAAiC,CAAC,
|
|
1
|
+
{"version":3,"file":"prices-get-price-by-lookup-key.js","sourceRoot":"","sources":["../../src/funcs/prices-get-price-by-lookup-key.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,yBAAyB,CACvC,MAAqB,EACrB,SAAiB,EACjB,OAAwB,EAcxB;IACA,OAAO,IAAI,UAAU,CAAC,GAAG,CACvB,MAAM,EACN,SAAS,EACT,OAAO,CACR,CAAC,CAAC;AAAA,CACJ;AAED,KAAK,UAAU,GAAG,CAChB,MAAqB,EACrB,SAAiB,EACjB,OAAwB,EAiBxB;IACA,MAAM,KAAK,GAAsC;QAC/C,SAAS,EAAE,SAAS;KACrB,CAAC;IAEF,MAAM,MAAM,GAAG,SAAS,CACtB,KAAK,EACL,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,yCAAyC,EAAE,KAAK,CAAC,EAC3E,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,UAAU,EAAE,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,UAAU,EAAE;YACzD,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IACF,MAAM,IAAI,GAAG,UAAU,CAAC,6BAA6B,CAAC,CAAC,UAAU,CAAC,CAAC;IAEnE,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,qBAAqB;QAClC,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,2BAA2B,CAAC,EAC/C,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"}
|