@schematichq/schematic-typescript-node 1.2.1 → 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/README.md +114 -0
- 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/dist/wrapper.d.ts +8 -0
- package/package.json +2 -1
- package/dist/api/resources/billing/types/CreateBillingSubscriptionsRequestBodyTrialEndSetting.d.ts +0 -8
- package/dist/serialization/resources/billing/types/CreateBillingSubscriptionsRequestBodyTrialEndSetting.d.ts +0 -10
|
@@ -4,8 +4,11 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* @example
|
|
6
6
|
* {
|
|
7
|
+
* companyId: "company_id",
|
|
7
8
|
* customerExternalId: "customer_external_id",
|
|
8
|
-
* subscriptionExternalId: "subscription_external_id"
|
|
9
|
+
* subscriptionExternalId: "subscription_external_id",
|
|
10
|
+
* limit: 1,
|
|
11
|
+
* offset: 1
|
|
9
12
|
* }
|
|
10
13
|
*/
|
|
11
14
|
export interface ListInvoicesRequest {
|
|
@@ -4,7 +4,18 @@
|
|
|
4
4
|
import * as Schematic from "../../../../index";
|
|
5
5
|
/**
|
|
6
6
|
* @example
|
|
7
|
-
* {
|
|
7
|
+
* {
|
|
8
|
+
* name: "name",
|
|
9
|
+
* q: "q",
|
|
10
|
+
* priceUsageType: "licensed",
|
|
11
|
+
* withoutLinkedToPlan: true,
|
|
12
|
+
* withOneTimeCharges: true,
|
|
13
|
+
* withZeroPrice: true,
|
|
14
|
+
* withPricesOnly: true,
|
|
15
|
+
* isActive: true,
|
|
16
|
+
* limit: 1,
|
|
17
|
+
* offset: 1
|
|
18
|
+
* }
|
|
8
19
|
*/
|
|
9
20
|
export interface ListProductPricesRequest {
|
|
10
21
|
ids?: string | string[];
|
|
@@ -4,15 +4,40 @@
|
|
|
4
4
|
import * as Schematic from "../../../../index";
|
|
5
5
|
/**
|
|
6
6
|
* @example
|
|
7
|
-
* {
|
|
7
|
+
* {
|
|
8
|
+
* forInitialPlan: true,
|
|
9
|
+
* forTrialExpiryPlan: true,
|
|
10
|
+
* productId: "product_id",
|
|
11
|
+
* interval: "interval",
|
|
12
|
+
* price: 1,
|
|
13
|
+
* q: "q",
|
|
14
|
+
* requiresPaymentMethod: true,
|
|
15
|
+
* tiersMode: "volume",
|
|
16
|
+
* usageType: "licensed",
|
|
17
|
+
* limit: 1,
|
|
18
|
+
* offset: 1
|
|
19
|
+
* }
|
|
8
20
|
*/
|
|
9
21
|
export interface SearchBillingPricesRequest {
|
|
22
|
+
/**
|
|
23
|
+
* Filter for prices valid for initial plans (free prices only)
|
|
24
|
+
*/
|
|
25
|
+
forInitialPlan?: boolean;
|
|
26
|
+
/**
|
|
27
|
+
* Filter for prices valid for trial expiry plans (free prices only)
|
|
28
|
+
*/
|
|
29
|
+
forTrialExpiryPlan?: boolean;
|
|
10
30
|
ids?: string | string[];
|
|
11
|
-
|
|
31
|
+
productId?: string;
|
|
12
32
|
interval?: string;
|
|
13
|
-
usageType?: Schematic.SearchBillingPricesRequestUsageType;
|
|
14
33
|
price?: number;
|
|
34
|
+
q?: string;
|
|
35
|
+
/**
|
|
36
|
+
* Filter for prices that require a payment method (inverse of ForInitialPlan)
|
|
37
|
+
*/
|
|
38
|
+
requiresPaymentMethod?: boolean;
|
|
15
39
|
tiersMode?: Schematic.SearchBillingPricesRequestTiersMode;
|
|
40
|
+
usageType?: Schematic.SearchBillingPricesRequestUsageType;
|
|
16
41
|
/**
|
|
17
42
|
* Page limit (default 100)
|
|
18
43
|
*/
|
|
@@ -15,4 +15,4 @@ export { type ListProductPricesRequest } from "./ListProductPricesRequest";
|
|
|
15
15
|
export { type CreateBillingProductRequestBody } from "./CreateBillingProductRequestBody";
|
|
16
16
|
export { type ListBillingProductsRequest } from "./ListBillingProductsRequest";
|
|
17
17
|
export { type CountBillingProductsRequest } from "./CountBillingProductsRequest";
|
|
18
|
-
export { type
|
|
18
|
+
export { type CreateBillingSubscriptionRequestBody } from "./CreateBillingSubscriptionRequestBody";
|
package/dist/api/resources/billing/types/CreateBillingSubscriptionRequestBodyTrialEndSetting.d.ts
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export type CreateBillingSubscriptionRequestBodyTrialEndSetting = "subscribe" | "cancel";
|
|
5
|
+
export declare const CreateBillingSubscriptionRequestBodyTrialEndSetting: {
|
|
6
|
+
readonly Subscribe: "subscribe";
|
|
7
|
+
readonly Cancel: "cancel";
|
|
8
|
+
};
|
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as Schematic from "../../../index";
|
|
5
5
|
export interface ListCustomersWithSubscriptionsResponse {
|
|
6
|
-
/** The returned resources */
|
|
7
6
|
data: Schematic.BillingCustomerWithSubscriptionsResponseData[];
|
|
8
7
|
/** Input parameters */
|
|
9
8
|
params: Schematic.ListCustomersWithSubscriptionsParams;
|
|
@@ -6,6 +6,10 @@ import * as Schematic from "../../../index";
|
|
|
6
6
|
* Input parameters
|
|
7
7
|
*/
|
|
8
8
|
export interface SearchBillingPricesParams {
|
|
9
|
+
/** Filter for prices valid for initial plans (free prices only) */
|
|
10
|
+
forInitialPlan?: boolean;
|
|
11
|
+
/** Filter for prices valid for trial expiry plans (free prices only) */
|
|
12
|
+
forTrialExpiryPlan?: boolean;
|
|
9
13
|
ids?: string[];
|
|
10
14
|
interval?: string;
|
|
11
15
|
/** Page limit (default 100) */
|
|
@@ -13,7 +17,10 @@ export interface SearchBillingPricesParams {
|
|
|
13
17
|
/** Page offset (default 0) */
|
|
14
18
|
offset?: number;
|
|
15
19
|
price?: number;
|
|
20
|
+
productId?: string;
|
|
16
21
|
q?: string;
|
|
22
|
+
/** Filter for prices that require a payment method (inverse of ForInitialPlan) */
|
|
23
|
+
requiresPaymentMethod?: boolean;
|
|
17
24
|
tiersMode?: Schematic.SearchBillingPricesResponseParamsTiersMode;
|
|
18
25
|
usageType?: Schematic.SearchBillingPricesResponseParamsUsageType;
|
|
19
26
|
}
|
|
@@ -15,8 +15,8 @@ export * from "./UpsertBillingMeterResponse";
|
|
|
15
15
|
export * from "./ListPaymentMethodsParams";
|
|
16
16
|
export * from "./ListPaymentMethodsResponse";
|
|
17
17
|
export * from "./UpsertPaymentMethodResponse";
|
|
18
|
-
export * from "./SearchBillingPricesRequestUsageType";
|
|
19
18
|
export * from "./SearchBillingPricesRequestTiersMode";
|
|
19
|
+
export * from "./SearchBillingPricesRequestUsageType";
|
|
20
20
|
export * from "./SearchBillingPricesResponseParamsTiersMode";
|
|
21
21
|
export * from "./SearchBillingPricesResponseParamsUsageType";
|
|
22
22
|
export * from "./SearchBillingPricesParams";
|
|
@@ -40,5 +40,5 @@ export * from "./CountBillingProductsRequestPriceUsageType";
|
|
|
40
40
|
export * from "./CountBillingProductsResponseParamsPriceUsageType";
|
|
41
41
|
export * from "./CountBillingProductsParams";
|
|
42
42
|
export * from "./CountBillingProductsResponse";
|
|
43
|
-
export * from "./
|
|
43
|
+
export * from "./CreateBillingSubscriptionRequestBodyTrialEndSetting";
|
|
44
44
|
export * from "./UpsertBillingSubscriptionResponse";
|
|
@@ -9,7 +9,7 @@ export declare namespace Checkout {
|
|
|
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 Checkout {
|
|
|
25
25
|
}
|
|
26
26
|
export declare class Checkout {
|
|
27
27
|
protected readonly _options: Checkout.Options;
|
|
28
|
-
constructor(_options
|
|
28
|
+
constructor(_options?: Checkout.Options);
|
|
29
29
|
/**
|
|
30
30
|
* @param {Schematic.ChangeSubscriptionInternalRequestBody} request
|
|
31
31
|
* @param {Checkout.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -107,6 +107,62 @@ export declare class Checkout {
|
|
|
107
107
|
*/
|
|
108
108
|
previewCheckoutInternal(request: Schematic.ChangeSubscriptionInternalRequestBody, requestOptions?: Checkout.RequestOptions): core.HttpResponsePromise<Schematic.PreviewCheckoutInternalResponse>;
|
|
109
109
|
private __previewCheckoutInternal;
|
|
110
|
+
/**
|
|
111
|
+
* @param {Schematic.ManagePlanRequest} request
|
|
112
|
+
* @param {Checkout.RequestOptions} requestOptions - Request-specific configuration.
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link Schematic.BadRequestError}
|
|
115
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
116
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
117
|
+
* @throws {@link Schematic.NotFoundError}
|
|
118
|
+
* @throws {@link Schematic.InternalServerError}
|
|
119
|
+
*
|
|
120
|
+
* @example
|
|
121
|
+
* await client.checkout.managePlan({
|
|
122
|
+
* addOnSelections: [{
|
|
123
|
+
* planId: "plan_id"
|
|
124
|
+
* }],
|
|
125
|
+
* companyId: "company_id",
|
|
126
|
+
* creditBundles: [{
|
|
127
|
+
* bundleId: "bundle_id",
|
|
128
|
+
* quantity: 1
|
|
129
|
+
* }],
|
|
130
|
+
* payInAdvanceEntitlements: [{
|
|
131
|
+
* priceId: "price_id",
|
|
132
|
+
* quantity: 1
|
|
133
|
+
* }]
|
|
134
|
+
* })
|
|
135
|
+
*/
|
|
136
|
+
managePlan(request: Schematic.ManagePlanRequest, requestOptions?: Checkout.RequestOptions): core.HttpResponsePromise<Schematic.ManagePlanResponse>;
|
|
137
|
+
private __managePlan;
|
|
138
|
+
/**
|
|
139
|
+
* @param {Schematic.ManagePlanRequest} request
|
|
140
|
+
* @param {Checkout.RequestOptions} requestOptions - Request-specific configuration.
|
|
141
|
+
*
|
|
142
|
+
* @throws {@link Schematic.BadRequestError}
|
|
143
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
144
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
145
|
+
* @throws {@link Schematic.NotFoundError}
|
|
146
|
+
* @throws {@link Schematic.InternalServerError}
|
|
147
|
+
*
|
|
148
|
+
* @example
|
|
149
|
+
* await client.checkout.previewManagePlan({
|
|
150
|
+
* addOnSelections: [{
|
|
151
|
+
* planId: "plan_id"
|
|
152
|
+
* }],
|
|
153
|
+
* companyId: "company_id",
|
|
154
|
+
* creditBundles: [{
|
|
155
|
+
* bundleId: "bundle_id",
|
|
156
|
+
* quantity: 1
|
|
157
|
+
* }],
|
|
158
|
+
* payInAdvanceEntitlements: [{
|
|
159
|
+
* priceId: "price_id",
|
|
160
|
+
* quantity: 1
|
|
161
|
+
* }]
|
|
162
|
+
* })
|
|
163
|
+
*/
|
|
164
|
+
previewManagePlan(request: Schematic.ManagePlanRequest, requestOptions?: Checkout.RequestOptions): core.HttpResponsePromise<Schematic.PreviewManagePlanResponse>;
|
|
165
|
+
private __previewManagePlan;
|
|
110
166
|
/**
|
|
111
167
|
* @param {string} subscriptionId - subscription_id
|
|
112
168
|
* @param {Schematic.UpdateTrialEndRequestBody} request
|
|
@@ -124,6 +180,6 @@ export declare class Checkout {
|
|
|
124
180
|
updateCustomerSubscriptionTrialEnd(subscriptionId: string, request?: Schematic.UpdateTrialEndRequestBody, requestOptions?: Checkout.RequestOptions): core.HttpResponsePromise<Schematic.UpdateCustomerSubscriptionTrialEndResponse>;
|
|
125
181
|
private __updateCustomerSubscriptionTrialEnd;
|
|
126
182
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
127
|
-
"X-Schematic-Api-Key": string;
|
|
183
|
+
"X-Schematic-Api-Key": string | undefined;
|
|
128
184
|
}>;
|
|
129
185
|
}
|
|
@@ -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 ManagePlanResponse {
|
|
6
|
+
data: Schematic.ManagePlanResponseResponseData;
|
|
7
|
+
/** Input parameters */
|
|
8
|
+
params: Record<string, unknown>;
|
|
9
|
+
}
|
|
@@ -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 PreviewManagePlanResponse {
|
|
6
|
+
data: Schematic.ManagePlanPreviewResponseResponseData;
|
|
7
|
+
/** Input parameters */
|
|
8
|
+
params: Record<string, unknown>;
|
|
9
|
+
}
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
export * from "./CheckoutInternalResponse";
|
|
2
2
|
export * from "./GetCheckoutDataResponse";
|
|
3
3
|
export * from "./PreviewCheckoutInternalResponse";
|
|
4
|
+
export * from "./ManagePlanResponse";
|
|
5
|
+
export * from "./PreviewManagePlanResponse";
|
|
4
6
|
export * from "./UpdateCustomerSubscriptionTrialEndResponse";
|
|
@@ -9,7 +9,7 @@ export declare namespace Companies {
|
|
|
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 Companies {
|
|
|
25
25
|
}
|
|
26
26
|
export declare class Companies {
|
|
27
27
|
protected readonly _options: Companies.Options;
|
|
28
|
-
constructor(_options
|
|
28
|
+
constructor(_options?: Companies.Options);
|
|
29
29
|
/**
|
|
30
30
|
* @param {Schematic.ListCompaniesRequest} request
|
|
31
31
|
* @param {Companies.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -37,7 +37,15 @@ export declare class Companies {
|
|
|
37
37
|
* @throws {@link Schematic.InternalServerError}
|
|
38
38
|
*
|
|
39
39
|
* @example
|
|
40
|
-
* await client.companies.listCompanies(
|
|
40
|
+
* await client.companies.listCompanies({
|
|
41
|
+
* planId: "plan_id",
|
|
42
|
+
* q: "q",
|
|
43
|
+
* withoutFeatureOverrideFor: "without_feature_override_for",
|
|
44
|
+
* withoutPlan: true,
|
|
45
|
+
* withSubscription: true,
|
|
46
|
+
* limit: 1,
|
|
47
|
+
* offset: 1
|
|
48
|
+
* })
|
|
41
49
|
*/
|
|
42
50
|
listCompanies(request?: Schematic.ListCompaniesRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.ListCompaniesResponse>;
|
|
43
51
|
private __listCompanies;
|
|
@@ -100,7 +108,15 @@ export declare class Companies {
|
|
|
100
108
|
* @throws {@link Schematic.InternalServerError}
|
|
101
109
|
*
|
|
102
110
|
* @example
|
|
103
|
-
* await client.companies.countCompanies(
|
|
111
|
+
* await client.companies.countCompanies({
|
|
112
|
+
* planId: "plan_id",
|
|
113
|
+
* q: "q",
|
|
114
|
+
* withoutFeatureOverrideFor: "without_feature_override_for",
|
|
115
|
+
* withoutPlan: true,
|
|
116
|
+
* withSubscription: true,
|
|
117
|
+
* limit: 1,
|
|
118
|
+
* offset: 1
|
|
119
|
+
* })
|
|
104
120
|
*/
|
|
105
121
|
countCompanies(request?: Schematic.CountCompaniesRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.CountCompaniesResponse>;
|
|
106
122
|
private __countCompanies;
|
|
@@ -115,7 +131,16 @@ export declare class Companies {
|
|
|
115
131
|
* @throws {@link Schematic.InternalServerError}
|
|
116
132
|
*
|
|
117
133
|
* @example
|
|
118
|
-
* await client.companies.countCompaniesForAdvancedFilter(
|
|
134
|
+
* await client.companies.countCompaniesForAdvancedFilter({
|
|
135
|
+
* monetizedSubscriptions: true,
|
|
136
|
+
* q: "q",
|
|
137
|
+
* withoutPlan: true,
|
|
138
|
+
* withoutSubscription: true,
|
|
139
|
+
* sortOrderColumn: "sort_order_column",
|
|
140
|
+
* sortOrderDirection: "asc",
|
|
141
|
+
* limit: 1,
|
|
142
|
+
* offset: 1
|
|
143
|
+
* })
|
|
119
144
|
*/
|
|
120
145
|
countCompaniesForAdvancedFilter(request?: Schematic.CountCompaniesForAdvancedFilterRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.CountCompaniesForAdvancedFilterResponse>;
|
|
121
146
|
private __countCompaniesForAdvancedFilter;
|
|
@@ -168,7 +193,16 @@ export declare class Companies {
|
|
|
168
193
|
* @throws {@link Schematic.InternalServerError}
|
|
169
194
|
*
|
|
170
195
|
* @example
|
|
171
|
-
* await client.companies.listCompaniesForAdvancedFilter(
|
|
196
|
+
* await client.companies.listCompaniesForAdvancedFilter({
|
|
197
|
+
* monetizedSubscriptions: true,
|
|
198
|
+
* q: "q",
|
|
199
|
+
* withoutPlan: true,
|
|
200
|
+
* withoutSubscription: true,
|
|
201
|
+
* sortOrderColumn: "sort_order_column",
|
|
202
|
+
* sortOrderDirection: "asc",
|
|
203
|
+
* limit: 1,
|
|
204
|
+
* offset: 1
|
|
205
|
+
* })
|
|
172
206
|
*/
|
|
173
207
|
listCompaniesForAdvancedFilter(request?: Schematic.ListCompaniesForAdvancedFilterRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.ListCompaniesForAdvancedFilterResponse>;
|
|
174
208
|
private __listCompaniesForAdvancedFilter;
|
|
@@ -203,7 +237,9 @@ export declare class Companies {
|
|
|
203
237
|
* @example
|
|
204
238
|
* await client.companies.getActiveDeals({
|
|
205
239
|
* companyId: "company_id",
|
|
206
|
-
* dealStage: "deal_stage"
|
|
240
|
+
* dealStage: "deal_stage",
|
|
241
|
+
* limit: 1,
|
|
242
|
+
* offset: 1
|
|
207
243
|
* })
|
|
208
244
|
*/
|
|
209
245
|
getActiveDeals(request: Schematic.GetActiveDealsRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.GetActiveDealsResponse>;
|
|
@@ -219,7 +255,12 @@ export declare class Companies {
|
|
|
219
255
|
* @throws {@link Schematic.InternalServerError}
|
|
220
256
|
*
|
|
221
257
|
* @example
|
|
222
|
-
* await client.companies.listCompanyMemberships(
|
|
258
|
+
* await client.companies.listCompanyMemberships({
|
|
259
|
+
* companyId: "company_id",
|
|
260
|
+
* userId: "user_id",
|
|
261
|
+
* limit: 1,
|
|
262
|
+
* offset: 1
|
|
263
|
+
* })
|
|
223
264
|
*/
|
|
224
265
|
listCompanyMemberships(request?: Schematic.ListCompanyMembershipsRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyMembershipsResponse>;
|
|
225
266
|
private __listCompanyMemberships;
|
|
@@ -267,7 +308,11 @@ export declare class Companies {
|
|
|
267
308
|
* @throws {@link Schematic.InternalServerError}
|
|
268
309
|
*
|
|
269
310
|
* @example
|
|
270
|
-
* await client.companies.getActiveCompanySubscription(
|
|
311
|
+
* await client.companies.getActiveCompanySubscription({
|
|
312
|
+
* companyId: "company_id",
|
|
313
|
+
* limit: 1,
|
|
314
|
+
* offset: 1
|
|
315
|
+
* })
|
|
271
316
|
*/
|
|
272
317
|
getActiveCompanySubscription(request?: Schematic.GetActiveCompanySubscriptionRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.GetActiveCompanySubscriptionResponse>;
|
|
273
318
|
private __getActiveCompanySubscription;
|
|
@@ -302,7 +347,12 @@ export declare class Companies {
|
|
|
302
347
|
* @throws {@link Schematic.InternalServerError}
|
|
303
348
|
*
|
|
304
349
|
* @example
|
|
305
|
-
* await client.companies.listEntityKeyDefinitions(
|
|
350
|
+
* await client.companies.listEntityKeyDefinitions({
|
|
351
|
+
* entityType: "company",
|
|
352
|
+
* q: "q",
|
|
353
|
+
* limit: 1,
|
|
354
|
+
* offset: 1
|
|
355
|
+
* })
|
|
306
356
|
*/
|
|
307
357
|
listEntityKeyDefinitions(request?: Schematic.ListEntityKeyDefinitionsRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.ListEntityKeyDefinitionsResponse>;
|
|
308
358
|
private __listEntityKeyDefinitions;
|
|
@@ -317,7 +367,12 @@ export declare class Companies {
|
|
|
317
367
|
* @throws {@link Schematic.InternalServerError}
|
|
318
368
|
*
|
|
319
369
|
* @example
|
|
320
|
-
* await client.companies.countEntityKeyDefinitions(
|
|
370
|
+
* await client.companies.countEntityKeyDefinitions({
|
|
371
|
+
* entityType: "company",
|
|
372
|
+
* q: "q",
|
|
373
|
+
* limit: 1,
|
|
374
|
+
* offset: 1
|
|
375
|
+
* })
|
|
321
376
|
*/
|
|
322
377
|
countEntityKeyDefinitions(request?: Schematic.CountEntityKeyDefinitionsRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.CountEntityKeyDefinitionsResponse>;
|
|
323
378
|
private __countEntityKeyDefinitions;
|
|
@@ -332,7 +387,13 @@ export declare class Companies {
|
|
|
332
387
|
* @throws {@link Schematic.InternalServerError}
|
|
333
388
|
*
|
|
334
389
|
* @example
|
|
335
|
-
* await client.companies.listEntityTraitDefinitions(
|
|
390
|
+
* await client.companies.listEntityTraitDefinitions({
|
|
391
|
+
* entityType: "company",
|
|
392
|
+
* q: "q",
|
|
393
|
+
* traitType: "boolean",
|
|
394
|
+
* limit: 1,
|
|
395
|
+
* offset: 1
|
|
396
|
+
* })
|
|
336
397
|
*/
|
|
337
398
|
listEntityTraitDefinitions(request?: Schematic.ListEntityTraitDefinitionsRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.ListEntityTraitDefinitionsResponse>;
|
|
338
399
|
private __listEntityTraitDefinitions;
|
|
@@ -398,7 +459,13 @@ export declare class Companies {
|
|
|
398
459
|
* @throws {@link Schematic.InternalServerError}
|
|
399
460
|
*
|
|
400
461
|
* @example
|
|
401
|
-
* await client.companies.countEntityTraitDefinitions(
|
|
462
|
+
* await client.companies.countEntityTraitDefinitions({
|
|
463
|
+
* entityType: "company",
|
|
464
|
+
* q: "q",
|
|
465
|
+
* traitType: "boolean",
|
|
466
|
+
* limit: 1,
|
|
467
|
+
* offset: 1
|
|
468
|
+
* })
|
|
402
469
|
*/
|
|
403
470
|
countEntityTraitDefinitions(request?: Schematic.CountEntityTraitDefinitionsRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.CountEntityTraitDefinitionsResponse>;
|
|
404
471
|
private __countEntityTraitDefinitions;
|
|
@@ -414,7 +481,10 @@ export declare class Companies {
|
|
|
414
481
|
*
|
|
415
482
|
* @example
|
|
416
483
|
* await client.companies.getEntityTraitValues({
|
|
417
|
-
* definitionId: "definition_id"
|
|
484
|
+
* definitionId: "definition_id",
|
|
485
|
+
* q: "q",
|
|
486
|
+
* limit: 1,
|
|
487
|
+
* offset: 1
|
|
418
488
|
* })
|
|
419
489
|
*/
|
|
420
490
|
getEntityTraitValues(request: Schematic.GetEntityTraitValuesRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.GetEntityTraitValuesResponse>;
|
|
@@ -430,7 +500,12 @@ export declare class Companies {
|
|
|
430
500
|
* @throws {@link Schematic.InternalServerError}
|
|
431
501
|
*
|
|
432
502
|
* @example
|
|
433
|
-
* await client.companies.listPlanTraits(
|
|
503
|
+
* await client.companies.listPlanTraits({
|
|
504
|
+
* planId: "plan_id",
|
|
505
|
+
* traitId: "trait_id",
|
|
506
|
+
* limit: 1,
|
|
507
|
+
* offset: 1
|
|
508
|
+
* })
|
|
434
509
|
*/
|
|
435
510
|
listPlanTraits(request?: Schematic.ListPlanTraitsRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.ListPlanTraitsResponse>;
|
|
436
511
|
private __listPlanTraits;
|
|
@@ -501,6 +576,27 @@ export declare class Companies {
|
|
|
501
576
|
*/
|
|
502
577
|
deletePlanTrait(planTraitId: string, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.DeletePlanTraitResponse>;
|
|
503
578
|
private __deletePlanTrait;
|
|
579
|
+
/**
|
|
580
|
+
* @param {Schematic.UpdatePlanTraitBulkRequestBody} request
|
|
581
|
+
* @param {Companies.RequestOptions} requestOptions - Request-specific configuration.
|
|
582
|
+
*
|
|
583
|
+
* @throws {@link Schematic.BadRequestError}
|
|
584
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
585
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
586
|
+
* @throws {@link Schematic.NotFoundError}
|
|
587
|
+
* @throws {@link Schematic.InternalServerError}
|
|
588
|
+
*
|
|
589
|
+
* @example
|
|
590
|
+
* await client.companies.updatePlanTraitsBulk({
|
|
591
|
+
* planId: "plan_id",
|
|
592
|
+
* traits: [{
|
|
593
|
+
* traitId: "trait_id",
|
|
594
|
+
* traitValue: "trait_value"
|
|
595
|
+
* }]
|
|
596
|
+
* })
|
|
597
|
+
*/
|
|
598
|
+
updatePlanTraitsBulk(request: Schematic.UpdatePlanTraitBulkRequestBody, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.UpdatePlanTraitsBulkResponse>;
|
|
599
|
+
private __updatePlanTraitsBulk;
|
|
504
600
|
/**
|
|
505
601
|
* @param {Schematic.CountPlanTraitsRequest} request
|
|
506
602
|
* @param {Companies.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -512,7 +608,12 @@ export declare class Companies {
|
|
|
512
608
|
* @throws {@link Schematic.InternalServerError}
|
|
513
609
|
*
|
|
514
610
|
* @example
|
|
515
|
-
* await client.companies.countPlanTraits(
|
|
611
|
+
* await client.companies.countPlanTraits({
|
|
612
|
+
* planId: "plan_id",
|
|
613
|
+
* traitId: "trait_id",
|
|
614
|
+
* limit: 1,
|
|
615
|
+
* offset: 1
|
|
616
|
+
* })
|
|
516
617
|
*/
|
|
517
618
|
countPlanTraits(request?: Schematic.CountPlanTraitsRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.CountPlanTraitsResponse>;
|
|
518
619
|
private __countPlanTraits;
|
|
@@ -547,7 +648,13 @@ export declare class Companies {
|
|
|
547
648
|
* @throws {@link Schematic.InternalServerError}
|
|
548
649
|
*
|
|
549
650
|
* @example
|
|
550
|
-
* await client.companies.listUsers(
|
|
651
|
+
* await client.companies.listUsers({
|
|
652
|
+
* companyId: "company_id",
|
|
653
|
+
* planId: "plan_id",
|
|
654
|
+
* q: "q",
|
|
655
|
+
* limit: 1,
|
|
656
|
+
* offset: 1
|
|
657
|
+
* })
|
|
551
658
|
*/
|
|
552
659
|
listUsers(request?: Schematic.ListUsersRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.ListUsersResponse>;
|
|
553
660
|
private __listUsers;
|
|
@@ -610,7 +717,13 @@ export declare class Companies {
|
|
|
610
717
|
* @throws {@link Schematic.InternalServerError}
|
|
611
718
|
*
|
|
612
719
|
* @example
|
|
613
|
-
* await client.companies.countUsers(
|
|
720
|
+
* await client.companies.countUsers({
|
|
721
|
+
* companyId: "company_id",
|
|
722
|
+
* planId: "plan_id",
|
|
723
|
+
* q: "q",
|
|
724
|
+
* limit: 1,
|
|
725
|
+
* offset: 1
|
|
726
|
+
* })
|
|
614
727
|
*/
|
|
615
728
|
countUsers(request?: Schematic.CountUsersRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.CountUsersResponse>;
|
|
616
729
|
private __countUsers;
|
|
@@ -671,6 +784,6 @@ export declare class Companies {
|
|
|
671
784
|
lookupUser(request: Schematic.LookupUserRequest, requestOptions?: Companies.RequestOptions): core.HttpResponsePromise<Schematic.LookupUserResponse>;
|
|
672
785
|
private __lookupUser;
|
|
673
786
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
674
|
-
"X-Schematic-Api-Key": string;
|
|
787
|
+
"X-Schematic-Api-Key": string | undefined;
|
|
675
788
|
}>;
|
|
676
789
|
}
|