@schematichq/schematic-typescript-node 1.2.2 → 1.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Client.d.ts +2 -2
- package/dist/api/resources/accesstokens/client/Client.d.ts +3 -3
- package/dist/api/resources/accesstokens/client/requests/IssueTemporaryAccessTokenRequestBody.d.ts +1 -3
- package/dist/api/resources/accounts/client/Client.d.ts +29 -8
- package/dist/api/resources/accounts/client/requests/CountApiKeysRequest.d.ts +4 -1
- package/dist/api/resources/accounts/client/requests/CountApiRequestsRequest.d.ts +7 -1
- package/dist/api/resources/accounts/client/requests/ListApiKeysRequest.d.ts +4 -1
- package/dist/api/resources/accounts/client/requests/ListApiRequestsRequest.d.ts +7 -1
- package/dist/api/resources/accounts/client/requests/ListEnvironmentsRequest.d.ts +4 -1
- package/dist/api/resources/accounts/types/ListApiKeysResponse.d.ts +0 -1
- package/dist/api/resources/accounts/types/ListApiRequestsResponse.d.ts +0 -1
- package/dist/api/resources/accounts/types/ListEnvironmentsResponse.d.ts +0 -1
- package/dist/api/resources/billing/client/Client.d.ts +87 -15
- package/dist/api/resources/billing/client/requests/CountBillingProductsRequest.d.ts +12 -1
- package/dist/api/resources/billing/client/requests/CountCustomersRequest.d.ts +7 -1
- package/dist/api/resources/billing/client/requests/{CreateBillingSubscriptionsRequestBody.d.ts → CreateBillingSubscriptionRequestBody.d.ts} +3 -2
- package/dist/api/resources/billing/client/requests/ListBillingProductsRequest.d.ts +12 -1
- package/dist/api/resources/billing/client/requests/ListCouponsRequest.d.ts +6 -1
- package/dist/api/resources/billing/client/requests/ListCustomersWithSubscriptionsRequest.d.ts +7 -1
- package/dist/api/resources/billing/client/requests/ListInvoicesRequest.d.ts +4 -1
- package/dist/api/resources/billing/client/requests/ListMetersRequest.d.ts +5 -1
- package/dist/api/resources/billing/client/requests/ListPaymentMethodsRequest.d.ts +4 -1
- package/dist/api/resources/billing/client/requests/ListProductPricesRequest.d.ts +12 -1
- package/dist/api/resources/billing/client/requests/SearchBillingPricesRequest.d.ts +28 -3
- package/dist/api/resources/billing/client/requests/index.d.ts +1 -1
- package/dist/api/resources/billing/types/CreateBillingSubscriptionRequestBodyTrialEndSetting.d.ts +8 -0
- package/dist/api/resources/billing/types/ListBillingProductsResponse.d.ts +0 -1
- package/dist/api/resources/billing/types/ListCouponsResponse.d.ts +0 -1
- package/dist/api/resources/billing/types/ListCustomersWithSubscriptionsResponse.d.ts +0 -1
- package/dist/api/resources/billing/types/ListInvoicesResponse.d.ts +0 -1
- package/dist/api/resources/billing/types/ListMetersResponse.d.ts +0 -1
- package/dist/api/resources/billing/types/ListPaymentMethodsResponse.d.ts +0 -1
- package/dist/api/resources/billing/types/ListProductPricesResponse.d.ts +0 -1
- package/dist/api/resources/billing/types/SearchBillingPricesParams.d.ts +7 -0
- package/dist/api/resources/billing/types/SearchBillingPricesResponse.d.ts +0 -1
- package/dist/api/resources/billing/types/index.d.ts +2 -2
- package/dist/api/resources/checkout/client/Client.d.ts +59 -3
- package/dist/api/resources/checkout/types/CheckoutInternalResponse.d.ts +1 -1
- package/dist/api/resources/checkout/types/ManagePlanResponse.d.ts +9 -0
- package/dist/api/resources/checkout/types/PreviewManagePlanResponse.d.ts +9 -0
- package/dist/api/resources/checkout/types/index.d.ts +2 -0
- package/dist/api/resources/companies/client/Client.d.ts +132 -19
- package/dist/api/resources/companies/client/requests/CountCompaniesForAdvancedFilterRequest.d.ts +15 -2
- package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +9 -1
- package/dist/api/resources/companies/client/requests/CountEntityKeyDefinitionsRequest.d.ts +6 -1
- package/dist/api/resources/companies/client/requests/CountEntityTraitDefinitionsRequest.d.ts +7 -1
- package/dist/api/resources/companies/client/requests/CountPlanTraitsRequest.d.ts +6 -1
- package/dist/api/resources/companies/client/requests/CountUsersRequest.d.ts +7 -1
- package/dist/api/resources/companies/client/requests/GetActiveCompanySubscriptionRequest.d.ts +5 -1
- package/dist/api/resources/companies/client/requests/GetActiveDealsRequest.d.ts +3 -1
- package/dist/api/resources/companies/client/requests/GetEntityTraitValuesRequest.d.ts +4 -1
- package/dist/api/resources/companies/client/requests/ListCompaniesForAdvancedFilterRequest.d.ts +15 -2
- package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +9 -1
- package/dist/api/resources/companies/client/requests/ListCompanyMembershipsRequest.d.ts +6 -1
- package/dist/api/resources/companies/client/requests/ListEntityKeyDefinitionsRequest.d.ts +6 -1
- package/dist/api/resources/companies/client/requests/ListEntityTraitDefinitionsRequest.d.ts +7 -1
- package/dist/api/resources/companies/client/requests/ListPlanTraitsRequest.d.ts +6 -1
- package/dist/api/resources/companies/client/requests/ListUsersRequest.d.ts +7 -1
- package/dist/api/resources/companies/client/requests/UpdatePlanTraitBulkRequestBody.d.ts +18 -0
- package/dist/api/resources/companies/client/requests/index.d.ts +1 -0
- package/dist/api/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +3 -1
- package/dist/api/resources/companies/types/GetActiveCompanySubscriptionResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/GetActiveDealsResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/GetEntityTraitValuesResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +3 -1
- package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/ListCompaniesResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/ListCompanyMembershipsResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/ListEntityKeyDefinitionsResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/ListEntityTraitDefinitionsResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/ListPlanTraitsResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/ListUsersResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/UpdatePlanTraitsBulkResponse.d.ts +9 -0
- package/dist/api/resources/companies/types/index.d.ts +1 -0
- package/dist/api/resources/components/client/Client.d.ts +17 -6
- package/dist/api/resources/components/client/requests/CountComponentsRequest.d.ts +5 -1
- package/dist/api/resources/components/client/requests/ListComponentsRequest.d.ts +5 -1
- package/dist/api/resources/components/client/requests/PreviewComponentDataRequest.d.ts +4 -1
- package/dist/api/resources/components/types/ListComponentsResponse.d.ts +0 -1
- package/dist/api/resources/credits/client/Client.d.ts +104 -12
- package/dist/api/resources/credits/client/requests/CountBillingCreditsGrantsRequest.d.ts +5 -1
- package/dist/api/resources/credits/client/requests/CountBillingCreditsRequest.d.ts +5 -1
- package/dist/api/resources/credits/client/requests/CountBillingPlanCreditGrantsRequest.d.ts +6 -1
- package/dist/api/resources/credits/client/requests/CountCreditBundlesRequest.d.ts +7 -1
- package/dist/api/resources/credits/client/requests/CountCreditLedgerRequest.d.ts +33 -0
- package/dist/api/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.d.ts +4 -0
- package/dist/api/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +5 -0
- package/dist/api/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +1 -1
- package/dist/api/resources/credits/client/requests/GetEnrichedCreditLedgerRequest.d.ts +33 -0
- package/dist/api/resources/credits/client/requests/ListBillingCreditsRequest.d.ts +5 -1
- package/dist/api/resources/credits/client/requests/ListBillingPlanCreditGrantsRequest.d.ts +6 -1
- package/dist/api/resources/credits/client/requests/ListCompanyGrantsRequest.d.ts +7 -1
- package/dist/api/resources/credits/client/requests/ListCreditBundlesRequest.d.ts +7 -1
- package/dist/api/resources/credits/client/requests/ListGrantsForCreditRequest.d.ts +5 -1
- package/dist/api/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +1 -0
- package/dist/api/resources/credits/client/requests/index.d.ts +2 -0
- package/dist/api/resources/credits/types/CountCreditLedgerParams.d.ts +19 -0
- package/dist/api/resources/credits/types/CountCreditLedgerRequestPeriod.d.ts +10 -0
- package/dist/api/resources/credits/types/CountCreditLedgerResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/CountCreditLedgerResponseParamsPeriod.d.ts +10 -0
- package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryType.d.ts +11 -0
- package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryUnit.d.ts +8 -0
- package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetType.d.ts +8 -0
- package/dist/api/resources/credits/types/CreateCompanyCreditGrantExpiryType.d.ts +11 -0
- package/dist/api/resources/credits/types/CreateCompanyCreditGrantExpiryUnit.d.ts +8 -0
- package/dist/api/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.d.ts +5 -2
- package/dist/api/resources/credits/types/CreateCreditBundleRequestBodyExpiryUnit.d.ts +8 -0
- package/dist/api/resources/credits/types/GetEnrichedCreditLedgerParams.d.ts +19 -0
- package/dist/api/resources/credits/types/GetEnrichedCreditLedgerRequestPeriod.d.ts +10 -0
- package/dist/api/resources/credits/types/GetEnrichedCreditLedgerResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/GetEnrichedCreditLedgerResponseParamsPeriod.d.ts +10 -0
- package/dist/api/resources/credits/types/ListBillingCreditsResponse.d.ts +0 -1
- package/dist/api/resources/credits/types/ListBillingPlanCreditGrantsResponse.d.ts +0 -1
- package/dist/api/resources/credits/types/ListCompanyGrantsResponse.d.ts +0 -1
- package/dist/api/resources/credits/types/ListCreditBundlesResponse.d.ts +0 -1
- package/dist/api/resources/credits/types/ListGrantsForCreditResponse.d.ts +0 -1
- package/dist/api/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryType.d.ts +5 -2
- package/dist/api/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryUnit.d.ts +8 -0
- package/dist/api/resources/credits/types/ZeroOutGrantRequestBodyReason.d.ts +2 -1
- package/dist/api/resources/credits/types/index.d.ts +15 -0
- package/dist/api/resources/crm/client/Client.d.ts +8 -4
- package/dist/api/resources/crm/client/requests/ListCrmProductsRequest.d.ts +5 -1
- package/dist/api/resources/crm/types/ListCrmProductsResponse.d.ts +0 -1
- package/dist/api/resources/dataexports/client/Client.d.ts +3 -3
- package/dist/api/resources/entitlements/client/Client.d.ts +65 -13
- package/dist/api/resources/entitlements/client/requests/CountCompanyOverridesRequest.d.ts +8 -1
- package/dist/api/resources/entitlements/client/requests/CountFeatureCompaniesRequest.d.ts +4 -1
- package/dist/api/resources/entitlements/client/requests/CountFeatureUsageRequest.d.ts +7 -1
- package/dist/api/resources/entitlements/client/requests/CountFeatureUsersRequest.d.ts +4 -1
- package/dist/api/resources/entitlements/client/requests/CountPlanEntitlementsRequest.d.ts +8 -1
- package/dist/api/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +1 -0
- package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +1 -0
- package/dist/api/resources/entitlements/client/requests/ListCompanyOverridesRequest.d.ts +8 -1
- package/dist/api/resources/entitlements/client/requests/ListFeatureCompaniesRequest.d.ts +4 -1
- package/dist/api/resources/entitlements/client/requests/ListFeatureUsageRequest.d.ts +7 -1
- package/dist/api/resources/entitlements/client/requests/ListFeatureUsersRequest.d.ts +4 -1
- package/dist/api/resources/entitlements/client/requests/ListPlanEntitlementsRequest.d.ts +8 -1
- package/dist/api/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +1 -0
- package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +1 -0
- package/dist/api/resources/entitlements/types/ListCompanyOverridesResponse.d.ts +0 -1
- package/dist/api/resources/entitlements/types/ListFeatureCompaniesResponse.d.ts +0 -1
- package/dist/api/resources/entitlements/types/ListFeatureUsageResponse.d.ts +0 -1
- package/dist/api/resources/entitlements/types/ListFeatureUsersResponse.d.ts +0 -1
- package/dist/api/resources/entitlements/types/ListPlanEntitlementsResponse.d.ts +0 -1
- package/dist/api/resources/events/client/Client.d.ts +16 -5
- package/dist/api/resources/events/client/requests/GetEventSummariesRequest.d.ts +5 -1
- package/dist/api/resources/events/client/requests/ListEventsRequest.d.ts +8 -1
- package/dist/api/resources/events/types/GetEventSummariesResponse.d.ts +0 -1
- package/dist/api/resources/events/types/ListEventsResponse.d.ts +0 -1
- package/dist/api/resources/features/client/Client.d.ts +31 -7
- package/dist/api/resources/features/client/requests/CountFeaturesRequest.d.ts +11 -1
- package/dist/api/resources/features/client/requests/CountFlagsRequest.d.ts +9 -1
- package/dist/api/resources/features/client/requests/ListFeaturesRequest.d.ts +11 -1
- package/dist/api/resources/features/client/requests/ListFlagsRequest.d.ts +9 -1
- package/dist/api/resources/features/types/CountFeaturesParams.d.ts +1 -0
- package/dist/api/resources/features/types/CountFlagsParams.d.ts +1 -0
- package/dist/api/resources/features/types/ListAudienceCompaniesResponse.d.ts +0 -1
- package/dist/api/resources/features/types/ListAudienceUsersResponse.d.ts +0 -1
- package/dist/api/resources/features/types/ListFeaturesParams.d.ts +1 -0
- package/dist/api/resources/features/types/ListFeaturesResponse.d.ts +0 -1
- package/dist/api/resources/features/types/ListFlagsParams.d.ts +1 -0
- package/dist/api/resources/features/types/ListFlagsResponse.d.ts +0 -1
- package/dist/api/resources/plangroups/client/Client.d.ts +21 -5
- package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +22 -1
- package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +22 -1
- package/dist/api/resources/plans/client/Client.d.ts +50 -5
- package/dist/api/resources/plans/client/requests/CountPlansRequest.d.ts +31 -1
- package/dist/api/resources/plans/client/requests/ListPlanIssuesRequest.d.ts +12 -0
- package/dist/api/resources/plans/client/requests/ListPlansRequest.d.ts +31 -1
- package/dist/api/resources/plans/client/requests/index.d.ts +1 -0
- package/dist/api/resources/plans/types/CountPlansParams.d.ts +8 -0
- package/dist/api/resources/plans/types/ListPlanIssuesParams.d.ts +9 -0
- package/dist/api/resources/plans/types/ListPlanIssuesResponse.d.ts +9 -0
- package/dist/api/resources/plans/types/ListPlansParams.d.ts +8 -0
- package/dist/api/resources/plans/types/ListPlansResponse.d.ts +0 -1
- package/dist/api/resources/plans/types/index.d.ts +2 -0
- package/dist/api/resources/webhooks/client/Client.d.ts +25 -7
- package/dist/api/resources/webhooks/client/requests/CountWebhookEventsRequest.d.ts +6 -1
- package/dist/api/resources/webhooks/client/requests/CountWebhooksRequest.d.ts +5 -1
- package/dist/api/resources/webhooks/client/requests/ListWebhookEventsRequest.d.ts +6 -1
- package/dist/api/resources/webhooks/client/requests/ListWebhooksRequest.d.ts +5 -1
- package/dist/api/resources/webhooks/types/ListWebhookEventsResponse.d.ts +0 -1
- package/dist/api/resources/webhooks/types/ListWebhooksResponse.d.ts +0 -1
- package/dist/api/types/ApiKeyCreateResponseData.d.ts +0 -3
- package/dist/api/types/ApiKeyRequestResponseData.d.ts +0 -3
- package/dist/api/types/ApiKeyResponseData.d.ts +0 -3
- package/dist/api/types/BillingCreditBundleResponseData.d.ts +1 -0
- package/dist/api/types/BillingCreditBundleView.d.ts +1 -0
- package/dist/api/types/BillingCreditLedgerResponseData.d.ts +11 -0
- package/dist/api/types/BillingCustomerResponseData.d.ts +0 -3
- package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +7 -0
- package/dist/api/types/BillingProductDetailResponseData.d.ts +2 -1
- package/dist/api/types/BillingProductForSubscriptionResponseData.d.ts +2 -0
- package/dist/api/types/BillingProductPlanResponseData.d.ts +0 -3
- package/dist/api/types/BillingProductPricing.d.ts +2 -0
- package/dist/api/types/BillingProductResponseData.d.ts +2 -1
- package/dist/api/types/BillingSubscriptionView.d.ts +0 -3
- package/dist/api/types/CheckFlagResponseData.d.ts +0 -3
- package/dist/api/types/CheckFlagsResponseData.d.ts +0 -3
- package/dist/api/types/CheckoutDataResponseData.d.ts +0 -3
- package/dist/api/types/CheckoutSettingsResponseData.d.ts +8 -0
- package/dist/api/types/CheckoutSubscription.d.ts +25 -0
- package/dist/api/types/CompanyDetailResponseData.d.ts +1 -0
- package/dist/api/types/CompanyLedgerResponseData.d.ts +8 -0
- package/dist/api/types/CompanyOverrideNoteResponseData.d.ts +11 -0
- package/dist/api/types/CompanyOverrideResponseData.d.ts +1 -0
- package/dist/api/types/CompanyPlanDetailResponseData.d.ts +1 -0
- package/dist/api/types/CompanyViewWithFeatureUsageResponseData.d.ts +1 -0
- package/dist/api/types/ComponentCheckoutSettings.d.ts +9 -0
- package/dist/api/types/ComponentHydrateResponseData.d.ts +4 -0
- package/dist/api/types/ComponentPreviewResponseData.d.ts +4 -3
- package/dist/api/types/ComponentResponseData.d.ts +0 -3
- package/dist/api/types/Condition.d.ts +21 -0
- package/dist/api/types/ConditionGroup.d.ts +7 -0
- package/dist/api/types/CountResponse.d.ts +2 -4
- package/dist/api/types/CreditCompanyGrantView.d.ts +3 -0
- package/dist/api/types/CreditGrantDetail.d.ts +10 -0
- package/dist/api/types/CreditGrantDetailGrantReason.d.ts +9 -0
- package/dist/api/types/CreditLedgerEnrichedEntryResponseData.d.ts +27 -0
- package/dist/api/types/CreditUsage.d.ts +14 -0
- package/dist/api/types/CreditUsageResponseData.d.ts +14 -0
- package/dist/api/types/CrmDealResponseData.d.ts +0 -3
- package/dist/api/types/CrmLineItemResponseData.d.ts +0 -3
- package/dist/api/types/CrmProductResponseData.d.ts +0 -3
- package/dist/api/types/DataExportResponseData.d.ts +0 -3
- package/dist/api/types/EnvironmentDetailResponseData.d.ts +0 -3
- package/dist/api/types/EnvironmentResponseData.d.ts +0 -3
- package/dist/api/types/FeatureCompanyResponseData.d.ts +34 -1
- package/dist/api/types/FeatureCompanyResponseDataCreditGrantReason.d.ts +12 -0
- package/dist/api/types/FeatureCompanyUserResponseDataAllocationType.d.ts +2 -1
- package/dist/api/types/FeatureLedgerResponseData.d.ts +9 -0
- package/dist/api/types/FeatureUsageDataResponseData.d.ts +8 -0
- package/dist/api/types/FeatureUsageResponseData.d.ts +25 -0
- package/dist/api/types/FeatureUsageResponseDataCreditGrantReason.d.ts +12 -0
- package/dist/api/types/IssueTemporaryAccessTokenResponseData.d.ts +0 -3
- package/dist/api/types/ManagePlanPreviewResponseResponseData.d.ts +7 -0
- package/dist/api/types/ManagePlanRequest.d.ts +15 -0
- package/dist/api/types/ManagePlanResponseResponseData.d.ts +8 -0
- package/dist/api/types/PlanAudienceDetailResponseData.d.ts +0 -3
- package/dist/api/types/PlanCreditGrantView.d.ts +4 -0
- package/dist/api/types/PlanDetailResponseData.d.ts +1 -0
- package/dist/api/types/PlanEntitlementResponseData.d.ts +1 -0
- package/dist/api/types/PlanGroupDetailResponseData.d.ts +16 -3
- package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts +1 -0
- package/dist/api/types/PlanGroupResponseData.d.ts +11 -3
- package/dist/api/types/PlanIssueResponseData.d.ts +9 -0
- package/dist/api/types/PlanSelection.d.ts +7 -0
- package/dist/api/types/PlanTraitResponseData.d.ts +0 -3
- package/dist/api/types/PreviewSubscriptionChangeResponseData.d.ts +0 -3
- package/dist/api/types/PreviewSubscriptionFinanceResponseData.d.ts +3 -0
- package/dist/api/types/RawEventBatchResponseData.d.ts +0 -3
- package/dist/api/types/Rule.d.ts +16 -0
- package/dist/api/types/RulesDetailResponseData.d.ts +0 -3
- package/dist/api/types/SegmentStatusResp.d.ts +0 -3
- package/dist/api/types/TraitDefinition.d.ts +8 -0
- package/dist/api/types/UpdatePlanTraitTraitRequestBody.d.ts +7 -0
- package/dist/api/types/UsageBasedEntitlementRequestBody.d.ts +1 -0
- package/dist/api/types/UsageBasedEntitlementResponseData.d.ts +1 -0
- package/dist/api/types/index.d.ts +24 -0
- package/dist/index.js +3 -3
- package/dist/serialization/resources/accesstokens/client/requests/IssueTemporaryAccessTokenRequestBody.d.ts +0 -1
- package/dist/serialization/resources/billing/client/requests/{CreateBillingSubscriptionsRequestBody.d.ts → CreateBillingSubscriptionRequestBody.d.ts} +5 -4
- package/dist/serialization/resources/billing/client/requests/index.d.ts +1 -1
- package/dist/serialization/resources/billing/types/CreateBillingSubscriptionRequestBodyTrialEndSetting.d.ts +10 -0
- package/dist/serialization/resources/billing/types/SearchBillingPricesParams.d.ts +4 -0
- package/dist/serialization/resources/billing/types/index.d.ts +2 -2
- package/dist/serialization/resources/checkout/types/CheckoutInternalResponse.d.ts +2 -2
- package/dist/serialization/resources/checkout/types/ManagePlanResponse.d.ts +14 -0
- package/dist/serialization/resources/checkout/types/PreviewManagePlanResponse.d.ts +14 -0
- package/dist/serialization/resources/checkout/types/index.d.ts +2 -0
- package/dist/serialization/resources/companies/client/requests/UpdatePlanTraitBulkRequestBody.d.ts +14 -0
- package/dist/serialization/resources/companies/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +1 -0
- package/dist/serialization/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +1 -0
- package/dist/serialization/resources/companies/types/UpdatePlanTraitsBulkResponse.d.ts +14 -0
- package/dist/serialization/resources/companies/types/index.d.ts +1 -0
- package/dist/serialization/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.d.ts +7 -0
- package/dist/serialization/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +6 -0
- package/dist/serialization/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +2 -1
- package/dist/serialization/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +2 -0
- package/dist/serialization/resources/credits/types/CountCreditLedgerParams.d.ts +20 -0
- package/dist/serialization/resources/credits/types/CountCreditLedgerRequestPeriod.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CountCreditLedgerResponse.d.ts +15 -0
- package/dist/serialization/resources/credits/types/CountCreditLedgerResponseParamsPeriod.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryType.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryUnit.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetType.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateCompanyCreditGrantExpiryType.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateCompanyCreditGrantExpiryUnit.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.d.ts +1 -1
- package/dist/serialization/resources/credits/types/CreateCreditBundleRequestBodyExpiryUnit.d.ts +10 -0
- package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerParams.d.ts +20 -0
- package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerRequestPeriod.d.ts +10 -0
- package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerResponse.d.ts +15 -0
- package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerResponseParamsPeriod.d.ts +10 -0
- package/dist/serialization/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryType.d.ts +1 -1
- package/dist/serialization/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryUnit.d.ts +10 -0
- package/dist/serialization/resources/credits/types/ZeroOutGrantRequestBodyReason.d.ts +1 -1
- package/dist/serialization/resources/credits/types/index.d.ts +15 -0
- package/dist/serialization/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +1 -0
- package/dist/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +1 -0
- package/dist/serialization/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +1 -0
- package/dist/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +1 -0
- package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +13 -0
- package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +13 -0
- package/dist/serialization/resources/plans/types/CountPlansParams.d.ts +4 -0
- package/dist/serialization/resources/plans/types/ListPlanIssuesParams.d.ts +12 -0
- package/dist/serialization/resources/plans/types/ListPlanIssuesResponse.d.ts +15 -0
- package/dist/serialization/resources/plans/types/ListPlansParams.d.ts +4 -0
- package/dist/serialization/resources/plans/types/index.d.ts +2 -0
- package/dist/serialization/types/BillingCreditBundleResponseData.d.ts +1 -0
- package/dist/serialization/types/BillingCreditBundleView.d.ts +1 -0
- package/dist/serialization/types/BillingCreditLedgerResponseData.d.ts +17 -0
- package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +7 -0
- package/dist/serialization/types/BillingProductDetailResponseData.d.ts +1 -1
- package/dist/serialization/types/BillingProductForSubscriptionResponseData.d.ts +2 -0
- package/dist/serialization/types/BillingProductPricing.d.ts +2 -0
- package/dist/serialization/types/BillingProductResponseData.d.ts +1 -1
- package/dist/serialization/types/CheckoutSettingsResponseData.d.ts +14 -0
- package/dist/serialization/types/CheckoutSubscription.d.ts +31 -0
- package/dist/serialization/types/CompanyDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/CompanyLedgerResponseData.d.ts +14 -0
- package/dist/serialization/types/CompanyOverrideNoteResponseData.d.ts +17 -0
- package/dist/serialization/types/CompanyOverrideResponseData.d.ts +2 -0
- package/dist/serialization/types/CompanyPlanDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/CompanyViewWithFeatureUsageResponseData.d.ts +2 -0
- package/dist/serialization/types/ComponentCheckoutSettings.d.ts +15 -0
- package/dist/serialization/types/ComponentHydrateResponseData.d.ts +5 -0
- package/dist/serialization/types/ComponentPreviewResponseData.d.ts +5 -0
- package/dist/serialization/types/Condition.d.ts +27 -0
- package/dist/serialization/types/ConditionGroup.d.ts +13 -0
- package/dist/serialization/types/CountResponse.d.ts +1 -1
- package/dist/serialization/types/CreditCompanyGrantView.d.ts +3 -0
- package/dist/serialization/types/CreditGrantDetail.d.ts +16 -0
- package/dist/serialization/types/CreditGrantDetailGrantReason.d.ts +10 -0
- package/dist/serialization/types/CreditLedgerEnrichedEntryResponseData.d.ts +35 -0
- package/dist/serialization/types/CreditUsage.d.ts +20 -0
- package/dist/serialization/types/CreditUsageResponseData.d.ts +20 -0
- package/dist/serialization/types/FeatureCompanyResponseData.d.ts +28 -0
- package/dist/serialization/types/FeatureCompanyResponseDataCreditGrantReason.d.ts +10 -0
- package/dist/serialization/types/FeatureCompanyUserResponseDataAllocationType.d.ts +1 -1
- package/dist/serialization/types/FeatureLedgerResponseData.d.ts +15 -0
- package/dist/serialization/types/FeatureUsageDataResponseData.d.ts +9 -0
- package/dist/serialization/types/FeatureUsageResponseData.d.ts +17 -0
- package/dist/serialization/types/FeatureUsageResponseDataCreditGrantReason.d.ts +10 -0
- package/dist/serialization/types/ManagePlanPreviewResponseResponseData.d.ts +13 -0
- package/dist/serialization/types/ManagePlanRequest.d.ts +23 -0
- package/dist/serialization/types/ManagePlanResponseResponseData.d.ts +14 -0
- package/dist/serialization/types/PlanCreditGrantView.d.ts +4 -0
- package/dist/serialization/types/PlanDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/PlanEntitlementResponseData.d.ts +1 -0
- package/dist/serialization/types/PlanGroupDetailResponseData.d.ts +18 -0
- package/dist/serialization/types/PlanGroupPlanDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/PlanGroupResponseData.d.ts +12 -0
- package/dist/serialization/types/PlanIssueResponseData.d.ts +15 -0
- package/dist/serialization/types/PlanSelection.d.ts +13 -0
- package/dist/serialization/types/PreviewSubscriptionFinanceResponseData.d.ts +3 -0
- package/dist/serialization/types/Rule.d.ts +23 -0
- package/dist/serialization/types/TraitDefinition.d.ts +14 -0
- package/dist/serialization/types/UpdatePlanTraitTraitRequestBody.d.ts +13 -0
- package/dist/serialization/types/UsageBasedEntitlementRequestBody.d.ts +1 -0
- package/dist/serialization/types/UsageBasedEntitlementResponseData.d.ts +1 -0
- package/dist/serialization/types/index.d.ts +24 -0
- package/package.json +1 -1
- package/dist/api/resources/billing/types/CreateBillingSubscriptionsRequestBodyTrialEndSetting.d.ts +0 -8
- package/dist/serialization/resources/billing/types/CreateBillingSubscriptionsRequestBodyTrialEndSetting.d.ts +0 -10
package/dist/api/resources/companies/client/requests/ListCompaniesForAdvancedFilterRequest.d.ts
CHANGED
|
@@ -4,7 +4,16 @@
|
|
|
4
4
|
import * as Schematic from "../../../../index";
|
|
5
5
|
/**
|
|
6
6
|
* @example
|
|
7
|
-
* {
|
|
7
|
+
* {
|
|
8
|
+
* monetizedSubscriptions: true,
|
|
9
|
+
* q: "q",
|
|
10
|
+
* withoutPlan: true,
|
|
11
|
+
* withoutSubscription: true,
|
|
12
|
+
* sortOrderColumn: "sort_order_column",
|
|
13
|
+
* sortOrderDirection: "asc",
|
|
14
|
+
* limit: 1,
|
|
15
|
+
* offset: 1
|
|
16
|
+
* }
|
|
8
17
|
*/
|
|
9
18
|
export interface ListCompaniesForAdvancedFilterRequest {
|
|
10
19
|
/**
|
|
@@ -19,6 +28,10 @@ export interface ListCompaniesForAdvancedFilterRequest {
|
|
|
19
28
|
* Filter companies by one or more feature IDs (each ID starts with feat_)
|
|
20
29
|
*/
|
|
21
30
|
featureIds?: string | string[];
|
|
31
|
+
/**
|
|
32
|
+
* Filter companies by one or more credit type IDs (each ID starts with bcrd_)
|
|
33
|
+
*/
|
|
34
|
+
creditTypeIds?: string | string[];
|
|
22
35
|
/**
|
|
23
36
|
* Filter companies by one or more subscription statuses (active, canceled, expired, incomplete, incomplete_expired, past_due, paused, trialing, unpaid)
|
|
24
37
|
*/
|
|
@@ -52,7 +65,7 @@ export interface ListCompaniesForAdvancedFilterRequest {
|
|
|
52
65
|
*/
|
|
53
66
|
sortOrderDirection?: Schematic.ListCompaniesForAdvancedFilterRequestSortOrderDirection;
|
|
54
67
|
/**
|
|
55
|
-
* Select the display columns to return (e.g. plan, subscription, users,
|
|
68
|
+
* Select the display columns to return (e.g. plan, subscription, users, last_seen_at)
|
|
56
69
|
*/
|
|
57
70
|
displayProperties?: string | string[];
|
|
58
71
|
/**
|
|
@@ -3,7 +3,15 @@
|
|
|
3
3
|
*/
|
|
4
4
|
/**
|
|
5
5
|
* @example
|
|
6
|
-
* {
|
|
6
|
+
* {
|
|
7
|
+
* planId: "plan_id",
|
|
8
|
+
* q: "q",
|
|
9
|
+
* withoutFeatureOverrideFor: "without_feature_override_for",
|
|
10
|
+
* withoutPlan: true,
|
|
11
|
+
* withSubscription: true,
|
|
12
|
+
* limit: 1,
|
|
13
|
+
* offset: 1
|
|
14
|
+
* }
|
|
7
15
|
*/
|
|
8
16
|
export interface ListCompaniesRequest {
|
|
9
17
|
/**
|
|
@@ -4,7 +4,12 @@
|
|
|
4
4
|
import * as Schematic from "../../../../index";
|
|
5
5
|
/**
|
|
6
6
|
* @example
|
|
7
|
-
* {
|
|
7
|
+
* {
|
|
8
|
+
* entityType: "company",
|
|
9
|
+
* q: "q",
|
|
10
|
+
* limit: 1,
|
|
11
|
+
* offset: 1
|
|
12
|
+
* }
|
|
8
13
|
*/
|
|
9
14
|
export interface ListEntityKeyDefinitionsRequest {
|
|
10
15
|
entityType?: Schematic.ListEntityKeyDefinitionsRequestEntityType;
|
|
@@ -4,7 +4,13 @@
|
|
|
4
4
|
import * as Schematic from "../../../../index";
|
|
5
5
|
/**
|
|
6
6
|
* @example
|
|
7
|
-
* {
|
|
7
|
+
* {
|
|
8
|
+
* entityType: "company",
|
|
9
|
+
* q: "q",
|
|
10
|
+
* traitType: "boolean",
|
|
11
|
+
* limit: 1,
|
|
12
|
+
* offset: 1
|
|
13
|
+
* }
|
|
8
14
|
*/
|
|
9
15
|
export interface ListEntityTraitDefinitionsRequest {
|
|
10
16
|
entityType?: Schematic.ListEntityTraitDefinitionsRequestEntityType;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Schematic from "../../../../index";
|
|
5
|
+
/**
|
|
6
|
+
* @example
|
|
7
|
+
* {
|
|
8
|
+
* planId: "plan_id",
|
|
9
|
+
* traits: [{
|
|
10
|
+
* traitId: "trait_id",
|
|
11
|
+
* traitValue: "trait_value"
|
|
12
|
+
* }]
|
|
13
|
+
* }
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdatePlanTraitBulkRequestBody {
|
|
16
|
+
planId: string;
|
|
17
|
+
traits: Schematic.UpdatePlanTraitTraitRequestBody[];
|
|
18
|
+
}
|
|
@@ -17,6 +17,7 @@ export { type GetEntityTraitValuesRequest } from "./GetEntityTraitValuesRequest"
|
|
|
17
17
|
export { type ListPlanTraitsRequest } from "./ListPlanTraitsRequest";
|
|
18
18
|
export { type CreatePlanTraitRequestBody } from "./CreatePlanTraitRequestBody";
|
|
19
19
|
export { type UpdatePlanTraitRequestBody } from "./UpdatePlanTraitRequestBody";
|
|
20
|
+
export { type UpdatePlanTraitBulkRequestBody } from "./UpdatePlanTraitBulkRequestBody";
|
|
20
21
|
export { type CountPlanTraitsRequest } from "./CountPlanTraitsRequest";
|
|
21
22
|
export { type ListUsersRequest } from "./ListUsersRequest";
|
|
22
23
|
export { type CountUsersRequest } from "./CountUsersRequest";
|
|
@@ -6,7 +6,9 @@ import * as Schematic from "../../../index";
|
|
|
6
6
|
* Input parameters
|
|
7
7
|
*/
|
|
8
8
|
export interface CountCompaniesForAdvancedFilterParams {
|
|
9
|
-
/**
|
|
9
|
+
/** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
|
|
10
|
+
creditTypeIds?: string[];
|
|
11
|
+
/** Select the display columns to return (e.g. plan, subscription, users, last_seen_at) */
|
|
10
12
|
displayProperties?: string[];
|
|
11
13
|
/** Filter companies by one or more feature IDs (each ID starts with feat_) */
|
|
12
14
|
featureIds?: string[];
|
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as Schematic from "../../../index";
|
|
5
5
|
export interface GetActiveCompanySubscriptionResponse {
|
|
6
|
-
/** The returned resources */
|
|
7
6
|
data: Schematic.CompanySubscriptionResponseData[];
|
|
8
7
|
/** Input parameters */
|
|
9
8
|
params: Schematic.GetActiveCompanySubscriptionParams;
|
|
@@ -6,7 +6,9 @@ import * as Schematic from "../../../index";
|
|
|
6
6
|
* Input parameters
|
|
7
7
|
*/
|
|
8
8
|
export interface ListCompaniesForAdvancedFilterParams {
|
|
9
|
-
/**
|
|
9
|
+
/** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
|
|
10
|
+
creditTypeIds?: string[];
|
|
11
|
+
/** Select the display columns to return (e.g. plan, subscription, users, last_seen_at) */
|
|
10
12
|
displayProperties?: string[];
|
|
11
13
|
/** Filter companies by one or more feature IDs (each ID starts with feat_) */
|
|
12
14
|
featureIds?: string[];
|
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as Schematic from "../../../index";
|
|
5
5
|
export interface ListCompaniesForAdvancedFilterResponse {
|
|
6
|
-
/** The returned resources */
|
|
7
6
|
data: Schematic.CompanyViewWithFeatureUsageResponseData[];
|
|
8
7
|
/** Input parameters */
|
|
9
8
|
params: Schematic.ListCompaniesForAdvancedFilterParams;
|
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as Schematic from "../../../index";
|
|
5
5
|
export interface ListEntityTraitDefinitionsResponse {
|
|
6
|
-
/** The returned resources */
|
|
7
6
|
data: Schematic.EntityTraitDefinitionResponseData[];
|
|
8
7
|
/** Input parameters */
|
|
9
8
|
params: Schematic.ListEntityTraitDefinitionsParams;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Schematic from "../../../index";
|
|
5
|
+
export interface UpdatePlanTraitsBulkResponse {
|
|
6
|
+
data: Schematic.PlanTraitResponseData[];
|
|
7
|
+
/** Input parameters */
|
|
8
|
+
params: Record<string, unknown>;
|
|
9
|
+
}
|
|
@@ -60,6 +60,7 @@ export * from "./CreatePlanTraitResponse";
|
|
|
60
60
|
export * from "./GetPlanTraitResponse";
|
|
61
61
|
export * from "./UpdatePlanTraitResponse";
|
|
62
62
|
export * from "./DeletePlanTraitResponse";
|
|
63
|
+
export * from "./UpdatePlanTraitsBulkResponse";
|
|
63
64
|
export * from "./CountPlanTraitsParams";
|
|
64
65
|
export * from "./CountPlanTraitsResponse";
|
|
65
66
|
export * from "./UpsertUserTraitResponse";
|
|
@@ -9,7 +9,7 @@ export declare namespace Components {
|
|
|
9
9
|
environment?: core.Supplier<environments.SchematicEnvironment | string>;
|
|
10
10
|
/** Specify a custom URL to connect the client to. */
|
|
11
11
|
baseUrl?: core.Supplier<string>;
|
|
12
|
-
apiKey
|
|
12
|
+
apiKey?: core.Supplier<string | undefined>;
|
|
13
13
|
fetcher?: core.FetchFunction;
|
|
14
14
|
}
|
|
15
15
|
interface RequestOptions {
|
|
@@ -25,7 +25,7 @@ export declare namespace Components {
|
|
|
25
25
|
}
|
|
26
26
|
export declare class Components {
|
|
27
27
|
protected readonly _options: Components.Options;
|
|
28
|
-
constructor(_options
|
|
28
|
+
constructor(_options?: Components.Options);
|
|
29
29
|
/**
|
|
30
30
|
* @param {Schematic.ListComponentsRequest} request
|
|
31
31
|
* @param {Components.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -37,7 +37,11 @@ export declare class Components {
|
|
|
37
37
|
* @throws {@link Schematic.InternalServerError}
|
|
38
38
|
*
|
|
39
39
|
* @example
|
|
40
|
-
* await client.components.listComponents(
|
|
40
|
+
* await client.components.listComponents({
|
|
41
|
+
* q: "q",
|
|
42
|
+
* limit: 1,
|
|
43
|
+
* offset: 1
|
|
44
|
+
* })
|
|
41
45
|
*/
|
|
42
46
|
listComponents(request?: Schematic.ListComponentsRequest, requestOptions?: Components.RequestOptions): core.HttpResponsePromise<Schematic.ListComponentsResponse>;
|
|
43
47
|
private __listComponents;
|
|
@@ -115,7 +119,11 @@ export declare class Components {
|
|
|
115
119
|
* @throws {@link Schematic.InternalServerError}
|
|
116
120
|
*
|
|
117
121
|
* @example
|
|
118
|
-
* await client.components.countComponents(
|
|
122
|
+
* await client.components.countComponents({
|
|
123
|
+
* q: "q",
|
|
124
|
+
* limit: 1,
|
|
125
|
+
* offset: 1
|
|
126
|
+
* })
|
|
119
127
|
*/
|
|
120
128
|
countComponents(request?: Schematic.CountComponentsRequest, requestOptions?: Components.RequestOptions): core.HttpResponsePromise<Schematic.CountComponentsResponse>;
|
|
121
129
|
private __countComponents;
|
|
@@ -129,11 +137,14 @@ export declare class Components {
|
|
|
129
137
|
* @throws {@link Schematic.InternalServerError}
|
|
130
138
|
*
|
|
131
139
|
* @example
|
|
132
|
-
* await client.components.previewComponentData(
|
|
140
|
+
* await client.components.previewComponentData({
|
|
141
|
+
* companyId: "company_id",
|
|
142
|
+
* componentId: "component_id"
|
|
143
|
+
* })
|
|
133
144
|
*/
|
|
134
145
|
previewComponentData(request?: Schematic.PreviewComponentDataRequest, requestOptions?: Components.RequestOptions): core.HttpResponsePromise<Schematic.PreviewComponentDataResponse>;
|
|
135
146
|
private __previewComponentData;
|
|
136
147
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
137
|
-
"X-Schematic-Api-Key": string;
|
|
148
|
+
"X-Schematic-Api-Key": string | undefined;
|
|
138
149
|
}>;
|
|
139
150
|
}
|
|
@@ -9,7 +9,7 @@ export declare namespace Credits {
|
|
|
9
9
|
environment?: core.Supplier<environments.SchematicEnvironment | string>;
|
|
10
10
|
/** Specify a custom URL to connect the client to. */
|
|
11
11
|
baseUrl?: core.Supplier<string>;
|
|
12
|
-
apiKey
|
|
12
|
+
apiKey?: core.Supplier<string | undefined>;
|
|
13
13
|
fetcher?: core.FetchFunction;
|
|
14
14
|
}
|
|
15
15
|
interface RequestOptions {
|
|
@@ -25,7 +25,7 @@ export declare namespace Credits {
|
|
|
25
25
|
}
|
|
26
26
|
export declare class Credits {
|
|
27
27
|
protected readonly _options: Credits.Options;
|
|
28
|
-
constructor(_options
|
|
28
|
+
constructor(_options?: Credits.Options);
|
|
29
29
|
/**
|
|
30
30
|
* @param {Schematic.ListBillingCreditsRequest} request
|
|
31
31
|
* @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -37,7 +37,11 @@ export declare class Credits {
|
|
|
37
37
|
* @throws {@link Schematic.InternalServerError}
|
|
38
38
|
*
|
|
39
39
|
* @example
|
|
40
|
-
* await client.credits.listBillingCredits(
|
|
40
|
+
* await client.credits.listBillingCredits({
|
|
41
|
+
* name: "name",
|
|
42
|
+
* limit: 1,
|
|
43
|
+
* offset: 1
|
|
44
|
+
* })
|
|
41
45
|
*/
|
|
42
46
|
listBillingCredits(request?: Schematic.ListBillingCreditsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ListBillingCreditsResponse>;
|
|
43
47
|
private __listBillingCredits;
|
|
@@ -119,7 +123,13 @@ export declare class Credits {
|
|
|
119
123
|
* @throws {@link Schematic.InternalServerError}
|
|
120
124
|
*
|
|
121
125
|
* @example
|
|
122
|
-
* await client.credits.listCreditBundles(
|
|
126
|
+
* await client.credits.listCreditBundles({
|
|
127
|
+
* creditId: "credit_id",
|
|
128
|
+
* status: "active",
|
|
129
|
+
* bundleType: "fixed",
|
|
130
|
+
* limit: 1,
|
|
131
|
+
* offset: 1
|
|
132
|
+
* })
|
|
123
133
|
*/
|
|
124
134
|
listCreditBundles(request?: Schematic.ListCreditBundlesRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ListCreditBundlesResponse>;
|
|
125
135
|
private __listCreditBundles;
|
|
@@ -202,7 +212,13 @@ export declare class Credits {
|
|
|
202
212
|
* @throws {@link Schematic.InternalServerError}
|
|
203
213
|
*
|
|
204
214
|
* @example
|
|
205
|
-
* await client.credits.countCreditBundles(
|
|
215
|
+
* await client.credits.countCreditBundles({
|
|
216
|
+
* creditId: "credit_id",
|
|
217
|
+
* status: "active",
|
|
218
|
+
* bundleType: "fixed",
|
|
219
|
+
* limit: 1,
|
|
220
|
+
* offset: 1
|
|
221
|
+
* })
|
|
206
222
|
*/
|
|
207
223
|
countCreditBundles(request?: Schematic.CountCreditBundlesRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CountCreditBundlesResponse>;
|
|
208
224
|
private __countCreditBundles;
|
|
@@ -217,7 +233,11 @@ export declare class Credits {
|
|
|
217
233
|
* @throws {@link Schematic.InternalServerError}
|
|
218
234
|
*
|
|
219
235
|
* @example
|
|
220
|
-
* await client.credits.countBillingCredits(
|
|
236
|
+
* await client.credits.countBillingCredits({
|
|
237
|
+
* name: "name",
|
|
238
|
+
* limit: 1,
|
|
239
|
+
* offset: 1
|
|
240
|
+
* })
|
|
221
241
|
*/
|
|
222
242
|
countBillingCredits(request?: Schematic.CountBillingCreditsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CountBillingCreditsResponse>;
|
|
223
243
|
private __countBillingCredits;
|
|
@@ -268,7 +288,13 @@ export declare class Credits {
|
|
|
268
288
|
* @throws {@link Schematic.InternalServerError}
|
|
269
289
|
*
|
|
270
290
|
* @example
|
|
271
|
-
* await client.credits.listCompanyGrants(
|
|
291
|
+
* await client.credits.listCompanyGrants({
|
|
292
|
+
* companyId: "company_id",
|
|
293
|
+
* order: "created_at",
|
|
294
|
+
* dir: "asc",
|
|
295
|
+
* limit: 1,
|
|
296
|
+
* offset: 1
|
|
297
|
+
* })
|
|
272
298
|
*/
|
|
273
299
|
listCompanyGrants(request?: Schematic.ListCompanyGrantsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyGrantsResponse>;
|
|
274
300
|
private __listCompanyGrants;
|
|
@@ -283,7 +309,11 @@ export declare class Credits {
|
|
|
283
309
|
* @throws {@link Schematic.InternalServerError}
|
|
284
310
|
*
|
|
285
311
|
* @example
|
|
286
|
-
* await client.credits.countBillingCreditsGrants(
|
|
312
|
+
* await client.credits.countBillingCreditsGrants({
|
|
313
|
+
* creditId: "credit_id",
|
|
314
|
+
* limit: 1,
|
|
315
|
+
* offset: 1
|
|
316
|
+
* })
|
|
287
317
|
*/
|
|
288
318
|
countBillingCreditsGrants(request?: Schematic.CountBillingCreditsGrantsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CountBillingCreditsGrantsResponse>;
|
|
289
319
|
private __countBillingCreditsGrants;
|
|
@@ -298,10 +328,62 @@ export declare class Credits {
|
|
|
298
328
|
* @throws {@link Schematic.InternalServerError}
|
|
299
329
|
*
|
|
300
330
|
* @example
|
|
301
|
-
* await client.credits.listGrantsForCredit(
|
|
331
|
+
* await client.credits.listGrantsForCredit({
|
|
332
|
+
* creditId: "credit_id",
|
|
333
|
+
* limit: 1,
|
|
334
|
+
* offset: 1
|
|
335
|
+
* })
|
|
302
336
|
*/
|
|
303
337
|
listGrantsForCredit(request?: Schematic.ListGrantsForCreditRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ListGrantsForCreditResponse>;
|
|
304
338
|
private __listGrantsForCredit;
|
|
339
|
+
/**
|
|
340
|
+
* @param {Schematic.GetEnrichedCreditLedgerRequest} request
|
|
341
|
+
* @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
|
|
342
|
+
*
|
|
343
|
+
* @throws {@link Schematic.BadRequestError}
|
|
344
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
345
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
346
|
+
* @throws {@link Schematic.NotFoundError}
|
|
347
|
+
* @throws {@link Schematic.InternalServerError}
|
|
348
|
+
*
|
|
349
|
+
* @example
|
|
350
|
+
* await client.credits.getEnrichedCreditLedger({
|
|
351
|
+
* companyId: "company_id",
|
|
352
|
+
* billingCreditId: "billing_credit_id",
|
|
353
|
+
* featureId: "feature_id",
|
|
354
|
+
* period: "daily",
|
|
355
|
+
* startTime: "start_time",
|
|
356
|
+
* endTime: "end_time",
|
|
357
|
+
* limit: 1,
|
|
358
|
+
* offset: 1
|
|
359
|
+
* })
|
|
360
|
+
*/
|
|
361
|
+
getEnrichedCreditLedger(request: Schematic.GetEnrichedCreditLedgerRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.GetEnrichedCreditLedgerResponse>;
|
|
362
|
+
private __getEnrichedCreditLedger;
|
|
363
|
+
/**
|
|
364
|
+
* @param {Schematic.CountCreditLedgerRequest} request
|
|
365
|
+
* @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
|
|
366
|
+
*
|
|
367
|
+
* @throws {@link Schematic.BadRequestError}
|
|
368
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
369
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
370
|
+
* @throws {@link Schematic.NotFoundError}
|
|
371
|
+
* @throws {@link Schematic.InternalServerError}
|
|
372
|
+
*
|
|
373
|
+
* @example
|
|
374
|
+
* await client.credits.countCreditLedger({
|
|
375
|
+
* companyId: "company_id",
|
|
376
|
+
* billingCreditId: "billing_credit_id",
|
|
377
|
+
* featureId: "feature_id",
|
|
378
|
+
* period: "daily",
|
|
379
|
+
* startTime: "start_time",
|
|
380
|
+
* endTime: "end_time",
|
|
381
|
+
* limit: 1,
|
|
382
|
+
* offset: 1
|
|
383
|
+
* })
|
|
384
|
+
*/
|
|
385
|
+
countCreditLedger(request: Schematic.CountCreditLedgerRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CountCreditLedgerResponse>;
|
|
386
|
+
private __countCreditLedger;
|
|
305
387
|
/**
|
|
306
388
|
* @param {Schematic.ListBillingPlanCreditGrantsRequest} request
|
|
307
389
|
* @param {Credits.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -313,7 +395,12 @@ export declare class Credits {
|
|
|
313
395
|
* @throws {@link Schematic.InternalServerError}
|
|
314
396
|
*
|
|
315
397
|
* @example
|
|
316
|
-
* await client.credits.listBillingPlanCreditGrants(
|
|
398
|
+
* await client.credits.listBillingPlanCreditGrants({
|
|
399
|
+
* creditId: "credit_id",
|
|
400
|
+
* planId: "plan_id",
|
|
401
|
+
* limit: 1,
|
|
402
|
+
* offset: 1
|
|
403
|
+
* })
|
|
317
404
|
*/
|
|
318
405
|
listBillingPlanCreditGrants(request?: Schematic.ListBillingPlanCreditGrantsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.ListBillingPlanCreditGrantsResponse>;
|
|
319
406
|
private __listBillingPlanCreditGrants;
|
|
@@ -364,11 +451,16 @@ export declare class Credits {
|
|
|
364
451
|
* @throws {@link Schematic.InternalServerError}
|
|
365
452
|
*
|
|
366
453
|
* @example
|
|
367
|
-
* await client.credits.countBillingPlanCreditGrants(
|
|
454
|
+
* await client.credits.countBillingPlanCreditGrants({
|
|
455
|
+
* creditId: "credit_id",
|
|
456
|
+
* planId: "plan_id",
|
|
457
|
+
* limit: 1,
|
|
458
|
+
* offset: 1
|
|
459
|
+
* })
|
|
368
460
|
*/
|
|
369
461
|
countBillingPlanCreditGrants(request?: Schematic.CountBillingPlanCreditGrantsRequest, requestOptions?: Credits.RequestOptions): core.HttpResponsePromise<Schematic.CountBillingPlanCreditGrantsResponse>;
|
|
370
462
|
private __countBillingPlanCreditGrants;
|
|
371
463
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
372
|
-
"X-Schematic-Api-Key": string;
|
|
464
|
+
"X-Schematic-Api-Key": string | undefined;
|
|
373
465
|
}>;
|
|
374
466
|
}
|