@schematichq/schematic-typescript-node 1.5.3 → 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/billing/client/requests/CreateBillingSubscriptionRequestBody.d.ts +1 -0
- package/dist/api/resources/billing/client/requests/CreateInvoiceRequestBody.d.ts +2 -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/companies/client/Client.d.ts +34 -0
- package/dist/api/resources/companies/client/requests/GetBillingEntityChildSubscriptionsRequest.d.ts +9 -0
- package/dist/api/resources/companies/client/requests/GetCompanyBillingEntityRequest.d.ts +9 -0
- package/dist/api/resources/companies/client/requests/index.d.ts +2 -0
- package/dist/api/resources/companies/types/GetBillingEntityChildSubscriptionsParams.d.ts +6 -0
- package/dist/api/resources/companies/types/GetBillingEntityChildSubscriptionsResponse.d.ts +6 -0
- package/dist/api/resources/companies/types/GetCompanyBillingEntityParams.d.ts +6 -0
- package/dist/api/resources/companies/types/GetCompanyBillingEntityResponse.d.ts +6 -0
- package/dist/api/resources/companies/types/index.d.ts +4 -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/entitlements/client/requests/CreateBillingLinkedPlanEntitlementRequestBody.d.ts +1 -0
- package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +1 -0
- package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +1 -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/resources/planbundle/client/requests/CreatePlanBundleRequestBody.d.ts +0 -1
- package/dist/api/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +0 -1
- package/dist/api/types/AccountMemberPermission.d.ts +1 -0
- package/dist/api/types/AuditLogExportMetadata.d.ts +12 -0
- package/dist/api/types/BillingCreditAutoTopupAvailability.d.ts +6 -0
- package/dist/api/types/BillingCreditGrantZeroedOutReason.d.ts +2 -0
- package/dist/api/types/BillingPlanCreditGrantResetCadence.d.ts +2 -0
- package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +5 -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/ChangeSubscriptionInternalRequestBody.d.ts +1 -0
- package/dist/api/types/ChangeSubscriptionRequestBody.d.ts +1 -0
- package/dist/api/types/CompanyBillingEntityResponseData.d.ts +5 -0
- package/dist/api/types/CompanyBillingEntitySubscriptionResponseData.d.ts +21 -0
- package/dist/api/types/CompanyFeatureUsageExportMetadata.d.ts +36 -0
- package/dist/api/types/CompanyPlanCreditGrantView.d.ts +2 -0
- package/dist/api/types/CompanyPlanDetailResponseData.d.ts +3 -0
- package/dist/api/types/ComponentResponseData.d.ts +1 -0
- package/dist/api/types/CreateBillingPlanCreditGrantRequestBody.d.ts +2 -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/EventBody.d.ts +1 -1
- package/dist/api/types/EventBodyInference.d.ts +30 -0
- package/dist/api/types/EventType.d.ts +1 -0
- package/dist/api/types/FeatureEntitlement.d.ts +2 -0
- package/dist/api/types/IntegrationsListResponseData.d.ts +1 -0
- package/dist/api/types/InvoiceRequestBody.d.ts +2 -0
- package/dist/api/types/InvoiceResponseData.d.ts +2 -0
- package/dist/api/types/ManagePlanRequest.d.ts +2 -0
- package/dist/api/types/MetronomeIntegrationConfig.d.ts +4 -1
- package/dist/api/types/PlanBundleResponseData.d.ts +0 -1
- package/dist/api/types/PlanCatalogMembershipResponseData.d.ts +4 -0
- package/dist/api/types/PlanCreditGrantView.d.ts +2 -0
- package/dist/api/types/PlanDetailResponseData.d.ts +3 -0
- package/dist/api/types/PlanEntitlementResponseData.d.ts +1 -0
- package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts +3 -0
- package/dist/api/types/PlanViewPublicResponseData.d.ts +3 -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/UpdateBillingPlanCreditGrantRequestBody.d.ts +2 -0
- package/dist/api/types/UpsertCompanyRequestBody.d.ts +4 -0
- package/dist/api/types/WarningTier.d.ts +6 -0
- package/dist/api/types/WarningTierRequestBody.d.ts +4 -0
- package/dist/api/types/WarningTierResponseData.d.ts +5 -0
- package/dist/api/types/index.d.ts +25 -0
- package/dist/index.js +9 -9
- package/dist/serialization/resources/billing/client/requests/CreateBillingSubscriptionRequestBody.d.ts +1 -0
- package/dist/serialization/resources/billing/client/requests/CreateInvoiceRequestBody.d.ts +2 -0
- 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/companies/types/GetBillingEntityChildSubscriptionsParams.d.ts +9 -0
- package/dist/serialization/resources/companies/types/GetBillingEntityChildSubscriptionsResponse.d.ts +12 -0
- package/dist/serialization/resources/companies/types/GetCompanyBillingEntityParams.d.ts +9 -0
- package/dist/serialization/resources/companies/types/GetCompanyBillingEntityResponse.d.ts +12 -0
- package/dist/serialization/resources/companies/types/index.d.ts +4 -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/entitlements/client/requests/CreateBillingLinkedPlanEntitlementRequestBody.d.ts +2 -0
- package/dist/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +2 -0
- package/dist/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +2 -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/resources/planbundle/client/requests/CreatePlanBundleRequestBody.d.ts +0 -2
- package/dist/serialization/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +0 -2
- package/dist/serialization/types/AccountMemberPermission.d.ts +1 -1
- package/dist/serialization/types/AuditLogExportMetadata.d.ts +13 -0
- package/dist/serialization/types/BillingCreditAutoTopupAvailability.d.ts +7 -0
- package/dist/serialization/types/BillingCreditGrantZeroedOutReason.d.ts +1 -1
- package/dist/serialization/types/BillingPlanCreditGrantResetCadence.d.ts +1 -1
- package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +3 -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/ChangeSubscriptionInternalRequestBody.d.ts +1 -0
- package/dist/serialization/types/ChangeSubscriptionRequestBody.d.ts +1 -0
- package/dist/serialization/types/CompanyBillingEntityResponseData.d.ts +11 -0
- package/dist/serialization/types/CompanyBillingEntitySubscriptionResponseData.d.ts +32 -0
- package/dist/serialization/types/CompanyFeatureUsageExportMetadata.d.ts +25 -0
- package/dist/serialization/types/CompanyPlanCreditGrantView.d.ts +3 -0
- package/dist/serialization/types/CompanyPlanDetailResponseData.d.ts +5 -0
- package/dist/serialization/types/ComponentResponseData.d.ts +1 -0
- package/dist/serialization/types/CreateBillingPlanCreditGrantRequestBody.d.ts +3 -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/EventBody.d.ts +2 -1
- package/dist/serialization/types/EventBodyInference.d.ts +22 -0
- package/dist/serialization/types/EventType.d.ts +1 -1
- package/dist/serialization/types/FeatureEntitlement.d.ts +2 -0
- package/dist/serialization/types/IntegrationsListResponseData.d.ts +1 -0
- package/dist/serialization/types/InvoiceRequestBody.d.ts +2 -0
- package/dist/serialization/types/InvoiceResponseData.d.ts +2 -0
- package/dist/serialization/types/ManagePlanRequest.d.ts +1 -0
- package/dist/serialization/types/MetronomeIntegrationConfig.d.ts +3 -1
- package/dist/serialization/types/PlanBundleResponseData.d.ts +0 -2
- package/dist/serialization/types/PlanCatalogMembershipResponseData.d.ts +10 -0
- package/dist/serialization/types/PlanCreditGrantView.d.ts +3 -0
- package/dist/serialization/types/PlanDetailResponseData.d.ts +5 -0
- package/dist/serialization/types/PlanEntitlementResponseData.d.ts +2 -0
- package/dist/serialization/types/PlanGroupPlanDetailResponseData.d.ts +5 -0
- package/dist/serialization/types/PlanViewPublicResponseData.d.ts +5 -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/UpdateBillingPlanCreditGrantRequestBody.d.ts +3 -0
- package/dist/serialization/types/UpsertCompanyRequestBody.d.ts +2 -0
- package/dist/serialization/types/WarningTier.d.ts +10 -0
- package/dist/serialization/types/WarningTierRequestBody.d.ts +10 -0
- package/dist/serialization/types/WarningTierResponseData.d.ts +11 -0
- package/dist/serialization/types/index.d.ts +25 -0
- package/dist/wasm/rulesengine.js +4 -4
- package/dist/wasm/rulesengine_bg.wasm.d.ts +1 -0
- package/package.json +1 -1
|
@@ -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
|
+
}
|
|
@@ -43,6 +43,7 @@ export interface CreateBillingLinkedPlanEntitlementRequestBody {
|
|
|
43
43
|
valueNumeric?: number;
|
|
44
44
|
valueTraitId?: string;
|
|
45
45
|
valueType: Schematic.EntitlementValueType;
|
|
46
|
+
warningTiers?: Schematic.WarningTierRequestBody[];
|
|
46
47
|
yearlyMeteredPriceId?: string;
|
|
47
48
|
yearlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
|
|
48
49
|
yearlyUnitPrice?: number;
|
package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts
CHANGED
|
@@ -39,6 +39,7 @@ export interface CreatePlanEntitlementRequestBody {
|
|
|
39
39
|
valueNumeric?: number;
|
|
40
40
|
valueTraitId?: string;
|
|
41
41
|
valueType: Schematic.EntitlementValueType;
|
|
42
|
+
warningTiers?: Schematic.WarningTierRequestBody[];
|
|
42
43
|
yearlyMeteredPriceId?: string;
|
|
43
44
|
yearlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
|
|
44
45
|
yearlyUnitPrice?: number;
|
package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts
CHANGED
|
@@ -34,6 +34,7 @@ export interface UpdatePlanEntitlementRequestBody {
|
|
|
34
34
|
valueNumeric?: number;
|
|
35
35
|
valueTraitId?: string;
|
|
36
36
|
valueType: Schematic.EntitlementValueType;
|
|
37
|
+
warningTiers?: Schematic.WarningTierRequestBody[];
|
|
37
38
|
yearlyMeteredPriceId?: string;
|
|
38
39
|
yearlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
|
|
39
40
|
yearlyUnitPrice?: number;
|
|
@@ -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
|
}
|
|
@@ -12,5 +12,4 @@ export interface CreatePlanBundleRequestBody {
|
|
|
12
12
|
creditGrants?: Schematic.PlanBundleCreditGrantRequestBody[];
|
|
13
13
|
entitlements: Schematic.PlanBundleEntitlementRequestBody[];
|
|
14
14
|
plan?: Schematic.CreatePlanRequestBody;
|
|
15
|
-
traits?: Schematic.UpdatePlanTraitTraitRequestBody[];
|
|
16
15
|
}
|
|
@@ -2,6 +2,7 @@ export declare const AccountMemberPermission: {
|
|
|
2
2
|
readonly CompaniesEdit: "companies_edit";
|
|
3
3
|
readonly CompanyUsersEdit: "company_users_edit";
|
|
4
4
|
readonly ComponentsEdit: "components_edit";
|
|
5
|
+
readonly CustomPlansEdit: "custom_plans_edit";
|
|
5
6
|
readonly DataExportsEdit: "data_exports_edit";
|
|
6
7
|
readonly FeaturesEdit: "features_edit";
|
|
7
8
|
readonly FlagRulesEdit: "flag_rules_edit";
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export interface AuditLogExportMetadata {
|
|
2
|
+
/** Restrict the export to audit log entries from this actor type */
|
|
3
|
+
actorType?: string;
|
|
4
|
+
/** Restrict the export to audit log entries that started before this time */
|
|
5
|
+
endTime?: Date;
|
|
6
|
+
/** Account member emails to notify when the export completes; empty means the artifact is only retrievable via the API */
|
|
7
|
+
notificationEmailRecipientEmailAddresses?: string[];
|
|
8
|
+
/** Free-text search over audit log entries */
|
|
9
|
+
q?: string;
|
|
10
|
+
/** Restrict the export to audit log entries that started at or after this time */
|
|
11
|
+
startTime?: Date;
|
|
12
|
+
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export declare const BillingCreditAutoTopupAvailability: {
|
|
2
|
+
readonly Off: "off";
|
|
3
|
+
readonly Automatic: "automatic";
|
|
4
|
+
readonly UserControlled: "user_controlled";
|
|
5
|
+
};
|
|
6
|
+
export type BillingCreditAutoTopupAvailability = (typeof BillingCreditAutoTopupAvailability)[keyof typeof BillingCreditAutoTopupAvailability];
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
export declare const BillingCreditGrantZeroedOutReason: {
|
|
2
|
+
readonly CustomerArchived: "customer_archived";
|
|
2
3
|
readonly Expired: "expired";
|
|
4
|
+
readonly IntegrationUninstalled: "integration_uninstalled";
|
|
3
5
|
readonly Manual: "manual";
|
|
4
6
|
readonly PlanChange: "plan_change";
|
|
5
7
|
readonly PlanPeriodReset: "plan_period_reset";
|
|
@@ -2,13 +2,18 @@ import type * as Schematic from "../index";
|
|
|
2
2
|
export interface BillingPlanCreditGrantResponseData {
|
|
3
3
|
autoTopupAmount?: number;
|
|
4
4
|
autoTopupAmountType?: string;
|
|
5
|
+
autoTopupAvailability: Schematic.BillingCreditAutoTopupAvailability;
|
|
6
|
+
/** Derived from auto_topup_availability; use that instead. */
|
|
5
7
|
autoTopupEnabled: boolean;
|
|
6
8
|
autoTopupExpiryType?: Schematic.BillingCreditExpiryType;
|
|
7
9
|
autoTopupExpiryUnit?: Schematic.BillingCreditExpiryUnit;
|
|
8
10
|
autoTopupExpiryUnitCount?: number;
|
|
11
|
+
/** Derived from auto_topup_availability; use that instead. */
|
|
9
12
|
autoTopupSelfService: boolean;
|
|
10
13
|
autoTopupThresholdCredits?: number;
|
|
11
14
|
autoTopupThresholdPercent?: number;
|
|
15
|
+
/** Whether buyers can purchase one-time credit bundles on this grant, independent of auto top-up availability. */
|
|
16
|
+
canBuyBundles: boolean;
|
|
12
17
|
createdAt: Date;
|
|
13
18
|
credit?: Schematic.BillingCreditResponseData;
|
|
14
19
|
creditAmount: number;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type * as Schematic from "../index";
|
|
2
|
+
export interface CatalogConfigurationResponseData {
|
|
3
|
+
addOns: Schematic.PlanGroupPlanDetailResponseData[];
|
|
4
|
+
customPlanCtaText?: string;
|
|
5
|
+
customPlanCtaUrl?: string;
|
|
6
|
+
customPlanPriceText?: string;
|
|
7
|
+
customPlansVisible: boolean;
|
|
8
|
+
orderedAddOns: Schematic.CatalogConfigOrderedPlanResponseData[];
|
|
9
|
+
orderedBundles: Schematic.CatalogConfigOrderedBundleResponseData[];
|
|
10
|
+
orderedPlans: Schematic.CatalogConfigOrderedPlanResponseData[];
|
|
11
|
+
plans: Schematic.PlanGroupPlanDetailResponseData[];
|
|
12
|
+
pricingModel?: string;
|
|
13
|
+
pricingUrl?: string;
|
|
14
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
export interface CatalogResponseData {
|
|
2
|
+
accountId: string;
|
|
3
|
+
createdAt: Date;
|
|
4
|
+
customPlanCtaText?: string;
|
|
5
|
+
customPlanCtaUrl?: string;
|
|
6
|
+
customPlanPriceText?: string;
|
|
7
|
+
customPlansVisible: boolean;
|
|
8
|
+
description?: string;
|
|
9
|
+
environmentId: string;
|
|
10
|
+
id: string;
|
|
11
|
+
isDefault: boolean;
|
|
12
|
+
name: string;
|
|
13
|
+
pricingModel?: string;
|
|
14
|
+
pricingUrl?: string;
|
|
15
|
+
updatedAt: Date;
|
|
16
|
+
}
|
|
@@ -2,6 +2,7 @@ import type * as Schematic from "../index";
|
|
|
2
2
|
export interface ChangeSubscriptionInternalRequestBody {
|
|
3
3
|
addOnIds: Schematic.UpdateAddOnRequestBody[];
|
|
4
4
|
autoTopupOverrides: Schematic.UpdateAutoTopupOverrideRequestBody[];
|
|
5
|
+
billingEntityId?: string;
|
|
5
6
|
companyId: string;
|
|
6
7
|
couponExternalId?: string;
|
|
7
8
|
creditBundles: Schematic.UpdateCreditBundleRequestBody[];
|
|
@@ -2,6 +2,7 @@ import type * as Schematic from "../index";
|
|
|
2
2
|
export interface ChangeSubscriptionRequestBody {
|
|
3
3
|
addOnIds: Schematic.UpdateAddOnRequestBody[];
|
|
4
4
|
autoTopupOverrides: Schematic.UpdateAutoTopupOverrideRequestBody[];
|
|
5
|
+
billingEntityId?: string;
|
|
5
6
|
couponExternalId?: string;
|
|
6
7
|
creditBundles: Schematic.UpdateCreditBundleRequestBody[];
|
|
7
8
|
customFieldValues: Schematic.CheckoutFieldValue[];
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type * as Schematic from "../index";
|
|
2
|
+
export interface CompanyBillingEntitySubscriptionResponseData {
|
|
3
|
+
cancelAt?: Date;
|
|
4
|
+
cancelAtPeriodEnd: boolean;
|
|
5
|
+
company?: Schematic.CompanyResponseData;
|
|
6
|
+
currency: string;
|
|
7
|
+
customerExternalId: string;
|
|
8
|
+
discounts: Schematic.BillingSubscriptionDiscountView[];
|
|
9
|
+
expiredAt?: Date;
|
|
10
|
+
interval: string;
|
|
11
|
+
isInitial: boolean;
|
|
12
|
+
latestInvoice?: Schematic.InvoiceResponseData;
|
|
13
|
+
paymentMethod?: Schematic.PaymentMethodResponseData;
|
|
14
|
+
planName: string;
|
|
15
|
+
products: Schematic.BillingProductForSubscriptionResponseData[];
|
|
16
|
+
providerType: Schematic.BillingProviderType;
|
|
17
|
+
status: string;
|
|
18
|
+
subscriptionExternalId: string;
|
|
19
|
+
totalPrice: number;
|
|
20
|
+
trialEnd?: Date;
|
|
21
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
export interface CompanyFeatureUsageExportMetadata {
|
|
2
|
+
/** Restrict the export to these Schematic company IDs (starting with 'comp_') */
|
|
3
|
+
companyIds?: string[];
|
|
4
|
+
/** Restrict the export to companies with these billing credit type IDs */
|
|
5
|
+
creditTypeIds?: string[];
|
|
6
|
+
/** Schematic feature IDs (starting with 'feat_') to include as usage columns; at least one is required */
|
|
7
|
+
featureIds: string[];
|
|
8
|
+
/** Restrict the export to companies that do (or do not) have a scheduled downgrade */
|
|
9
|
+
hasScheduledDowngrade?: boolean;
|
|
10
|
+
/** Restrict the export to companies with (or without) a monetized subscription */
|
|
11
|
+
monetizedSubscriptions?: boolean;
|
|
12
|
+
/** Account member emails to notify when the export completes; empty means the artifact is only retrievable via the API */
|
|
13
|
+
notificationEmailRecipientEmailAddresses?: string[];
|
|
14
|
+
/** Restrict the export to companies on this plan ID (starting with 'plan_') */
|
|
15
|
+
planId?: string;
|
|
16
|
+
/** Restrict the export to companies on any of these plan IDs */
|
|
17
|
+
planIds?: string[];
|
|
18
|
+
/** Restrict the export to companies on this plan version ID */
|
|
19
|
+
planVersionId?: string;
|
|
20
|
+
/** Free-text search over company name and keys */
|
|
21
|
+
q?: string;
|
|
22
|
+
/** Restrict the export to companies whose subscription has one of these statuses */
|
|
23
|
+
subscriptionStatuses?: string[];
|
|
24
|
+
/** Restrict the export to companies whose subscription has one of these types */
|
|
25
|
+
subscriptionTypes?: string[];
|
|
26
|
+
/** Restrict the export to companies that have an entitlement for this feature ID */
|
|
27
|
+
withEntitlementFor?: string;
|
|
28
|
+
/** Restrict the export to companies with a subscription */
|
|
29
|
+
withSubscription?: boolean;
|
|
30
|
+
/** Restrict the export to companies without a company-level override for this feature ID */
|
|
31
|
+
withoutFeatureOverrideFor?: string;
|
|
32
|
+
/** Restrict the export to companies without a plan */
|
|
33
|
+
withoutPlan?: boolean;
|
|
34
|
+
/** Restrict the export to companies without a subscription */
|
|
35
|
+
withoutSubscription?: boolean;
|
|
36
|
+
}
|
|
@@ -2,6 +2,7 @@ import type * as Schematic from "../index";
|
|
|
2
2
|
export interface CompanyPlanCreditGrantView {
|
|
3
3
|
billingCreditAutoTopupAmount?: number;
|
|
4
4
|
billingCreditAutoTopupAmountType?: string;
|
|
5
|
+
billingCreditAutoTopupAvailability?: Schematic.BillingCreditAutoTopupAvailability;
|
|
5
6
|
billingCreditAutoTopupEnabled: boolean;
|
|
6
7
|
billingCreditAutoTopupExpiryType?: Schematic.BillingCreditExpiryType;
|
|
7
8
|
billingCreditAutoTopupExpiryUnit?: Schematic.BillingCreditExpiryUnit;
|
|
@@ -9,6 +10,7 @@ export interface CompanyPlanCreditGrantView {
|
|
|
9
10
|
billingCreditAutoTopupSelfService: boolean;
|
|
10
11
|
billingCreditAutoTopupThresholdCredits?: number;
|
|
11
12
|
billingCreditAutoTopupThresholdPercent?: number;
|
|
13
|
+
billingCreditCanBuyBundles: boolean;
|
|
12
14
|
companyAutoTopupAmount?: number;
|
|
13
15
|
companyAutoTopupEnabled?: boolean;
|
|
14
16
|
companyAutoTopupThresholdCredits?: number;
|
|
@@ -6,15 +6,18 @@ export interface CompanyPlanDetailResponseData {
|
|
|
6
6
|
billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
|
|
7
7
|
billingProduct?: Schematic.BillingProductDetailResponseData;
|
|
8
8
|
billingStrategy: Schematic.BillingStrategy;
|
|
9
|
+
catalogs?: Schematic.PlanCatalogMembershipResponseData[];
|
|
9
10
|
chargeType: Schematic.ChargeType;
|
|
10
11
|
companyCanTrial: boolean;
|
|
11
12
|
companyCount: number;
|
|
12
13
|
companyId?: string;
|
|
14
|
+
companyLogoUrl?: string;
|
|
13
15
|
companyName?: string;
|
|
14
16
|
compatiblePlanIds: string[];
|
|
15
17
|
controlledBy: Schematic.BillingProviderType;
|
|
16
18
|
copiedFromPlanId?: string;
|
|
17
19
|
createdAt: Date;
|
|
20
|
+
credits: Schematic.BillingCreditResponseData[];
|
|
18
21
|
currencyPrices: Schematic.PlanCurrencyPricesResponseData[];
|
|
19
22
|
current: boolean;
|
|
20
23
|
custom: boolean;
|
|
@@ -3,6 +3,7 @@ export interface CreateBillingPlanCreditGrantRequestBody {
|
|
|
3
3
|
applyToExisting?: boolean;
|
|
4
4
|
autoTopupAmount?: number;
|
|
5
5
|
autoTopupAmountType?: Schematic.CreditAutoTopupAmountType;
|
|
6
|
+
autoTopupAvailability?: Schematic.BillingCreditAutoTopupAvailability;
|
|
6
7
|
autoTopupEnabled?: boolean;
|
|
7
8
|
autoTopupExpiryType?: Schematic.BillingCreditExpiryType;
|
|
8
9
|
autoTopupExpiryUnit?: Schematic.BillingCreditExpiryUnit;
|
|
@@ -10,6 +11,7 @@ export interface CreateBillingPlanCreditGrantRequestBody {
|
|
|
10
11
|
autoTopupSelfService?: boolean;
|
|
11
12
|
autoTopupThresholdCredits?: number;
|
|
12
13
|
autoTopupThresholdPercent?: number;
|
|
14
|
+
canBuyBundles?: boolean;
|
|
13
15
|
creditAmount: number;
|
|
14
16
|
creditId: string;
|
|
15
17
|
expiryType?: Schematic.BillingCreditExpiryType;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type * as Schematic from "../index";
|
|
2
|
+
export type DataExportMetadata = Schematic.DataExportMetadata.AuditLog | Schematic.DataExportMetadata.CompanyFeatureUsage;
|
|
3
|
+
export declare namespace DataExportMetadata {
|
|
4
|
+
interface AuditLog extends Schematic.AuditLogExportMetadata {
|
|
5
|
+
exportType: "audit-log";
|
|
6
|
+
}
|
|
7
|
+
interface CompanyFeatureUsage extends Schematic.CompanyFeatureUsageExportMetadata {
|
|
8
|
+
exportType: "company-feature-usage";
|
|
9
|
+
}
|
|
10
|
+
}
|
|
@@ -5,7 +5,7 @@ export interface DataExportResponseData {
|
|
|
5
5
|
environmentId: string;
|
|
6
6
|
exportType: Schematic.DataExportType;
|
|
7
7
|
id: string;
|
|
8
|
-
metadata
|
|
8
|
+
metadata?: Schematic.DataExportMetadata;
|
|
9
9
|
outputFileType: Schematic.DataExportOutputFileType;
|
|
10
10
|
status: Schematic.DataExportStatus;
|
|
11
11
|
updatedAt: Date;
|
|
@@ -1 +1,5 @@
|
|
|
1
|
-
export
|
|
1
|
+
export declare const DataExportType: {
|
|
2
|
+
readonly AuditLog: "audit-log";
|
|
3
|
+
readonly CompanyFeatureUsage: "company-feature-usage";
|
|
4
|
+
};
|
|
5
|
+
export type DataExportType = (typeof DataExportType)[keyof typeof DataExportType];
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
import type * as Schematic from "../index";
|
|
2
|
-
export type EventBody = Schematic.EventBodyTrack | Schematic.EventBodyFlagCheck | Schematic.EventBodyIdentify;
|
|
2
|
+
export type EventBody = Schematic.EventBodyTrack | Schematic.EventBodyFlagCheck | Schematic.EventBodyIdentify | Schematic.EventBodyInference;
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
export interface EventBodyInference {
|
|
2
|
+
/** Number of input tokens served from cache */
|
|
3
|
+
cachedInputTokens?: number;
|
|
4
|
+
/** Key-value pairs to identify the company associated with the inference event */
|
|
5
|
+
company: Record<string, string>;
|
|
6
|
+
/** Provided cost of the inference request as a decimal string; derived from model pricing when omitted */
|
|
7
|
+
cost?: string;
|
|
8
|
+
/** ISO 4217 currency code for the provided cost; defaults to 'usd' */
|
|
9
|
+
currency?: string;
|
|
10
|
+
/** Optional track event name to fan out for usage-based billing */
|
|
11
|
+
event?: string;
|
|
12
|
+
/** Number of input tokens for the inference request */
|
|
13
|
+
inputTokens: number;
|
|
14
|
+
/** The inference operation; defaults to 'chat' */
|
|
15
|
+
operation?: string;
|
|
16
|
+
/** Number of output tokens for the inference request */
|
|
17
|
+
outputTokens: number;
|
|
18
|
+
/** The inference provider (e.g. 'anthropic', 'openai') */
|
|
19
|
+
provider: string;
|
|
20
|
+
/** Number of reasoning tokens for the inference request */
|
|
21
|
+
reasoningTokens?: number;
|
|
22
|
+
/** The model requested for the inference request */
|
|
23
|
+
requestModel?: string;
|
|
24
|
+
/** Number of requests represented by this event; defaults to 1 */
|
|
25
|
+
requests?: number;
|
|
26
|
+
/** The model that served the inference response */
|
|
27
|
+
responseModel: string;
|
|
28
|
+
/** Key-value pairs to identify the user associated with the inference event */
|
|
29
|
+
user?: Record<string, string>;
|
|
30
|
+
}
|
|
@@ -36,4 +36,6 @@ export interface FeatureEntitlement {
|
|
|
36
36
|
usage?: number;
|
|
37
37
|
/** The type of the entitlement value */
|
|
38
38
|
valueType: Schematic.EntitlementValueType;
|
|
39
|
+
/** Customer-defined usage warning thresholds configured on this entitlement */
|
|
40
|
+
warningTiers?: Schematic.WarningTier[];
|
|
39
41
|
}
|
|
@@ -7,7 +7,9 @@ export interface InvoiceRequestBody {
|
|
|
7
7
|
currency: string;
|
|
8
8
|
customerExternalId: string;
|
|
9
9
|
dueDate?: Date;
|
|
10
|
+
endingBalance?: number;
|
|
10
11
|
paymentMethodExternalId?: string;
|
|
12
|
+
startingBalance?: number;
|
|
11
13
|
status?: Schematic.InvoiceStatus;
|
|
12
14
|
subscriptionExternalId?: string;
|
|
13
15
|
subtotal: number;
|
|
@@ -9,11 +9,13 @@ export interface InvoiceResponseData {
|
|
|
9
9
|
currency: string;
|
|
10
10
|
customerExternalId: string;
|
|
11
11
|
dueDate?: Date;
|
|
12
|
+
endingBalance: number;
|
|
12
13
|
environmentId: string;
|
|
13
14
|
externalId?: string;
|
|
14
15
|
id: string;
|
|
15
16
|
paymentMethodExternalId?: string;
|
|
16
17
|
providerType: Schematic.BillingProviderType;
|
|
18
|
+
startingBalance: number;
|
|
17
19
|
status?: Schematic.InvoiceStatus;
|
|
18
20
|
subscriptionExternalId?: string;
|
|
19
21
|
subtotal: number;
|