@schematichq/schematic-typescript-node 1.5.8 → 1.5.9
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/README.md +1 -1
- package/dist/api/resources/accounts/client/Client.d.ts +28 -0
- package/dist/api/resources/accounts/client/requests/UpdateOnboardingStateRequestBody.d.ts +11 -0
- package/dist/api/resources/accounts/client/requests/index.d.ts +1 -0
- package/dist/api/resources/accounts/types/GetOnboardingStateResponse.d.ts +6 -0
- package/dist/api/resources/accounts/types/UpdateOnboardingStateResponse.d.ts +6 -0
- package/dist/api/resources/accounts/types/index.d.ts +2 -0
- package/dist/api/resources/companies/client/Client.d.ts +53 -3
- package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +3 -0
- package/dist/api/resources/companies/client/requests/CountEntityTraitsRequest.d.ts +18 -0
- package/dist/api/resources/companies/client/requests/GetBillingEntityChildSubscriptionsRequest.d.ts +1 -1
- package/dist/api/resources/companies/client/requests/GetCompanyBillingEntityRequest.d.ts +1 -1
- package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +3 -0
- package/dist/api/resources/companies/client/requests/ListPlanChangesRequest.d.ts +0 -2
- package/dist/api/resources/companies/client/requests/index.d.ts +1 -0
- package/dist/api/resources/companies/types/CountCompaniesParams.d.ts +2 -0
- package/dist/api/resources/companies/types/CountEntityTraitsParams.d.ts +12 -0
- package/dist/api/resources/companies/types/CountEntityTraitsResponse.d.ts +6 -0
- package/dist/api/resources/companies/types/DeleteEntityTraitDefinitionResponse.d.ts +6 -0
- package/dist/api/resources/companies/types/GetEntityTraitDefinitionUsageResponse.d.ts +6 -0
- package/dist/api/resources/companies/types/ListCompaniesParams.d.ts +2 -0
- package/dist/api/resources/companies/types/ListPlanChangesParams.d.ts +0 -1
- package/dist/api/resources/companies/types/index.d.ts +4 -0
- package/dist/api/resources/credits/client/Client.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/CountCompanyGrantsRequest.d.ts +1 -1
- package/dist/api/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +2 -0
- package/dist/api/resources/credits/client/requests/ListCompanyGrantsRequest.d.ts +1 -1
- package/dist/api/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +2 -0
- package/dist/api/resources/entitlements/client/Client.d.ts +23 -0
- package/dist/api/resources/entitlements/client/requests/ListFeatureUsageHistoryRequest.d.ts +29 -0
- package/dist/api/resources/entitlements/client/requests/index.d.ts +1 -0
- package/dist/api/resources/entitlements/types/ListFeatureUsageHistoryParams.d.ts +20 -0
- package/dist/api/resources/entitlements/types/ListFeatureUsageHistoryResponse.d.ts +6 -0
- package/dist/api/resources/entitlements/types/index.d.ts +2 -0
- package/dist/api/resources/planbundle/client/Client.d.ts +23 -6
- package/dist/api/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +12 -3
- package/dist/api/resources/planbundle/client/requests/CreatePlanBundleRequestBody.d.ts +7 -2
- package/dist/api/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +5 -2
- package/dist/api/resources/plangroups/client/Client.d.ts +2 -0
- package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +3 -0
- package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +3 -0
- package/dist/api/resources/planmigrations/client/Client.d.ts +4 -8
- package/dist/api/resources/planmigrations/client/requests/CountCompanyMigrationsRequest.d.ts +1 -1
- package/dist/api/resources/planmigrations/client/requests/CountMigrationsRequest.d.ts +1 -1
- package/dist/api/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +4 -6
- package/dist/api/resources/planmigrations/client/requests/ListCompanyMigrationsRequest.d.ts +1 -1
- package/dist/api/resources/planmigrations/client/requests/ListMigrationsRequest.d.ts +1 -1
- package/dist/api/resources/planmigrations/client/requests/PreviewMigrationRequestBody.d.ts +2 -2
- package/dist/api/resources/plans/client/Client.d.ts +10 -9
- package/dist/api/resources/plans/client/requests/CreateCustomPlanRequestBody.d.ts +1 -0
- package/dist/api/resources/plans/client/requests/ListCustomPlanBillingsRequest.d.ts +3 -0
- package/dist/api/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +3 -0
- package/dist/api/resources/plans/types/ListCustomPlanBillingsParams.d.ts +2 -0
- package/dist/api/types/BillingCollectionMethod.d.ts +5 -0
- package/dist/api/types/BillingCreditBundleResponseData.d.ts +2 -0
- package/dist/api/types/BillingCreditBundleView.d.ts +1 -0
- package/dist/api/types/BillingCreditGrantResponseData.d.ts +4 -0
- package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +2 -0
- package/dist/api/types/CheckFlagRequestBody.d.ts +3 -0
- package/dist/api/types/CheckoutBundlePurchaseBehavior.d.ts +5 -0
- package/dist/api/types/CheckoutSettingsResponseData.d.ts +3 -0
- package/dist/api/types/CompanyBillingCheckoutSettings.d.ts +1 -0
- package/dist/api/types/CompanyFeatureUsageExportMetadata.d.ts +6 -0
- package/dist/api/types/CompanyPlanCreditGrantView.d.ts +1 -0
- package/dist/api/types/ComponentCheckoutSettings.d.ts +2 -0
- package/dist/api/types/CreateBillingPlanCreditGrantRequestBody.d.ts +2 -0
- package/dist/api/types/CreditCompanyGrantView.d.ts +2 -0
- package/dist/api/types/CustomPlanBillingResponseData.d.ts +4 -0
- package/dist/api/types/EntityTraitDefinitionUsage.d.ts +8 -0
- package/dist/api/types/EventBodyFlagCheck.d.ts +2 -0
- package/dist/api/types/FeatureUsageHistoryResponseData.d.ts +12 -0
- package/dist/api/types/GetOnboardingStateResp.d.ts +9 -0
- package/dist/api/types/ManagePlanRequest.d.ts +14 -0
- package/dist/api/types/MigrationProrationBehavior.d.ts +6 -0
- package/dist/api/types/OnboardingMilestone.d.ts +5 -0
- package/dist/api/types/OnboardingMilestoneView.d.ts +7 -0
- package/dist/api/types/OnboardingPath.d.ts +5 -0
- package/dist/api/types/OnboardingRequirement.d.ts +9 -0
- package/dist/api/types/OnboardingRequirementStatus.d.ts +6 -0
- package/dist/api/types/OnboardingRequirementView.d.ts +7 -0
- package/dist/api/types/OnboardingTrack.d.ts +5 -0
- package/dist/api/types/PlanBillingSource.d.ts +5 -0
- package/dist/api/types/PlanBundleResponseData.d.ts +1 -0
- package/dist/api/types/PlanCreditGrantView.d.ts +1 -0
- package/dist/api/types/PlanVersionMigrationPreviewCompanyResponseData.d.ts +1 -0
- package/dist/api/types/PlanVersionMigrationPreviewResponseData.d.ts +1 -0
- package/dist/api/types/PlanVersionMigrationResponseData.d.ts +1 -0
- package/dist/api/types/PreflightEventUsageRequestBody.d.ts +6 -0
- package/dist/api/types/PreflightRequestBody.d.ts +9 -0
- package/dist/api/types/PreviewSubscriptionFinanceResponseData.d.ts +1 -0
- package/dist/api/types/RulesEngineSchemaVersion.d.ts +1 -1
- package/dist/api/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +4 -2
- package/dist/api/types/UpsertCompanyRequestBody.d.ts +2 -0
- package/dist/api/types/UpsertUserRequestBody.d.ts +2 -0
- package/dist/api/types/UpsertUserSubRequestBody.d.ts +2 -0
- package/dist/api/types/WhoAmIResponseData.d.ts +1 -0
- package/dist/api/types/index.d.ts +16 -0
- package/dist/index.js +9 -9
- package/dist/serialization/resources/accounts/client/requests/UpdateOnboardingStateRequestBody.d.ts +14 -0
- package/dist/serialization/resources/accounts/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/accounts/types/GetOnboardingStateResponse.d.ts +11 -0
- package/dist/serialization/resources/accounts/types/UpdateOnboardingStateResponse.d.ts +11 -0
- package/dist/serialization/resources/accounts/types/index.d.ts +2 -0
- package/dist/serialization/resources/companies/types/CountCompaniesParams.d.ts +1 -0
- package/dist/serialization/resources/companies/types/CountEntityTraitsParams.d.ts +13 -0
- package/dist/serialization/resources/companies/types/CountEntityTraitsResponse.d.ts +12 -0
- package/dist/serialization/resources/companies/types/DeleteEntityTraitDefinitionResponse.d.ts +11 -0
- package/dist/serialization/resources/companies/types/GetEntityTraitDefinitionUsageResponse.d.ts +11 -0
- package/dist/serialization/resources/companies/types/ListCompaniesParams.d.ts +1 -0
- package/dist/serialization/resources/companies/types/ListPlanChangesParams.d.ts +0 -1
- package/dist/serialization/resources/companies/types/index.d.ts +4 -0
- package/dist/serialization/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +1 -0
- package/dist/serialization/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +1 -0
- package/dist/serialization/resources/entitlements/types/ListFeatureUsageHistoryParams.d.ts +16 -0
- package/dist/serialization/resources/entitlements/types/ListFeatureUsageHistoryResponse.d.ts +12 -0
- package/dist/serialization/resources/entitlements/types/index.d.ts +2 -0
- package/dist/serialization/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +2 -2
- package/dist/serialization/resources/planbundle/client/requests/CreatePlanBundleRequestBody.d.ts +1 -1
- package/dist/serialization/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +1 -1
- package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +3 -0
- package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +3 -0
- package/dist/serialization/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +5 -3
- package/dist/serialization/resources/planmigrations/client/requests/PreviewMigrationRequestBody.d.ts +2 -1
- package/dist/serialization/resources/plans/client/requests/CreateCustomPlanRequestBody.d.ts +1 -0
- package/dist/serialization/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +3 -0
- package/dist/serialization/resources/plans/types/ListCustomPlanBillingsParams.d.ts +2 -0
- package/dist/serialization/types/BillingCollectionMethod.d.ts +7 -0
- package/dist/serialization/types/BillingCreditBundleResponseData.d.ts +1 -0
- package/dist/serialization/types/BillingCreditBundleView.d.ts +1 -0
- package/dist/serialization/types/BillingCreditGrantResponseData.d.ts +2 -0
- package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +1 -0
- package/dist/serialization/types/CheckFlagRequestBody.d.ts +2 -0
- package/dist/serialization/types/CheckoutBundlePurchaseBehavior.d.ts +7 -0
- package/dist/serialization/types/CheckoutSettingsResponseData.d.ts +3 -0
- package/dist/serialization/types/CompanyBillingCheckoutSettings.d.ts +1 -0
- package/dist/serialization/types/CompanyFeatureUsageExportMetadata.d.ts +3 -0
- package/dist/serialization/types/CompanyPlanCreditGrantView.d.ts +1 -0
- package/dist/serialization/types/ComponentCheckoutSettings.d.ts +3 -0
- package/dist/serialization/types/CreateBillingPlanCreditGrantRequestBody.d.ts +1 -0
- package/dist/serialization/types/CreditCompanyGrantView.d.ts +2 -0
- package/dist/serialization/types/CustomPlanBillingResponseData.d.ts +3 -0
- package/dist/serialization/types/EntityTraitDefinitionUsage.d.ts +14 -0
- package/dist/serialization/types/EventBodyFlagCheck.d.ts +1 -0
- package/dist/serialization/types/FeatureUsageHistoryResponseData.d.ts +14 -0
- package/dist/serialization/types/GetOnboardingStateResp.d.ts +19 -0
- package/dist/serialization/types/ManagePlanRequest.d.ts +8 -0
- package/dist/serialization/types/MigrationProrationBehavior.d.ts +7 -0
- package/dist/serialization/types/OnboardingMilestone.d.ts +7 -0
- package/dist/serialization/types/OnboardingMilestoneView.d.ts +14 -0
- package/dist/serialization/types/OnboardingPath.d.ts +7 -0
- package/dist/serialization/types/OnboardingRequirement.d.ts +7 -0
- package/dist/serialization/types/OnboardingRequirementStatus.d.ts +7 -0
- package/dist/serialization/types/OnboardingRequirementView.d.ts +14 -0
- package/dist/serialization/types/OnboardingTrack.d.ts +7 -0
- package/dist/serialization/types/PlanBillingSource.d.ts +7 -0
- package/dist/serialization/types/PlanBundleResponseData.d.ts +2 -0
- package/dist/serialization/types/PlanCreditGrantView.d.ts +1 -0
- package/dist/serialization/types/PlanVersionMigrationPreviewCompanyResponseData.d.ts +1 -0
- package/dist/serialization/types/PlanVersionMigrationPreviewResponseData.d.ts +1 -0
- package/dist/serialization/types/PlanVersionMigrationResponseData.d.ts +2 -0
- package/dist/serialization/types/PreflightEventUsageRequestBody.d.ts +10 -0
- package/dist/serialization/types/PreflightRequestBody.d.ts +12 -0
- package/dist/serialization/types/PreviewSubscriptionFinanceResponseData.d.ts +1 -0
- package/dist/serialization/types/RulesEngineSchemaVersion.d.ts +1 -1
- package/dist/serialization/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +1 -0
- package/dist/serialization/types/UpsertCompanyRequestBody.d.ts +1 -0
- package/dist/serialization/types/UpsertUserRequestBody.d.ts +1 -0
- package/dist/serialization/types/UpsertUserSubRequestBody.d.ts +1 -0
- package/dist/serialization/types/WhoAmIResponseData.d.ts +1 -0
- package/dist/serialization/types/index.d.ts +16 -0
- package/dist/wasm/rulesengine.js +4 -4
- package/package.json +4 -1
package/README.md
CHANGED
|
@@ -12,7 +12,7 @@ yarn add @schematichq/schematic-typescript-node
|
|
|
12
12
|
pnpm add @schematichq/schematic-typescript-node
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
2. [Issue an API key](https://docs.schematichq.com/quickstart#create-
|
|
15
|
+
2. [Issue an API key](https://docs.schematichq.com/quickstart/account-setup#2-create-your-api-keys) for the appropriate environment using the [Schematic app](https://app.schematichq.com/settings/api-keys). Be sure to capture the secret key when you issue the API key; you'll only see this key once, and this is what you'll use with schematic-typescript-node.
|
|
16
16
|
|
|
17
17
|
3. Using this secret key, initialize a client in your application:
|
|
18
18
|
|
|
@@ -310,6 +310,34 @@ export declare class AccountsClient {
|
|
|
310
310
|
*/
|
|
311
311
|
deleteEnvironment(environment_id: string, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteEnvironmentResponse>;
|
|
312
312
|
private __deleteEnvironment;
|
|
313
|
+
/**
|
|
314
|
+
* @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
315
|
+
*
|
|
316
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
317
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
318
|
+
* @throws {@link Schematic.NotFoundError}
|
|
319
|
+
* @throws {@link Schematic.InternalServerError}
|
|
320
|
+
*
|
|
321
|
+
* @example
|
|
322
|
+
* await client.accounts.getOnboardingState()
|
|
323
|
+
*/
|
|
324
|
+
getOnboardingState(requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetOnboardingStateResponse>;
|
|
325
|
+
private __getOnboardingState;
|
|
326
|
+
/**
|
|
327
|
+
* @param {Schematic.UpdateOnboardingStateRequestBody} request
|
|
328
|
+
* @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
329
|
+
*
|
|
330
|
+
* @throws {@link Schematic.BadRequestError}
|
|
331
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
332
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
333
|
+
* @throws {@link Schematic.NotFoundError}
|
|
334
|
+
* @throws {@link Schematic.InternalServerError}
|
|
335
|
+
*
|
|
336
|
+
* @example
|
|
337
|
+
* await client.accounts.updateOnboardingState()
|
|
338
|
+
*/
|
|
339
|
+
updateOnboardingState(request?: Schematic.UpdateOnboardingStateRequestBody, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdateOnboardingStateResponse>;
|
|
340
|
+
private __updateOnboardingState;
|
|
313
341
|
/**
|
|
314
342
|
* @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
315
343
|
*
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {}
|
|
5
|
+
*/
|
|
6
|
+
export interface UpdateOnboardingStateRequestBody {
|
|
7
|
+
path?: Schematic.OnboardingPath;
|
|
8
|
+
pricingPageUrl?: string;
|
|
9
|
+
track?: Schematic.OnboardingTrack;
|
|
10
|
+
websiteUrl?: string;
|
|
11
|
+
}
|
|
@@ -9,3 +9,4 @@ export type { ListAuditLogsRequest } from "./ListAuditLogsRequest";
|
|
|
9
9
|
export type { ListEnvironmentsRequest } from "./ListEnvironmentsRequest";
|
|
10
10
|
export type { UpdateApiKeyRequestBody } from "./UpdateApiKeyRequestBody";
|
|
11
11
|
export type { UpdateEnvironmentRequestBody } from "./UpdateEnvironmentRequestBody";
|
|
12
|
+
export type { UpdateOnboardingStateRequestBody } from "./UpdateOnboardingStateRequestBody";
|
|
@@ -12,6 +12,7 @@ export * from "./GetAccountMemberResponse";
|
|
|
12
12
|
export * from "./GetApiKeyResponse";
|
|
13
13
|
export * from "./GetAuditLogResponse";
|
|
14
14
|
export * from "./GetEnvironmentResponse";
|
|
15
|
+
export * from "./GetOnboardingStateResponse";
|
|
15
16
|
export * from "./GetWhoAmIResponse";
|
|
16
17
|
export * from "./ListAccountMembersParams";
|
|
17
18
|
export * from "./ListAccountMembersResponse";
|
|
@@ -24,3 +25,4 @@ export * from "./ListEnvironmentsResponse";
|
|
|
24
25
|
export * from "./QuickstartResponse";
|
|
25
26
|
export * from "./UpdateApiKeyResponse";
|
|
26
27
|
export * from "./UpdateEnvironmentResponse";
|
|
28
|
+
export * from "./UpdateOnboardingStateResponse";
|
|
@@ -30,6 +30,7 @@ export declare class CompaniesClient {
|
|
|
30
30
|
* planIds: ["plan_ids"],
|
|
31
31
|
* planVersionId: "plan_version_id",
|
|
32
32
|
* planVersionIds: ["plan_version_ids"],
|
|
33
|
+
* planVersionUnpublished: true,
|
|
33
34
|
* q: "q",
|
|
34
35
|
* sortOrderColumn: "sort_order_column",
|
|
35
36
|
* sortOrderDirection: "asc",
|
|
@@ -118,6 +119,7 @@ export declare class CompaniesClient {
|
|
|
118
119
|
* planIds: ["plan_ids"],
|
|
119
120
|
* planVersionId: "plan_version_id",
|
|
120
121
|
* planVersionIds: ["plan_version_ids"],
|
|
122
|
+
* planVersionUnpublished: true,
|
|
121
123
|
* q: "q",
|
|
122
124
|
* sortOrderColumn: "sort_order_column",
|
|
123
125
|
* sortOrderDirection: "asc",
|
|
@@ -211,7 +213,7 @@ export declare class CompaniesClient {
|
|
|
211
213
|
* companyId: "company_id"
|
|
212
214
|
* })
|
|
213
215
|
*/
|
|
214
|
-
getCompanyBillingEntity(request
|
|
216
|
+
getCompanyBillingEntity(request: Schematic.GetCompanyBillingEntityRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.GetCompanyBillingEntityResponse>;
|
|
215
217
|
private __getCompanyBillingEntity;
|
|
216
218
|
/**
|
|
217
219
|
* @param {Schematic.GetBillingEntityChildSubscriptionsRequest} request
|
|
@@ -228,7 +230,7 @@ export declare class CompaniesClient {
|
|
|
228
230
|
* companyId: "company_id"
|
|
229
231
|
* })
|
|
230
232
|
*/
|
|
231
|
-
getBillingEntityChildSubscriptions(request
|
|
233
|
+
getBillingEntityChildSubscriptions(request: Schematic.GetBillingEntityChildSubscriptionsRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.GetBillingEntityChildSubscriptionsResponse>;
|
|
232
234
|
private __getBillingEntityChildSubscriptions;
|
|
233
235
|
/**
|
|
234
236
|
* @param {Schematic.ListCompanyMembershipsRequest} request
|
|
@@ -474,6 +476,35 @@ export declare class CompaniesClient {
|
|
|
474
476
|
*/
|
|
475
477
|
updateEntityTraitDefinition(entity_trait_definition_id: string, request: Schematic.UpdateEntityTraitDefinitionRequestBody, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdateEntityTraitDefinitionResponse>;
|
|
476
478
|
private __updateEntityTraitDefinition;
|
|
479
|
+
/**
|
|
480
|
+
* @param {string} entity_trait_definition_id - entity_trait_definition_id
|
|
481
|
+
* @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
482
|
+
*
|
|
483
|
+
* @throws {@link Schematic.BadRequestError}
|
|
484
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
485
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
486
|
+
* @throws {@link Schematic.NotFoundError}
|
|
487
|
+
* @throws {@link Schematic.InternalServerError}
|
|
488
|
+
*
|
|
489
|
+
* @example
|
|
490
|
+
* await client.companies.deleteEntityTraitDefinition("entity_trait_definition_id")
|
|
491
|
+
*/
|
|
492
|
+
deleteEntityTraitDefinition(entity_trait_definition_id: string, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteEntityTraitDefinitionResponse>;
|
|
493
|
+
private __deleteEntityTraitDefinition;
|
|
494
|
+
/**
|
|
495
|
+
* @param {string} entity_trait_definition_id - entity_trait_definition_id
|
|
496
|
+
* @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
497
|
+
*
|
|
498
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
499
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
500
|
+
* @throws {@link Schematic.NotFoundError}
|
|
501
|
+
* @throws {@link Schematic.InternalServerError}
|
|
502
|
+
*
|
|
503
|
+
* @example
|
|
504
|
+
* await client.companies.getEntityTraitDefinitionUsage("entity_trait_definition_id")
|
|
505
|
+
*/
|
|
506
|
+
getEntityTraitDefinitionUsage(entity_trait_definition_id: string, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.GetEntityTraitDefinitionUsageResponse>;
|
|
507
|
+
private __getEntityTraitDefinitionUsage;
|
|
477
508
|
/**
|
|
478
509
|
* @param {Schematic.CountEntityTraitDefinitionsRequest} request
|
|
479
510
|
* @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -517,6 +548,26 @@ export declare class CompaniesClient {
|
|
|
517
548
|
*/
|
|
518
549
|
getEntityTraitValues(request: Schematic.GetEntityTraitValuesRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.GetEntityTraitValuesResponse>;
|
|
519
550
|
private __getEntityTraitValues;
|
|
551
|
+
/**
|
|
552
|
+
* @param {Schematic.CountEntityTraitsRequest} request
|
|
553
|
+
* @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
554
|
+
*
|
|
555
|
+
* @throws {@link Schematic.BadRequestError}
|
|
556
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
557
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
558
|
+
* @throws {@link Schematic.NotFoundError}
|
|
559
|
+
* @throws {@link Schematic.InternalServerError}
|
|
560
|
+
*
|
|
561
|
+
* @example
|
|
562
|
+
* await client.companies.countEntityTraits({
|
|
563
|
+
* definitionId: "definition_id",
|
|
564
|
+
* entityType: "company",
|
|
565
|
+
* limit: 1000000,
|
|
566
|
+
* offset: 1000000
|
|
567
|
+
* })
|
|
568
|
+
*/
|
|
569
|
+
countEntityTraits(request?: Schematic.CountEntityTraitsRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.CountEntityTraitsResponse>;
|
|
570
|
+
private __countEntityTraits;
|
|
520
571
|
/**
|
|
521
572
|
* @param {Schematic.ListPlanChangesRequest} request
|
|
522
573
|
* @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -533,7 +584,6 @@ export declare class CompaniesClient {
|
|
|
533
584
|
* basePlanAction: "fallback",
|
|
534
585
|
* companyId: "company_id",
|
|
535
586
|
* companyIds: ["company_ids"],
|
|
536
|
-
* planIds: ["plan_ids"],
|
|
537
587
|
* limit: 1000000,
|
|
538
588
|
* offset: 1000000
|
|
539
589
|
* })
|
|
@@ -10,6 +10,7 @@ import type * as Schematic from "../../../../index";
|
|
|
10
10
|
* planIds: ["plan_ids"],
|
|
11
11
|
* planVersionId: "plan_version_id",
|
|
12
12
|
* planVersionIds: ["plan_version_ids"],
|
|
13
|
+
* planVersionUnpublished: true,
|
|
13
14
|
* q: "q",
|
|
14
15
|
* sortOrderColumn: "sort_order_column",
|
|
15
16
|
* sortOrderDirection: "asc",
|
|
@@ -41,6 +42,8 @@ export interface CountCompaniesRequest {
|
|
|
41
42
|
planVersionId?: string;
|
|
42
43
|
/** Filter companies by one or more plan version IDs (each ID starts with plvr_). Takes precedence over plan_version_id when set. */
|
|
43
44
|
planVersionIds?: string | string[];
|
|
45
|
+
/** Filter companies assigned to a plan version that is no longer published, meaning the plan has since moved on to a newer version */
|
|
46
|
+
planVersionUnpublished?: boolean;
|
|
44
47
|
/** Search for companies by name, keys or string traits */
|
|
45
48
|
q?: string;
|
|
46
49
|
/** Column to sort by (e.g. name, created_at, last_seen_at) */
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* definitionId: "definition_id",
|
|
6
|
+
* entityType: "company",
|
|
7
|
+
* limit: 1000000,
|
|
8
|
+
* offset: 1000000
|
|
9
|
+
* }
|
|
10
|
+
*/
|
|
11
|
+
export interface CountEntityTraitsRequest {
|
|
12
|
+
definitionId?: string;
|
|
13
|
+
entityType?: Schematic.EntityType;
|
|
14
|
+
/** Page limit (default 100) */
|
|
15
|
+
limit?: number;
|
|
16
|
+
/** Page offset (default 0) */
|
|
17
|
+
offset?: number;
|
|
18
|
+
}
|
|
@@ -10,6 +10,7 @@ import type * as Schematic from "../../../../index";
|
|
|
10
10
|
* planIds: ["plan_ids"],
|
|
11
11
|
* planVersionId: "plan_version_id",
|
|
12
12
|
* planVersionIds: ["plan_version_ids"],
|
|
13
|
+
* planVersionUnpublished: true,
|
|
13
14
|
* q: "q",
|
|
14
15
|
* sortOrderColumn: "sort_order_column",
|
|
15
16
|
* sortOrderDirection: "asc",
|
|
@@ -41,6 +42,8 @@ export interface ListCompaniesRequest {
|
|
|
41
42
|
planVersionId?: string;
|
|
42
43
|
/** Filter companies by one or more plan version IDs (each ID starts with plvr_). Takes precedence over plan_version_id when set. */
|
|
43
44
|
planVersionIds?: string | string[];
|
|
45
|
+
/** Filter companies assigned to a plan version that is no longer published, meaning the plan has since moved on to a newer version */
|
|
46
|
+
planVersionUnpublished?: boolean;
|
|
44
47
|
/** Search for companies by name, keys or string traits */
|
|
45
48
|
q?: string;
|
|
46
49
|
/** Column to sort by (e.g. name, created_at, last_seen_at) */
|
|
@@ -6,7 +6,6 @@ import type * as Schematic from "../../../../index";
|
|
|
6
6
|
* basePlanAction: "fallback",
|
|
7
7
|
* companyId: "company_id",
|
|
8
8
|
* companyIds: ["company_ids"],
|
|
9
|
-
* planIds: ["plan_ids"],
|
|
10
9
|
* limit: 1000000,
|
|
11
10
|
* offset: 1000000
|
|
12
11
|
* }
|
|
@@ -16,7 +15,6 @@ export interface ListPlanChangesRequest {
|
|
|
16
15
|
basePlanAction?: Schematic.PlanChangeBasePlanAction;
|
|
17
16
|
companyId?: string;
|
|
18
17
|
companyIds?: string | string[];
|
|
19
|
-
planIds?: string | string[];
|
|
20
18
|
/** Page limit (default 100) */
|
|
21
19
|
limit?: number;
|
|
22
20
|
/** Page offset (default 0) */
|
|
@@ -2,6 +2,7 @@ export type { CountCompaniesRequest } from "./CountCompaniesRequest";
|
|
|
2
2
|
export type { CountEntityKeyDefinitionsRequest } from "./CountEntityKeyDefinitionsRequest";
|
|
3
3
|
export type { CountEntityKeysRequest } from "./CountEntityKeysRequest";
|
|
4
4
|
export type { CountEntityTraitDefinitionsRequest } from "./CountEntityTraitDefinitionsRequest";
|
|
5
|
+
export type { CountEntityTraitsRequest } from "./CountEntityTraitsRequest";
|
|
5
6
|
export type { CountPlanTraitsRequest } from "./CountPlanTraitsRequest";
|
|
6
7
|
export type { CountUsersRequest } from "./CountUsersRequest";
|
|
7
8
|
export type { CreateEntityTraitDefinitionRequestBody } from "./CreateEntityTraitDefinitionRequestBody";
|
|
@@ -23,6 +23,8 @@ export interface CountCompaniesParams {
|
|
|
23
23
|
planVersionId?: string;
|
|
24
24
|
/** Filter companies by one or more plan version IDs (each ID starts with plvr_). Takes precedence over plan_version_id when set. */
|
|
25
25
|
planVersionIds?: string[];
|
|
26
|
+
/** Filter companies assigned to a plan version that is no longer published, meaning the plan has since moved on to a newer version */
|
|
27
|
+
planVersionUnpublished?: boolean;
|
|
26
28
|
/** Search for companies by name, keys or string traits */
|
|
27
29
|
q?: string;
|
|
28
30
|
/** Column to sort by (e.g. name, created_at, last_seen_at) */
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type * as Schematic from "../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* Input parameters
|
|
4
|
+
*/
|
|
5
|
+
export interface CountEntityTraitsParams {
|
|
6
|
+
definitionId?: string;
|
|
7
|
+
entityType?: Schematic.EntityType;
|
|
8
|
+
/** Page limit (default 100) */
|
|
9
|
+
limit?: number;
|
|
10
|
+
/** Page offset (default 0) */
|
|
11
|
+
offset?: number;
|
|
12
|
+
}
|
|
@@ -23,6 +23,8 @@ export interface ListCompaniesParams {
|
|
|
23
23
|
planVersionId?: string;
|
|
24
24
|
/** Filter companies by one or more plan version IDs (each ID starts with plvr_). Takes precedence over plan_version_id when set. */
|
|
25
25
|
planVersionIds?: string[];
|
|
26
|
+
/** Filter companies assigned to a plan version that is no longer published, meaning the plan has since moved on to a newer version */
|
|
27
|
+
planVersionUnpublished?: boolean;
|
|
26
28
|
/** Search for companies by name, keys or string traits */
|
|
27
29
|
q?: string;
|
|
28
30
|
/** Column to sort by (e.g. name, created_at, last_seen_at) */
|
|
@@ -6,6 +6,8 @@ export * from "./CountEntityKeysParams";
|
|
|
6
6
|
export * from "./CountEntityKeysResponse";
|
|
7
7
|
export * from "./CountEntityTraitDefinitionsParams";
|
|
8
8
|
export * from "./CountEntityTraitDefinitionsResponse";
|
|
9
|
+
export * from "./CountEntityTraitsParams";
|
|
10
|
+
export * from "./CountEntityTraitsResponse";
|
|
9
11
|
export * from "./CountPlanTraitsParams";
|
|
10
12
|
export * from "./CountPlanTraitsResponse";
|
|
11
13
|
export * from "./CountUsersParams";
|
|
@@ -17,6 +19,7 @@ export * from "./DeleteCompanyMembershipResponse";
|
|
|
17
19
|
export * from "./DeleteCompanyParams";
|
|
18
20
|
export * from "./DeleteCompanyResponse";
|
|
19
21
|
export * from "./DeleteEntityKeyDefinitionResponse";
|
|
22
|
+
export * from "./DeleteEntityTraitDefinitionResponse";
|
|
20
23
|
export * from "./DeleteUserByKeysResponse";
|
|
21
24
|
export * from "./DeleteUserResponse";
|
|
22
25
|
export * from "./GetActiveCompanySubscriptionParams";
|
|
@@ -27,6 +30,7 @@ export * from "./GetCompanyBillingEntityParams";
|
|
|
27
30
|
export * from "./GetCompanyBillingEntityResponse";
|
|
28
31
|
export * from "./GetCompanyResponse";
|
|
29
32
|
export * from "./GetEntityTraitDefinitionResponse";
|
|
33
|
+
export * from "./GetEntityTraitDefinitionUsageResponse";
|
|
30
34
|
export * from "./GetEntityTraitValuesParams";
|
|
31
35
|
export * from "./GetEntityTraitValuesResponse";
|
|
32
36
|
export * from "./GetOrCreateCompanyMembershipResponse";
|
|
@@ -301,7 +301,7 @@ export declare class CreditsClient {
|
|
|
301
301
|
* offset: 1000000
|
|
302
302
|
* })
|
|
303
303
|
*/
|
|
304
|
-
countCompanyGrants(request
|
|
304
|
+
countCompanyGrants(request: Schematic.CountCompanyGrantsRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCompanyGrantsResponse>;
|
|
305
305
|
private __countCompanyGrants;
|
|
306
306
|
/**
|
|
307
307
|
* @param {Schematic.ListCompanyGrantsRequest} request
|
|
@@ -322,7 +322,7 @@ export declare class CreditsClient {
|
|
|
322
322
|
* offset: 1000000
|
|
323
323
|
* })
|
|
324
324
|
*/
|
|
325
|
-
listCompanyGrants(request
|
|
325
|
+
listCompanyGrants(request: Schematic.ListCompanyGrantsRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyGrantsResponse>;
|
|
326
326
|
private __listCompanyGrants;
|
|
327
327
|
/**
|
|
328
328
|
* @param {Schematic.CountBillingCreditsGrantsRequest} request
|
|
@@ -10,7 +10,7 @@ import type * as Schematic from "../../../../index";
|
|
|
10
10
|
* }
|
|
11
11
|
*/
|
|
12
12
|
export interface CountCompanyGrantsRequest {
|
|
13
|
-
companyId
|
|
13
|
+
companyId: string;
|
|
14
14
|
order?: Schematic.CreditGrantSortOrder;
|
|
15
15
|
dir?: Schematic.SortDirection;
|
|
16
16
|
/** Page limit (default 100) */
|
|
@@ -11,6 +11,8 @@ import type * as Schematic from "../../../../index";
|
|
|
11
11
|
export interface CreateCreditBundleRequestBody {
|
|
12
12
|
bundleName: string;
|
|
13
13
|
bundleType?: Schematic.BillingCreditBundleType;
|
|
14
|
+
/** Plans whose companies may purchase this bundle. Omitted or empty means the bundle is purchasable on every plan. */
|
|
15
|
+
compatiblePlanIds?: string[];
|
|
14
16
|
creditId: string;
|
|
15
17
|
currency: string;
|
|
16
18
|
currencyPrices?: Schematic.CreditBundleCurrencyPriceRequestBody[];
|
|
@@ -10,7 +10,7 @@ import type * as Schematic from "../../../../index";
|
|
|
10
10
|
* }
|
|
11
11
|
*/
|
|
12
12
|
export interface ListCompanyGrantsRequest {
|
|
13
|
-
companyId
|
|
13
|
+
companyId: string;
|
|
14
14
|
order?: Schematic.CreditGrantSortOrder;
|
|
15
15
|
dir?: Schematic.SortDirection;
|
|
16
16
|
/** Page limit (default 100) */
|
package/dist/api/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts
CHANGED
|
@@ -8,6 +8,8 @@ import type * as Schematic from "../../../../index";
|
|
|
8
8
|
*/
|
|
9
9
|
export interface UpdateCreditBundleDetailsRequestBody {
|
|
10
10
|
bundleName: string;
|
|
11
|
+
/** Plans whose companies may purchase this bundle. Omitted leaves compatibility unchanged; empty resets the bundle to purchasable on every plan. */
|
|
12
|
+
compatiblePlanIds?: string[];
|
|
11
13
|
currencyPrices?: Schematic.CreditBundleCurrencyPriceRequestBody[];
|
|
12
14
|
expiryType?: Schematic.BillingCreditExpiryType;
|
|
13
15
|
expiryUnit?: Schematic.BillingCreditExpiryUnit;
|
|
@@ -190,6 +190,29 @@ export declare class EntitlementsClient {
|
|
|
190
190
|
*/
|
|
191
191
|
listFeatureUsage(request?: Schematic.ListFeatureUsageRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListFeatureUsageResponse>;
|
|
192
192
|
private __listFeatureUsage;
|
|
193
|
+
/**
|
|
194
|
+
* @param {Schematic.ListFeatureUsageHistoryRequest} request
|
|
195
|
+
* @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
196
|
+
*
|
|
197
|
+
* @throws {@link Schematic.BadRequestError}
|
|
198
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
199
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
200
|
+
* @throws {@link Schematic.NotFoundError}
|
|
201
|
+
* @throws {@link Schematic.InternalServerError}
|
|
202
|
+
*
|
|
203
|
+
* @example
|
|
204
|
+
* await client.entitlements.listFeatureUsageHistory({
|
|
205
|
+
* companyIds: ["company_ids"],
|
|
206
|
+
* endTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
207
|
+
* featureIds: ["feature_ids"],
|
|
208
|
+
* granularity: "daily",
|
|
209
|
+
* startTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
210
|
+
* limit: 1000000,
|
|
211
|
+
* offset: 1000000
|
|
212
|
+
* })
|
|
213
|
+
*/
|
|
214
|
+
listFeatureUsageHistory(request: Schematic.ListFeatureUsageHistoryRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListFeatureUsageHistoryResponse>;
|
|
215
|
+
private __listFeatureUsageHistory;
|
|
193
216
|
/**
|
|
194
217
|
* @param {Schematic.GetFeatureUsageTimeSeriesRequest} request
|
|
195
218
|
* @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* companyIds: ["company_ids"],
|
|
6
|
+
* endTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
7
|
+
* featureIds: ["feature_ids"],
|
|
8
|
+
* granularity: "daily",
|
|
9
|
+
* startTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
10
|
+
* limit: 1000000,
|
|
11
|
+
* offset: 1000000
|
|
12
|
+
* }
|
|
13
|
+
*/
|
|
14
|
+
export interface ListFeatureUsageHistoryRequest {
|
|
15
|
+
/** Restrict to these company IDs; omit for every company in the environment */
|
|
16
|
+
companyIds?: string | string[];
|
|
17
|
+
/** Exclusive end of the window; must fall on an hour boundary */
|
|
18
|
+
endTime: Date;
|
|
19
|
+
/** Restrict to these event features; omit for every event feature in the environment. Where several features measure the same event, each is reported separately and a page may carry more rows than the requested limit */
|
|
20
|
+
featureIds?: string | string[];
|
|
21
|
+
/** Bucket the window; omit for a single total per company and feature */
|
|
22
|
+
granularity?: Schematic.TimeSeriesGranularity;
|
|
23
|
+
/** Inclusive start of the window; must fall on an hour boundary */
|
|
24
|
+
startTime: Date;
|
|
25
|
+
/** Page limit (default 100) */
|
|
26
|
+
limit?: number;
|
|
27
|
+
/** Page offset (default 0) */
|
|
28
|
+
offset?: number;
|
|
29
|
+
}
|
|
@@ -13,6 +13,7 @@ export type { GetUserUsageByCompanyRequest } from "./GetUserUsageByCompanyReques
|
|
|
13
13
|
export type { GetUserUsageDetailRequest } from "./GetUserUsageDetailRequest";
|
|
14
14
|
export type { ListCompanyOverridesRequest } from "./ListCompanyOverridesRequest";
|
|
15
15
|
export type { ListFeatureCompaniesRequest } from "./ListFeatureCompaniesRequest";
|
|
16
|
+
export type { ListFeatureUsageHistoryRequest } from "./ListFeatureUsageHistoryRequest";
|
|
16
17
|
export type { ListFeatureUsageRequest } from "./ListFeatureUsageRequest";
|
|
17
18
|
export type { ListFeatureUsersRequest } from "./ListFeatureUsersRequest";
|
|
18
19
|
export type { ListPlanEntitlementsRequest } from "./ListPlanEntitlementsRequest";
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type * as Schematic from "../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* Input parameters
|
|
4
|
+
*/
|
|
5
|
+
export interface ListFeatureUsageHistoryParams {
|
|
6
|
+
/** Restrict to these company IDs; omit for every company in the environment */
|
|
7
|
+
companyIds?: string[];
|
|
8
|
+
/** Exclusive end of the window; must fall on an hour boundary */
|
|
9
|
+
endTime?: Date;
|
|
10
|
+
/** Restrict to these event features; omit for every event feature in the environment. Where several features measure the same event, each is reported separately and a page may carry more rows than the requested limit */
|
|
11
|
+
featureIds?: string[];
|
|
12
|
+
/** Bucket the window; omit for a single total per company and feature */
|
|
13
|
+
granularity?: Schematic.TimeSeriesGranularity;
|
|
14
|
+
/** Page limit (default 100) */
|
|
15
|
+
limit?: number;
|
|
16
|
+
/** Page offset (default 0) */
|
|
17
|
+
offset?: number;
|
|
18
|
+
/** Inclusive start of the window; must fall on an hour boundary */
|
|
19
|
+
startTime?: Date;
|
|
20
|
+
}
|
|
@@ -27,6 +27,8 @@ export * from "./ListCompanyOverridesParams";
|
|
|
27
27
|
export * from "./ListCompanyOverridesResponse";
|
|
28
28
|
export * from "./ListFeatureCompaniesParams";
|
|
29
29
|
export * from "./ListFeatureCompaniesResponse";
|
|
30
|
+
export * from "./ListFeatureUsageHistoryParams";
|
|
31
|
+
export * from "./ListFeatureUsageHistoryResponse";
|
|
30
32
|
export * from "./ListFeatureUsageParams";
|
|
31
33
|
export * from "./ListFeatureUsageResponse";
|
|
32
34
|
export * from "./ListFeatureUsersParams";
|
|
@@ -22,9 +22,18 @@ export declare class PlanbundleClient {
|
|
|
22
22
|
*
|
|
23
23
|
* @example
|
|
24
24
|
* await client.planbundle.createCustomPlanBundle({
|
|
25
|
+
* billingProduct: {
|
|
26
|
+
* chargeType: "free",
|
|
27
|
+
* isTrialable: true
|
|
28
|
+
* },
|
|
25
29
|
* entitlements: [{
|
|
26
30
|
* action: "create"
|
|
27
|
-
* }]
|
|
31
|
+
* }],
|
|
32
|
+
* plan: {
|
|
33
|
+
* companyId: "company_id",
|
|
34
|
+
* description: "description",
|
|
35
|
+
* name: "name"
|
|
36
|
+
* }
|
|
28
37
|
* })
|
|
29
38
|
*/
|
|
30
39
|
createCustomPlanBundle(request: Schematic.CreateCustomPlanBundleRequestBody, requestOptions?: PlanbundleClient.RequestOptions): core.HttpResponsePromise<Schematic.CreateCustomPlanBundleResponse>;
|
|
@@ -43,13 +52,18 @@ export declare class PlanbundleClient {
|
|
|
43
52
|
* await client.planbundle.createPlanBundle({
|
|
44
53
|
* entitlements: [{
|
|
45
54
|
* action: "create"
|
|
46
|
-
* }]
|
|
55
|
+
* }],
|
|
56
|
+
* plan: {
|
|
57
|
+
* description: "description",
|
|
58
|
+
* name: "name",
|
|
59
|
+
* planType: "plan"
|
|
60
|
+
* }
|
|
47
61
|
* })
|
|
48
62
|
*/
|
|
49
63
|
createPlanBundle(request: Schematic.CreatePlanBundleRequestBody, requestOptions?: PlanbundleClient.RequestOptions): core.HttpResponsePromise<Schematic.CreatePlanBundleResponse>;
|
|
50
64
|
private __createPlanBundle;
|
|
51
65
|
/**
|
|
52
|
-
* @param {string}
|
|
66
|
+
* @param {string} plan_id - plan_id
|
|
53
67
|
* @param {Schematic.UpdatePlanBundleRequestBody} request
|
|
54
68
|
* @param {PlanbundleClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
55
69
|
*
|
|
@@ -60,12 +74,15 @@ export declare class PlanbundleClient {
|
|
|
60
74
|
* @throws {@link Schematic.InternalServerError}
|
|
61
75
|
*
|
|
62
76
|
* @example
|
|
63
|
-
* await client.planbundle.updatePlanBundle("
|
|
77
|
+
* await client.planbundle.updatePlanBundle("plan_id", {
|
|
64
78
|
* entitlements: [{
|
|
65
79
|
* action: "create"
|
|
66
|
-
* }]
|
|
80
|
+
* }],
|
|
81
|
+
* plan: {
|
|
82
|
+
* name: "name"
|
|
83
|
+
* }
|
|
67
84
|
* })
|
|
68
85
|
*/
|
|
69
|
-
updatePlanBundle(
|
|
86
|
+
updatePlanBundle(plan_id: string, request: Schematic.UpdatePlanBundleRequestBody, requestOptions?: PlanbundleClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdatePlanBundleResponse>;
|
|
70
87
|
private __updatePlanBundle;
|
|
71
88
|
}
|