@schematichq/schematic-typescript-node 1.5.5 → 1.5.7
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/dist/Client.d.ts +3 -0
- package/dist/api/resources/accounts/client/Client.d.ts +2 -0
- package/dist/api/resources/accounts/client/requests/CountAccountMembersRequest.d.ts +4 -0
- package/dist/api/resources/accounts/client/requests/CreateApiKeyRequestBody.d.ts +1 -0
- package/dist/api/resources/accounts/client/requests/ListAccountMembersRequest.d.ts +4 -0
- package/dist/api/resources/accounts/client/requests/UpdateApiKeyRequestBody.d.ts +1 -0
- package/dist/api/resources/accounts/types/CountAccountMembersParams.d.ts +3 -0
- package/dist/api/resources/accounts/types/ListAccountMembersParams.d.ts +3 -0
- package/dist/api/resources/billing/client/Client.d.ts +2 -0
- package/dist/api/resources/billing/client/requests/ListBillingPricesRequest.d.ts +3 -0
- package/dist/api/resources/billing/client/requests/ListBillingProductPricesRequest.d.ts +3 -0
- package/dist/api/resources/billing/types/ListBillingPricesParams.d.ts +2 -0
- package/dist/api/resources/billing/types/ListBillingProductPricesParams.d.ts +2 -0
- package/dist/api/resources/catalogs/client/Client.d.ts +0 -1
- package/dist/api/resources/catalogs/client/requests/CreateCatalogRequestBody.d.ts +0 -2
- package/dist/api/resources/checkout/client/Client.d.ts +35 -0
- package/dist/api/resources/checkout/client/requests/UpdateCompanyBillingDetailsRequestBody.d.ts +17 -0
- package/dist/api/resources/checkout/client/requests/index.d.ts +1 -0
- package/dist/api/resources/checkout/types/GetCompanyBillingDetailsResponse.d.ts +6 -0
- package/dist/api/resources/checkout/types/UpdateCompanyBillingDetailsResponse.d.ts +6 -0
- package/dist/api/resources/checkout/types/index.d.ts +2 -0
- package/dist/api/resources/entitlements/client/Client.d.ts +38 -0
- package/dist/api/resources/entitlements/client/requests/GetUserUsageByCompanyRequest.d.ts +19 -0
- package/dist/api/resources/entitlements/client/requests/GetUserUsageDetailRequest.d.ts +19 -0
- package/dist/api/resources/entitlements/client/requests/index.d.ts +2 -0
- package/dist/api/resources/entitlements/types/GetUserUsageByCompanyParams.d.ts +13 -0
- package/dist/api/resources/entitlements/types/GetUserUsageByCompanyResponse.d.ts +6 -0
- package/dist/api/resources/entitlements/types/GetUserUsageDetailParams.d.ts +13 -0
- package/dist/api/resources/entitlements/types/GetUserUsageDetailResponse.d.ts +6 -0
- package/dist/api/resources/entitlements/types/index.d.ts +4 -0
- package/dist/api/resources/index.d.ts +3 -0
- package/dist/api/resources/licenses/client/Client.d.ts +69 -0
- package/dist/api/resources/licenses/client/index.d.ts +1 -0
- package/dist/api/resources/licenses/client/requests/CountLicensesRequest.d.ts +19 -0
- package/dist/api/resources/licenses/client/requests/ListLicensesRequest.d.ts +19 -0
- package/dist/api/resources/licenses/client/requests/index.d.ts +2 -0
- package/dist/api/resources/licenses/exports.d.ts +2 -0
- package/dist/api/resources/licenses/index.d.ts +2 -0
- package/dist/api/resources/licenses/types/CountLicensesParams.d.ts +12 -0
- package/dist/api/resources/licenses/types/CountLicensesResponse.d.ts +6 -0
- package/dist/api/resources/licenses/types/GetSingleLicenseResponse.d.ts +6 -0
- package/dist/api/resources/licenses/types/ListLicensesParams.d.ts +12 -0
- package/dist/api/resources/licenses/types/ListLicensesResponse.d.ts +6 -0
- package/dist/api/resources/licenses/types/index.d.ts +5 -0
- package/dist/api/resources/planmigrations/client/Client.d.ts +20 -0
- package/dist/api/resources/planmigrations/client/requests/PreviewMigrationRequestBody.d.ts +16 -0
- package/dist/api/resources/planmigrations/client/requests/index.d.ts +1 -0
- package/dist/api/resources/planmigrations/types/PreviewMigrationResponse.d.ts +6 -0
- package/dist/api/resources/planmigrations/types/index.d.ts +1 -0
- package/dist/api/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +6 -0
- package/dist/api/resources/plans/client/requests/RetryCustomPlanBillingRequestBody.d.ts +2 -0
- package/dist/api/types/ApiKeyCreateResponseData.d.ts +1 -0
- package/dist/api/types/ApiKeyResponseData.d.ts +1 -0
- package/dist/api/types/BillingCreditGrantZeroedOutReason.d.ts +1 -0
- package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +4 -0
- package/dist/api/types/CatalogConfigOrderedEntitlement.d.ts +1 -1
- package/dist/api/types/CatalogConfigOrderedEntitlementResponseData.d.ts +1 -1
- package/dist/api/types/CatalogResponseData.d.ts +0 -1
- package/dist/api/types/CompanyBillingAddressView.d.ts +8 -0
- package/dist/api/types/CompanyBillingCheckoutSettings.d.ts +5 -0
- package/dist/api/types/CompanyBillingDetailsResponseData.d.ts +9 -0
- package/dist/api/types/CompanyBillingDetailsView.d.ts +9 -0
- package/dist/api/types/CompanyPlanCreditGrantView.d.ts +2 -0
- package/dist/api/types/CompanyPlanDetailResponseData.d.ts +2 -2
- package/dist/api/types/CompanyTaxIdView.d.ts +7 -0
- package/dist/api/types/ComponentCheckoutSettings.d.ts +2 -0
- package/dist/api/types/CreateBillingPlanCreditGrantRequestBody.d.ts +4 -0
- package/dist/api/types/CreateEntitlementInBundleRequestBody.d.ts +1 -0
- package/dist/api/types/CreditsAutoTopupSuccess.d.ts +7 -0
- package/dist/api/types/CreditsCreditPurchaseSuccess.d.ts +9 -0
- package/dist/api/types/CreditsWebhookCompanySummary.d.ts +4 -0
- package/dist/api/types/CreditsWebhookCreditSummary.d.ts +4 -0
- package/dist/api/types/CustomPlanBillingResponseData.d.ts +1 -0
- package/dist/api/types/CustomerBillingAddress.d.ts +8 -0
- package/dist/api/types/FeatureDetailResponseData.d.ts +6 -0
- package/dist/api/types/FeatureInPlanResponseData.d.ts +4 -0
- package/dist/api/types/FeatureResponseData.d.ts +4 -0
- package/dist/api/types/FeatureType.d.ts +1 -0
- package/dist/api/types/FeatureView.d.ts +2 -0
- package/dist/api/types/LicenseResponseData.d.ts +6 -0
- package/dist/api/types/PlanCreditGrantScaling.d.ts +5 -0
- package/dist/api/types/PlanCreditGrantView.d.ts +2 -0
- package/dist/api/types/PlanDetailResponseData.d.ts +2 -2
- package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts +2 -2
- package/dist/api/types/PlanVersionMigrationPreviewCompanyResponseData.d.ts +8 -0
- package/dist/api/types/PlanVersionMigrationPreviewResponseData.d.ts +4 -0
- package/dist/api/types/PlanViewPublicResponseData.d.ts +2 -2
- package/dist/api/types/TaxIdInput.d.ts +5 -0
- package/dist/api/types/TaxIdType.d.ts +41 -0
- package/dist/api/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +4 -0
- package/dist/api/types/UserCreditUsageResponseData.d.ts +14 -0
- package/dist/api/types/UserDailyCreditPointResponseData.d.ts +6 -0
- package/dist/api/types/UserDailyUsagePointResponseData.d.ts +8 -0
- package/dist/api/types/UserFeatureUsageResponseData.d.ts +14 -0
- package/dist/api/types/UserUsageByCompanyResponseData.d.ts +11 -0
- package/dist/api/types/UserUsageDetailResponseData.d.ts +16 -0
- package/dist/api/types/WebhookRequestType.d.ts +2 -0
- package/dist/api/types/index.d.ts +22 -0
- package/dist/index.js +9 -9
- package/dist/serialization/resources/accounts/client/requests/CreateApiKeyRequestBody.d.ts +1 -0
- package/dist/serialization/resources/accounts/client/requests/UpdateApiKeyRequestBody.d.ts +1 -0
- package/dist/serialization/resources/accounts/types/CountAccountMembersParams.d.ts +2 -0
- package/dist/serialization/resources/accounts/types/ListAccountMembersParams.d.ts +2 -0
- package/dist/serialization/resources/billing/types/ListBillingPricesParams.d.ts +1 -0
- package/dist/serialization/resources/billing/types/ListBillingProductPricesParams.d.ts +1 -0
- package/dist/serialization/resources/catalogs/client/requests/CreateCatalogRequestBody.d.ts +0 -1
- package/dist/serialization/resources/checkout/client/requests/UpdateCompanyBillingDetailsRequestBody.d.ts +16 -0
- package/dist/serialization/resources/checkout/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/checkout/types/GetCompanyBillingDetailsResponse.d.ts +11 -0
- package/dist/serialization/resources/checkout/types/UpdateCompanyBillingDetailsResponse.d.ts +11 -0
- package/dist/serialization/resources/checkout/types/index.d.ts +2 -0
- package/dist/serialization/resources/entitlements/types/GetUserUsageByCompanyParams.d.ts +12 -0
- package/dist/serialization/resources/entitlements/types/GetUserUsageByCompanyResponse.d.ts +12 -0
- package/dist/serialization/resources/entitlements/types/GetUserUsageDetailParams.d.ts +12 -0
- package/dist/serialization/resources/entitlements/types/GetUserUsageDetailResponse.d.ts +12 -0
- package/dist/serialization/resources/entitlements/types/index.d.ts +4 -0
- package/dist/serialization/resources/index.d.ts +2 -0
- package/dist/serialization/resources/licenses/index.d.ts +1 -0
- package/dist/serialization/resources/licenses/types/CountLicensesParams.d.ts +13 -0
- package/dist/serialization/resources/licenses/types/CountLicensesResponse.d.ts +12 -0
- package/dist/serialization/resources/licenses/types/GetSingleLicenseResponse.d.ts +11 -0
- package/dist/serialization/resources/licenses/types/ListLicensesParams.d.ts +13 -0
- package/dist/serialization/resources/licenses/types/ListLicensesResponse.d.ts +12 -0
- package/dist/serialization/resources/licenses/types/index.d.ts +5 -0
- package/dist/serialization/resources/planmigrations/client/requests/PreviewMigrationRequestBody.d.ts +13 -0
- package/dist/serialization/resources/planmigrations/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/planmigrations/types/PreviewMigrationResponse.d.ts +11 -0
- package/dist/serialization/resources/planmigrations/types/index.d.ts +1 -0
- package/dist/serialization/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +8 -0
- package/dist/serialization/resources/plans/client/requests/RetryCustomPlanBillingRequestBody.d.ts +1 -0
- package/dist/serialization/types/ApiKeyCreateResponseData.d.ts +1 -0
- package/dist/serialization/types/ApiKeyResponseData.d.ts +1 -0
- package/dist/serialization/types/BillingCreditGrantZeroedOutReason.d.ts +1 -1
- package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +3 -0
- package/dist/serialization/types/CatalogConfigOrderedEntitlement.d.ts +1 -1
- package/dist/serialization/types/CatalogConfigOrderedEntitlementResponseData.d.ts +1 -1
- package/dist/serialization/types/CatalogResponseData.d.ts +0 -1
- package/dist/serialization/types/CompanyBillingAddressView.d.ts +14 -0
- package/dist/serialization/types/CompanyBillingCheckoutSettings.d.ts +11 -0
- package/dist/serialization/types/CompanyBillingDetailsResponseData.d.ts +18 -0
- package/dist/serialization/types/CompanyBillingDetailsView.d.ts +18 -0
- package/dist/serialization/types/CompanyPlanCreditGrantView.d.ts +3 -0
- package/dist/serialization/types/CompanyPlanDetailResponseData.d.ts +1 -1
- package/dist/serialization/types/CompanyTaxIdView.d.ts +13 -0
- package/dist/serialization/types/ComponentCheckoutSettings.d.ts +2 -0
- package/dist/serialization/types/CreateBillingPlanCreditGrantRequestBody.d.ts +3 -0
- package/dist/serialization/types/CreateEntitlementInBundleRequestBody.d.ts +2 -0
- package/dist/serialization/types/CreditsAutoTopupSuccess.d.ts +14 -0
- package/dist/serialization/types/CreditsCreditPurchaseSuccess.d.ts +16 -0
- package/dist/serialization/types/CreditsWebhookCompanySummary.d.ts +10 -0
- package/dist/serialization/types/CreditsWebhookCreditSummary.d.ts +10 -0
- package/dist/serialization/types/CustomPlanBillingResponseData.d.ts +1 -0
- package/dist/serialization/types/CustomerBillingAddress.d.ts +14 -0
- package/dist/serialization/types/FeatureDetailResponseData.d.ts +4 -0
- package/dist/serialization/types/FeatureInPlanResponseData.d.ts +2 -0
- package/dist/serialization/types/FeatureResponseData.d.ts +2 -0
- package/dist/serialization/types/FeatureType.d.ts +1 -1
- package/dist/serialization/types/FeatureView.d.ts +3 -0
- package/dist/serialization/types/LicenseResponseData.d.ts +12 -0
- package/dist/serialization/types/PlanCreditGrantScaling.d.ts +7 -0
- package/dist/serialization/types/PlanCreditGrantView.d.ts +3 -0
- package/dist/serialization/types/PlanDetailResponseData.d.ts +1 -1
- package/dist/serialization/types/PlanGroupPlanDetailResponseData.d.ts +1 -1
- package/dist/serialization/types/PlanVersionMigrationPreviewCompanyResponseData.d.ts +14 -0
- package/dist/serialization/types/PlanVersionMigrationPreviewResponseData.d.ts +10 -0
- package/dist/serialization/types/PlanViewPublicResponseData.d.ts +1 -1
- package/dist/serialization/types/TaxIdInput.d.ts +11 -0
- package/dist/serialization/types/TaxIdType.d.ts +7 -0
- package/dist/serialization/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +3 -0
- package/dist/serialization/types/UserCreditUsageResponseData.d.ts +15 -0
- package/dist/serialization/types/UserDailyCreditPointResponseData.d.ts +10 -0
- package/dist/serialization/types/UserDailyUsagePointResponseData.d.ts +12 -0
- package/dist/serialization/types/UserFeatureUsageResponseData.d.ts +16 -0
- package/dist/serialization/types/UserUsageByCompanyResponseData.d.ts +14 -0
- package/dist/serialization/types/UserUsageDetailResponseData.d.ts +20 -0
- package/dist/serialization/types/WebhookRequestType.d.ts +1 -1
- package/dist/serialization/types/index.d.ts +22 -0
- package/dist/wasm/rulesengine.js +1 -1
- package/package.json +1 -1
package/dist/Client.d.ts
CHANGED
|
@@ -13,6 +13,7 @@ import { EventsClient } from "./api/resources/events/client/Client";
|
|
|
13
13
|
import { FeaturesClient } from "./api/resources/features/client/Client";
|
|
14
14
|
import { InsightsClient } from "./api/resources/insights/client/Client";
|
|
15
15
|
import { IntegrationsapiClient } from "./api/resources/integrationsapi/client/Client";
|
|
16
|
+
import { LicensesClient } from "./api/resources/licenses/client/Client";
|
|
16
17
|
import { PlanbundleClient } from "./api/resources/planbundle/client/Client";
|
|
17
18
|
import { PlangroupsClient } from "./api/resources/plangroups/client/Client";
|
|
18
19
|
import { PlanmigrationsClient } from "./api/resources/planmigrations/client/Client";
|
|
@@ -44,6 +45,7 @@ export declare class SchematicClient {
|
|
|
44
45
|
protected _features: FeaturesClient | undefined;
|
|
45
46
|
protected _insights: InsightsClient | undefined;
|
|
46
47
|
protected _integrationsapi: IntegrationsapiClient | undefined;
|
|
48
|
+
protected _licenses: LicensesClient | undefined;
|
|
47
49
|
protected _plangroups: PlangroupsClient | undefined;
|
|
48
50
|
protected _planmigrations: PlanmigrationsClient | undefined;
|
|
49
51
|
protected _componentspublic: ComponentspublicClient | undefined;
|
|
@@ -66,6 +68,7 @@ export declare class SchematicClient {
|
|
|
66
68
|
get features(): FeaturesClient;
|
|
67
69
|
get insights(): InsightsClient;
|
|
68
70
|
get integrationsapi(): IntegrationsapiClient;
|
|
71
|
+
get licenses(): LicensesClient;
|
|
69
72
|
get plangroups(): PlangroupsClient;
|
|
70
73
|
get planmigrations(): PlanmigrationsClient;
|
|
71
74
|
get componentspublic(): ComponentspublicClient;
|
|
@@ -24,6 +24,7 @@ export declare class AccountsClient {
|
|
|
24
24
|
* await client.accounts.listAccountMembers({
|
|
25
25
|
* ids: ["ids"],
|
|
26
26
|
* q: "q",
|
|
27
|
+
* role: "admin",
|
|
27
28
|
* limit: 1000000,
|
|
28
29
|
* offset: 1000000
|
|
29
30
|
* })
|
|
@@ -58,6 +59,7 @@ export declare class AccountsClient {
|
|
|
58
59
|
* await client.accounts.countAccountMembers({
|
|
59
60
|
* ids: ["ids"],
|
|
60
61
|
* q: "q",
|
|
62
|
+
* role: "admin",
|
|
61
63
|
* limit: 1000000,
|
|
62
64
|
* offset: 1000000
|
|
63
65
|
* })
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
1
2
|
/**
|
|
2
3
|
* @example
|
|
3
4
|
* {
|
|
4
5
|
* ids: ["ids"],
|
|
5
6
|
* q: "q",
|
|
7
|
+
* role: "admin",
|
|
6
8
|
* limit: 1000000,
|
|
7
9
|
* offset: 1000000
|
|
8
10
|
* }
|
|
@@ -11,6 +13,8 @@ export interface CountAccountMembersRequest {
|
|
|
11
13
|
ids?: string | string[];
|
|
12
14
|
/** Search filter */
|
|
13
15
|
q?: string;
|
|
16
|
+
/** Filter by member role */
|
|
17
|
+
role?: Schematic.AccountMemberRole;
|
|
14
18
|
/** Page limit (default 100) */
|
|
15
19
|
limit?: number;
|
|
16
20
|
/** Page offset (default 0) */
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
1
2
|
/**
|
|
2
3
|
* @example
|
|
3
4
|
* {
|
|
4
5
|
* ids: ["ids"],
|
|
5
6
|
* q: "q",
|
|
7
|
+
* role: "admin",
|
|
6
8
|
* limit: 1000000,
|
|
7
9
|
* offset: 1000000
|
|
8
10
|
* }
|
|
@@ -11,6 +13,8 @@ export interface ListAccountMembersRequest {
|
|
|
11
13
|
ids?: string | string[];
|
|
12
14
|
/** Search filter */
|
|
13
15
|
q?: string;
|
|
16
|
+
/** Filter by member role */
|
|
17
|
+
role?: Schematic.AccountMemberRole;
|
|
14
18
|
/** Page limit (default 100) */
|
|
15
19
|
limit?: number;
|
|
16
20
|
/** Page offset (default 0) */
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type * as Schematic from "../../../index";
|
|
1
2
|
/**
|
|
2
3
|
* Input parameters
|
|
3
4
|
*/
|
|
@@ -9,4 +10,6 @@ export interface CountAccountMembersParams {
|
|
|
9
10
|
offset?: number;
|
|
10
11
|
/** Search filter */
|
|
11
12
|
q?: string;
|
|
13
|
+
/** Filter by member role */
|
|
14
|
+
role?: Schematic.AccountMemberRole;
|
|
12
15
|
}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type * as Schematic from "../../../index";
|
|
1
2
|
/**
|
|
2
3
|
* Input parameters
|
|
3
4
|
*/
|
|
@@ -9,4 +10,6 @@ export interface ListAccountMembersParams {
|
|
|
9
10
|
offset?: number;
|
|
10
11
|
/** Search filter */
|
|
11
12
|
q?: string;
|
|
13
|
+
/** Filter by member role */
|
|
14
|
+
role?: Schematic.AccountMemberRole;
|
|
12
15
|
}
|
|
@@ -319,6 +319,7 @@ export declare class BillingClient {
|
|
|
319
319
|
* forTrialExpiryPlan: true,
|
|
320
320
|
* ids: ["ids"],
|
|
321
321
|
* interval: "interval",
|
|
322
|
+
* intervalCount: 1000000,
|
|
322
323
|
* isActive: true,
|
|
323
324
|
* planVersionId: "plan_version_id",
|
|
324
325
|
* price: 1000000,
|
|
@@ -395,6 +396,7 @@ export declare class BillingClient {
|
|
|
395
396
|
* forTrialExpiryPlan: true,
|
|
396
397
|
* ids: ["ids"],
|
|
397
398
|
* interval: "interval",
|
|
399
|
+
* intervalCount: 1000000,
|
|
398
400
|
* isActive: true,
|
|
399
401
|
* planVersionId: "plan_version_id",
|
|
400
402
|
* price: 1000000,
|
|
@@ -7,6 +7,7 @@ import type * as Schematic from "../../../../index";
|
|
|
7
7
|
* forTrialExpiryPlan: true,
|
|
8
8
|
* ids: ["ids"],
|
|
9
9
|
* interval: "interval",
|
|
10
|
+
* intervalCount: 1000000,
|
|
10
11
|
* isActive: true,
|
|
11
12
|
* planVersionId: "plan_version_id",
|
|
12
13
|
* price: 1000000,
|
|
@@ -30,6 +31,8 @@ export interface ListBillingPricesRequest {
|
|
|
30
31
|
forTrialExpiryPlan?: boolean;
|
|
31
32
|
ids?: string | string[];
|
|
32
33
|
interval?: string;
|
|
34
|
+
/** Filter for prices billed every N intervals; combine with interval (e.g. interval=month, interval_count=3 for quarterly) */
|
|
35
|
+
intervalCount?: number;
|
|
33
36
|
/** Filter for active prices on active products (defaults to true if not specified) */
|
|
34
37
|
isActive?: boolean;
|
|
35
38
|
/** Filter for prices belonging to a specific plan version (e.g. the latest published version) */
|
|
@@ -7,6 +7,7 @@ import type * as Schematic from "../../../../index";
|
|
|
7
7
|
* forTrialExpiryPlan: true,
|
|
8
8
|
* ids: ["ids"],
|
|
9
9
|
* interval: "interval",
|
|
10
|
+
* intervalCount: 1000000,
|
|
10
11
|
* isActive: true,
|
|
11
12
|
* planVersionId: "plan_version_id",
|
|
12
13
|
* price: 1000000,
|
|
@@ -30,6 +31,8 @@ export interface ListBillingProductPricesRequest {
|
|
|
30
31
|
forTrialExpiryPlan?: boolean;
|
|
31
32
|
ids?: string | string[];
|
|
32
33
|
interval?: string;
|
|
34
|
+
/** Filter for prices billed every N intervals; combine with interval (e.g. interval=month, interval_count=3 for quarterly) */
|
|
35
|
+
intervalCount?: number;
|
|
33
36
|
/** Filter for active prices on active products (defaults to true if not specified) */
|
|
34
37
|
isActive?: boolean;
|
|
35
38
|
/** Filter for prices belonging to a specific plan version (e.g. the latest published version) */
|
|
@@ -11,6 +11,8 @@ export interface ListBillingPricesParams {
|
|
|
11
11
|
forTrialExpiryPlan?: boolean;
|
|
12
12
|
ids?: string[];
|
|
13
13
|
interval?: string;
|
|
14
|
+
/** Filter for prices billed every N intervals; combine with interval (e.g. interval=month, interval_count=3 for quarterly) */
|
|
15
|
+
intervalCount?: number;
|
|
14
16
|
/** Filter for active prices on active products (defaults to true if not specified) */
|
|
15
17
|
isActive?: boolean;
|
|
16
18
|
/** Page limit (default 100) */
|
|
@@ -11,6 +11,8 @@ export interface ListBillingProductPricesParams {
|
|
|
11
11
|
forTrialExpiryPlan?: boolean;
|
|
12
12
|
ids?: string[];
|
|
13
13
|
interval?: string;
|
|
14
|
+
/** Filter for prices billed every N intervals; combine with interval (e.g. interval=month, interval_count=3 for quarterly) */
|
|
15
|
+
intervalCount?: number;
|
|
14
16
|
/** Filter for active prices on active products (defaults to true if not specified) */
|
|
15
17
|
isActive?: boolean;
|
|
16
18
|
/** Page limit (default 100) */
|
|
@@ -105,6 +105,41 @@ export declare class CheckoutClient {
|
|
|
105
105
|
*/
|
|
106
106
|
previewCheckoutInternal(request: Schematic.ChangeSubscriptionInternalRequestBody, requestOptions?: CheckoutClient.RequestOptions): core.HttpResponsePromise<Schematic.PreviewCheckoutInternalResponse>;
|
|
107
107
|
private __previewCheckoutInternal;
|
|
108
|
+
/**
|
|
109
|
+
* @param {string} company_id - company_id
|
|
110
|
+
* @param {CheckoutClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
113
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
114
|
+
* @throws {@link Schematic.NotFoundError}
|
|
115
|
+
* @throws {@link Schematic.InternalServerError}
|
|
116
|
+
*
|
|
117
|
+
* @example
|
|
118
|
+
* await client.checkout.getCompanyBillingDetails("company_id")
|
|
119
|
+
*/
|
|
120
|
+
getCompanyBillingDetails(company_id: string, requestOptions?: CheckoutClient.RequestOptions): core.HttpResponsePromise<Schematic.GetCompanyBillingDetailsResponse>;
|
|
121
|
+
private __getCompanyBillingDetails;
|
|
122
|
+
/**
|
|
123
|
+
* @param {string} company_id - company_id
|
|
124
|
+
* @param {Schematic.UpdateCompanyBillingDetailsRequestBody} request
|
|
125
|
+
* @param {CheckoutClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
126
|
+
*
|
|
127
|
+
* @throws {@link Schematic.BadRequestError}
|
|
128
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
129
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
130
|
+
* @throws {@link Schematic.NotFoundError}
|
|
131
|
+
* @throws {@link Schematic.InternalServerError}
|
|
132
|
+
*
|
|
133
|
+
* @example
|
|
134
|
+
* await client.checkout.updateCompanyBillingDetails("company_id", {
|
|
135
|
+
* values: [{
|
|
136
|
+
* id: "id",
|
|
137
|
+
* value: "value"
|
|
138
|
+
* }]
|
|
139
|
+
* })
|
|
140
|
+
*/
|
|
141
|
+
updateCompanyBillingDetails(company_id: string, request: Schematic.UpdateCompanyBillingDetailsRequestBody, requestOptions?: CheckoutClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdateCompanyBillingDetailsResponse>;
|
|
142
|
+
private __updateCompanyBillingDetails;
|
|
108
143
|
/**
|
|
109
144
|
* @param {Schematic.ManagePlanRequest} request
|
|
110
145
|
* @param {CheckoutClient.RequestOptions} requestOptions - Request-specific configuration.
|
package/dist/api/resources/checkout/client/requests/UpdateCompanyBillingDetailsRequestBody.d.ts
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* values: [{
|
|
6
|
+
* id: "id",
|
|
7
|
+
* value: "value"
|
|
8
|
+
* }]
|
|
9
|
+
* }
|
|
10
|
+
*/
|
|
11
|
+
export interface UpdateCompanyBillingDetailsRequestBody {
|
|
12
|
+
address?: Schematic.CustomerBillingAddress;
|
|
13
|
+
email?: string;
|
|
14
|
+
phone?: string;
|
|
15
|
+
taxId?: Schematic.TaxIdInput;
|
|
16
|
+
values: Schematic.CheckoutFieldValue[];
|
|
17
|
+
}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
1
|
export type { CancelSubscriptionRequest } from "./CancelSubscriptionRequest";
|
|
2
2
|
export type { CheckoutDataRequestBody } from "./CheckoutDataRequestBody";
|
|
3
|
+
export type { UpdateCompanyBillingDetailsRequestBody } from "./UpdateCompanyBillingDetailsRequestBody";
|
|
3
4
|
export type { UpdateTrialEndRequestBody } from "./UpdateTrialEndRequestBody";
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
export * from "./CancelSubscriptionResponse";
|
|
2
2
|
export * from "./CheckoutInternalResponse";
|
|
3
3
|
export * from "./GetCheckoutDataResponse";
|
|
4
|
+
export * from "./GetCompanyBillingDetailsResponse";
|
|
4
5
|
export * from "./ManagePlanResponse";
|
|
5
6
|
export * from "./PreviewCheckoutInternalResponse";
|
|
6
7
|
export * from "./PreviewManagePlanResponse";
|
|
8
|
+
export * from "./UpdateCompanyBillingDetailsResponse";
|
|
7
9
|
export * from "./UpdateCustomerSubscriptionTrialEndResponse";
|
|
@@ -451,4 +451,42 @@ export declare class EntitlementsClient {
|
|
|
451
451
|
*/
|
|
452
452
|
getFeatureUsageByCompany(request: Schematic.GetFeatureUsageByCompanyRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetFeatureUsageByCompanyResponse>;
|
|
453
453
|
private __getFeatureUsageByCompany;
|
|
454
|
+
/**
|
|
455
|
+
* @param {Schematic.GetUserUsageByCompanyRequest} request
|
|
456
|
+
* @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
457
|
+
*
|
|
458
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
459
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
460
|
+
* @throws {@link Schematic.NotFoundError}
|
|
461
|
+
* @throws {@link Schematic.InternalServerError}
|
|
462
|
+
*
|
|
463
|
+
* @example
|
|
464
|
+
* await client.entitlements.getUserUsageByCompany({
|
|
465
|
+
* companyId: "company_id",
|
|
466
|
+
* endTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
467
|
+
* featureId: "feature_id",
|
|
468
|
+
* startTime: new Date("2024-01-15T09:30:00.000Z")
|
|
469
|
+
* })
|
|
470
|
+
*/
|
|
471
|
+
getUserUsageByCompany(request: Schematic.GetUserUsageByCompanyRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetUserUsageByCompanyResponse>;
|
|
472
|
+
private __getUserUsageByCompany;
|
|
473
|
+
/**
|
|
474
|
+
* @param {Schematic.GetUserUsageDetailRequest} request
|
|
475
|
+
* @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
476
|
+
*
|
|
477
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
478
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
479
|
+
* @throws {@link Schematic.NotFoundError}
|
|
480
|
+
* @throws {@link Schematic.InternalServerError}
|
|
481
|
+
*
|
|
482
|
+
* @example
|
|
483
|
+
* await client.entitlements.getUserUsageDetail({
|
|
484
|
+
* companyId: "company_id",
|
|
485
|
+
* endTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
486
|
+
* startTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
487
|
+
* userId: "user_id"
|
|
488
|
+
* })
|
|
489
|
+
*/
|
|
490
|
+
getUserUsageDetail(request: Schematic.GetUserUsageDetailRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetUserUsageDetailResponse>;
|
|
491
|
+
private __getUserUsageDetail;
|
|
454
492
|
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* companyId: "company_id",
|
|
5
|
+
* endTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
6
|
+
* featureId: "feature_id",
|
|
7
|
+
* startTime: new Date("2024-01-15T09:30:00.000Z")
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface GetUserUsageByCompanyRequest {
|
|
11
|
+
/** Company to break usage down for */
|
|
12
|
+
companyId: string;
|
|
13
|
+
/** End of the usage window (exclusive); defaults to now */
|
|
14
|
+
endTime?: Date;
|
|
15
|
+
/** Restrict to a single event-based feature */
|
|
16
|
+
featureId?: string;
|
|
17
|
+
/** Start of the usage window; defaults to 30 days before the end */
|
|
18
|
+
startTime?: Date;
|
|
19
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* companyId: "company_id",
|
|
5
|
+
* endTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
6
|
+
* startTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
7
|
+
* userId: "user_id"
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface GetUserUsageDetailRequest {
|
|
11
|
+
/** Company the user belongs to */
|
|
12
|
+
companyId: string;
|
|
13
|
+
/** End of the usage window (exclusive); defaults to now */
|
|
14
|
+
endTime?: Date;
|
|
15
|
+
/** Start of the usage window; defaults to 30 days before the end */
|
|
16
|
+
startTime?: Date;
|
|
17
|
+
/** User to break usage down for */
|
|
18
|
+
userId: string;
|
|
19
|
+
}
|
|
@@ -9,6 +9,8 @@ export type { CreatePlanEntitlementRequestBody } from "./CreatePlanEntitlementRe
|
|
|
9
9
|
export type { DuplicatePlanEntitlementsRequestBody } from "./DuplicatePlanEntitlementsRequestBody";
|
|
10
10
|
export type { GetFeatureUsageByCompanyRequest } from "./GetFeatureUsageByCompanyRequest";
|
|
11
11
|
export type { GetFeatureUsageTimeSeriesRequest } from "./GetFeatureUsageTimeSeriesRequest";
|
|
12
|
+
export type { GetUserUsageByCompanyRequest } from "./GetUserUsageByCompanyRequest";
|
|
13
|
+
export type { GetUserUsageDetailRequest } from "./GetUserUsageDetailRequest";
|
|
12
14
|
export type { ListCompanyOverridesRequest } from "./ListCompanyOverridesRequest";
|
|
13
15
|
export type { ListFeatureCompaniesRequest } from "./ListFeatureCompaniesRequest";
|
|
14
16
|
export type { ListFeatureUsageRequest } from "./ListFeatureUsageRequest";
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Input parameters
|
|
3
|
+
*/
|
|
4
|
+
export interface GetUserUsageByCompanyParams {
|
|
5
|
+
/** Company to break usage down for */
|
|
6
|
+
companyId?: string;
|
|
7
|
+
/** End of the usage window (exclusive); defaults to now */
|
|
8
|
+
endTime?: Date;
|
|
9
|
+
/** Restrict to a single event-based feature */
|
|
10
|
+
featureId?: string;
|
|
11
|
+
/** Start of the usage window; defaults to 30 days before the end */
|
|
12
|
+
startTime?: Date;
|
|
13
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Input parameters
|
|
3
|
+
*/
|
|
4
|
+
export interface GetUserUsageDetailParams {
|
|
5
|
+
/** Company the user belongs to */
|
|
6
|
+
companyId?: string;
|
|
7
|
+
/** End of the usage window (exclusive); defaults to now */
|
|
8
|
+
endTime?: Date;
|
|
9
|
+
/** Start of the usage window; defaults to 30 days before the end */
|
|
10
|
+
startTime?: Date;
|
|
11
|
+
/** User to break usage down for */
|
|
12
|
+
userId?: string;
|
|
13
|
+
}
|
|
@@ -19,6 +19,10 @@ export * from "./GetFeatureUsageByCompanyResponse";
|
|
|
19
19
|
export * from "./GetFeatureUsageTimeSeriesParams";
|
|
20
20
|
export * from "./GetFeatureUsageTimeSeriesResponse";
|
|
21
21
|
export * from "./GetPlanEntitlementResponse";
|
|
22
|
+
export * from "./GetUserUsageByCompanyParams";
|
|
23
|
+
export * from "./GetUserUsageByCompanyResponse";
|
|
24
|
+
export * from "./GetUserUsageDetailParams";
|
|
25
|
+
export * from "./GetUserUsageDetailResponse";
|
|
22
26
|
export * from "./ListCompanyOverridesParams";
|
|
23
27
|
export * from "./ListCompanyOverridesResponse";
|
|
24
28
|
export * from "./ListFeatureCompaniesParams";
|
|
@@ -42,6 +42,9 @@ export * from "./insights/types";
|
|
|
42
42
|
export * as integrationsapi from "./integrationsapi";
|
|
43
43
|
export * from "./integrationsapi/client/requests";
|
|
44
44
|
export * from "./integrationsapi/types";
|
|
45
|
+
export * as licenses from "./licenses";
|
|
46
|
+
export * from "./licenses/client/requests";
|
|
47
|
+
export * from "./licenses/types";
|
|
45
48
|
export * as planbundle from "./planbundle";
|
|
46
49
|
export * from "./planbundle/client/requests";
|
|
47
50
|
export * from "./planbundle/types";
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient";
|
|
2
|
+
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient";
|
|
3
|
+
import * as core from "../../../../core";
|
|
4
|
+
import * as Schematic from "../../../index";
|
|
5
|
+
export declare namespace LicensesClient {
|
|
6
|
+
type Options = BaseClientOptions;
|
|
7
|
+
interface RequestOptions extends BaseRequestOptions {
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
export declare class LicensesClient {
|
|
11
|
+
protected readonly _options: NormalizedClientOptionsWithAuth<LicensesClient.Options>;
|
|
12
|
+
constructor(options: LicensesClient.Options);
|
|
13
|
+
/**
|
|
14
|
+
* @param {Schematic.ListLicensesRequest} request
|
|
15
|
+
* @param {LicensesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
16
|
+
*
|
|
17
|
+
* @throws {@link Schematic.BadRequestError}
|
|
18
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
19
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
20
|
+
* @throws {@link Schematic.NotFoundError}
|
|
21
|
+
* @throws {@link Schematic.InternalServerError}
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* await client.licenses.listLicenses({
|
|
25
|
+
* featureIds: ["feature_ids"],
|
|
26
|
+
* ids: ["ids"],
|
|
27
|
+
* name: "name",
|
|
28
|
+
* limit: 1000000,
|
|
29
|
+
* offset: 1000000
|
|
30
|
+
* })
|
|
31
|
+
*/
|
|
32
|
+
listLicenses(request?: Schematic.ListLicensesRequest, requestOptions?: LicensesClient.RequestOptions): core.HttpResponsePromise<Schematic.ListLicensesResponse>;
|
|
33
|
+
private __listLicenses;
|
|
34
|
+
/**
|
|
35
|
+
* @param {string} license_id - license_id
|
|
36
|
+
* @param {LicensesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
39
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
40
|
+
* @throws {@link Schematic.NotFoundError}
|
|
41
|
+
* @throws {@link Schematic.InternalServerError}
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* await client.licenses.getSingleLicense("license_id")
|
|
45
|
+
*/
|
|
46
|
+
getSingleLicense(license_id: string, requestOptions?: LicensesClient.RequestOptions): core.HttpResponsePromise<Schematic.GetSingleLicenseResponse>;
|
|
47
|
+
private __getSingleLicense;
|
|
48
|
+
/**
|
|
49
|
+
* @param {Schematic.CountLicensesRequest} request
|
|
50
|
+
* @param {LicensesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link Schematic.BadRequestError}
|
|
53
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
54
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
55
|
+
* @throws {@link Schematic.NotFoundError}
|
|
56
|
+
* @throws {@link Schematic.InternalServerError}
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* await client.licenses.countLicenses({
|
|
60
|
+
* featureIds: ["feature_ids"],
|
|
61
|
+
* ids: ["ids"],
|
|
62
|
+
* name: "name",
|
|
63
|
+
* limit: 1000000,
|
|
64
|
+
* offset: 1000000
|
|
65
|
+
* })
|
|
66
|
+
*/
|
|
67
|
+
countLicenses(request?: Schematic.CountLicensesRequest, requestOptions?: LicensesClient.RequestOptions): core.HttpResponsePromise<Schematic.CountLicensesResponse>;
|
|
68
|
+
private __countLicenses;
|
|
69
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./requests";
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* featureIds: ["feature_ids"],
|
|
5
|
+
* ids: ["ids"],
|
|
6
|
+
* name: "name",
|
|
7
|
+
* limit: 1000000,
|
|
8
|
+
* offset: 1000000
|
|
9
|
+
* }
|
|
10
|
+
*/
|
|
11
|
+
export interface CountLicensesRequest {
|
|
12
|
+
featureIds?: string | string[];
|
|
13
|
+
ids?: string | string[];
|
|
14
|
+
name?: string;
|
|
15
|
+
/** Page limit (default 100) */
|
|
16
|
+
limit?: number;
|
|
17
|
+
/** Page offset (default 0) */
|
|
18
|
+
offset?: number;
|
|
19
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* featureIds: ["feature_ids"],
|
|
5
|
+
* ids: ["ids"],
|
|
6
|
+
* name: "name",
|
|
7
|
+
* limit: 1000000,
|
|
8
|
+
* offset: 1000000
|
|
9
|
+
* }
|
|
10
|
+
*/
|
|
11
|
+
export interface ListLicensesRequest {
|
|
12
|
+
featureIds?: string | string[];
|
|
13
|
+
ids?: string | string[];
|
|
14
|
+
name?: string;
|
|
15
|
+
/** Page limit (default 100) */
|
|
16
|
+
limit?: number;
|
|
17
|
+
/** Page offset (default 0) */
|
|
18
|
+
offset?: number;
|
|
19
|
+
}
|