@schematichq/schematic-typescript-node 1.5.4 → 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.
Files changed (219) hide show
  1. package/dist/Client.d.ts +6 -0
  2. package/dist/api/resources/accounts/client/Client.d.ts +2 -0
  3. package/dist/api/resources/accounts/client/requests/CountAccountMembersRequest.d.ts +4 -0
  4. package/dist/api/resources/accounts/client/requests/ListAccountMembersRequest.d.ts +4 -0
  5. package/dist/api/resources/accounts/types/CountAccountMembersParams.d.ts +3 -0
  6. package/dist/api/resources/accounts/types/ListAccountMembersParams.d.ts +3 -0
  7. package/dist/api/resources/catalogs/client/Client.d.ts +232 -0
  8. package/dist/api/resources/catalogs/client/index.d.ts +1 -0
  9. package/dist/api/resources/catalogs/client/requests/CreateCatalogRequestBody.d.ts +12 -0
  10. package/dist/api/resources/catalogs/client/requests/ListCatalogsRequest.d.ts +18 -0
  11. package/dist/api/resources/catalogs/client/requests/UpdateCatalogConfigurationRequestBody.d.ts +16 -0
  12. package/dist/api/resources/catalogs/client/requests/UpdateCatalogRequestBody.d.ts +9 -0
  13. package/dist/api/resources/catalogs/client/requests/index.d.ts +4 -0
  14. package/dist/api/resources/catalogs/exports.d.ts +2 -0
  15. package/dist/api/resources/catalogs/index.d.ts +2 -0
  16. package/dist/api/resources/catalogs/types/CreateCatalogResponse.d.ts +6 -0
  17. package/dist/api/resources/catalogs/types/DeleteCatalogResponse.d.ts +6 -0
  18. package/dist/api/resources/catalogs/types/GetCatalogResponse.d.ts +6 -0
  19. package/dist/api/resources/catalogs/types/GetConfigurationResponse.d.ts +6 -0
  20. package/dist/api/resources/catalogs/types/GetCreditBundlesInCatalogResponse.d.ts +6 -0
  21. package/dist/api/resources/catalogs/types/GetDerivedFeaturesResponse.d.ts +6 -0
  22. package/dist/api/resources/catalogs/types/GetPlansInCatalogResponse.d.ts +6 -0
  23. package/dist/api/resources/catalogs/types/ListCatalogsParams.d.ts +12 -0
  24. package/dist/api/resources/catalogs/types/ListCatalogsResponse.d.ts +6 -0
  25. package/dist/api/resources/catalogs/types/UpdateCatalogResponse.d.ts +6 -0
  26. package/dist/api/resources/catalogs/types/UpdateConfigurationResponse.d.ts +6 -0
  27. package/dist/api/resources/catalogs/types/index.d.ts +11 -0
  28. package/dist/api/resources/checkout/client/Client.d.ts +35 -0
  29. package/dist/api/resources/checkout/client/requests/UpdateCompanyBillingDetailsRequestBody.d.ts +16 -0
  30. package/dist/api/resources/checkout/client/requests/index.d.ts +1 -0
  31. package/dist/api/resources/checkout/types/GetCompanyBillingDetailsResponse.d.ts +6 -0
  32. package/dist/api/resources/checkout/types/UpdateCompanyBillingDetailsResponse.d.ts +6 -0
  33. package/dist/api/resources/checkout/types/index.d.ts +2 -0
  34. package/dist/api/resources/components/client/Client.d.ts +16 -0
  35. package/dist/api/resources/components/client/requests/BindCatalogRequestBody.d.ts +7 -0
  36. package/dist/api/resources/components/client/requests/index.d.ts +1 -0
  37. package/dist/api/resources/components/types/BindCatalogResponse.d.ts +6 -0
  38. package/dist/api/resources/components/types/index.d.ts +1 -0
  39. package/dist/api/resources/dataexports/client/Client.d.ts +36 -1
  40. package/dist/api/resources/dataexports/client/requests/CreateDataExportRequestBody.d.ts +6 -2
  41. package/dist/api/resources/dataexports/client/requests/ListDataExportsRequest.d.ts +18 -0
  42. package/dist/api/resources/dataexports/client/requests/index.d.ts +1 -0
  43. package/dist/api/resources/dataexports/types/GetDataExportResponse.d.ts +6 -0
  44. package/dist/api/resources/dataexports/types/ListDataExportsParams.d.ts +12 -0
  45. package/dist/api/resources/dataexports/types/ListDataExportsResponse.d.ts +6 -0
  46. package/dist/api/resources/dataexports/types/index.d.ts +3 -0
  47. package/dist/api/resources/index.d.ts +6 -0
  48. package/dist/api/resources/licenses/client/Client.d.ts +69 -0
  49. package/dist/api/resources/licenses/client/index.d.ts +1 -0
  50. package/dist/api/resources/licenses/client/requests/CountLicensesRequest.d.ts +19 -0
  51. package/dist/api/resources/licenses/client/requests/ListLicensesRequest.d.ts +19 -0
  52. package/dist/api/resources/licenses/client/requests/index.d.ts +2 -0
  53. package/dist/api/resources/licenses/exports.d.ts +2 -0
  54. package/dist/api/resources/licenses/index.d.ts +2 -0
  55. package/dist/api/resources/licenses/types/CountLicensesParams.d.ts +12 -0
  56. package/dist/api/resources/licenses/types/CountLicensesResponse.d.ts +6 -0
  57. package/dist/api/resources/licenses/types/GetSingleLicenseResponse.d.ts +6 -0
  58. package/dist/api/resources/licenses/types/ListLicensesParams.d.ts +12 -0
  59. package/dist/api/resources/licenses/types/ListLicensesResponse.d.ts +6 -0
  60. package/dist/api/resources/licenses/types/index.d.ts +5 -0
  61. package/dist/api/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +1 -0
  62. package/dist/api/resources/planmigrations/client/Client.d.ts +20 -0
  63. package/dist/api/resources/planmigrations/client/requests/PreviewMigrationRequestBody.d.ts +16 -0
  64. package/dist/api/resources/planmigrations/client/requests/index.d.ts +1 -0
  65. package/dist/api/resources/planmigrations/types/PreviewMigrationResponse.d.ts +6 -0
  66. package/dist/api/resources/planmigrations/types/index.d.ts +1 -0
  67. package/dist/api/types/AuditLogExportMetadata.d.ts +12 -0
  68. package/dist/api/types/BillingCreditGrantZeroedOutReason.d.ts +1 -0
  69. package/dist/api/types/CatalogConfigOrderedBundle.d.ts +3 -0
  70. package/dist/api/types/CatalogConfigOrderedBundleResponseData.d.ts +3 -0
  71. package/dist/api/types/CatalogConfigOrderedEntitlement.d.ts +4 -0
  72. package/dist/api/types/CatalogConfigOrderedEntitlementResponseData.d.ts +4 -0
  73. package/dist/api/types/CatalogConfigOrderedPlan.d.ts +5 -0
  74. package/dist/api/types/CatalogConfigOrderedPlanResponseData.d.ts +5 -0
  75. package/dist/api/types/CatalogConfigurationResponseData.d.ts +14 -0
  76. package/dist/api/types/CatalogCreditBundleIDsResponseData.d.ts +3 -0
  77. package/dist/api/types/CatalogDerivedFeatureResponseData.d.ts +5 -0
  78. package/dist/api/types/CatalogDerivedFeaturesResponseData.d.ts +4 -0
  79. package/dist/api/types/CatalogPlanIDsResponseData.d.ts +3 -0
  80. package/dist/api/types/CatalogResponseData.d.ts +16 -0
  81. package/dist/api/types/CompanyBillingAddressView.d.ts +8 -0
  82. package/dist/api/types/CompanyBillingCheckoutSettings.d.ts +5 -0
  83. package/dist/api/types/CompanyBillingDetailsResponseData.d.ts +8 -0
  84. package/dist/api/types/CompanyBillingDetailsView.d.ts +8 -0
  85. package/dist/api/types/CompanyFeatureUsageExportMetadata.d.ts +36 -0
  86. package/dist/api/types/CompanyPlanDetailResponseData.d.ts +1 -0
  87. package/dist/api/types/ComponentResponseData.d.ts +1 -0
  88. package/dist/api/types/CreateEntitlementInBundleRequestBody.d.ts +1 -0
  89. package/dist/api/types/CreditsAutoTopupSuccess.d.ts +7 -0
  90. package/dist/api/types/CreditsCreditPurchaseSuccess.d.ts +9 -0
  91. package/dist/api/types/CreditsWebhookCompanySummary.d.ts +4 -0
  92. package/dist/api/types/CreditsWebhookCreditSummary.d.ts +4 -0
  93. package/dist/api/types/CustomerBillingAddress.d.ts +8 -0
  94. package/dist/api/types/DataExportMetadata.d.ts +10 -0
  95. package/dist/api/types/DataExportOutputFileType.d.ts +5 -1
  96. package/dist/api/types/DataExportResponseData.d.ts +1 -1
  97. package/dist/api/types/DataExportType.d.ts +5 -1
  98. package/dist/api/types/FeatureDetailResponseData.d.ts +6 -0
  99. package/dist/api/types/FeatureEntitlement.d.ts +2 -0
  100. package/dist/api/types/FeatureInPlanResponseData.d.ts +4 -0
  101. package/dist/api/types/FeatureResponseData.d.ts +4 -0
  102. package/dist/api/types/FeatureType.d.ts +1 -0
  103. package/dist/api/types/FeatureView.d.ts +2 -0
  104. package/dist/api/types/LicenseResponseData.d.ts +6 -0
  105. package/dist/api/types/PlanCatalogMembershipResponseData.d.ts +4 -0
  106. package/dist/api/types/PlanDetailResponseData.d.ts +1 -0
  107. package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts +1 -0
  108. package/dist/api/types/PlanVersionMigrationPreviewCompanyResponseData.d.ts +8 -0
  109. package/dist/api/types/PlanVersionMigrationPreviewResponseData.d.ts +4 -0
  110. package/dist/api/types/PlanViewPublicResponseData.d.ts +1 -0
  111. package/dist/api/types/PreviewSubscriptionDiscountResponseData.d.ts +13 -0
  112. package/dist/api/types/PreviewSubscriptionFinanceResponseData.d.ts +2 -0
  113. package/dist/api/types/RulesengineFeatureEntitlement.d.ts +2 -0
  114. package/dist/api/types/RulesengineWarningTier.d.ts +6 -0
  115. package/dist/api/types/UpsertCompanyRequestBody.d.ts +4 -0
  116. package/dist/api/types/WarningTier.d.ts +6 -0
  117. package/dist/api/types/WebhookRequestType.d.ts +2 -0
  118. package/dist/api/types/index.d.ts +31 -0
  119. package/dist/index.js +9 -9
  120. package/dist/serialization/resources/accounts/types/CountAccountMembersParams.d.ts +2 -0
  121. package/dist/serialization/resources/accounts/types/ListAccountMembersParams.d.ts +2 -0
  122. package/dist/serialization/resources/catalogs/client/index.d.ts +1 -0
  123. package/dist/serialization/resources/catalogs/client/requests/CreateCatalogRequestBody.d.ts +11 -0
  124. package/dist/serialization/resources/catalogs/client/requests/UpdateCatalogConfigurationRequestBody.d.ts +19 -0
  125. package/dist/serialization/resources/catalogs/client/requests/UpdateCatalogRequestBody.d.ts +11 -0
  126. package/dist/serialization/resources/catalogs/client/requests/index.d.ts +3 -0
  127. package/dist/serialization/resources/catalogs/index.d.ts +2 -0
  128. package/dist/serialization/resources/catalogs/types/CreateCatalogResponse.d.ts +11 -0
  129. package/dist/serialization/resources/catalogs/types/DeleteCatalogResponse.d.ts +11 -0
  130. package/dist/serialization/resources/catalogs/types/GetCatalogResponse.d.ts +11 -0
  131. package/dist/serialization/resources/catalogs/types/GetConfigurationResponse.d.ts +11 -0
  132. package/dist/serialization/resources/catalogs/types/GetCreditBundlesInCatalogResponse.d.ts +11 -0
  133. package/dist/serialization/resources/catalogs/types/GetDerivedFeaturesResponse.d.ts +11 -0
  134. package/dist/serialization/resources/catalogs/types/GetPlansInCatalogResponse.d.ts +11 -0
  135. package/dist/serialization/resources/catalogs/types/ListCatalogsParams.d.ts +12 -0
  136. package/dist/serialization/resources/catalogs/types/ListCatalogsResponse.d.ts +12 -0
  137. package/dist/serialization/resources/catalogs/types/UpdateCatalogResponse.d.ts +11 -0
  138. package/dist/serialization/resources/catalogs/types/UpdateConfigurationResponse.d.ts +11 -0
  139. package/dist/serialization/resources/catalogs/types/index.d.ts +11 -0
  140. package/dist/serialization/resources/checkout/client/requests/UpdateCompanyBillingDetailsRequestBody.d.ts +14 -0
  141. package/dist/serialization/resources/checkout/client/requests/index.d.ts +1 -0
  142. package/dist/serialization/resources/checkout/types/GetCompanyBillingDetailsResponse.d.ts +11 -0
  143. package/dist/serialization/resources/checkout/types/UpdateCompanyBillingDetailsResponse.d.ts +11 -0
  144. package/dist/serialization/resources/checkout/types/index.d.ts +2 -0
  145. package/dist/serialization/resources/components/client/requests/BindCatalogRequestBody.d.ts +9 -0
  146. package/dist/serialization/resources/components/client/requests/index.d.ts +1 -0
  147. package/dist/serialization/resources/components/types/BindCatalogResponse.d.ts +11 -0
  148. package/dist/serialization/resources/components/types/index.d.ts +1 -0
  149. package/dist/serialization/resources/dataexports/client/requests/CreateDataExportRequestBody.d.ts +6 -1
  150. package/dist/serialization/resources/dataexports/types/GetDataExportResponse.d.ts +11 -0
  151. package/dist/serialization/resources/dataexports/types/ListDataExportsParams.d.ts +14 -0
  152. package/dist/serialization/resources/dataexports/types/ListDataExportsResponse.d.ts +12 -0
  153. package/dist/serialization/resources/dataexports/types/index.d.ts +3 -0
  154. package/dist/serialization/resources/index.d.ts +5 -0
  155. package/dist/serialization/resources/licenses/index.d.ts +1 -0
  156. package/dist/serialization/resources/licenses/types/CountLicensesParams.d.ts +13 -0
  157. package/dist/serialization/resources/licenses/types/CountLicensesResponse.d.ts +12 -0
  158. package/dist/serialization/resources/licenses/types/GetSingleLicenseResponse.d.ts +11 -0
  159. package/dist/serialization/resources/licenses/types/ListLicensesParams.d.ts +13 -0
  160. package/dist/serialization/resources/licenses/types/ListLicensesResponse.d.ts +12 -0
  161. package/dist/serialization/resources/licenses/types/index.d.ts +5 -0
  162. package/dist/serialization/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +2 -0
  163. package/dist/serialization/resources/planmigrations/client/requests/PreviewMigrationRequestBody.d.ts +13 -0
  164. package/dist/serialization/resources/planmigrations/client/requests/index.d.ts +1 -0
  165. package/dist/serialization/resources/planmigrations/types/PreviewMigrationResponse.d.ts +11 -0
  166. package/dist/serialization/resources/planmigrations/types/index.d.ts +1 -0
  167. package/dist/serialization/types/AuditLogExportMetadata.d.ts +13 -0
  168. package/dist/serialization/types/BillingCreditGrantZeroedOutReason.d.ts +1 -1
  169. package/dist/serialization/types/CatalogConfigOrderedBundle.d.ts +9 -0
  170. package/dist/serialization/types/CatalogConfigOrderedBundleResponseData.d.ts +9 -0
  171. package/dist/serialization/types/CatalogConfigOrderedEntitlement.d.ts +10 -0
  172. package/dist/serialization/types/CatalogConfigOrderedEntitlementResponseData.d.ts +10 -0
  173. package/dist/serialization/types/CatalogConfigOrderedPlan.d.ts +11 -0
  174. package/dist/serialization/types/CatalogConfigOrderedPlanResponseData.d.ts +11 -0
  175. package/dist/serialization/types/CatalogConfigurationResponseData.d.ts +22 -0
  176. package/dist/serialization/types/CatalogCreditBundleIDsResponseData.d.ts +9 -0
  177. package/dist/serialization/types/CatalogDerivedFeatureResponseData.d.ts +11 -0
  178. package/dist/serialization/types/CatalogDerivedFeaturesResponseData.d.ts +10 -0
  179. package/dist/serialization/types/CatalogPlanIDsResponseData.d.ts +9 -0
  180. package/dist/serialization/types/CatalogResponseData.d.ts +22 -0
  181. package/dist/serialization/types/CompanyBillingAddressView.d.ts +14 -0
  182. package/dist/serialization/types/CompanyBillingCheckoutSettings.d.ts +11 -0
  183. package/dist/serialization/types/CompanyBillingDetailsResponseData.d.ts +16 -0
  184. package/dist/serialization/types/CompanyBillingDetailsView.d.ts +16 -0
  185. package/dist/serialization/types/CompanyFeatureUsageExportMetadata.d.ts +25 -0
  186. package/dist/serialization/types/CompanyPlanDetailResponseData.d.ts +2 -0
  187. package/dist/serialization/types/ComponentResponseData.d.ts +1 -0
  188. package/dist/serialization/types/CreateEntitlementInBundleRequestBody.d.ts +2 -0
  189. package/dist/serialization/types/CreditsAutoTopupSuccess.d.ts +14 -0
  190. package/dist/serialization/types/CreditsCreditPurchaseSuccess.d.ts +16 -0
  191. package/dist/serialization/types/CreditsWebhookCompanySummary.d.ts +10 -0
  192. package/dist/serialization/types/CreditsWebhookCreditSummary.d.ts +10 -0
  193. package/dist/serialization/types/CustomerBillingAddress.d.ts +14 -0
  194. package/dist/serialization/types/DataExportMetadata.d.ts +15 -0
  195. package/dist/serialization/types/DataExportOutputFileType.d.ts +1 -1
  196. package/dist/serialization/types/DataExportResponseData.d.ts +2 -1
  197. package/dist/serialization/types/DataExportType.d.ts +1 -1
  198. package/dist/serialization/types/FeatureDetailResponseData.d.ts +4 -0
  199. package/dist/serialization/types/FeatureEntitlement.d.ts +2 -0
  200. package/dist/serialization/types/FeatureInPlanResponseData.d.ts +2 -0
  201. package/dist/serialization/types/FeatureResponseData.d.ts +2 -0
  202. package/dist/serialization/types/FeatureType.d.ts +1 -1
  203. package/dist/serialization/types/FeatureView.d.ts +3 -0
  204. package/dist/serialization/types/LicenseResponseData.d.ts +12 -0
  205. package/dist/serialization/types/PlanCatalogMembershipResponseData.d.ts +10 -0
  206. package/dist/serialization/types/PlanDetailResponseData.d.ts +2 -0
  207. package/dist/serialization/types/PlanGroupPlanDetailResponseData.d.ts +2 -0
  208. package/dist/serialization/types/PlanVersionMigrationPreviewCompanyResponseData.d.ts +14 -0
  209. package/dist/serialization/types/PlanVersionMigrationPreviewResponseData.d.ts +10 -0
  210. package/dist/serialization/types/PlanViewPublicResponseData.d.ts +2 -0
  211. package/dist/serialization/types/PreviewSubscriptionDiscountResponseData.d.ts +19 -0
  212. package/dist/serialization/types/PreviewSubscriptionFinanceResponseData.d.ts +3 -0
  213. package/dist/serialization/types/RulesengineFeatureEntitlement.d.ts +2 -0
  214. package/dist/serialization/types/RulesengineWarningTier.d.ts +10 -0
  215. package/dist/serialization/types/UpsertCompanyRequestBody.d.ts +2 -0
  216. package/dist/serialization/types/WarningTier.d.ts +10 -0
  217. package/dist/serialization/types/WebhookRequestType.d.ts +1 -1
  218. package/dist/serialization/types/index.d.ts +31 -0
  219. package/package.json +1 -1
@@ -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.
@@ -0,0 +1,7 @@
1
+ /**
2
+ * @example
3
+ * {}
4
+ */
5
+ export interface BindCatalogRequestBody {
6
+ catalogId?: string;
7
+ }
@@ -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";
@@ -0,0 +1,6 @@
1
+ import type * as Schematic from "../../../index";
2
+ export interface BindCatalogResponse {
3
+ data: Schematic.ComponentResponseData;
4
+ /** Input parameters */
5
+ params: Record<string, unknown>;
6
+ }
@@ -1,3 +1,4 @@
1
+ export * from "./BindCatalogResponse";
1
2
  export * from "./CountComponentsParams";
2
3
  export * from "./CountComponentsResponse";
3
4
  export * from "./CreateComponentResponse";
@@ -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
- * metadata: "metadata"
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
- * metadata: "metadata"
5
+ * exportType: "audit-log",
6
+ * outputFileType: "csv"
5
7
  * }
6
8
  */
7
9
  export interface CreateDataExportRequestBody {
8
- metadata: string;
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
+ }
@@ -1 +1,2 @@
1
1
  export type { CreateDataExportRequestBody } from "./CreateDataExportRequestBody";
2
+ export type { ListDataExportsRequest } from "./ListDataExportsRequest";
@@ -0,0 +1,6 @@
1
+ import type * as Schematic from "../../../index";
2
+ export interface GetDataExportResponse {
3
+ data: Schematic.DataExportResponseData;
4
+ /** Input parameters */
5
+ params: Record<string, unknown>;
6
+ }
@@ -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
+ }
@@ -0,0 +1,6 @@
1
+ import type * as Schematic from "../../../index";
2
+ export interface ListDataExportsResponse {
3
+ data: Schematic.DataExportResponseData[];
4
+ /** Input parameters */
5
+ params: Schematic.ListDataExportsParams;
6
+ }
@@ -1 +1,4 @@
1
1
  export * from "./CreateDataExportResponse";
2
+ export * from "./GetDataExportResponse";
3
+ export * from "./ListDataExportsParams";
4
+ export * from "./ListDataExportsResponse";
@@ -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";
@@ -39,6 +42,9 @@ export * from "./insights/types";
39
42
  export * as integrationsapi from "./integrationsapi";
40
43
  export * from "./integrationsapi/client/requests";
41
44
  export * from "./integrationsapi/types";
45
+ export * as licenses from "./licenses";
46
+ export * from "./licenses/client/requests";
47
+ export * from "./licenses/types";
42
48
  export * as planbundle from "./planbundle";
43
49
  export * from "./planbundle/client/requests";
44
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
+ }
@@ -0,0 +1,2 @@
1
+ export type { CountLicensesRequest } from "./CountLicensesRequest";
2
+ export type { ListLicensesRequest } from "./ListLicensesRequest";
@@ -0,0 +1,2 @@
1
+ export { LicensesClient } from "./client/Client";
2
+ export * from "./client/index";
@@ -0,0 +1,2 @@
1
+ export * from "./client";
2
+ export * from "./types";
@@ -0,0 +1,12 @@
1
+ /**
2
+ * Input parameters
3
+ */
4
+ export interface CountLicensesParams {
5
+ featureIds?: string[];
6
+ ids?: string[];
7
+ /** Page limit (default 100) */
8
+ limit?: number;
9
+ name?: string;
10
+ /** Page offset (default 0) */
11
+ offset?: number;
12
+ }
@@ -0,0 +1,6 @@
1
+ import type * as Schematic from "../../../index";
2
+ export interface CountLicensesResponse {
3
+ data: Schematic.CountResponse;
4
+ /** Input parameters */
5
+ params: Schematic.CountLicensesParams;
6
+ }
@@ -0,0 +1,6 @@
1
+ import type * as Schematic from "../../../index";
2
+ export interface GetSingleLicenseResponse {
3
+ data: Schematic.LicenseResponseData;
4
+ /** Input parameters */
5
+ params: Record<string, unknown>;
6
+ }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * Input parameters
3
+ */
4
+ export interface ListLicensesParams {
5
+ featureIds?: string[];
6
+ ids?: string[];
7
+ /** Page limit (default 100) */
8
+ limit?: number;
9
+ name?: string;
10
+ /** Page offset (default 0) */
11
+ offset?: number;
12
+ }
@@ -0,0 +1,6 @@
1
+ import type * as Schematic from "../../../index";
2
+ export interface ListLicensesResponse {
3
+ data: Schematic.LicenseResponseData[];
4
+ /** Input parameters */
5
+ params: Schematic.ListLicensesParams;
6
+ }
@@ -0,0 +1,5 @@
1
+ export * from "./CountLicensesParams";
2
+ export * from "./CountLicensesResponse";
3
+ export * from "./GetSingleLicenseResponse";
4
+ export * from "./ListLicensesParams";
5
+ export * from "./ListLicensesResponse";
@@ -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
  }
@@ -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";
@@ -0,0 +1,6 @@
1
+ import type * as Schematic from "../../../index";
2
+ export interface PreviewMigrationResponse {
3
+ data: Schematic.PlanVersionMigrationPreviewResponseData;
4
+ /** Input parameters */
5
+ params: Record<string, unknown>;
6
+ }
@@ -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";
@@ -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
+ }
@@ -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,3 @@
1
+ export interface CatalogConfigOrderedBundle {
2
+ bundleId: string;
3
+ }
@@ -0,0 +1,3 @@
1
+ export interface CatalogConfigOrderedBundleResponseData {
2
+ bundleId: string;
3
+ }
@@ -0,0 +1,4 @@
1
+ export interface CatalogConfigOrderedEntitlement {
2
+ planEntitlementId: string;
3
+ visible?: boolean;
4
+ }
@@ -0,0 +1,4 @@
1
+ export interface CatalogConfigOrderedEntitlementResponseData {
2
+ planEntitlementId: string;
3
+ visible: boolean;
4
+ }
@@ -0,0 +1,5 @@
1
+ import type * as Schematic from "../index";
2
+ export interface CatalogConfigOrderedPlan {
3
+ entitlements?: Schematic.CatalogConfigOrderedEntitlement[];
4
+ planId: string;
5
+ }
@@ -0,0 +1,5 @@
1
+ import type * as Schematic from "../index";
2
+ export interface CatalogConfigOrderedPlanResponseData {
3
+ entitlements: Schematic.CatalogConfigOrderedEntitlementResponseData[];
4
+ planId: string;
5
+ }
@@ -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,3 @@
1
+ export interface CatalogCreditBundleIDsResponseData {
2
+ creditBundleIds: string[];
3
+ }
@@ -0,0 +1,5 @@
1
+ export interface CatalogDerivedFeatureResponseData {
2
+ icon: string;
3
+ id: string;
4
+ name: string;
5
+ }
@@ -0,0 +1,4 @@
1
+ import type * as Schematic from "../index";
2
+ export interface CatalogDerivedFeaturesResponseData {
3
+ features: Schematic.CatalogDerivedFeatureResponseData[];
4
+ }
@@ -0,0 +1,3 @@
1
+ export interface CatalogPlanIDsResponseData {
2
+ planIds: string[];
3
+ }
@@ -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
+ }
@@ -0,0 +1,8 @@
1
+ export interface CompanyBillingAddressView {
2
+ city: string;
3
+ country: string;
4
+ line1: string;
5
+ line2: string;
6
+ postalCode: string;
7
+ state: string;
8
+ }
@@ -0,0 +1,5 @@
1
+ export interface CompanyBillingCheckoutSettings {
2
+ collectAddress: boolean;
3
+ collectEmail: boolean;
4
+ collectPhone: boolean;
5
+ }
@@ -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
+ }