@schematichq/schematic-typescript-node 1.1.10 → 1.1.12
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/Client.d.ts +6 -0
- package/Client.js +30 -20
- package/README.md +2 -0
- package/api/errors/BadRequestError.d.ts +2 -1
- package/api/errors/BadRequestError.js +2 -1
- package/api/errors/ForbiddenError.d.ts +2 -1
- package/api/errors/ForbiddenError.js +2 -1
- package/api/errors/InternalServerError.d.ts +2 -1
- package/api/errors/InternalServerError.js +2 -1
- package/api/errors/NotFoundError.d.ts +2 -1
- package/api/errors/NotFoundError.js +2 -1
- package/api/errors/UnauthorizedError.d.ts +2 -1
- package/api/errors/UnauthorizedError.js +2 -1
- package/api/errors/index.d.ts +1 -1
- package/api/errors/index.js +1 -1
- package/api/resources/accesstokens/client/Client.d.ts +4 -3
- package/api/resources/accesstokens/client/Client.js +33 -16
- package/api/resources/accesstokens/client/requests/IssueTemporaryAccessTokenRequestBody.d.ts +1 -3
- package/api/resources/accounts/client/Client.d.ts +51 -14
- package/api/resources/accounts/client/Client.js +489 -175
- package/api/resources/accounts/types/QuickstartResponse.d.ts +9 -0
- package/api/resources/accounts/types/index.d.ts +1 -0
- package/api/resources/accounts/types/index.js +1 -0
- package/api/resources/billing/client/Client.d.ts +64 -26
- package/api/resources/billing/client/Client.js +657 -260
- package/api/resources/billing/client/requests/CountBillingProductsRequest.d.ts +8 -0
- package/api/resources/billing/client/requests/CountCustomersRequest.d.ts +1 -0
- package/api/resources/billing/client/requests/CreateBillingPriceRequestBody.d.ts +5 -1
- package/api/resources/billing/client/requests/CreateBillingProductRequestBody.d.ts +2 -7
- package/api/resources/billing/client/requests/ListBillingProductsRequest.d.ts +8 -0
- package/api/resources/billing/client/requests/{ListCustomersRequest.d.ts → ListCustomersWithSubscriptionsRequest.d.ts} +2 -1
- package/api/resources/billing/client/requests/ListProductPricesRequest.d.ts +8 -0
- package/api/resources/billing/client/requests/SearchBillingPricesRequest.d.ts +1 -0
- package/api/resources/billing/client/requests/index.d.ts +1 -1
- package/api/resources/billing/types/CountBillingProductsParams.d.ts +4 -0
- package/api/resources/billing/types/CountCustomersParams.d.ts +1 -0
- package/api/resources/billing/types/CreateBillingPriceRequestBodyBillingScheme.d.ts +8 -0
- package/api/resources/billing/types/CreateBillingPriceRequestBodyBillingScheme.js +10 -0
- package/api/resources/billing/types/CreateBillingPriceRequestBodyTiersMode.d.ts +8 -0
- package/api/resources/billing/types/CreateBillingPriceRequestBodyTiersMode.js +10 -0
- package/api/resources/billing/types/ListBillingProductsParams.d.ts +4 -0
- package/api/resources/billing/types/{ListCustomersParams.d.ts → ListCustomersWithSubscriptionsParams.d.ts} +2 -1
- package/{dist/api/resources/billing/types/ListCustomersResponse.d.ts → api/resources/billing/types/ListCustomersWithSubscriptionsResponse.d.ts} +2 -2
- package/api/resources/billing/types/ListProductPricesParams.d.ts +4 -0
- package/api/resources/billing/types/SearchBillingPricesParams.d.ts +1 -0
- package/{dist/api/resources/billing/types/CreateBillingPriceRequestBodyTierMode.d.ts → api/resources/billing/types/SearchBillingPricesRequestTiersMode.d.ts} +2 -2
- package/{dist/api/resources/billing/types/CreateBillingPriceRequestBodyTierMode.js → api/resources/billing/types/SearchBillingPricesRequestTiersMode.js} +2 -2
- package/api/resources/billing/types/SearchBillingPricesResponseParamsTiersMode.d.ts +8 -0
- package/api/resources/billing/types/SearchBillingPricesResponseParamsTiersMode.js +10 -0
- package/api/resources/billing/types/index.d.ts +6 -3
- package/api/resources/billing/types/index.js +6 -3
- package/api/resources/checkout/client/Client.d.ts +23 -6
- package/api/resources/checkout/client/Client.js +125 -52
- package/api/resources/companies/client/Client.d.ts +119 -43
- package/api/resources/companies/client/Client.js +1306 -434
- package/api/resources/companies/client/requests/CountCompaniesForAdvancedFilterRequest.d.ts +66 -0
- package/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +4 -0
- package/api/resources/companies/client/requests/ListCompaniesForAdvancedFilterRequest.d.ts +66 -0
- package/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +4 -0
- package/api/resources/companies/client/requests/LookupCompanyRequest.d.ts +2 -4
- package/api/resources/companies/client/requests/LookupUserRequest.d.ts +2 -4
- package/api/resources/companies/client/requests/index.d.ts +2 -0
- package/api/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +37 -0
- package/api/resources/companies/types/CountCompaniesForAdvancedFilterParams.js +5 -0
- package/api/resources/companies/types/CountCompaniesForAdvancedFilterRequestSortOrderDirection.d.ts +11 -0
- package/api/resources/companies/types/CountCompaniesForAdvancedFilterRequestSortOrderDirection.js +10 -0
- package/api/resources/companies/types/CountCompaniesForAdvancedFilterResponse.d.ts +9 -0
- package/api/resources/companies/types/CountCompaniesForAdvancedFilterResponse.js +5 -0
- package/api/resources/companies/types/CountCompaniesForAdvancedFilterResponseParamsSortOrderDirection.d.ts +11 -0
- package/api/resources/companies/types/CountCompaniesForAdvancedFilterResponseParamsSortOrderDirection.js +10 -0
- package/api/resources/companies/types/CountCompaniesParams.d.ts +2 -0
- package/api/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +37 -0
- package/api/resources/companies/types/ListCompaniesForAdvancedFilterParams.js +5 -0
- package/api/resources/companies/types/ListCompaniesForAdvancedFilterRequestSortOrderDirection.d.ts +11 -0
- package/api/resources/companies/types/ListCompaniesForAdvancedFilterRequestSortOrderDirection.js +10 -0
- package/api/resources/companies/types/ListCompaniesForAdvancedFilterResponse.d.ts +10 -0
- package/api/resources/companies/types/ListCompaniesForAdvancedFilterResponse.js +5 -0
- package/api/resources/companies/types/ListCompaniesForAdvancedFilterResponseParamsSortOrderDirection.d.ts +11 -0
- package/api/resources/companies/types/ListCompaniesForAdvancedFilterResponseParamsSortOrderDirection.js +10 -0
- package/api/resources/companies/types/ListCompaniesParams.d.ts +2 -0
- package/api/resources/companies/types/LookupCompanyParams.d.ts +1 -1
- package/api/resources/companies/types/LookupUserParams.d.ts +1 -1
- package/api/resources/companies/types/index.d.ts +8 -0
- package/api/resources/companies/types/index.js +8 -0
- package/api/resources/components/client/Client.d.ts +18 -7
- package/api/resources/components/client/Client.js +188 -89
- package/api/resources/credits/client/Client.d.ts +338 -0
- package/api/resources/credits/client/Client.js +2338 -0
- package/api/resources/credits/client/index.d.ts +1 -0
- package/api/resources/credits/client/index.js +17 -0
- package/api/resources/credits/client/requests/CountBillingCreditsGrantsRequest.d.ts +19 -0
- package/api/resources/credits/client/requests/CountBillingCreditsGrantsRequest.js +5 -0
- package/api/resources/credits/client/requests/CountBillingCreditsRequest.d.ts +19 -0
- package/api/resources/credits/client/requests/CountBillingCreditsRequest.js +5 -0
- package/api/resources/credits/client/requests/CountBillingPlanCreditGrantsRequest.d.ts +20 -0
- package/api/resources/credits/client/requests/CountBillingPlanCreditGrantsRequest.js +5 -0
- package/api/resources/credits/client/requests/CountCreditBundlesRequest.d.ts +22 -0
- package/api/resources/credits/client/requests/CountCreditBundlesRequest.js +5 -0
- package/api/resources/credits/client/requests/CreateBillingCreditRequestBody.d.ts +26 -0
- package/api/resources/credits/client/requests/CreateBillingCreditRequestBody.js +5 -0
- package/api/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.d.ts +21 -0
- package/api/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.js +5 -0
- package/api/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +24 -0
- package/api/resources/credits/client/requests/CreateCreditBundleRequestBody.js +5 -0
- package/api/resources/credits/client/requests/ListBillingCreditsRequest.d.ts +19 -0
- package/api/resources/credits/client/requests/ListBillingCreditsRequest.js +5 -0
- package/api/resources/credits/client/requests/ListBillingPlanCreditGrantsRequest.d.ts +20 -0
- package/api/resources/credits/client/requests/ListBillingPlanCreditGrantsRequest.js +5 -0
- package/api/resources/credits/client/requests/ListCompanyGrantsRequest.d.ts +21 -0
- package/api/resources/credits/client/requests/ListCompanyGrantsRequest.js +5 -0
- package/api/resources/credits/client/requests/ListCreditBundlesRequest.d.ts +22 -0
- package/api/resources/credits/client/requests/ListCreditBundlesRequest.js +5 -0
- package/api/resources/credits/client/requests/ListGrantsForCreditRequest.d.ts +19 -0
- package/api/resources/credits/client/requests/ListGrantsForCreditRequest.js +5 -0
- package/api/resources/credits/client/requests/UpdateBillingCreditRequestBody.d.ts +24 -0
- package/api/resources/credits/client/requests/UpdateBillingCreditRequestBody.js +5 -0
- package/api/resources/credits/client/requests/ZeroOutGrantRequestBody.d.ts +11 -0
- package/api/resources/credits/client/requests/ZeroOutGrantRequestBody.js +5 -0
- package/api/resources/credits/client/requests/index.d.ts +14 -0
- package/api/resources/credits/client/requests/index.js +2 -0
- package/api/resources/credits/index.d.ts +2 -0
- package/api/resources/credits/index.js +18 -0
- package/api/resources/credits/types/CountBillingCreditsGrantsParams.d.ts +14 -0
- package/api/resources/credits/types/CountBillingCreditsGrantsParams.js +5 -0
- package/api/resources/credits/types/CountBillingCreditsGrantsResponse.d.ts +9 -0
- package/api/resources/credits/types/CountBillingCreditsGrantsResponse.js +5 -0
- package/api/resources/credits/types/CountBillingCreditsParams.d.ts +14 -0
- package/api/resources/credits/types/CountBillingCreditsParams.js +5 -0
- package/api/resources/credits/types/CountBillingCreditsResponse.d.ts +9 -0
- package/api/resources/credits/types/CountBillingCreditsResponse.js +5 -0
- package/api/resources/credits/types/CountBillingPlanCreditGrantsParams.d.ts +15 -0
- package/api/resources/credits/types/CountBillingPlanCreditGrantsParams.js +5 -0
- package/api/resources/credits/types/CountBillingPlanCreditGrantsResponse.d.ts +9 -0
- package/api/resources/credits/types/CountBillingPlanCreditGrantsResponse.js +5 -0
- package/api/resources/credits/types/CountCreditBundlesParams.d.ts +17 -0
- package/api/resources/credits/types/CountCreditBundlesParams.js +5 -0
- package/api/resources/credits/types/CountCreditBundlesRequestStatus.d.ts +8 -0
- package/api/resources/credits/types/CountCreditBundlesRequestStatus.js +10 -0
- package/api/resources/credits/types/CountCreditBundlesResponse.d.ts +9 -0
- package/api/resources/credits/types/CountCreditBundlesResponse.js +5 -0
- package/api/resources/credits/types/CountCreditBundlesResponseParamsStatus.d.ts +8 -0
- package/api/resources/credits/types/CountCreditBundlesResponseParamsStatus.js +10 -0
- package/api/resources/credits/types/CreateBillingCreditRequestBodyBurnStrategy.d.ts +10 -0
- package/api/resources/credits/types/CreateBillingCreditRequestBodyBurnStrategy.js +12 -0
- package/api/resources/credits/types/CreateBillingCreditRequestBodyDefaultRolloverPolicy.d.ts +9 -0
- package/api/resources/credits/types/CreateBillingCreditRequestBodyDefaultRolloverPolicy.js +11 -0
- package/api/resources/credits/types/CreateBillingCreditResponse.d.ts +9 -0
- package/api/resources/credits/types/CreateBillingCreditResponse.js +5 -0
- package/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetCadence.d.ts +10 -0
- package/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetCadence.js +12 -0
- package/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetStart.d.ts +8 -0
- package/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetStart.js +10 -0
- package/api/resources/credits/types/CreateBillingPlanCreditGrantResponse.d.ts +9 -0
- package/api/resources/credits/types/CreateBillingPlanCreditGrantResponse.js +5 -0
- package/api/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.d.ts +8 -0
- package/api/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.js +10 -0
- package/api/resources/credits/types/CreateCreditBundleRequestBodyStatus.d.ts +8 -0
- package/api/resources/credits/types/CreateCreditBundleRequestBodyStatus.js +10 -0
- package/api/resources/credits/types/CreateCreditBundleResponse.d.ts +9 -0
- package/api/resources/credits/types/CreateCreditBundleResponse.js +5 -0
- package/api/resources/credits/types/DeleteBillingPlanCreditGrantResponse.d.ts +9 -0
- package/api/resources/credits/types/DeleteBillingPlanCreditGrantResponse.js +5 -0
- package/api/resources/credits/types/DeleteCreditBundleResponse.d.ts +9 -0
- package/api/resources/credits/types/DeleteCreditBundleResponse.js +5 -0
- package/api/resources/credits/types/GetCreditBundleResponse.d.ts +9 -0
- package/api/resources/credits/types/GetCreditBundleResponse.js +5 -0
- package/api/resources/credits/types/GetSingleBillingCreditResponse.d.ts +9 -0
- package/api/resources/credits/types/GetSingleBillingCreditResponse.js +5 -0
- package/api/resources/credits/types/ListBillingCreditsParams.d.ts +14 -0
- package/api/resources/credits/types/ListBillingCreditsParams.js +5 -0
- package/api/resources/credits/types/ListBillingCreditsResponse.d.ts +10 -0
- package/api/resources/credits/types/ListBillingCreditsResponse.js +5 -0
- package/api/resources/credits/types/ListBillingPlanCreditGrantsParams.d.ts +15 -0
- package/api/resources/credits/types/ListBillingPlanCreditGrantsParams.js +5 -0
- package/api/resources/credits/types/ListBillingPlanCreditGrantsResponse.d.ts +10 -0
- package/api/resources/credits/types/ListBillingPlanCreditGrantsResponse.js +5 -0
- package/api/resources/credits/types/ListCompanyGrantsParams.d.ts +16 -0
- package/api/resources/credits/types/ListCompanyGrantsParams.js +5 -0
- package/api/resources/credits/types/ListCompanyGrantsRequestDir.d.ts +8 -0
- package/api/resources/credits/types/ListCompanyGrantsRequestDir.js +10 -0
- package/api/resources/credits/types/ListCompanyGrantsRequestOrder.d.ts +10 -0
- package/api/resources/credits/types/ListCompanyGrantsRequestOrder.js +12 -0
- package/api/resources/credits/types/ListCompanyGrantsResponse.d.ts +10 -0
- package/api/resources/credits/types/ListCompanyGrantsResponse.js +5 -0
- package/api/resources/credits/types/ListCompanyGrantsResponseParamsDir.d.ts +8 -0
- package/api/resources/credits/types/ListCompanyGrantsResponseParamsDir.js +10 -0
- package/api/resources/credits/types/ListCompanyGrantsResponseParamsOrder.d.ts +10 -0
- package/api/resources/credits/types/ListCompanyGrantsResponseParamsOrder.js +12 -0
- package/api/resources/credits/types/ListCreditBundlesParams.d.ts +17 -0
- package/api/resources/credits/types/ListCreditBundlesParams.js +5 -0
- package/api/resources/credits/types/ListCreditBundlesRequestStatus.d.ts +8 -0
- package/api/resources/credits/types/ListCreditBundlesRequestStatus.js +10 -0
- package/api/resources/credits/types/ListCreditBundlesResponse.d.ts +10 -0
- package/api/resources/credits/types/ListCreditBundlesResponse.js +5 -0
- package/api/resources/credits/types/ListCreditBundlesResponseParamsStatus.d.ts +8 -0
- package/api/resources/credits/types/ListCreditBundlesResponseParamsStatus.js +10 -0
- package/api/resources/credits/types/ListGrantsForCreditParams.d.ts +14 -0
- package/api/resources/credits/types/ListGrantsForCreditParams.js +5 -0
- package/api/resources/credits/types/ListGrantsForCreditResponse.d.ts +10 -0
- package/api/resources/credits/types/ListGrantsForCreditResponse.js +5 -0
- package/api/resources/credits/types/UpdateBillingCreditRequestBodyBurnStrategy.d.ts +10 -0
- package/api/resources/credits/types/UpdateBillingCreditRequestBodyBurnStrategy.js +12 -0
- package/api/resources/credits/types/UpdateBillingCreditRequestBodyDefaultRolloverPolicy.d.ts +9 -0
- package/api/resources/credits/types/UpdateBillingCreditRequestBodyDefaultRolloverPolicy.js +11 -0
- package/api/resources/credits/types/UpdateBillingCreditResponse.d.ts +9 -0
- package/api/resources/credits/types/UpdateBillingCreditResponse.js +5 -0
- package/api/resources/credits/types/UpdateCreditBundleResponse.d.ts +9 -0
- package/api/resources/credits/types/UpdateCreditBundleResponse.js +5 -0
- package/api/resources/credits/types/ZeroOutGrantRequestBodyReason.d.ts +8 -0
- package/api/resources/credits/types/ZeroOutGrantRequestBodyReason.js +10 -0
- package/api/resources/credits/types/ZeroOutGrantResponse.d.ts +9 -0
- package/api/resources/credits/types/ZeroOutGrantResponse.js +5 -0
- package/api/resources/credits/types/index.d.ts +45 -0
- package/api/resources/credits/types/index.js +61 -0
- package/api/resources/crm/client/Client.d.ts +15 -5
- package/api/resources/crm/client/Client.js +151 -61
- package/api/resources/dataexports/client/Client.d.ts +58 -0
- package/api/resources/dataexports/client/Client.js +265 -0
- package/api/resources/dataexports/client/index.d.ts +1 -0
- package/api/resources/dataexports/client/index.js +17 -0
- package/api/resources/dataexports/client/requests/CreateDataExportRequestBody.d.ts +12 -0
- package/api/resources/dataexports/client/requests/CreateDataExportRequestBody.js +5 -0
- package/api/resources/dataexports/client/requests/index.d.ts +1 -0
- package/api/resources/dataexports/client/requests/index.js +2 -0
- package/api/resources/dataexports/index.d.ts +2 -0
- package/api/resources/dataexports/index.js +18 -0
- package/api/resources/dataexports/types/CreateDataExportResponse.d.ts +9 -0
- package/api/resources/dataexports/types/CreateDataExportResponse.js +5 -0
- package/api/resources/dataexports/types/index.d.ts +1 -0
- package/api/resources/dataexports/types/index.js +17 -0
- package/api/resources/entitlements/client/Client.d.ts +57 -22
- package/api/resources/entitlements/client/Client.js +538 -239
- package/api/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +1 -0
- package/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +13 -1
- package/api/resources/entitlements/client/requests/GetFeatureUsageByCompanyRequest.d.ts +2 -4
- package/api/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +1 -0
- package/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +13 -1
- package/api/resources/entitlements/types/CreateCompanyOverrideRequestBodyValueType.d.ts +2 -1
- package/api/resources/entitlements/types/CreateCompanyOverrideRequestBodyValueType.js +1 -0
- package/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyPriceBehavior.d.ts +11 -0
- package/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyPriceBehavior.js +13 -0
- package/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyValueType.d.ts +2 -1
- package/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyValueType.js +1 -0
- package/api/resources/entitlements/types/GetFeatureUsageByCompanyParams.d.ts +1 -1
- package/api/resources/entitlements/types/UpdateCompanyOverrideRequestBodyValueType.d.ts +2 -1
- package/api/resources/entitlements/types/UpdateCompanyOverrideRequestBodyValueType.js +1 -0
- package/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyPriceBehavior.d.ts +11 -0
- package/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyPriceBehavior.js +13 -0
- package/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyValueType.d.ts +2 -1
- package/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyValueType.js +1 -0
- package/api/resources/entitlements/types/index.d.ts +2 -0
- package/api/resources/entitlements/types/index.js +2 -0
- package/api/resources/events/client/Client.d.ts +16 -6
- package/api/resources/events/client/Client.js +168 -76
- package/api/resources/events/client/requests/ListEventsRequest.d.ts +2 -1
- package/api/resources/events/types/ListEventsParams.d.ts +2 -1
- package/api/resources/events/types/ListEventsRequestEventTypesItem.d.ts +9 -0
- package/api/resources/events/types/ListEventsRequestEventTypesItem.js +11 -0
- package/api/resources/events/types/ListEventsResponseParamsEventTypesItem.d.ts +9 -0
- package/api/resources/events/types/ListEventsResponseParamsEventTypesItem.js +11 -0
- package/api/resources/events/types/index.d.ts +2 -0
- package/api/resources/events/types/index.js +2 -0
- package/api/resources/features/client/Client.d.ts +54 -21
- package/api/resources/features/client/Client.js +559 -240
- package/api/resources/features/client/requests/CountFeaturesRequest.d.ts +8 -0
- package/api/resources/features/client/requests/CreateFeatureRequestBody.d.ts +1 -1
- package/api/resources/features/client/requests/ListFeaturesRequest.d.ts +8 -0
- package/api/resources/features/client/requests/UpdateFeatureRequestBody.d.ts +1 -1
- package/api/resources/features/types/CountFeaturesParams.d.ts +4 -0
- package/api/resources/features/types/CreateFeatureRequestBodyLifecyclePhase.d.ts +15 -0
- package/api/resources/features/types/CreateFeatureRequestBodyLifecyclePhase.js +17 -0
- package/api/resources/features/types/ListFeaturesParams.d.ts +4 -0
- package/api/resources/features/types/UpdateFeatureRequestBodyLifecyclePhase.d.ts +15 -0
- package/api/resources/features/types/UpdateFeatureRequestBodyLifecyclePhase.js +17 -0
- package/api/resources/features/types/index.d.ts +2 -0
- package/api/resources/features/types/index.js +2 -0
- package/api/resources/index.d.ts +6 -0
- package/api/resources/index.js +7 -1
- package/api/resources/plangroups/client/Client.d.ts +7 -3
- package/api/resources/plangroups/client/Client.js +73 -37
- package/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +1 -0
- package/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +1 -0
- package/api/resources/plans/client/Client.d.ts +125 -12
- package/api/resources/plans/client/Client.js +1011 -172
- package/api/resources/plans/client/requests/CountPlanTraitsRequest.d.ts +20 -0
- package/api/resources/plans/client/requests/CountPlanTraitsRequest.js +5 -0
- package/api/resources/plans/client/requests/CreatePlanTraitRequestBody.d.ts +16 -0
- package/api/resources/plans/client/requests/CreatePlanTraitRequestBody.js +5 -0
- package/api/resources/plans/client/requests/ListPlanTraitsRequest.d.ts +20 -0
- package/api/resources/plans/client/requests/ListPlanTraitsRequest.js +5 -0
- package/api/resources/plans/client/requests/UpdatePlanTraitRequestBody.d.ts +14 -0
- package/api/resources/plans/client/requests/UpdatePlanTraitRequestBody.js +5 -0
- package/api/resources/plans/client/requests/UpsertBillingProductRequestBody.d.ts +8 -2
- package/api/resources/plans/client/requests/index.d.ts +4 -0
- package/api/resources/plans/types/CountPlanTraitsParams.d.ts +15 -0
- package/api/resources/plans/types/CountPlanTraitsParams.js +5 -0
- package/api/resources/plans/types/CountPlanTraitsResponse.d.ts +9 -0
- package/api/resources/plans/types/CountPlanTraitsResponse.js +5 -0
- package/api/resources/plans/types/CreatePlanTraitResponse.d.ts +9 -0
- package/api/resources/plans/types/CreatePlanTraitResponse.js +5 -0
- package/api/resources/plans/types/DeletePlanTraitResponse.d.ts +9 -0
- package/api/resources/plans/types/DeletePlanTraitResponse.js +5 -0
- package/api/resources/plans/types/GetPlanTraitResponse.d.ts +9 -0
- package/api/resources/plans/types/GetPlanTraitResponse.js +5 -0
- package/api/resources/plans/types/ListPlanTraitsParams.d.ts +15 -0
- package/api/resources/plans/types/ListPlanTraitsParams.js +5 -0
- package/api/resources/plans/types/ListPlanTraitsResponse.d.ts +10 -0
- package/api/resources/plans/types/ListPlanTraitsResponse.js +5 -0
- package/api/resources/plans/types/UpdatePlanTraitResponse.d.ts +9 -0
- package/api/resources/plans/types/UpdatePlanTraitResponse.js +5 -0
- package/api/resources/plans/types/UpsertBillingProductRequestBodyChargeType.d.ts +9 -0
- package/api/resources/plans/types/UpsertBillingProductRequestBodyChargeType.js +11 -0
- package/api/resources/plans/types/index.d.ts +9 -0
- package/api/resources/plans/types/index.js +9 -0
- package/api/resources/webhooks/client/Client.d.ts +24 -9
- package/api/resources/webhooks/client/Client.js +249 -114
- package/api/resources/webhooks/client/requests/CreateWebhookRequestBody.d.ts +1 -0
- package/api/resources/webhooks/client/requests/UpdateWebhookRequestBody.d.ts +1 -0
- package/api/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.d.ts +5 -1
- package/api/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.js +4 -0
- package/api/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.d.ts +5 -1
- package/api/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.js +4 -0
- package/api/types/BillingCreditBundleResponseData.d.ts +18 -0
- package/api/types/BillingCreditBundleResponseData.js +5 -0
- package/api/types/BillingCreditGrantResponseData.d.ts +23 -0
- package/api/types/BillingCreditGrantResponseData.js +5 -0
- package/api/types/BillingCreditResponseData.d.ts +21 -0
- package/api/types/BillingCreditResponseData.js +5 -0
- package/api/types/BillingPlanCreditGrantResponseData.d.ts +14 -0
- package/api/types/BillingPlanCreditGrantResponseData.js +5 -0
- package/api/types/BillingPriceResponseData.d.ts +2 -0
- package/api/types/BillingPriceView.d.ts +8 -0
- package/api/types/BillingProductDetailResponseData.d.ts +2 -0
- package/api/types/BillingProductForSubscriptionResponseData.d.ts +5 -0
- package/api/types/BillingProductPlanResponseData.d.ts +3 -0
- package/api/types/BillingProductPriceResponseData.d.ts +4 -0
- package/api/types/BillingProductPriceTierResponseData.d.ts +9 -0
- package/api/types/BillingProductPriceTierResponseData.js +5 -0
- package/api/types/BillingProductPricing.d.ts +2 -0
- package/api/types/BillingProductResponseData.d.ts +2 -0
- package/api/types/ChangeSubscriptionInternalRequestBody.d.ts +2 -0
- package/api/types/ChangeSubscriptionRequestBody.d.ts +2 -0
- package/api/types/CheckFlagResponseData.d.ts +2 -0
- package/api/types/CheckoutDataResponseData.d.ts +2 -0
- package/api/types/CompanyDetailResponseData.d.ts +1 -0
- package/api/types/CompanyOverrideResponseData.d.ts +1 -0
- package/api/types/CompanyPlanDetailResponseData.d.ts +4 -0
- package/api/types/CompanyPlanWithBillingSubView.d.ts +2 -0
- package/api/types/CompanyViewWithFeatureUsageResponseData.d.ts +27 -0
- package/api/types/CompanyViewWithFeatureUsageResponseData.js +5 -0
- package/api/types/CompatiblePlans.d.ts +7 -0
- package/api/types/CompatiblePlans.js +5 -0
- package/api/types/CompatiblePlansResponseData.d.ts +7 -0
- package/api/types/CompatiblePlansResponseData.js +5 -0
- package/api/types/ComponentHydrateResponseData.d.ts +1 -0
- package/api/types/ComponentPreviewResponseData.d.ts +1 -0
- package/api/types/CreateBillingPriceTierRequestBody.d.ts +1 -0
- package/api/types/CreateEntitlementReqCommon.d.ts +1 -0
- package/api/types/CreateEntitlementReqCommonValueType.d.ts +2 -1
- package/api/types/CreateEntitlementReqCommonValueType.js +1 -0
- package/api/types/CreateFlagRequestBody.d.ts +1 -1
- package/api/types/CreateOrUpdateFlagRequestBody.d.ts +1 -1
- package/api/types/CreatePriceTierRequestBody.d.ts +9 -0
- package/api/types/CreatePriceTierRequestBody.js +5 -0
- package/api/types/CreditBundlePurchaseResponseData.d.ts +9 -0
- package/api/types/CreditBundlePurchaseResponseData.js +5 -0
- package/api/types/DataExportResponseData.d.ts +17 -0
- package/api/types/DataExportResponseData.js +5 -0
- package/api/types/EntitlementTriggerConfig.d.ts +6 -0
- package/api/types/EntitlementTriggerConfig.js +5 -0
- package/api/types/EventSummaryResponseData.d.ts +2 -2
- package/api/types/FeatureUsageDataResponseData.d.ts +14 -0
- package/api/types/FeatureUsageDataResponseData.js +5 -0
- package/api/types/PlanDetailResponseData.d.ts +3 -0
- package/api/types/PlanEntitlementResponseData.d.ts +3 -0
- package/api/types/PlanGroupPlanDetailResponseData.d.ts +4 -0
- package/api/types/PlanGroupResponseData.d.ts +1 -0
- package/api/types/PlanTraitResponseData.d.ts +16 -0
- package/api/types/PlanTraitResponseData.js +5 -0
- package/api/types/PreviewSubscriptionChangeResponseData.d.ts +4 -0
- package/api/types/PreviewSubscriptionFinanceResponseData.d.ts +15 -0
- package/api/types/PreviewSubscriptionFinanceResponseData.js +5 -0
- package/api/types/PreviewSubscriptionUpcomingInvoiceLineItems.d.ts +10 -0
- package/api/types/PreviewSubscriptionUpcomingInvoiceLineItems.js +5 -0
- package/api/types/QuickstartResp.d.ts +6 -0
- package/api/types/QuickstartResp.js +5 -0
- package/api/types/UpdateCreditBundleRequestBody.d.ts +7 -0
- package/api/types/UpdateCreditBundleRequestBody.js +5 -0
- package/api/types/UpdateEntitlementReqCommon.d.ts +1 -0
- package/api/types/UpdateEntitlementReqCommonValueType.d.ts +2 -1
- package/api/types/UpdateEntitlementReqCommonValueType.js +1 -0
- package/api/types/UpsertCompanyRequestBody.d.ts +1 -0
- package/api/types/UpsertTraitRequestBody.d.ts +1 -1
- package/api/types/UpsertUserRequestBody.d.ts +8 -3
- package/api/types/UpsertUserSubRequestBody.d.ts +4 -1
- package/api/types/UsageBasedEntitlementRequestBody.d.ts +11 -1
- package/api/types/UsageBasedEntitlementRequestBodyPriceBehavior.d.ts +11 -0
- package/api/types/UsageBasedEntitlementRequestBodyPriceBehavior.js +13 -0
- package/api/types/UsageBasedEntitlementResponseData.d.ts +1 -0
- package/api/types/WebhookResponseData.d.ts +2 -0
- package/api/types/index.d.ts +19 -0
- package/api/types/index.js +19 -0
- package/core/fetcher/APIResponse.d.ts +10 -0
- package/core/fetcher/Fetcher.js +7 -0
- package/core/fetcher/Headers.d.ts +2 -0
- package/core/fetcher/Headers.js +84 -0
- package/core/fetcher/HttpResponsePromise.d.ts +58 -0
- package/core/fetcher/HttpResponsePromise.js +103 -0
- package/core/fetcher/RawResponse.d.ts +29 -0
- package/core/fetcher/RawResponse.js +44 -0
- package/core/fetcher/custom.js +17 -0
- package/core/fetcher/index.d.ts +3 -0
- package/core/fetcher/index.js +7 -1
- package/dist/Client.d.ts +6 -0
- package/dist/Client.js +30 -20
- package/dist/api/errors/BadRequestError.d.ts +2 -1
- package/dist/api/errors/BadRequestError.js +2 -1
- package/dist/api/errors/ForbiddenError.d.ts +2 -1
- package/dist/api/errors/ForbiddenError.js +2 -1
- package/dist/api/errors/InternalServerError.d.ts +2 -1
- package/dist/api/errors/InternalServerError.js +2 -1
- package/dist/api/errors/NotFoundError.d.ts +2 -1
- package/dist/api/errors/NotFoundError.js +2 -1
- package/dist/api/errors/UnauthorizedError.d.ts +2 -1
- package/dist/api/errors/UnauthorizedError.js +2 -1
- package/dist/api/errors/index.d.ts +1 -1
- package/dist/api/errors/index.js +1 -1
- package/dist/api/resources/accesstokens/client/Client.d.ts +4 -3
- package/dist/api/resources/accesstokens/client/Client.js +33 -16
- package/dist/api/resources/accesstokens/client/requests/IssueTemporaryAccessTokenRequestBody.d.ts +1 -3
- package/dist/api/resources/accounts/client/Client.d.ts +51 -14
- package/dist/api/resources/accounts/client/Client.js +489 -175
- package/dist/api/resources/accounts/types/QuickstartResponse.d.ts +9 -0
- package/dist/api/resources/accounts/types/QuickstartResponse.js +5 -0
- package/dist/api/resources/accounts/types/index.d.ts +1 -0
- package/dist/api/resources/accounts/types/index.js +1 -0
- package/dist/api/resources/billing/client/Client.d.ts +64 -26
- package/dist/api/resources/billing/client/Client.js +657 -260
- package/dist/api/resources/billing/client/requests/CountBillingProductsRequest.d.ts +8 -0
- package/dist/api/resources/billing/client/requests/CountCustomersRequest.d.ts +1 -0
- package/dist/api/resources/billing/client/requests/CreateBillingPriceRequestBody.d.ts +5 -1
- package/dist/api/resources/billing/client/requests/CreateBillingProductRequestBody.d.ts +2 -7
- package/dist/api/resources/billing/client/requests/ListBillingProductsRequest.d.ts +8 -0
- package/dist/api/resources/billing/client/requests/{ListCustomersRequest.d.ts → ListCustomersWithSubscriptionsRequest.d.ts} +2 -1
- package/dist/api/resources/billing/client/requests/ListCustomersWithSubscriptionsRequest.js +5 -0
- package/dist/api/resources/billing/client/requests/ListProductPricesRequest.d.ts +8 -0
- package/dist/api/resources/billing/client/requests/SearchBillingPricesRequest.d.ts +1 -0
- package/dist/api/resources/billing/client/requests/index.d.ts +1 -1
- package/dist/api/resources/billing/types/CountBillingProductsParams.d.ts +4 -0
- package/dist/api/resources/billing/types/CountCustomersParams.d.ts +1 -0
- package/dist/api/resources/billing/types/CreateBillingPriceRequestBodyBillingScheme.d.ts +8 -0
- package/dist/api/resources/billing/types/CreateBillingPriceRequestBodyBillingScheme.js +10 -0
- package/dist/api/resources/billing/types/CreateBillingPriceRequestBodyTiersMode.d.ts +8 -0
- package/dist/api/resources/billing/types/CreateBillingPriceRequestBodyTiersMode.js +10 -0
- package/dist/api/resources/billing/types/ListBillingProductsParams.d.ts +4 -0
- package/dist/api/resources/billing/types/{ListCustomersParams.d.ts → ListCustomersWithSubscriptionsParams.d.ts} +2 -1
- package/dist/api/resources/billing/types/ListCustomersWithSubscriptionsParams.js +5 -0
- package/{api/resources/billing/types/ListCustomersResponse.d.ts → dist/api/resources/billing/types/ListCustomersWithSubscriptionsResponse.d.ts} +2 -2
- package/dist/api/resources/billing/types/ListCustomersWithSubscriptionsResponse.js +5 -0
- package/dist/api/resources/billing/types/ListProductPricesParams.d.ts +4 -0
- package/dist/api/resources/billing/types/SearchBillingPricesParams.d.ts +1 -0
- package/{api/resources/billing/types/CreateBillingPriceRequestBodyTierMode.d.ts → dist/api/resources/billing/types/SearchBillingPricesRequestTiersMode.d.ts} +2 -2
- package/{api/resources/billing/types/CreateBillingPriceRequestBodyTierMode.js → dist/api/resources/billing/types/SearchBillingPricesRequestTiersMode.js} +2 -2
- package/dist/api/resources/billing/types/SearchBillingPricesResponseParamsTiersMode.d.ts +8 -0
- package/dist/api/resources/billing/types/SearchBillingPricesResponseParamsTiersMode.js +10 -0
- package/dist/api/resources/billing/types/index.d.ts +6 -3
- package/dist/api/resources/billing/types/index.js +6 -3
- package/dist/api/resources/checkout/client/Client.d.ts +23 -6
- package/dist/api/resources/checkout/client/Client.js +125 -52
- package/dist/api/resources/companies/client/Client.d.ts +119 -43
- package/dist/api/resources/companies/client/Client.js +1306 -434
- package/dist/api/resources/companies/client/requests/CountCompaniesForAdvancedFilterRequest.d.ts +66 -0
- package/dist/api/resources/companies/client/requests/CountCompaniesForAdvancedFilterRequest.js +5 -0
- package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +4 -0
- package/dist/api/resources/companies/client/requests/ListCompaniesForAdvancedFilterRequest.d.ts +66 -0
- package/dist/api/resources/companies/client/requests/ListCompaniesForAdvancedFilterRequest.js +5 -0
- package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +4 -0
- package/dist/api/resources/companies/client/requests/LookupCompanyRequest.d.ts +2 -4
- package/dist/api/resources/companies/client/requests/LookupUserRequest.d.ts +2 -4
- package/dist/api/resources/companies/client/requests/index.d.ts +2 -0
- package/dist/api/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +37 -0
- package/dist/api/resources/companies/types/CountCompaniesForAdvancedFilterParams.js +5 -0
- package/dist/api/resources/companies/types/CountCompaniesForAdvancedFilterRequestSortOrderDirection.d.ts +11 -0
- package/dist/api/resources/companies/types/CountCompaniesForAdvancedFilterRequestSortOrderDirection.js +10 -0
- package/dist/api/resources/companies/types/CountCompaniesForAdvancedFilterResponse.d.ts +9 -0
- package/dist/api/resources/companies/types/CountCompaniesForAdvancedFilterResponse.js +5 -0
- package/dist/api/resources/companies/types/CountCompaniesForAdvancedFilterResponseParamsSortOrderDirection.d.ts +11 -0
- package/dist/api/resources/companies/types/CountCompaniesForAdvancedFilterResponseParamsSortOrderDirection.js +10 -0
- package/dist/api/resources/companies/types/CountCompaniesParams.d.ts +2 -0
- package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +37 -0
- package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterParams.js +5 -0
- package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterRequestSortOrderDirection.d.ts +11 -0
- package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterRequestSortOrderDirection.js +10 -0
- package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterResponse.d.ts +10 -0
- package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterResponse.js +5 -0
- package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterResponseParamsSortOrderDirection.d.ts +11 -0
- package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterResponseParamsSortOrderDirection.js +10 -0
- package/dist/api/resources/companies/types/ListCompaniesParams.d.ts +2 -0
- package/dist/api/resources/companies/types/LookupCompanyParams.d.ts +1 -1
- package/dist/api/resources/companies/types/LookupUserParams.d.ts +1 -1
- package/dist/api/resources/companies/types/index.d.ts +8 -0
- package/dist/api/resources/companies/types/index.js +8 -0
- package/dist/api/resources/components/client/Client.d.ts +18 -7
- package/dist/api/resources/components/client/Client.js +188 -89
- package/dist/api/resources/credits/client/Client.d.ts +338 -0
- package/dist/api/resources/credits/client/Client.js +2338 -0
- package/dist/api/resources/credits/client/index.d.ts +1 -0
- package/dist/api/resources/credits/client/index.js +17 -0
- package/dist/api/resources/credits/client/requests/CountBillingCreditsGrantsRequest.d.ts +19 -0
- package/dist/api/resources/credits/client/requests/CountBillingCreditsGrantsRequest.js +5 -0
- package/dist/api/resources/credits/client/requests/CountBillingCreditsRequest.d.ts +19 -0
- package/dist/api/resources/credits/client/requests/CountBillingCreditsRequest.js +5 -0
- package/dist/api/resources/credits/client/requests/CountBillingPlanCreditGrantsRequest.d.ts +20 -0
- package/dist/api/resources/credits/client/requests/CountBillingPlanCreditGrantsRequest.js +5 -0
- package/dist/api/resources/credits/client/requests/CountCreditBundlesRequest.d.ts +22 -0
- package/dist/api/resources/credits/client/requests/CountCreditBundlesRequest.js +5 -0
- package/dist/api/resources/credits/client/requests/CreateBillingCreditRequestBody.d.ts +26 -0
- package/dist/api/resources/credits/client/requests/CreateBillingCreditRequestBody.js +5 -0
- package/dist/api/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.d.ts +21 -0
- package/dist/api/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.js +5 -0
- package/dist/api/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +24 -0
- package/dist/api/resources/credits/client/requests/CreateCreditBundleRequestBody.js +5 -0
- package/dist/api/resources/credits/client/requests/ListBillingCreditsRequest.d.ts +19 -0
- package/dist/api/resources/credits/client/requests/ListBillingCreditsRequest.js +5 -0
- package/dist/api/resources/credits/client/requests/ListBillingPlanCreditGrantsRequest.d.ts +20 -0
- package/dist/api/resources/credits/client/requests/ListBillingPlanCreditGrantsRequest.js +5 -0
- package/dist/api/resources/credits/client/requests/ListCompanyGrantsRequest.d.ts +21 -0
- package/dist/api/resources/credits/client/requests/ListCompanyGrantsRequest.js +5 -0
- package/dist/api/resources/credits/client/requests/ListCreditBundlesRequest.d.ts +22 -0
- package/dist/api/resources/credits/client/requests/ListCreditBundlesRequest.js +5 -0
- package/dist/api/resources/credits/client/requests/ListGrantsForCreditRequest.d.ts +19 -0
- package/dist/api/resources/credits/client/requests/ListGrantsForCreditRequest.js +5 -0
- package/dist/api/resources/credits/client/requests/UpdateBillingCreditRequestBody.d.ts +24 -0
- package/dist/api/resources/credits/client/requests/UpdateBillingCreditRequestBody.js +5 -0
- package/dist/api/resources/credits/client/requests/ZeroOutGrantRequestBody.d.ts +11 -0
- package/dist/api/resources/credits/client/requests/ZeroOutGrantRequestBody.js +5 -0
- package/dist/api/resources/credits/client/requests/index.d.ts +14 -0
- package/dist/api/resources/credits/client/requests/index.js +2 -0
- package/dist/api/resources/credits/index.d.ts +2 -0
- package/dist/api/resources/credits/index.js +18 -0
- package/dist/api/resources/credits/types/CountBillingCreditsGrantsParams.d.ts +14 -0
- package/dist/api/resources/credits/types/CountBillingCreditsGrantsParams.js +5 -0
- package/dist/api/resources/credits/types/CountBillingCreditsGrantsResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/CountBillingCreditsGrantsResponse.js +5 -0
- package/dist/api/resources/credits/types/CountBillingCreditsParams.d.ts +14 -0
- package/dist/api/resources/credits/types/CountBillingCreditsParams.js +5 -0
- package/dist/api/resources/credits/types/CountBillingCreditsResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/CountBillingCreditsResponse.js +5 -0
- package/dist/api/resources/credits/types/CountBillingPlanCreditGrantsParams.d.ts +15 -0
- package/dist/api/resources/credits/types/CountBillingPlanCreditGrantsParams.js +5 -0
- package/dist/api/resources/credits/types/CountBillingPlanCreditGrantsResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/CountBillingPlanCreditGrantsResponse.js +5 -0
- package/dist/api/resources/credits/types/CountCreditBundlesParams.d.ts +17 -0
- package/dist/api/resources/credits/types/CountCreditBundlesParams.js +5 -0
- package/dist/api/resources/credits/types/CountCreditBundlesRequestStatus.d.ts +8 -0
- package/dist/api/resources/credits/types/CountCreditBundlesRequestStatus.js +10 -0
- package/dist/api/resources/credits/types/CountCreditBundlesResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/CountCreditBundlesResponse.js +5 -0
- package/dist/api/resources/credits/types/CountCreditBundlesResponseParamsStatus.d.ts +8 -0
- package/dist/api/resources/credits/types/CountCreditBundlesResponseParamsStatus.js +10 -0
- package/dist/api/resources/credits/types/CreateBillingCreditRequestBodyBurnStrategy.d.ts +10 -0
- package/dist/api/resources/credits/types/CreateBillingCreditRequestBodyBurnStrategy.js +12 -0
- package/dist/api/resources/credits/types/CreateBillingCreditRequestBodyDefaultRolloverPolicy.d.ts +9 -0
- package/dist/api/resources/credits/types/CreateBillingCreditRequestBodyDefaultRolloverPolicy.js +11 -0
- package/dist/api/resources/credits/types/CreateBillingCreditResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/CreateBillingCreditResponse.js +5 -0
- package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetCadence.d.ts +10 -0
- package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetCadence.js +12 -0
- package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetStart.d.ts +8 -0
- package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetStart.js +10 -0
- package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantResponse.js +5 -0
- package/dist/api/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.d.ts +8 -0
- package/dist/api/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.js +10 -0
- package/dist/api/resources/credits/types/CreateCreditBundleRequestBodyStatus.d.ts +8 -0
- package/dist/api/resources/credits/types/CreateCreditBundleRequestBodyStatus.js +10 -0
- package/dist/api/resources/credits/types/CreateCreditBundleResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/CreateCreditBundleResponse.js +5 -0
- package/dist/api/resources/credits/types/DeleteBillingPlanCreditGrantResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/DeleteBillingPlanCreditGrantResponse.js +5 -0
- package/dist/api/resources/credits/types/DeleteCreditBundleResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/DeleteCreditBundleResponse.js +5 -0
- package/dist/api/resources/credits/types/GetCreditBundleResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/GetCreditBundleResponse.js +5 -0
- package/dist/api/resources/credits/types/GetSingleBillingCreditResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/GetSingleBillingCreditResponse.js +5 -0
- package/dist/api/resources/credits/types/ListBillingCreditsParams.d.ts +14 -0
- package/dist/api/resources/credits/types/ListBillingCreditsParams.js +5 -0
- package/dist/api/resources/credits/types/ListBillingCreditsResponse.d.ts +10 -0
- package/dist/api/resources/credits/types/ListBillingCreditsResponse.js +5 -0
- package/dist/api/resources/credits/types/ListBillingPlanCreditGrantsParams.d.ts +15 -0
- package/dist/api/resources/credits/types/ListBillingPlanCreditGrantsParams.js +5 -0
- package/dist/api/resources/credits/types/ListBillingPlanCreditGrantsResponse.d.ts +10 -0
- package/dist/api/resources/credits/types/ListBillingPlanCreditGrantsResponse.js +5 -0
- package/dist/api/resources/credits/types/ListCompanyGrantsParams.d.ts +16 -0
- package/dist/api/resources/credits/types/ListCompanyGrantsParams.js +5 -0
- package/dist/api/resources/credits/types/ListCompanyGrantsRequestDir.d.ts +8 -0
- package/dist/api/resources/credits/types/ListCompanyGrantsRequestDir.js +10 -0
- package/dist/api/resources/credits/types/ListCompanyGrantsRequestOrder.d.ts +10 -0
- package/dist/api/resources/credits/types/ListCompanyGrantsRequestOrder.js +12 -0
- package/dist/api/resources/credits/types/ListCompanyGrantsResponse.d.ts +10 -0
- package/dist/api/resources/credits/types/ListCompanyGrantsResponse.js +5 -0
- package/dist/api/resources/credits/types/ListCompanyGrantsResponseParamsDir.d.ts +8 -0
- package/dist/api/resources/credits/types/ListCompanyGrantsResponseParamsDir.js +10 -0
- package/dist/api/resources/credits/types/ListCompanyGrantsResponseParamsOrder.d.ts +10 -0
- package/dist/api/resources/credits/types/ListCompanyGrantsResponseParamsOrder.js +12 -0
- package/dist/api/resources/credits/types/ListCreditBundlesParams.d.ts +17 -0
- package/dist/api/resources/credits/types/ListCreditBundlesParams.js +5 -0
- package/dist/api/resources/credits/types/ListCreditBundlesRequestStatus.d.ts +8 -0
- package/dist/api/resources/credits/types/ListCreditBundlesRequestStatus.js +10 -0
- package/dist/api/resources/credits/types/ListCreditBundlesResponse.d.ts +10 -0
- package/dist/api/resources/credits/types/ListCreditBundlesResponse.js +5 -0
- package/dist/api/resources/credits/types/ListCreditBundlesResponseParamsStatus.d.ts +8 -0
- package/dist/api/resources/credits/types/ListCreditBundlesResponseParamsStatus.js +10 -0
- package/dist/api/resources/credits/types/ListGrantsForCreditParams.d.ts +14 -0
- package/dist/api/resources/credits/types/ListGrantsForCreditParams.js +5 -0
- package/dist/api/resources/credits/types/ListGrantsForCreditResponse.d.ts +10 -0
- package/dist/api/resources/credits/types/ListGrantsForCreditResponse.js +5 -0
- package/dist/api/resources/credits/types/UpdateBillingCreditRequestBodyBurnStrategy.d.ts +10 -0
- package/dist/api/resources/credits/types/UpdateBillingCreditRequestBodyBurnStrategy.js +12 -0
- package/dist/api/resources/credits/types/UpdateBillingCreditRequestBodyDefaultRolloverPolicy.d.ts +9 -0
- package/dist/api/resources/credits/types/UpdateBillingCreditRequestBodyDefaultRolloverPolicy.js +11 -0
- package/dist/api/resources/credits/types/UpdateBillingCreditResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/UpdateBillingCreditResponse.js +5 -0
- package/dist/api/resources/credits/types/UpdateCreditBundleResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/UpdateCreditBundleResponse.js +5 -0
- package/dist/api/resources/credits/types/ZeroOutGrantRequestBodyReason.d.ts +8 -0
- package/dist/api/resources/credits/types/ZeroOutGrantRequestBodyReason.js +10 -0
- package/dist/api/resources/credits/types/ZeroOutGrantResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/ZeroOutGrantResponse.js +5 -0
- package/dist/api/resources/credits/types/index.d.ts +45 -0
- package/dist/api/resources/credits/types/index.js +61 -0
- package/dist/api/resources/crm/client/Client.d.ts +15 -5
- package/dist/api/resources/crm/client/Client.js +151 -61
- package/dist/api/resources/dataexports/client/Client.d.ts +58 -0
- package/dist/api/resources/dataexports/client/Client.js +265 -0
- package/dist/api/resources/dataexports/client/index.d.ts +1 -0
- package/dist/api/resources/dataexports/client/index.js +17 -0
- package/dist/api/resources/dataexports/client/requests/CreateDataExportRequestBody.d.ts +12 -0
- package/dist/api/resources/dataexports/client/requests/CreateDataExportRequestBody.js +5 -0
- package/dist/api/resources/dataexports/client/requests/index.d.ts +1 -0
- package/dist/api/resources/dataexports/client/requests/index.js +2 -0
- package/dist/api/resources/dataexports/index.d.ts +2 -0
- package/dist/api/resources/dataexports/index.js +18 -0
- package/dist/api/resources/dataexports/types/CreateDataExportResponse.d.ts +9 -0
- package/dist/api/resources/dataexports/types/CreateDataExportResponse.js +5 -0
- package/dist/api/resources/dataexports/types/index.d.ts +1 -0
- package/dist/api/resources/dataexports/types/index.js +17 -0
- package/dist/api/resources/entitlements/client/Client.d.ts +57 -22
- package/dist/api/resources/entitlements/client/Client.js +538 -239
- package/dist/api/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +1 -0
- package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +13 -1
- package/dist/api/resources/entitlements/client/requests/GetFeatureUsageByCompanyRequest.d.ts +2 -4
- package/dist/api/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +1 -0
- package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +13 -1
- package/dist/api/resources/entitlements/types/CreateCompanyOverrideRequestBodyValueType.d.ts +2 -1
- package/dist/api/resources/entitlements/types/CreateCompanyOverrideRequestBodyValueType.js +1 -0
- package/dist/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyPriceBehavior.d.ts +11 -0
- package/dist/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyPriceBehavior.js +13 -0
- package/dist/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyValueType.d.ts +2 -1
- package/dist/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyValueType.js +1 -0
- package/dist/api/resources/entitlements/types/GetFeatureUsageByCompanyParams.d.ts +1 -1
- package/dist/api/resources/entitlements/types/UpdateCompanyOverrideRequestBodyValueType.d.ts +2 -1
- package/dist/api/resources/entitlements/types/UpdateCompanyOverrideRequestBodyValueType.js +1 -0
- package/dist/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyPriceBehavior.d.ts +11 -0
- package/dist/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyPriceBehavior.js +13 -0
- package/dist/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyValueType.d.ts +2 -1
- package/dist/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyValueType.js +1 -0
- package/dist/api/resources/entitlements/types/index.d.ts +2 -0
- package/dist/api/resources/entitlements/types/index.js +2 -0
- package/dist/api/resources/events/client/Client.d.ts +16 -6
- package/dist/api/resources/events/client/Client.js +168 -76
- package/dist/api/resources/events/client/requests/ListEventsRequest.d.ts +2 -1
- package/dist/api/resources/events/types/ListEventsParams.d.ts +2 -1
- package/dist/api/resources/events/types/ListEventsRequestEventTypesItem.d.ts +9 -0
- package/dist/api/resources/events/types/ListEventsRequestEventTypesItem.js +11 -0
- package/dist/api/resources/events/types/ListEventsResponseParamsEventTypesItem.d.ts +9 -0
- package/dist/api/resources/events/types/ListEventsResponseParamsEventTypesItem.js +11 -0
- package/dist/api/resources/events/types/index.d.ts +2 -0
- package/dist/api/resources/events/types/index.js +2 -0
- package/dist/api/resources/features/client/Client.d.ts +54 -21
- package/dist/api/resources/features/client/Client.js +559 -240
- package/dist/api/resources/features/client/requests/CountFeaturesRequest.d.ts +8 -0
- package/dist/api/resources/features/client/requests/CreateFeatureRequestBody.d.ts +1 -1
- package/dist/api/resources/features/client/requests/ListFeaturesRequest.d.ts +8 -0
- package/dist/api/resources/features/client/requests/UpdateFeatureRequestBody.d.ts +1 -1
- package/dist/api/resources/features/types/CountFeaturesParams.d.ts +4 -0
- package/dist/api/resources/features/types/CreateFeatureRequestBodyLifecyclePhase.d.ts +15 -0
- package/dist/api/resources/features/types/CreateFeatureRequestBodyLifecyclePhase.js +17 -0
- package/dist/api/resources/features/types/ListFeaturesParams.d.ts +4 -0
- package/dist/api/resources/features/types/UpdateFeatureRequestBodyLifecyclePhase.d.ts +15 -0
- package/dist/api/resources/features/types/UpdateFeatureRequestBodyLifecyclePhase.js +17 -0
- package/dist/api/resources/features/types/index.d.ts +2 -0
- package/dist/api/resources/features/types/index.js +2 -0
- package/dist/api/resources/index.d.ts +6 -0
- package/dist/api/resources/index.js +7 -1
- package/dist/api/resources/plangroups/client/Client.d.ts +7 -3
- package/dist/api/resources/plangroups/client/Client.js +73 -37
- package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +1 -0
- package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +1 -0
- package/dist/api/resources/plans/client/Client.d.ts +125 -12
- package/dist/api/resources/plans/client/Client.js +1011 -172
- package/dist/api/resources/plans/client/requests/CountPlanTraitsRequest.d.ts +20 -0
- package/dist/api/resources/plans/client/requests/CountPlanTraitsRequest.js +5 -0
- package/dist/api/resources/plans/client/requests/CreatePlanTraitRequestBody.d.ts +16 -0
- package/dist/api/resources/plans/client/requests/CreatePlanTraitRequestBody.js +5 -0
- package/dist/api/resources/plans/client/requests/ListPlanTraitsRequest.d.ts +20 -0
- package/dist/api/resources/plans/client/requests/ListPlanTraitsRequest.js +5 -0
- package/dist/api/resources/plans/client/requests/UpdatePlanTraitRequestBody.d.ts +14 -0
- package/dist/api/resources/plans/client/requests/UpdatePlanTraitRequestBody.js +5 -0
- package/dist/api/resources/plans/client/requests/UpsertBillingProductRequestBody.d.ts +8 -2
- package/dist/api/resources/plans/client/requests/index.d.ts +4 -0
- package/dist/api/resources/plans/types/CountPlanTraitsParams.d.ts +15 -0
- package/dist/api/resources/plans/types/CountPlanTraitsParams.js +5 -0
- package/dist/api/resources/plans/types/CountPlanTraitsResponse.d.ts +9 -0
- package/dist/api/resources/plans/types/CountPlanTraitsResponse.js +5 -0
- package/dist/api/resources/plans/types/CreatePlanTraitResponse.d.ts +9 -0
- package/dist/api/resources/plans/types/CreatePlanTraitResponse.js +5 -0
- package/dist/api/resources/plans/types/DeletePlanTraitResponse.d.ts +9 -0
- package/dist/api/resources/plans/types/DeletePlanTraitResponse.js +5 -0
- package/dist/api/resources/plans/types/GetPlanTraitResponse.d.ts +9 -0
- package/dist/api/resources/plans/types/GetPlanTraitResponse.js +5 -0
- package/dist/api/resources/plans/types/ListPlanTraitsParams.d.ts +15 -0
- package/dist/api/resources/plans/types/ListPlanTraitsParams.js +5 -0
- package/dist/api/resources/plans/types/ListPlanTraitsResponse.d.ts +10 -0
- package/dist/api/resources/plans/types/ListPlanTraitsResponse.js +5 -0
- package/dist/api/resources/plans/types/UpdatePlanTraitResponse.d.ts +9 -0
- package/dist/api/resources/plans/types/UpdatePlanTraitResponse.js +5 -0
- package/dist/api/resources/plans/types/UpsertBillingProductRequestBodyChargeType.d.ts +9 -0
- package/dist/api/resources/plans/types/UpsertBillingProductRequestBodyChargeType.js +11 -0
- package/dist/api/resources/plans/types/index.d.ts +9 -0
- package/dist/api/resources/plans/types/index.js +9 -0
- package/dist/api/resources/webhooks/client/Client.d.ts +24 -9
- package/dist/api/resources/webhooks/client/Client.js +249 -114
- package/dist/api/resources/webhooks/client/requests/CreateWebhookRequestBody.d.ts +1 -0
- package/dist/api/resources/webhooks/client/requests/UpdateWebhookRequestBody.d.ts +1 -0
- package/dist/api/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.d.ts +5 -1
- package/dist/api/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.js +4 -0
- package/dist/api/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.d.ts +5 -1
- package/dist/api/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.js +4 -0
- package/dist/api/types/BillingCreditBundleResponseData.d.ts +18 -0
- package/dist/api/types/BillingCreditBundleResponseData.js +5 -0
- package/dist/api/types/BillingCreditGrantResponseData.d.ts +23 -0
- package/dist/api/types/BillingCreditGrantResponseData.js +5 -0
- package/dist/api/types/BillingCreditResponseData.d.ts +21 -0
- package/dist/api/types/BillingCreditResponseData.js +5 -0
- package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +14 -0
- package/dist/api/types/BillingPlanCreditGrantResponseData.js +5 -0
- package/dist/api/types/BillingPriceResponseData.d.ts +2 -0
- package/dist/api/types/BillingPriceView.d.ts +8 -0
- package/dist/api/types/BillingProductDetailResponseData.d.ts +2 -0
- package/dist/api/types/BillingProductForSubscriptionResponseData.d.ts +5 -0
- package/dist/api/types/BillingProductPlanResponseData.d.ts +3 -0
- package/dist/api/types/BillingProductPriceResponseData.d.ts +4 -0
- package/dist/api/types/BillingProductPriceTierResponseData.d.ts +9 -0
- package/dist/api/types/BillingProductPriceTierResponseData.js +5 -0
- package/dist/api/types/BillingProductPricing.d.ts +2 -0
- package/dist/api/types/BillingProductResponseData.d.ts +2 -0
- package/dist/api/types/ChangeSubscriptionInternalRequestBody.d.ts +2 -0
- package/dist/api/types/ChangeSubscriptionRequestBody.d.ts +2 -0
- package/dist/api/types/CheckFlagResponseData.d.ts +2 -0
- package/dist/api/types/CheckoutDataResponseData.d.ts +2 -0
- package/dist/api/types/CompanyDetailResponseData.d.ts +1 -0
- package/dist/api/types/CompanyOverrideResponseData.d.ts +1 -0
- package/dist/api/types/CompanyPlanDetailResponseData.d.ts +4 -0
- package/dist/api/types/CompanyPlanWithBillingSubView.d.ts +2 -0
- package/dist/api/types/CompanyViewWithFeatureUsageResponseData.d.ts +27 -0
- package/dist/api/types/CompanyViewWithFeatureUsageResponseData.js +5 -0
- package/dist/api/types/CompatiblePlans.d.ts +7 -0
- package/dist/api/types/CompatiblePlans.js +5 -0
- package/dist/api/types/CompatiblePlansResponseData.d.ts +7 -0
- package/dist/api/types/CompatiblePlansResponseData.js +5 -0
- package/dist/api/types/ComponentHydrateResponseData.d.ts +1 -0
- package/dist/api/types/ComponentPreviewResponseData.d.ts +1 -0
- package/dist/api/types/CreateBillingPriceTierRequestBody.d.ts +1 -0
- package/dist/api/types/CreateEntitlementReqCommon.d.ts +1 -0
- package/dist/api/types/CreateEntitlementReqCommonValueType.d.ts +2 -1
- package/dist/api/types/CreateEntitlementReqCommonValueType.js +1 -0
- package/dist/api/types/CreateFlagRequestBody.d.ts +1 -1
- package/dist/api/types/CreateOrUpdateFlagRequestBody.d.ts +1 -1
- package/dist/api/types/CreatePriceTierRequestBody.d.ts +9 -0
- package/dist/api/types/CreatePriceTierRequestBody.js +5 -0
- package/dist/api/types/CreditBundlePurchaseResponseData.d.ts +9 -0
- package/dist/api/types/CreditBundlePurchaseResponseData.js +5 -0
- package/dist/api/types/DataExportResponseData.d.ts +17 -0
- package/dist/api/types/DataExportResponseData.js +5 -0
- package/dist/api/types/EntitlementTriggerConfig.d.ts +6 -0
- package/dist/api/types/EntitlementTriggerConfig.js +5 -0
- package/dist/api/types/EventSummaryResponseData.d.ts +2 -2
- package/dist/api/types/FeatureUsageDataResponseData.d.ts +14 -0
- package/dist/api/types/FeatureUsageDataResponseData.js +5 -0
- package/dist/api/types/PlanDetailResponseData.d.ts +3 -0
- package/dist/api/types/PlanEntitlementResponseData.d.ts +3 -0
- package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts +4 -0
- package/dist/api/types/PlanGroupResponseData.d.ts +1 -0
- package/dist/api/types/PlanTraitResponseData.d.ts +16 -0
- package/dist/api/types/PlanTraitResponseData.js +5 -0
- package/dist/api/types/PreviewSubscriptionChangeResponseData.d.ts +4 -0
- package/dist/api/types/PreviewSubscriptionFinanceResponseData.d.ts +15 -0
- package/dist/api/types/PreviewSubscriptionFinanceResponseData.js +5 -0
- package/dist/api/types/PreviewSubscriptionUpcomingInvoiceLineItems.d.ts +10 -0
- package/dist/api/types/PreviewSubscriptionUpcomingInvoiceLineItems.js +5 -0
- package/dist/api/types/QuickstartResp.d.ts +6 -0
- package/dist/api/types/QuickstartResp.js +5 -0
- package/dist/api/types/UpdateCreditBundleRequestBody.d.ts +7 -0
- package/dist/api/types/UpdateCreditBundleRequestBody.js +5 -0
- package/dist/api/types/UpdateEntitlementReqCommon.d.ts +1 -0
- package/dist/api/types/UpdateEntitlementReqCommonValueType.d.ts +2 -1
- package/dist/api/types/UpdateEntitlementReqCommonValueType.js +1 -0
- package/dist/api/types/UpsertCompanyRequestBody.d.ts +1 -0
- package/dist/api/types/UpsertTraitRequestBody.d.ts +1 -1
- package/dist/api/types/UpsertUserRequestBody.d.ts +8 -3
- package/dist/api/types/UpsertUserSubRequestBody.d.ts +4 -1
- package/dist/api/types/UsageBasedEntitlementRequestBody.d.ts +11 -1
- package/dist/api/types/UsageBasedEntitlementRequestBodyPriceBehavior.d.ts +11 -0
- package/dist/api/types/UsageBasedEntitlementRequestBodyPriceBehavior.js +13 -0
- package/dist/api/types/UsageBasedEntitlementResponseData.d.ts +1 -0
- package/dist/api/types/WebhookResponseData.d.ts +2 -0
- package/dist/api/types/index.d.ts +19 -0
- package/dist/api/types/index.js +19 -0
- package/dist/core/fetcher/APIResponse.d.ts +10 -0
- package/dist/core/fetcher/Fetcher.js +7 -0
- package/dist/core/fetcher/Headers.d.ts +2 -0
- package/dist/core/fetcher/Headers.js +84 -0
- package/dist/core/fetcher/HttpResponsePromise.d.ts +58 -0
- package/dist/core/fetcher/HttpResponsePromise.js +103 -0
- package/dist/core/fetcher/RawResponse.d.ts +29 -0
- package/dist/core/fetcher/RawResponse.js +44 -0
- package/dist/core/fetcher/custom.js +17 -0
- package/dist/core/fetcher/index.d.ts +3 -0
- package/dist/core/fetcher/index.js +7 -1
- package/dist/errors/SchematicError.d.ts +4 -1
- package/dist/errors/SchematicError.js +4 -7
- package/dist/events.d.ts +4 -0
- package/dist/events.js +41 -5
- package/dist/events.test.js +50 -3
- package/dist/serialization/resources/accesstokens/client/requests/IssueTemporaryAccessTokenRequestBody.d.ts +0 -1
- package/dist/serialization/resources/accesstokens/client/requests/IssueTemporaryAccessTokenRequestBody.js +0 -1
- package/dist/serialization/resources/accounts/types/QuickstartResponse.d.ts +14 -0
- package/dist/serialization/resources/accounts/types/QuickstartResponse.js +45 -0
- package/dist/serialization/resources/accounts/types/index.d.ts +1 -0
- package/dist/serialization/resources/accounts/types/index.js +1 -0
- package/dist/serialization/resources/billing/client/requests/CreateBillingPriceRequestBody.d.ts +6 -2
- package/dist/serialization/resources/billing/client/requests/CreateBillingPriceRequestBody.js +6 -2
- package/dist/serialization/resources/billing/client/requests/CreateBillingProductRequestBody.d.ts +1 -3
- package/dist/serialization/resources/billing/client/requests/CreateBillingProductRequestBody.js +1 -3
- package/dist/serialization/resources/billing/types/CountBillingProductsParams.d.ts +2 -0
- package/dist/serialization/resources/billing/types/CountBillingProductsParams.js +2 -0
- package/dist/serialization/resources/billing/types/CountCustomersParams.d.ts +1 -0
- package/dist/serialization/resources/billing/types/CountCustomersParams.js +1 -0
- package/dist/serialization/resources/billing/types/CreateBillingPriceRequestBodyBillingScheme.d.ts +10 -0
- package/dist/serialization/resources/billing/types/CreateBillingPriceRequestBodyBillingScheme.js +41 -0
- package/dist/serialization/resources/billing/types/CreateBillingPriceRequestBodyTiersMode.d.ts +10 -0
- package/dist/serialization/resources/billing/types/CreateBillingPriceRequestBodyTiersMode.js +41 -0
- package/dist/serialization/resources/billing/types/ListBillingProductsParams.d.ts +2 -0
- package/dist/serialization/resources/billing/types/ListBillingProductsParams.js +2 -0
- package/{serialization/resources/billing/types/ListCustomersParams.d.ts → dist/serialization/resources/billing/types/ListCustomersWithSubscriptionsParams.d.ts} +3 -2
- package/{serialization/resources/billing/types/ListCustomersParams.js → dist/serialization/resources/billing/types/ListCustomersWithSubscriptionsParams.js} +3 -2
- package/dist/serialization/resources/billing/types/{ListCustomersResponse.d.ts → ListCustomersWithSubscriptionsResponse.d.ts} +4 -4
- package/dist/serialization/resources/billing/types/{ListCustomersResponse.js → ListCustomersWithSubscriptionsResponse.js} +4 -4
- package/dist/serialization/resources/billing/types/ListProductPricesParams.d.ts +2 -0
- package/dist/serialization/resources/billing/types/ListProductPricesParams.js +2 -0
- package/dist/serialization/resources/billing/types/SearchBillingPricesParams.d.ts +2 -0
- package/dist/serialization/resources/billing/types/SearchBillingPricesParams.js +2 -0
- package/dist/serialization/resources/billing/types/SearchBillingPricesRequestTiersMode.d.ts +10 -0
- package/dist/serialization/resources/billing/types/{CreateBillingPriceRequestBodyTierMode.js → SearchBillingPricesRequestTiersMode.js} +2 -2
- package/dist/serialization/resources/billing/types/SearchBillingPricesResponseParamsTiersMode.d.ts +10 -0
- package/dist/serialization/resources/billing/types/SearchBillingPricesResponseParamsTiersMode.js +41 -0
- package/dist/serialization/resources/billing/types/index.d.ts +6 -3
- package/dist/serialization/resources/billing/types/index.js +6 -3
- package/dist/serialization/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +26 -0
- package/dist/serialization/resources/companies/types/CountCompaniesForAdvancedFilterParams.js +57 -0
- package/dist/serialization/resources/companies/types/CountCompaniesForAdvancedFilterRequestSortOrderDirection.d.ts +10 -0
- package/dist/serialization/resources/companies/types/CountCompaniesForAdvancedFilterRequestSortOrderDirection.js +41 -0
- package/dist/serialization/resources/companies/types/CountCompaniesForAdvancedFilterResponse.d.ts +15 -0
- package/dist/serialization/resources/companies/types/CountCompaniesForAdvancedFilterResponse.js +46 -0
- package/dist/serialization/resources/companies/types/CountCompaniesForAdvancedFilterResponseParamsSortOrderDirection.d.ts +10 -0
- package/dist/serialization/resources/companies/types/CountCompaniesForAdvancedFilterResponseParamsSortOrderDirection.js +41 -0
- package/dist/serialization/resources/companies/types/CountCompaniesParams.d.ts +1 -0
- package/dist/serialization/resources/companies/types/CountCompaniesParams.js +1 -0
- package/dist/serialization/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +26 -0
- package/dist/serialization/resources/companies/types/ListCompaniesForAdvancedFilterParams.js +57 -0
- package/dist/serialization/resources/companies/types/ListCompaniesForAdvancedFilterRequestSortOrderDirection.d.ts +10 -0
- package/dist/serialization/resources/companies/types/ListCompaniesForAdvancedFilterRequestSortOrderDirection.js +41 -0
- package/dist/serialization/resources/companies/types/ListCompaniesForAdvancedFilterResponse.d.ts +15 -0
- package/dist/serialization/resources/companies/types/ListCompaniesForAdvancedFilterResponse.js +46 -0
- package/dist/serialization/resources/companies/types/ListCompaniesForAdvancedFilterResponseParamsSortOrderDirection.d.ts +10 -0
- package/dist/serialization/resources/companies/types/ListCompaniesForAdvancedFilterResponseParamsSortOrderDirection.js +41 -0
- package/dist/serialization/resources/companies/types/ListCompaniesParams.d.ts +1 -0
- package/dist/serialization/resources/companies/types/ListCompaniesParams.js +1 -0
- package/dist/serialization/resources/companies/types/LookupCompanyParams.d.ts +1 -1
- package/dist/serialization/resources/companies/types/LookupCompanyParams.js +1 -1
- package/dist/serialization/resources/companies/types/LookupUserParams.d.ts +1 -1
- package/dist/serialization/resources/companies/types/LookupUserParams.js +1 -1
- package/dist/serialization/resources/companies/types/index.d.ts +8 -0
- package/dist/serialization/resources/companies/types/index.js +8 -0
- package/dist/serialization/resources/credits/client/index.d.ts +1 -0
- package/dist/serialization/resources/credits/client/index.js +17 -0
- package/dist/serialization/resources/credits/client/requests/CreateBillingCreditRequestBody.d.ts +25 -0
- package/dist/serialization/resources/credits/client/requests/CreateBillingCreditRequestBody.js +56 -0
- package/dist/serialization/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.d.ts +18 -0
- package/dist/serialization/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.js +49 -0
- package/dist/serialization/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +23 -0
- package/dist/serialization/resources/credits/client/requests/CreateCreditBundleRequestBody.js +54 -0
- package/dist/serialization/resources/credits/client/requests/UpdateBillingCreditRequestBody.d.ts +24 -0
- package/dist/serialization/resources/credits/client/requests/UpdateBillingCreditRequestBody.js +55 -0
- package/dist/serialization/resources/credits/client/requests/ZeroOutGrantRequestBody.d.ts +13 -0
- package/dist/serialization/resources/credits/client/requests/ZeroOutGrantRequestBody.js +44 -0
- package/dist/serialization/resources/credits/client/requests/index.d.ts +5 -0
- package/dist/serialization/resources/credits/client/requests/index.js +13 -0
- package/dist/serialization/resources/credits/index.d.ts +2 -0
- package/dist/serialization/resources/credits/index.js +18 -0
- package/dist/serialization/resources/credits/types/CountBillingCreditsGrantsParams.d.ts +15 -0
- package/dist/serialization/resources/credits/types/CountBillingCreditsGrantsParams.js +46 -0
- package/dist/serialization/resources/credits/types/CountBillingCreditsGrantsResponse.d.ts +15 -0
- package/dist/serialization/resources/credits/types/CountBillingCreditsGrantsResponse.js +46 -0
- package/dist/serialization/resources/credits/types/CountBillingCreditsParams.d.ts +15 -0
- package/dist/serialization/resources/credits/types/CountBillingCreditsParams.js +46 -0
- package/dist/serialization/resources/credits/types/CountBillingCreditsResponse.d.ts +15 -0
- package/dist/serialization/resources/credits/types/CountBillingCreditsResponse.js +46 -0
- package/dist/serialization/resources/credits/types/CountBillingPlanCreditGrantsParams.d.ts +16 -0
- package/dist/serialization/resources/credits/types/CountBillingPlanCreditGrantsParams.js +47 -0
- package/dist/serialization/resources/credits/types/CountBillingPlanCreditGrantsResponse.d.ts +15 -0
- package/dist/serialization/resources/credits/types/CountBillingPlanCreditGrantsResponse.js +46 -0
- package/dist/serialization/resources/credits/types/CountCreditBundlesParams.d.ts +18 -0
- package/dist/serialization/resources/credits/types/CountCreditBundlesParams.js +49 -0
- package/dist/serialization/resources/credits/types/CountCreditBundlesRequestStatus.d.ts +10 -0
- package/{serialization/resources/billing/types/CreateBillingPriceRequestBodyTierMode.js → dist/serialization/resources/credits/types/CountCreditBundlesRequestStatus.js} +2 -2
- package/dist/serialization/resources/credits/types/CountCreditBundlesResponse.d.ts +15 -0
- package/dist/serialization/resources/credits/types/CountCreditBundlesResponse.js +46 -0
- package/dist/serialization/resources/credits/types/CountCreditBundlesResponseParamsStatus.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CountCreditBundlesResponseParamsStatus.js +41 -0
- package/dist/serialization/resources/credits/types/CreateBillingCreditRequestBodyBurnStrategy.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateBillingCreditRequestBodyBurnStrategy.js +46 -0
- package/dist/serialization/resources/credits/types/CreateBillingCreditRequestBodyDefaultRolloverPolicy.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateBillingCreditRequestBodyDefaultRolloverPolicy.js +41 -0
- package/dist/serialization/resources/credits/types/CreateBillingCreditResponse.d.ts +14 -0
- package/dist/serialization/resources/credits/types/CreateBillingCreditResponse.js +45 -0
- package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetCadence.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetCadence.js +41 -0
- package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetStart.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetStart.js +41 -0
- package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantResponse.d.ts +14 -0
- package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantResponse.js +45 -0
- package/dist/serialization/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.js +41 -0
- package/dist/serialization/resources/credits/types/CreateCreditBundleRequestBodyStatus.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateCreditBundleRequestBodyStatus.js +41 -0
- package/dist/serialization/resources/credits/types/CreateCreditBundleResponse.d.ts +14 -0
- package/dist/serialization/resources/credits/types/CreateCreditBundleResponse.js +45 -0
- package/dist/serialization/resources/credits/types/DeleteBillingPlanCreditGrantResponse.d.ts +14 -0
- package/dist/serialization/resources/credits/types/DeleteBillingPlanCreditGrantResponse.js +45 -0
- package/dist/serialization/resources/credits/types/DeleteCreditBundleResponse.d.ts +14 -0
- package/dist/serialization/resources/credits/types/DeleteCreditBundleResponse.js +45 -0
- package/dist/serialization/resources/credits/types/GetCreditBundleResponse.d.ts +14 -0
- package/dist/serialization/resources/credits/types/GetCreditBundleResponse.js +45 -0
- package/dist/serialization/resources/credits/types/GetSingleBillingCreditResponse.d.ts +14 -0
- package/dist/serialization/resources/credits/types/GetSingleBillingCreditResponse.js +45 -0
- package/dist/serialization/resources/credits/types/ListBillingCreditsParams.d.ts +15 -0
- package/dist/serialization/resources/credits/types/ListBillingCreditsParams.js +46 -0
- package/dist/serialization/resources/credits/types/ListBillingCreditsResponse.d.ts +15 -0
- package/dist/serialization/resources/credits/types/ListBillingCreditsResponse.js +46 -0
- package/dist/serialization/resources/credits/types/ListBillingPlanCreditGrantsParams.d.ts +16 -0
- package/dist/serialization/resources/credits/types/ListBillingPlanCreditGrantsParams.js +47 -0
- package/dist/serialization/resources/credits/types/ListBillingPlanCreditGrantsResponse.d.ts +15 -0
- package/dist/serialization/resources/credits/types/ListBillingPlanCreditGrantsResponse.js +46 -0
- package/dist/serialization/resources/credits/types/ListCompanyGrantsParams.d.ts +18 -0
- package/dist/serialization/resources/credits/types/ListCompanyGrantsParams.js +49 -0
- package/dist/serialization/resources/credits/types/ListCompanyGrantsRequestDir.d.ts +10 -0
- package/dist/serialization/resources/credits/types/ListCompanyGrantsRequestDir.js +41 -0
- package/dist/serialization/resources/credits/types/ListCompanyGrantsRequestOrder.d.ts +10 -0
- package/dist/serialization/resources/credits/types/ListCompanyGrantsRequestOrder.js +41 -0
- package/dist/serialization/resources/credits/types/ListCompanyGrantsResponse.d.ts +15 -0
- package/dist/serialization/resources/credits/types/ListCompanyGrantsResponse.js +46 -0
- package/dist/serialization/resources/credits/types/ListCompanyGrantsResponseParamsDir.d.ts +10 -0
- package/dist/serialization/resources/credits/types/ListCompanyGrantsResponseParamsDir.js +41 -0
- package/dist/serialization/resources/credits/types/ListCompanyGrantsResponseParamsOrder.d.ts +10 -0
- package/dist/serialization/resources/credits/types/ListCompanyGrantsResponseParamsOrder.js +41 -0
- package/dist/serialization/resources/credits/types/ListCreditBundlesParams.d.ts +18 -0
- package/dist/serialization/resources/credits/types/ListCreditBundlesParams.js +49 -0
- package/dist/serialization/resources/credits/types/ListCreditBundlesRequestStatus.d.ts +10 -0
- package/dist/serialization/resources/credits/types/ListCreditBundlesRequestStatus.js +41 -0
- package/dist/serialization/resources/credits/types/ListCreditBundlesResponse.d.ts +15 -0
- package/dist/serialization/resources/credits/types/ListCreditBundlesResponse.js +46 -0
- package/dist/serialization/resources/credits/types/ListCreditBundlesResponseParamsStatus.d.ts +10 -0
- package/dist/serialization/resources/credits/types/ListCreditBundlesResponseParamsStatus.js +41 -0
- package/dist/serialization/resources/credits/types/ListGrantsForCreditParams.d.ts +15 -0
- package/dist/serialization/resources/credits/types/ListGrantsForCreditParams.js +46 -0
- package/dist/serialization/resources/credits/types/ListGrantsForCreditResponse.d.ts +15 -0
- package/dist/serialization/resources/credits/types/ListGrantsForCreditResponse.js +46 -0
- package/dist/serialization/resources/credits/types/UpdateBillingCreditRequestBodyBurnStrategy.d.ts +10 -0
- package/dist/serialization/resources/credits/types/UpdateBillingCreditRequestBodyBurnStrategy.js +46 -0
- package/dist/serialization/resources/credits/types/UpdateBillingCreditRequestBodyDefaultRolloverPolicy.d.ts +10 -0
- package/dist/serialization/resources/credits/types/UpdateBillingCreditRequestBodyDefaultRolloverPolicy.js +41 -0
- package/dist/serialization/resources/credits/types/UpdateBillingCreditResponse.d.ts +14 -0
- package/dist/serialization/resources/credits/types/UpdateBillingCreditResponse.js +45 -0
- package/dist/serialization/resources/credits/types/UpdateCreditBundleResponse.d.ts +14 -0
- package/dist/serialization/resources/credits/types/UpdateCreditBundleResponse.js +45 -0
- package/dist/serialization/resources/credits/types/ZeroOutGrantRequestBodyReason.d.ts +10 -0
- package/dist/serialization/resources/credits/types/ZeroOutGrantRequestBodyReason.js +41 -0
- package/dist/serialization/resources/credits/types/ZeroOutGrantResponse.d.ts +14 -0
- package/dist/serialization/resources/credits/types/ZeroOutGrantResponse.js +45 -0
- package/dist/serialization/resources/credits/types/index.d.ts +45 -0
- package/dist/serialization/resources/credits/types/index.js +61 -0
- package/dist/serialization/resources/dataexports/client/index.d.ts +1 -0
- package/dist/serialization/resources/dataexports/client/index.js +17 -0
- package/dist/serialization/resources/dataexports/client/requests/CreateDataExportRequestBody.d.ts +12 -0
- package/dist/serialization/resources/dataexports/client/requests/CreateDataExportRequestBody.js +43 -0
- package/dist/serialization/resources/dataexports/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/dataexports/client/requests/index.js +5 -0
- package/dist/serialization/resources/dataexports/index.d.ts +2 -0
- package/dist/serialization/resources/dataexports/index.js +18 -0
- package/dist/serialization/resources/dataexports/types/CreateDataExportResponse.d.ts +14 -0
- package/dist/serialization/resources/dataexports/types/CreateDataExportResponse.js +45 -0
- package/dist/serialization/resources/dataexports/types/index.d.ts +1 -0
- package/dist/serialization/resources/dataexports/types/index.js +17 -0
- package/dist/serialization/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +1 -0
- package/dist/serialization/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.js +1 -0
- package/dist/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +13 -1
- package/dist/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.js +13 -1
- package/dist/serialization/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +1 -0
- package/dist/serialization/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.js +1 -0
- package/dist/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +13 -1
- package/dist/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.js +13 -1
- package/dist/serialization/resources/entitlements/types/CreateCompanyOverrideRequestBodyValueType.d.ts +1 -1
- package/dist/serialization/resources/entitlements/types/CreateCompanyOverrideRequestBodyValueType.js +1 -1
- package/dist/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyPriceBehavior.d.ts +10 -0
- package/dist/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyPriceBehavior.js +41 -0
- package/dist/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyValueType.d.ts +1 -1
- package/dist/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyValueType.js +1 -1
- package/dist/serialization/resources/entitlements/types/GetFeatureUsageByCompanyParams.d.ts +1 -1
- package/dist/serialization/resources/entitlements/types/GetFeatureUsageByCompanyParams.js +1 -1
- package/dist/serialization/resources/entitlements/types/UpdateCompanyOverrideRequestBodyValueType.d.ts +1 -1
- package/dist/serialization/resources/entitlements/types/UpdateCompanyOverrideRequestBodyValueType.js +1 -1
- package/dist/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyPriceBehavior.d.ts +10 -0
- package/dist/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyPriceBehavior.js +41 -0
- package/dist/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyValueType.d.ts +1 -1
- package/dist/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyValueType.js +1 -1
- package/dist/serialization/resources/entitlements/types/index.d.ts +2 -0
- package/dist/serialization/resources/entitlements/types/index.js +2 -0
- package/dist/serialization/resources/events/types/ListEventsParams.d.ts +2 -1
- package/dist/serialization/resources/events/types/ListEventsParams.js +2 -1
- package/dist/serialization/resources/events/types/ListEventsRequestEventTypesItem.d.ts +10 -0
- package/dist/serialization/resources/events/types/ListEventsRequestEventTypesItem.js +41 -0
- package/dist/serialization/resources/events/types/ListEventsResponseParamsEventTypesItem.d.ts +10 -0
- package/dist/serialization/resources/events/types/ListEventsResponseParamsEventTypesItem.js +41 -0
- package/dist/serialization/resources/events/types/index.d.ts +2 -0
- package/dist/serialization/resources/events/types/index.js +2 -0
- package/dist/serialization/resources/features/client/requests/CreateFeatureRequestBody.d.ts +2 -1
- package/dist/serialization/resources/features/client/requests/CreateFeatureRequestBody.js +2 -1
- package/dist/serialization/resources/features/client/requests/UpdateFeatureRequestBody.d.ts +2 -1
- package/dist/serialization/resources/features/client/requests/UpdateFeatureRequestBody.js +2 -1
- package/dist/serialization/resources/features/types/CountFeaturesParams.d.ts +2 -0
- package/dist/serialization/resources/features/types/CountFeaturesParams.js +2 -0
- package/dist/serialization/resources/features/types/CreateFeatureRequestBodyLifecyclePhase.d.ts +10 -0
- package/dist/serialization/resources/features/types/CreateFeatureRequestBodyLifecyclePhase.js +51 -0
- package/dist/serialization/resources/features/types/ListFeaturesParams.d.ts +2 -0
- package/dist/serialization/resources/features/types/ListFeaturesParams.js +2 -0
- package/dist/serialization/resources/features/types/UpdateFeatureRequestBodyLifecyclePhase.d.ts +10 -0
- package/dist/serialization/resources/features/types/UpdateFeatureRequestBodyLifecyclePhase.js +51 -0
- package/dist/serialization/resources/features/types/index.d.ts +2 -0
- package/dist/serialization/resources/features/types/index.js +2 -0
- package/dist/serialization/resources/index.d.ts +6 -0
- package/dist/serialization/resources/index.js +7 -1
- package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +2 -0
- package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.js +2 -0
- package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +2 -0
- package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.js +2 -0
- package/dist/serialization/resources/plans/client/requests/CreatePlanTraitRequestBody.d.ts +14 -0
- package/dist/serialization/resources/plans/client/requests/CreatePlanTraitRequestBody.js +45 -0
- package/dist/serialization/resources/plans/client/requests/UpdatePlanTraitRequestBody.d.ts +13 -0
- package/dist/serialization/resources/plans/client/requests/UpdatePlanTraitRequestBody.js +44 -0
- package/dist/serialization/resources/plans/client/requests/UpsertBillingProductRequestBody.d.ts +7 -1
- package/dist/serialization/resources/plans/client/requests/UpsertBillingProductRequestBody.js +7 -1
- package/dist/serialization/resources/plans/client/requests/index.d.ts +2 -0
- package/dist/serialization/resources/plans/client/requests/index.js +5 -1
- package/dist/serialization/resources/plans/types/CountPlanTraitsParams.d.ts +16 -0
- package/dist/serialization/resources/plans/types/CountPlanTraitsParams.js +47 -0
- package/dist/serialization/resources/plans/types/CountPlanTraitsResponse.d.ts +15 -0
- package/dist/serialization/resources/plans/types/CountPlanTraitsResponse.js +46 -0
- package/dist/serialization/resources/plans/types/CreatePlanTraitResponse.d.ts +14 -0
- package/dist/serialization/resources/plans/types/CreatePlanTraitResponse.js +45 -0
- package/dist/serialization/resources/plans/types/DeletePlanTraitResponse.d.ts +14 -0
- package/dist/serialization/resources/plans/types/DeletePlanTraitResponse.js +45 -0
- package/dist/serialization/resources/plans/types/GetPlanTraitResponse.d.ts +14 -0
- package/dist/serialization/resources/plans/types/GetPlanTraitResponse.js +45 -0
- package/dist/serialization/resources/plans/types/ListPlanTraitsParams.d.ts +16 -0
- package/dist/serialization/resources/plans/types/ListPlanTraitsParams.js +47 -0
- package/dist/serialization/resources/plans/types/ListPlanTraitsResponse.d.ts +15 -0
- package/dist/serialization/resources/plans/types/ListPlanTraitsResponse.js +46 -0
- package/dist/serialization/resources/plans/types/UpdatePlanTraitResponse.d.ts +14 -0
- package/dist/serialization/resources/plans/types/UpdatePlanTraitResponse.js +45 -0
- package/dist/serialization/resources/plans/types/UpsertBillingProductRequestBodyChargeType.d.ts +10 -0
- package/dist/serialization/resources/plans/types/UpsertBillingProductRequestBodyChargeType.js +41 -0
- package/dist/serialization/resources/plans/types/index.d.ts +9 -0
- package/dist/serialization/resources/plans/types/index.js +9 -0
- package/dist/serialization/resources/webhooks/client/requests/CreateWebhookRequestBody.d.ts +2 -0
- package/dist/serialization/resources/webhooks/client/requests/CreateWebhookRequestBody.js +2 -0
- package/dist/serialization/resources/webhooks/client/requests/UpdateWebhookRequestBody.d.ts +2 -0
- package/dist/serialization/resources/webhooks/client/requests/UpdateWebhookRequestBody.js +2 -0
- package/dist/serialization/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.d.ts +1 -1
- package/dist/serialization/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.js +4 -0
- package/dist/serialization/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.d.ts +1 -1
- package/dist/serialization/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.js +4 -0
- package/dist/serialization/types/BillingCreditBundleResponseData.d.ts +24 -0
- package/dist/serialization/types/BillingCreditBundleResponseData.js +55 -0
- package/dist/serialization/types/BillingCreditGrantResponseData.d.ts +29 -0
- package/dist/serialization/types/BillingCreditGrantResponseData.js +60 -0
- package/dist/serialization/types/BillingCreditResponseData.d.ts +28 -0
- package/dist/serialization/types/BillingCreditResponseData.js +59 -0
- package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +20 -0
- package/dist/serialization/types/BillingPlanCreditGrantResponseData.js +51 -0
- package/dist/serialization/types/BillingPriceResponseData.d.ts +2 -0
- package/dist/serialization/types/BillingPriceResponseData.js +2 -0
- package/dist/serialization/types/BillingPriceView.d.ts +8 -0
- package/dist/serialization/types/BillingPriceView.js +8 -0
- package/dist/serialization/types/BillingProductDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/BillingProductDetailResponseData.js +2 -0
- package/dist/serialization/types/BillingProductForSubscriptionResponseData.d.ts +5 -0
- package/dist/serialization/types/BillingProductForSubscriptionResponseData.js +5 -0
- package/dist/serialization/types/BillingProductPlanResponseData.d.ts +3 -0
- package/dist/serialization/types/BillingProductPlanResponseData.js +3 -0
- package/dist/serialization/types/BillingProductPriceResponseData.d.ts +4 -0
- package/dist/serialization/types/BillingProductPriceResponseData.js +4 -0
- package/dist/serialization/types/BillingProductPriceTierResponseData.d.ts +15 -0
- package/dist/serialization/types/BillingProductPriceTierResponseData.js +46 -0
- package/dist/serialization/types/BillingProductPricing.d.ts +2 -0
- package/dist/serialization/types/BillingProductPricing.js +2 -0
- package/dist/serialization/types/BillingProductResponseData.d.ts +2 -0
- package/dist/serialization/types/BillingProductResponseData.js +2 -0
- package/dist/serialization/types/ChangeSubscriptionInternalRequestBody.d.ts +3 -0
- package/dist/serialization/types/ChangeSubscriptionInternalRequestBody.js +3 -0
- package/dist/serialization/types/ChangeSubscriptionRequestBody.d.ts +3 -0
- package/dist/serialization/types/ChangeSubscriptionRequestBody.js +3 -0
- package/dist/serialization/types/CheckFlagResponseData.d.ts +1 -0
- package/dist/serialization/types/CheckFlagResponseData.js +1 -0
- package/dist/serialization/types/CheckoutDataResponseData.d.ts +4 -0
- package/dist/serialization/types/CheckoutDataResponseData.js +4 -0
- package/dist/serialization/types/CompanyDetailResponseData.d.ts +2 -1
- package/dist/serialization/types/CompanyDetailResponseData.js +2 -1
- package/dist/serialization/types/CompanyOverrideResponseData.d.ts +1 -0
- package/dist/serialization/types/CompanyOverrideResponseData.js +1 -0
- package/dist/serialization/types/CompanyPlanDetailResponseData.d.ts +4 -0
- package/dist/serialization/types/CompanyPlanDetailResponseData.js +4 -0
- package/dist/serialization/types/CompanyPlanWithBillingSubView.d.ts +2 -0
- package/dist/serialization/types/CompanyPlanWithBillingSubView.js +2 -0
- package/dist/serialization/types/CompanyViewWithFeatureUsageResponseData.d.ts +39 -0
- package/dist/serialization/types/CompanyViewWithFeatureUsageResponseData.js +70 -0
- package/dist/serialization/types/CompatiblePlans.d.ts +13 -0
- package/dist/serialization/types/CompatiblePlans.js +44 -0
- package/dist/serialization/types/CompatiblePlansResponseData.d.ts +13 -0
- package/dist/serialization/types/CompatiblePlansResponseData.js +44 -0
- package/dist/serialization/types/ComponentHydrateResponseData.d.ts +2 -0
- package/dist/serialization/types/ComponentHydrateResponseData.js +2 -0
- package/dist/serialization/types/ComponentPreviewResponseData.d.ts +2 -0
- package/dist/serialization/types/ComponentPreviewResponseData.js +2 -0
- package/dist/serialization/types/CreateBillingPriceTierRequestBody.d.ts +1 -0
- package/dist/serialization/types/CreateBillingPriceTierRequestBody.js +1 -0
- package/dist/serialization/types/CreateEntitlementReqCommon.d.ts +1 -0
- package/dist/serialization/types/CreateEntitlementReqCommon.js +1 -0
- package/dist/serialization/types/CreateEntitlementReqCommonValueType.d.ts +1 -1
- package/dist/serialization/types/CreateEntitlementReqCommonValueType.js +1 -1
- package/dist/serialization/types/CreateFlagRequestBody.d.ts +1 -1
- package/dist/serialization/types/CreateFlagRequestBody.js +1 -1
- package/dist/serialization/types/CreateOrUpdateFlagRequestBody.d.ts +1 -1
- package/dist/serialization/types/CreateOrUpdateFlagRequestBody.js +1 -1
- package/dist/serialization/types/CreatePriceTierRequestBody.d.ts +15 -0
- package/dist/serialization/types/CreatePriceTierRequestBody.js +46 -0
- package/dist/serialization/types/CreditBundlePurchaseResponseData.d.ts +15 -0
- package/dist/serialization/types/CreditBundlePurchaseResponseData.js +46 -0
- package/dist/serialization/types/DataExportResponseData.d.ts +20 -0
- package/dist/serialization/types/DataExportResponseData.js +51 -0
- package/dist/serialization/types/EntitlementTriggerConfig.d.ts +12 -0
- package/dist/serialization/types/EntitlementTriggerConfig.js +43 -0
- package/dist/serialization/types/EventSummaryResponseData.d.ts +2 -2
- package/dist/serialization/types/EventSummaryResponseData.js +2 -2
- package/dist/serialization/types/FeatureUsageDataResponseData.d.ts +20 -0
- package/dist/serialization/types/FeatureUsageDataResponseData.js +51 -0
- package/dist/serialization/types/PlanDetailResponseData.d.ts +3 -0
- package/dist/serialization/types/PlanDetailResponseData.js +3 -0
- package/dist/serialization/types/PlanEntitlementResponseData.d.ts +5 -0
- package/dist/serialization/types/PlanEntitlementResponseData.js +5 -0
- package/dist/serialization/types/PlanGroupPlanDetailResponseData.d.ts +4 -0
- package/dist/serialization/types/PlanGroupPlanDetailResponseData.js +4 -0
- package/dist/serialization/types/PlanGroupResponseData.d.ts +2 -0
- package/dist/serialization/types/PlanGroupResponseData.js +2 -0
- package/dist/serialization/types/PlanTraitResponseData.d.ts +19 -0
- package/dist/serialization/types/PlanTraitResponseData.js +50 -0
- package/dist/serialization/types/PreviewSubscriptionChangeResponseData.d.ts +5 -0
- package/dist/serialization/types/PreviewSubscriptionChangeResponseData.js +5 -0
- package/dist/serialization/types/PreviewSubscriptionFinanceResponseData.d.ts +21 -0
- package/dist/serialization/types/PreviewSubscriptionFinanceResponseData.js +52 -0
- package/dist/serialization/types/PreviewSubscriptionUpcomingInvoiceLineItems.d.ts +16 -0
- package/dist/serialization/types/PreviewSubscriptionUpcomingInvoiceLineItems.js +47 -0
- package/dist/serialization/types/QuickstartResp.d.ts +12 -0
- package/dist/serialization/types/QuickstartResp.js +43 -0
- package/dist/serialization/types/UpdateCreditBundleRequestBody.d.ts +13 -0
- package/dist/serialization/types/UpdateCreditBundleRequestBody.js +44 -0
- package/dist/serialization/types/UpdateEntitlementReqCommon.d.ts +1 -0
- package/dist/serialization/types/UpdateEntitlementReqCommon.js +1 -0
- package/dist/serialization/types/UpdateEntitlementReqCommonValueType.d.ts +1 -1
- package/dist/serialization/types/UpdateEntitlementReqCommonValueType.js +1 -1
- package/dist/serialization/types/UpsertUserRequestBody.d.ts +3 -1
- package/dist/serialization/types/UpsertUserRequestBody.js +5 -1
- package/dist/serialization/types/UpsertUserSubRequestBody.d.ts +1 -0
- package/dist/serialization/types/UpsertUserSubRequestBody.js +1 -0
- package/dist/serialization/types/UsageBasedEntitlementRequestBody.d.ts +12 -1
- package/dist/serialization/types/UsageBasedEntitlementRequestBody.js +12 -1
- package/dist/serialization/types/UsageBasedEntitlementRequestBodyPriceBehavior.d.ts +10 -0
- package/dist/serialization/types/UsageBasedEntitlementRequestBodyPriceBehavior.js +41 -0
- package/dist/serialization/types/UsageBasedEntitlementResponseData.d.ts +1 -0
- package/dist/serialization/types/UsageBasedEntitlementResponseData.js +1 -0
- package/dist/serialization/types/WebhookResponseData.d.ts +2 -0
- package/dist/serialization/types/WebhookResponseData.js +2 -0
- package/dist/serialization/types/index.d.ts +19 -0
- package/dist/serialization/types/index.js +19 -0
- package/errors/SchematicError.d.ts +4 -1
- package/errors/SchematicError.js +4 -7
- package/events.d.ts +4 -0
- package/events.js +41 -5
- package/events.test.js +50 -3
- package/package.json +4 -3
- package/reference.md +1830 -378
- package/serialization/resources/accesstokens/client/requests/IssueTemporaryAccessTokenRequestBody.d.ts +0 -1
- package/serialization/resources/accesstokens/client/requests/IssueTemporaryAccessTokenRequestBody.js +0 -1
- package/serialization/resources/accounts/types/QuickstartResponse.d.ts +14 -0
- package/serialization/resources/accounts/types/QuickstartResponse.js +45 -0
- package/serialization/resources/accounts/types/index.d.ts +1 -0
- package/serialization/resources/accounts/types/index.js +1 -0
- package/serialization/resources/billing/client/requests/CreateBillingPriceRequestBody.d.ts +6 -2
- package/serialization/resources/billing/client/requests/CreateBillingPriceRequestBody.js +6 -2
- package/serialization/resources/billing/client/requests/CreateBillingProductRequestBody.d.ts +1 -3
- package/serialization/resources/billing/client/requests/CreateBillingProductRequestBody.js +1 -3
- package/serialization/resources/billing/types/CountBillingProductsParams.d.ts +2 -0
- package/serialization/resources/billing/types/CountBillingProductsParams.js +2 -0
- package/serialization/resources/billing/types/CountCustomersParams.d.ts +1 -0
- package/serialization/resources/billing/types/CountCustomersParams.js +1 -0
- package/serialization/resources/billing/types/CreateBillingPriceRequestBodyBillingScheme.d.ts +10 -0
- package/serialization/resources/billing/types/CreateBillingPriceRequestBodyBillingScheme.js +41 -0
- package/serialization/resources/billing/types/CreateBillingPriceRequestBodyTiersMode.d.ts +10 -0
- package/serialization/resources/billing/types/CreateBillingPriceRequestBodyTiersMode.js +41 -0
- package/serialization/resources/billing/types/ListBillingProductsParams.d.ts +2 -0
- package/serialization/resources/billing/types/ListBillingProductsParams.js +2 -0
- package/{dist/serialization/resources/billing/types/ListCustomersParams.d.ts → serialization/resources/billing/types/ListCustomersWithSubscriptionsParams.d.ts} +3 -2
- package/{dist/serialization/resources/billing/types/ListCustomersParams.js → serialization/resources/billing/types/ListCustomersWithSubscriptionsParams.js} +3 -2
- package/serialization/resources/billing/types/{ListCustomersResponse.d.ts → ListCustomersWithSubscriptionsResponse.d.ts} +4 -4
- package/serialization/resources/billing/types/{ListCustomersResponse.js → ListCustomersWithSubscriptionsResponse.js} +4 -4
- package/serialization/resources/billing/types/ListProductPricesParams.d.ts +2 -0
- package/serialization/resources/billing/types/ListProductPricesParams.js +2 -0
- package/serialization/resources/billing/types/SearchBillingPricesParams.d.ts +2 -0
- package/serialization/resources/billing/types/SearchBillingPricesParams.js +2 -0
- package/serialization/resources/billing/types/SearchBillingPricesRequestTiersMode.d.ts +10 -0
- package/serialization/resources/billing/types/SearchBillingPricesRequestTiersMode.js +41 -0
- package/serialization/resources/billing/types/SearchBillingPricesResponseParamsTiersMode.d.ts +10 -0
- package/serialization/resources/billing/types/SearchBillingPricesResponseParamsTiersMode.js +41 -0
- package/serialization/resources/billing/types/index.d.ts +6 -3
- package/serialization/resources/billing/types/index.js +6 -3
- package/serialization/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +26 -0
- package/serialization/resources/companies/types/CountCompaniesForAdvancedFilterParams.js +57 -0
- package/serialization/resources/companies/types/CountCompaniesForAdvancedFilterRequestSortOrderDirection.d.ts +10 -0
- package/serialization/resources/companies/types/CountCompaniesForAdvancedFilterRequestSortOrderDirection.js +41 -0
- package/serialization/resources/companies/types/CountCompaniesForAdvancedFilterResponse.d.ts +15 -0
- package/serialization/resources/companies/types/CountCompaniesForAdvancedFilterResponse.js +46 -0
- package/serialization/resources/companies/types/CountCompaniesForAdvancedFilterResponseParamsSortOrderDirection.d.ts +10 -0
- package/serialization/resources/companies/types/CountCompaniesForAdvancedFilterResponseParamsSortOrderDirection.js +41 -0
- package/serialization/resources/companies/types/CountCompaniesParams.d.ts +1 -0
- package/serialization/resources/companies/types/CountCompaniesParams.js +1 -0
- package/serialization/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +26 -0
- package/serialization/resources/companies/types/ListCompaniesForAdvancedFilterParams.js +57 -0
- package/serialization/resources/companies/types/ListCompaniesForAdvancedFilterRequestSortOrderDirection.d.ts +10 -0
- package/serialization/resources/companies/types/ListCompaniesForAdvancedFilterRequestSortOrderDirection.js +41 -0
- package/serialization/resources/companies/types/ListCompaniesForAdvancedFilterResponse.d.ts +15 -0
- package/serialization/resources/companies/types/ListCompaniesForAdvancedFilterResponse.js +46 -0
- package/serialization/resources/companies/types/ListCompaniesForAdvancedFilterResponseParamsSortOrderDirection.d.ts +10 -0
- package/serialization/resources/companies/types/ListCompaniesForAdvancedFilterResponseParamsSortOrderDirection.js +41 -0
- package/serialization/resources/companies/types/ListCompaniesParams.d.ts +1 -0
- package/serialization/resources/companies/types/ListCompaniesParams.js +1 -0
- package/serialization/resources/companies/types/LookupCompanyParams.d.ts +1 -1
- package/serialization/resources/companies/types/LookupCompanyParams.js +1 -1
- package/serialization/resources/companies/types/LookupUserParams.d.ts +1 -1
- package/serialization/resources/companies/types/LookupUserParams.js +1 -1
- package/serialization/resources/companies/types/index.d.ts +8 -0
- package/serialization/resources/companies/types/index.js +8 -0
- package/serialization/resources/credits/client/index.d.ts +1 -0
- package/serialization/resources/credits/client/index.js +17 -0
- package/serialization/resources/credits/client/requests/CreateBillingCreditRequestBody.d.ts +25 -0
- package/serialization/resources/credits/client/requests/CreateBillingCreditRequestBody.js +56 -0
- package/serialization/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.d.ts +18 -0
- package/serialization/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.js +49 -0
- package/serialization/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +23 -0
- package/serialization/resources/credits/client/requests/CreateCreditBundleRequestBody.js +54 -0
- package/serialization/resources/credits/client/requests/UpdateBillingCreditRequestBody.d.ts +24 -0
- package/serialization/resources/credits/client/requests/UpdateBillingCreditRequestBody.js +55 -0
- package/serialization/resources/credits/client/requests/ZeroOutGrantRequestBody.d.ts +13 -0
- package/serialization/resources/credits/client/requests/ZeroOutGrantRequestBody.js +44 -0
- package/serialization/resources/credits/client/requests/index.d.ts +5 -0
- package/serialization/resources/credits/client/requests/index.js +13 -0
- package/serialization/resources/credits/index.d.ts +2 -0
- package/serialization/resources/credits/index.js +18 -0
- package/serialization/resources/credits/types/CountBillingCreditsGrantsParams.d.ts +15 -0
- package/serialization/resources/credits/types/CountBillingCreditsGrantsParams.js +46 -0
- package/serialization/resources/credits/types/CountBillingCreditsGrantsResponse.d.ts +15 -0
- package/serialization/resources/credits/types/CountBillingCreditsGrantsResponse.js +46 -0
- package/serialization/resources/credits/types/CountBillingCreditsParams.d.ts +15 -0
- package/serialization/resources/credits/types/CountBillingCreditsParams.js +46 -0
- package/serialization/resources/credits/types/CountBillingCreditsResponse.d.ts +15 -0
- package/serialization/resources/credits/types/CountBillingCreditsResponse.js +46 -0
- package/serialization/resources/credits/types/CountBillingPlanCreditGrantsParams.d.ts +16 -0
- package/serialization/resources/credits/types/CountBillingPlanCreditGrantsParams.js +47 -0
- package/serialization/resources/credits/types/CountBillingPlanCreditGrantsResponse.d.ts +15 -0
- package/serialization/resources/credits/types/CountBillingPlanCreditGrantsResponse.js +46 -0
- package/serialization/resources/credits/types/CountCreditBundlesParams.d.ts +18 -0
- package/serialization/resources/credits/types/CountCreditBundlesParams.js +49 -0
- package/serialization/resources/credits/types/CountCreditBundlesRequestStatus.d.ts +10 -0
- package/serialization/resources/credits/types/CountCreditBundlesRequestStatus.js +41 -0
- package/serialization/resources/credits/types/CountCreditBundlesResponse.d.ts +15 -0
- package/serialization/resources/credits/types/CountCreditBundlesResponse.js +46 -0
- package/serialization/resources/credits/types/CountCreditBundlesResponseParamsStatus.d.ts +10 -0
- package/serialization/resources/credits/types/CountCreditBundlesResponseParamsStatus.js +41 -0
- package/serialization/resources/credits/types/CreateBillingCreditRequestBodyBurnStrategy.d.ts +10 -0
- package/serialization/resources/credits/types/CreateBillingCreditRequestBodyBurnStrategy.js +46 -0
- package/serialization/resources/credits/types/CreateBillingCreditRequestBodyDefaultRolloverPolicy.d.ts +10 -0
- package/serialization/resources/credits/types/CreateBillingCreditRequestBodyDefaultRolloverPolicy.js +41 -0
- package/serialization/resources/credits/types/CreateBillingCreditResponse.d.ts +14 -0
- package/serialization/resources/credits/types/CreateBillingCreditResponse.js +45 -0
- package/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetCadence.d.ts +10 -0
- package/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetCadence.js +41 -0
- package/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetStart.d.ts +10 -0
- package/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetStart.js +41 -0
- package/serialization/resources/credits/types/CreateBillingPlanCreditGrantResponse.d.ts +14 -0
- package/serialization/resources/credits/types/CreateBillingPlanCreditGrantResponse.js +45 -0
- package/serialization/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.d.ts +10 -0
- package/serialization/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.js +41 -0
- package/serialization/resources/credits/types/CreateCreditBundleRequestBodyStatus.d.ts +10 -0
- package/serialization/resources/credits/types/CreateCreditBundleRequestBodyStatus.js +41 -0
- package/serialization/resources/credits/types/CreateCreditBundleResponse.d.ts +14 -0
- package/serialization/resources/credits/types/CreateCreditBundleResponse.js +45 -0
- package/serialization/resources/credits/types/DeleteBillingPlanCreditGrantResponse.d.ts +14 -0
- package/serialization/resources/credits/types/DeleteBillingPlanCreditGrantResponse.js +45 -0
- package/serialization/resources/credits/types/DeleteCreditBundleResponse.d.ts +14 -0
- package/serialization/resources/credits/types/DeleteCreditBundleResponse.js +45 -0
- package/serialization/resources/credits/types/GetCreditBundleResponse.d.ts +14 -0
- package/serialization/resources/credits/types/GetCreditBundleResponse.js +45 -0
- package/serialization/resources/credits/types/GetSingleBillingCreditResponse.d.ts +14 -0
- package/serialization/resources/credits/types/GetSingleBillingCreditResponse.js +45 -0
- package/serialization/resources/credits/types/ListBillingCreditsParams.d.ts +15 -0
- package/serialization/resources/credits/types/ListBillingCreditsParams.js +46 -0
- package/serialization/resources/credits/types/ListBillingCreditsResponse.d.ts +15 -0
- package/serialization/resources/credits/types/ListBillingCreditsResponse.js +46 -0
- package/serialization/resources/credits/types/ListBillingPlanCreditGrantsParams.d.ts +16 -0
- package/serialization/resources/credits/types/ListBillingPlanCreditGrantsParams.js +47 -0
- package/serialization/resources/credits/types/ListBillingPlanCreditGrantsResponse.d.ts +15 -0
- package/serialization/resources/credits/types/ListBillingPlanCreditGrantsResponse.js +46 -0
- package/serialization/resources/credits/types/ListCompanyGrantsParams.d.ts +18 -0
- package/serialization/resources/credits/types/ListCompanyGrantsParams.js +49 -0
- package/serialization/resources/credits/types/ListCompanyGrantsRequestDir.d.ts +10 -0
- package/serialization/resources/credits/types/ListCompanyGrantsRequestDir.js +41 -0
- package/serialization/resources/credits/types/ListCompanyGrantsRequestOrder.d.ts +10 -0
- package/serialization/resources/credits/types/ListCompanyGrantsRequestOrder.js +41 -0
- package/serialization/resources/credits/types/ListCompanyGrantsResponse.d.ts +15 -0
- package/serialization/resources/credits/types/ListCompanyGrantsResponse.js +46 -0
- package/serialization/resources/credits/types/ListCompanyGrantsResponseParamsDir.d.ts +10 -0
- package/serialization/resources/credits/types/ListCompanyGrantsResponseParamsDir.js +41 -0
- package/serialization/resources/credits/types/ListCompanyGrantsResponseParamsOrder.d.ts +10 -0
- package/serialization/resources/credits/types/ListCompanyGrantsResponseParamsOrder.js +41 -0
- package/serialization/resources/credits/types/ListCreditBundlesParams.d.ts +18 -0
- package/serialization/resources/credits/types/ListCreditBundlesParams.js +49 -0
- package/serialization/resources/credits/types/ListCreditBundlesRequestStatus.d.ts +10 -0
- package/serialization/resources/credits/types/ListCreditBundlesRequestStatus.js +41 -0
- package/serialization/resources/credits/types/ListCreditBundlesResponse.d.ts +15 -0
- package/serialization/resources/credits/types/ListCreditBundlesResponse.js +46 -0
- package/serialization/resources/credits/types/ListCreditBundlesResponseParamsStatus.d.ts +10 -0
- package/serialization/resources/credits/types/ListCreditBundlesResponseParamsStatus.js +41 -0
- package/serialization/resources/credits/types/ListGrantsForCreditParams.d.ts +15 -0
- package/serialization/resources/credits/types/ListGrantsForCreditParams.js +46 -0
- package/serialization/resources/credits/types/ListGrantsForCreditResponse.d.ts +15 -0
- package/serialization/resources/credits/types/ListGrantsForCreditResponse.js +46 -0
- package/serialization/resources/credits/types/UpdateBillingCreditRequestBodyBurnStrategy.d.ts +10 -0
- package/serialization/resources/credits/types/UpdateBillingCreditRequestBodyBurnStrategy.js +46 -0
- package/serialization/resources/credits/types/UpdateBillingCreditRequestBodyDefaultRolloverPolicy.d.ts +10 -0
- package/serialization/resources/credits/types/UpdateBillingCreditRequestBodyDefaultRolloverPolicy.js +41 -0
- package/serialization/resources/credits/types/UpdateBillingCreditResponse.d.ts +14 -0
- package/serialization/resources/credits/types/UpdateBillingCreditResponse.js +45 -0
- package/serialization/resources/credits/types/UpdateCreditBundleResponse.d.ts +14 -0
- package/serialization/resources/credits/types/UpdateCreditBundleResponse.js +45 -0
- package/serialization/resources/credits/types/ZeroOutGrantRequestBodyReason.d.ts +10 -0
- package/serialization/resources/credits/types/ZeroOutGrantRequestBodyReason.js +41 -0
- package/serialization/resources/credits/types/ZeroOutGrantResponse.d.ts +14 -0
- package/serialization/resources/credits/types/ZeroOutGrantResponse.js +45 -0
- package/serialization/resources/credits/types/index.d.ts +45 -0
- package/serialization/resources/credits/types/index.js +61 -0
- package/serialization/resources/dataexports/client/index.d.ts +1 -0
- package/serialization/resources/dataexports/client/index.js +17 -0
- package/serialization/resources/dataexports/client/requests/CreateDataExportRequestBody.d.ts +12 -0
- package/serialization/resources/dataexports/client/requests/CreateDataExportRequestBody.js +43 -0
- package/serialization/resources/dataexports/client/requests/index.d.ts +1 -0
- package/serialization/resources/dataexports/client/requests/index.js +5 -0
- package/serialization/resources/dataexports/index.d.ts +2 -0
- package/serialization/resources/dataexports/index.js +18 -0
- package/serialization/resources/dataexports/types/CreateDataExportResponse.d.ts +14 -0
- package/serialization/resources/dataexports/types/CreateDataExportResponse.js +45 -0
- package/serialization/resources/dataexports/types/index.d.ts +1 -0
- package/serialization/resources/dataexports/types/index.js +17 -0
- package/serialization/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +1 -0
- package/serialization/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.js +1 -0
- package/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +13 -1
- package/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.js +13 -1
- package/serialization/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +1 -0
- package/serialization/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.js +1 -0
- package/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +13 -1
- package/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.js +13 -1
- package/serialization/resources/entitlements/types/CreateCompanyOverrideRequestBodyValueType.d.ts +1 -1
- package/serialization/resources/entitlements/types/CreateCompanyOverrideRequestBodyValueType.js +1 -1
- package/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyPriceBehavior.d.ts +10 -0
- package/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyPriceBehavior.js +41 -0
- package/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyValueType.d.ts +1 -1
- package/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyValueType.js +1 -1
- package/serialization/resources/entitlements/types/GetFeatureUsageByCompanyParams.d.ts +1 -1
- package/serialization/resources/entitlements/types/GetFeatureUsageByCompanyParams.js +1 -1
- package/serialization/resources/entitlements/types/UpdateCompanyOverrideRequestBodyValueType.d.ts +1 -1
- package/serialization/resources/entitlements/types/UpdateCompanyOverrideRequestBodyValueType.js +1 -1
- package/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyPriceBehavior.d.ts +10 -0
- package/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyPriceBehavior.js +41 -0
- package/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyValueType.d.ts +1 -1
- package/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyValueType.js +1 -1
- package/serialization/resources/entitlements/types/index.d.ts +2 -0
- package/serialization/resources/entitlements/types/index.js +2 -0
- package/serialization/resources/events/types/ListEventsParams.d.ts +2 -1
- package/serialization/resources/events/types/ListEventsParams.js +2 -1
- package/serialization/resources/events/types/ListEventsRequestEventTypesItem.d.ts +10 -0
- package/serialization/resources/events/types/ListEventsRequestEventTypesItem.js +41 -0
- package/serialization/resources/events/types/ListEventsResponseParamsEventTypesItem.d.ts +10 -0
- package/serialization/resources/events/types/ListEventsResponseParamsEventTypesItem.js +41 -0
- package/serialization/resources/events/types/index.d.ts +2 -0
- package/serialization/resources/events/types/index.js +2 -0
- package/serialization/resources/features/client/requests/CreateFeatureRequestBody.d.ts +2 -1
- package/serialization/resources/features/client/requests/CreateFeatureRequestBody.js +2 -1
- package/serialization/resources/features/client/requests/UpdateFeatureRequestBody.d.ts +2 -1
- package/serialization/resources/features/client/requests/UpdateFeatureRequestBody.js +2 -1
- package/serialization/resources/features/types/CountFeaturesParams.d.ts +2 -0
- package/serialization/resources/features/types/CountFeaturesParams.js +2 -0
- package/serialization/resources/features/types/CreateFeatureRequestBodyLifecyclePhase.d.ts +10 -0
- package/serialization/resources/features/types/CreateFeatureRequestBodyLifecyclePhase.js +51 -0
- package/serialization/resources/features/types/ListFeaturesParams.d.ts +2 -0
- package/serialization/resources/features/types/ListFeaturesParams.js +2 -0
- package/serialization/resources/features/types/UpdateFeatureRequestBodyLifecyclePhase.d.ts +10 -0
- package/serialization/resources/features/types/UpdateFeatureRequestBodyLifecyclePhase.js +51 -0
- package/serialization/resources/features/types/index.d.ts +2 -0
- package/serialization/resources/features/types/index.js +2 -0
- package/serialization/resources/index.d.ts +6 -0
- package/serialization/resources/index.js +7 -1
- package/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +2 -0
- package/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.js +2 -0
- package/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +2 -0
- package/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.js +2 -0
- package/serialization/resources/plans/client/requests/CreatePlanTraitRequestBody.d.ts +14 -0
- package/serialization/resources/plans/client/requests/CreatePlanTraitRequestBody.js +45 -0
- package/serialization/resources/plans/client/requests/UpdatePlanTraitRequestBody.d.ts +13 -0
- package/serialization/resources/plans/client/requests/UpdatePlanTraitRequestBody.js +44 -0
- package/serialization/resources/plans/client/requests/UpsertBillingProductRequestBody.d.ts +7 -1
- package/serialization/resources/plans/client/requests/UpsertBillingProductRequestBody.js +7 -1
- package/serialization/resources/plans/client/requests/index.d.ts +2 -0
- package/serialization/resources/plans/client/requests/index.js +5 -1
- package/serialization/resources/plans/types/CountPlanTraitsParams.d.ts +16 -0
- package/serialization/resources/plans/types/CountPlanTraitsParams.js +47 -0
- package/serialization/resources/plans/types/CountPlanTraitsResponse.d.ts +15 -0
- package/serialization/resources/plans/types/CountPlanTraitsResponse.js +46 -0
- package/serialization/resources/plans/types/CreatePlanTraitResponse.d.ts +14 -0
- package/serialization/resources/plans/types/CreatePlanTraitResponse.js +45 -0
- package/serialization/resources/plans/types/DeletePlanTraitResponse.d.ts +14 -0
- package/serialization/resources/plans/types/DeletePlanTraitResponse.js +45 -0
- package/serialization/resources/plans/types/GetPlanTraitResponse.d.ts +14 -0
- package/serialization/resources/plans/types/GetPlanTraitResponse.js +45 -0
- package/serialization/resources/plans/types/ListPlanTraitsParams.d.ts +16 -0
- package/serialization/resources/plans/types/ListPlanTraitsParams.js +47 -0
- package/serialization/resources/plans/types/ListPlanTraitsResponse.d.ts +15 -0
- package/serialization/resources/plans/types/ListPlanTraitsResponse.js +46 -0
- package/serialization/resources/plans/types/UpdatePlanTraitResponse.d.ts +14 -0
- package/serialization/resources/plans/types/UpdatePlanTraitResponse.js +45 -0
- package/serialization/resources/plans/types/UpsertBillingProductRequestBodyChargeType.d.ts +10 -0
- package/serialization/resources/plans/types/UpsertBillingProductRequestBodyChargeType.js +41 -0
- package/serialization/resources/plans/types/index.d.ts +9 -0
- package/serialization/resources/plans/types/index.js +9 -0
- package/serialization/resources/webhooks/client/requests/CreateWebhookRequestBody.d.ts +2 -0
- package/serialization/resources/webhooks/client/requests/CreateWebhookRequestBody.js +2 -0
- package/serialization/resources/webhooks/client/requests/UpdateWebhookRequestBody.d.ts +2 -0
- package/serialization/resources/webhooks/client/requests/UpdateWebhookRequestBody.js +2 -0
- package/serialization/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.d.ts +1 -1
- package/serialization/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.js +4 -0
- package/serialization/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.d.ts +1 -1
- package/serialization/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.js +4 -0
- package/serialization/types/BillingCreditBundleResponseData.d.ts +24 -0
- package/serialization/types/BillingCreditBundleResponseData.js +55 -0
- package/serialization/types/BillingCreditGrantResponseData.d.ts +29 -0
- package/serialization/types/BillingCreditGrantResponseData.js +60 -0
- package/serialization/types/BillingCreditResponseData.d.ts +28 -0
- package/serialization/types/BillingCreditResponseData.js +59 -0
- package/serialization/types/BillingPlanCreditGrantResponseData.d.ts +20 -0
- package/serialization/types/BillingPlanCreditGrantResponseData.js +51 -0
- package/serialization/types/BillingPriceResponseData.d.ts +2 -0
- package/serialization/types/BillingPriceResponseData.js +2 -0
- package/serialization/types/BillingPriceView.d.ts +8 -0
- package/serialization/types/BillingPriceView.js +8 -0
- package/serialization/types/BillingProductDetailResponseData.d.ts +2 -0
- package/serialization/types/BillingProductDetailResponseData.js +2 -0
- package/serialization/types/BillingProductForSubscriptionResponseData.d.ts +5 -0
- package/serialization/types/BillingProductForSubscriptionResponseData.js +5 -0
- package/serialization/types/BillingProductPlanResponseData.d.ts +3 -0
- package/serialization/types/BillingProductPlanResponseData.js +3 -0
- package/serialization/types/BillingProductPriceResponseData.d.ts +4 -0
- package/serialization/types/BillingProductPriceResponseData.js +4 -0
- package/serialization/types/BillingProductPriceTierResponseData.d.ts +15 -0
- package/serialization/types/BillingProductPriceTierResponseData.js +46 -0
- package/serialization/types/BillingProductPricing.d.ts +2 -0
- package/serialization/types/BillingProductPricing.js +2 -0
- package/serialization/types/BillingProductResponseData.d.ts +2 -0
- package/serialization/types/BillingProductResponseData.js +2 -0
- package/serialization/types/ChangeSubscriptionInternalRequestBody.d.ts +3 -0
- package/serialization/types/ChangeSubscriptionInternalRequestBody.js +3 -0
- package/serialization/types/ChangeSubscriptionRequestBody.d.ts +3 -0
- package/serialization/types/ChangeSubscriptionRequestBody.js +3 -0
- package/serialization/types/CheckFlagResponseData.d.ts +1 -0
- package/serialization/types/CheckFlagResponseData.js +1 -0
- package/serialization/types/CheckoutDataResponseData.d.ts +4 -0
- package/serialization/types/CheckoutDataResponseData.js +4 -0
- package/serialization/types/CompanyDetailResponseData.d.ts +2 -1
- package/serialization/types/CompanyDetailResponseData.js +2 -1
- package/serialization/types/CompanyOverrideResponseData.d.ts +1 -0
- package/serialization/types/CompanyOverrideResponseData.js +1 -0
- package/serialization/types/CompanyPlanDetailResponseData.d.ts +4 -0
- package/serialization/types/CompanyPlanDetailResponseData.js +4 -0
- package/serialization/types/CompanyPlanWithBillingSubView.d.ts +2 -0
- package/serialization/types/CompanyPlanWithBillingSubView.js +2 -0
- package/serialization/types/CompanyViewWithFeatureUsageResponseData.d.ts +39 -0
- package/serialization/types/CompanyViewWithFeatureUsageResponseData.js +70 -0
- package/serialization/types/CompatiblePlans.d.ts +13 -0
- package/serialization/types/CompatiblePlans.js +44 -0
- package/serialization/types/CompatiblePlansResponseData.d.ts +13 -0
- package/serialization/types/CompatiblePlansResponseData.js +44 -0
- package/serialization/types/ComponentHydrateResponseData.d.ts +2 -0
- package/serialization/types/ComponentHydrateResponseData.js +2 -0
- package/serialization/types/ComponentPreviewResponseData.d.ts +2 -0
- package/serialization/types/ComponentPreviewResponseData.js +2 -0
- package/serialization/types/CreateBillingPriceTierRequestBody.d.ts +1 -0
- package/serialization/types/CreateBillingPriceTierRequestBody.js +1 -0
- package/serialization/types/CreateEntitlementReqCommon.d.ts +1 -0
- package/serialization/types/CreateEntitlementReqCommon.js +1 -0
- package/serialization/types/CreateEntitlementReqCommonValueType.d.ts +1 -1
- package/serialization/types/CreateEntitlementReqCommonValueType.js +1 -1
- package/serialization/types/CreateFlagRequestBody.d.ts +1 -1
- package/serialization/types/CreateFlagRequestBody.js +1 -1
- package/serialization/types/CreateOrUpdateFlagRequestBody.d.ts +1 -1
- package/serialization/types/CreateOrUpdateFlagRequestBody.js +1 -1
- package/serialization/types/CreatePriceTierRequestBody.d.ts +15 -0
- package/serialization/types/CreatePriceTierRequestBody.js +46 -0
- package/serialization/types/CreditBundlePurchaseResponseData.d.ts +15 -0
- package/serialization/types/CreditBundlePurchaseResponseData.js +46 -0
- package/serialization/types/DataExportResponseData.d.ts +20 -0
- package/serialization/types/DataExportResponseData.js +51 -0
- package/serialization/types/EntitlementTriggerConfig.d.ts +12 -0
- package/serialization/types/EntitlementTriggerConfig.js +43 -0
- package/serialization/types/EventSummaryResponseData.d.ts +2 -2
- package/serialization/types/EventSummaryResponseData.js +2 -2
- package/serialization/types/FeatureUsageDataResponseData.d.ts +20 -0
- package/serialization/types/FeatureUsageDataResponseData.js +51 -0
- package/serialization/types/PlanDetailResponseData.d.ts +3 -0
- package/serialization/types/PlanDetailResponseData.js +3 -0
- package/serialization/types/PlanEntitlementResponseData.d.ts +5 -0
- package/serialization/types/PlanEntitlementResponseData.js +5 -0
- package/serialization/types/PlanGroupPlanDetailResponseData.d.ts +4 -0
- package/serialization/types/PlanGroupPlanDetailResponseData.js +4 -0
- package/serialization/types/PlanGroupResponseData.d.ts +2 -0
- package/serialization/types/PlanGroupResponseData.js +2 -0
- package/serialization/types/PlanTraitResponseData.d.ts +19 -0
- package/serialization/types/PlanTraitResponseData.js +50 -0
- package/serialization/types/PreviewSubscriptionChangeResponseData.d.ts +5 -0
- package/serialization/types/PreviewSubscriptionChangeResponseData.js +5 -0
- package/serialization/types/PreviewSubscriptionFinanceResponseData.d.ts +21 -0
- package/serialization/types/PreviewSubscriptionFinanceResponseData.js +52 -0
- package/serialization/types/PreviewSubscriptionUpcomingInvoiceLineItems.d.ts +16 -0
- package/serialization/types/PreviewSubscriptionUpcomingInvoiceLineItems.js +47 -0
- package/serialization/types/QuickstartResp.d.ts +12 -0
- package/serialization/types/QuickstartResp.js +43 -0
- package/serialization/types/UpdateCreditBundleRequestBody.d.ts +13 -0
- package/serialization/types/UpdateCreditBundleRequestBody.js +44 -0
- package/serialization/types/UpdateEntitlementReqCommon.d.ts +1 -0
- package/serialization/types/UpdateEntitlementReqCommon.js +1 -0
- package/serialization/types/UpdateEntitlementReqCommonValueType.d.ts +1 -1
- package/serialization/types/UpdateEntitlementReqCommonValueType.js +1 -1
- package/serialization/types/UpsertUserRequestBody.d.ts +3 -1
- package/serialization/types/UpsertUserRequestBody.js +5 -1
- package/serialization/types/UpsertUserSubRequestBody.d.ts +1 -0
- package/serialization/types/UpsertUserSubRequestBody.js +1 -0
- package/serialization/types/UsageBasedEntitlementRequestBody.d.ts +12 -1
- package/serialization/types/UsageBasedEntitlementRequestBody.js +12 -1
- package/serialization/types/UsageBasedEntitlementRequestBodyPriceBehavior.d.ts +10 -0
- package/serialization/types/UsageBasedEntitlementRequestBodyPriceBehavior.js +41 -0
- package/serialization/types/UsageBasedEntitlementResponseData.d.ts +1 -0
- package/serialization/types/UsageBasedEntitlementResponseData.js +1 -0
- package/serialization/types/WebhookResponseData.d.ts +2 -0
- package/serialization/types/WebhookResponseData.js +2 -0
- package/serialization/types/index.d.ts +19 -0
- package/serialization/types/index.js +19 -0
- package/dist/serialization/resources/billing/types/CreateBillingPriceRequestBodyTierMode.d.ts +0 -10
- package/serialization/resources/billing/types/CreateBillingPriceRequestBodyTierMode.d.ts +0 -10
- /package/api/resources/{billing/client/requests/ListCustomersRequest.js → accounts/types/QuickstartResponse.js} +0 -0
- /package/api/resources/billing/{types/ListCustomersParams.js → client/requests/ListCustomersWithSubscriptionsRequest.js} +0 -0
- /package/api/resources/billing/types/{ListCustomersResponse.js → ListCustomersWithSubscriptionsParams.js} +0 -0
- /package/{dist/api/resources/billing/client/requests/ListCustomersRequest.js → api/resources/billing/types/ListCustomersWithSubscriptionsResponse.js} +0 -0
- /package/{dist/api/resources/billing/types/ListCustomersParams.js → api/resources/companies/client/requests/CountCompaniesForAdvancedFilterRequest.js} +0 -0
- /package/{dist/api/resources/billing/types/ListCustomersResponse.js → api/resources/companies/client/requests/ListCompaniesForAdvancedFilterRequest.js} +0 -0
package/reference.md
CHANGED
|
@@ -699,6 +699,46 @@ await client.accounts.deleteEnvironment("environment_id");
|
|
|
699
699
|
</dl>
|
|
700
700
|
</details>
|
|
701
701
|
|
|
702
|
+
<details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">quickstart</a>() -> Schematic.QuickstartResponse</code></summary>
|
|
703
|
+
<dl>
|
|
704
|
+
<dd>
|
|
705
|
+
|
|
706
|
+
#### 🔌 Usage
|
|
707
|
+
|
|
708
|
+
<dl>
|
|
709
|
+
<dd>
|
|
710
|
+
|
|
711
|
+
<dl>
|
|
712
|
+
<dd>
|
|
713
|
+
|
|
714
|
+
```typescript
|
|
715
|
+
await client.accounts.quickstart();
|
|
716
|
+
```
|
|
717
|
+
|
|
718
|
+
</dd>
|
|
719
|
+
</dl>
|
|
720
|
+
</dd>
|
|
721
|
+
</dl>
|
|
722
|
+
|
|
723
|
+
#### ⚙️ Parameters
|
|
724
|
+
|
|
725
|
+
<dl>
|
|
726
|
+
<dd>
|
|
727
|
+
|
|
728
|
+
<dl>
|
|
729
|
+
<dd>
|
|
730
|
+
|
|
731
|
+
**requestOptions:** `Accounts.RequestOptions`
|
|
732
|
+
|
|
733
|
+
</dd>
|
|
734
|
+
</dl>
|
|
735
|
+
</dd>
|
|
736
|
+
</dl>
|
|
737
|
+
|
|
738
|
+
</dd>
|
|
739
|
+
</dl>
|
|
740
|
+
</details>
|
|
741
|
+
|
|
702
742
|
## features
|
|
703
743
|
|
|
704
744
|
<details><summary><code>client.features.<a href="/src/api/resources/features/client/Client.ts">countAudienceCompanies</a>({ ...params }) -> Schematic.CountAudienceCompaniesResponse</code></summary>
|
|
@@ -1333,7 +1373,7 @@ await client.features.listFlags();
|
|
|
1333
1373
|
await client.features.createFlag({
|
|
1334
1374
|
defaultValue: true,
|
|
1335
1375
|
description: "description",
|
|
1336
|
-
flagType: "
|
|
1376
|
+
flagType: "boolean",
|
|
1337
1377
|
key: "key",
|
|
1338
1378
|
name: "name",
|
|
1339
1379
|
});
|
|
@@ -1435,7 +1475,7 @@ await client.features.getFlag("flag_id");
|
|
|
1435
1475
|
await client.features.updateFlag("flag_id", {
|
|
1436
1476
|
defaultValue: true,
|
|
1437
1477
|
description: "description",
|
|
1438
|
-
flagType: "
|
|
1478
|
+
flagType: "boolean",
|
|
1439
1479
|
key: "key",
|
|
1440
1480
|
name: "name",
|
|
1441
1481
|
});
|
|
@@ -1926,7 +1966,7 @@ await client.billing.upsertBillingCustomer({
|
|
|
1926
1966
|
</dl>
|
|
1927
1967
|
</details>
|
|
1928
1968
|
|
|
1929
|
-
<details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">
|
|
1969
|
+
<details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">listCustomersWithSubscriptions</a>({ ...params }) -> Schematic.ListCustomersWithSubscriptionsResponse</code></summary>
|
|
1930
1970
|
<dl>
|
|
1931
1971
|
<dd>
|
|
1932
1972
|
|
|
@@ -1939,7 +1979,7 @@ await client.billing.upsertBillingCustomer({
|
|
|
1939
1979
|
<dd>
|
|
1940
1980
|
|
|
1941
1981
|
```typescript
|
|
1942
|
-
await client.billing.
|
|
1982
|
+
await client.billing.listCustomersWithSubscriptions();
|
|
1943
1983
|
```
|
|
1944
1984
|
|
|
1945
1985
|
</dd>
|
|
@@ -1955,7 +1995,7 @@ await client.billing.listCustomers();
|
|
|
1955
1995
|
<dl>
|
|
1956
1996
|
<dd>
|
|
1957
1997
|
|
|
1958
|
-
**request:** `Schematic.
|
|
1998
|
+
**request:** `Schematic.ListCustomersWithSubscriptionsRequest`
|
|
1959
1999
|
|
|
1960
2000
|
</dd>
|
|
1961
2001
|
</dl>
|
|
@@ -2393,6 +2433,7 @@ await client.billing.searchBillingPrices();
|
|
|
2393
2433
|
|
|
2394
2434
|
```typescript
|
|
2395
2435
|
await client.billing.upsertBillingPrice({
|
|
2436
|
+
billingScheme: "per_unit",
|
|
2396
2437
|
currency: "currency",
|
|
2397
2438
|
externalAccountId: "external_account_id",
|
|
2398
2439
|
interval: "interval",
|
|
@@ -2599,12 +2640,9 @@ await client.billing.deleteProductPrice("billing_id");
|
|
|
2599
2640
|
|
|
2600
2641
|
```typescript
|
|
2601
2642
|
await client.billing.upsertBillingProduct({
|
|
2602
|
-
active: true,
|
|
2603
|
-
currency: "currency",
|
|
2604
2643
|
externalId: "external_id",
|
|
2605
2644
|
name: "name",
|
|
2606
2645
|
price: 1.1,
|
|
2607
|
-
quantity: 1,
|
|
2608
2646
|
});
|
|
2609
2647
|
```
|
|
2610
2648
|
|
|
@@ -2810,9 +2848,9 @@ await client.billing.upsertBillingSubscription({
|
|
|
2810
2848
|
</dl>
|
|
2811
2849
|
</details>
|
|
2812
2850
|
|
|
2813
|
-
##
|
|
2851
|
+
## credits
|
|
2814
2852
|
|
|
2815
|
-
<details><summary><code>client.
|
|
2853
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">listBillingCredits</a>({ ...params }) -> Schematic.ListBillingCreditsResponse</code></summary>
|
|
2816
2854
|
<dl>
|
|
2817
2855
|
<dd>
|
|
2818
2856
|
|
|
@@ -2825,23 +2863,7 @@ await client.billing.upsertBillingSubscription({
|
|
|
2825
2863
|
<dd>
|
|
2826
2864
|
|
|
2827
2865
|
```typescript
|
|
2828
|
-
await client.
|
|
2829
|
-
addOnIds: [
|
|
2830
|
-
{
|
|
2831
|
-
addOnId: "add_on_id",
|
|
2832
|
-
priceId: "price_id",
|
|
2833
|
-
},
|
|
2834
|
-
],
|
|
2835
|
-
companyId: "company_id",
|
|
2836
|
-
newPlanId: "new_plan_id",
|
|
2837
|
-
newPriceId: "new_price_id",
|
|
2838
|
-
payInAdvance: [
|
|
2839
|
-
{
|
|
2840
|
-
priceId: "price_id",
|
|
2841
|
-
quantity: 1,
|
|
2842
|
-
},
|
|
2843
|
-
],
|
|
2844
|
-
});
|
|
2866
|
+
await client.credits.listBillingCredits();
|
|
2845
2867
|
```
|
|
2846
2868
|
|
|
2847
2869
|
</dd>
|
|
@@ -2857,7 +2879,7 @@ await client.checkout.internal({
|
|
|
2857
2879
|
<dl>
|
|
2858
2880
|
<dd>
|
|
2859
2881
|
|
|
2860
|
-
**request:** `Schematic.
|
|
2882
|
+
**request:** `Schematic.ListBillingCreditsRequest`
|
|
2861
2883
|
|
|
2862
2884
|
</dd>
|
|
2863
2885
|
</dl>
|
|
@@ -2865,7 +2887,7 @@ await client.checkout.internal({
|
|
|
2865
2887
|
<dl>
|
|
2866
2888
|
<dd>
|
|
2867
2889
|
|
|
2868
|
-
**requestOptions:** `
|
|
2890
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
2869
2891
|
|
|
2870
2892
|
</dd>
|
|
2871
2893
|
</dl>
|
|
@@ -2876,7 +2898,7 @@ await client.checkout.internal({
|
|
|
2876
2898
|
</dl>
|
|
2877
2899
|
</details>
|
|
2878
2900
|
|
|
2879
|
-
<details><summary><code>client.
|
|
2901
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">createBillingCredit</a>({ ...params }) -> Schematic.CreateBillingCreditResponse</code></summary>
|
|
2880
2902
|
<dl>
|
|
2881
2903
|
<dd>
|
|
2882
2904
|
|
|
@@ -2889,8 +2911,10 @@ await client.checkout.internal({
|
|
|
2889
2911
|
<dd>
|
|
2890
2912
|
|
|
2891
2913
|
```typescript
|
|
2892
|
-
await client.
|
|
2893
|
-
|
|
2914
|
+
await client.credits.createBillingCredit({
|
|
2915
|
+
currency: "currency",
|
|
2916
|
+
description: "description",
|
|
2917
|
+
name: "name",
|
|
2894
2918
|
});
|
|
2895
2919
|
```
|
|
2896
2920
|
|
|
@@ -2907,7 +2931,7 @@ await client.checkout.getCheckoutData({
|
|
|
2907
2931
|
<dl>
|
|
2908
2932
|
<dd>
|
|
2909
2933
|
|
|
2910
|
-
**request:** `Schematic.
|
|
2934
|
+
**request:** `Schematic.CreateBillingCreditRequestBody`
|
|
2911
2935
|
|
|
2912
2936
|
</dd>
|
|
2913
2937
|
</dl>
|
|
@@ -2915,7 +2939,7 @@ await client.checkout.getCheckoutData({
|
|
|
2915
2939
|
<dl>
|
|
2916
2940
|
<dd>
|
|
2917
2941
|
|
|
2918
|
-
**requestOptions:** `
|
|
2942
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
2919
2943
|
|
|
2920
2944
|
</dd>
|
|
2921
2945
|
</dl>
|
|
@@ -2926,7 +2950,7 @@ await client.checkout.getCheckoutData({
|
|
|
2926
2950
|
</dl>
|
|
2927
2951
|
</details>
|
|
2928
2952
|
|
|
2929
|
-
<details><summary><code>client.
|
|
2953
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">getSingleBillingCredit</a>(billingId) -> Schematic.GetSingleBillingCreditResponse</code></summary>
|
|
2930
2954
|
<dl>
|
|
2931
2955
|
<dd>
|
|
2932
2956
|
|
|
@@ -2939,23 +2963,7 @@ await client.checkout.getCheckoutData({
|
|
|
2939
2963
|
<dd>
|
|
2940
2964
|
|
|
2941
2965
|
```typescript
|
|
2942
|
-
await client.
|
|
2943
|
-
addOnIds: [
|
|
2944
|
-
{
|
|
2945
|
-
addOnId: "add_on_id",
|
|
2946
|
-
priceId: "price_id",
|
|
2947
|
-
},
|
|
2948
|
-
],
|
|
2949
|
-
companyId: "company_id",
|
|
2950
|
-
newPlanId: "new_plan_id",
|
|
2951
|
-
newPriceId: "new_price_id",
|
|
2952
|
-
payInAdvance: [
|
|
2953
|
-
{
|
|
2954
|
-
priceId: "price_id",
|
|
2955
|
-
quantity: 1,
|
|
2956
|
-
},
|
|
2957
|
-
],
|
|
2958
|
-
});
|
|
2966
|
+
await client.credits.getSingleBillingCredit("billing_id");
|
|
2959
2967
|
```
|
|
2960
2968
|
|
|
2961
2969
|
</dd>
|
|
@@ -2971,7 +2979,7 @@ await client.checkout.previewCheckoutInternal({
|
|
|
2971
2979
|
<dl>
|
|
2972
2980
|
<dd>
|
|
2973
2981
|
|
|
2974
|
-
**
|
|
2982
|
+
**billingId:** `string` — billing_id
|
|
2975
2983
|
|
|
2976
2984
|
</dd>
|
|
2977
2985
|
</dl>
|
|
@@ -2979,7 +2987,7 @@ await client.checkout.previewCheckoutInternal({
|
|
|
2979
2987
|
<dl>
|
|
2980
2988
|
<dd>
|
|
2981
2989
|
|
|
2982
|
-
**requestOptions:** `
|
|
2990
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
2983
2991
|
|
|
2984
2992
|
</dd>
|
|
2985
2993
|
</dl>
|
|
@@ -2990,7 +2998,7 @@ await client.checkout.previewCheckoutInternal({
|
|
|
2990
2998
|
</dl>
|
|
2991
2999
|
</details>
|
|
2992
3000
|
|
|
2993
|
-
<details><summary><code>client.
|
|
3001
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">updateBillingCredit</a>(billingId, { ...params }) -> Schematic.UpdateBillingCreditResponse</code></summary>
|
|
2994
3002
|
<dl>
|
|
2995
3003
|
<dd>
|
|
2996
3004
|
|
|
@@ -3003,7 +3011,10 @@ await client.checkout.previewCheckoutInternal({
|
|
|
3003
3011
|
<dd>
|
|
3004
3012
|
|
|
3005
3013
|
```typescript
|
|
3006
|
-
await client.
|
|
3014
|
+
await client.credits.updateBillingCredit("billing_id", {
|
|
3015
|
+
description: "description",
|
|
3016
|
+
name: "name",
|
|
3017
|
+
});
|
|
3007
3018
|
```
|
|
3008
3019
|
|
|
3009
3020
|
</dd>
|
|
@@ -3019,7 +3030,7 @@ await client.checkout.updateCustomerSubscriptionTrialEnd("subscription_id");
|
|
|
3019
3030
|
<dl>
|
|
3020
3031
|
<dd>
|
|
3021
3032
|
|
|
3022
|
-
**
|
|
3033
|
+
**billingId:** `string` — billing_id
|
|
3023
3034
|
|
|
3024
3035
|
</dd>
|
|
3025
3036
|
</dl>
|
|
@@ -3027,7 +3038,7 @@ await client.checkout.updateCustomerSubscriptionTrialEnd("subscription_id");
|
|
|
3027
3038
|
<dl>
|
|
3028
3039
|
<dd>
|
|
3029
3040
|
|
|
3030
|
-
**request:** `Schematic.
|
|
3041
|
+
**request:** `Schematic.UpdateBillingCreditRequestBody`
|
|
3031
3042
|
|
|
3032
3043
|
</dd>
|
|
3033
3044
|
</dl>
|
|
@@ -3035,7 +3046,7 @@ await client.checkout.updateCustomerSubscriptionTrialEnd("subscription_id");
|
|
|
3035
3046
|
<dl>
|
|
3036
3047
|
<dd>
|
|
3037
3048
|
|
|
3038
|
-
**requestOptions:** `
|
|
3049
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
3039
3050
|
|
|
3040
3051
|
</dd>
|
|
3041
3052
|
</dl>
|
|
@@ -3046,9 +3057,7 @@ await client.checkout.updateCustomerSubscriptionTrialEnd("subscription_id");
|
|
|
3046
3057
|
</dl>
|
|
3047
3058
|
</details>
|
|
3048
3059
|
|
|
3049
|
-
|
|
3050
|
-
|
|
3051
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">listCompanies</a>({ ...params }) -> Schematic.ListCompaniesResponse</code></summary>
|
|
3060
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">listCreditBundles</a>({ ...params }) -> Schematic.ListCreditBundlesResponse</code></summary>
|
|
3052
3061
|
<dl>
|
|
3053
3062
|
<dd>
|
|
3054
3063
|
|
|
@@ -3061,7 +3070,7 @@ await client.checkout.updateCustomerSubscriptionTrialEnd("subscription_id");
|
|
|
3061
3070
|
<dd>
|
|
3062
3071
|
|
|
3063
3072
|
```typescript
|
|
3064
|
-
await client.
|
|
3073
|
+
await client.credits.listCreditBundles();
|
|
3065
3074
|
```
|
|
3066
3075
|
|
|
3067
3076
|
</dd>
|
|
@@ -3077,7 +3086,7 @@ await client.companies.listCompanies();
|
|
|
3077
3086
|
<dl>
|
|
3078
3087
|
<dd>
|
|
3079
3088
|
|
|
3080
|
-
**request:** `Schematic.
|
|
3089
|
+
**request:** `Schematic.ListCreditBundlesRequest`
|
|
3081
3090
|
|
|
3082
3091
|
</dd>
|
|
3083
3092
|
</dl>
|
|
@@ -3085,7 +3094,7 @@ await client.companies.listCompanies();
|
|
|
3085
3094
|
<dl>
|
|
3086
3095
|
<dd>
|
|
3087
3096
|
|
|
3088
|
-
**requestOptions:** `
|
|
3097
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
3089
3098
|
|
|
3090
3099
|
</dd>
|
|
3091
3100
|
</dl>
|
|
@@ -3096,7 +3105,7 @@ await client.companies.listCompanies();
|
|
|
3096
3105
|
</dl>
|
|
3097
3106
|
</details>
|
|
3098
3107
|
|
|
3099
|
-
<details><summary><code>client.
|
|
3108
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">createCreditBundle</a>({ ...params }) -> Schematic.CreateCreditBundleResponse</code></summary>
|
|
3100
3109
|
<dl>
|
|
3101
3110
|
<dd>
|
|
3102
3111
|
|
|
@@ -3109,10 +3118,10 @@ await client.companies.listCompanies();
|
|
|
3109
3118
|
<dd>
|
|
3110
3119
|
|
|
3111
3120
|
```typescript
|
|
3112
|
-
await client.
|
|
3113
|
-
|
|
3114
|
-
|
|
3115
|
-
|
|
3121
|
+
await client.credits.createCreditBundle({
|
|
3122
|
+
creditId: "credit_id",
|
|
3123
|
+
currency: "currency",
|
|
3124
|
+
pricePerUnit: 1,
|
|
3116
3125
|
});
|
|
3117
3126
|
```
|
|
3118
3127
|
|
|
@@ -3129,7 +3138,7 @@ await client.companies.upsertCompany({
|
|
|
3129
3138
|
<dl>
|
|
3130
3139
|
<dd>
|
|
3131
3140
|
|
|
3132
|
-
**request:** `Schematic.
|
|
3141
|
+
**request:** `Schematic.CreateCreditBundleRequestBody`
|
|
3133
3142
|
|
|
3134
3143
|
</dd>
|
|
3135
3144
|
</dl>
|
|
@@ -3137,7 +3146,7 @@ await client.companies.upsertCompany({
|
|
|
3137
3146
|
<dl>
|
|
3138
3147
|
<dd>
|
|
3139
3148
|
|
|
3140
|
-
**requestOptions:** `
|
|
3149
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
3141
3150
|
|
|
3142
3151
|
</dd>
|
|
3143
3152
|
</dl>
|
|
@@ -3148,7 +3157,7 @@ await client.companies.upsertCompany({
|
|
|
3148
3157
|
</dl>
|
|
3149
3158
|
</details>
|
|
3150
3159
|
|
|
3151
|
-
<details><summary><code>client.
|
|
3160
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">getCreditBundle</a>(billingId) -> Schematic.GetCreditBundleResponse</code></summary>
|
|
3152
3161
|
<dl>
|
|
3153
3162
|
<dd>
|
|
3154
3163
|
|
|
@@ -3161,7 +3170,7 @@ await client.companies.upsertCompany({
|
|
|
3161
3170
|
<dd>
|
|
3162
3171
|
|
|
3163
3172
|
```typescript
|
|
3164
|
-
await client.
|
|
3173
|
+
await client.credits.getCreditBundle("billing_id");
|
|
3165
3174
|
```
|
|
3166
3175
|
|
|
3167
3176
|
</dd>
|
|
@@ -3177,7 +3186,7 @@ await client.companies.getCompany("company_id");
|
|
|
3177
3186
|
<dl>
|
|
3178
3187
|
<dd>
|
|
3179
3188
|
|
|
3180
|
-
**
|
|
3189
|
+
**billingId:** `string` — billing_id
|
|
3181
3190
|
|
|
3182
3191
|
</dd>
|
|
3183
3192
|
</dl>
|
|
@@ -3185,7 +3194,7 @@ await client.companies.getCompany("company_id");
|
|
|
3185
3194
|
<dl>
|
|
3186
3195
|
<dd>
|
|
3187
3196
|
|
|
3188
|
-
**requestOptions:** `
|
|
3197
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
3189
3198
|
|
|
3190
3199
|
</dd>
|
|
3191
3200
|
</dl>
|
|
@@ -3196,7 +3205,7 @@ await client.companies.getCompany("company_id");
|
|
|
3196
3205
|
</dl>
|
|
3197
3206
|
</details>
|
|
3198
3207
|
|
|
3199
|
-
<details><summary><code>client.
|
|
3208
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">updateCreditBundle</a>(billingId, { ...params }) -> Schematic.UpdateCreditBundleResponse</code></summary>
|
|
3200
3209
|
<dl>
|
|
3201
3210
|
<dd>
|
|
3202
3211
|
|
|
@@ -3209,7 +3218,10 @@ await client.companies.getCompany("company_id");
|
|
|
3209
3218
|
<dd>
|
|
3210
3219
|
|
|
3211
3220
|
```typescript
|
|
3212
|
-
await client.
|
|
3221
|
+
await client.credits.updateCreditBundle("billing_id", {
|
|
3222
|
+
bundleId: "bundle_id",
|
|
3223
|
+
quantity: 1,
|
|
3224
|
+
});
|
|
3213
3225
|
```
|
|
3214
3226
|
|
|
3215
3227
|
</dd>
|
|
@@ -3225,7 +3237,7 @@ await client.companies.deleteCompany("company_id");
|
|
|
3225
3237
|
<dl>
|
|
3226
3238
|
<dd>
|
|
3227
3239
|
|
|
3228
|
-
**
|
|
3240
|
+
**billingId:** `string` — billing_id
|
|
3229
3241
|
|
|
3230
3242
|
</dd>
|
|
3231
3243
|
</dl>
|
|
@@ -3233,7 +3245,15 @@ await client.companies.deleteCompany("company_id");
|
|
|
3233
3245
|
<dl>
|
|
3234
3246
|
<dd>
|
|
3235
3247
|
|
|
3236
|
-
**
|
|
3248
|
+
**request:** `Schematic.UpdateCreditBundleRequestBody`
|
|
3249
|
+
|
|
3250
|
+
</dd>
|
|
3251
|
+
</dl>
|
|
3252
|
+
|
|
3253
|
+
<dl>
|
|
3254
|
+
<dd>
|
|
3255
|
+
|
|
3256
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
3237
3257
|
|
|
3238
3258
|
</dd>
|
|
3239
3259
|
</dl>
|
|
@@ -3244,7 +3264,7 @@ await client.companies.deleteCompany("company_id");
|
|
|
3244
3264
|
</dl>
|
|
3245
3265
|
</details>
|
|
3246
3266
|
|
|
3247
|
-
<details><summary><code>client.
|
|
3267
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">deleteCreditBundle</a>(billingId) -> Schematic.DeleteCreditBundleResponse</code></summary>
|
|
3248
3268
|
<dl>
|
|
3249
3269
|
<dd>
|
|
3250
3270
|
|
|
@@ -3257,7 +3277,7 @@ await client.companies.deleteCompany("company_id");
|
|
|
3257
3277
|
<dd>
|
|
3258
3278
|
|
|
3259
3279
|
```typescript
|
|
3260
|
-
await client.
|
|
3280
|
+
await client.credits.deleteCreditBundle("billing_id");
|
|
3261
3281
|
```
|
|
3262
3282
|
|
|
3263
3283
|
</dd>
|
|
@@ -3273,7 +3293,7 @@ await client.companies.countCompanies();
|
|
|
3273
3293
|
<dl>
|
|
3274
3294
|
<dd>
|
|
3275
3295
|
|
|
3276
|
-
**
|
|
3296
|
+
**billingId:** `string` — billing_id
|
|
3277
3297
|
|
|
3278
3298
|
</dd>
|
|
3279
3299
|
</dl>
|
|
@@ -3281,7 +3301,7 @@ await client.companies.countCompanies();
|
|
|
3281
3301
|
<dl>
|
|
3282
3302
|
<dd>
|
|
3283
3303
|
|
|
3284
|
-
**requestOptions:** `
|
|
3304
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
3285
3305
|
|
|
3286
3306
|
</dd>
|
|
3287
3307
|
</dl>
|
|
@@ -3292,7 +3312,7 @@ await client.companies.countCompanies();
|
|
|
3292
3312
|
</dl>
|
|
3293
3313
|
</details>
|
|
3294
3314
|
|
|
3295
|
-
<details><summary><code>client.
|
|
3315
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">countCreditBundles</a>({ ...params }) -> Schematic.CountCreditBundlesResponse</code></summary>
|
|
3296
3316
|
<dl>
|
|
3297
3317
|
<dd>
|
|
3298
3318
|
|
|
@@ -3305,11 +3325,7 @@ await client.companies.countCompanies();
|
|
|
3305
3325
|
<dd>
|
|
3306
3326
|
|
|
3307
3327
|
```typescript
|
|
3308
|
-
await client.
|
|
3309
|
-
keys: {
|
|
3310
|
-
key: "value",
|
|
3311
|
-
},
|
|
3312
|
-
});
|
|
3328
|
+
await client.credits.countCreditBundles();
|
|
3313
3329
|
```
|
|
3314
3330
|
|
|
3315
3331
|
</dd>
|
|
@@ -3325,7 +3341,7 @@ await client.companies.createCompany({
|
|
|
3325
3341
|
<dl>
|
|
3326
3342
|
<dd>
|
|
3327
3343
|
|
|
3328
|
-
**request:** `Schematic.
|
|
3344
|
+
**request:** `Schematic.CountCreditBundlesRequest`
|
|
3329
3345
|
|
|
3330
3346
|
</dd>
|
|
3331
3347
|
</dl>
|
|
@@ -3333,7 +3349,7 @@ await client.companies.createCompany({
|
|
|
3333
3349
|
<dl>
|
|
3334
3350
|
<dd>
|
|
3335
3351
|
|
|
3336
|
-
**requestOptions:** `
|
|
3352
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
3337
3353
|
|
|
3338
3354
|
</dd>
|
|
3339
3355
|
</dl>
|
|
@@ -3344,7 +3360,7 @@ await client.companies.createCompany({
|
|
|
3344
3360
|
</dl>
|
|
3345
3361
|
</details>
|
|
3346
3362
|
|
|
3347
|
-
<details><summary><code>client.
|
|
3363
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">countBillingCredits</a>({ ...params }) -> Schematic.CountBillingCreditsResponse</code></summary>
|
|
3348
3364
|
<dl>
|
|
3349
3365
|
<dd>
|
|
3350
3366
|
|
|
@@ -3357,11 +3373,7 @@ await client.companies.createCompany({
|
|
|
3357
3373
|
<dd>
|
|
3358
3374
|
|
|
3359
3375
|
```typescript
|
|
3360
|
-
await client.
|
|
3361
|
-
keys: {
|
|
3362
|
-
key: "value",
|
|
3363
|
-
},
|
|
3364
|
-
});
|
|
3376
|
+
await client.credits.countBillingCredits();
|
|
3365
3377
|
```
|
|
3366
3378
|
|
|
3367
3379
|
</dd>
|
|
@@ -3377,7 +3389,7 @@ await client.companies.deleteCompanyByKeys({
|
|
|
3377
3389
|
<dl>
|
|
3378
3390
|
<dd>
|
|
3379
3391
|
|
|
3380
|
-
**request:** `Schematic.
|
|
3392
|
+
**request:** `Schematic.CountBillingCreditsRequest`
|
|
3381
3393
|
|
|
3382
3394
|
</dd>
|
|
3383
3395
|
</dl>
|
|
@@ -3385,7 +3397,7 @@ await client.companies.deleteCompanyByKeys({
|
|
|
3385
3397
|
<dl>
|
|
3386
3398
|
<dd>
|
|
3387
3399
|
|
|
3388
|
-
**requestOptions:** `
|
|
3400
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
3389
3401
|
|
|
3390
3402
|
</dd>
|
|
3391
3403
|
</dl>
|
|
@@ -3396,7 +3408,7 @@ await client.companies.deleteCompanyByKeys({
|
|
|
3396
3408
|
</dl>
|
|
3397
3409
|
</details>
|
|
3398
3410
|
|
|
3399
|
-
<details><summary><code>client.
|
|
3411
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">zeroOutGrant</a>(billingId, { ...params }) -> Schematic.ZeroOutGrantResponse</code></summary>
|
|
3400
3412
|
<dl>
|
|
3401
3413
|
<dd>
|
|
3402
3414
|
|
|
@@ -3409,13 +3421,7 @@ await client.companies.deleteCompanyByKeys({
|
|
|
3409
3421
|
<dd>
|
|
3410
3422
|
|
|
3411
3423
|
```typescript
|
|
3412
|
-
await client.
|
|
3413
|
-
keys: {
|
|
3414
|
-
keys: {
|
|
3415
|
-
key: "value",
|
|
3416
|
-
},
|
|
3417
|
-
},
|
|
3418
|
-
});
|
|
3424
|
+
await client.credits.zeroOutGrant("billing_id");
|
|
3419
3425
|
```
|
|
3420
3426
|
|
|
3421
3427
|
</dd>
|
|
@@ -3431,7 +3437,7 @@ await client.companies.lookupCompany({
|
|
|
3431
3437
|
<dl>
|
|
3432
3438
|
<dd>
|
|
3433
3439
|
|
|
3434
|
-
**
|
|
3440
|
+
**billingId:** `string` — billing_id
|
|
3435
3441
|
|
|
3436
3442
|
</dd>
|
|
3437
3443
|
</dl>
|
|
@@ -3439,7 +3445,15 @@ await client.companies.lookupCompany({
|
|
|
3439
3445
|
<dl>
|
|
3440
3446
|
<dd>
|
|
3441
3447
|
|
|
3442
|
-
**
|
|
3448
|
+
**request:** `Schematic.ZeroOutGrantRequestBody`
|
|
3449
|
+
|
|
3450
|
+
</dd>
|
|
3451
|
+
</dl>
|
|
3452
|
+
|
|
3453
|
+
<dl>
|
|
3454
|
+
<dd>
|
|
3455
|
+
|
|
3456
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
3443
3457
|
|
|
3444
3458
|
</dd>
|
|
3445
3459
|
</dl>
|
|
@@ -3450,7 +3464,7 @@ await client.companies.lookupCompany({
|
|
|
3450
3464
|
</dl>
|
|
3451
3465
|
</details>
|
|
3452
3466
|
|
|
3453
|
-
<details><summary><code>client.
|
|
3467
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">listCompanyGrants</a>({ ...params }) -> Schematic.ListCompanyGrantsResponse</code></summary>
|
|
3454
3468
|
<dl>
|
|
3455
3469
|
<dd>
|
|
3456
3470
|
|
|
@@ -3463,10 +3477,7 @@ await client.companies.lookupCompany({
|
|
|
3463
3477
|
<dd>
|
|
3464
3478
|
|
|
3465
3479
|
```typescript
|
|
3466
|
-
await client.
|
|
3467
|
-
companyId: "company_id",
|
|
3468
|
-
dealStage: "deal_stage",
|
|
3469
|
-
});
|
|
3480
|
+
await client.credits.listCompanyGrants();
|
|
3470
3481
|
```
|
|
3471
3482
|
|
|
3472
3483
|
</dd>
|
|
@@ -3482,7 +3493,7 @@ await client.companies.getActiveDeals({
|
|
|
3482
3493
|
<dl>
|
|
3483
3494
|
<dd>
|
|
3484
3495
|
|
|
3485
|
-
**request:** `Schematic.
|
|
3496
|
+
**request:** `Schematic.ListCompanyGrantsRequest`
|
|
3486
3497
|
|
|
3487
3498
|
</dd>
|
|
3488
3499
|
</dl>
|
|
@@ -3490,7 +3501,7 @@ await client.companies.getActiveDeals({
|
|
|
3490
3501
|
<dl>
|
|
3491
3502
|
<dd>
|
|
3492
3503
|
|
|
3493
|
-
**requestOptions:** `
|
|
3504
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
3494
3505
|
|
|
3495
3506
|
</dd>
|
|
3496
3507
|
</dl>
|
|
@@ -3501,7 +3512,7 @@ await client.companies.getActiveDeals({
|
|
|
3501
3512
|
</dl>
|
|
3502
3513
|
</details>
|
|
3503
3514
|
|
|
3504
|
-
<details><summary><code>client.
|
|
3515
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">countBillingCreditsGrants</a>({ ...params }) -> Schematic.CountBillingCreditsGrantsResponse</code></summary>
|
|
3505
3516
|
<dl>
|
|
3506
3517
|
<dd>
|
|
3507
3518
|
|
|
@@ -3514,7 +3525,7 @@ await client.companies.getActiveDeals({
|
|
|
3514
3525
|
<dd>
|
|
3515
3526
|
|
|
3516
3527
|
```typescript
|
|
3517
|
-
await client.
|
|
3528
|
+
await client.credits.countBillingCreditsGrants();
|
|
3518
3529
|
```
|
|
3519
3530
|
|
|
3520
3531
|
</dd>
|
|
@@ -3530,7 +3541,7 @@ await client.companies.listCompanyMemberships();
|
|
|
3530
3541
|
<dl>
|
|
3531
3542
|
<dd>
|
|
3532
3543
|
|
|
3533
|
-
**request:** `Schematic.
|
|
3544
|
+
**request:** `Schematic.CountBillingCreditsGrantsRequest`
|
|
3534
3545
|
|
|
3535
3546
|
</dd>
|
|
3536
3547
|
</dl>
|
|
@@ -3538,7 +3549,7 @@ await client.companies.listCompanyMemberships();
|
|
|
3538
3549
|
<dl>
|
|
3539
3550
|
<dd>
|
|
3540
3551
|
|
|
3541
|
-
**requestOptions:** `
|
|
3552
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
3542
3553
|
|
|
3543
3554
|
</dd>
|
|
3544
3555
|
</dl>
|
|
@@ -3549,7 +3560,7 @@ await client.companies.listCompanyMemberships();
|
|
|
3549
3560
|
</dl>
|
|
3550
3561
|
</details>
|
|
3551
3562
|
|
|
3552
|
-
<details><summary><code>client.
|
|
3563
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">listGrantsForCredit</a>({ ...params }) -> Schematic.ListGrantsForCreditResponse</code></summary>
|
|
3553
3564
|
<dl>
|
|
3554
3565
|
<dd>
|
|
3555
3566
|
|
|
@@ -3562,10 +3573,7 @@ await client.companies.listCompanyMemberships();
|
|
|
3562
3573
|
<dd>
|
|
3563
3574
|
|
|
3564
3575
|
```typescript
|
|
3565
|
-
await client.
|
|
3566
|
-
companyId: "company_id",
|
|
3567
|
-
userId: "user_id",
|
|
3568
|
-
});
|
|
3576
|
+
await client.credits.listGrantsForCredit();
|
|
3569
3577
|
```
|
|
3570
3578
|
|
|
3571
3579
|
</dd>
|
|
@@ -3581,7 +3589,7 @@ await client.companies.getOrCreateCompanyMembership({
|
|
|
3581
3589
|
<dl>
|
|
3582
3590
|
<dd>
|
|
3583
3591
|
|
|
3584
|
-
**request:** `Schematic.
|
|
3592
|
+
**request:** `Schematic.ListGrantsForCreditRequest`
|
|
3585
3593
|
|
|
3586
3594
|
</dd>
|
|
3587
3595
|
</dl>
|
|
@@ -3589,7 +3597,7 @@ await client.companies.getOrCreateCompanyMembership({
|
|
|
3589
3597
|
<dl>
|
|
3590
3598
|
<dd>
|
|
3591
3599
|
|
|
3592
|
-
**requestOptions:** `
|
|
3600
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
3593
3601
|
|
|
3594
3602
|
</dd>
|
|
3595
3603
|
</dl>
|
|
@@ -3600,7 +3608,7 @@ await client.companies.getOrCreateCompanyMembership({
|
|
|
3600
3608
|
</dl>
|
|
3601
3609
|
</details>
|
|
3602
3610
|
|
|
3603
|
-
<details><summary><code>client.
|
|
3611
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">listBillingPlanCreditGrants</a>({ ...params }) -> Schematic.ListBillingPlanCreditGrantsResponse</code></summary>
|
|
3604
3612
|
<dl>
|
|
3605
3613
|
<dd>
|
|
3606
3614
|
|
|
@@ -3613,7 +3621,7 @@ await client.companies.getOrCreateCompanyMembership({
|
|
|
3613
3621
|
<dd>
|
|
3614
3622
|
|
|
3615
3623
|
```typescript
|
|
3616
|
-
await client.
|
|
3624
|
+
await client.credits.listBillingPlanCreditGrants();
|
|
3617
3625
|
```
|
|
3618
3626
|
|
|
3619
3627
|
</dd>
|
|
@@ -3629,7 +3637,7 @@ await client.companies.deleteCompanyMembership("company_membership_id");
|
|
|
3629
3637
|
<dl>
|
|
3630
3638
|
<dd>
|
|
3631
3639
|
|
|
3632
|
-
**
|
|
3640
|
+
**request:** `Schematic.ListBillingPlanCreditGrantsRequest`
|
|
3633
3641
|
|
|
3634
3642
|
</dd>
|
|
3635
3643
|
</dl>
|
|
@@ -3637,7 +3645,7 @@ await client.companies.deleteCompanyMembership("company_membership_id");
|
|
|
3637
3645
|
<dl>
|
|
3638
3646
|
<dd>
|
|
3639
3647
|
|
|
3640
|
-
**requestOptions:** `
|
|
3648
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
3641
3649
|
|
|
3642
3650
|
</dd>
|
|
3643
3651
|
</dl>
|
|
@@ -3648,7 +3656,7 @@ await client.companies.deleteCompanyMembership("company_membership_id");
|
|
|
3648
3656
|
</dl>
|
|
3649
3657
|
</details>
|
|
3650
3658
|
|
|
3651
|
-
<details><summary><code>client.
|
|
3659
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">createBillingPlanCreditGrant</a>({ ...params }) -> Schematic.CreateBillingPlanCreditGrantResponse</code></summary>
|
|
3652
3660
|
<dl>
|
|
3653
3661
|
<dd>
|
|
3654
3662
|
|
|
@@ -3661,7 +3669,13 @@ await client.companies.deleteCompanyMembership("company_membership_id");
|
|
|
3661
3669
|
<dd>
|
|
3662
3670
|
|
|
3663
3671
|
```typescript
|
|
3664
|
-
await client.
|
|
3672
|
+
await client.credits.createBillingPlanCreditGrant({
|
|
3673
|
+
creditAmount: 1,
|
|
3674
|
+
creditId: "credit_id",
|
|
3675
|
+
planId: "plan_id",
|
|
3676
|
+
resetCadence: "monthly",
|
|
3677
|
+
resetStart: "billing_period",
|
|
3678
|
+
});
|
|
3665
3679
|
```
|
|
3666
3680
|
|
|
3667
3681
|
</dd>
|
|
@@ -3677,7 +3691,7 @@ await client.companies.getActiveCompanySubscription();
|
|
|
3677
3691
|
<dl>
|
|
3678
3692
|
<dd>
|
|
3679
3693
|
|
|
3680
|
-
**request:** `Schematic.
|
|
3694
|
+
**request:** `Schematic.CreateBillingPlanCreditGrantRequestBody`
|
|
3681
3695
|
|
|
3682
3696
|
</dd>
|
|
3683
3697
|
</dl>
|
|
@@ -3685,7 +3699,7 @@ await client.companies.getActiveCompanySubscription();
|
|
|
3685
3699
|
<dl>
|
|
3686
3700
|
<dd>
|
|
3687
3701
|
|
|
3688
|
-
**requestOptions:** `
|
|
3702
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
3689
3703
|
|
|
3690
3704
|
</dd>
|
|
3691
3705
|
</dl>
|
|
@@ -3696,7 +3710,7 @@ await client.companies.getActiveCompanySubscription();
|
|
|
3696
3710
|
</dl>
|
|
3697
3711
|
</details>
|
|
3698
3712
|
|
|
3699
|
-
<details><summary><code>client.
|
|
3713
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">deleteBillingPlanCreditGrant</a>(billingId) -> Schematic.DeleteBillingPlanCreditGrantResponse</code></summary>
|
|
3700
3714
|
<dl>
|
|
3701
3715
|
<dd>
|
|
3702
3716
|
|
|
@@ -3709,12 +3723,7 @@ await client.companies.getActiveCompanySubscription();
|
|
|
3709
3723
|
<dd>
|
|
3710
3724
|
|
|
3711
3725
|
```typescript
|
|
3712
|
-
await client.
|
|
3713
|
-
keys: {
|
|
3714
|
-
key: "value",
|
|
3715
|
-
},
|
|
3716
|
-
trait: "trait",
|
|
3717
|
-
});
|
|
3726
|
+
await client.credits.deleteBillingPlanCreditGrant("billing_id");
|
|
3718
3727
|
```
|
|
3719
3728
|
|
|
3720
3729
|
</dd>
|
|
@@ -3730,7 +3739,7 @@ await client.companies.upsertCompanyTrait({
|
|
|
3730
3739
|
<dl>
|
|
3731
3740
|
<dd>
|
|
3732
3741
|
|
|
3733
|
-
**
|
|
3742
|
+
**billingId:** `string` — billing_id
|
|
3734
3743
|
|
|
3735
3744
|
</dd>
|
|
3736
3745
|
</dl>
|
|
@@ -3738,7 +3747,7 @@ await client.companies.upsertCompanyTrait({
|
|
|
3738
3747
|
<dl>
|
|
3739
3748
|
<dd>
|
|
3740
3749
|
|
|
3741
|
-
**requestOptions:** `
|
|
3750
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
3742
3751
|
|
|
3743
3752
|
</dd>
|
|
3744
3753
|
</dl>
|
|
@@ -3749,7 +3758,7 @@ await client.companies.upsertCompanyTrait({
|
|
|
3749
3758
|
</dl>
|
|
3750
3759
|
</details>
|
|
3751
3760
|
|
|
3752
|
-
<details><summary><code>client.
|
|
3761
|
+
<details><summary><code>client.credits.<a href="/src/api/resources/credits/client/Client.ts">countBillingPlanCreditGrants</a>({ ...params }) -> Schematic.CountBillingPlanCreditGrantsResponse</code></summary>
|
|
3753
3762
|
<dl>
|
|
3754
3763
|
<dd>
|
|
3755
3764
|
|
|
@@ -3762,7 +3771,7 @@ await client.companies.upsertCompanyTrait({
|
|
|
3762
3771
|
<dd>
|
|
3763
3772
|
|
|
3764
3773
|
```typescript
|
|
3765
|
-
await client.
|
|
3774
|
+
await client.credits.countBillingPlanCreditGrants();
|
|
3766
3775
|
```
|
|
3767
3776
|
|
|
3768
3777
|
</dd>
|
|
@@ -3778,7 +3787,7 @@ await client.companies.listEntityKeyDefinitions();
|
|
|
3778
3787
|
<dl>
|
|
3779
3788
|
<dd>
|
|
3780
3789
|
|
|
3781
|
-
**request:** `Schematic.
|
|
3790
|
+
**request:** `Schematic.CountBillingPlanCreditGrantsRequest`
|
|
3782
3791
|
|
|
3783
3792
|
</dd>
|
|
3784
3793
|
</dl>
|
|
@@ -3786,7 +3795,7 @@ await client.companies.listEntityKeyDefinitions();
|
|
|
3786
3795
|
<dl>
|
|
3787
3796
|
<dd>
|
|
3788
3797
|
|
|
3789
|
-
**requestOptions:** `
|
|
3798
|
+
**requestOptions:** `Credits.RequestOptions`
|
|
3790
3799
|
|
|
3791
3800
|
</dd>
|
|
3792
3801
|
</dl>
|
|
@@ -3797,7 +3806,9 @@ await client.companies.listEntityKeyDefinitions();
|
|
|
3797
3806
|
</dl>
|
|
3798
3807
|
</details>
|
|
3799
3808
|
|
|
3800
|
-
|
|
3809
|
+
## checkout
|
|
3810
|
+
|
|
3811
|
+
<details><summary><code>client.checkout.<a href="/src/api/resources/checkout/client/Client.ts">internal</a>({ ...params }) -> Schematic.CheckoutInternalResponse</code></summary>
|
|
3801
3812
|
<dl>
|
|
3802
3813
|
<dd>
|
|
3803
3814
|
|
|
@@ -3810,7 +3821,30 @@ await client.companies.listEntityKeyDefinitions();
|
|
|
3810
3821
|
<dd>
|
|
3811
3822
|
|
|
3812
3823
|
```typescript
|
|
3813
|
-
await client.
|
|
3824
|
+
await client.checkout.internal({
|
|
3825
|
+
addOnIds: [
|
|
3826
|
+
{
|
|
3827
|
+
addOnId: "add_on_id",
|
|
3828
|
+
priceId: "price_id",
|
|
3829
|
+
},
|
|
3830
|
+
],
|
|
3831
|
+
companyId: "company_id",
|
|
3832
|
+
creditBundles: [
|
|
3833
|
+
{
|
|
3834
|
+
bundleId: "bundle_id",
|
|
3835
|
+
quantity: 1,
|
|
3836
|
+
},
|
|
3837
|
+
],
|
|
3838
|
+
newPlanId: "new_plan_id",
|
|
3839
|
+
newPriceId: "new_price_id",
|
|
3840
|
+
payInAdvance: [
|
|
3841
|
+
{
|
|
3842
|
+
priceId: "price_id",
|
|
3843
|
+
quantity: 1,
|
|
3844
|
+
},
|
|
3845
|
+
],
|
|
3846
|
+
skipTrial: true,
|
|
3847
|
+
});
|
|
3814
3848
|
```
|
|
3815
3849
|
|
|
3816
3850
|
</dd>
|
|
@@ -3826,7 +3860,7 @@ await client.companies.countEntityKeyDefinitions();
|
|
|
3826
3860
|
<dl>
|
|
3827
3861
|
<dd>
|
|
3828
3862
|
|
|
3829
|
-
**request:** `Schematic.
|
|
3863
|
+
**request:** `Schematic.ChangeSubscriptionInternalRequestBody`
|
|
3830
3864
|
|
|
3831
3865
|
</dd>
|
|
3832
3866
|
</dl>
|
|
@@ -3834,7 +3868,7 @@ await client.companies.countEntityKeyDefinitions();
|
|
|
3834
3868
|
<dl>
|
|
3835
3869
|
<dd>
|
|
3836
3870
|
|
|
3837
|
-
**requestOptions:** `
|
|
3871
|
+
**requestOptions:** `Checkout.RequestOptions`
|
|
3838
3872
|
|
|
3839
3873
|
</dd>
|
|
3840
3874
|
</dl>
|
|
@@ -3845,7 +3879,7 @@ await client.companies.countEntityKeyDefinitions();
|
|
|
3845
3879
|
</dl>
|
|
3846
3880
|
</details>
|
|
3847
3881
|
|
|
3848
|
-
<details><summary><code>client.
|
|
3882
|
+
<details><summary><code>client.checkout.<a href="/src/api/resources/checkout/client/Client.ts">getCheckoutData</a>({ ...params }) -> Schematic.GetCheckoutDataResponse</code></summary>
|
|
3849
3883
|
<dl>
|
|
3850
3884
|
<dd>
|
|
3851
3885
|
|
|
@@ -3858,7 +3892,9 @@ await client.companies.countEntityKeyDefinitions();
|
|
|
3858
3892
|
<dd>
|
|
3859
3893
|
|
|
3860
3894
|
```typescript
|
|
3861
|
-
await client.
|
|
3895
|
+
await client.checkout.getCheckoutData({
|
|
3896
|
+
companyId: "company_id",
|
|
3897
|
+
});
|
|
3862
3898
|
```
|
|
3863
3899
|
|
|
3864
3900
|
</dd>
|
|
@@ -3874,7 +3910,7 @@ await client.companies.listEntityTraitDefinitions();
|
|
|
3874
3910
|
<dl>
|
|
3875
3911
|
<dd>
|
|
3876
3912
|
|
|
3877
|
-
**request:** `Schematic.
|
|
3913
|
+
**request:** `Schematic.CheckoutDataRequestBody`
|
|
3878
3914
|
|
|
3879
3915
|
</dd>
|
|
3880
3916
|
</dl>
|
|
@@ -3882,7 +3918,7 @@ await client.companies.listEntityTraitDefinitions();
|
|
|
3882
3918
|
<dl>
|
|
3883
3919
|
<dd>
|
|
3884
3920
|
|
|
3885
|
-
**requestOptions:** `
|
|
3921
|
+
**requestOptions:** `Checkout.RequestOptions`
|
|
3886
3922
|
|
|
3887
3923
|
</dd>
|
|
3888
3924
|
</dl>
|
|
@@ -3893,7 +3929,7 @@ await client.companies.listEntityTraitDefinitions();
|
|
|
3893
3929
|
</dl>
|
|
3894
3930
|
</details>
|
|
3895
3931
|
|
|
3896
|
-
<details><summary><code>client.
|
|
3932
|
+
<details><summary><code>client.checkout.<a href="/src/api/resources/checkout/client/Client.ts">previewCheckoutInternal</a>({ ...params }) -> Schematic.PreviewCheckoutInternalResponse</code></summary>
|
|
3897
3933
|
<dl>
|
|
3898
3934
|
<dd>
|
|
3899
3935
|
|
|
@@ -3906,9 +3942,1175 @@ await client.companies.listEntityTraitDefinitions();
|
|
|
3906
3942
|
<dd>
|
|
3907
3943
|
|
|
3908
3944
|
```typescript
|
|
3909
|
-
await client.
|
|
3910
|
-
|
|
3911
|
-
|
|
3945
|
+
await client.checkout.previewCheckoutInternal({
|
|
3946
|
+
addOnIds: [
|
|
3947
|
+
{
|
|
3948
|
+
addOnId: "add_on_id",
|
|
3949
|
+
priceId: "price_id",
|
|
3950
|
+
},
|
|
3951
|
+
],
|
|
3952
|
+
companyId: "company_id",
|
|
3953
|
+
creditBundles: [
|
|
3954
|
+
{
|
|
3955
|
+
bundleId: "bundle_id",
|
|
3956
|
+
quantity: 1,
|
|
3957
|
+
},
|
|
3958
|
+
],
|
|
3959
|
+
newPlanId: "new_plan_id",
|
|
3960
|
+
newPriceId: "new_price_id",
|
|
3961
|
+
payInAdvance: [
|
|
3962
|
+
{
|
|
3963
|
+
priceId: "price_id",
|
|
3964
|
+
quantity: 1,
|
|
3965
|
+
},
|
|
3966
|
+
],
|
|
3967
|
+
skipTrial: true,
|
|
3968
|
+
});
|
|
3969
|
+
```
|
|
3970
|
+
|
|
3971
|
+
</dd>
|
|
3972
|
+
</dl>
|
|
3973
|
+
</dd>
|
|
3974
|
+
</dl>
|
|
3975
|
+
|
|
3976
|
+
#### ⚙️ Parameters
|
|
3977
|
+
|
|
3978
|
+
<dl>
|
|
3979
|
+
<dd>
|
|
3980
|
+
|
|
3981
|
+
<dl>
|
|
3982
|
+
<dd>
|
|
3983
|
+
|
|
3984
|
+
**request:** `Schematic.ChangeSubscriptionInternalRequestBody`
|
|
3985
|
+
|
|
3986
|
+
</dd>
|
|
3987
|
+
</dl>
|
|
3988
|
+
|
|
3989
|
+
<dl>
|
|
3990
|
+
<dd>
|
|
3991
|
+
|
|
3992
|
+
**requestOptions:** `Checkout.RequestOptions`
|
|
3993
|
+
|
|
3994
|
+
</dd>
|
|
3995
|
+
</dl>
|
|
3996
|
+
</dd>
|
|
3997
|
+
</dl>
|
|
3998
|
+
|
|
3999
|
+
</dd>
|
|
4000
|
+
</dl>
|
|
4001
|
+
</details>
|
|
4002
|
+
|
|
4003
|
+
<details><summary><code>client.checkout.<a href="/src/api/resources/checkout/client/Client.ts">updateCustomerSubscriptionTrialEnd</a>(subscriptionId, { ...params }) -> Schematic.UpdateCustomerSubscriptionTrialEndResponse</code></summary>
|
|
4004
|
+
<dl>
|
|
4005
|
+
<dd>
|
|
4006
|
+
|
|
4007
|
+
#### 🔌 Usage
|
|
4008
|
+
|
|
4009
|
+
<dl>
|
|
4010
|
+
<dd>
|
|
4011
|
+
|
|
4012
|
+
<dl>
|
|
4013
|
+
<dd>
|
|
4014
|
+
|
|
4015
|
+
```typescript
|
|
4016
|
+
await client.checkout.updateCustomerSubscriptionTrialEnd("subscription_id");
|
|
4017
|
+
```
|
|
4018
|
+
|
|
4019
|
+
</dd>
|
|
4020
|
+
</dl>
|
|
4021
|
+
</dd>
|
|
4022
|
+
</dl>
|
|
4023
|
+
|
|
4024
|
+
#### ⚙️ Parameters
|
|
4025
|
+
|
|
4026
|
+
<dl>
|
|
4027
|
+
<dd>
|
|
4028
|
+
|
|
4029
|
+
<dl>
|
|
4030
|
+
<dd>
|
|
4031
|
+
|
|
4032
|
+
**subscriptionId:** `string` — subscription_id
|
|
4033
|
+
|
|
4034
|
+
</dd>
|
|
4035
|
+
</dl>
|
|
4036
|
+
|
|
4037
|
+
<dl>
|
|
4038
|
+
<dd>
|
|
4039
|
+
|
|
4040
|
+
**request:** `Schematic.UpdateTrialEndRequestBody`
|
|
4041
|
+
|
|
4042
|
+
</dd>
|
|
4043
|
+
</dl>
|
|
4044
|
+
|
|
4045
|
+
<dl>
|
|
4046
|
+
<dd>
|
|
4047
|
+
|
|
4048
|
+
**requestOptions:** `Checkout.RequestOptions`
|
|
4049
|
+
|
|
4050
|
+
</dd>
|
|
4051
|
+
</dl>
|
|
4052
|
+
</dd>
|
|
4053
|
+
</dl>
|
|
4054
|
+
|
|
4055
|
+
</dd>
|
|
4056
|
+
</dl>
|
|
4057
|
+
</details>
|
|
4058
|
+
|
|
4059
|
+
## companies
|
|
4060
|
+
|
|
4061
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">listCompanies</a>({ ...params }) -> Schematic.ListCompaniesResponse</code></summary>
|
|
4062
|
+
<dl>
|
|
4063
|
+
<dd>
|
|
4064
|
+
|
|
4065
|
+
#### 🔌 Usage
|
|
4066
|
+
|
|
4067
|
+
<dl>
|
|
4068
|
+
<dd>
|
|
4069
|
+
|
|
4070
|
+
<dl>
|
|
4071
|
+
<dd>
|
|
4072
|
+
|
|
4073
|
+
```typescript
|
|
4074
|
+
await client.companies.listCompanies();
|
|
4075
|
+
```
|
|
4076
|
+
|
|
4077
|
+
</dd>
|
|
4078
|
+
</dl>
|
|
4079
|
+
</dd>
|
|
4080
|
+
</dl>
|
|
4081
|
+
|
|
4082
|
+
#### ⚙️ Parameters
|
|
4083
|
+
|
|
4084
|
+
<dl>
|
|
4085
|
+
<dd>
|
|
4086
|
+
|
|
4087
|
+
<dl>
|
|
4088
|
+
<dd>
|
|
4089
|
+
|
|
4090
|
+
**request:** `Schematic.ListCompaniesRequest`
|
|
4091
|
+
|
|
4092
|
+
</dd>
|
|
4093
|
+
</dl>
|
|
4094
|
+
|
|
4095
|
+
<dl>
|
|
4096
|
+
<dd>
|
|
4097
|
+
|
|
4098
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4099
|
+
|
|
4100
|
+
</dd>
|
|
4101
|
+
</dl>
|
|
4102
|
+
</dd>
|
|
4103
|
+
</dl>
|
|
4104
|
+
|
|
4105
|
+
</dd>
|
|
4106
|
+
</dl>
|
|
4107
|
+
</details>
|
|
4108
|
+
|
|
4109
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">upsertCompany</a>({ ...params }) -> Schematic.UpsertCompanyResponse</code></summary>
|
|
4110
|
+
<dl>
|
|
4111
|
+
<dd>
|
|
4112
|
+
|
|
4113
|
+
#### 🔌 Usage
|
|
4114
|
+
|
|
4115
|
+
<dl>
|
|
4116
|
+
<dd>
|
|
4117
|
+
|
|
4118
|
+
<dl>
|
|
4119
|
+
<dd>
|
|
4120
|
+
|
|
4121
|
+
```typescript
|
|
4122
|
+
await client.companies.upsertCompany({
|
|
4123
|
+
keys: {
|
|
4124
|
+
key: "value",
|
|
4125
|
+
},
|
|
4126
|
+
});
|
|
4127
|
+
```
|
|
4128
|
+
|
|
4129
|
+
</dd>
|
|
4130
|
+
</dl>
|
|
4131
|
+
</dd>
|
|
4132
|
+
</dl>
|
|
4133
|
+
|
|
4134
|
+
#### ⚙️ Parameters
|
|
4135
|
+
|
|
4136
|
+
<dl>
|
|
4137
|
+
<dd>
|
|
4138
|
+
|
|
4139
|
+
<dl>
|
|
4140
|
+
<dd>
|
|
4141
|
+
|
|
4142
|
+
**request:** `Schematic.UpsertCompanyRequestBody`
|
|
4143
|
+
|
|
4144
|
+
</dd>
|
|
4145
|
+
</dl>
|
|
4146
|
+
|
|
4147
|
+
<dl>
|
|
4148
|
+
<dd>
|
|
4149
|
+
|
|
4150
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4151
|
+
|
|
4152
|
+
</dd>
|
|
4153
|
+
</dl>
|
|
4154
|
+
</dd>
|
|
4155
|
+
</dl>
|
|
4156
|
+
|
|
4157
|
+
</dd>
|
|
4158
|
+
</dl>
|
|
4159
|
+
</details>
|
|
4160
|
+
|
|
4161
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">getCompany</a>(companyId) -> Schematic.GetCompanyResponse</code></summary>
|
|
4162
|
+
<dl>
|
|
4163
|
+
<dd>
|
|
4164
|
+
|
|
4165
|
+
#### 🔌 Usage
|
|
4166
|
+
|
|
4167
|
+
<dl>
|
|
4168
|
+
<dd>
|
|
4169
|
+
|
|
4170
|
+
<dl>
|
|
4171
|
+
<dd>
|
|
4172
|
+
|
|
4173
|
+
```typescript
|
|
4174
|
+
await client.companies.getCompany("company_id");
|
|
4175
|
+
```
|
|
4176
|
+
|
|
4177
|
+
</dd>
|
|
4178
|
+
</dl>
|
|
4179
|
+
</dd>
|
|
4180
|
+
</dl>
|
|
4181
|
+
|
|
4182
|
+
#### ⚙️ Parameters
|
|
4183
|
+
|
|
4184
|
+
<dl>
|
|
4185
|
+
<dd>
|
|
4186
|
+
|
|
4187
|
+
<dl>
|
|
4188
|
+
<dd>
|
|
4189
|
+
|
|
4190
|
+
**companyId:** `string` — company_id
|
|
4191
|
+
|
|
4192
|
+
</dd>
|
|
4193
|
+
</dl>
|
|
4194
|
+
|
|
4195
|
+
<dl>
|
|
4196
|
+
<dd>
|
|
4197
|
+
|
|
4198
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4199
|
+
|
|
4200
|
+
</dd>
|
|
4201
|
+
</dl>
|
|
4202
|
+
</dd>
|
|
4203
|
+
</dl>
|
|
4204
|
+
|
|
4205
|
+
</dd>
|
|
4206
|
+
</dl>
|
|
4207
|
+
</details>
|
|
4208
|
+
|
|
4209
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">deleteCompany</a>(companyId) -> Schematic.DeleteCompanyResponse</code></summary>
|
|
4210
|
+
<dl>
|
|
4211
|
+
<dd>
|
|
4212
|
+
|
|
4213
|
+
#### 🔌 Usage
|
|
4214
|
+
|
|
4215
|
+
<dl>
|
|
4216
|
+
<dd>
|
|
4217
|
+
|
|
4218
|
+
<dl>
|
|
4219
|
+
<dd>
|
|
4220
|
+
|
|
4221
|
+
```typescript
|
|
4222
|
+
await client.companies.deleteCompany("company_id");
|
|
4223
|
+
```
|
|
4224
|
+
|
|
4225
|
+
</dd>
|
|
4226
|
+
</dl>
|
|
4227
|
+
</dd>
|
|
4228
|
+
</dl>
|
|
4229
|
+
|
|
4230
|
+
#### ⚙️ Parameters
|
|
4231
|
+
|
|
4232
|
+
<dl>
|
|
4233
|
+
<dd>
|
|
4234
|
+
|
|
4235
|
+
<dl>
|
|
4236
|
+
<dd>
|
|
4237
|
+
|
|
4238
|
+
**companyId:** `string` — company_id
|
|
4239
|
+
|
|
4240
|
+
</dd>
|
|
4241
|
+
</dl>
|
|
4242
|
+
|
|
4243
|
+
<dl>
|
|
4244
|
+
<dd>
|
|
4245
|
+
|
|
4246
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4247
|
+
|
|
4248
|
+
</dd>
|
|
4249
|
+
</dl>
|
|
4250
|
+
</dd>
|
|
4251
|
+
</dl>
|
|
4252
|
+
|
|
4253
|
+
</dd>
|
|
4254
|
+
</dl>
|
|
4255
|
+
</details>
|
|
4256
|
+
|
|
4257
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">countCompanies</a>({ ...params }) -> Schematic.CountCompaniesResponse</code></summary>
|
|
4258
|
+
<dl>
|
|
4259
|
+
<dd>
|
|
4260
|
+
|
|
4261
|
+
#### 🔌 Usage
|
|
4262
|
+
|
|
4263
|
+
<dl>
|
|
4264
|
+
<dd>
|
|
4265
|
+
|
|
4266
|
+
<dl>
|
|
4267
|
+
<dd>
|
|
4268
|
+
|
|
4269
|
+
```typescript
|
|
4270
|
+
await client.companies.countCompanies();
|
|
4271
|
+
```
|
|
4272
|
+
|
|
4273
|
+
</dd>
|
|
4274
|
+
</dl>
|
|
4275
|
+
</dd>
|
|
4276
|
+
</dl>
|
|
4277
|
+
|
|
4278
|
+
#### ⚙️ Parameters
|
|
4279
|
+
|
|
4280
|
+
<dl>
|
|
4281
|
+
<dd>
|
|
4282
|
+
|
|
4283
|
+
<dl>
|
|
4284
|
+
<dd>
|
|
4285
|
+
|
|
4286
|
+
**request:** `Schematic.CountCompaniesRequest`
|
|
4287
|
+
|
|
4288
|
+
</dd>
|
|
4289
|
+
</dl>
|
|
4290
|
+
|
|
4291
|
+
<dl>
|
|
4292
|
+
<dd>
|
|
4293
|
+
|
|
4294
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4295
|
+
|
|
4296
|
+
</dd>
|
|
4297
|
+
</dl>
|
|
4298
|
+
</dd>
|
|
4299
|
+
</dl>
|
|
4300
|
+
|
|
4301
|
+
</dd>
|
|
4302
|
+
</dl>
|
|
4303
|
+
</details>
|
|
4304
|
+
|
|
4305
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">countCompaniesForAdvancedFilter</a>({ ...params }) -> Schematic.CountCompaniesForAdvancedFilterResponse</code></summary>
|
|
4306
|
+
<dl>
|
|
4307
|
+
<dd>
|
|
4308
|
+
|
|
4309
|
+
#### 🔌 Usage
|
|
4310
|
+
|
|
4311
|
+
<dl>
|
|
4312
|
+
<dd>
|
|
4313
|
+
|
|
4314
|
+
<dl>
|
|
4315
|
+
<dd>
|
|
4316
|
+
|
|
4317
|
+
```typescript
|
|
4318
|
+
await client.companies.countCompaniesForAdvancedFilter();
|
|
4319
|
+
```
|
|
4320
|
+
|
|
4321
|
+
</dd>
|
|
4322
|
+
</dl>
|
|
4323
|
+
</dd>
|
|
4324
|
+
</dl>
|
|
4325
|
+
|
|
4326
|
+
#### ⚙️ Parameters
|
|
4327
|
+
|
|
4328
|
+
<dl>
|
|
4329
|
+
<dd>
|
|
4330
|
+
|
|
4331
|
+
<dl>
|
|
4332
|
+
<dd>
|
|
4333
|
+
|
|
4334
|
+
**request:** `Schematic.CountCompaniesForAdvancedFilterRequest`
|
|
4335
|
+
|
|
4336
|
+
</dd>
|
|
4337
|
+
</dl>
|
|
4338
|
+
|
|
4339
|
+
<dl>
|
|
4340
|
+
<dd>
|
|
4341
|
+
|
|
4342
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4343
|
+
|
|
4344
|
+
</dd>
|
|
4345
|
+
</dl>
|
|
4346
|
+
</dd>
|
|
4347
|
+
</dl>
|
|
4348
|
+
|
|
4349
|
+
</dd>
|
|
4350
|
+
</dl>
|
|
4351
|
+
</details>
|
|
4352
|
+
|
|
4353
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">createCompany</a>({ ...params }) -> Schematic.CreateCompanyResponse</code></summary>
|
|
4354
|
+
<dl>
|
|
4355
|
+
<dd>
|
|
4356
|
+
|
|
4357
|
+
#### 🔌 Usage
|
|
4358
|
+
|
|
4359
|
+
<dl>
|
|
4360
|
+
<dd>
|
|
4361
|
+
|
|
4362
|
+
<dl>
|
|
4363
|
+
<dd>
|
|
4364
|
+
|
|
4365
|
+
```typescript
|
|
4366
|
+
await client.companies.createCompany({
|
|
4367
|
+
keys: {
|
|
4368
|
+
key: "value",
|
|
4369
|
+
},
|
|
4370
|
+
});
|
|
4371
|
+
```
|
|
4372
|
+
|
|
4373
|
+
</dd>
|
|
4374
|
+
</dl>
|
|
4375
|
+
</dd>
|
|
4376
|
+
</dl>
|
|
4377
|
+
|
|
4378
|
+
#### ⚙️ Parameters
|
|
4379
|
+
|
|
4380
|
+
<dl>
|
|
4381
|
+
<dd>
|
|
4382
|
+
|
|
4383
|
+
<dl>
|
|
4384
|
+
<dd>
|
|
4385
|
+
|
|
4386
|
+
**request:** `Schematic.UpsertCompanyRequestBody`
|
|
4387
|
+
|
|
4388
|
+
</dd>
|
|
4389
|
+
</dl>
|
|
4390
|
+
|
|
4391
|
+
<dl>
|
|
4392
|
+
<dd>
|
|
4393
|
+
|
|
4394
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4395
|
+
|
|
4396
|
+
</dd>
|
|
4397
|
+
</dl>
|
|
4398
|
+
</dd>
|
|
4399
|
+
</dl>
|
|
4400
|
+
|
|
4401
|
+
</dd>
|
|
4402
|
+
</dl>
|
|
4403
|
+
</details>
|
|
4404
|
+
|
|
4405
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">deleteCompanyByKeys</a>({ ...params }) -> Schematic.DeleteCompanyByKeysResponse</code></summary>
|
|
4406
|
+
<dl>
|
|
4407
|
+
<dd>
|
|
4408
|
+
|
|
4409
|
+
#### 🔌 Usage
|
|
4410
|
+
|
|
4411
|
+
<dl>
|
|
4412
|
+
<dd>
|
|
4413
|
+
|
|
4414
|
+
<dl>
|
|
4415
|
+
<dd>
|
|
4416
|
+
|
|
4417
|
+
```typescript
|
|
4418
|
+
await client.companies.deleteCompanyByKeys({
|
|
4419
|
+
keys: {
|
|
4420
|
+
key: "value",
|
|
4421
|
+
},
|
|
4422
|
+
});
|
|
4423
|
+
```
|
|
4424
|
+
|
|
4425
|
+
</dd>
|
|
4426
|
+
</dl>
|
|
4427
|
+
</dd>
|
|
4428
|
+
</dl>
|
|
4429
|
+
|
|
4430
|
+
#### ⚙️ Parameters
|
|
4431
|
+
|
|
4432
|
+
<dl>
|
|
4433
|
+
<dd>
|
|
4434
|
+
|
|
4435
|
+
<dl>
|
|
4436
|
+
<dd>
|
|
4437
|
+
|
|
4438
|
+
**request:** `Schematic.KeysRequestBody`
|
|
4439
|
+
|
|
4440
|
+
</dd>
|
|
4441
|
+
</dl>
|
|
4442
|
+
|
|
4443
|
+
<dl>
|
|
4444
|
+
<dd>
|
|
4445
|
+
|
|
4446
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4447
|
+
|
|
4448
|
+
</dd>
|
|
4449
|
+
</dl>
|
|
4450
|
+
</dd>
|
|
4451
|
+
</dl>
|
|
4452
|
+
|
|
4453
|
+
</dd>
|
|
4454
|
+
</dl>
|
|
4455
|
+
</details>
|
|
4456
|
+
|
|
4457
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">listCompaniesForAdvancedFilter</a>({ ...params }) -> Schematic.ListCompaniesForAdvancedFilterResponse</code></summary>
|
|
4458
|
+
<dl>
|
|
4459
|
+
<dd>
|
|
4460
|
+
|
|
4461
|
+
#### 🔌 Usage
|
|
4462
|
+
|
|
4463
|
+
<dl>
|
|
4464
|
+
<dd>
|
|
4465
|
+
|
|
4466
|
+
<dl>
|
|
4467
|
+
<dd>
|
|
4468
|
+
|
|
4469
|
+
```typescript
|
|
4470
|
+
await client.companies.listCompaniesForAdvancedFilter();
|
|
4471
|
+
```
|
|
4472
|
+
|
|
4473
|
+
</dd>
|
|
4474
|
+
</dl>
|
|
4475
|
+
</dd>
|
|
4476
|
+
</dl>
|
|
4477
|
+
|
|
4478
|
+
#### ⚙️ Parameters
|
|
4479
|
+
|
|
4480
|
+
<dl>
|
|
4481
|
+
<dd>
|
|
4482
|
+
|
|
4483
|
+
<dl>
|
|
4484
|
+
<dd>
|
|
4485
|
+
|
|
4486
|
+
**request:** `Schematic.ListCompaniesForAdvancedFilterRequest`
|
|
4487
|
+
|
|
4488
|
+
</dd>
|
|
4489
|
+
</dl>
|
|
4490
|
+
|
|
4491
|
+
<dl>
|
|
4492
|
+
<dd>
|
|
4493
|
+
|
|
4494
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4495
|
+
|
|
4496
|
+
</dd>
|
|
4497
|
+
</dl>
|
|
4498
|
+
</dd>
|
|
4499
|
+
</dl>
|
|
4500
|
+
|
|
4501
|
+
</dd>
|
|
4502
|
+
</dl>
|
|
4503
|
+
</details>
|
|
4504
|
+
|
|
4505
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">lookupCompany</a>({ ...params }) -> Schematic.LookupCompanyResponse</code></summary>
|
|
4506
|
+
<dl>
|
|
4507
|
+
<dd>
|
|
4508
|
+
|
|
4509
|
+
#### 🔌 Usage
|
|
4510
|
+
|
|
4511
|
+
<dl>
|
|
4512
|
+
<dd>
|
|
4513
|
+
|
|
4514
|
+
<dl>
|
|
4515
|
+
<dd>
|
|
4516
|
+
|
|
4517
|
+
```typescript
|
|
4518
|
+
await client.companies.lookupCompany({
|
|
4519
|
+
keys: {
|
|
4520
|
+
keys: "keys",
|
|
4521
|
+
},
|
|
4522
|
+
});
|
|
4523
|
+
```
|
|
4524
|
+
|
|
4525
|
+
</dd>
|
|
4526
|
+
</dl>
|
|
4527
|
+
</dd>
|
|
4528
|
+
</dl>
|
|
4529
|
+
|
|
4530
|
+
#### ⚙️ Parameters
|
|
4531
|
+
|
|
4532
|
+
<dl>
|
|
4533
|
+
<dd>
|
|
4534
|
+
|
|
4535
|
+
<dl>
|
|
4536
|
+
<dd>
|
|
4537
|
+
|
|
4538
|
+
**request:** `Schematic.LookupCompanyRequest`
|
|
4539
|
+
|
|
4540
|
+
</dd>
|
|
4541
|
+
</dl>
|
|
4542
|
+
|
|
4543
|
+
<dl>
|
|
4544
|
+
<dd>
|
|
4545
|
+
|
|
4546
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4547
|
+
|
|
4548
|
+
</dd>
|
|
4549
|
+
</dl>
|
|
4550
|
+
</dd>
|
|
4551
|
+
</dl>
|
|
4552
|
+
|
|
4553
|
+
</dd>
|
|
4554
|
+
</dl>
|
|
4555
|
+
</details>
|
|
4556
|
+
|
|
4557
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">getActiveDeals</a>({ ...params }) -> Schematic.GetActiveDealsResponse</code></summary>
|
|
4558
|
+
<dl>
|
|
4559
|
+
<dd>
|
|
4560
|
+
|
|
4561
|
+
#### 🔌 Usage
|
|
4562
|
+
|
|
4563
|
+
<dl>
|
|
4564
|
+
<dd>
|
|
4565
|
+
|
|
4566
|
+
<dl>
|
|
4567
|
+
<dd>
|
|
4568
|
+
|
|
4569
|
+
```typescript
|
|
4570
|
+
await client.companies.getActiveDeals({
|
|
4571
|
+
companyId: "company_id",
|
|
4572
|
+
dealStage: "deal_stage",
|
|
4573
|
+
});
|
|
4574
|
+
```
|
|
4575
|
+
|
|
4576
|
+
</dd>
|
|
4577
|
+
</dl>
|
|
4578
|
+
</dd>
|
|
4579
|
+
</dl>
|
|
4580
|
+
|
|
4581
|
+
#### ⚙️ Parameters
|
|
4582
|
+
|
|
4583
|
+
<dl>
|
|
4584
|
+
<dd>
|
|
4585
|
+
|
|
4586
|
+
<dl>
|
|
4587
|
+
<dd>
|
|
4588
|
+
|
|
4589
|
+
**request:** `Schematic.GetActiveDealsRequest`
|
|
4590
|
+
|
|
4591
|
+
</dd>
|
|
4592
|
+
</dl>
|
|
4593
|
+
|
|
4594
|
+
<dl>
|
|
4595
|
+
<dd>
|
|
4596
|
+
|
|
4597
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4598
|
+
|
|
4599
|
+
</dd>
|
|
4600
|
+
</dl>
|
|
4601
|
+
</dd>
|
|
4602
|
+
</dl>
|
|
4603
|
+
|
|
4604
|
+
</dd>
|
|
4605
|
+
</dl>
|
|
4606
|
+
</details>
|
|
4607
|
+
|
|
4608
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">listCompanyMemberships</a>({ ...params }) -> Schematic.ListCompanyMembershipsResponse</code></summary>
|
|
4609
|
+
<dl>
|
|
4610
|
+
<dd>
|
|
4611
|
+
|
|
4612
|
+
#### 🔌 Usage
|
|
4613
|
+
|
|
4614
|
+
<dl>
|
|
4615
|
+
<dd>
|
|
4616
|
+
|
|
4617
|
+
<dl>
|
|
4618
|
+
<dd>
|
|
4619
|
+
|
|
4620
|
+
```typescript
|
|
4621
|
+
await client.companies.listCompanyMemberships();
|
|
4622
|
+
```
|
|
4623
|
+
|
|
4624
|
+
</dd>
|
|
4625
|
+
</dl>
|
|
4626
|
+
</dd>
|
|
4627
|
+
</dl>
|
|
4628
|
+
|
|
4629
|
+
#### ⚙️ Parameters
|
|
4630
|
+
|
|
4631
|
+
<dl>
|
|
4632
|
+
<dd>
|
|
4633
|
+
|
|
4634
|
+
<dl>
|
|
4635
|
+
<dd>
|
|
4636
|
+
|
|
4637
|
+
**request:** `Schematic.ListCompanyMembershipsRequest`
|
|
4638
|
+
|
|
4639
|
+
</dd>
|
|
4640
|
+
</dl>
|
|
4641
|
+
|
|
4642
|
+
<dl>
|
|
4643
|
+
<dd>
|
|
4644
|
+
|
|
4645
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4646
|
+
|
|
4647
|
+
</dd>
|
|
4648
|
+
</dl>
|
|
4649
|
+
</dd>
|
|
4650
|
+
</dl>
|
|
4651
|
+
|
|
4652
|
+
</dd>
|
|
4653
|
+
</dl>
|
|
4654
|
+
</details>
|
|
4655
|
+
|
|
4656
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">getOrCreateCompanyMembership</a>({ ...params }) -> Schematic.GetOrCreateCompanyMembershipResponse</code></summary>
|
|
4657
|
+
<dl>
|
|
4658
|
+
<dd>
|
|
4659
|
+
|
|
4660
|
+
#### 🔌 Usage
|
|
4661
|
+
|
|
4662
|
+
<dl>
|
|
4663
|
+
<dd>
|
|
4664
|
+
|
|
4665
|
+
<dl>
|
|
4666
|
+
<dd>
|
|
4667
|
+
|
|
4668
|
+
```typescript
|
|
4669
|
+
await client.companies.getOrCreateCompanyMembership({
|
|
4670
|
+
companyId: "company_id",
|
|
4671
|
+
userId: "user_id",
|
|
4672
|
+
});
|
|
4673
|
+
```
|
|
4674
|
+
|
|
4675
|
+
</dd>
|
|
4676
|
+
</dl>
|
|
4677
|
+
</dd>
|
|
4678
|
+
</dl>
|
|
4679
|
+
|
|
4680
|
+
#### ⚙️ Parameters
|
|
4681
|
+
|
|
4682
|
+
<dl>
|
|
4683
|
+
<dd>
|
|
4684
|
+
|
|
4685
|
+
<dl>
|
|
4686
|
+
<dd>
|
|
4687
|
+
|
|
4688
|
+
**request:** `Schematic.GetOrCreateCompanyMembershipRequestBody`
|
|
4689
|
+
|
|
4690
|
+
</dd>
|
|
4691
|
+
</dl>
|
|
4692
|
+
|
|
4693
|
+
<dl>
|
|
4694
|
+
<dd>
|
|
4695
|
+
|
|
4696
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4697
|
+
|
|
4698
|
+
</dd>
|
|
4699
|
+
</dl>
|
|
4700
|
+
</dd>
|
|
4701
|
+
</dl>
|
|
4702
|
+
|
|
4703
|
+
</dd>
|
|
4704
|
+
</dl>
|
|
4705
|
+
</details>
|
|
4706
|
+
|
|
4707
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">deleteCompanyMembership</a>(companyMembershipId) -> Schematic.DeleteCompanyMembershipResponse</code></summary>
|
|
4708
|
+
<dl>
|
|
4709
|
+
<dd>
|
|
4710
|
+
|
|
4711
|
+
#### 🔌 Usage
|
|
4712
|
+
|
|
4713
|
+
<dl>
|
|
4714
|
+
<dd>
|
|
4715
|
+
|
|
4716
|
+
<dl>
|
|
4717
|
+
<dd>
|
|
4718
|
+
|
|
4719
|
+
```typescript
|
|
4720
|
+
await client.companies.deleteCompanyMembership("company_membership_id");
|
|
4721
|
+
```
|
|
4722
|
+
|
|
4723
|
+
</dd>
|
|
4724
|
+
</dl>
|
|
4725
|
+
</dd>
|
|
4726
|
+
</dl>
|
|
4727
|
+
|
|
4728
|
+
#### ⚙️ Parameters
|
|
4729
|
+
|
|
4730
|
+
<dl>
|
|
4731
|
+
<dd>
|
|
4732
|
+
|
|
4733
|
+
<dl>
|
|
4734
|
+
<dd>
|
|
4735
|
+
|
|
4736
|
+
**companyMembershipId:** `string` — company_membership_id
|
|
4737
|
+
|
|
4738
|
+
</dd>
|
|
4739
|
+
</dl>
|
|
4740
|
+
|
|
4741
|
+
<dl>
|
|
4742
|
+
<dd>
|
|
4743
|
+
|
|
4744
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4745
|
+
|
|
4746
|
+
</dd>
|
|
4747
|
+
</dl>
|
|
4748
|
+
</dd>
|
|
4749
|
+
</dl>
|
|
4750
|
+
|
|
4751
|
+
</dd>
|
|
4752
|
+
</dl>
|
|
4753
|
+
</details>
|
|
4754
|
+
|
|
4755
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">getActiveCompanySubscription</a>({ ...params }) -> Schematic.GetActiveCompanySubscriptionResponse</code></summary>
|
|
4756
|
+
<dl>
|
|
4757
|
+
<dd>
|
|
4758
|
+
|
|
4759
|
+
#### 🔌 Usage
|
|
4760
|
+
|
|
4761
|
+
<dl>
|
|
4762
|
+
<dd>
|
|
4763
|
+
|
|
4764
|
+
<dl>
|
|
4765
|
+
<dd>
|
|
4766
|
+
|
|
4767
|
+
```typescript
|
|
4768
|
+
await client.companies.getActiveCompanySubscription();
|
|
4769
|
+
```
|
|
4770
|
+
|
|
4771
|
+
</dd>
|
|
4772
|
+
</dl>
|
|
4773
|
+
</dd>
|
|
4774
|
+
</dl>
|
|
4775
|
+
|
|
4776
|
+
#### ⚙️ Parameters
|
|
4777
|
+
|
|
4778
|
+
<dl>
|
|
4779
|
+
<dd>
|
|
4780
|
+
|
|
4781
|
+
<dl>
|
|
4782
|
+
<dd>
|
|
4783
|
+
|
|
4784
|
+
**request:** `Schematic.GetActiveCompanySubscriptionRequest`
|
|
4785
|
+
|
|
4786
|
+
</dd>
|
|
4787
|
+
</dl>
|
|
4788
|
+
|
|
4789
|
+
<dl>
|
|
4790
|
+
<dd>
|
|
4791
|
+
|
|
4792
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4793
|
+
|
|
4794
|
+
</dd>
|
|
4795
|
+
</dl>
|
|
4796
|
+
</dd>
|
|
4797
|
+
</dl>
|
|
4798
|
+
|
|
4799
|
+
</dd>
|
|
4800
|
+
</dl>
|
|
4801
|
+
</details>
|
|
4802
|
+
|
|
4803
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">upsertCompanyTrait</a>({ ...params }) -> Schematic.UpsertCompanyTraitResponse</code></summary>
|
|
4804
|
+
<dl>
|
|
4805
|
+
<dd>
|
|
4806
|
+
|
|
4807
|
+
#### 🔌 Usage
|
|
4808
|
+
|
|
4809
|
+
<dl>
|
|
4810
|
+
<dd>
|
|
4811
|
+
|
|
4812
|
+
<dl>
|
|
4813
|
+
<dd>
|
|
4814
|
+
|
|
4815
|
+
```typescript
|
|
4816
|
+
await client.companies.upsertCompanyTrait({
|
|
4817
|
+
keys: {
|
|
4818
|
+
key: "value",
|
|
4819
|
+
},
|
|
4820
|
+
trait: "trait",
|
|
4821
|
+
});
|
|
4822
|
+
```
|
|
4823
|
+
|
|
4824
|
+
</dd>
|
|
4825
|
+
</dl>
|
|
4826
|
+
</dd>
|
|
4827
|
+
</dl>
|
|
4828
|
+
|
|
4829
|
+
#### ⚙️ Parameters
|
|
4830
|
+
|
|
4831
|
+
<dl>
|
|
4832
|
+
<dd>
|
|
4833
|
+
|
|
4834
|
+
<dl>
|
|
4835
|
+
<dd>
|
|
4836
|
+
|
|
4837
|
+
**request:** `Schematic.UpsertTraitRequestBody`
|
|
4838
|
+
|
|
4839
|
+
</dd>
|
|
4840
|
+
</dl>
|
|
4841
|
+
|
|
4842
|
+
<dl>
|
|
4843
|
+
<dd>
|
|
4844
|
+
|
|
4845
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4846
|
+
|
|
4847
|
+
</dd>
|
|
4848
|
+
</dl>
|
|
4849
|
+
</dd>
|
|
4850
|
+
</dl>
|
|
4851
|
+
|
|
4852
|
+
</dd>
|
|
4853
|
+
</dl>
|
|
4854
|
+
</details>
|
|
4855
|
+
|
|
4856
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">listEntityKeyDefinitions</a>({ ...params }) -> Schematic.ListEntityKeyDefinitionsResponse</code></summary>
|
|
4857
|
+
<dl>
|
|
4858
|
+
<dd>
|
|
4859
|
+
|
|
4860
|
+
#### 🔌 Usage
|
|
4861
|
+
|
|
4862
|
+
<dl>
|
|
4863
|
+
<dd>
|
|
4864
|
+
|
|
4865
|
+
<dl>
|
|
4866
|
+
<dd>
|
|
4867
|
+
|
|
4868
|
+
```typescript
|
|
4869
|
+
await client.companies.listEntityKeyDefinitions();
|
|
4870
|
+
```
|
|
4871
|
+
|
|
4872
|
+
</dd>
|
|
4873
|
+
</dl>
|
|
4874
|
+
</dd>
|
|
4875
|
+
</dl>
|
|
4876
|
+
|
|
4877
|
+
#### ⚙️ Parameters
|
|
4878
|
+
|
|
4879
|
+
<dl>
|
|
4880
|
+
<dd>
|
|
4881
|
+
|
|
4882
|
+
<dl>
|
|
4883
|
+
<dd>
|
|
4884
|
+
|
|
4885
|
+
**request:** `Schematic.ListEntityKeyDefinitionsRequest`
|
|
4886
|
+
|
|
4887
|
+
</dd>
|
|
4888
|
+
</dl>
|
|
4889
|
+
|
|
4890
|
+
<dl>
|
|
4891
|
+
<dd>
|
|
4892
|
+
|
|
4893
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4894
|
+
|
|
4895
|
+
</dd>
|
|
4896
|
+
</dl>
|
|
4897
|
+
</dd>
|
|
4898
|
+
</dl>
|
|
4899
|
+
|
|
4900
|
+
</dd>
|
|
4901
|
+
</dl>
|
|
4902
|
+
</details>
|
|
4903
|
+
|
|
4904
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">countEntityKeyDefinitions</a>({ ...params }) -> Schematic.CountEntityKeyDefinitionsResponse</code></summary>
|
|
4905
|
+
<dl>
|
|
4906
|
+
<dd>
|
|
4907
|
+
|
|
4908
|
+
#### 🔌 Usage
|
|
4909
|
+
|
|
4910
|
+
<dl>
|
|
4911
|
+
<dd>
|
|
4912
|
+
|
|
4913
|
+
<dl>
|
|
4914
|
+
<dd>
|
|
4915
|
+
|
|
4916
|
+
```typescript
|
|
4917
|
+
await client.companies.countEntityKeyDefinitions();
|
|
4918
|
+
```
|
|
4919
|
+
|
|
4920
|
+
</dd>
|
|
4921
|
+
</dl>
|
|
4922
|
+
</dd>
|
|
4923
|
+
</dl>
|
|
4924
|
+
|
|
4925
|
+
#### ⚙️ Parameters
|
|
4926
|
+
|
|
4927
|
+
<dl>
|
|
4928
|
+
<dd>
|
|
4929
|
+
|
|
4930
|
+
<dl>
|
|
4931
|
+
<dd>
|
|
4932
|
+
|
|
4933
|
+
**request:** `Schematic.CountEntityKeyDefinitionsRequest`
|
|
4934
|
+
|
|
4935
|
+
</dd>
|
|
4936
|
+
</dl>
|
|
4937
|
+
|
|
4938
|
+
<dl>
|
|
4939
|
+
<dd>
|
|
4940
|
+
|
|
4941
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4942
|
+
|
|
4943
|
+
</dd>
|
|
4944
|
+
</dl>
|
|
4945
|
+
</dd>
|
|
4946
|
+
</dl>
|
|
4947
|
+
|
|
4948
|
+
</dd>
|
|
4949
|
+
</dl>
|
|
4950
|
+
</details>
|
|
4951
|
+
|
|
4952
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">listEntityTraitDefinitions</a>({ ...params }) -> Schematic.ListEntityTraitDefinitionsResponse</code></summary>
|
|
4953
|
+
<dl>
|
|
4954
|
+
<dd>
|
|
4955
|
+
|
|
4956
|
+
#### 🔌 Usage
|
|
4957
|
+
|
|
4958
|
+
<dl>
|
|
4959
|
+
<dd>
|
|
4960
|
+
|
|
4961
|
+
<dl>
|
|
4962
|
+
<dd>
|
|
4963
|
+
|
|
4964
|
+
```typescript
|
|
4965
|
+
await client.companies.listEntityTraitDefinitions();
|
|
4966
|
+
```
|
|
4967
|
+
|
|
4968
|
+
</dd>
|
|
4969
|
+
</dl>
|
|
4970
|
+
</dd>
|
|
4971
|
+
</dl>
|
|
4972
|
+
|
|
4973
|
+
#### ⚙️ Parameters
|
|
4974
|
+
|
|
4975
|
+
<dl>
|
|
4976
|
+
<dd>
|
|
4977
|
+
|
|
4978
|
+
<dl>
|
|
4979
|
+
<dd>
|
|
4980
|
+
|
|
4981
|
+
**request:** `Schematic.ListEntityTraitDefinitionsRequest`
|
|
4982
|
+
|
|
4983
|
+
</dd>
|
|
4984
|
+
</dl>
|
|
4985
|
+
|
|
4986
|
+
<dl>
|
|
4987
|
+
<dd>
|
|
4988
|
+
|
|
4989
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
4990
|
+
|
|
4991
|
+
</dd>
|
|
4992
|
+
</dl>
|
|
4993
|
+
</dd>
|
|
4994
|
+
</dl>
|
|
4995
|
+
|
|
4996
|
+
</dd>
|
|
4997
|
+
</dl>
|
|
4998
|
+
</details>
|
|
4999
|
+
|
|
5000
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">getOrCreateEntityTraitDefinition</a>({ ...params }) -> Schematic.GetOrCreateEntityTraitDefinitionResponse</code></summary>
|
|
5001
|
+
<dl>
|
|
5002
|
+
<dd>
|
|
5003
|
+
|
|
5004
|
+
#### 🔌 Usage
|
|
5005
|
+
|
|
5006
|
+
<dl>
|
|
5007
|
+
<dd>
|
|
5008
|
+
|
|
5009
|
+
<dl>
|
|
5010
|
+
<dd>
|
|
5011
|
+
|
|
5012
|
+
```typescript
|
|
5013
|
+
await client.companies.getOrCreateEntityTraitDefinition({
|
|
5014
|
+
entityType: "company",
|
|
5015
|
+
hierarchy: ["hierarchy"],
|
|
5016
|
+
traitType: "boolean",
|
|
5017
|
+
});
|
|
5018
|
+
```
|
|
5019
|
+
|
|
5020
|
+
</dd>
|
|
5021
|
+
</dl>
|
|
5022
|
+
</dd>
|
|
5023
|
+
</dl>
|
|
5024
|
+
|
|
5025
|
+
#### ⚙️ Parameters
|
|
5026
|
+
|
|
5027
|
+
<dl>
|
|
5028
|
+
<dd>
|
|
5029
|
+
|
|
5030
|
+
<dl>
|
|
5031
|
+
<dd>
|
|
5032
|
+
|
|
5033
|
+
**request:** `Schematic.CreateEntityTraitDefinitionRequestBody`
|
|
5034
|
+
|
|
5035
|
+
</dd>
|
|
5036
|
+
</dl>
|
|
5037
|
+
|
|
5038
|
+
<dl>
|
|
5039
|
+
<dd>
|
|
5040
|
+
|
|
5041
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
5042
|
+
|
|
5043
|
+
</dd>
|
|
5044
|
+
</dl>
|
|
5045
|
+
</dd>
|
|
5046
|
+
</dl>
|
|
5047
|
+
|
|
5048
|
+
</dd>
|
|
5049
|
+
</dl>
|
|
5050
|
+
</details>
|
|
5051
|
+
|
|
5052
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">getEntityTraitDefinition</a>(entityTraitDefinitionId) -> Schematic.GetEntityTraitDefinitionResponse</code></summary>
|
|
5053
|
+
<dl>
|
|
5054
|
+
<dd>
|
|
5055
|
+
|
|
5056
|
+
#### 🔌 Usage
|
|
5057
|
+
|
|
5058
|
+
<dl>
|
|
5059
|
+
<dd>
|
|
5060
|
+
|
|
5061
|
+
<dl>
|
|
5062
|
+
<dd>
|
|
5063
|
+
|
|
5064
|
+
```typescript
|
|
5065
|
+
await client.companies.getEntityTraitDefinition("entity_trait_definition_id");
|
|
5066
|
+
```
|
|
5067
|
+
|
|
5068
|
+
</dd>
|
|
5069
|
+
</dl>
|
|
5070
|
+
</dd>
|
|
5071
|
+
</dl>
|
|
5072
|
+
|
|
5073
|
+
#### ⚙️ Parameters
|
|
5074
|
+
|
|
5075
|
+
<dl>
|
|
5076
|
+
<dd>
|
|
5077
|
+
|
|
5078
|
+
<dl>
|
|
5079
|
+
<dd>
|
|
5080
|
+
|
|
5081
|
+
**entityTraitDefinitionId:** `string` — entity_trait_definition_id
|
|
5082
|
+
|
|
5083
|
+
</dd>
|
|
5084
|
+
</dl>
|
|
5085
|
+
|
|
5086
|
+
<dl>
|
|
5087
|
+
<dd>
|
|
5088
|
+
|
|
5089
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
5090
|
+
|
|
5091
|
+
</dd>
|
|
5092
|
+
</dl>
|
|
5093
|
+
</dd>
|
|
5094
|
+
</dl>
|
|
5095
|
+
|
|
5096
|
+
</dd>
|
|
5097
|
+
</dl>
|
|
5098
|
+
</details>
|
|
5099
|
+
|
|
5100
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">updateEntityTraitDefinition</a>(entityTraitDefinitionId, { ...params }) -> Schematic.UpdateEntityTraitDefinitionResponse</code></summary>
|
|
5101
|
+
<dl>
|
|
5102
|
+
<dd>
|
|
5103
|
+
|
|
5104
|
+
#### 🔌 Usage
|
|
5105
|
+
|
|
5106
|
+
<dl>
|
|
5107
|
+
<dd>
|
|
5108
|
+
|
|
5109
|
+
<dl>
|
|
5110
|
+
<dd>
|
|
5111
|
+
|
|
5112
|
+
```typescript
|
|
5113
|
+
await client.companies.updateEntityTraitDefinition("entity_trait_definition_id", {
|
|
3912
5114
|
traitType: "boolean",
|
|
3913
5115
|
});
|
|
3914
5116
|
```
|
|
@@ -3926,7 +5128,166 @@ await client.companies.getOrCreateEntityTraitDefinition({
|
|
|
3926
5128
|
<dl>
|
|
3927
5129
|
<dd>
|
|
3928
5130
|
|
|
3929
|
-
**
|
|
5131
|
+
**entityTraitDefinitionId:** `string` — entity_trait_definition_id
|
|
5132
|
+
|
|
5133
|
+
</dd>
|
|
5134
|
+
</dl>
|
|
5135
|
+
|
|
5136
|
+
<dl>
|
|
5137
|
+
<dd>
|
|
5138
|
+
|
|
5139
|
+
**request:** `Schematic.UpdateEntityTraitDefinitionRequestBody`
|
|
5140
|
+
|
|
5141
|
+
</dd>
|
|
5142
|
+
</dl>
|
|
5143
|
+
|
|
5144
|
+
<dl>
|
|
5145
|
+
<dd>
|
|
5146
|
+
|
|
5147
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
5148
|
+
|
|
5149
|
+
</dd>
|
|
5150
|
+
</dl>
|
|
5151
|
+
</dd>
|
|
5152
|
+
</dl>
|
|
5153
|
+
|
|
5154
|
+
</dd>
|
|
5155
|
+
</dl>
|
|
5156
|
+
</details>
|
|
5157
|
+
|
|
5158
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">countEntityTraitDefinitions</a>({ ...params }) -> Schematic.CountEntityTraitDefinitionsResponse</code></summary>
|
|
5159
|
+
<dl>
|
|
5160
|
+
<dd>
|
|
5161
|
+
|
|
5162
|
+
#### 🔌 Usage
|
|
5163
|
+
|
|
5164
|
+
<dl>
|
|
5165
|
+
<dd>
|
|
5166
|
+
|
|
5167
|
+
<dl>
|
|
5168
|
+
<dd>
|
|
5169
|
+
|
|
5170
|
+
```typescript
|
|
5171
|
+
await client.companies.countEntityTraitDefinitions();
|
|
5172
|
+
```
|
|
5173
|
+
|
|
5174
|
+
</dd>
|
|
5175
|
+
</dl>
|
|
5176
|
+
</dd>
|
|
5177
|
+
</dl>
|
|
5178
|
+
|
|
5179
|
+
#### ⚙️ Parameters
|
|
5180
|
+
|
|
5181
|
+
<dl>
|
|
5182
|
+
<dd>
|
|
5183
|
+
|
|
5184
|
+
<dl>
|
|
5185
|
+
<dd>
|
|
5186
|
+
|
|
5187
|
+
**request:** `Schematic.CountEntityTraitDefinitionsRequest`
|
|
5188
|
+
|
|
5189
|
+
</dd>
|
|
5190
|
+
</dl>
|
|
5191
|
+
|
|
5192
|
+
<dl>
|
|
5193
|
+
<dd>
|
|
5194
|
+
|
|
5195
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
5196
|
+
|
|
5197
|
+
</dd>
|
|
5198
|
+
</dl>
|
|
5199
|
+
</dd>
|
|
5200
|
+
</dl>
|
|
5201
|
+
|
|
5202
|
+
</dd>
|
|
5203
|
+
</dl>
|
|
5204
|
+
</details>
|
|
5205
|
+
|
|
5206
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">getEntityTraitValues</a>({ ...params }) -> Schematic.GetEntityTraitValuesResponse</code></summary>
|
|
5207
|
+
<dl>
|
|
5208
|
+
<dd>
|
|
5209
|
+
|
|
5210
|
+
#### 🔌 Usage
|
|
5211
|
+
|
|
5212
|
+
<dl>
|
|
5213
|
+
<dd>
|
|
5214
|
+
|
|
5215
|
+
<dl>
|
|
5216
|
+
<dd>
|
|
5217
|
+
|
|
5218
|
+
```typescript
|
|
5219
|
+
await client.companies.getEntityTraitValues({
|
|
5220
|
+
definitionId: "definition_id",
|
|
5221
|
+
});
|
|
5222
|
+
```
|
|
5223
|
+
|
|
5224
|
+
</dd>
|
|
5225
|
+
</dl>
|
|
5226
|
+
</dd>
|
|
5227
|
+
</dl>
|
|
5228
|
+
|
|
5229
|
+
#### ⚙️ Parameters
|
|
5230
|
+
|
|
5231
|
+
<dl>
|
|
5232
|
+
<dd>
|
|
5233
|
+
|
|
5234
|
+
<dl>
|
|
5235
|
+
<dd>
|
|
5236
|
+
|
|
5237
|
+
**request:** `Schematic.GetEntityTraitValuesRequest`
|
|
5238
|
+
|
|
5239
|
+
</dd>
|
|
5240
|
+
</dl>
|
|
5241
|
+
|
|
5242
|
+
<dl>
|
|
5243
|
+
<dd>
|
|
5244
|
+
|
|
5245
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
5246
|
+
|
|
5247
|
+
</dd>
|
|
5248
|
+
</dl>
|
|
5249
|
+
</dd>
|
|
5250
|
+
</dl>
|
|
5251
|
+
|
|
5252
|
+
</dd>
|
|
5253
|
+
</dl>
|
|
5254
|
+
</details>
|
|
5255
|
+
|
|
5256
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">upsertUserTrait</a>({ ...params }) -> Schematic.UpsertUserTraitResponse</code></summary>
|
|
5257
|
+
<dl>
|
|
5258
|
+
<dd>
|
|
5259
|
+
|
|
5260
|
+
#### 🔌 Usage
|
|
5261
|
+
|
|
5262
|
+
<dl>
|
|
5263
|
+
<dd>
|
|
5264
|
+
|
|
5265
|
+
<dl>
|
|
5266
|
+
<dd>
|
|
5267
|
+
|
|
5268
|
+
```typescript
|
|
5269
|
+
await client.companies.upsertUserTrait({
|
|
5270
|
+
keys: {
|
|
5271
|
+
key: "value",
|
|
5272
|
+
},
|
|
5273
|
+
trait: "trait",
|
|
5274
|
+
});
|
|
5275
|
+
```
|
|
5276
|
+
|
|
5277
|
+
</dd>
|
|
5278
|
+
</dl>
|
|
5279
|
+
</dd>
|
|
5280
|
+
</dl>
|
|
5281
|
+
|
|
5282
|
+
#### ⚙️ Parameters
|
|
5283
|
+
|
|
5284
|
+
<dl>
|
|
5285
|
+
<dd>
|
|
5286
|
+
|
|
5287
|
+
<dl>
|
|
5288
|
+
<dd>
|
|
5289
|
+
|
|
5290
|
+
**request:** `Schematic.UpsertTraitRequestBody`
|
|
3930
5291
|
|
|
3931
5292
|
</dd>
|
|
3932
5293
|
</dl>
|
|
@@ -3945,7 +5306,7 @@ await client.companies.getOrCreateEntityTraitDefinition({
|
|
|
3945
5306
|
</dl>
|
|
3946
5307
|
</details>
|
|
3947
5308
|
|
|
3948
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
5309
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">listUsers</a>({ ...params }) -> Schematic.ListUsersResponse</code></summary>
|
|
3949
5310
|
<dl>
|
|
3950
5311
|
<dd>
|
|
3951
5312
|
|
|
@@ -3958,7 +5319,7 @@ await client.companies.getOrCreateEntityTraitDefinition({
|
|
|
3958
5319
|
<dd>
|
|
3959
5320
|
|
|
3960
5321
|
```typescript
|
|
3961
|
-
await client.companies.
|
|
5322
|
+
await client.companies.listUsers();
|
|
3962
5323
|
```
|
|
3963
5324
|
|
|
3964
5325
|
</dd>
|
|
@@ -3974,7 +5335,7 @@ await client.companies.getEntityTraitDefinition("entity_trait_definition_id");
|
|
|
3974
5335
|
<dl>
|
|
3975
5336
|
<dd>
|
|
3976
5337
|
|
|
3977
|
-
**
|
|
5338
|
+
**request:** `Schematic.ListUsersRequest`
|
|
3978
5339
|
|
|
3979
5340
|
</dd>
|
|
3980
5341
|
</dl>
|
|
@@ -3993,7 +5354,7 @@ await client.companies.getEntityTraitDefinition("entity_trait_definition_id");
|
|
|
3993
5354
|
</dl>
|
|
3994
5355
|
</details>
|
|
3995
5356
|
|
|
3996
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
5357
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">upsertUser</a>({ ...params }) -> Schematic.UpsertUserResponse</code></summary>
|
|
3997
5358
|
<dl>
|
|
3998
5359
|
<dd>
|
|
3999
5360
|
|
|
@@ -4006,8 +5367,10 @@ await client.companies.getEntityTraitDefinition("entity_trait_definition_id");
|
|
|
4006
5367
|
<dd>
|
|
4007
5368
|
|
|
4008
5369
|
```typescript
|
|
4009
|
-
await client.companies.
|
|
4010
|
-
|
|
5370
|
+
await client.companies.upsertUser({
|
|
5371
|
+
keys: {
|
|
5372
|
+
key: "value",
|
|
5373
|
+
},
|
|
4011
5374
|
});
|
|
4012
5375
|
```
|
|
4013
5376
|
|
|
@@ -4024,7 +5387,7 @@ await client.companies.updateEntityTraitDefinition("entity_trait_definition_id",
|
|
|
4024
5387
|
<dl>
|
|
4025
5388
|
<dd>
|
|
4026
5389
|
|
|
4027
|
-
**
|
|
5390
|
+
**request:** `Schematic.UpsertUserRequestBody`
|
|
4028
5391
|
|
|
4029
5392
|
</dd>
|
|
4030
5393
|
</dl>
|
|
@@ -4032,7 +5395,47 @@ await client.companies.updateEntityTraitDefinition("entity_trait_definition_id",
|
|
|
4032
5395
|
<dl>
|
|
4033
5396
|
<dd>
|
|
4034
5397
|
|
|
4035
|
-
**
|
|
5398
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
5399
|
+
|
|
5400
|
+
</dd>
|
|
5401
|
+
</dl>
|
|
5402
|
+
</dd>
|
|
5403
|
+
</dl>
|
|
5404
|
+
|
|
5405
|
+
</dd>
|
|
5406
|
+
</dl>
|
|
5407
|
+
</details>
|
|
5408
|
+
|
|
5409
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">getUser</a>(userId) -> Schematic.GetUserResponse</code></summary>
|
|
5410
|
+
<dl>
|
|
5411
|
+
<dd>
|
|
5412
|
+
|
|
5413
|
+
#### 🔌 Usage
|
|
5414
|
+
|
|
5415
|
+
<dl>
|
|
5416
|
+
<dd>
|
|
5417
|
+
|
|
5418
|
+
<dl>
|
|
5419
|
+
<dd>
|
|
5420
|
+
|
|
5421
|
+
```typescript
|
|
5422
|
+
await client.companies.getUser("user_id");
|
|
5423
|
+
```
|
|
5424
|
+
|
|
5425
|
+
</dd>
|
|
5426
|
+
</dl>
|
|
5427
|
+
</dd>
|
|
5428
|
+
</dl>
|
|
5429
|
+
|
|
5430
|
+
#### ⚙️ Parameters
|
|
5431
|
+
|
|
5432
|
+
<dl>
|
|
5433
|
+
<dd>
|
|
5434
|
+
|
|
5435
|
+
<dl>
|
|
5436
|
+
<dd>
|
|
5437
|
+
|
|
5438
|
+
**userId:** `string` — user_id
|
|
4036
5439
|
|
|
4037
5440
|
</dd>
|
|
4038
5441
|
</dl>
|
|
@@ -4051,7 +5454,7 @@ await client.companies.updateEntityTraitDefinition("entity_trait_definition_id",
|
|
|
4051
5454
|
</dl>
|
|
4052
5455
|
</details>
|
|
4053
5456
|
|
|
4054
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
5457
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">deleteUser</a>(userId) -> Schematic.DeleteUserResponse</code></summary>
|
|
4055
5458
|
<dl>
|
|
4056
5459
|
<dd>
|
|
4057
5460
|
|
|
@@ -4064,7 +5467,7 @@ await client.companies.updateEntityTraitDefinition("entity_trait_definition_id",
|
|
|
4064
5467
|
<dd>
|
|
4065
5468
|
|
|
4066
5469
|
```typescript
|
|
4067
|
-
await client.companies.
|
|
5470
|
+
await client.companies.deleteUser("user_id");
|
|
4068
5471
|
```
|
|
4069
5472
|
|
|
4070
5473
|
</dd>
|
|
@@ -4080,7 +5483,7 @@ await client.companies.countEntityTraitDefinitions();
|
|
|
4080
5483
|
<dl>
|
|
4081
5484
|
<dd>
|
|
4082
5485
|
|
|
4083
|
-
**
|
|
5486
|
+
**userId:** `string` — user_id
|
|
4084
5487
|
|
|
4085
5488
|
</dd>
|
|
4086
5489
|
</dl>
|
|
@@ -4099,7 +5502,7 @@ await client.companies.countEntityTraitDefinitions();
|
|
|
4099
5502
|
</dl>
|
|
4100
5503
|
</details>
|
|
4101
5504
|
|
|
4102
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
5505
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">countUsers</a>({ ...params }) -> Schematic.CountUsersResponse</code></summary>
|
|
4103
5506
|
<dl>
|
|
4104
5507
|
<dd>
|
|
4105
5508
|
|
|
@@ -4112,9 +5515,7 @@ await client.companies.countEntityTraitDefinitions();
|
|
|
4112
5515
|
<dd>
|
|
4113
5516
|
|
|
4114
5517
|
```typescript
|
|
4115
|
-
await client.companies.
|
|
4116
|
-
definitionId: "definition_id",
|
|
4117
|
-
});
|
|
5518
|
+
await client.companies.countUsers();
|
|
4118
5519
|
```
|
|
4119
5520
|
|
|
4120
5521
|
</dd>
|
|
@@ -4130,7 +5531,7 @@ await client.companies.getEntityTraitValues({
|
|
|
4130
5531
|
<dl>
|
|
4131
5532
|
<dd>
|
|
4132
5533
|
|
|
4133
|
-
**request:** `Schematic.
|
|
5534
|
+
**request:** `Schematic.CountUsersRequest`
|
|
4134
5535
|
|
|
4135
5536
|
</dd>
|
|
4136
5537
|
</dl>
|
|
@@ -4149,7 +5550,7 @@ await client.companies.getEntityTraitValues({
|
|
|
4149
5550
|
</dl>
|
|
4150
5551
|
</details>
|
|
4151
5552
|
|
|
4152
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
5553
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">createUser</a>({ ...params }) -> Schematic.CreateUserResponse</code></summary>
|
|
4153
5554
|
<dl>
|
|
4154
5555
|
<dd>
|
|
4155
5556
|
|
|
@@ -4162,11 +5563,10 @@ await client.companies.getEntityTraitValues({
|
|
|
4162
5563
|
<dd>
|
|
4163
5564
|
|
|
4164
5565
|
```typescript
|
|
4165
|
-
await client.companies.
|
|
5566
|
+
await client.companies.createUser({
|
|
4166
5567
|
keys: {
|
|
4167
5568
|
key: "value",
|
|
4168
5569
|
},
|
|
4169
|
-
trait: "trait",
|
|
4170
5570
|
});
|
|
4171
5571
|
```
|
|
4172
5572
|
|
|
@@ -4183,7 +5583,7 @@ await client.companies.upsertUserTrait({
|
|
|
4183
5583
|
<dl>
|
|
4184
5584
|
<dd>
|
|
4185
5585
|
|
|
4186
|
-
**request:** `Schematic.
|
|
5586
|
+
**request:** `Schematic.UpsertUserRequestBody`
|
|
4187
5587
|
|
|
4188
5588
|
</dd>
|
|
4189
5589
|
</dl>
|
|
@@ -4202,7 +5602,7 @@ await client.companies.upsertUserTrait({
|
|
|
4202
5602
|
</dl>
|
|
4203
5603
|
</details>
|
|
4204
5604
|
|
|
4205
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
5605
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">deleteUserByKeys</a>({ ...params }) -> Schematic.DeleteUserByKeysResponse</code></summary>
|
|
4206
5606
|
<dl>
|
|
4207
5607
|
<dd>
|
|
4208
5608
|
|
|
@@ -4215,7 +5615,11 @@ await client.companies.upsertUserTrait({
|
|
|
4215
5615
|
<dd>
|
|
4216
5616
|
|
|
4217
5617
|
```typescript
|
|
4218
|
-
await client.companies.
|
|
5618
|
+
await client.companies.deleteUserByKeys({
|
|
5619
|
+
keys: {
|
|
5620
|
+
key: "value",
|
|
5621
|
+
},
|
|
5622
|
+
});
|
|
4219
5623
|
```
|
|
4220
5624
|
|
|
4221
5625
|
</dd>
|
|
@@ -4231,7 +5635,7 @@ await client.companies.listUsers();
|
|
|
4231
5635
|
<dl>
|
|
4232
5636
|
<dd>
|
|
4233
5637
|
|
|
4234
|
-
**request:** `Schematic.
|
|
5638
|
+
**request:** `Schematic.KeysRequestBody`
|
|
4235
5639
|
|
|
4236
5640
|
</dd>
|
|
4237
5641
|
</dl>
|
|
@@ -4250,7 +5654,7 @@ await client.companies.listUsers();
|
|
|
4250
5654
|
</dl>
|
|
4251
5655
|
</details>
|
|
4252
5656
|
|
|
4253
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
5657
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">lookupUser</a>({ ...params }) -> Schematic.LookupUserResponse</code></summary>
|
|
4254
5658
|
<dl>
|
|
4255
5659
|
<dd>
|
|
4256
5660
|
|
|
@@ -4263,12 +5667,9 @@ await client.companies.listUsers();
|
|
|
4263
5667
|
<dd>
|
|
4264
5668
|
|
|
4265
5669
|
```typescript
|
|
4266
|
-
await client.companies.
|
|
4267
|
-
company: {
|
|
4268
|
-
key: "value",
|
|
4269
|
-
},
|
|
5670
|
+
await client.companies.lookupUser({
|
|
4270
5671
|
keys: {
|
|
4271
|
-
|
|
5672
|
+
keys: "keys",
|
|
4272
5673
|
},
|
|
4273
5674
|
});
|
|
4274
5675
|
```
|
|
@@ -4286,7 +5687,7 @@ await client.companies.upsertUser({
|
|
|
4286
5687
|
<dl>
|
|
4287
5688
|
<dd>
|
|
4288
5689
|
|
|
4289
|
-
**request:** `Schematic.
|
|
5690
|
+
**request:** `Schematic.LookupUserRequest`
|
|
4290
5691
|
|
|
4291
5692
|
</dd>
|
|
4292
5693
|
</dl>
|
|
@@ -4305,7 +5706,9 @@ await client.companies.upsertUser({
|
|
|
4305
5706
|
</dl>
|
|
4306
5707
|
</details>
|
|
4307
5708
|
|
|
4308
|
-
|
|
5709
|
+
## entitlements
|
|
5710
|
+
|
|
5711
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">listCompanyOverrides</a>({ ...params }) -> Schematic.ListCompanyOverridesResponse</code></summary>
|
|
4309
5712
|
<dl>
|
|
4310
5713
|
<dd>
|
|
4311
5714
|
|
|
@@ -4318,7 +5721,7 @@ await client.companies.upsertUser({
|
|
|
4318
5721
|
<dd>
|
|
4319
5722
|
|
|
4320
5723
|
```typescript
|
|
4321
|
-
await client.
|
|
5724
|
+
await client.entitlements.listCompanyOverrides();
|
|
4322
5725
|
```
|
|
4323
5726
|
|
|
4324
5727
|
</dd>
|
|
@@ -4334,7 +5737,7 @@ await client.companies.getUser("user_id");
|
|
|
4334
5737
|
<dl>
|
|
4335
5738
|
<dd>
|
|
4336
5739
|
|
|
4337
|
-
**
|
|
5740
|
+
**request:** `Schematic.ListCompanyOverridesRequest`
|
|
4338
5741
|
|
|
4339
5742
|
</dd>
|
|
4340
5743
|
</dl>
|
|
@@ -4342,7 +5745,7 @@ await client.companies.getUser("user_id");
|
|
|
4342
5745
|
<dl>
|
|
4343
5746
|
<dd>
|
|
4344
5747
|
|
|
4345
|
-
**requestOptions:** `
|
|
5748
|
+
**requestOptions:** `Entitlements.RequestOptions`
|
|
4346
5749
|
|
|
4347
5750
|
</dd>
|
|
4348
5751
|
</dl>
|
|
@@ -4353,7 +5756,7 @@ await client.companies.getUser("user_id");
|
|
|
4353
5756
|
</dl>
|
|
4354
5757
|
</details>
|
|
4355
5758
|
|
|
4356
|
-
<details><summary><code>client.
|
|
5759
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">createCompanyOverride</a>({ ...params }) -> Schematic.CreateCompanyOverrideResponse</code></summary>
|
|
4357
5760
|
<dl>
|
|
4358
5761
|
<dd>
|
|
4359
5762
|
|
|
@@ -4366,7 +5769,11 @@ await client.companies.getUser("user_id");
|
|
|
4366
5769
|
<dd>
|
|
4367
5770
|
|
|
4368
5771
|
```typescript
|
|
4369
|
-
await client.
|
|
5772
|
+
await client.entitlements.createCompanyOverride({
|
|
5773
|
+
companyId: "company_id",
|
|
5774
|
+
featureId: "feature_id",
|
|
5775
|
+
valueType: "boolean",
|
|
5776
|
+
});
|
|
4370
5777
|
```
|
|
4371
5778
|
|
|
4372
5779
|
</dd>
|
|
@@ -4382,7 +5789,7 @@ await client.companies.deleteUser("user_id");
|
|
|
4382
5789
|
<dl>
|
|
4383
5790
|
<dd>
|
|
4384
5791
|
|
|
4385
|
-
**
|
|
5792
|
+
**request:** `Schematic.CreateCompanyOverrideRequestBody`
|
|
4386
5793
|
|
|
4387
5794
|
</dd>
|
|
4388
5795
|
</dl>
|
|
@@ -4390,7 +5797,7 @@ await client.companies.deleteUser("user_id");
|
|
|
4390
5797
|
<dl>
|
|
4391
5798
|
<dd>
|
|
4392
5799
|
|
|
4393
|
-
**requestOptions:** `
|
|
5800
|
+
**requestOptions:** `Entitlements.RequestOptions`
|
|
4394
5801
|
|
|
4395
5802
|
</dd>
|
|
4396
5803
|
</dl>
|
|
@@ -4401,7 +5808,7 @@ await client.companies.deleteUser("user_id");
|
|
|
4401
5808
|
</dl>
|
|
4402
5809
|
</details>
|
|
4403
5810
|
|
|
4404
|
-
<details><summary><code>client.
|
|
5811
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">getCompanyOverride</a>(companyOverrideId) -> Schematic.GetCompanyOverrideResponse</code></summary>
|
|
4405
5812
|
<dl>
|
|
4406
5813
|
<dd>
|
|
4407
5814
|
|
|
@@ -4414,7 +5821,7 @@ await client.companies.deleteUser("user_id");
|
|
|
4414
5821
|
<dd>
|
|
4415
5822
|
|
|
4416
5823
|
```typescript
|
|
4417
|
-
await client.
|
|
5824
|
+
await client.entitlements.getCompanyOverride("company_override_id");
|
|
4418
5825
|
```
|
|
4419
5826
|
|
|
4420
5827
|
</dd>
|
|
@@ -4430,7 +5837,7 @@ await client.companies.countUsers();
|
|
|
4430
5837
|
<dl>
|
|
4431
5838
|
<dd>
|
|
4432
5839
|
|
|
4433
|
-
**
|
|
5840
|
+
**companyOverrideId:** `string` — company_override_id
|
|
4434
5841
|
|
|
4435
5842
|
</dd>
|
|
4436
5843
|
</dl>
|
|
@@ -4438,7 +5845,7 @@ await client.companies.countUsers();
|
|
|
4438
5845
|
<dl>
|
|
4439
5846
|
<dd>
|
|
4440
5847
|
|
|
4441
|
-
**requestOptions:** `
|
|
5848
|
+
**requestOptions:** `Entitlements.RequestOptions`
|
|
4442
5849
|
|
|
4443
5850
|
</dd>
|
|
4444
5851
|
</dl>
|
|
@@ -4449,7 +5856,7 @@ await client.companies.countUsers();
|
|
|
4449
5856
|
</dl>
|
|
4450
5857
|
</details>
|
|
4451
5858
|
|
|
4452
|
-
<details><summary><code>client.
|
|
5859
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">updateCompanyOverride</a>(companyOverrideId, { ...params }) -> Schematic.UpdateCompanyOverrideResponse</code></summary>
|
|
4453
5860
|
<dl>
|
|
4454
5861
|
<dd>
|
|
4455
5862
|
|
|
@@ -4462,13 +5869,8 @@ await client.companies.countUsers();
|
|
|
4462
5869
|
<dd>
|
|
4463
5870
|
|
|
4464
5871
|
```typescript
|
|
4465
|
-
await client.
|
|
4466
|
-
|
|
4467
|
-
key: "value",
|
|
4468
|
-
},
|
|
4469
|
-
keys: {
|
|
4470
|
-
key: "value",
|
|
4471
|
-
},
|
|
5872
|
+
await client.entitlements.updateCompanyOverride("company_override_id", {
|
|
5873
|
+
valueType: "boolean",
|
|
4472
5874
|
});
|
|
4473
5875
|
```
|
|
4474
5876
|
|
|
@@ -4485,7 +5887,7 @@ await client.companies.createUser({
|
|
|
4485
5887
|
<dl>
|
|
4486
5888
|
<dd>
|
|
4487
5889
|
|
|
4488
|
-
**
|
|
5890
|
+
**companyOverrideId:** `string` — company_override_id
|
|
4489
5891
|
|
|
4490
5892
|
</dd>
|
|
4491
5893
|
</dl>
|
|
@@ -4493,7 +5895,15 @@ await client.companies.createUser({
|
|
|
4493
5895
|
<dl>
|
|
4494
5896
|
<dd>
|
|
4495
5897
|
|
|
4496
|
-
**
|
|
5898
|
+
**request:** `Schematic.UpdateCompanyOverrideRequestBody`
|
|
5899
|
+
|
|
5900
|
+
</dd>
|
|
5901
|
+
</dl>
|
|
5902
|
+
|
|
5903
|
+
<dl>
|
|
5904
|
+
<dd>
|
|
5905
|
+
|
|
5906
|
+
**requestOptions:** `Entitlements.RequestOptions`
|
|
4497
5907
|
|
|
4498
5908
|
</dd>
|
|
4499
5909
|
</dl>
|
|
@@ -4504,7 +5914,7 @@ await client.companies.createUser({
|
|
|
4504
5914
|
</dl>
|
|
4505
5915
|
</details>
|
|
4506
5916
|
|
|
4507
|
-
<details><summary><code>client.
|
|
5917
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">deleteCompanyOverride</a>(companyOverrideId) -> Schematic.DeleteCompanyOverrideResponse</code></summary>
|
|
4508
5918
|
<dl>
|
|
4509
5919
|
<dd>
|
|
4510
5920
|
|
|
@@ -4517,11 +5927,7 @@ await client.companies.createUser({
|
|
|
4517
5927
|
<dd>
|
|
4518
5928
|
|
|
4519
5929
|
```typescript
|
|
4520
|
-
await client.
|
|
4521
|
-
keys: {
|
|
4522
|
-
key: "value",
|
|
4523
|
-
},
|
|
4524
|
-
});
|
|
5930
|
+
await client.entitlements.deleteCompanyOverride("company_override_id");
|
|
4525
5931
|
```
|
|
4526
5932
|
|
|
4527
5933
|
</dd>
|
|
@@ -4537,7 +5943,7 @@ await client.companies.deleteUserByKeys({
|
|
|
4537
5943
|
<dl>
|
|
4538
5944
|
<dd>
|
|
4539
5945
|
|
|
4540
|
-
**
|
|
5946
|
+
**companyOverrideId:** `string` — company_override_id
|
|
4541
5947
|
|
|
4542
5948
|
</dd>
|
|
4543
5949
|
</dl>
|
|
@@ -4545,7 +5951,7 @@ await client.companies.deleteUserByKeys({
|
|
|
4545
5951
|
<dl>
|
|
4546
5952
|
<dd>
|
|
4547
5953
|
|
|
4548
|
-
**requestOptions:** `
|
|
5954
|
+
**requestOptions:** `Entitlements.RequestOptions`
|
|
4549
5955
|
|
|
4550
5956
|
</dd>
|
|
4551
5957
|
</dl>
|
|
@@ -4556,7 +5962,7 @@ await client.companies.deleteUserByKeys({
|
|
|
4556
5962
|
</dl>
|
|
4557
5963
|
</details>
|
|
4558
5964
|
|
|
4559
|
-
<details><summary><code>client.
|
|
5965
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">countCompanyOverrides</a>({ ...params }) -> Schematic.CountCompanyOverridesResponse</code></summary>
|
|
4560
5966
|
<dl>
|
|
4561
5967
|
<dd>
|
|
4562
5968
|
|
|
@@ -4569,13 +5975,7 @@ await client.companies.deleteUserByKeys({
|
|
|
4569
5975
|
<dd>
|
|
4570
5976
|
|
|
4571
5977
|
```typescript
|
|
4572
|
-
await client.
|
|
4573
|
-
keys: {
|
|
4574
|
-
keys: {
|
|
4575
|
-
key: "value",
|
|
4576
|
-
},
|
|
4577
|
-
},
|
|
4578
|
-
});
|
|
5978
|
+
await client.entitlements.countCompanyOverrides();
|
|
4579
5979
|
```
|
|
4580
5980
|
|
|
4581
5981
|
</dd>
|
|
@@ -4591,7 +5991,7 @@ await client.companies.lookupUser({
|
|
|
4591
5991
|
<dl>
|
|
4592
5992
|
<dd>
|
|
4593
5993
|
|
|
4594
|
-
**request:** `Schematic.
|
|
5994
|
+
**request:** `Schematic.CountCompanyOverridesRequest`
|
|
4595
5995
|
|
|
4596
5996
|
</dd>
|
|
4597
5997
|
</dl>
|
|
@@ -4599,7 +5999,7 @@ await client.companies.lookupUser({
|
|
|
4599
5999
|
<dl>
|
|
4600
6000
|
<dd>
|
|
4601
6001
|
|
|
4602
|
-
**requestOptions:** `
|
|
6002
|
+
**requestOptions:** `Entitlements.RequestOptions`
|
|
4603
6003
|
|
|
4604
6004
|
</dd>
|
|
4605
6005
|
</dl>
|
|
@@ -4610,9 +6010,7 @@ await client.companies.lookupUser({
|
|
|
4610
6010
|
</dl>
|
|
4611
6011
|
</details>
|
|
4612
6012
|
|
|
4613
|
-
|
|
4614
|
-
|
|
4615
|
-
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">listCompanyOverrides</a>({ ...params }) -> Schematic.ListCompanyOverridesResponse</code></summary>
|
|
6013
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">listFeatureCompanies</a>({ ...params }) -> Schematic.ListFeatureCompaniesResponse</code></summary>
|
|
4616
6014
|
<dl>
|
|
4617
6015
|
<dd>
|
|
4618
6016
|
|
|
@@ -4625,7 +6023,9 @@ await client.companies.lookupUser({
|
|
|
4625
6023
|
<dd>
|
|
4626
6024
|
|
|
4627
6025
|
```typescript
|
|
4628
|
-
await client.entitlements.
|
|
6026
|
+
await client.entitlements.listFeatureCompanies({
|
|
6027
|
+
featureId: "feature_id",
|
|
6028
|
+
});
|
|
4629
6029
|
```
|
|
4630
6030
|
|
|
4631
6031
|
</dd>
|
|
@@ -4641,7 +6041,7 @@ await client.entitlements.listCompanyOverrides();
|
|
|
4641
6041
|
<dl>
|
|
4642
6042
|
<dd>
|
|
4643
6043
|
|
|
4644
|
-
**request:** `Schematic.
|
|
6044
|
+
**request:** `Schematic.ListFeatureCompaniesRequest`
|
|
4645
6045
|
|
|
4646
6046
|
</dd>
|
|
4647
6047
|
</dl>
|
|
@@ -4660,7 +6060,7 @@ await client.entitlements.listCompanyOverrides();
|
|
|
4660
6060
|
</dl>
|
|
4661
6061
|
</details>
|
|
4662
6062
|
|
|
4663
|
-
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">
|
|
6063
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">countFeatureCompanies</a>({ ...params }) -> Schematic.CountFeatureCompaniesResponse</code></summary>
|
|
4664
6064
|
<dl>
|
|
4665
6065
|
<dd>
|
|
4666
6066
|
|
|
@@ -4673,10 +6073,8 @@ await client.entitlements.listCompanyOverrides();
|
|
|
4673
6073
|
<dd>
|
|
4674
6074
|
|
|
4675
6075
|
```typescript
|
|
4676
|
-
await client.entitlements.
|
|
4677
|
-
companyId: "company_id",
|
|
6076
|
+
await client.entitlements.countFeatureCompanies({
|
|
4678
6077
|
featureId: "feature_id",
|
|
4679
|
-
valueType: "boolean",
|
|
4680
6078
|
});
|
|
4681
6079
|
```
|
|
4682
6080
|
|
|
@@ -4693,7 +6091,7 @@ await client.entitlements.createCompanyOverride({
|
|
|
4693
6091
|
<dl>
|
|
4694
6092
|
<dd>
|
|
4695
6093
|
|
|
4696
|
-
**request:** `Schematic.
|
|
6094
|
+
**request:** `Schematic.CountFeatureCompaniesRequest`
|
|
4697
6095
|
|
|
4698
6096
|
</dd>
|
|
4699
6097
|
</dl>
|
|
@@ -4712,7 +6110,7 @@ await client.entitlements.createCompanyOverride({
|
|
|
4712
6110
|
</dl>
|
|
4713
6111
|
</details>
|
|
4714
6112
|
|
|
4715
|
-
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">
|
|
6113
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">listFeatureUsage</a>({ ...params }) -> Schematic.ListFeatureUsageResponse</code></summary>
|
|
4716
6114
|
<dl>
|
|
4717
6115
|
<dd>
|
|
4718
6116
|
|
|
@@ -4725,7 +6123,7 @@ await client.entitlements.createCompanyOverride({
|
|
|
4725
6123
|
<dd>
|
|
4726
6124
|
|
|
4727
6125
|
```typescript
|
|
4728
|
-
await client.entitlements.
|
|
6126
|
+
await client.entitlements.listFeatureUsage();
|
|
4729
6127
|
```
|
|
4730
6128
|
|
|
4731
6129
|
</dd>
|
|
@@ -4741,7 +6139,7 @@ await client.entitlements.getCompanyOverride("company_override_id");
|
|
|
4741
6139
|
<dl>
|
|
4742
6140
|
<dd>
|
|
4743
6141
|
|
|
4744
|
-
**
|
|
6142
|
+
**request:** `Schematic.ListFeatureUsageRequest`
|
|
4745
6143
|
|
|
4746
6144
|
</dd>
|
|
4747
6145
|
</dl>
|
|
@@ -4760,7 +6158,7 @@ await client.entitlements.getCompanyOverride("company_override_id");
|
|
|
4760
6158
|
</dl>
|
|
4761
6159
|
</details>
|
|
4762
6160
|
|
|
4763
|
-
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">
|
|
6161
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">countFeatureUsage</a>({ ...params }) -> Schematic.CountFeatureUsageResponse</code></summary>
|
|
4764
6162
|
<dl>
|
|
4765
6163
|
<dd>
|
|
4766
6164
|
|
|
@@ -4773,9 +6171,7 @@ await client.entitlements.getCompanyOverride("company_override_id");
|
|
|
4773
6171
|
<dd>
|
|
4774
6172
|
|
|
4775
6173
|
```typescript
|
|
4776
|
-
await client.entitlements.
|
|
4777
|
-
valueType: "boolean",
|
|
4778
|
-
});
|
|
6174
|
+
await client.entitlements.countFeatureUsage();
|
|
4779
6175
|
```
|
|
4780
6176
|
|
|
4781
6177
|
</dd>
|
|
@@ -4791,15 +6187,7 @@ await client.entitlements.updateCompanyOverride("company_override_id", {
|
|
|
4791
6187
|
<dl>
|
|
4792
6188
|
<dd>
|
|
4793
6189
|
|
|
4794
|
-
**
|
|
4795
|
-
|
|
4796
|
-
</dd>
|
|
4797
|
-
</dl>
|
|
4798
|
-
|
|
4799
|
-
<dl>
|
|
4800
|
-
<dd>
|
|
4801
|
-
|
|
4802
|
-
**request:** `Schematic.UpdateCompanyOverrideRequestBody`
|
|
6190
|
+
**request:** `Schematic.CountFeatureUsageRequest`
|
|
4803
6191
|
|
|
4804
6192
|
</dd>
|
|
4805
6193
|
</dl>
|
|
@@ -4818,7 +6206,7 @@ await client.entitlements.updateCompanyOverride("company_override_id", {
|
|
|
4818
6206
|
</dl>
|
|
4819
6207
|
</details>
|
|
4820
6208
|
|
|
4821
|
-
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">
|
|
6209
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">listFeatureUsers</a>({ ...params }) -> Schematic.ListFeatureUsersResponse</code></summary>
|
|
4822
6210
|
<dl>
|
|
4823
6211
|
<dd>
|
|
4824
6212
|
|
|
@@ -4831,7 +6219,9 @@ await client.entitlements.updateCompanyOverride("company_override_id", {
|
|
|
4831
6219
|
<dd>
|
|
4832
6220
|
|
|
4833
6221
|
```typescript
|
|
4834
|
-
await client.entitlements.
|
|
6222
|
+
await client.entitlements.listFeatureUsers({
|
|
6223
|
+
featureId: "feature_id",
|
|
6224
|
+
});
|
|
4835
6225
|
```
|
|
4836
6226
|
|
|
4837
6227
|
</dd>
|
|
@@ -4847,7 +6237,7 @@ await client.entitlements.deleteCompanyOverride("company_override_id");
|
|
|
4847
6237
|
<dl>
|
|
4848
6238
|
<dd>
|
|
4849
6239
|
|
|
4850
|
-
**
|
|
6240
|
+
**request:** `Schematic.ListFeatureUsersRequest`
|
|
4851
6241
|
|
|
4852
6242
|
</dd>
|
|
4853
6243
|
</dl>
|
|
@@ -4866,7 +6256,7 @@ await client.entitlements.deleteCompanyOverride("company_override_id");
|
|
|
4866
6256
|
</dl>
|
|
4867
6257
|
</details>
|
|
4868
6258
|
|
|
4869
|
-
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">
|
|
6259
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">countFeatureUsers</a>({ ...params }) -> Schematic.CountFeatureUsersResponse</code></summary>
|
|
4870
6260
|
<dl>
|
|
4871
6261
|
<dd>
|
|
4872
6262
|
|
|
@@ -4879,7 +6269,9 @@ await client.entitlements.deleteCompanyOverride("company_override_id");
|
|
|
4879
6269
|
<dd>
|
|
4880
6270
|
|
|
4881
6271
|
```typescript
|
|
4882
|
-
await client.entitlements.
|
|
6272
|
+
await client.entitlements.countFeatureUsers({
|
|
6273
|
+
featureId: "feature_id",
|
|
6274
|
+
});
|
|
4883
6275
|
```
|
|
4884
6276
|
|
|
4885
6277
|
</dd>
|
|
@@ -4895,7 +6287,7 @@ await client.entitlements.countCompanyOverrides();
|
|
|
4895
6287
|
<dl>
|
|
4896
6288
|
<dd>
|
|
4897
6289
|
|
|
4898
|
-
**request:** `Schematic.
|
|
6290
|
+
**request:** `Schematic.CountFeatureUsersRequest`
|
|
4899
6291
|
|
|
4900
6292
|
</dd>
|
|
4901
6293
|
</dl>
|
|
@@ -4914,7 +6306,7 @@ await client.entitlements.countCompanyOverrides();
|
|
|
4914
6306
|
</dl>
|
|
4915
6307
|
</details>
|
|
4916
6308
|
|
|
4917
|
-
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">
|
|
6309
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">listPlanEntitlements</a>({ ...params }) -> Schematic.ListPlanEntitlementsResponse</code></summary>
|
|
4918
6310
|
<dl>
|
|
4919
6311
|
<dd>
|
|
4920
6312
|
|
|
@@ -4927,9 +6319,7 @@ await client.entitlements.countCompanyOverrides();
|
|
|
4927
6319
|
<dd>
|
|
4928
6320
|
|
|
4929
6321
|
```typescript
|
|
4930
|
-
await client.entitlements.
|
|
4931
|
-
featureId: "feature_id",
|
|
4932
|
-
});
|
|
6322
|
+
await client.entitlements.listPlanEntitlements();
|
|
4933
6323
|
```
|
|
4934
6324
|
|
|
4935
6325
|
</dd>
|
|
@@ -4945,7 +6335,7 @@ await client.entitlements.listFeatureCompanies({
|
|
|
4945
6335
|
<dl>
|
|
4946
6336
|
<dd>
|
|
4947
6337
|
|
|
4948
|
-
**request:** `Schematic.
|
|
6338
|
+
**request:** `Schematic.ListPlanEntitlementsRequest`
|
|
4949
6339
|
|
|
4950
6340
|
</dd>
|
|
4951
6341
|
</dl>
|
|
@@ -4964,7 +6354,7 @@ await client.entitlements.listFeatureCompanies({
|
|
|
4964
6354
|
</dl>
|
|
4965
6355
|
</details>
|
|
4966
6356
|
|
|
4967
|
-
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">
|
|
6357
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">createPlanEntitlement</a>({ ...params }) -> Schematic.CreatePlanEntitlementResponse</code></summary>
|
|
4968
6358
|
<dl>
|
|
4969
6359
|
<dd>
|
|
4970
6360
|
|
|
@@ -4977,8 +6367,12 @@ await client.entitlements.listFeatureCompanies({
|
|
|
4977
6367
|
<dd>
|
|
4978
6368
|
|
|
4979
6369
|
```typescript
|
|
4980
|
-
await client.entitlements.
|
|
6370
|
+
await client.entitlements.createPlanEntitlement({
|
|
4981
6371
|
featureId: "feature_id",
|
|
6372
|
+
planId: "plan_id",
|
|
6373
|
+
priceTiers: [{}],
|
|
6374
|
+
tierMode: "tier_mode",
|
|
6375
|
+
valueType: "boolean",
|
|
4982
6376
|
});
|
|
4983
6377
|
```
|
|
4984
6378
|
|
|
@@ -4995,7 +6389,7 @@ await client.entitlements.countFeatureCompanies({
|
|
|
4995
6389
|
<dl>
|
|
4996
6390
|
<dd>
|
|
4997
6391
|
|
|
4998
|
-
**request:** `Schematic.
|
|
6392
|
+
**request:** `Schematic.CreatePlanEntitlementRequestBody`
|
|
4999
6393
|
|
|
5000
6394
|
</dd>
|
|
5001
6395
|
</dl>
|
|
@@ -5014,7 +6408,7 @@ await client.entitlements.countFeatureCompanies({
|
|
|
5014
6408
|
</dl>
|
|
5015
6409
|
</details>
|
|
5016
6410
|
|
|
5017
|
-
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">
|
|
6411
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">getPlanEntitlement</a>(planEntitlementId) -> Schematic.GetPlanEntitlementResponse</code></summary>
|
|
5018
6412
|
<dl>
|
|
5019
6413
|
<dd>
|
|
5020
6414
|
|
|
@@ -5027,7 +6421,7 @@ await client.entitlements.countFeatureCompanies({
|
|
|
5027
6421
|
<dd>
|
|
5028
6422
|
|
|
5029
6423
|
```typescript
|
|
5030
|
-
await client.entitlements.
|
|
6424
|
+
await client.entitlements.getPlanEntitlement("plan_entitlement_id");
|
|
5031
6425
|
```
|
|
5032
6426
|
|
|
5033
6427
|
</dd>
|
|
@@ -5043,7 +6437,7 @@ await client.entitlements.listFeatureUsage();
|
|
|
5043
6437
|
<dl>
|
|
5044
6438
|
<dd>
|
|
5045
6439
|
|
|
5046
|
-
**
|
|
6440
|
+
**planEntitlementId:** `string` — plan_entitlement_id
|
|
5047
6441
|
|
|
5048
6442
|
</dd>
|
|
5049
6443
|
</dl>
|
|
@@ -5062,7 +6456,7 @@ await client.entitlements.listFeatureUsage();
|
|
|
5062
6456
|
</dl>
|
|
5063
6457
|
</details>
|
|
5064
6458
|
|
|
5065
|
-
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">
|
|
6459
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">updatePlanEntitlement</a>(planEntitlementId, { ...params }) -> Schematic.UpdatePlanEntitlementResponse</code></summary>
|
|
5066
6460
|
<dl>
|
|
5067
6461
|
<dd>
|
|
5068
6462
|
|
|
@@ -5075,7 +6469,11 @@ await client.entitlements.listFeatureUsage();
|
|
|
5075
6469
|
<dd>
|
|
5076
6470
|
|
|
5077
6471
|
```typescript
|
|
5078
|
-
await client.entitlements.
|
|
6472
|
+
await client.entitlements.updatePlanEntitlement("plan_entitlement_id", {
|
|
6473
|
+
priceTiers: [{}],
|
|
6474
|
+
tierMode: "tier_mode",
|
|
6475
|
+
valueType: "boolean",
|
|
6476
|
+
});
|
|
5079
6477
|
```
|
|
5080
6478
|
|
|
5081
6479
|
</dd>
|
|
@@ -5091,7 +6489,15 @@ await client.entitlements.countFeatureUsage();
|
|
|
5091
6489
|
<dl>
|
|
5092
6490
|
<dd>
|
|
5093
6491
|
|
|
5094
|
-
**
|
|
6492
|
+
**planEntitlementId:** `string` — plan_entitlement_id
|
|
6493
|
+
|
|
6494
|
+
</dd>
|
|
6495
|
+
</dl>
|
|
6496
|
+
|
|
6497
|
+
<dl>
|
|
6498
|
+
<dd>
|
|
6499
|
+
|
|
6500
|
+
**request:** `Schematic.UpdatePlanEntitlementRequestBody`
|
|
5095
6501
|
|
|
5096
6502
|
</dd>
|
|
5097
6503
|
</dl>
|
|
@@ -5110,7 +6516,7 @@ await client.entitlements.countFeatureUsage();
|
|
|
5110
6516
|
</dl>
|
|
5111
6517
|
</details>
|
|
5112
6518
|
|
|
5113
|
-
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">
|
|
6519
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">deletePlanEntitlement</a>(planEntitlementId) -> Schematic.DeletePlanEntitlementResponse</code></summary>
|
|
5114
6520
|
<dl>
|
|
5115
6521
|
<dd>
|
|
5116
6522
|
|
|
@@ -5123,9 +6529,7 @@ await client.entitlements.countFeatureUsage();
|
|
|
5123
6529
|
<dd>
|
|
5124
6530
|
|
|
5125
6531
|
```typescript
|
|
5126
|
-
await client.entitlements.
|
|
5127
|
-
featureId: "feature_id",
|
|
5128
|
-
});
|
|
6532
|
+
await client.entitlements.deletePlanEntitlement("plan_entitlement_id");
|
|
5129
6533
|
```
|
|
5130
6534
|
|
|
5131
6535
|
</dd>
|
|
@@ -5141,7 +6545,7 @@ await client.entitlements.listFeatureUsers({
|
|
|
5141
6545
|
<dl>
|
|
5142
6546
|
<dd>
|
|
5143
6547
|
|
|
5144
|
-
**
|
|
6548
|
+
**planEntitlementId:** `string` — plan_entitlement_id
|
|
5145
6549
|
|
|
5146
6550
|
</dd>
|
|
5147
6551
|
</dl>
|
|
@@ -5160,7 +6564,7 @@ await client.entitlements.listFeatureUsers({
|
|
|
5160
6564
|
</dl>
|
|
5161
6565
|
</details>
|
|
5162
6566
|
|
|
5163
|
-
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">
|
|
6567
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">countPlanEntitlements</a>({ ...params }) -> Schematic.CountPlanEntitlementsResponse</code></summary>
|
|
5164
6568
|
<dl>
|
|
5165
6569
|
<dd>
|
|
5166
6570
|
|
|
@@ -5173,9 +6577,7 @@ await client.entitlements.listFeatureUsers({
|
|
|
5173
6577
|
<dd>
|
|
5174
6578
|
|
|
5175
6579
|
```typescript
|
|
5176
|
-
await client.entitlements.
|
|
5177
|
-
featureId: "feature_id",
|
|
5178
|
-
});
|
|
6580
|
+
await client.entitlements.countPlanEntitlements();
|
|
5179
6581
|
```
|
|
5180
6582
|
|
|
5181
6583
|
</dd>
|
|
@@ -5191,7 +6593,7 @@ await client.entitlements.countFeatureUsers({
|
|
|
5191
6593
|
<dl>
|
|
5192
6594
|
<dd>
|
|
5193
6595
|
|
|
5194
|
-
**request:** `Schematic.
|
|
6596
|
+
**request:** `Schematic.CountPlanEntitlementsRequest`
|
|
5195
6597
|
|
|
5196
6598
|
</dd>
|
|
5197
6599
|
</dl>
|
|
@@ -5210,7 +6612,7 @@ await client.entitlements.countFeatureUsers({
|
|
|
5210
6612
|
</dl>
|
|
5211
6613
|
</details>
|
|
5212
6614
|
|
|
5213
|
-
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">
|
|
6615
|
+
<details><summary><code>client.entitlements.<a href="/src/api/resources/entitlements/client/Client.ts">getFeatureUsageByCompany</a>({ ...params }) -> Schematic.GetFeatureUsageByCompanyResponse</code></summary>
|
|
5214
6616
|
<dl>
|
|
5215
6617
|
<dd>
|
|
5216
6618
|
|
|
@@ -5223,7 +6625,11 @@ await client.entitlements.countFeatureUsers({
|
|
|
5223
6625
|
<dd>
|
|
5224
6626
|
|
|
5225
6627
|
```typescript
|
|
5226
|
-
await client.entitlements.
|
|
6628
|
+
await client.entitlements.getFeatureUsageByCompany({
|
|
6629
|
+
keys: {
|
|
6630
|
+
keys: "keys",
|
|
6631
|
+
},
|
|
6632
|
+
});
|
|
5227
6633
|
```
|
|
5228
6634
|
|
|
5229
6635
|
</dd>
|
|
@@ -5239,7 +6645,7 @@ await client.entitlements.listPlanEntitlements();
|
|
|
5239
6645
|
<dl>
|
|
5240
6646
|
<dd>
|
|
5241
6647
|
|
|
5242
|
-
**request:** `Schematic.
|
|
6648
|
+
**request:** `Schematic.GetFeatureUsageByCompanyRequest`
|
|
5243
6649
|
|
|
5244
6650
|
</dd>
|
|
5245
6651
|
</dl>
|
|
@@ -5258,7 +6664,9 @@ await client.entitlements.listPlanEntitlements();
|
|
|
5258
6664
|
</dl>
|
|
5259
6665
|
</details>
|
|
5260
6666
|
|
|
5261
|
-
|
|
6667
|
+
## plans
|
|
6668
|
+
|
|
6669
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">updateCompanyPlans</a>(companyPlanId, { ...params }) -> Schematic.UpdateCompanyPlansResponse</code></summary>
|
|
5262
6670
|
<dl>
|
|
5263
6671
|
<dd>
|
|
5264
6672
|
|
|
@@ -5271,10 +6679,8 @@ await client.entitlements.listPlanEntitlements();
|
|
|
5271
6679
|
<dd>
|
|
5272
6680
|
|
|
5273
6681
|
```typescript
|
|
5274
|
-
await client.
|
|
5275
|
-
|
|
5276
|
-
planId: "plan_id",
|
|
5277
|
-
valueType: "boolean",
|
|
6682
|
+
await client.plans.updateCompanyPlans("company_plan_id", {
|
|
6683
|
+
addOnIds: ["add_on_ids"],
|
|
5278
6684
|
});
|
|
5279
6685
|
```
|
|
5280
6686
|
|
|
@@ -5291,7 +6697,7 @@ await client.entitlements.createPlanEntitlement({
|
|
|
5291
6697
|
<dl>
|
|
5292
6698
|
<dd>
|
|
5293
6699
|
|
|
5294
|
-
**
|
|
6700
|
+
**companyPlanId:** `string` — company_plan_id
|
|
5295
6701
|
|
|
5296
6702
|
</dd>
|
|
5297
6703
|
</dl>
|
|
@@ -5299,7 +6705,15 @@ await client.entitlements.createPlanEntitlement({
|
|
|
5299
6705
|
<dl>
|
|
5300
6706
|
<dd>
|
|
5301
6707
|
|
|
5302
|
-
**
|
|
6708
|
+
**request:** `Schematic.UpdateCompanyPlansRequestBody`
|
|
6709
|
+
|
|
6710
|
+
</dd>
|
|
6711
|
+
</dl>
|
|
6712
|
+
|
|
6713
|
+
<dl>
|
|
6714
|
+
<dd>
|
|
6715
|
+
|
|
6716
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5303
6717
|
|
|
5304
6718
|
</dd>
|
|
5305
6719
|
</dl>
|
|
@@ -5310,7 +6724,7 @@ await client.entitlements.createPlanEntitlement({
|
|
|
5310
6724
|
</dl>
|
|
5311
6725
|
</details>
|
|
5312
6726
|
|
|
5313
|
-
<details><summary><code>client.
|
|
6727
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">getAudience</a>(planAudienceId) -> Schematic.GetAudienceResponse</code></summary>
|
|
5314
6728
|
<dl>
|
|
5315
6729
|
<dd>
|
|
5316
6730
|
|
|
@@ -5323,7 +6737,7 @@ await client.entitlements.createPlanEntitlement({
|
|
|
5323
6737
|
<dd>
|
|
5324
6738
|
|
|
5325
6739
|
```typescript
|
|
5326
|
-
await client.
|
|
6740
|
+
await client.plans.getAudience("plan_audience_id");
|
|
5327
6741
|
```
|
|
5328
6742
|
|
|
5329
6743
|
</dd>
|
|
@@ -5339,7 +6753,7 @@ await client.entitlements.getPlanEntitlement("plan_entitlement_id");
|
|
|
5339
6753
|
<dl>
|
|
5340
6754
|
<dd>
|
|
5341
6755
|
|
|
5342
|
-
**
|
|
6756
|
+
**planAudienceId:** `string` — plan_audience_id
|
|
5343
6757
|
|
|
5344
6758
|
</dd>
|
|
5345
6759
|
</dl>
|
|
@@ -5347,7 +6761,7 @@ await client.entitlements.getPlanEntitlement("plan_entitlement_id");
|
|
|
5347
6761
|
<dl>
|
|
5348
6762
|
<dd>
|
|
5349
6763
|
|
|
5350
|
-
**requestOptions:** `
|
|
6764
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5351
6765
|
|
|
5352
6766
|
</dd>
|
|
5353
6767
|
</dl>
|
|
@@ -5358,7 +6772,7 @@ await client.entitlements.getPlanEntitlement("plan_entitlement_id");
|
|
|
5358
6772
|
</dl>
|
|
5359
6773
|
</details>
|
|
5360
6774
|
|
|
5361
|
-
<details><summary><code>client.
|
|
6775
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">updateAudience</a>(planAudienceId, { ...params }) -> Schematic.UpdateAudienceResponse</code></summary>
|
|
5362
6776
|
<dl>
|
|
5363
6777
|
<dd>
|
|
5364
6778
|
|
|
@@ -5371,8 +6785,25 @@ await client.entitlements.getPlanEntitlement("plan_entitlement_id");
|
|
|
5371
6785
|
<dd>
|
|
5372
6786
|
|
|
5373
6787
|
```typescript
|
|
5374
|
-
await client.
|
|
5375
|
-
|
|
6788
|
+
await client.plans.updateAudience("plan_audience_id", {
|
|
6789
|
+
conditionGroups: [
|
|
6790
|
+
{
|
|
6791
|
+
conditions: [
|
|
6792
|
+
{
|
|
6793
|
+
conditionType: "company",
|
|
6794
|
+
operator: "eq",
|
|
6795
|
+
resourceIds: ["resource_ids"],
|
|
6796
|
+
},
|
|
6797
|
+
],
|
|
6798
|
+
},
|
|
6799
|
+
],
|
|
6800
|
+
conditions: [
|
|
6801
|
+
{
|
|
6802
|
+
conditionType: "company",
|
|
6803
|
+
operator: "eq",
|
|
6804
|
+
resourceIds: ["resource_ids"],
|
|
6805
|
+
},
|
|
6806
|
+
],
|
|
5376
6807
|
});
|
|
5377
6808
|
```
|
|
5378
6809
|
|
|
@@ -5389,7 +6820,7 @@ await client.entitlements.updatePlanEntitlement("plan_entitlement_id", {
|
|
|
5389
6820
|
<dl>
|
|
5390
6821
|
<dd>
|
|
5391
6822
|
|
|
5392
|
-
**
|
|
6823
|
+
**planAudienceId:** `string` — plan_audience_id
|
|
5393
6824
|
|
|
5394
6825
|
</dd>
|
|
5395
6826
|
</dl>
|
|
@@ -5397,7 +6828,7 @@ await client.entitlements.updatePlanEntitlement("plan_entitlement_id", {
|
|
|
5397
6828
|
<dl>
|
|
5398
6829
|
<dd>
|
|
5399
6830
|
|
|
5400
|
-
**request:** `Schematic.
|
|
6831
|
+
**request:** `Schematic.UpdateAudienceRequestBody`
|
|
5401
6832
|
|
|
5402
6833
|
</dd>
|
|
5403
6834
|
</dl>
|
|
@@ -5405,7 +6836,7 @@ await client.entitlements.updatePlanEntitlement("plan_entitlement_id", {
|
|
|
5405
6836
|
<dl>
|
|
5406
6837
|
<dd>
|
|
5407
6838
|
|
|
5408
|
-
**requestOptions:** `
|
|
6839
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5409
6840
|
|
|
5410
6841
|
</dd>
|
|
5411
6842
|
</dl>
|
|
@@ -5416,7 +6847,7 @@ await client.entitlements.updatePlanEntitlement("plan_entitlement_id", {
|
|
|
5416
6847
|
</dl>
|
|
5417
6848
|
</details>
|
|
5418
6849
|
|
|
5419
|
-
<details><summary><code>client.
|
|
6850
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">deleteAudience</a>(planAudienceId) -> Schematic.DeleteAudienceResponse</code></summary>
|
|
5420
6851
|
<dl>
|
|
5421
6852
|
<dd>
|
|
5422
6853
|
|
|
@@ -5429,7 +6860,7 @@ await client.entitlements.updatePlanEntitlement("plan_entitlement_id", {
|
|
|
5429
6860
|
<dd>
|
|
5430
6861
|
|
|
5431
6862
|
```typescript
|
|
5432
|
-
await client.
|
|
6863
|
+
await client.plans.deleteAudience("plan_audience_id");
|
|
5433
6864
|
```
|
|
5434
6865
|
|
|
5435
6866
|
</dd>
|
|
@@ -5445,7 +6876,7 @@ await client.entitlements.deletePlanEntitlement("plan_entitlement_id");
|
|
|
5445
6876
|
<dl>
|
|
5446
6877
|
<dd>
|
|
5447
6878
|
|
|
5448
|
-
**
|
|
6879
|
+
**planAudienceId:** `string` — plan_audience_id
|
|
5449
6880
|
|
|
5450
6881
|
</dd>
|
|
5451
6882
|
</dl>
|
|
@@ -5453,7 +6884,7 @@ await client.entitlements.deletePlanEntitlement("plan_entitlement_id");
|
|
|
5453
6884
|
<dl>
|
|
5454
6885
|
<dd>
|
|
5455
6886
|
|
|
5456
|
-
**requestOptions:** `
|
|
6887
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5457
6888
|
|
|
5458
6889
|
</dd>
|
|
5459
6890
|
</dl>
|
|
@@ -5464,7 +6895,7 @@ await client.entitlements.deletePlanEntitlement("plan_entitlement_id");
|
|
|
5464
6895
|
</dl>
|
|
5465
6896
|
</details>
|
|
5466
6897
|
|
|
5467
|
-
<details><summary><code>client.
|
|
6898
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">listPlanTraits</a>({ ...params }) -> Schematic.ListPlanTraitsResponse</code></summary>
|
|
5468
6899
|
<dl>
|
|
5469
6900
|
<dd>
|
|
5470
6901
|
|
|
@@ -5477,7 +6908,7 @@ await client.entitlements.deletePlanEntitlement("plan_entitlement_id");
|
|
|
5477
6908
|
<dd>
|
|
5478
6909
|
|
|
5479
6910
|
```typescript
|
|
5480
|
-
await client.
|
|
6911
|
+
await client.plans.listPlanTraits();
|
|
5481
6912
|
```
|
|
5482
6913
|
|
|
5483
6914
|
</dd>
|
|
@@ -5493,7 +6924,7 @@ await client.entitlements.countPlanEntitlements();
|
|
|
5493
6924
|
<dl>
|
|
5494
6925
|
<dd>
|
|
5495
6926
|
|
|
5496
|
-
**request:** `Schematic.
|
|
6927
|
+
**request:** `Schematic.ListPlanTraitsRequest`
|
|
5497
6928
|
|
|
5498
6929
|
</dd>
|
|
5499
6930
|
</dl>
|
|
@@ -5501,7 +6932,7 @@ await client.entitlements.countPlanEntitlements();
|
|
|
5501
6932
|
<dl>
|
|
5502
6933
|
<dd>
|
|
5503
6934
|
|
|
5504
|
-
**requestOptions:** `
|
|
6935
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5505
6936
|
|
|
5506
6937
|
</dd>
|
|
5507
6938
|
</dl>
|
|
@@ -5512,7 +6943,7 @@ await client.entitlements.countPlanEntitlements();
|
|
|
5512
6943
|
</dl>
|
|
5513
6944
|
</details>
|
|
5514
6945
|
|
|
5515
|
-
<details><summary><code>client.
|
|
6946
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">createPlanTrait</a>({ ...params }) -> Schematic.CreatePlanTraitResponse</code></summary>
|
|
5516
6947
|
<dl>
|
|
5517
6948
|
<dd>
|
|
5518
6949
|
|
|
@@ -5525,12 +6956,10 @@ await client.entitlements.countPlanEntitlements();
|
|
|
5525
6956
|
<dd>
|
|
5526
6957
|
|
|
5527
6958
|
```typescript
|
|
5528
|
-
await client.
|
|
5529
|
-
|
|
5530
|
-
|
|
5531
|
-
|
|
5532
|
-
},
|
|
5533
|
-
},
|
|
6959
|
+
await client.plans.createPlanTrait({
|
|
6960
|
+
planId: "plan_id",
|
|
6961
|
+
traitId: "trait_id",
|
|
6962
|
+
traitValue: "trait_value",
|
|
5534
6963
|
});
|
|
5535
6964
|
```
|
|
5536
6965
|
|
|
@@ -5547,7 +6976,7 @@ await client.entitlements.getFeatureUsageByCompany({
|
|
|
5547
6976
|
<dl>
|
|
5548
6977
|
<dd>
|
|
5549
6978
|
|
|
5550
|
-
**request:** `Schematic.
|
|
6979
|
+
**request:** `Schematic.CreatePlanTraitRequestBody`
|
|
5551
6980
|
|
|
5552
6981
|
</dd>
|
|
5553
6982
|
</dl>
|
|
@@ -5555,7 +6984,7 @@ await client.entitlements.getFeatureUsageByCompany({
|
|
|
5555
6984
|
<dl>
|
|
5556
6985
|
<dd>
|
|
5557
6986
|
|
|
5558
|
-
**requestOptions:** `
|
|
6987
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5559
6988
|
|
|
5560
6989
|
</dd>
|
|
5561
6990
|
</dl>
|
|
@@ -5566,9 +6995,7 @@ await client.entitlements.getFeatureUsageByCompany({
|
|
|
5566
6995
|
</dl>
|
|
5567
6996
|
</details>
|
|
5568
6997
|
|
|
5569
|
-
|
|
5570
|
-
|
|
5571
|
-
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">updateCompanyPlans</a>(companyPlanId, { ...params }) -> Schematic.UpdateCompanyPlansResponse</code></summary>
|
|
6998
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">getPlanTrait</a>(planTraitId) -> Schematic.GetPlanTraitResponse</code></summary>
|
|
5572
6999
|
<dl>
|
|
5573
7000
|
<dd>
|
|
5574
7001
|
|
|
@@ -5581,9 +7008,7 @@ await client.entitlements.getFeatureUsageByCompany({
|
|
|
5581
7008
|
<dd>
|
|
5582
7009
|
|
|
5583
7010
|
```typescript
|
|
5584
|
-
await client.plans.
|
|
5585
|
-
addOnIds: ["add_on_ids"],
|
|
5586
|
-
});
|
|
7011
|
+
await client.plans.getPlanTrait("plan_trait_id");
|
|
5587
7012
|
```
|
|
5588
7013
|
|
|
5589
7014
|
</dd>
|
|
@@ -5599,15 +7024,7 @@ await client.plans.updateCompanyPlans("company_plan_id", {
|
|
|
5599
7024
|
<dl>
|
|
5600
7025
|
<dd>
|
|
5601
7026
|
|
|
5602
|
-
**
|
|
5603
|
-
|
|
5604
|
-
</dd>
|
|
5605
|
-
</dl>
|
|
5606
|
-
|
|
5607
|
-
<dl>
|
|
5608
|
-
<dd>
|
|
5609
|
-
|
|
5610
|
-
**request:** `Schematic.UpdateCompanyPlansRequestBody`
|
|
7027
|
+
**planTraitId:** `string` — plan_trait_id
|
|
5611
7028
|
|
|
5612
7029
|
</dd>
|
|
5613
7030
|
</dl>
|
|
@@ -5626,7 +7043,7 @@ await client.plans.updateCompanyPlans("company_plan_id", {
|
|
|
5626
7043
|
</dl>
|
|
5627
7044
|
</details>
|
|
5628
7045
|
|
|
5629
|
-
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">
|
|
7046
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">updatePlanTrait</a>(planTraitId, { ...params }) -> Schematic.UpdatePlanTraitResponse</code></summary>
|
|
5630
7047
|
<dl>
|
|
5631
7048
|
<dd>
|
|
5632
7049
|
|
|
@@ -5639,7 +7056,10 @@ await client.plans.updateCompanyPlans("company_plan_id", {
|
|
|
5639
7056
|
<dd>
|
|
5640
7057
|
|
|
5641
7058
|
```typescript
|
|
5642
|
-
await client.plans.
|
|
7059
|
+
await client.plans.updatePlanTrait("plan_trait_id", {
|
|
7060
|
+
planId: "plan_id",
|
|
7061
|
+
traitValue: "trait_value",
|
|
7062
|
+
});
|
|
5643
7063
|
```
|
|
5644
7064
|
|
|
5645
7065
|
</dd>
|
|
@@ -5655,7 +7075,15 @@ await client.plans.getAudience("plan_audience_id");
|
|
|
5655
7075
|
<dl>
|
|
5656
7076
|
<dd>
|
|
5657
7077
|
|
|
5658
|
-
**
|
|
7078
|
+
**planTraitId:** `string` — plan_trait_id
|
|
7079
|
+
|
|
7080
|
+
</dd>
|
|
7081
|
+
</dl>
|
|
7082
|
+
|
|
7083
|
+
<dl>
|
|
7084
|
+
<dd>
|
|
7085
|
+
|
|
7086
|
+
**request:** `Schematic.UpdatePlanTraitRequestBody`
|
|
5659
7087
|
|
|
5660
7088
|
</dd>
|
|
5661
7089
|
</dl>
|
|
@@ -5674,7 +7102,7 @@ await client.plans.getAudience("plan_audience_id");
|
|
|
5674
7102
|
</dl>
|
|
5675
7103
|
</details>
|
|
5676
7104
|
|
|
5677
|
-
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">
|
|
7105
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">deletePlanTrait</a>(planTraitId) -> Schematic.DeletePlanTraitResponse</code></summary>
|
|
5678
7106
|
<dl>
|
|
5679
7107
|
<dd>
|
|
5680
7108
|
|
|
@@ -5687,26 +7115,7 @@ await client.plans.getAudience("plan_audience_id");
|
|
|
5687
7115
|
<dd>
|
|
5688
7116
|
|
|
5689
7117
|
```typescript
|
|
5690
|
-
await client.plans.
|
|
5691
|
-
conditionGroups: [
|
|
5692
|
-
{
|
|
5693
|
-
conditions: [
|
|
5694
|
-
{
|
|
5695
|
-
conditionType: "company",
|
|
5696
|
-
operator: "eq",
|
|
5697
|
-
resourceIds: ["resource_ids"],
|
|
5698
|
-
},
|
|
5699
|
-
],
|
|
5700
|
-
},
|
|
5701
|
-
],
|
|
5702
|
-
conditions: [
|
|
5703
|
-
{
|
|
5704
|
-
conditionType: "company",
|
|
5705
|
-
operator: "eq",
|
|
5706
|
-
resourceIds: ["resource_ids"],
|
|
5707
|
-
},
|
|
5708
|
-
],
|
|
5709
|
-
});
|
|
7118
|
+
await client.plans.deletePlanTrait("plan_trait_id");
|
|
5710
7119
|
```
|
|
5711
7120
|
|
|
5712
7121
|
</dd>
|
|
@@ -5722,15 +7131,7 @@ await client.plans.updateAudience("plan_audience_id", {
|
|
|
5722
7131
|
<dl>
|
|
5723
7132
|
<dd>
|
|
5724
7133
|
|
|
5725
|
-
**
|
|
5726
|
-
|
|
5727
|
-
</dd>
|
|
5728
|
-
</dl>
|
|
5729
|
-
|
|
5730
|
-
<dl>
|
|
5731
|
-
<dd>
|
|
5732
|
-
|
|
5733
|
-
**request:** `Schematic.UpdateAudienceRequestBody`
|
|
7134
|
+
**planTraitId:** `string` — plan_trait_id
|
|
5734
7135
|
|
|
5735
7136
|
</dd>
|
|
5736
7137
|
</dl>
|
|
@@ -5749,7 +7150,7 @@ await client.plans.updateAudience("plan_audience_id", {
|
|
|
5749
7150
|
</dl>
|
|
5750
7151
|
</details>
|
|
5751
7152
|
|
|
5752
|
-
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">
|
|
7153
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">countPlanTraits</a>({ ...params }) -> Schematic.CountPlanTraitsResponse</code></summary>
|
|
5753
7154
|
<dl>
|
|
5754
7155
|
<dd>
|
|
5755
7156
|
|
|
@@ -5762,7 +7163,7 @@ await client.plans.updateAudience("plan_audience_id", {
|
|
|
5762
7163
|
<dd>
|
|
5763
7164
|
|
|
5764
7165
|
```typescript
|
|
5765
|
-
await client.plans.
|
|
7166
|
+
await client.plans.countPlanTraits();
|
|
5766
7167
|
```
|
|
5767
7168
|
|
|
5768
7169
|
</dd>
|
|
@@ -5778,7 +7179,7 @@ await client.plans.deleteAudience("plan_audience_id");
|
|
|
5778
7179
|
<dl>
|
|
5779
7180
|
<dd>
|
|
5780
7181
|
|
|
5781
|
-
**
|
|
7182
|
+
**request:** `Schematic.CountPlanTraitsRequest`
|
|
5782
7183
|
|
|
5783
7184
|
</dd>
|
|
5784
7185
|
</dl>
|
|
@@ -6065,7 +7466,7 @@ await client.plans.deletePlan("plan_id");
|
|
|
6065
7466
|
|
|
6066
7467
|
```typescript
|
|
6067
7468
|
await client.plans.upsertBillingProductPlan("plan_id", {
|
|
6068
|
-
|
|
7469
|
+
chargeType: "one_time",
|
|
6069
7470
|
isTrialable: true,
|
|
6070
7471
|
});
|
|
6071
7472
|
```
|
|
@@ -6771,6 +8172,58 @@ await client.crm.upsertCrmProduct({
|
|
|
6771
8172
|
</dl>
|
|
6772
8173
|
</details>
|
|
6773
8174
|
|
|
8175
|
+
## dataexports
|
|
8176
|
+
|
|
8177
|
+
<details><summary><code>client.dataexports.<a href="/src/api/resources/dataexports/client/Client.ts">createDataExport</a>({ ...params }) -> Schematic.CreateDataExportResponse</code></summary>
|
|
8178
|
+
<dl>
|
|
8179
|
+
<dd>
|
|
8180
|
+
|
|
8181
|
+
#### 🔌 Usage
|
|
8182
|
+
|
|
8183
|
+
<dl>
|
|
8184
|
+
<dd>
|
|
8185
|
+
|
|
8186
|
+
<dl>
|
|
8187
|
+
<dd>
|
|
8188
|
+
|
|
8189
|
+
```typescript
|
|
8190
|
+
await client.dataexports.createDataExport({
|
|
8191
|
+
metadata: "metadata",
|
|
8192
|
+
});
|
|
8193
|
+
```
|
|
8194
|
+
|
|
8195
|
+
</dd>
|
|
8196
|
+
</dl>
|
|
8197
|
+
</dd>
|
|
8198
|
+
</dl>
|
|
8199
|
+
|
|
8200
|
+
#### ⚙️ Parameters
|
|
8201
|
+
|
|
8202
|
+
<dl>
|
|
8203
|
+
<dd>
|
|
8204
|
+
|
|
8205
|
+
<dl>
|
|
8206
|
+
<dd>
|
|
8207
|
+
|
|
8208
|
+
**request:** `Schematic.CreateDataExportRequestBody`
|
|
8209
|
+
|
|
8210
|
+
</dd>
|
|
8211
|
+
</dl>
|
|
8212
|
+
|
|
8213
|
+
<dl>
|
|
8214
|
+
<dd>
|
|
8215
|
+
|
|
8216
|
+
**requestOptions:** `Dataexports.RequestOptions`
|
|
8217
|
+
|
|
8218
|
+
</dd>
|
|
8219
|
+
</dl>
|
|
8220
|
+
</dd>
|
|
8221
|
+
</dl>
|
|
8222
|
+
|
|
8223
|
+
</dd>
|
|
8224
|
+
</dl>
|
|
8225
|
+
</details>
|
|
8226
|
+
|
|
6774
8227
|
## events
|
|
6775
8228
|
|
|
6776
8229
|
<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">createEventBatch</a>({ ...params }) -> Schematic.CreateEventBatchResponse</code></summary>
|
|
@@ -7240,7 +8693,6 @@ await client.accesstokens.issueTemporaryAccessToken({
|
|
|
7240
8693
|
lookup: {
|
|
7241
8694
|
key: "value",
|
|
7242
8695
|
},
|
|
7243
|
-
resourceType: "resource_type",
|
|
7244
8696
|
});
|
|
7245
8697
|
```
|
|
7246
8698
|
|