@schematichq/schematic-typescript-node 1.5.4 → 1.5.5
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/catalogs/client/Client.d.ts +232 -0
- package/dist/api/resources/catalogs/client/index.d.ts +1 -0
- package/dist/api/resources/catalogs/client/requests/CreateCatalogRequestBody.d.ts +12 -0
- package/dist/api/resources/catalogs/client/requests/ListCatalogsRequest.d.ts +18 -0
- package/dist/api/resources/catalogs/client/requests/UpdateCatalogConfigurationRequestBody.d.ts +16 -0
- package/dist/api/resources/catalogs/client/requests/UpdateCatalogRequestBody.d.ts +9 -0
- package/dist/api/resources/catalogs/client/requests/index.d.ts +4 -0
- package/dist/api/resources/catalogs/exports.d.ts +2 -0
- package/dist/api/resources/catalogs/index.d.ts +2 -0
- package/dist/api/resources/catalogs/types/CreateCatalogResponse.d.ts +6 -0
- package/dist/api/resources/catalogs/types/DeleteCatalogResponse.d.ts +6 -0
- package/dist/api/resources/catalogs/types/GetCatalogResponse.d.ts +6 -0
- package/dist/api/resources/catalogs/types/GetConfigurationResponse.d.ts +6 -0
- package/dist/api/resources/catalogs/types/GetCreditBundlesInCatalogResponse.d.ts +6 -0
- package/dist/api/resources/catalogs/types/GetDerivedFeaturesResponse.d.ts +6 -0
- package/dist/api/resources/catalogs/types/GetPlansInCatalogResponse.d.ts +6 -0
- package/dist/api/resources/catalogs/types/ListCatalogsParams.d.ts +12 -0
- package/dist/api/resources/catalogs/types/ListCatalogsResponse.d.ts +6 -0
- package/dist/api/resources/catalogs/types/UpdateCatalogResponse.d.ts +6 -0
- package/dist/api/resources/catalogs/types/UpdateConfigurationResponse.d.ts +6 -0
- package/dist/api/resources/catalogs/types/index.d.ts +11 -0
- package/dist/api/resources/components/client/Client.d.ts +16 -0
- package/dist/api/resources/components/client/requests/BindCatalogRequestBody.d.ts +7 -0
- package/dist/api/resources/components/client/requests/index.d.ts +1 -0
- package/dist/api/resources/components/types/BindCatalogResponse.d.ts +6 -0
- package/dist/api/resources/components/types/index.d.ts +1 -0
- package/dist/api/resources/dataexports/client/Client.d.ts +36 -1
- package/dist/api/resources/dataexports/client/requests/CreateDataExportRequestBody.d.ts +6 -2
- package/dist/api/resources/dataexports/client/requests/ListDataExportsRequest.d.ts +18 -0
- package/dist/api/resources/dataexports/client/requests/index.d.ts +1 -0
- package/dist/api/resources/dataexports/types/GetDataExportResponse.d.ts +6 -0
- package/dist/api/resources/dataexports/types/ListDataExportsParams.d.ts +12 -0
- package/dist/api/resources/dataexports/types/ListDataExportsResponse.d.ts +6 -0
- package/dist/api/resources/dataexports/types/index.d.ts +3 -0
- package/dist/api/resources/index.d.ts +3 -0
- package/dist/api/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +1 -0
- package/dist/api/types/AuditLogExportMetadata.d.ts +12 -0
- package/dist/api/types/CatalogConfigOrderedBundle.d.ts +3 -0
- package/dist/api/types/CatalogConfigOrderedBundleResponseData.d.ts +3 -0
- package/dist/api/types/CatalogConfigOrderedEntitlement.d.ts +4 -0
- package/dist/api/types/CatalogConfigOrderedEntitlementResponseData.d.ts +4 -0
- package/dist/api/types/CatalogConfigOrderedPlan.d.ts +5 -0
- package/dist/api/types/CatalogConfigOrderedPlanResponseData.d.ts +5 -0
- package/dist/api/types/CatalogConfigurationResponseData.d.ts +14 -0
- package/dist/api/types/CatalogCreditBundleIDsResponseData.d.ts +3 -0
- package/dist/api/types/CatalogDerivedFeatureResponseData.d.ts +5 -0
- package/dist/api/types/CatalogDerivedFeaturesResponseData.d.ts +4 -0
- package/dist/api/types/CatalogPlanIDsResponseData.d.ts +3 -0
- package/dist/api/types/CatalogResponseData.d.ts +16 -0
- package/dist/api/types/CompanyFeatureUsageExportMetadata.d.ts +36 -0
- package/dist/api/types/CompanyPlanDetailResponseData.d.ts +1 -0
- package/dist/api/types/ComponentResponseData.d.ts +1 -0
- package/dist/api/types/DataExportMetadata.d.ts +10 -0
- package/dist/api/types/DataExportOutputFileType.d.ts +5 -1
- package/dist/api/types/DataExportResponseData.d.ts +1 -1
- package/dist/api/types/DataExportType.d.ts +5 -1
- package/dist/api/types/FeatureEntitlement.d.ts +2 -0
- package/dist/api/types/PlanCatalogMembershipResponseData.d.ts +4 -0
- package/dist/api/types/PlanDetailResponseData.d.ts +1 -0
- package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts +1 -0
- package/dist/api/types/PlanViewPublicResponseData.d.ts +1 -0
- package/dist/api/types/PreviewSubscriptionDiscountResponseData.d.ts +13 -0
- package/dist/api/types/PreviewSubscriptionFinanceResponseData.d.ts +2 -0
- package/dist/api/types/RulesengineFeatureEntitlement.d.ts +2 -0
- package/dist/api/types/RulesengineWarningTier.d.ts +6 -0
- package/dist/api/types/UpsertCompanyRequestBody.d.ts +4 -0
- package/dist/api/types/WarningTier.d.ts +6 -0
- package/dist/api/types/index.d.ts +19 -0
- package/dist/index.js +9 -9
- package/dist/serialization/resources/catalogs/client/index.d.ts +1 -0
- package/dist/serialization/resources/catalogs/client/requests/CreateCatalogRequestBody.d.ts +11 -0
- package/dist/serialization/resources/catalogs/client/requests/UpdateCatalogConfigurationRequestBody.d.ts +19 -0
- package/dist/serialization/resources/catalogs/client/requests/UpdateCatalogRequestBody.d.ts +11 -0
- package/dist/serialization/resources/catalogs/client/requests/index.d.ts +3 -0
- package/dist/serialization/resources/catalogs/index.d.ts +2 -0
- package/dist/serialization/resources/catalogs/types/CreateCatalogResponse.d.ts +11 -0
- package/dist/serialization/resources/catalogs/types/DeleteCatalogResponse.d.ts +11 -0
- package/dist/serialization/resources/catalogs/types/GetCatalogResponse.d.ts +11 -0
- package/dist/serialization/resources/catalogs/types/GetConfigurationResponse.d.ts +11 -0
- package/dist/serialization/resources/catalogs/types/GetCreditBundlesInCatalogResponse.d.ts +11 -0
- package/dist/serialization/resources/catalogs/types/GetDerivedFeaturesResponse.d.ts +11 -0
- package/dist/serialization/resources/catalogs/types/GetPlansInCatalogResponse.d.ts +11 -0
- package/dist/serialization/resources/catalogs/types/ListCatalogsParams.d.ts +12 -0
- package/dist/serialization/resources/catalogs/types/ListCatalogsResponse.d.ts +12 -0
- package/dist/serialization/resources/catalogs/types/UpdateCatalogResponse.d.ts +11 -0
- package/dist/serialization/resources/catalogs/types/UpdateConfigurationResponse.d.ts +11 -0
- package/dist/serialization/resources/catalogs/types/index.d.ts +11 -0
- package/dist/serialization/resources/components/client/requests/BindCatalogRequestBody.d.ts +9 -0
- package/dist/serialization/resources/components/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/components/types/BindCatalogResponse.d.ts +11 -0
- package/dist/serialization/resources/components/types/index.d.ts +1 -0
- package/dist/serialization/resources/dataexports/client/requests/CreateDataExportRequestBody.d.ts +6 -1
- package/dist/serialization/resources/dataexports/types/GetDataExportResponse.d.ts +11 -0
- package/dist/serialization/resources/dataexports/types/ListDataExportsParams.d.ts +14 -0
- package/dist/serialization/resources/dataexports/types/ListDataExportsResponse.d.ts +12 -0
- package/dist/serialization/resources/dataexports/types/index.d.ts +3 -0
- package/dist/serialization/resources/index.d.ts +3 -0
- package/dist/serialization/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +2 -0
- package/dist/serialization/types/AuditLogExportMetadata.d.ts +13 -0
- package/dist/serialization/types/CatalogConfigOrderedBundle.d.ts +9 -0
- package/dist/serialization/types/CatalogConfigOrderedBundleResponseData.d.ts +9 -0
- package/dist/serialization/types/CatalogConfigOrderedEntitlement.d.ts +10 -0
- package/dist/serialization/types/CatalogConfigOrderedEntitlementResponseData.d.ts +10 -0
- package/dist/serialization/types/CatalogConfigOrderedPlan.d.ts +11 -0
- package/dist/serialization/types/CatalogConfigOrderedPlanResponseData.d.ts +11 -0
- package/dist/serialization/types/CatalogConfigurationResponseData.d.ts +22 -0
- package/dist/serialization/types/CatalogCreditBundleIDsResponseData.d.ts +9 -0
- package/dist/serialization/types/CatalogDerivedFeatureResponseData.d.ts +11 -0
- package/dist/serialization/types/CatalogDerivedFeaturesResponseData.d.ts +10 -0
- package/dist/serialization/types/CatalogPlanIDsResponseData.d.ts +9 -0
- package/dist/serialization/types/CatalogResponseData.d.ts +22 -0
- package/dist/serialization/types/CompanyFeatureUsageExportMetadata.d.ts +25 -0
- package/dist/serialization/types/CompanyPlanDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/ComponentResponseData.d.ts +1 -0
- package/dist/serialization/types/DataExportMetadata.d.ts +15 -0
- package/dist/serialization/types/DataExportOutputFileType.d.ts +1 -1
- package/dist/serialization/types/DataExportResponseData.d.ts +2 -1
- package/dist/serialization/types/DataExportType.d.ts +1 -1
- package/dist/serialization/types/FeatureEntitlement.d.ts +2 -0
- package/dist/serialization/types/PlanCatalogMembershipResponseData.d.ts +10 -0
- package/dist/serialization/types/PlanDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/PlanGroupPlanDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/PlanViewPublicResponseData.d.ts +2 -0
- package/dist/serialization/types/PreviewSubscriptionDiscountResponseData.d.ts +19 -0
- package/dist/serialization/types/PreviewSubscriptionFinanceResponseData.d.ts +3 -0
- package/dist/serialization/types/RulesengineFeatureEntitlement.d.ts +2 -0
- package/dist/serialization/types/RulesengineWarningTier.d.ts +10 -0
- package/dist/serialization/types/UpsertCompanyRequestBody.d.ts +2 -0
- package/dist/serialization/types/WarningTier.d.ts +10 -0
- package/dist/serialization/types/index.d.ts +19 -0
- package/package.json +1 -1
package/dist/Client.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { AccesstokensClient } from "./api/resources/accesstokens/client/Client";
|
|
2
2
|
import { AccountsClient } from "./api/resources/accounts/client/Client";
|
|
3
3
|
import { BillingClient } from "./api/resources/billing/client/Client";
|
|
4
|
+
import { CatalogsClient } from "./api/resources/catalogs/client/Client";
|
|
4
5
|
import { CheckoutClient } from "./api/resources/checkout/client/Client";
|
|
5
6
|
import { CompaniesClient } from "./api/resources/companies/client/Client";
|
|
6
7
|
import { ComponentsClient } from "./api/resources/components/client/Client";
|
|
@@ -31,6 +32,7 @@ export declare class SchematicClient {
|
|
|
31
32
|
protected _accounts: AccountsClient | undefined;
|
|
32
33
|
protected _billing: BillingClient | undefined;
|
|
33
34
|
protected _credits: CreditsClient | undefined;
|
|
35
|
+
protected _catalogs: CatalogsClient | undefined;
|
|
34
36
|
protected _checkout: CheckoutClient | undefined;
|
|
35
37
|
protected _companies: CompaniesClient | undefined;
|
|
36
38
|
protected _entitlements: EntitlementsClient | undefined;
|
|
@@ -52,6 +54,7 @@ export declare class SchematicClient {
|
|
|
52
54
|
get accounts(): AccountsClient;
|
|
53
55
|
get billing(): BillingClient;
|
|
54
56
|
get credits(): CreditsClient;
|
|
57
|
+
get catalogs(): CatalogsClient;
|
|
55
58
|
get checkout(): CheckoutClient;
|
|
56
59
|
get companies(): CompaniesClient;
|
|
57
60
|
get entitlements(): EntitlementsClient;
|
|
@@ -0,0 +1,232 @@
|
|
|
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 CatalogsClient {
|
|
6
|
+
type Options = BaseClientOptions;
|
|
7
|
+
interface RequestOptions extends BaseRequestOptions {
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
export declare class CatalogsClient {
|
|
11
|
+
protected readonly _options: NormalizedClientOptionsWithAuth<CatalogsClient.Options>;
|
|
12
|
+
constructor(options: CatalogsClient.Options);
|
|
13
|
+
/**
|
|
14
|
+
* @param {Schematic.ListCatalogsRequest} request
|
|
15
|
+
* @param {CatalogsClient.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.catalogs.listCatalogs({
|
|
25
|
+
* isDefault: true,
|
|
26
|
+
* q: "q",
|
|
27
|
+
* limit: 1000000,
|
|
28
|
+
* offset: 1000000
|
|
29
|
+
* })
|
|
30
|
+
*/
|
|
31
|
+
listCatalogs(request?: Schematic.ListCatalogsRequest, requestOptions?: CatalogsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCatalogsResponse>;
|
|
32
|
+
private __listCatalogs;
|
|
33
|
+
/**
|
|
34
|
+
* @param {Schematic.CreateCatalogRequestBody} request
|
|
35
|
+
* @param {CatalogsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link Schematic.BadRequestError}
|
|
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.catalogs.createCatalog({
|
|
45
|
+
* isDefault: true,
|
|
46
|
+
* name: "name"
|
|
47
|
+
* })
|
|
48
|
+
*/
|
|
49
|
+
createCatalog(request: Schematic.CreateCatalogRequestBody, requestOptions?: CatalogsClient.RequestOptions): core.HttpResponsePromise<Schematic.CreateCatalogResponse>;
|
|
50
|
+
private __createCatalog;
|
|
51
|
+
/**
|
|
52
|
+
* @param {string} catalog_id - catalog_id
|
|
53
|
+
* @param {CatalogsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
56
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
57
|
+
* @throws {@link Schematic.NotFoundError}
|
|
58
|
+
* @throws {@link Schematic.InternalServerError}
|
|
59
|
+
*
|
|
60
|
+
* @example
|
|
61
|
+
* await client.catalogs.getCatalog("catalog_id")
|
|
62
|
+
*/
|
|
63
|
+
getCatalog(catalog_id: string, requestOptions?: CatalogsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetCatalogResponse>;
|
|
64
|
+
private __getCatalog;
|
|
65
|
+
/**
|
|
66
|
+
* @param {string} catalog_id - catalog_id
|
|
67
|
+
* @param {Schematic.UpdateCatalogRequestBody} request
|
|
68
|
+
* @param {CatalogsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link Schematic.BadRequestError}
|
|
71
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
72
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
73
|
+
* @throws {@link Schematic.NotFoundError}
|
|
74
|
+
* @throws {@link Schematic.InternalServerError}
|
|
75
|
+
*
|
|
76
|
+
* @example
|
|
77
|
+
* await client.catalogs.updateCatalog("catalog_id")
|
|
78
|
+
*/
|
|
79
|
+
updateCatalog(catalog_id: string, request?: Schematic.UpdateCatalogRequestBody, requestOptions?: CatalogsClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdateCatalogResponse>;
|
|
80
|
+
private __updateCatalog;
|
|
81
|
+
/**
|
|
82
|
+
* @param {string} catalog_id - catalog_id
|
|
83
|
+
* @param {CatalogsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link Schematic.BadRequestError}
|
|
86
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
87
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
88
|
+
* @throws {@link Schematic.NotFoundError}
|
|
89
|
+
* @throws {@link Schematic.InternalServerError}
|
|
90
|
+
*
|
|
91
|
+
* @example
|
|
92
|
+
* await client.catalogs.deleteCatalog("catalog_id")
|
|
93
|
+
*/
|
|
94
|
+
deleteCatalog(catalog_id: string, requestOptions?: CatalogsClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteCatalogResponse>;
|
|
95
|
+
private __deleteCatalog;
|
|
96
|
+
/**
|
|
97
|
+
* @param {string} catalog_id - catalog_id
|
|
98
|
+
* @param {CatalogsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
101
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
102
|
+
* @throws {@link Schematic.NotFoundError}
|
|
103
|
+
* @throws {@link Schematic.InternalServerError}
|
|
104
|
+
*
|
|
105
|
+
* @example
|
|
106
|
+
* await client.catalogs.getConfiguration("catalog_id")
|
|
107
|
+
*/
|
|
108
|
+
getConfiguration(catalog_id: string, requestOptions?: CatalogsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetConfigurationResponse>;
|
|
109
|
+
private __getConfiguration;
|
|
110
|
+
/**
|
|
111
|
+
* @param {string} catalog_id - catalog_id
|
|
112
|
+
* @param {Schematic.UpdateCatalogConfigurationRequestBody} request
|
|
113
|
+
* @param {CatalogsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
114
|
+
*
|
|
115
|
+
* @throws {@link Schematic.BadRequestError}
|
|
116
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
117
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
118
|
+
* @throws {@link Schematic.NotFoundError}
|
|
119
|
+
* @throws {@link Schematic.InternalServerError}
|
|
120
|
+
*
|
|
121
|
+
* @example
|
|
122
|
+
* await client.catalogs.updateConfiguration("catalog_id")
|
|
123
|
+
*/
|
|
124
|
+
updateConfiguration(catalog_id: string, request?: Schematic.UpdateCatalogConfigurationRequestBody, requestOptions?: CatalogsClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdateConfigurationResponse>;
|
|
125
|
+
private __updateConfiguration;
|
|
126
|
+
/**
|
|
127
|
+
* @param {string} catalog_id - catalog_id
|
|
128
|
+
* @param {CatalogsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
131
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
132
|
+
* @throws {@link Schematic.NotFoundError}
|
|
133
|
+
* @throws {@link Schematic.InternalServerError}
|
|
134
|
+
*
|
|
135
|
+
* @example
|
|
136
|
+
* await client.catalogs.getCreditBundlesInCatalog("catalog_id")
|
|
137
|
+
*/
|
|
138
|
+
getCreditBundlesInCatalog(catalog_id: string, requestOptions?: CatalogsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetCreditBundlesInCatalogResponse>;
|
|
139
|
+
private __getCreditBundlesInCatalog;
|
|
140
|
+
/**
|
|
141
|
+
* @param {string} catalog_id - catalog_id
|
|
142
|
+
* @param {string} credit_bundle_id - credit_bundle_id
|
|
143
|
+
* @param {CatalogsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
144
|
+
*
|
|
145
|
+
* @throws {@link Schematic.BadRequestError}
|
|
146
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
147
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
148
|
+
* @throws {@link Schematic.NotFoundError}
|
|
149
|
+
* @throws {@link Schematic.InternalServerError}
|
|
150
|
+
*
|
|
151
|
+
* @example
|
|
152
|
+
* await client.catalogs.addCreditBundle("catalog_id", "credit_bundle_id")
|
|
153
|
+
*/
|
|
154
|
+
addCreditBundle(catalog_id: string, credit_bundle_id: string, requestOptions?: CatalogsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
155
|
+
private __addCreditBundle;
|
|
156
|
+
/**
|
|
157
|
+
* @param {string} catalog_id - catalog_id
|
|
158
|
+
* @param {string} credit_bundle_id - credit_bundle_id
|
|
159
|
+
* @param {CatalogsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
160
|
+
*
|
|
161
|
+
* @throws {@link Schematic.BadRequestError}
|
|
162
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
163
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
164
|
+
* @throws {@link Schematic.NotFoundError}
|
|
165
|
+
* @throws {@link Schematic.InternalServerError}
|
|
166
|
+
*
|
|
167
|
+
* @example
|
|
168
|
+
* await client.catalogs.removeCreditBundle("catalog_id", "credit_bundle_id")
|
|
169
|
+
*/
|
|
170
|
+
removeCreditBundle(catalog_id: string, credit_bundle_id: string, requestOptions?: CatalogsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
171
|
+
private __removeCreditBundle;
|
|
172
|
+
/**
|
|
173
|
+
* @param {string} catalog_id - catalog_id
|
|
174
|
+
* @param {CatalogsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
175
|
+
*
|
|
176
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
177
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
178
|
+
* @throws {@link Schematic.NotFoundError}
|
|
179
|
+
* @throws {@link Schematic.InternalServerError}
|
|
180
|
+
*
|
|
181
|
+
* @example
|
|
182
|
+
* await client.catalogs.getDerivedFeatures("catalog_id")
|
|
183
|
+
*/
|
|
184
|
+
getDerivedFeatures(catalog_id: string, requestOptions?: CatalogsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetDerivedFeaturesResponse>;
|
|
185
|
+
private __getDerivedFeatures;
|
|
186
|
+
/**
|
|
187
|
+
* @param {string} catalog_id - catalog_id
|
|
188
|
+
* @param {CatalogsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
189
|
+
*
|
|
190
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
191
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
192
|
+
* @throws {@link Schematic.NotFoundError}
|
|
193
|
+
* @throws {@link Schematic.InternalServerError}
|
|
194
|
+
*
|
|
195
|
+
* @example
|
|
196
|
+
* await client.catalogs.getPlansInCatalog("catalog_id")
|
|
197
|
+
*/
|
|
198
|
+
getPlansInCatalog(catalog_id: string, requestOptions?: CatalogsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetPlansInCatalogResponse>;
|
|
199
|
+
private __getPlansInCatalog;
|
|
200
|
+
/**
|
|
201
|
+
* @param {string} catalog_id - catalog_id
|
|
202
|
+
* @param {string} plan_id - plan_id
|
|
203
|
+
* @param {CatalogsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
204
|
+
*
|
|
205
|
+
* @throws {@link Schematic.BadRequestError}
|
|
206
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
207
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
208
|
+
* @throws {@link Schematic.NotFoundError}
|
|
209
|
+
* @throws {@link Schematic.InternalServerError}
|
|
210
|
+
*
|
|
211
|
+
* @example
|
|
212
|
+
* await client.catalogs.addPlan("catalog_id", "plan_id")
|
|
213
|
+
*/
|
|
214
|
+
addPlan(catalog_id: string, plan_id: string, requestOptions?: CatalogsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
215
|
+
private __addPlan;
|
|
216
|
+
/**
|
|
217
|
+
* @param {string} catalog_id - catalog_id
|
|
218
|
+
* @param {string} plan_id - plan_id
|
|
219
|
+
* @param {CatalogsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
220
|
+
*
|
|
221
|
+
* @throws {@link Schematic.BadRequestError}
|
|
222
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
223
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
224
|
+
* @throws {@link Schematic.NotFoundError}
|
|
225
|
+
* @throws {@link Schematic.InternalServerError}
|
|
226
|
+
*
|
|
227
|
+
* @example
|
|
228
|
+
* await client.catalogs.removePlan("catalog_id", "plan_id")
|
|
229
|
+
*/
|
|
230
|
+
removePlan(catalog_id: string, plan_id: string, requestOptions?: CatalogsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
231
|
+
private __removePlan;
|
|
232
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./requests";
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* isDefault: true,
|
|
5
|
+
* q: "q",
|
|
6
|
+
* limit: 1000000,
|
|
7
|
+
* offset: 1000000
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface ListCatalogsRequest {
|
|
11
|
+
isDefault?: boolean;
|
|
12
|
+
/** Search by catalog name */
|
|
13
|
+
q?: string;
|
|
14
|
+
/** Page limit (default 100) */
|
|
15
|
+
limit?: number;
|
|
16
|
+
/** Page offset (default 0) */
|
|
17
|
+
offset?: number;
|
|
18
|
+
}
|
package/dist/api/resources/catalogs/client/requests/UpdateCatalogConfigurationRequestBody.d.ts
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {}
|
|
5
|
+
*/
|
|
6
|
+
export interface UpdateCatalogConfigurationRequestBody {
|
|
7
|
+
customPlanCtaText?: string;
|
|
8
|
+
customPlanCtaUrl?: string;
|
|
9
|
+
customPlanPriceText?: string;
|
|
10
|
+
customPlansVisible?: boolean;
|
|
11
|
+
orderedAddOns?: Schematic.CatalogConfigOrderedPlan[];
|
|
12
|
+
orderedBundles?: Schematic.CatalogConfigOrderedBundle[];
|
|
13
|
+
orderedPlans?: Schematic.CatalogConfigOrderedPlan[];
|
|
14
|
+
pricingModel?: string;
|
|
15
|
+
pricingUrl?: string;
|
|
16
|
+
}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export type { CreateCatalogRequestBody } from "./CreateCatalogRequestBody";
|
|
2
|
+
export type { ListCatalogsRequest } from "./ListCatalogsRequest";
|
|
3
|
+
export type { UpdateCatalogConfigurationRequestBody } from "./UpdateCatalogConfigurationRequestBody";
|
|
4
|
+
export type { UpdateCatalogRequestBody } from "./UpdateCatalogRequestBody";
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
export * from "./CreateCatalogResponse";
|
|
2
|
+
export * from "./DeleteCatalogResponse";
|
|
3
|
+
export * from "./GetCatalogResponse";
|
|
4
|
+
export * from "./GetConfigurationResponse";
|
|
5
|
+
export * from "./GetCreditBundlesInCatalogResponse";
|
|
6
|
+
export * from "./GetDerivedFeaturesResponse";
|
|
7
|
+
export * from "./GetPlansInCatalogResponse";
|
|
8
|
+
export * from "./ListCatalogsParams";
|
|
9
|
+
export * from "./ListCatalogsResponse";
|
|
10
|
+
export * from "./UpdateCatalogResponse";
|
|
11
|
+
export * from "./UpdateConfigurationResponse";
|
|
@@ -92,6 +92,22 @@ export declare class ComponentsClient {
|
|
|
92
92
|
*/
|
|
93
93
|
deleteComponent(component_id: string, requestOptions?: ComponentsClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteComponentResponse>;
|
|
94
94
|
private __deleteComponent;
|
|
95
|
+
/**
|
|
96
|
+
* @param {string} component_id - component_id
|
|
97
|
+
* @param {Schematic.BindCatalogRequestBody} request
|
|
98
|
+
* @param {ComponentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link Schematic.BadRequestError}
|
|
101
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
102
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
103
|
+
* @throws {@link Schematic.NotFoundError}
|
|
104
|
+
* @throws {@link Schematic.InternalServerError}
|
|
105
|
+
*
|
|
106
|
+
* @example
|
|
107
|
+
* await client.components.bindCatalog("component_id")
|
|
108
|
+
*/
|
|
109
|
+
bindCatalog(component_id: string, request?: Schematic.BindCatalogRequestBody, requestOptions?: ComponentsClient.RequestOptions): core.HttpResponsePromise<Schematic.BindCatalogResponse>;
|
|
110
|
+
private __bindCatalog;
|
|
95
111
|
/**
|
|
96
112
|
* @param {Schematic.CountComponentsRequest} request
|
|
97
113
|
* @param {ComponentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
export type { BindCatalogRequestBody } from "./BindCatalogRequestBody";
|
|
1
2
|
export type { CountComponentsRequest } from "./CountComponentsRequest";
|
|
2
3
|
export type { CreateComponentRequestBody } from "./CreateComponentRequestBody";
|
|
3
4
|
export type { ListComponentsRequest } from "./ListComponentsRequest";
|
|
@@ -11,6 +11,26 @@ export declare namespace DataexportsClient {
|
|
|
11
11
|
export declare class DataexportsClient {
|
|
12
12
|
protected readonly _options: NormalizedClientOptionsWithAuth<DataexportsClient.Options>;
|
|
13
13
|
constructor(options: DataexportsClient.Options);
|
|
14
|
+
/**
|
|
15
|
+
* @param {Schematic.ListDataExportsRequest} request
|
|
16
|
+
* @param {DataexportsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
17
|
+
*
|
|
18
|
+
* @throws {@link Schematic.BadRequestError}
|
|
19
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
20
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
21
|
+
* @throws {@link Schematic.NotFoundError}
|
|
22
|
+
* @throws {@link Schematic.InternalServerError}
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* await client.dataexports.listDataExports({
|
|
26
|
+
* exportType: "audit-log",
|
|
27
|
+
* status: "failure",
|
|
28
|
+
* limit: 1000000,
|
|
29
|
+
* offset: 1000000
|
|
30
|
+
* })
|
|
31
|
+
*/
|
|
32
|
+
listDataExports(request?: Schematic.ListDataExportsRequest, requestOptions?: DataexportsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListDataExportsResponse>;
|
|
33
|
+
private __listDataExports;
|
|
14
34
|
/**
|
|
15
35
|
* @param {Schematic.CreateDataExportRequestBody} request
|
|
16
36
|
* @param {DataexportsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -23,11 +43,26 @@ export declare class DataexportsClient {
|
|
|
23
43
|
*
|
|
24
44
|
* @example
|
|
25
45
|
* await client.dataexports.createDataExport({
|
|
26
|
-
*
|
|
46
|
+
* exportType: "audit-log",
|
|
47
|
+
* outputFileType: "csv"
|
|
27
48
|
* })
|
|
28
49
|
*/
|
|
29
50
|
createDataExport(request: Schematic.CreateDataExportRequestBody, requestOptions?: DataexportsClient.RequestOptions): core.HttpResponsePromise<Schematic.CreateDataExportResponse>;
|
|
30
51
|
private __createDataExport;
|
|
52
|
+
/**
|
|
53
|
+
* @param {string} data_export_id - data_export_id
|
|
54
|
+
* @param {DataexportsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
57
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
58
|
+
* @throws {@link Schematic.NotFoundError}
|
|
59
|
+
* @throws {@link Schematic.InternalServerError}
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* await client.dataexports.getDataExport("data_export_id")
|
|
63
|
+
*/
|
|
64
|
+
getDataExport(data_export_id: string, requestOptions?: DataexportsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetDataExportResponse>;
|
|
65
|
+
private __getDataExport;
|
|
31
66
|
/**
|
|
32
67
|
* @throws {@link Schematic.UnauthorizedError}
|
|
33
68
|
* @throws {@link Schematic.ForbiddenError}
|
|
@@ -1,9 +1,13 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
1
2
|
/**
|
|
2
3
|
* @example
|
|
3
4
|
* {
|
|
4
|
-
*
|
|
5
|
+
* exportType: "audit-log",
|
|
6
|
+
* outputFileType: "csv"
|
|
5
7
|
* }
|
|
6
8
|
*/
|
|
7
9
|
export interface CreateDataExportRequestBody {
|
|
8
|
-
|
|
10
|
+
exportType: Schematic.DataExportType;
|
|
11
|
+
metadata?: Schematic.DataExportMetadata;
|
|
12
|
+
outputFileType: Schematic.DataExportOutputFileType;
|
|
9
13
|
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* exportType: "audit-log",
|
|
6
|
+
* status: "failure",
|
|
7
|
+
* limit: 1000000,
|
|
8
|
+
* offset: 1000000
|
|
9
|
+
* }
|
|
10
|
+
*/
|
|
11
|
+
export interface ListDataExportsRequest {
|
|
12
|
+
exportType?: Schematic.DataExportType;
|
|
13
|
+
status?: Schematic.DataExportStatus;
|
|
14
|
+
/** Page limit (default 100) */
|
|
15
|
+
limit?: number;
|
|
16
|
+
/** Page offset (default 0) */
|
|
17
|
+
offset?: number;
|
|
18
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type * as Schematic from "../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* Input parameters
|
|
4
|
+
*/
|
|
5
|
+
export interface ListDataExportsParams {
|
|
6
|
+
exportType?: Schematic.DataExportType;
|
|
7
|
+
/** Page limit (default 100) */
|
|
8
|
+
limit?: number;
|
|
9
|
+
/** Page offset (default 0) */
|
|
10
|
+
offset?: number;
|
|
11
|
+
status?: Schematic.DataExportStatus;
|
|
12
|
+
}
|
|
@@ -7,6 +7,9 @@ export * from "./accounts/types";
|
|
|
7
7
|
export * as billing from "./billing";
|
|
8
8
|
export * from "./billing/client/requests";
|
|
9
9
|
export * from "./billing/types";
|
|
10
|
+
export * as catalogs from "./catalogs";
|
|
11
|
+
export * from "./catalogs/client/requests";
|
|
12
|
+
export * from "./catalogs/types";
|
|
10
13
|
export * as checkout from "./checkout";
|
|
11
14
|
export * from "./checkout/client/requests";
|
|
12
15
|
export * from "./checkout/types";
|
package/dist/api/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts
CHANGED
|
@@ -9,6 +9,7 @@ import type * as Schematic from "../../../../index";
|
|
|
9
9
|
*/
|
|
10
10
|
export interface CreateCustomPlanBundleRequestBody {
|
|
11
11
|
billingProduct?: Schematic.UpsertBillingProductRequestBody;
|
|
12
|
+
creditGrants?: Schematic.PlanBundleCreditGrantRequestBody[];
|
|
12
13
|
entitlements: Schematic.PlanBundleEntitlementRequestBody[];
|
|
13
14
|
plan?: Schematic.CreateCustomPlanBundlePlanRequestBody;
|
|
14
15
|
}
|