@schematichq/schematic-typescript-node 1.5.5 → 1.5.6
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/ListAccountMembersRequest.d.ts +4 -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/checkout/client/Client.d.ts +35 -0
- package/dist/api/resources/checkout/client/requests/UpdateCompanyBillingDetailsRequestBody.d.ts +16 -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/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/types/BillingCreditGrantZeroedOutReason.d.ts +1 -0
- 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 +8 -0
- package/dist/api/types/CompanyBillingDetailsView.d.ts +8 -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/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/PlanVersionMigrationPreviewCompanyResponseData.d.ts +8 -0
- package/dist/api/types/PlanVersionMigrationPreviewResponseData.d.ts +4 -0
- package/dist/api/types/WebhookRequestType.d.ts +2 -0
- package/dist/api/types/index.d.ts +12 -0
- package/dist/index.js +9 -9
- 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/checkout/client/requests/UpdateCompanyBillingDetailsRequestBody.d.ts +14 -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/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/types/BillingCreditGrantZeroedOutReason.d.ts +1 -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 +16 -0
- package/dist/serialization/types/CompanyBillingDetailsView.d.ts +16 -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/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/PlanVersionMigrationPreviewCompanyResponseData.d.ts +14 -0
- package/dist/serialization/types/PlanVersionMigrationPreviewResponseData.d.ts +10 -0
- package/dist/serialization/types/WebhookRequestType.d.ts +1 -1
- package/dist/serialization/types/index.d.ts +12 -0
- 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
|
}
|
|
@@ -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,16 @@
|
|
|
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
|
+
values: Schematic.CheckoutFieldValue[];
|
|
16
|
+
}
|
|
@@ -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";
|
|
@@ -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
|
+
}
|
|
@@ -162,4 +162,24 @@ export declare class PlanmigrationsClient {
|
|
|
162
162
|
*/
|
|
163
163
|
countMigrations(request?: Schematic.CountMigrationsRequest, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountMigrationsResponse>;
|
|
164
164
|
private __countMigrations;
|
|
165
|
+
/**
|
|
166
|
+
* @param {Schematic.PreviewMigrationRequestBody} request
|
|
167
|
+
* @param {PlanmigrationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
168
|
+
*
|
|
169
|
+
* @throws {@link Schematic.BadRequestError}
|
|
170
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
171
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
172
|
+
* @throws {@link Schematic.NotFoundError}
|
|
173
|
+
* @throws {@link Schematic.InternalServerError}
|
|
174
|
+
*
|
|
175
|
+
* @example
|
|
176
|
+
* await client.planmigrations.previewMigration({
|
|
177
|
+
* companyIds: ["company_ids"],
|
|
178
|
+
* planId: "plan_id",
|
|
179
|
+
* planVersionIdTo: "plan_version_id_to",
|
|
180
|
+
* targetPlanType: "plan"
|
|
181
|
+
* })
|
|
182
|
+
*/
|
|
183
|
+
previewMigration(request: Schematic.PreviewMigrationRequestBody, requestOptions?: PlanmigrationsClient.RequestOptions): core.HttpResponsePromise<Schematic.PreviewMigrationResponse>;
|
|
184
|
+
private __previewMigration;
|
|
165
185
|
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* companyIds: ["company_ids"],
|
|
6
|
+
* planId: "plan_id",
|
|
7
|
+
* planVersionIdTo: "plan_version_id_to",
|
|
8
|
+
* targetPlanType: "plan"
|
|
9
|
+
* }
|
|
10
|
+
*/
|
|
11
|
+
export interface PreviewMigrationRequestBody {
|
|
12
|
+
companyIds: string[];
|
|
13
|
+
planId: string;
|
|
14
|
+
planVersionIdTo: string;
|
|
15
|
+
targetPlanType: Schematic.PlanType;
|
|
16
|
+
}
|
|
@@ -3,4 +3,5 @@ export type { CountMigrationsRequest } from "./CountMigrationsRequest";
|
|
|
3
3
|
export type { CreateMigrationInput } from "./CreateMigrationInput";
|
|
4
4
|
export type { ListCompanyMigrationsRequest } from "./ListCompanyMigrationsRequest";
|
|
5
5
|
export type { ListMigrationsRequest } from "./ListMigrationsRequest";
|
|
6
|
+
export type { PreviewMigrationRequestBody } from "./PreviewMigrationRequestBody";
|
|
6
7
|
export type { RetryMigrationRequestBody } from "./RetryMigrationRequestBody";
|
|
@@ -8,5 +8,6 @@ export * from "./ListCompanyMigrationsParams";
|
|
|
8
8
|
export * from "./ListCompanyMigrationsResponse";
|
|
9
9
|
export * from "./ListMigrationsParams";
|
|
10
10
|
export * from "./ListMigrationsResponse";
|
|
11
|
+
export * from "./PreviewMigrationResponse";
|
|
11
12
|
export * from "./RetryCompanyMigrationResponse";
|
|
12
13
|
export * from "./RetryMigrationResponse";
|
|
@@ -2,6 +2,7 @@ export declare const BillingCreditGrantZeroedOutReason: {
|
|
|
2
2
|
readonly CustomerArchived: "customer_archived";
|
|
3
3
|
readonly Expired: "expired";
|
|
4
4
|
readonly IntegrationUninstalled: "integration_uninstalled";
|
|
5
|
+
readonly LicenseRetired: "license_retired";
|
|
5
6
|
readonly Manual: "manual";
|
|
6
7
|
readonly PlanChange: "plan_change";
|
|
7
8
|
readonly PlanPeriodReset: "plan_period_reset";
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type * as Schematic from "../index";
|
|
2
|
+
export interface CompanyBillingDetailsResponseData {
|
|
3
|
+
address?: Schematic.CompanyBillingAddressView;
|
|
4
|
+
checkoutSettings: Schematic.CompanyBillingCheckoutSettings;
|
|
5
|
+
customFields: Schematic.CheckoutFieldWithValue[];
|
|
6
|
+
email?: string;
|
|
7
|
+
phone?: string;
|
|
8
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type * as Schematic from "../index";
|
|
2
|
+
export interface CompanyBillingDetailsView {
|
|
3
|
+
address?: Schematic.CompanyBillingAddressView;
|
|
4
|
+
checkoutSettings: Schematic.CompanyBillingCheckoutSettings;
|
|
5
|
+
customFields: Schematic.CheckoutFieldWithValue[];
|
|
6
|
+
email?: string;
|
|
7
|
+
phone?: string;
|
|
8
|
+
}
|
|
@@ -31,6 +31,7 @@ export interface CreateEntitlementInBundleRequestBody {
|
|
|
31
31
|
valueNumeric?: number;
|
|
32
32
|
valueTraitId?: string;
|
|
33
33
|
valueType: Schematic.EntitlementValueType;
|
|
34
|
+
warningTiers?: Schematic.WarningTierRequestBody[];
|
|
34
35
|
yearlyMeteredPriceId?: string;
|
|
35
36
|
yearlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
|
|
36
37
|
yearlyUnitPrice?: number;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type * as Schematic from "../index";
|
|
2
|
+
export interface CreditsCreditPurchaseSuccess {
|
|
3
|
+
bundleId: string;
|
|
4
|
+
bundleName: string;
|
|
5
|
+
company?: Schematic.CreditsWebhookCompanySummary;
|
|
6
|
+
credit?: Schematic.CreditsWebhookCreditSummary;
|
|
7
|
+
grantIds: string[];
|
|
8
|
+
quantity: number;
|
|
9
|
+
}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import type * as Schematic from "../index";
|
|
2
2
|
export interface FeatureDetailResponseData {
|
|
3
3
|
billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
|
|
4
|
+
/** The billing provider product that sells this feature in the current environment. Set for license features once they have been priced in a plan; a feature priced in several environments has a different product in each. */
|
|
5
|
+
billingProduct?: Schematic.BillingProductResponseData;
|
|
4
6
|
createdAt: Date;
|
|
5
7
|
description: string;
|
|
6
8
|
eventSubtype?: string;
|
|
@@ -9,6 +11,8 @@ export interface FeatureDetailResponseData {
|
|
|
9
11
|
flags: Schematic.FlagDetailResponseData[];
|
|
10
12
|
icon: string;
|
|
11
13
|
id: string;
|
|
14
|
+
/** The license sold through this feature. Set only on features of type license, and created automatically with them. */
|
|
15
|
+
licenseId?: string;
|
|
12
16
|
lifecyclePhase?: Schematic.FeatureLifecyclePhase;
|
|
13
17
|
maintainer?: Schematic.AccountMemberResponseData;
|
|
14
18
|
maintainerAccountMemberId?: string;
|
|
@@ -19,4 +23,6 @@ export interface FeatureDetailResponseData {
|
|
|
19
23
|
trait?: Schematic.EntityTraitDefinitionResponseData;
|
|
20
24
|
traitId?: string;
|
|
21
25
|
updatedAt: Date;
|
|
26
|
+
/** Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features. */
|
|
27
|
+
usageLimitTraitId?: string;
|
|
22
28
|
}
|
|
@@ -9,6 +9,8 @@ export interface FeatureInPlanResponseData {
|
|
|
9
9
|
flags: Schematic.FlagInPlanResponseData[];
|
|
10
10
|
icon: string;
|
|
11
11
|
id: string;
|
|
12
|
+
/** The license sold through this feature. Set only on features of type license, and created automatically with them. */
|
|
13
|
+
licenseId?: string;
|
|
12
14
|
lifecyclePhase?: Schematic.FeatureLifecyclePhase;
|
|
13
15
|
maintainerAccountMemberId?: string;
|
|
14
16
|
name: string;
|
|
@@ -18,4 +20,6 @@ export interface FeatureInPlanResponseData {
|
|
|
18
20
|
trait?: Schematic.EntityTraitDefinitionResponseData;
|
|
19
21
|
traitId?: string;
|
|
20
22
|
updatedAt: Date;
|
|
23
|
+
/** Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features. */
|
|
24
|
+
usageLimitTraitId?: string;
|
|
21
25
|
}
|
|
@@ -6,6 +6,8 @@ export interface FeatureResponseData {
|
|
|
6
6
|
featureType: Schematic.FeatureType;
|
|
7
7
|
icon: string;
|
|
8
8
|
id: string;
|
|
9
|
+
/** The license sold through this feature. Set only on features of type license, and created automatically with them. */
|
|
10
|
+
licenseId?: string;
|
|
9
11
|
lifecyclePhase?: Schematic.FeatureLifecyclePhase;
|
|
10
12
|
maintainerAccountMemberId?: string;
|
|
11
13
|
name: string;
|
|
@@ -13,4 +15,6 @@ export interface FeatureResponseData {
|
|
|
13
15
|
singularName?: string;
|
|
14
16
|
traitId?: string;
|
|
15
17
|
updatedAt: Date;
|
|
18
|
+
/** Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features. */
|
|
19
|
+
usageLimitTraitId?: string;
|
|
16
20
|
}
|
|
@@ -2,6 +2,7 @@ import type * as Schematic from "../index";
|
|
|
2
2
|
export interface FeatureView {
|
|
3
3
|
accountId: string;
|
|
4
4
|
billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
|
|
5
|
+
billingProduct?: Schematic.BillingProductResponseData;
|
|
5
6
|
createdAt: Date;
|
|
6
7
|
description: string;
|
|
7
8
|
eventSubtype?: string;
|
|
@@ -10,6 +11,7 @@ export interface FeatureView {
|
|
|
10
11
|
flags: Schematic.FlagView[];
|
|
11
12
|
icon: string;
|
|
12
13
|
id: string;
|
|
14
|
+
licenseId?: string;
|
|
13
15
|
lifecyclePhase?: Schematic.FeatureLifecyclePhase;
|
|
14
16
|
name: string;
|
|
15
17
|
plans: Schematic.PreviewObject[];
|