@schematichq/schematic-typescript-node 1.1.7 → 1.1.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Client.d.ts +6 -13
- package/Client.js +26 -109
- package/README.md +5 -3
- package/api/resources/accesstokens/client/Client.js +1 -1
- package/api/resources/accounts/client/Client.js +14 -14
- package/api/resources/billing/client/Client.d.ts +29 -0
- package/api/resources/billing/client/Client.js +124 -17
- package/api/resources/billing/client/requests/CreateBillingPriceRequestBody.d.ts +2 -0
- package/api/resources/billing/client/requests/CreateBillingSubscriptionsRequestBody.d.ts +8 -0
- package/api/resources/billing/client/requests/CreateCouponRequestBody.d.ts +27 -0
- package/api/resources/billing/client/requests/index.d.ts +1 -0
- package/api/resources/{events/types/GetEventSummaryBySubtypeResponse.d.ts → billing/types/UpsertBillingCouponResponse.d.ts} +2 -2
- package/api/resources/billing/types/index.d.ts +1 -0
- package/api/resources/billing/types/index.js +1 -0
- package/api/resources/checkout/client/Client.d.ts +106 -0
- package/api/resources/checkout/client/Client.js +460 -0
- package/api/resources/checkout/client/index.d.ts +1 -0
- package/api/resources/checkout/client/index.js +17 -0
- package/api/resources/checkout/client/requests/UpdateTrialEndRequestBody.d.ts +10 -0
- package/api/resources/checkout/client/requests/index.d.ts +1 -0
- package/api/resources/checkout/client/requests/index.js +2 -0
- package/api/resources/checkout/index.d.ts +2 -0
- package/api/resources/checkout/index.js +18 -0
- package/{dist/api/resources/events/types/GetEventSummaryBySubtypeResponse.d.ts → api/resources/checkout/types/CheckoutInternalResponse.d.ts} +2 -2
- package/api/resources/checkout/types/GetCheckoutDataResponse.d.ts +9 -0
- package/api/resources/checkout/types/GetCheckoutDataResponse.js +5 -0
- package/api/resources/checkout/types/PreviewCheckoutInternalResponse.d.ts +9 -0
- package/api/resources/checkout/types/PreviewCheckoutInternalResponse.js +5 -0
- package/api/resources/checkout/types/UpdateCustomerSubscriptionTrialEndResponse.d.ts +9 -0
- package/api/resources/checkout/types/UpdateCustomerSubscriptionTrialEndResponse.js +5 -0
- package/api/resources/checkout/types/index.d.ts +4 -0
- package/api/resources/checkout/types/index.js +20 -0
- package/api/resources/companies/client/Client.js +31 -31
- package/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +2 -2
- package/api/resources/companies/client/requests/CountUsersRequest.d.ts +3 -3
- package/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +2 -2
- package/api/resources/companies/client/requests/ListUsersRequest.d.ts +3 -3
- package/api/resources/companies/types/CountCompaniesParams.d.ts +2 -2
- package/api/resources/companies/types/CountUsersParams.d.ts +3 -3
- package/api/resources/companies/types/ListCompaniesParams.d.ts +2 -2
- package/api/resources/companies/types/ListUsersParams.d.ts +3 -3
- package/api/resources/components/client/Client.js +7 -7
- package/api/resources/crm/client/Client.js +5 -5
- package/api/resources/entitlements/client/Client.js +27 -21
- package/api/resources/entitlements/client/requests/CountCompanyOverridesRequest.d.ts +9 -5
- package/api/resources/entitlements/client/requests/CountPlanEntitlementsRequest.d.ts +5 -5
- package/api/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +0 -2
- package/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +0 -2
- package/api/resources/entitlements/client/requests/ListCompanyOverridesRequest.d.ts +9 -5
- package/api/resources/entitlements/client/requests/ListPlanEntitlementsRequest.d.ts +5 -5
- package/api/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +0 -2
- package/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +3 -2
- package/api/resources/entitlements/types/CountCompanyOverridesParams.d.ts +7 -5
- package/api/resources/entitlements/types/CountPlanEntitlementsParams.d.ts +5 -5
- package/api/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriod.d.ts +1 -2
- package/api/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriod.js +0 -1
- package/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriod.d.ts +1 -2
- package/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriod.js +0 -1
- package/api/resources/entitlements/types/ListCompanyOverridesParams.d.ts +7 -5
- package/api/resources/entitlements/types/ListPlanEntitlementsParams.d.ts +5 -5
- package/api/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriod.d.ts +1 -2
- package/api/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriod.js +0 -1
- package/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriod.d.ts +1 -2
- package/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriod.js +0 -1
- package/api/resources/events/client/Client.d.ts +0 -13
- package/api/resources/events/client/Client.js +6 -96
- package/api/resources/events/types/index.d.ts +0 -1
- package/api/resources/events/types/index.js +0 -1
- package/api/resources/features/client/Client.js +19 -19
- package/api/resources/index.d.ts +6 -3
- package/api/resources/index.js +7 -4
- package/api/resources/plangroups/client/Client.js +3 -3
- package/api/resources/plans/client/Client.d.ts +17 -0
- package/api/resources/plans/client/Client.js +122 -13
- package/api/resources/plans/client/requests/CountPlansRequest.d.ts +4 -0
- package/api/resources/plans/client/requests/ListPlansRequest.d.ts +4 -0
- package/api/resources/plans/client/requests/UpdateCompanyPlansRequestBody.d.ts +13 -0
- package/api/resources/plans/client/requests/UpdateCompanyPlansRequestBody.js +5 -0
- package/api/resources/plans/client/requests/index.d.ts +1 -0
- package/api/resources/plans/types/CountPlansParams.d.ts +2 -0
- package/api/resources/plans/types/ListPlansParams.d.ts +2 -0
- package/api/resources/plans/types/UpdateCompanyPlansResponse.d.ts +9 -0
- package/api/resources/plans/types/UpdateCompanyPlansResponse.js +5 -0
- package/api/resources/plans/types/index.d.ts +1 -0
- package/api/resources/plans/types/index.js +1 -0
- package/api/resources/webhooks/client/Client.js +9 -9
- package/api/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.d.ts +2 -1
- package/api/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.js +1 -0
- package/api/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.d.ts +2 -1
- package/api/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.js +1 -0
- package/api/types/BillingCouponResponseData.d.ts +24 -0
- package/api/types/BillingCouponResponseData.js +5 -0
- package/api/types/BillingPriceView.d.ts +1 -0
- package/api/types/BillingProductForSubscriptionResponseData.d.ts +1 -0
- package/api/types/BillingProductPriceResponseData.d.ts +1 -0
- package/api/types/BillingSubscriptionDiscount.d.ts +12 -0
- package/api/types/BillingSubscriptionDiscount.js +5 -0
- package/api/types/BillingSubscriptionDiscountView.d.ts +19 -0
- package/api/types/BillingSubscriptionDiscountView.js +5 -0
- package/api/types/BillingSubscriptionResponseData.d.ts +1 -0
- package/api/types/BillingSubscriptionView.d.ts +5 -0
- package/api/types/ChangeSubscriptionInternalRequestBody.d.ts +13 -0
- package/api/types/ChangeSubscriptionInternalRequestBody.js +5 -0
- package/api/types/ChangeSubscriptionRequestBody.d.ts +12 -0
- package/api/types/ChangeSubscriptionRequestBody.js +5 -0
- package/api/types/CheckFlagResponseData.d.ts +19 -0
- package/api/types/CheckFlagsResponseData.d.ts +1 -1
- package/api/types/CheckoutDataResponseData.d.ts +15 -0
- package/api/types/CheckoutDataResponseData.js +5 -0
- package/api/types/CompanyDetailResponseData.d.ts +1 -0
- package/api/types/CompanyEventPeriodMetricsResponseData.d.ts +16 -0
- package/api/types/CompanyEventPeriodMetricsResponseData.js +5 -0
- package/api/types/CompanyOverrideResponseData.d.ts +1 -0
- package/api/types/CompanySubscriptionResponseData.d.ts +2 -0
- package/api/types/ComponentHydrateResponseData.d.ts +2 -0
- package/api/types/ComponentPreviewResponseData.d.ts +2 -0
- package/api/types/CouponRequestBody.d.ts +13 -0
- package/api/types/CouponRequestBody.js +5 -0
- package/api/types/CreateEntitlementReqCommon.d.ts +0 -2
- package/api/types/CreateEntitlementReqCommonMetricPeriod.d.ts +1 -2
- package/api/types/CreateEntitlementReqCommonMetricPeriod.js +0 -1
- package/api/types/CreateOrUpdateConditionRequestBodyMetricPeriod.d.ts +1 -2
- package/api/types/CreateOrUpdateConditionRequestBodyMetricPeriod.js +0 -1
- package/api/types/EventBodyFlagCheck.d.ts +4 -4
- package/api/types/EventBodyTrack.d.ts +2 -0
- package/api/types/EventDetailResponseData.d.ts +1 -0
- package/api/types/EventResponseData.d.ts +1 -0
- package/api/types/FeatureCompanyResponseData.d.ts +1 -0
- package/api/types/FeatureUsageResponseData.d.ts +5 -1
- package/api/types/PlanEntitlementResponseData.d.ts +1 -0
- package/api/types/PreviewSubscriptionChangeResponseData.d.ts +16 -0
- package/api/types/PreviewSubscriptionChangeResponseData.js +5 -0
- package/api/types/UpdateAddOnRequestBody.d.ts +7 -0
- package/api/types/UpdateAddOnRequestBody.js +5 -0
- package/api/types/UpdateEntitlementReqCommon.d.ts +0 -2
- package/api/types/UpdateEntitlementReqCommonMetricPeriod.d.ts +1 -2
- package/api/types/UpdateEntitlementReqCommonMetricPeriod.js +0 -1
- package/api/types/UpdatePayInAdvanceRequestBody.d.ts +7 -0
- package/api/types/UpdatePayInAdvanceRequestBody.js +5 -0
- package/api/types/UsageBasedEntitlementRequestBody.d.ts +8 -0
- package/api/types/UsageBasedEntitlementRequestBody.js +5 -0
- package/api/types/UsageBasedEntitlementResponseData.d.ts +2 -0
- package/api/types/index.d.ts +12 -1
- package/api/types/index.js +12 -1
- package/dist/Client.d.ts +6 -13
- package/dist/Client.js +26 -109
- package/dist/api/resources/accesstokens/client/Client.js +1 -1
- package/dist/api/resources/accounts/client/Client.js +14 -14
- package/dist/api/resources/billing/client/Client.d.ts +29 -0
- package/dist/api/resources/billing/client/Client.js +124 -17
- package/dist/api/resources/billing/client/requests/CreateBillingPriceRequestBody.d.ts +2 -0
- package/dist/api/resources/billing/client/requests/CreateBillingSubscriptionsRequestBody.d.ts +8 -0
- package/dist/api/resources/billing/client/requests/CreateCouponRequestBody.d.ts +27 -0
- package/dist/api/resources/billing/client/requests/CreateCouponRequestBody.js +5 -0
- package/dist/api/resources/billing/client/requests/index.d.ts +1 -0
- package/dist/api/resources/billing/types/UpsertBillingCouponResponse.d.ts +9 -0
- package/dist/api/resources/billing/types/UpsertBillingCouponResponse.js +5 -0
- package/dist/api/resources/billing/types/index.d.ts +1 -0
- package/dist/api/resources/billing/types/index.js +1 -0
- package/dist/api/resources/checkout/client/Client.d.ts +106 -0
- package/dist/api/resources/checkout/client/Client.js +460 -0
- package/dist/api/resources/checkout/client/index.d.ts +1 -0
- package/dist/api/resources/checkout/client/index.js +17 -0
- package/dist/api/resources/checkout/client/requests/UpdateTrialEndRequestBody.d.ts +10 -0
- package/dist/api/resources/checkout/client/requests/UpdateTrialEndRequestBody.js +5 -0
- package/dist/api/resources/checkout/client/requests/index.d.ts +1 -0
- package/dist/api/resources/checkout/client/requests/index.js +2 -0
- package/dist/api/resources/checkout/index.d.ts +2 -0
- package/dist/api/resources/checkout/index.js +18 -0
- package/dist/api/resources/checkout/types/CheckoutInternalResponse.d.ts +9 -0
- package/dist/api/resources/checkout/types/CheckoutInternalResponse.js +5 -0
- package/dist/api/resources/checkout/types/GetCheckoutDataResponse.d.ts +9 -0
- package/dist/api/resources/checkout/types/GetCheckoutDataResponse.js +5 -0
- package/dist/api/resources/checkout/types/PreviewCheckoutInternalResponse.d.ts +9 -0
- package/dist/api/resources/checkout/types/PreviewCheckoutInternalResponse.js +5 -0
- package/dist/api/resources/checkout/types/UpdateCustomerSubscriptionTrialEndResponse.d.ts +9 -0
- package/dist/api/resources/checkout/types/UpdateCustomerSubscriptionTrialEndResponse.js +5 -0
- package/dist/api/resources/checkout/types/index.d.ts +4 -0
- package/dist/api/resources/checkout/types/index.js +20 -0
- package/dist/api/resources/companies/client/Client.js +31 -31
- package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +2 -2
- package/dist/api/resources/companies/client/requests/CountUsersRequest.d.ts +3 -3
- package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +2 -2
- package/dist/api/resources/companies/client/requests/ListUsersRequest.d.ts +3 -3
- package/dist/api/resources/companies/types/CountCompaniesParams.d.ts +2 -2
- package/dist/api/resources/companies/types/CountUsersParams.d.ts +3 -3
- package/dist/api/resources/companies/types/ListCompaniesParams.d.ts +2 -2
- package/dist/api/resources/companies/types/ListUsersParams.d.ts +3 -3
- package/dist/api/resources/components/client/Client.js +7 -7
- package/dist/api/resources/crm/client/Client.js +5 -5
- package/dist/api/resources/entitlements/client/Client.js +27 -21
- package/dist/api/resources/entitlements/client/requests/CountCompanyOverridesRequest.d.ts +9 -5
- package/dist/api/resources/entitlements/client/requests/CountPlanEntitlementsRequest.d.ts +5 -5
- package/dist/api/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +0 -2
- package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +0 -2
- package/dist/api/resources/entitlements/client/requests/ListCompanyOverridesRequest.d.ts +9 -5
- package/dist/api/resources/entitlements/client/requests/ListPlanEntitlementsRequest.d.ts +5 -5
- package/dist/api/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +0 -2
- package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +3 -2
- package/dist/api/resources/entitlements/types/CountCompanyOverridesParams.d.ts +7 -5
- package/dist/api/resources/entitlements/types/CountPlanEntitlementsParams.d.ts +5 -5
- package/dist/api/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriod.d.ts +1 -2
- package/dist/api/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriod.js +0 -1
- package/dist/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriod.d.ts +1 -2
- package/dist/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriod.js +0 -1
- package/dist/api/resources/entitlements/types/ListCompanyOverridesParams.d.ts +7 -5
- package/dist/api/resources/entitlements/types/ListPlanEntitlementsParams.d.ts +5 -5
- package/dist/api/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriod.d.ts +1 -2
- package/dist/api/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriod.js +0 -1
- package/dist/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriod.d.ts +1 -2
- package/dist/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriod.js +0 -1
- package/dist/api/resources/events/client/Client.d.ts +0 -13
- package/dist/api/resources/events/client/Client.js +6 -96
- package/dist/api/resources/events/types/index.d.ts +0 -1
- package/dist/api/resources/events/types/index.js +0 -1
- package/dist/api/resources/features/client/Client.js +19 -19
- package/dist/api/resources/index.d.ts +6 -3
- package/dist/api/resources/index.js +7 -4
- package/dist/api/resources/plangroups/client/Client.js +3 -3
- package/dist/api/resources/plans/client/Client.d.ts +17 -0
- package/dist/api/resources/plans/client/Client.js +122 -13
- package/dist/api/resources/plans/client/requests/CountPlansRequest.d.ts +4 -0
- package/dist/api/resources/plans/client/requests/ListPlansRequest.d.ts +4 -0
- package/dist/api/resources/plans/client/requests/UpdateCompanyPlansRequestBody.d.ts +13 -0
- package/dist/api/resources/plans/client/requests/UpdateCompanyPlansRequestBody.js +5 -0
- package/dist/api/resources/plans/client/requests/index.d.ts +1 -0
- package/dist/api/resources/plans/types/CountPlansParams.d.ts +2 -0
- package/dist/api/resources/plans/types/ListPlansParams.d.ts +2 -0
- package/dist/api/resources/plans/types/UpdateCompanyPlansResponse.d.ts +9 -0
- package/dist/api/resources/plans/types/UpdateCompanyPlansResponse.js +5 -0
- package/dist/api/resources/plans/types/index.d.ts +1 -0
- package/dist/api/resources/plans/types/index.js +1 -0
- package/dist/api/resources/webhooks/client/Client.js +9 -9
- package/dist/api/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.d.ts +2 -1
- package/dist/api/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.js +1 -0
- package/dist/api/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.d.ts +2 -1
- package/dist/api/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.js +1 -0
- package/dist/api/types/BillingCouponResponseData.d.ts +24 -0
- package/dist/api/types/BillingCouponResponseData.js +5 -0
- package/dist/api/types/BillingPriceView.d.ts +1 -0
- package/dist/api/types/BillingProductForSubscriptionResponseData.d.ts +1 -0
- package/dist/api/types/BillingProductPriceResponseData.d.ts +1 -0
- package/dist/api/types/BillingSubscriptionDiscount.d.ts +12 -0
- package/dist/api/types/BillingSubscriptionDiscount.js +5 -0
- package/dist/api/types/BillingSubscriptionDiscountView.d.ts +19 -0
- package/dist/api/types/BillingSubscriptionDiscountView.js +5 -0
- package/dist/api/types/BillingSubscriptionResponseData.d.ts +1 -0
- package/dist/api/types/BillingSubscriptionView.d.ts +5 -0
- package/dist/api/types/ChangeSubscriptionInternalRequestBody.d.ts +13 -0
- package/dist/api/types/ChangeSubscriptionInternalRequestBody.js +5 -0
- package/dist/api/types/ChangeSubscriptionRequestBody.d.ts +12 -0
- package/dist/api/types/ChangeSubscriptionRequestBody.js +5 -0
- package/dist/api/types/CheckFlagResponseData.d.ts +19 -0
- package/dist/api/types/CheckFlagsResponseData.d.ts +1 -1
- package/dist/api/types/CheckoutDataResponseData.d.ts +15 -0
- package/dist/api/types/CheckoutDataResponseData.js +5 -0
- package/dist/api/types/CompanyDetailResponseData.d.ts +1 -0
- package/dist/api/types/CompanyEventPeriodMetricsResponseData.d.ts +16 -0
- package/dist/api/types/CompanyEventPeriodMetricsResponseData.js +5 -0
- package/dist/api/types/CompanyOverrideResponseData.d.ts +1 -0
- package/dist/api/types/CompanySubscriptionResponseData.d.ts +2 -0
- package/dist/api/types/ComponentHydrateResponseData.d.ts +2 -0
- package/dist/api/types/ComponentPreviewResponseData.d.ts +2 -0
- package/dist/api/types/CouponRequestBody.d.ts +13 -0
- package/dist/api/types/CouponRequestBody.js +5 -0
- package/dist/api/types/CreateEntitlementReqCommon.d.ts +0 -2
- package/dist/api/types/CreateEntitlementReqCommonMetricPeriod.d.ts +1 -2
- package/dist/api/types/CreateEntitlementReqCommonMetricPeriod.js +0 -1
- package/dist/api/types/CreateOrUpdateConditionRequestBodyMetricPeriod.d.ts +1 -2
- package/dist/api/types/CreateOrUpdateConditionRequestBodyMetricPeriod.js +0 -1
- package/dist/api/types/EventBodyFlagCheck.d.ts +4 -4
- package/dist/api/types/EventBodyTrack.d.ts +2 -0
- package/dist/api/types/EventDetailResponseData.d.ts +1 -0
- package/dist/api/types/EventResponseData.d.ts +1 -0
- package/dist/api/types/FeatureCompanyResponseData.d.ts +1 -0
- package/dist/api/types/FeatureUsageResponseData.d.ts +5 -1
- package/dist/api/types/PlanEntitlementResponseData.d.ts +1 -0
- package/dist/api/types/PreviewSubscriptionChangeResponseData.d.ts +16 -0
- package/dist/api/types/PreviewSubscriptionChangeResponseData.js +5 -0
- package/dist/api/types/UpdateAddOnRequestBody.d.ts +7 -0
- package/dist/api/types/UpdateAddOnRequestBody.js +5 -0
- package/dist/api/types/UpdateEntitlementReqCommon.d.ts +0 -2
- package/dist/api/types/UpdateEntitlementReqCommonMetricPeriod.d.ts +1 -2
- package/dist/api/types/UpdateEntitlementReqCommonMetricPeriod.js +0 -1
- package/dist/api/types/UpdatePayInAdvanceRequestBody.d.ts +7 -0
- package/dist/api/types/UpdatePayInAdvanceRequestBody.js +5 -0
- package/dist/api/types/UsageBasedEntitlementRequestBody.d.ts +8 -0
- package/dist/api/types/UsageBasedEntitlementRequestBody.js +5 -0
- package/dist/api/types/UsageBasedEntitlementResponseData.d.ts +2 -0
- package/dist/api/types/index.d.ts +12 -1
- package/dist/api/types/index.js +12 -1
- package/dist/serialization/resources/billing/client/requests/CreateBillingPriceRequestBody.d.ts +1 -0
- package/dist/serialization/resources/billing/client/requests/CreateBillingPriceRequestBody.js +1 -0
- package/dist/serialization/resources/billing/client/requests/CreateBillingSubscriptionsRequestBody.d.ts +3 -0
- package/dist/serialization/resources/billing/client/requests/CreateBillingSubscriptionsRequestBody.js +3 -0
- package/dist/serialization/resources/billing/client/requests/CreateCouponRequestBody.d.ts +20 -0
- package/dist/serialization/resources/billing/client/requests/CreateCouponRequestBody.js +41 -0
- package/dist/serialization/resources/billing/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/billing/client/requests/index.js +3 -1
- package/dist/serialization/resources/billing/types/UpsertBillingCouponResponse.d.ts +14 -0
- package/dist/serialization/resources/{events/types/GetEventSummaryBySubtypeResponse.js → billing/types/UpsertBillingCouponResponse.js} +4 -4
- package/dist/serialization/resources/billing/types/index.d.ts +1 -0
- package/dist/serialization/resources/billing/types/index.js +1 -0
- package/dist/serialization/resources/checkout/client/index.d.ts +1 -0
- package/dist/serialization/resources/checkout/client/index.js +17 -0
- package/dist/serialization/resources/checkout/client/requests/UpdateTrialEndRequestBody.d.ts +12 -0
- package/dist/serialization/resources/checkout/client/requests/UpdateTrialEndRequestBody.js +33 -0
- package/dist/serialization/resources/checkout/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/checkout/client/requests/index.js +5 -0
- package/dist/serialization/resources/checkout/index.d.ts +2 -0
- package/dist/serialization/resources/checkout/index.js +18 -0
- package/dist/serialization/resources/checkout/types/CheckoutInternalResponse.d.ts +14 -0
- package/dist/serialization/resources/checkout/types/CheckoutInternalResponse.js +35 -0
- package/dist/serialization/resources/checkout/types/GetCheckoutDataResponse.d.ts +14 -0
- package/{serialization/resources/events/types/GetEventSummaryBySubtypeResponse.js → dist/serialization/resources/checkout/types/GetCheckoutDataResponse.js} +4 -4
- package/dist/serialization/resources/checkout/types/PreviewCheckoutInternalResponse.d.ts +14 -0
- package/dist/serialization/resources/checkout/types/PreviewCheckoutInternalResponse.js +35 -0
- package/dist/serialization/resources/checkout/types/UpdateCustomerSubscriptionTrialEndResponse.d.ts +14 -0
- package/dist/serialization/resources/checkout/types/UpdateCustomerSubscriptionTrialEndResponse.js +35 -0
- package/dist/serialization/resources/checkout/types/index.d.ts +4 -0
- package/dist/serialization/resources/checkout/types/index.js +20 -0
- package/dist/serialization/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +0 -2
- package/dist/serialization/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.js +0 -2
- package/dist/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +0 -2
- package/dist/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.js +0 -2
- package/dist/serialization/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +0 -2
- package/dist/serialization/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.js +0 -2
- package/dist/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +3 -2
- package/dist/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.js +3 -2
- package/dist/serialization/resources/entitlements/types/CountCompanyOverridesParams.d.ts +1 -0
- package/dist/serialization/resources/entitlements/types/CountCompanyOverridesParams.js +1 -0
- package/dist/serialization/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriod.d.ts +1 -1
- package/dist/serialization/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriod.js +1 -1
- package/dist/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriod.d.ts +1 -1
- package/dist/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriod.js +1 -1
- package/dist/serialization/resources/entitlements/types/ListCompanyOverridesParams.d.ts +1 -0
- package/dist/serialization/resources/entitlements/types/ListCompanyOverridesParams.js +1 -0
- package/dist/serialization/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriod.d.ts +1 -1
- package/dist/serialization/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriod.js +1 -1
- package/dist/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriod.d.ts +1 -1
- package/dist/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriod.js +1 -1
- package/dist/serialization/resources/events/types/index.d.ts +0 -1
- package/dist/serialization/resources/events/types/index.js +0 -1
- package/dist/serialization/resources/index.d.ts +6 -3
- package/dist/serialization/resources/index.js +7 -4
- package/dist/serialization/resources/plans/client/requests/UpdateCompanyPlansRequestBody.d.ts +13 -0
- package/dist/serialization/resources/plans/client/requests/UpdateCompanyPlansRequestBody.js +34 -0
- package/dist/serialization/resources/plans/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/plans/client/requests/index.js +3 -1
- package/dist/serialization/resources/plans/types/CountPlansParams.d.ts +1 -0
- package/dist/serialization/resources/plans/types/CountPlansParams.js +1 -0
- package/dist/serialization/resources/plans/types/ListPlansParams.d.ts +1 -0
- package/dist/serialization/resources/plans/types/ListPlansParams.js +1 -0
- package/dist/serialization/resources/plans/types/UpdateCompanyPlansResponse.d.ts +14 -0
- package/dist/serialization/resources/plans/types/UpdateCompanyPlansResponse.js +35 -0
- package/dist/serialization/resources/plans/types/index.d.ts +1 -0
- package/dist/serialization/resources/plans/types/index.js +1 -0
- package/dist/serialization/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.d.ts +1 -1
- package/dist/serialization/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.js +1 -0
- package/dist/serialization/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.d.ts +1 -1
- package/dist/serialization/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.js +1 -0
- package/dist/serialization/types/BillingCouponResponseData.d.ts +27 -0
- package/dist/serialization/types/BillingCouponResponseData.js +48 -0
- package/dist/serialization/types/BillingPriceView.d.ts +1 -0
- package/dist/serialization/types/BillingPriceView.js +1 -0
- package/dist/serialization/types/BillingProductForSubscriptionResponseData.d.ts +1 -0
- package/dist/serialization/types/BillingProductForSubscriptionResponseData.js +1 -0
- package/dist/serialization/types/BillingProductPriceResponseData.d.ts +1 -0
- package/dist/serialization/types/BillingProductPriceResponseData.js +1 -0
- package/dist/serialization/types/BillingSubscriptionDiscount.d.ts +18 -0
- package/dist/serialization/types/BillingSubscriptionDiscount.js +39 -0
- package/dist/serialization/types/BillingSubscriptionDiscountView.d.ts +25 -0
- package/dist/serialization/types/BillingSubscriptionDiscountView.js +46 -0
- package/dist/serialization/types/BillingSubscriptionResponseData.d.ts +1 -0
- package/dist/serialization/types/BillingSubscriptionResponseData.js +1 -0
- package/dist/serialization/types/BillingSubscriptionView.d.ts +3 -0
- package/dist/serialization/types/BillingSubscriptionView.js +3 -0
- package/dist/serialization/types/ChangeSubscriptionInternalRequestBody.d.ts +20 -0
- package/dist/serialization/types/ChangeSubscriptionInternalRequestBody.js +41 -0
- package/dist/serialization/types/ChangeSubscriptionRequestBody.d.ts +19 -0
- package/dist/serialization/types/ChangeSubscriptionRequestBody.js +40 -0
- package/dist/serialization/types/CheckFlagResponseData.d.ts +6 -0
- package/dist/serialization/types/CheckFlagResponseData.js +6 -0
- package/dist/serialization/types/CheckFlagsResponseData.d.ts +2 -2
- package/dist/serialization/types/CheckFlagsResponseData.js +2 -2
- package/dist/serialization/types/CheckoutDataResponseData.d.ts +22 -0
- package/dist/serialization/types/CheckoutDataResponseData.js +43 -0
- package/dist/serialization/types/CompanyDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/CompanyDetailResponseData.js +2 -0
- package/dist/serialization/types/CompanyEventPeriodMetricsResponseData.d.ts +22 -0
- package/dist/serialization/types/CompanyEventPeriodMetricsResponseData.js +43 -0
- package/dist/serialization/types/CompanyOverrideResponseData.d.ts +1 -0
- package/dist/serialization/types/CompanyOverrideResponseData.js +1 -0
- package/dist/serialization/types/CompanySubscriptionResponseData.d.ts +3 -0
- package/dist/serialization/types/CompanySubscriptionResponseData.js +3 -0
- package/dist/serialization/types/ComponentHydrateResponseData.d.ts +3 -0
- package/dist/serialization/types/ComponentHydrateResponseData.js +3 -0
- package/dist/serialization/types/ComponentPreviewResponseData.d.ts +3 -0
- package/dist/serialization/types/ComponentPreviewResponseData.js +3 -0
- package/dist/serialization/types/CouponRequestBody.d.ts +19 -0
- package/dist/serialization/types/CouponRequestBody.js +40 -0
- package/dist/serialization/types/CreateEntitlementReqCommon.d.ts +0 -2
- package/dist/serialization/types/CreateEntitlementReqCommon.js +0 -2
- package/dist/serialization/types/CreateEntitlementReqCommonMetricPeriod.d.ts +1 -1
- package/dist/serialization/types/CreateEntitlementReqCommonMetricPeriod.js +1 -1
- package/dist/serialization/types/CreateOrUpdateConditionRequestBodyMetricPeriod.d.ts +1 -1
- package/dist/serialization/types/CreateOrUpdateConditionRequestBodyMetricPeriod.js +1 -1
- package/dist/serialization/types/EventBodyTrack.d.ts +1 -0
- package/dist/serialization/types/EventBodyTrack.js +1 -0
- package/dist/serialization/types/EventDetailResponseData.d.ts +1 -0
- package/dist/serialization/types/EventDetailResponseData.js +1 -0
- package/dist/serialization/types/EventResponseData.d.ts +1 -0
- package/dist/serialization/types/EventResponseData.js +1 -0
- package/dist/serialization/types/FeatureCompanyResponseData.d.ts +1 -0
- package/dist/serialization/types/FeatureCompanyResponseData.js +1 -0
- package/dist/serialization/types/FeatureUsageResponseData.d.ts +5 -0
- package/dist/serialization/types/FeatureUsageResponseData.js +5 -0
- package/dist/serialization/types/PlanEntitlementResponseData.d.ts +1 -0
- package/dist/serialization/types/PlanEntitlementResponseData.js +1 -0
- package/dist/serialization/types/PreviewSubscriptionChangeResponseData.d.ts +19 -0
- package/dist/serialization/types/PreviewSubscriptionChangeResponseData.js +40 -0
- package/dist/serialization/types/UpdateAddOnRequestBody.d.ts +13 -0
- package/dist/serialization/types/{CheckFlagOutputWithFlagKey.js → UpdateAddOnRequestBody.js} +4 -10
- package/dist/serialization/types/UpdateEntitlementReqCommon.d.ts +0 -2
- package/dist/serialization/types/UpdateEntitlementReqCommon.js +0 -2
- package/dist/serialization/types/UpdateEntitlementReqCommonMetricPeriod.d.ts +1 -1
- package/dist/serialization/types/UpdateEntitlementReqCommonMetricPeriod.js +1 -1
- package/dist/serialization/types/UpdatePayInAdvanceRequestBody.d.ts +13 -0
- package/{serialization/types/CheckFlagOutputWithFlagKey.js → dist/serialization/types/UpdatePayInAdvanceRequestBody.js} +4 -10
- package/dist/serialization/types/UsageBasedEntitlementRequestBody.d.ts +14 -0
- package/dist/serialization/types/UsageBasedEntitlementRequestBody.js +35 -0
- package/dist/serialization/types/UsageBasedEntitlementResponseData.d.ts +2 -0
- package/dist/serialization/types/UsageBasedEntitlementResponseData.js +2 -0
- package/dist/serialization/types/index.d.ts +12 -1
- package/dist/serialization/types/index.js +12 -1
- package/dist/wrapper.d.ts +49 -0
- package/dist/wrapper.js +36 -0
- package/package.json +1 -1
- package/reference.md +612 -344
- package/serialization/resources/billing/client/requests/CreateBillingPriceRequestBody.d.ts +1 -0
- package/serialization/resources/billing/client/requests/CreateBillingPriceRequestBody.js +1 -0
- package/serialization/resources/billing/client/requests/CreateBillingSubscriptionsRequestBody.d.ts +3 -0
- package/serialization/resources/billing/client/requests/CreateBillingSubscriptionsRequestBody.js +3 -0
- package/serialization/resources/billing/client/requests/CreateCouponRequestBody.d.ts +20 -0
- package/serialization/resources/billing/client/requests/CreateCouponRequestBody.js +41 -0
- package/serialization/resources/billing/client/requests/index.d.ts +1 -0
- package/serialization/resources/billing/client/requests/index.js +3 -1
- package/serialization/resources/billing/types/UpsertBillingCouponResponse.d.ts +14 -0
- package/serialization/resources/billing/types/UpsertBillingCouponResponse.js +35 -0
- package/serialization/resources/billing/types/index.d.ts +1 -0
- package/serialization/resources/billing/types/index.js +1 -0
- package/serialization/resources/checkout/client/index.d.ts +1 -0
- package/serialization/resources/checkout/client/index.js +17 -0
- package/serialization/resources/checkout/client/requests/UpdateTrialEndRequestBody.d.ts +12 -0
- package/serialization/resources/checkout/client/requests/UpdateTrialEndRequestBody.js +33 -0
- package/serialization/resources/checkout/client/requests/index.d.ts +1 -0
- package/serialization/resources/checkout/client/requests/index.js +5 -0
- package/serialization/resources/checkout/index.d.ts +2 -0
- package/serialization/resources/checkout/index.js +18 -0
- package/serialization/resources/checkout/types/CheckoutInternalResponse.d.ts +14 -0
- package/serialization/resources/checkout/types/CheckoutInternalResponse.js +35 -0
- package/serialization/resources/checkout/types/GetCheckoutDataResponse.d.ts +14 -0
- package/serialization/resources/checkout/types/GetCheckoutDataResponse.js +35 -0
- package/serialization/resources/checkout/types/PreviewCheckoutInternalResponse.d.ts +14 -0
- package/serialization/resources/checkout/types/PreviewCheckoutInternalResponse.js +35 -0
- package/serialization/resources/checkout/types/UpdateCustomerSubscriptionTrialEndResponse.d.ts +14 -0
- package/serialization/resources/checkout/types/UpdateCustomerSubscriptionTrialEndResponse.js +35 -0
- package/serialization/resources/checkout/types/index.d.ts +4 -0
- package/serialization/resources/checkout/types/index.js +20 -0
- package/serialization/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +0 -2
- package/serialization/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.js +0 -2
- package/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +0 -2
- package/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.js +0 -2
- package/serialization/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +0 -2
- package/serialization/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.js +0 -2
- package/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +3 -2
- package/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.js +3 -2
- package/serialization/resources/entitlements/types/CountCompanyOverridesParams.d.ts +1 -0
- package/serialization/resources/entitlements/types/CountCompanyOverridesParams.js +1 -0
- package/serialization/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriod.d.ts +1 -1
- package/serialization/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriod.js +1 -1
- package/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriod.d.ts +1 -1
- package/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriod.js +1 -1
- package/serialization/resources/entitlements/types/ListCompanyOverridesParams.d.ts +1 -0
- package/serialization/resources/entitlements/types/ListCompanyOverridesParams.js +1 -0
- package/serialization/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriod.d.ts +1 -1
- package/serialization/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriod.js +1 -1
- package/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriod.d.ts +1 -1
- package/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriod.js +1 -1
- package/serialization/resources/events/types/index.d.ts +0 -1
- package/serialization/resources/events/types/index.js +0 -1
- package/serialization/resources/index.d.ts +6 -3
- package/serialization/resources/index.js +7 -4
- package/serialization/resources/plans/client/requests/UpdateCompanyPlansRequestBody.d.ts +13 -0
- package/serialization/resources/plans/client/requests/UpdateCompanyPlansRequestBody.js +34 -0
- package/serialization/resources/plans/client/requests/index.d.ts +1 -0
- package/serialization/resources/plans/client/requests/index.js +3 -1
- package/serialization/resources/plans/types/CountPlansParams.d.ts +1 -0
- package/serialization/resources/plans/types/CountPlansParams.js +1 -0
- package/serialization/resources/plans/types/ListPlansParams.d.ts +1 -0
- package/serialization/resources/plans/types/ListPlansParams.js +1 -0
- package/serialization/resources/plans/types/UpdateCompanyPlansResponse.d.ts +14 -0
- package/serialization/resources/plans/types/UpdateCompanyPlansResponse.js +35 -0
- package/serialization/resources/plans/types/index.d.ts +1 -0
- package/serialization/resources/plans/types/index.js +1 -0
- package/serialization/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.d.ts +1 -1
- package/serialization/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.js +1 -0
- package/serialization/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.d.ts +1 -1
- package/serialization/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.js +1 -0
- package/serialization/types/BillingCouponResponseData.d.ts +27 -0
- package/serialization/types/BillingCouponResponseData.js +48 -0
- package/serialization/types/BillingPriceView.d.ts +1 -0
- package/serialization/types/BillingPriceView.js +1 -0
- package/serialization/types/BillingProductForSubscriptionResponseData.d.ts +1 -0
- package/serialization/types/BillingProductForSubscriptionResponseData.js +1 -0
- package/serialization/types/BillingProductPriceResponseData.d.ts +1 -0
- package/serialization/types/BillingProductPriceResponseData.js +1 -0
- package/serialization/types/BillingSubscriptionDiscount.d.ts +18 -0
- package/serialization/types/BillingSubscriptionDiscount.js +39 -0
- package/serialization/types/BillingSubscriptionDiscountView.d.ts +25 -0
- package/serialization/types/BillingSubscriptionDiscountView.js +46 -0
- package/serialization/types/BillingSubscriptionResponseData.d.ts +1 -0
- package/serialization/types/BillingSubscriptionResponseData.js +1 -0
- package/serialization/types/BillingSubscriptionView.d.ts +3 -0
- package/serialization/types/BillingSubscriptionView.js +3 -0
- package/serialization/types/ChangeSubscriptionInternalRequestBody.d.ts +20 -0
- package/serialization/types/ChangeSubscriptionInternalRequestBody.js +41 -0
- package/serialization/types/ChangeSubscriptionRequestBody.d.ts +19 -0
- package/serialization/types/ChangeSubscriptionRequestBody.js +40 -0
- package/serialization/types/CheckFlagResponseData.d.ts +6 -0
- package/serialization/types/CheckFlagResponseData.js +6 -0
- package/serialization/types/CheckFlagsResponseData.d.ts +2 -2
- package/serialization/types/CheckFlagsResponseData.js +2 -2
- package/serialization/types/CheckoutDataResponseData.d.ts +22 -0
- package/serialization/types/CheckoutDataResponseData.js +43 -0
- package/serialization/types/CompanyDetailResponseData.d.ts +2 -0
- package/serialization/types/CompanyDetailResponseData.js +2 -0
- package/serialization/types/CompanyEventPeriodMetricsResponseData.d.ts +22 -0
- package/serialization/types/CompanyEventPeriodMetricsResponseData.js +43 -0
- package/serialization/types/CompanyOverrideResponseData.d.ts +1 -0
- package/serialization/types/CompanyOverrideResponseData.js +1 -0
- package/serialization/types/CompanySubscriptionResponseData.d.ts +3 -0
- package/serialization/types/CompanySubscriptionResponseData.js +3 -0
- package/serialization/types/ComponentHydrateResponseData.d.ts +3 -0
- package/serialization/types/ComponentHydrateResponseData.js +3 -0
- package/serialization/types/ComponentPreviewResponseData.d.ts +3 -0
- package/serialization/types/ComponentPreviewResponseData.js +3 -0
- package/serialization/types/CouponRequestBody.d.ts +19 -0
- package/serialization/types/CouponRequestBody.js +40 -0
- package/serialization/types/CreateEntitlementReqCommon.d.ts +0 -2
- package/serialization/types/CreateEntitlementReqCommon.js +0 -2
- package/serialization/types/CreateEntitlementReqCommonMetricPeriod.d.ts +1 -1
- package/serialization/types/CreateEntitlementReqCommonMetricPeriod.js +1 -1
- package/serialization/types/CreateOrUpdateConditionRequestBodyMetricPeriod.d.ts +1 -1
- package/serialization/types/CreateOrUpdateConditionRequestBodyMetricPeriod.js +1 -1
- package/serialization/types/EventBodyTrack.d.ts +1 -0
- package/serialization/types/EventBodyTrack.js +1 -0
- package/serialization/types/EventDetailResponseData.d.ts +1 -0
- package/serialization/types/EventDetailResponseData.js +1 -0
- package/serialization/types/EventResponseData.d.ts +1 -0
- package/serialization/types/EventResponseData.js +1 -0
- package/serialization/types/FeatureCompanyResponseData.d.ts +1 -0
- package/serialization/types/FeatureCompanyResponseData.js +1 -0
- package/serialization/types/FeatureUsageResponseData.d.ts +5 -0
- package/serialization/types/FeatureUsageResponseData.js +5 -0
- package/serialization/types/PlanEntitlementResponseData.d.ts +1 -0
- package/serialization/types/PlanEntitlementResponseData.js +1 -0
- package/serialization/types/PreviewSubscriptionChangeResponseData.d.ts +19 -0
- package/serialization/types/PreviewSubscriptionChangeResponseData.js +40 -0
- package/serialization/types/UpdateAddOnRequestBody.d.ts +13 -0
- package/serialization/types/UpdateAddOnRequestBody.js +34 -0
- package/serialization/types/UpdateEntitlementReqCommon.d.ts +0 -2
- package/serialization/types/UpdateEntitlementReqCommon.js +0 -2
- package/serialization/types/UpdateEntitlementReqCommonMetricPeriod.d.ts +1 -1
- package/serialization/types/UpdateEntitlementReqCommonMetricPeriod.js +1 -1
- package/serialization/types/UpdatePayInAdvanceRequestBody.d.ts +13 -0
- package/serialization/types/UpdatePayInAdvanceRequestBody.js +34 -0
- package/serialization/types/UsageBasedEntitlementRequestBody.d.ts +14 -0
- package/serialization/types/UsageBasedEntitlementRequestBody.js +35 -0
- package/serialization/types/UsageBasedEntitlementResponseData.d.ts +2 -0
- package/serialization/types/UsageBasedEntitlementResponseData.js +2 -0
- package/serialization/types/index.d.ts +12 -1
- package/serialization/types/index.js +12 -1
- package/wrapper.d.ts +49 -0
- package/wrapper.js +36 -0
- package/api/types/CheckFlagOutputWithFlagKey.d.ts +0 -13
- package/dist/api/types/CheckFlagOutputWithFlagKey.d.ts +0 -13
- package/dist/serialization/resources/events/types/GetEventSummaryBySubtypeResponse.d.ts +0 -14
- package/dist/serialization/types/CheckFlagOutputWithFlagKey.d.ts +0 -19
- package/serialization/resources/events/types/GetEventSummaryBySubtypeResponse.d.ts +0 -14
- package/serialization/types/CheckFlagOutputWithFlagKey.d.ts +0 -19
- /package/api/resources/{events/types/GetEventSummaryBySubtypeResponse.js → billing/client/requests/CreateCouponRequestBody.js} +0 -0
- /package/api/{types/CheckFlagOutputWithFlagKey.js → resources/billing/types/UpsertBillingCouponResponse.js} +0 -0
- /package/{dist/api/resources/events/types/GetEventSummaryBySubtypeResponse.js → api/resources/checkout/client/requests/UpdateTrialEndRequestBody.js} +0 -0
- /package/{dist/api/types/CheckFlagOutputWithFlagKey.js → api/resources/checkout/types/CheckoutInternalResponse.js} +0 -0
package/reference.md
CHANGED
|
@@ -1,47 +1,5 @@
|
|
|
1
1
|
# Reference
|
|
2
2
|
|
|
3
|
-
<details><summary><code>client.<a href="/src/Client.ts">getCompanyPlans</a>() -> void</code></summary>
|
|
4
|
-
<dl>
|
|
5
|
-
<dd>
|
|
6
|
-
|
|
7
|
-
#### 🔌 Usage
|
|
8
|
-
|
|
9
|
-
<dl>
|
|
10
|
-
<dd>
|
|
11
|
-
|
|
12
|
-
<dl>
|
|
13
|
-
<dd>
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
await client.getCompanyPlans();
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
</dd>
|
|
20
|
-
</dl>
|
|
21
|
-
</dd>
|
|
22
|
-
</dl>
|
|
23
|
-
|
|
24
|
-
#### ⚙️ Parameters
|
|
25
|
-
|
|
26
|
-
<dl>
|
|
27
|
-
<dd>
|
|
28
|
-
|
|
29
|
-
<dl>
|
|
30
|
-
<dd>
|
|
31
|
-
|
|
32
|
-
**requestOptions:** `SchematicClient.RequestOptions`
|
|
33
|
-
|
|
34
|
-
</dd>
|
|
35
|
-
</dl>
|
|
36
|
-
</dd>
|
|
37
|
-
</dl>
|
|
38
|
-
|
|
39
|
-
</dd>
|
|
40
|
-
</dl>
|
|
41
|
-
</details>
|
|
42
|
-
|
|
43
|
-
##
|
|
44
|
-
|
|
45
3
|
## accounts
|
|
46
4
|
|
|
47
5
|
<details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">listApiKeys</a>({ ...params }) -> Schematic.ListApiKeysResponse</code></summary>
|
|
@@ -1807,6 +1765,63 @@ await client.features.countFlags();
|
|
|
1807
1765
|
|
|
1808
1766
|
## billing
|
|
1809
1767
|
|
|
1768
|
+
<details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">upsertBillingCoupon</a>({ ...params }) -> Schematic.UpsertBillingCouponResponse</code></summary>
|
|
1769
|
+
<dl>
|
|
1770
|
+
<dd>
|
|
1771
|
+
|
|
1772
|
+
#### 🔌 Usage
|
|
1773
|
+
|
|
1774
|
+
<dl>
|
|
1775
|
+
<dd>
|
|
1776
|
+
|
|
1777
|
+
<dl>
|
|
1778
|
+
<dd>
|
|
1779
|
+
|
|
1780
|
+
```typescript
|
|
1781
|
+
await client.billing.upsertBillingCoupon({
|
|
1782
|
+
amountOff: 1,
|
|
1783
|
+
duration: "duration",
|
|
1784
|
+
durationInMonths: 1,
|
|
1785
|
+
externalId: "external_id",
|
|
1786
|
+
maxRedemptions: 1,
|
|
1787
|
+
name: "name",
|
|
1788
|
+
percentOff: 1.1,
|
|
1789
|
+
timesRedeemed: 1,
|
|
1790
|
+
});
|
|
1791
|
+
```
|
|
1792
|
+
|
|
1793
|
+
</dd>
|
|
1794
|
+
</dl>
|
|
1795
|
+
</dd>
|
|
1796
|
+
</dl>
|
|
1797
|
+
|
|
1798
|
+
#### ⚙️ Parameters
|
|
1799
|
+
|
|
1800
|
+
<dl>
|
|
1801
|
+
<dd>
|
|
1802
|
+
|
|
1803
|
+
<dl>
|
|
1804
|
+
<dd>
|
|
1805
|
+
|
|
1806
|
+
**request:** `Schematic.CreateCouponRequestBody`
|
|
1807
|
+
|
|
1808
|
+
</dd>
|
|
1809
|
+
</dl>
|
|
1810
|
+
|
|
1811
|
+
<dl>
|
|
1812
|
+
<dd>
|
|
1813
|
+
|
|
1814
|
+
**requestOptions:** `Billing.RequestOptions`
|
|
1815
|
+
|
|
1816
|
+
</dd>
|
|
1817
|
+
</dl>
|
|
1818
|
+
</dd>
|
|
1819
|
+
</dl>
|
|
1820
|
+
|
|
1821
|
+
</dd>
|
|
1822
|
+
</dl>
|
|
1823
|
+
</details>
|
|
1824
|
+
|
|
1810
1825
|
<details><summary><code>client.billing.<a href="/src/api/resources/billing/client/Client.ts">upsertBillingCustomer</a>({ ...params }) -> Schematic.UpsertBillingCustomerResponse</code></summary>
|
|
1811
1826
|
<dl>
|
|
1812
1827
|
<dd>
|
|
@@ -2332,6 +2347,7 @@ await client.billing.searchBillingPrices();
|
|
|
2332
2347
|
await client.billing.upsertBillingPrice({
|
|
2333
2348
|
currency: "currency",
|
|
2334
2349
|
interval: "interval",
|
|
2350
|
+
isActive: true,
|
|
2335
2351
|
price: 1,
|
|
2336
2352
|
priceExternalId: "price_external_id",
|
|
2337
2353
|
productExternalId: "product_external_id",
|
|
@@ -2633,6 +2649,14 @@ await client.billing.countBillingProducts();
|
|
|
2633
2649
|
await client.billing.upsertBillingSubscription({
|
|
2634
2650
|
currency: "currency",
|
|
2635
2651
|
customerExternalId: "customer_external_id",
|
|
2652
|
+
discounts: [
|
|
2653
|
+
{
|
|
2654
|
+
couponExternalId: "coupon_external_id",
|
|
2655
|
+
externalId: "external_id",
|
|
2656
|
+
isActive: true,
|
|
2657
|
+
startedAt: "2024-01-15T09:30:00Z",
|
|
2658
|
+
},
|
|
2659
|
+
],
|
|
2636
2660
|
expiredAt: "2024-01-15T09:30:00Z",
|
|
2637
2661
|
productExternalIds: [
|
|
2638
2662
|
{
|
|
@@ -2682,9 +2706,9 @@ await client.billing.upsertBillingSubscription({
|
|
|
2682
2706
|
</dl>
|
|
2683
2707
|
</details>
|
|
2684
2708
|
|
|
2685
|
-
##
|
|
2709
|
+
## checkout
|
|
2686
2710
|
|
|
2687
|
-
<details><summary><code>client.
|
|
2711
|
+
<details><summary><code>client.checkout.<a href="/src/api/resources/checkout/client/Client.ts">internal</a>({ ...params }) -> Schematic.CheckoutInternalResponse</code></summary>
|
|
2688
2712
|
<dl>
|
|
2689
2713
|
<dd>
|
|
2690
2714
|
|
|
@@ -2697,7 +2721,23 @@ await client.billing.upsertBillingSubscription({
|
|
|
2697
2721
|
<dd>
|
|
2698
2722
|
|
|
2699
2723
|
```typescript
|
|
2700
|
-
await client.
|
|
2724
|
+
await client.checkout.internal({
|
|
2725
|
+
addOnIds: [
|
|
2726
|
+
{
|
|
2727
|
+
addOnId: "add_on_id",
|
|
2728
|
+
priceId: "price_id",
|
|
2729
|
+
},
|
|
2730
|
+
],
|
|
2731
|
+
companyId: "company_id",
|
|
2732
|
+
newPlanId: "new_plan_id",
|
|
2733
|
+
newPriceId: "new_price_id",
|
|
2734
|
+
payInAdvance: [
|
|
2735
|
+
{
|
|
2736
|
+
priceId: "price_id",
|
|
2737
|
+
quantity: 1,
|
|
2738
|
+
},
|
|
2739
|
+
],
|
|
2740
|
+
});
|
|
2701
2741
|
```
|
|
2702
2742
|
|
|
2703
2743
|
</dd>
|
|
@@ -2713,7 +2753,7 @@ await client.companies.listCompanies();
|
|
|
2713
2753
|
<dl>
|
|
2714
2754
|
<dd>
|
|
2715
2755
|
|
|
2716
|
-
**request:** `Schematic.
|
|
2756
|
+
**request:** `Schematic.ChangeSubscriptionInternalRequestBody`
|
|
2717
2757
|
|
|
2718
2758
|
</dd>
|
|
2719
2759
|
</dl>
|
|
@@ -2721,7 +2761,7 @@ await client.companies.listCompanies();
|
|
|
2721
2761
|
<dl>
|
|
2722
2762
|
<dd>
|
|
2723
2763
|
|
|
2724
|
-
**requestOptions:** `
|
|
2764
|
+
**requestOptions:** `Checkout.RequestOptions`
|
|
2725
2765
|
|
|
2726
2766
|
</dd>
|
|
2727
2767
|
</dl>
|
|
@@ -2732,7 +2772,7 @@ await client.companies.listCompanies();
|
|
|
2732
2772
|
</dl>
|
|
2733
2773
|
</details>
|
|
2734
2774
|
|
|
2735
|
-
<details><summary><code>client.
|
|
2775
|
+
<details><summary><code>client.checkout.<a href="/src/api/resources/checkout/client/Client.ts">getCheckoutData</a>(checkoutInternalId) -> Schematic.GetCheckoutDataResponse</code></summary>
|
|
2736
2776
|
<dl>
|
|
2737
2777
|
<dd>
|
|
2738
2778
|
|
|
@@ -2745,11 +2785,7 @@ await client.companies.listCompanies();
|
|
|
2745
2785
|
<dd>
|
|
2746
2786
|
|
|
2747
2787
|
```typescript
|
|
2748
|
-
await client.
|
|
2749
|
-
keys: {
|
|
2750
|
-
key: "value",
|
|
2751
|
-
},
|
|
2752
|
-
});
|
|
2788
|
+
await client.checkout.getCheckoutData("checkout_internal_id");
|
|
2753
2789
|
```
|
|
2754
2790
|
|
|
2755
2791
|
</dd>
|
|
@@ -2765,7 +2801,7 @@ await client.companies.upsertCompany({
|
|
|
2765
2801
|
<dl>
|
|
2766
2802
|
<dd>
|
|
2767
2803
|
|
|
2768
|
-
**
|
|
2804
|
+
**checkoutInternalId:** `string` — checkout_internal_id
|
|
2769
2805
|
|
|
2770
2806
|
</dd>
|
|
2771
2807
|
</dl>
|
|
@@ -2773,7 +2809,7 @@ await client.companies.upsertCompany({
|
|
|
2773
2809
|
<dl>
|
|
2774
2810
|
<dd>
|
|
2775
2811
|
|
|
2776
|
-
**requestOptions:** `
|
|
2812
|
+
**requestOptions:** `Checkout.RequestOptions`
|
|
2777
2813
|
|
|
2778
2814
|
</dd>
|
|
2779
2815
|
</dl>
|
|
@@ -2784,7 +2820,7 @@ await client.companies.upsertCompany({
|
|
|
2784
2820
|
</dl>
|
|
2785
2821
|
</details>
|
|
2786
2822
|
|
|
2787
|
-
<details><summary><code>client.
|
|
2823
|
+
<details><summary><code>client.checkout.<a href="/src/api/resources/checkout/client/Client.ts">previewCheckoutInternal</a>({ ...params }) -> Schematic.PreviewCheckoutInternalResponse</code></summary>
|
|
2788
2824
|
<dl>
|
|
2789
2825
|
<dd>
|
|
2790
2826
|
|
|
@@ -2797,7 +2833,23 @@ await client.companies.upsertCompany({
|
|
|
2797
2833
|
<dd>
|
|
2798
2834
|
|
|
2799
2835
|
```typescript
|
|
2800
|
-
await client.
|
|
2836
|
+
await client.checkout.previewCheckoutInternal({
|
|
2837
|
+
addOnIds: [
|
|
2838
|
+
{
|
|
2839
|
+
addOnId: "add_on_id",
|
|
2840
|
+
priceId: "price_id",
|
|
2841
|
+
},
|
|
2842
|
+
],
|
|
2843
|
+
companyId: "company_id",
|
|
2844
|
+
newPlanId: "new_plan_id",
|
|
2845
|
+
newPriceId: "new_price_id",
|
|
2846
|
+
payInAdvance: [
|
|
2847
|
+
{
|
|
2848
|
+
priceId: "price_id",
|
|
2849
|
+
quantity: 1,
|
|
2850
|
+
},
|
|
2851
|
+
],
|
|
2852
|
+
});
|
|
2801
2853
|
```
|
|
2802
2854
|
|
|
2803
2855
|
</dd>
|
|
@@ -2813,7 +2865,7 @@ await client.companies.getCompany("company_id");
|
|
|
2813
2865
|
<dl>
|
|
2814
2866
|
<dd>
|
|
2815
2867
|
|
|
2816
|
-
**
|
|
2868
|
+
**request:** `Schematic.ChangeSubscriptionInternalRequestBody`
|
|
2817
2869
|
|
|
2818
2870
|
</dd>
|
|
2819
2871
|
</dl>
|
|
@@ -2821,7 +2873,7 @@ await client.companies.getCompany("company_id");
|
|
|
2821
2873
|
<dl>
|
|
2822
2874
|
<dd>
|
|
2823
2875
|
|
|
2824
|
-
**requestOptions:** `
|
|
2876
|
+
**requestOptions:** `Checkout.RequestOptions`
|
|
2825
2877
|
|
|
2826
2878
|
</dd>
|
|
2827
2879
|
</dl>
|
|
@@ -2832,7 +2884,7 @@ await client.companies.getCompany("company_id");
|
|
|
2832
2884
|
</dl>
|
|
2833
2885
|
</details>
|
|
2834
2886
|
|
|
2835
|
-
<details><summary><code>client.
|
|
2887
|
+
<details><summary><code>client.checkout.<a href="/src/api/resources/checkout/client/Client.ts">updateCustomerSubscriptionTrialEnd</a>(subscriptionId, { ...params }) -> Schematic.UpdateCustomerSubscriptionTrialEndResponse</code></summary>
|
|
2836
2888
|
<dl>
|
|
2837
2889
|
<dd>
|
|
2838
2890
|
|
|
@@ -2845,7 +2897,7 @@ await client.companies.getCompany("company_id");
|
|
|
2845
2897
|
<dd>
|
|
2846
2898
|
|
|
2847
2899
|
```typescript
|
|
2848
|
-
await client.
|
|
2900
|
+
await client.checkout.updateCustomerSubscriptionTrialEnd("subscription_id");
|
|
2849
2901
|
```
|
|
2850
2902
|
|
|
2851
2903
|
</dd>
|
|
@@ -2861,7 +2913,7 @@ await client.companies.deleteCompany("company_id");
|
|
|
2861
2913
|
<dl>
|
|
2862
2914
|
<dd>
|
|
2863
2915
|
|
|
2864
|
-
**
|
|
2916
|
+
**subscriptionId:** `string` — subscription_id
|
|
2865
2917
|
|
|
2866
2918
|
</dd>
|
|
2867
2919
|
</dl>
|
|
@@ -2869,7 +2921,15 @@ await client.companies.deleteCompany("company_id");
|
|
|
2869
2921
|
<dl>
|
|
2870
2922
|
<dd>
|
|
2871
2923
|
|
|
2872
|
-
**
|
|
2924
|
+
**request:** `Schematic.UpdateTrialEndRequestBody`
|
|
2925
|
+
|
|
2926
|
+
</dd>
|
|
2927
|
+
</dl>
|
|
2928
|
+
|
|
2929
|
+
<dl>
|
|
2930
|
+
<dd>
|
|
2931
|
+
|
|
2932
|
+
**requestOptions:** `Checkout.RequestOptions`
|
|
2873
2933
|
|
|
2874
2934
|
</dd>
|
|
2875
2935
|
</dl>
|
|
@@ -2880,7 +2940,9 @@ await client.companies.deleteCompany("company_id");
|
|
|
2880
2940
|
</dl>
|
|
2881
2941
|
</details>
|
|
2882
2942
|
|
|
2883
|
-
|
|
2943
|
+
## companies
|
|
2944
|
+
|
|
2945
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">listCompanies</a>({ ...params }) -> Schematic.ListCompaniesResponse</code></summary>
|
|
2884
2946
|
<dl>
|
|
2885
2947
|
<dd>
|
|
2886
2948
|
|
|
@@ -2893,7 +2955,7 @@ await client.companies.deleteCompany("company_id");
|
|
|
2893
2955
|
<dd>
|
|
2894
2956
|
|
|
2895
2957
|
```typescript
|
|
2896
|
-
await client.companies.
|
|
2958
|
+
await client.companies.listCompanies();
|
|
2897
2959
|
```
|
|
2898
2960
|
|
|
2899
2961
|
</dd>
|
|
@@ -2909,7 +2971,7 @@ await client.companies.countCompanies();
|
|
|
2909
2971
|
<dl>
|
|
2910
2972
|
<dd>
|
|
2911
2973
|
|
|
2912
|
-
**request:** `Schematic.
|
|
2974
|
+
**request:** `Schematic.ListCompaniesRequest`
|
|
2913
2975
|
|
|
2914
2976
|
</dd>
|
|
2915
2977
|
</dl>
|
|
@@ -2928,7 +2990,7 @@ await client.companies.countCompanies();
|
|
|
2928
2990
|
</dl>
|
|
2929
2991
|
</details>
|
|
2930
2992
|
|
|
2931
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
2993
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">upsertCompany</a>({ ...params }) -> Schematic.UpsertCompanyResponse</code></summary>
|
|
2932
2994
|
<dl>
|
|
2933
2995
|
<dd>
|
|
2934
2996
|
|
|
@@ -2941,7 +3003,7 @@ await client.companies.countCompanies();
|
|
|
2941
3003
|
<dd>
|
|
2942
3004
|
|
|
2943
3005
|
```typescript
|
|
2944
|
-
await client.companies.
|
|
3006
|
+
await client.companies.upsertCompany({
|
|
2945
3007
|
keys: {
|
|
2946
3008
|
key: "value",
|
|
2947
3009
|
},
|
|
@@ -2980,7 +3042,7 @@ await client.companies.createCompany({
|
|
|
2980
3042
|
</dl>
|
|
2981
3043
|
</details>
|
|
2982
3044
|
|
|
2983
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
3045
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">getCompany</a>(companyId) -> Schematic.GetCompanyResponse</code></summary>
|
|
2984
3046
|
<dl>
|
|
2985
3047
|
<dd>
|
|
2986
3048
|
|
|
@@ -2993,11 +3055,7 @@ await client.companies.createCompany({
|
|
|
2993
3055
|
<dd>
|
|
2994
3056
|
|
|
2995
3057
|
```typescript
|
|
2996
|
-
await client.companies.
|
|
2997
|
-
keys: {
|
|
2998
|
-
key: "value",
|
|
2999
|
-
},
|
|
3000
|
-
});
|
|
3058
|
+
await client.companies.getCompany("company_id");
|
|
3001
3059
|
```
|
|
3002
3060
|
|
|
3003
3061
|
</dd>
|
|
@@ -3013,7 +3071,7 @@ await client.companies.deleteCompanyByKeys({
|
|
|
3013
3071
|
<dl>
|
|
3014
3072
|
<dd>
|
|
3015
3073
|
|
|
3016
|
-
**
|
|
3074
|
+
**companyId:** `string` — company_id
|
|
3017
3075
|
|
|
3018
3076
|
</dd>
|
|
3019
3077
|
</dl>
|
|
@@ -3032,7 +3090,7 @@ await client.companies.deleteCompanyByKeys({
|
|
|
3032
3090
|
</dl>
|
|
3033
3091
|
</details>
|
|
3034
3092
|
|
|
3035
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
3093
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">deleteCompany</a>(companyId) -> Schematic.DeleteCompanyResponse</code></summary>
|
|
3036
3094
|
<dl>
|
|
3037
3095
|
<dd>
|
|
3038
3096
|
|
|
@@ -3045,13 +3103,7 @@ await client.companies.deleteCompanyByKeys({
|
|
|
3045
3103
|
<dd>
|
|
3046
3104
|
|
|
3047
3105
|
```typescript
|
|
3048
|
-
await client.companies.
|
|
3049
|
-
keys: {
|
|
3050
|
-
keys: {
|
|
3051
|
-
key: "value",
|
|
3052
|
-
},
|
|
3053
|
-
},
|
|
3054
|
-
});
|
|
3106
|
+
await client.companies.deleteCompany("company_id");
|
|
3055
3107
|
```
|
|
3056
3108
|
|
|
3057
3109
|
</dd>
|
|
@@ -3067,7 +3119,7 @@ await client.companies.lookupCompany({
|
|
|
3067
3119
|
<dl>
|
|
3068
3120
|
<dd>
|
|
3069
3121
|
|
|
3070
|
-
**
|
|
3122
|
+
**companyId:** `string` — company_id
|
|
3071
3123
|
|
|
3072
3124
|
</dd>
|
|
3073
3125
|
</dl>
|
|
@@ -3086,7 +3138,7 @@ await client.companies.lookupCompany({
|
|
|
3086
3138
|
</dl>
|
|
3087
3139
|
</details>
|
|
3088
3140
|
|
|
3089
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
3141
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">countCompanies</a>({ ...params }) -> Schematic.CountCompaniesResponse</code></summary>
|
|
3090
3142
|
<dl>
|
|
3091
3143
|
<dd>
|
|
3092
3144
|
|
|
@@ -3099,10 +3151,7 @@ await client.companies.lookupCompany({
|
|
|
3099
3151
|
<dd>
|
|
3100
3152
|
|
|
3101
3153
|
```typescript
|
|
3102
|
-
await client.companies.
|
|
3103
|
-
companyId: "company_id",
|
|
3104
|
-
dealStage: "deal_stage",
|
|
3105
|
-
});
|
|
3154
|
+
await client.companies.countCompanies();
|
|
3106
3155
|
```
|
|
3107
3156
|
|
|
3108
3157
|
</dd>
|
|
@@ -3118,7 +3167,7 @@ await client.companies.getActiveDeals({
|
|
|
3118
3167
|
<dl>
|
|
3119
3168
|
<dd>
|
|
3120
3169
|
|
|
3121
|
-
**request:** `Schematic.
|
|
3170
|
+
**request:** `Schematic.CountCompaniesRequest`
|
|
3122
3171
|
|
|
3123
3172
|
</dd>
|
|
3124
3173
|
</dl>
|
|
@@ -3137,7 +3186,7 @@ await client.companies.getActiveDeals({
|
|
|
3137
3186
|
</dl>
|
|
3138
3187
|
</details>
|
|
3139
3188
|
|
|
3140
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
3189
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">createCompany</a>({ ...params }) -> Schematic.CreateCompanyResponse</code></summary>
|
|
3141
3190
|
<dl>
|
|
3142
3191
|
<dd>
|
|
3143
3192
|
|
|
@@ -3150,7 +3199,11 @@ await client.companies.getActiveDeals({
|
|
|
3150
3199
|
<dd>
|
|
3151
3200
|
|
|
3152
3201
|
```typescript
|
|
3153
|
-
await client.companies.
|
|
3202
|
+
await client.companies.createCompany({
|
|
3203
|
+
keys: {
|
|
3204
|
+
key: "value",
|
|
3205
|
+
},
|
|
3206
|
+
});
|
|
3154
3207
|
```
|
|
3155
3208
|
|
|
3156
3209
|
</dd>
|
|
@@ -3166,7 +3219,7 @@ await client.companies.listCompanyMemberships();
|
|
|
3166
3219
|
<dl>
|
|
3167
3220
|
<dd>
|
|
3168
3221
|
|
|
3169
|
-
**request:** `Schematic.
|
|
3222
|
+
**request:** `Schematic.UpsertCompanyRequestBody`
|
|
3170
3223
|
|
|
3171
3224
|
</dd>
|
|
3172
3225
|
</dl>
|
|
@@ -3185,7 +3238,7 @@ await client.companies.listCompanyMemberships();
|
|
|
3185
3238
|
</dl>
|
|
3186
3239
|
</details>
|
|
3187
3240
|
|
|
3188
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
3241
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">deleteCompanyByKeys</a>({ ...params }) -> Schematic.DeleteCompanyByKeysResponse</code></summary>
|
|
3189
3242
|
<dl>
|
|
3190
3243
|
<dd>
|
|
3191
3244
|
|
|
@@ -3198,9 +3251,10 @@ await client.companies.listCompanyMemberships();
|
|
|
3198
3251
|
<dd>
|
|
3199
3252
|
|
|
3200
3253
|
```typescript
|
|
3201
|
-
await client.companies.
|
|
3202
|
-
|
|
3203
|
-
|
|
3254
|
+
await client.companies.deleteCompanyByKeys({
|
|
3255
|
+
keys: {
|
|
3256
|
+
key: "value",
|
|
3257
|
+
},
|
|
3204
3258
|
});
|
|
3205
3259
|
```
|
|
3206
3260
|
|
|
@@ -3217,7 +3271,7 @@ await client.companies.getOrCreateCompanyMembership({
|
|
|
3217
3271
|
<dl>
|
|
3218
3272
|
<dd>
|
|
3219
3273
|
|
|
3220
|
-
**request:** `Schematic.
|
|
3274
|
+
**request:** `Schematic.KeysRequestBody`
|
|
3221
3275
|
|
|
3222
3276
|
</dd>
|
|
3223
3277
|
</dl>
|
|
@@ -3236,7 +3290,7 @@ await client.companies.getOrCreateCompanyMembership({
|
|
|
3236
3290
|
</dl>
|
|
3237
3291
|
</details>
|
|
3238
3292
|
|
|
3239
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
3293
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">lookupCompany</a>({ ...params }) -> Schematic.LookupCompanyResponse</code></summary>
|
|
3240
3294
|
<dl>
|
|
3241
3295
|
<dd>
|
|
3242
3296
|
|
|
@@ -3249,7 +3303,13 @@ await client.companies.getOrCreateCompanyMembership({
|
|
|
3249
3303
|
<dd>
|
|
3250
3304
|
|
|
3251
3305
|
```typescript
|
|
3252
|
-
await client.companies.
|
|
3306
|
+
await client.companies.lookupCompany({
|
|
3307
|
+
keys: {
|
|
3308
|
+
keys: {
|
|
3309
|
+
key: "value",
|
|
3310
|
+
},
|
|
3311
|
+
},
|
|
3312
|
+
});
|
|
3253
3313
|
```
|
|
3254
3314
|
|
|
3255
3315
|
</dd>
|
|
@@ -3265,7 +3325,7 @@ await client.companies.deleteCompanyMembership("company_membership_id");
|
|
|
3265
3325
|
<dl>
|
|
3266
3326
|
<dd>
|
|
3267
3327
|
|
|
3268
|
-
**
|
|
3328
|
+
**request:** `Schematic.LookupCompanyRequest`
|
|
3269
3329
|
|
|
3270
3330
|
</dd>
|
|
3271
3331
|
</dl>
|
|
@@ -3284,7 +3344,7 @@ await client.companies.deleteCompanyMembership("company_membership_id");
|
|
|
3284
3344
|
</dl>
|
|
3285
3345
|
</details>
|
|
3286
3346
|
|
|
3287
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
3347
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">getActiveDeals</a>({ ...params }) -> Schematic.GetActiveDealsResponse</code></summary>
|
|
3288
3348
|
<dl>
|
|
3289
3349
|
<dd>
|
|
3290
3350
|
|
|
@@ -3297,7 +3357,10 @@ await client.companies.deleteCompanyMembership("company_membership_id");
|
|
|
3297
3357
|
<dd>
|
|
3298
3358
|
|
|
3299
3359
|
```typescript
|
|
3300
|
-
await client.companies.
|
|
3360
|
+
await client.companies.getActiveDeals({
|
|
3361
|
+
companyId: "company_id",
|
|
3362
|
+
dealStage: "deal_stage",
|
|
3363
|
+
});
|
|
3301
3364
|
```
|
|
3302
3365
|
|
|
3303
3366
|
</dd>
|
|
@@ -3313,7 +3376,7 @@ await client.companies.getActiveCompanySubscription();
|
|
|
3313
3376
|
<dl>
|
|
3314
3377
|
<dd>
|
|
3315
3378
|
|
|
3316
|
-
**request:** `Schematic.
|
|
3379
|
+
**request:** `Schematic.GetActiveDealsRequest`
|
|
3317
3380
|
|
|
3318
3381
|
</dd>
|
|
3319
3382
|
</dl>
|
|
@@ -3332,7 +3395,7 @@ await client.companies.getActiveCompanySubscription();
|
|
|
3332
3395
|
</dl>
|
|
3333
3396
|
</details>
|
|
3334
3397
|
|
|
3335
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
3398
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">listCompanyMemberships</a>({ ...params }) -> Schematic.ListCompanyMembershipsResponse</code></summary>
|
|
3336
3399
|
<dl>
|
|
3337
3400
|
<dd>
|
|
3338
3401
|
|
|
@@ -3345,12 +3408,7 @@ await client.companies.getActiveCompanySubscription();
|
|
|
3345
3408
|
<dd>
|
|
3346
3409
|
|
|
3347
3410
|
```typescript
|
|
3348
|
-
await client.companies.
|
|
3349
|
-
keys: {
|
|
3350
|
-
key: "value",
|
|
3351
|
-
},
|
|
3352
|
-
trait: "trait",
|
|
3353
|
-
});
|
|
3411
|
+
await client.companies.listCompanyMemberships();
|
|
3354
3412
|
```
|
|
3355
3413
|
|
|
3356
3414
|
</dd>
|
|
@@ -3366,7 +3424,7 @@ await client.companies.upsertCompanyTrait({
|
|
|
3366
3424
|
<dl>
|
|
3367
3425
|
<dd>
|
|
3368
3426
|
|
|
3369
|
-
**request:** `Schematic.
|
|
3427
|
+
**request:** `Schematic.ListCompanyMembershipsRequest`
|
|
3370
3428
|
|
|
3371
3429
|
</dd>
|
|
3372
3430
|
</dl>
|
|
@@ -3385,7 +3443,7 @@ await client.companies.upsertCompanyTrait({
|
|
|
3385
3443
|
</dl>
|
|
3386
3444
|
</details>
|
|
3387
3445
|
|
|
3388
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
3446
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">getOrCreateCompanyMembership</a>({ ...params }) -> Schematic.GetOrCreateCompanyMembershipResponse</code></summary>
|
|
3389
3447
|
<dl>
|
|
3390
3448
|
<dd>
|
|
3391
3449
|
|
|
@@ -3398,7 +3456,10 @@ await client.companies.upsertCompanyTrait({
|
|
|
3398
3456
|
<dd>
|
|
3399
3457
|
|
|
3400
3458
|
```typescript
|
|
3401
|
-
await client.companies.
|
|
3459
|
+
await client.companies.getOrCreateCompanyMembership({
|
|
3460
|
+
companyId: "company_id",
|
|
3461
|
+
userId: "user_id",
|
|
3462
|
+
});
|
|
3402
3463
|
```
|
|
3403
3464
|
|
|
3404
3465
|
</dd>
|
|
@@ -3414,7 +3475,7 @@ await client.companies.listEntityKeyDefinitions();
|
|
|
3414
3475
|
<dl>
|
|
3415
3476
|
<dd>
|
|
3416
3477
|
|
|
3417
|
-
**request:** `Schematic.
|
|
3478
|
+
**request:** `Schematic.GetOrCreateCompanyMembershipRequestBody`
|
|
3418
3479
|
|
|
3419
3480
|
</dd>
|
|
3420
3481
|
</dl>
|
|
@@ -3433,7 +3494,7 @@ await client.companies.listEntityKeyDefinitions();
|
|
|
3433
3494
|
</dl>
|
|
3434
3495
|
</details>
|
|
3435
3496
|
|
|
3436
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
3497
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">deleteCompanyMembership</a>(companyMembershipId) -> Schematic.DeleteCompanyMembershipResponse</code></summary>
|
|
3437
3498
|
<dl>
|
|
3438
3499
|
<dd>
|
|
3439
3500
|
|
|
@@ -3446,7 +3507,7 @@ await client.companies.listEntityKeyDefinitions();
|
|
|
3446
3507
|
<dd>
|
|
3447
3508
|
|
|
3448
3509
|
```typescript
|
|
3449
|
-
await client.companies.
|
|
3510
|
+
await client.companies.deleteCompanyMembership("company_membership_id");
|
|
3450
3511
|
```
|
|
3451
3512
|
|
|
3452
3513
|
</dd>
|
|
@@ -3462,7 +3523,7 @@ await client.companies.countEntityKeyDefinitions();
|
|
|
3462
3523
|
<dl>
|
|
3463
3524
|
<dd>
|
|
3464
3525
|
|
|
3465
|
-
**
|
|
3526
|
+
**companyMembershipId:** `string` — company_membership_id
|
|
3466
3527
|
|
|
3467
3528
|
</dd>
|
|
3468
3529
|
</dl>
|
|
@@ -3481,7 +3542,7 @@ await client.companies.countEntityKeyDefinitions();
|
|
|
3481
3542
|
</dl>
|
|
3482
3543
|
</details>
|
|
3483
3544
|
|
|
3484
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
3545
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">getActiveCompanySubscription</a>({ ...params }) -> Schematic.GetActiveCompanySubscriptionResponse</code></summary>
|
|
3485
3546
|
<dl>
|
|
3486
3547
|
<dd>
|
|
3487
3548
|
|
|
@@ -3494,7 +3555,7 @@ await client.companies.countEntityKeyDefinitions();
|
|
|
3494
3555
|
<dd>
|
|
3495
3556
|
|
|
3496
3557
|
```typescript
|
|
3497
|
-
await client.companies.
|
|
3558
|
+
await client.companies.getActiveCompanySubscription();
|
|
3498
3559
|
```
|
|
3499
3560
|
|
|
3500
3561
|
</dd>
|
|
@@ -3510,7 +3571,7 @@ await client.companies.listEntityTraitDefinitions();
|
|
|
3510
3571
|
<dl>
|
|
3511
3572
|
<dd>
|
|
3512
3573
|
|
|
3513
|
-
**request:** `Schematic.
|
|
3574
|
+
**request:** `Schematic.GetActiveCompanySubscriptionRequest`
|
|
3514
3575
|
|
|
3515
3576
|
</dd>
|
|
3516
3577
|
</dl>
|
|
@@ -3529,7 +3590,7 @@ await client.companies.listEntityTraitDefinitions();
|
|
|
3529
3590
|
</dl>
|
|
3530
3591
|
</details>
|
|
3531
3592
|
|
|
3532
|
-
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">
|
|
3593
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">upsertCompanyTrait</a>({ ...params }) -> Schematic.UpsertCompanyTraitResponse</code></summary>
|
|
3533
3594
|
<dl>
|
|
3534
3595
|
<dd>
|
|
3535
3596
|
|
|
@@ -3542,8 +3603,205 @@ await client.companies.listEntityTraitDefinitions();
|
|
|
3542
3603
|
<dd>
|
|
3543
3604
|
|
|
3544
3605
|
```typescript
|
|
3545
|
-
await client.companies.
|
|
3546
|
-
|
|
3606
|
+
await client.companies.upsertCompanyTrait({
|
|
3607
|
+
keys: {
|
|
3608
|
+
key: "value",
|
|
3609
|
+
},
|
|
3610
|
+
trait: "trait",
|
|
3611
|
+
});
|
|
3612
|
+
```
|
|
3613
|
+
|
|
3614
|
+
</dd>
|
|
3615
|
+
</dl>
|
|
3616
|
+
</dd>
|
|
3617
|
+
</dl>
|
|
3618
|
+
|
|
3619
|
+
#### ⚙️ Parameters
|
|
3620
|
+
|
|
3621
|
+
<dl>
|
|
3622
|
+
<dd>
|
|
3623
|
+
|
|
3624
|
+
<dl>
|
|
3625
|
+
<dd>
|
|
3626
|
+
|
|
3627
|
+
**request:** `Schematic.UpsertTraitRequestBody`
|
|
3628
|
+
|
|
3629
|
+
</dd>
|
|
3630
|
+
</dl>
|
|
3631
|
+
|
|
3632
|
+
<dl>
|
|
3633
|
+
<dd>
|
|
3634
|
+
|
|
3635
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
3636
|
+
|
|
3637
|
+
</dd>
|
|
3638
|
+
</dl>
|
|
3639
|
+
</dd>
|
|
3640
|
+
</dl>
|
|
3641
|
+
|
|
3642
|
+
</dd>
|
|
3643
|
+
</dl>
|
|
3644
|
+
</details>
|
|
3645
|
+
|
|
3646
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">listEntityKeyDefinitions</a>({ ...params }) -> Schematic.ListEntityKeyDefinitionsResponse</code></summary>
|
|
3647
|
+
<dl>
|
|
3648
|
+
<dd>
|
|
3649
|
+
|
|
3650
|
+
#### 🔌 Usage
|
|
3651
|
+
|
|
3652
|
+
<dl>
|
|
3653
|
+
<dd>
|
|
3654
|
+
|
|
3655
|
+
<dl>
|
|
3656
|
+
<dd>
|
|
3657
|
+
|
|
3658
|
+
```typescript
|
|
3659
|
+
await client.companies.listEntityKeyDefinitions();
|
|
3660
|
+
```
|
|
3661
|
+
|
|
3662
|
+
</dd>
|
|
3663
|
+
</dl>
|
|
3664
|
+
</dd>
|
|
3665
|
+
</dl>
|
|
3666
|
+
|
|
3667
|
+
#### ⚙️ Parameters
|
|
3668
|
+
|
|
3669
|
+
<dl>
|
|
3670
|
+
<dd>
|
|
3671
|
+
|
|
3672
|
+
<dl>
|
|
3673
|
+
<dd>
|
|
3674
|
+
|
|
3675
|
+
**request:** `Schematic.ListEntityKeyDefinitionsRequest`
|
|
3676
|
+
|
|
3677
|
+
</dd>
|
|
3678
|
+
</dl>
|
|
3679
|
+
|
|
3680
|
+
<dl>
|
|
3681
|
+
<dd>
|
|
3682
|
+
|
|
3683
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
3684
|
+
|
|
3685
|
+
</dd>
|
|
3686
|
+
</dl>
|
|
3687
|
+
</dd>
|
|
3688
|
+
</dl>
|
|
3689
|
+
|
|
3690
|
+
</dd>
|
|
3691
|
+
</dl>
|
|
3692
|
+
</details>
|
|
3693
|
+
|
|
3694
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">countEntityKeyDefinitions</a>({ ...params }) -> Schematic.CountEntityKeyDefinitionsResponse</code></summary>
|
|
3695
|
+
<dl>
|
|
3696
|
+
<dd>
|
|
3697
|
+
|
|
3698
|
+
#### 🔌 Usage
|
|
3699
|
+
|
|
3700
|
+
<dl>
|
|
3701
|
+
<dd>
|
|
3702
|
+
|
|
3703
|
+
<dl>
|
|
3704
|
+
<dd>
|
|
3705
|
+
|
|
3706
|
+
```typescript
|
|
3707
|
+
await client.companies.countEntityKeyDefinitions();
|
|
3708
|
+
```
|
|
3709
|
+
|
|
3710
|
+
</dd>
|
|
3711
|
+
</dl>
|
|
3712
|
+
</dd>
|
|
3713
|
+
</dl>
|
|
3714
|
+
|
|
3715
|
+
#### ⚙️ Parameters
|
|
3716
|
+
|
|
3717
|
+
<dl>
|
|
3718
|
+
<dd>
|
|
3719
|
+
|
|
3720
|
+
<dl>
|
|
3721
|
+
<dd>
|
|
3722
|
+
|
|
3723
|
+
**request:** `Schematic.CountEntityKeyDefinitionsRequest`
|
|
3724
|
+
|
|
3725
|
+
</dd>
|
|
3726
|
+
</dl>
|
|
3727
|
+
|
|
3728
|
+
<dl>
|
|
3729
|
+
<dd>
|
|
3730
|
+
|
|
3731
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
3732
|
+
|
|
3733
|
+
</dd>
|
|
3734
|
+
</dl>
|
|
3735
|
+
</dd>
|
|
3736
|
+
</dl>
|
|
3737
|
+
|
|
3738
|
+
</dd>
|
|
3739
|
+
</dl>
|
|
3740
|
+
</details>
|
|
3741
|
+
|
|
3742
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">listEntityTraitDefinitions</a>({ ...params }) -> Schematic.ListEntityTraitDefinitionsResponse</code></summary>
|
|
3743
|
+
<dl>
|
|
3744
|
+
<dd>
|
|
3745
|
+
|
|
3746
|
+
#### 🔌 Usage
|
|
3747
|
+
|
|
3748
|
+
<dl>
|
|
3749
|
+
<dd>
|
|
3750
|
+
|
|
3751
|
+
<dl>
|
|
3752
|
+
<dd>
|
|
3753
|
+
|
|
3754
|
+
```typescript
|
|
3755
|
+
await client.companies.listEntityTraitDefinitions();
|
|
3756
|
+
```
|
|
3757
|
+
|
|
3758
|
+
</dd>
|
|
3759
|
+
</dl>
|
|
3760
|
+
</dd>
|
|
3761
|
+
</dl>
|
|
3762
|
+
|
|
3763
|
+
#### ⚙️ Parameters
|
|
3764
|
+
|
|
3765
|
+
<dl>
|
|
3766
|
+
<dd>
|
|
3767
|
+
|
|
3768
|
+
<dl>
|
|
3769
|
+
<dd>
|
|
3770
|
+
|
|
3771
|
+
**request:** `Schematic.ListEntityTraitDefinitionsRequest`
|
|
3772
|
+
|
|
3773
|
+
</dd>
|
|
3774
|
+
</dl>
|
|
3775
|
+
|
|
3776
|
+
<dl>
|
|
3777
|
+
<dd>
|
|
3778
|
+
|
|
3779
|
+
**requestOptions:** `Companies.RequestOptions`
|
|
3780
|
+
|
|
3781
|
+
</dd>
|
|
3782
|
+
</dl>
|
|
3783
|
+
</dd>
|
|
3784
|
+
</dl>
|
|
3785
|
+
|
|
3786
|
+
</dd>
|
|
3787
|
+
</dl>
|
|
3788
|
+
</details>
|
|
3789
|
+
|
|
3790
|
+
<details><summary><code>client.companies.<a href="/src/api/resources/companies/client/Client.ts">getOrCreateEntityTraitDefinition</a>({ ...params }) -> Schematic.GetOrCreateEntityTraitDefinitionResponse</code></summary>
|
|
3791
|
+
<dl>
|
|
3792
|
+
<dd>
|
|
3793
|
+
|
|
3794
|
+
#### 🔌 Usage
|
|
3795
|
+
|
|
3796
|
+
<dl>
|
|
3797
|
+
<dd>
|
|
3798
|
+
|
|
3799
|
+
<dl>
|
|
3800
|
+
<dd>
|
|
3801
|
+
|
|
3802
|
+
```typescript
|
|
3803
|
+
await client.companies.getOrCreateEntityTraitDefinition({
|
|
3804
|
+
entityType: "company",
|
|
3547
3805
|
hierarchy: ["hierarchy"],
|
|
3548
3806
|
traitType: "boolean",
|
|
3549
3807
|
});
|
|
@@ -5202,9 +5460,9 @@ await client.entitlements.getFeatureUsageByCompany({
|
|
|
5202
5460
|
</dl>
|
|
5203
5461
|
</details>
|
|
5204
5462
|
|
|
5205
|
-
##
|
|
5463
|
+
## plans
|
|
5206
5464
|
|
|
5207
|
-
<details><summary><code>client.
|
|
5465
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">updateCompanyPlans</a>(companyPlanId, { ...params }) -> Schematic.UpdateCompanyPlansResponse</code></summary>
|
|
5208
5466
|
<dl>
|
|
5209
5467
|
<dd>
|
|
5210
5468
|
|
|
@@ -5217,7 +5475,9 @@ await client.entitlements.getFeatureUsageByCompany({
|
|
|
5217
5475
|
<dd>
|
|
5218
5476
|
|
|
5219
5477
|
```typescript
|
|
5220
|
-
await client.
|
|
5478
|
+
await client.plans.updateCompanyPlans("company_plan_id", {
|
|
5479
|
+
addOnIds: ["add_on_ids"],
|
|
5480
|
+
});
|
|
5221
5481
|
```
|
|
5222
5482
|
|
|
5223
5483
|
</dd>
|
|
@@ -5233,7 +5493,7 @@ await client.components.listComponents();
|
|
|
5233
5493
|
<dl>
|
|
5234
5494
|
<dd>
|
|
5235
5495
|
|
|
5236
|
-
**
|
|
5496
|
+
**companyPlanId:** `string` — company_plan_id
|
|
5237
5497
|
|
|
5238
5498
|
</dd>
|
|
5239
5499
|
</dl>
|
|
@@ -5241,7 +5501,15 @@ await client.components.listComponents();
|
|
|
5241
5501
|
<dl>
|
|
5242
5502
|
<dd>
|
|
5243
5503
|
|
|
5244
|
-
**
|
|
5504
|
+
**request:** `Schematic.UpdateCompanyPlansRequestBody`
|
|
5505
|
+
|
|
5506
|
+
</dd>
|
|
5507
|
+
</dl>
|
|
5508
|
+
|
|
5509
|
+
<dl>
|
|
5510
|
+
<dd>
|
|
5511
|
+
|
|
5512
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5245
5513
|
|
|
5246
5514
|
</dd>
|
|
5247
5515
|
</dl>
|
|
@@ -5252,7 +5520,7 @@ await client.components.listComponents();
|
|
|
5252
5520
|
</dl>
|
|
5253
5521
|
</details>
|
|
5254
5522
|
|
|
5255
|
-
<details><summary><code>client.
|
|
5523
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">getAudience</a>(planAudienceId) -> Schematic.GetAudienceResponse</code></summary>
|
|
5256
5524
|
<dl>
|
|
5257
5525
|
<dd>
|
|
5258
5526
|
|
|
@@ -5265,10 +5533,7 @@ await client.components.listComponents();
|
|
|
5265
5533
|
<dd>
|
|
5266
5534
|
|
|
5267
5535
|
```typescript
|
|
5268
|
-
await client.
|
|
5269
|
-
entityType: "entitlement",
|
|
5270
|
-
name: "name",
|
|
5271
|
-
});
|
|
5536
|
+
await client.plans.getAudience("plan_audience_id");
|
|
5272
5537
|
```
|
|
5273
5538
|
|
|
5274
5539
|
</dd>
|
|
@@ -5284,7 +5549,7 @@ await client.components.createComponent({
|
|
|
5284
5549
|
<dl>
|
|
5285
5550
|
<dd>
|
|
5286
5551
|
|
|
5287
|
-
**
|
|
5552
|
+
**planAudienceId:** `string` — plan_audience_id
|
|
5288
5553
|
|
|
5289
5554
|
</dd>
|
|
5290
5555
|
</dl>
|
|
@@ -5292,7 +5557,7 @@ await client.components.createComponent({
|
|
|
5292
5557
|
<dl>
|
|
5293
5558
|
<dd>
|
|
5294
5559
|
|
|
5295
|
-
**requestOptions:** `
|
|
5560
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5296
5561
|
|
|
5297
5562
|
</dd>
|
|
5298
5563
|
</dl>
|
|
@@ -5303,7 +5568,7 @@ await client.components.createComponent({
|
|
|
5303
5568
|
</dl>
|
|
5304
5569
|
</details>
|
|
5305
5570
|
|
|
5306
|
-
<details><summary><code>client.
|
|
5571
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">updateAudience</a>(planAudienceId, { ...params }) -> Schematic.UpdateAudienceResponse</code></summary>
|
|
5307
5572
|
<dl>
|
|
5308
5573
|
<dd>
|
|
5309
5574
|
|
|
@@ -5316,7 +5581,26 @@ await client.components.createComponent({
|
|
|
5316
5581
|
<dd>
|
|
5317
5582
|
|
|
5318
5583
|
```typescript
|
|
5319
|
-
await client.
|
|
5584
|
+
await client.plans.updateAudience("plan_audience_id", {
|
|
5585
|
+
conditionGroups: [
|
|
5586
|
+
{
|
|
5587
|
+
conditions: [
|
|
5588
|
+
{
|
|
5589
|
+
conditionType: "company",
|
|
5590
|
+
operator: "eq",
|
|
5591
|
+
resourceIds: ["resource_ids"],
|
|
5592
|
+
},
|
|
5593
|
+
],
|
|
5594
|
+
},
|
|
5595
|
+
],
|
|
5596
|
+
conditions: [
|
|
5597
|
+
{
|
|
5598
|
+
conditionType: "company",
|
|
5599
|
+
operator: "eq",
|
|
5600
|
+
resourceIds: ["resource_ids"],
|
|
5601
|
+
},
|
|
5602
|
+
],
|
|
5603
|
+
});
|
|
5320
5604
|
```
|
|
5321
5605
|
|
|
5322
5606
|
</dd>
|
|
@@ -5332,7 +5616,7 @@ await client.components.getComponent("component_id");
|
|
|
5332
5616
|
<dl>
|
|
5333
5617
|
<dd>
|
|
5334
5618
|
|
|
5335
|
-
**
|
|
5619
|
+
**planAudienceId:** `string` — plan_audience_id
|
|
5336
5620
|
|
|
5337
5621
|
</dd>
|
|
5338
5622
|
</dl>
|
|
@@ -5340,18 +5624,26 @@ await client.components.getComponent("component_id");
|
|
|
5340
5624
|
<dl>
|
|
5341
5625
|
<dd>
|
|
5342
5626
|
|
|
5343
|
-
**
|
|
5627
|
+
**request:** `Schematic.UpdateAudienceRequestBody`
|
|
5344
5628
|
|
|
5345
|
-
</dd>
|
|
5346
|
-
</dl>
|
|
5347
5629
|
</dd>
|
|
5348
5630
|
</dl>
|
|
5349
5631
|
|
|
5350
|
-
|
|
5632
|
+
<dl>
|
|
5633
|
+
<dd>
|
|
5634
|
+
|
|
5635
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5636
|
+
|
|
5637
|
+
</dd>
|
|
5638
|
+
</dl>
|
|
5639
|
+
</dd>
|
|
5640
|
+
</dl>
|
|
5641
|
+
|
|
5642
|
+
</dd>
|
|
5351
5643
|
</dl>
|
|
5352
5644
|
</details>
|
|
5353
5645
|
|
|
5354
|
-
<details><summary><code>client.
|
|
5646
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">deleteAudience</a>(planAudienceId) -> Schematic.DeleteAudienceResponse</code></summary>
|
|
5355
5647
|
<dl>
|
|
5356
5648
|
<dd>
|
|
5357
5649
|
|
|
@@ -5364,7 +5656,7 @@ await client.components.getComponent("component_id");
|
|
|
5364
5656
|
<dd>
|
|
5365
5657
|
|
|
5366
5658
|
```typescript
|
|
5367
|
-
await client.
|
|
5659
|
+
await client.plans.deleteAudience("plan_audience_id");
|
|
5368
5660
|
```
|
|
5369
5661
|
|
|
5370
5662
|
</dd>
|
|
@@ -5380,15 +5672,7 @@ await client.components.updateComponent("component_id");
|
|
|
5380
5672
|
<dl>
|
|
5381
5673
|
<dd>
|
|
5382
5674
|
|
|
5383
|
-
**
|
|
5384
|
-
|
|
5385
|
-
</dd>
|
|
5386
|
-
</dl>
|
|
5387
|
-
|
|
5388
|
-
<dl>
|
|
5389
|
-
<dd>
|
|
5390
|
-
|
|
5391
|
-
**request:** `Schematic.UpdateComponentRequestBody`
|
|
5675
|
+
**planAudienceId:** `string` — plan_audience_id
|
|
5392
5676
|
|
|
5393
5677
|
</dd>
|
|
5394
5678
|
</dl>
|
|
@@ -5396,7 +5680,7 @@ await client.components.updateComponent("component_id");
|
|
|
5396
5680
|
<dl>
|
|
5397
5681
|
<dd>
|
|
5398
5682
|
|
|
5399
|
-
**requestOptions:** `
|
|
5683
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5400
5684
|
|
|
5401
5685
|
</dd>
|
|
5402
5686
|
</dl>
|
|
@@ -5407,7 +5691,7 @@ await client.components.updateComponent("component_id");
|
|
|
5407
5691
|
</dl>
|
|
5408
5692
|
</details>
|
|
5409
5693
|
|
|
5410
|
-
<details><summary><code>client.
|
|
5694
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">listPlans</a>({ ...params }) -> Schematic.ListPlansResponse</code></summary>
|
|
5411
5695
|
<dl>
|
|
5412
5696
|
<dd>
|
|
5413
5697
|
|
|
@@ -5420,7 +5704,7 @@ await client.components.updateComponent("component_id");
|
|
|
5420
5704
|
<dd>
|
|
5421
5705
|
|
|
5422
5706
|
```typescript
|
|
5423
|
-
await client.
|
|
5707
|
+
await client.plans.listPlans();
|
|
5424
5708
|
```
|
|
5425
5709
|
|
|
5426
5710
|
</dd>
|
|
@@ -5436,7 +5720,7 @@ await client.components.deleteComponent("component_id");
|
|
|
5436
5720
|
<dl>
|
|
5437
5721
|
<dd>
|
|
5438
5722
|
|
|
5439
|
-
**
|
|
5723
|
+
**request:** `Schematic.ListPlansRequest`
|
|
5440
5724
|
|
|
5441
5725
|
</dd>
|
|
5442
5726
|
</dl>
|
|
@@ -5444,7 +5728,7 @@ await client.components.deleteComponent("component_id");
|
|
|
5444
5728
|
<dl>
|
|
5445
5729
|
<dd>
|
|
5446
5730
|
|
|
5447
|
-
**requestOptions:** `
|
|
5731
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5448
5732
|
|
|
5449
5733
|
</dd>
|
|
5450
5734
|
</dl>
|
|
@@ -5455,7 +5739,7 @@ await client.components.deleteComponent("component_id");
|
|
|
5455
5739
|
</dl>
|
|
5456
5740
|
</details>
|
|
5457
5741
|
|
|
5458
|
-
<details><summary><code>client.
|
|
5742
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">createPlan</a>({ ...params }) -> Schematic.CreatePlanResponse</code></summary>
|
|
5459
5743
|
<dl>
|
|
5460
5744
|
<dd>
|
|
5461
5745
|
|
|
@@ -5468,7 +5752,11 @@ await client.components.deleteComponent("component_id");
|
|
|
5468
5752
|
<dd>
|
|
5469
5753
|
|
|
5470
5754
|
```typescript
|
|
5471
|
-
await client.
|
|
5755
|
+
await client.plans.createPlan({
|
|
5756
|
+
description: "description",
|
|
5757
|
+
name: "name",
|
|
5758
|
+
planType: "plan",
|
|
5759
|
+
});
|
|
5472
5760
|
```
|
|
5473
5761
|
|
|
5474
5762
|
</dd>
|
|
@@ -5484,7 +5772,7 @@ await client.components.countComponents();
|
|
|
5484
5772
|
<dl>
|
|
5485
5773
|
<dd>
|
|
5486
5774
|
|
|
5487
|
-
**request:** `Schematic.
|
|
5775
|
+
**request:** `Schematic.CreatePlanRequestBody`
|
|
5488
5776
|
|
|
5489
5777
|
</dd>
|
|
5490
5778
|
</dl>
|
|
@@ -5492,7 +5780,7 @@ await client.components.countComponents();
|
|
|
5492
5780
|
<dl>
|
|
5493
5781
|
<dd>
|
|
5494
5782
|
|
|
5495
|
-
**requestOptions:** `
|
|
5783
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5496
5784
|
|
|
5497
5785
|
</dd>
|
|
5498
5786
|
</dl>
|
|
@@ -5503,7 +5791,7 @@ await client.components.countComponents();
|
|
|
5503
5791
|
</dl>
|
|
5504
5792
|
</details>
|
|
5505
5793
|
|
|
5506
|
-
<details><summary><code>client.
|
|
5794
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">getPlan</a>(planId) -> Schematic.GetPlanResponse</code></summary>
|
|
5507
5795
|
<dl>
|
|
5508
5796
|
<dd>
|
|
5509
5797
|
|
|
@@ -5516,7 +5804,7 @@ await client.components.countComponents();
|
|
|
5516
5804
|
<dd>
|
|
5517
5805
|
|
|
5518
5806
|
```typescript
|
|
5519
|
-
await client.
|
|
5807
|
+
await client.plans.getPlan("plan_id");
|
|
5520
5808
|
```
|
|
5521
5809
|
|
|
5522
5810
|
</dd>
|
|
@@ -5532,7 +5820,7 @@ await client.components.previewComponentData();
|
|
|
5532
5820
|
<dl>
|
|
5533
5821
|
<dd>
|
|
5534
5822
|
|
|
5535
|
-
**
|
|
5823
|
+
**planId:** `string` — plan_id
|
|
5536
5824
|
|
|
5537
5825
|
</dd>
|
|
5538
5826
|
</dl>
|
|
@@ -5540,7 +5828,7 @@ await client.components.previewComponentData();
|
|
|
5540
5828
|
<dl>
|
|
5541
5829
|
<dd>
|
|
5542
5830
|
|
|
5543
|
-
**requestOptions:** `
|
|
5831
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5544
5832
|
|
|
5545
5833
|
</dd>
|
|
5546
5834
|
</dl>
|
|
@@ -5551,9 +5839,7 @@ await client.components.previewComponentData();
|
|
|
5551
5839
|
</dl>
|
|
5552
5840
|
</details>
|
|
5553
5841
|
|
|
5554
|
-
|
|
5555
|
-
|
|
5556
|
-
<details><summary><code>client.crm.<a href="/src/api/resources/crm/client/Client.ts">upsertDealLineItemAssociation</a>({ ...params }) -> Schematic.UpsertDealLineItemAssociationResponse</code></summary>
|
|
5842
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">updatePlan</a>(planId, { ...params }) -> Schematic.UpdatePlanResponse</code></summary>
|
|
5557
5843
|
<dl>
|
|
5558
5844
|
<dd>
|
|
5559
5845
|
|
|
@@ -5566,9 +5852,8 @@ await client.components.previewComponentData();
|
|
|
5566
5852
|
<dd>
|
|
5567
5853
|
|
|
5568
5854
|
```typescript
|
|
5569
|
-
await client.
|
|
5570
|
-
|
|
5571
|
-
lineItemExternalId: "line_item_external_id",
|
|
5855
|
+
await client.plans.updatePlan("plan_id", {
|
|
5856
|
+
name: "name",
|
|
5572
5857
|
});
|
|
5573
5858
|
```
|
|
5574
5859
|
|
|
@@ -5585,7 +5870,7 @@ await client.crm.upsertDealLineItemAssociation({
|
|
|
5585
5870
|
<dl>
|
|
5586
5871
|
<dd>
|
|
5587
5872
|
|
|
5588
|
-
**
|
|
5873
|
+
**planId:** `string` — plan_id
|
|
5589
5874
|
|
|
5590
5875
|
</dd>
|
|
5591
5876
|
</dl>
|
|
@@ -5593,7 +5878,15 @@ await client.crm.upsertDealLineItemAssociation({
|
|
|
5593
5878
|
<dl>
|
|
5594
5879
|
<dd>
|
|
5595
5880
|
|
|
5596
|
-
**
|
|
5881
|
+
**request:** `Schematic.UpdatePlanRequestBody`
|
|
5882
|
+
|
|
5883
|
+
</dd>
|
|
5884
|
+
</dl>
|
|
5885
|
+
|
|
5886
|
+
<dl>
|
|
5887
|
+
<dd>
|
|
5888
|
+
|
|
5889
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5597
5890
|
|
|
5598
5891
|
</dd>
|
|
5599
5892
|
</dl>
|
|
@@ -5604,7 +5897,7 @@ await client.crm.upsertDealLineItemAssociation({
|
|
|
5604
5897
|
</dl>
|
|
5605
5898
|
</details>
|
|
5606
5899
|
|
|
5607
|
-
<details><summary><code>client.
|
|
5900
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">deletePlan</a>(planId) -> Schematic.DeletePlanResponse</code></summary>
|
|
5608
5901
|
<dl>
|
|
5609
5902
|
<dd>
|
|
5610
5903
|
|
|
@@ -5617,13 +5910,7 @@ await client.crm.upsertDealLineItemAssociation({
|
|
|
5617
5910
|
<dd>
|
|
5618
5911
|
|
|
5619
5912
|
```typescript
|
|
5620
|
-
await client.
|
|
5621
|
-
amount: "amount",
|
|
5622
|
-
interval: "interval",
|
|
5623
|
-
lineItemExternalId: "line_item_external_id",
|
|
5624
|
-
productExternalId: "product_external_id",
|
|
5625
|
-
quantity: 1,
|
|
5626
|
-
});
|
|
5913
|
+
await client.plans.deletePlan("plan_id");
|
|
5627
5914
|
```
|
|
5628
5915
|
|
|
5629
5916
|
</dd>
|
|
@@ -5639,7 +5926,7 @@ await client.crm.upsertLineItem({
|
|
|
5639
5926
|
<dl>
|
|
5640
5927
|
<dd>
|
|
5641
5928
|
|
|
5642
|
-
**
|
|
5929
|
+
**planId:** `string` — plan_id
|
|
5643
5930
|
|
|
5644
5931
|
</dd>
|
|
5645
5932
|
</dl>
|
|
@@ -5647,7 +5934,7 @@ await client.crm.upsertLineItem({
|
|
|
5647
5934
|
<dl>
|
|
5648
5935
|
<dd>
|
|
5649
5936
|
|
|
5650
|
-
**requestOptions:** `
|
|
5937
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5651
5938
|
|
|
5652
5939
|
</dd>
|
|
5653
5940
|
</dl>
|
|
@@ -5658,7 +5945,7 @@ await client.crm.upsertLineItem({
|
|
|
5658
5945
|
</dl>
|
|
5659
5946
|
</details>
|
|
5660
5947
|
|
|
5661
|
-
<details><summary><code>client.
|
|
5948
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">upsertBillingProductPlan</a>(planId, { ...params }) -> Schematic.UpsertBillingProductPlanResponse</code></summary>
|
|
5662
5949
|
<dl>
|
|
5663
5950
|
<dd>
|
|
5664
5951
|
|
|
@@ -5671,10 +5958,9 @@ await client.crm.upsertLineItem({
|
|
|
5671
5958
|
<dd>
|
|
5672
5959
|
|
|
5673
5960
|
```typescript
|
|
5674
|
-
await client.
|
|
5675
|
-
|
|
5676
|
-
|
|
5677
|
-
dealExternalId: "deal_external_id",
|
|
5961
|
+
await client.plans.upsertBillingProductPlan("plan_id", {
|
|
5962
|
+
isFreePlan: true,
|
|
5963
|
+
isTrialable: true,
|
|
5678
5964
|
});
|
|
5679
5965
|
```
|
|
5680
5966
|
|
|
@@ -5691,7 +5977,7 @@ await client.crm.upsertCrmDeal({
|
|
|
5691
5977
|
<dl>
|
|
5692
5978
|
<dd>
|
|
5693
5979
|
|
|
5694
|
-
**
|
|
5980
|
+
**planId:** `string` — plan_id
|
|
5695
5981
|
|
|
5696
5982
|
</dd>
|
|
5697
5983
|
</dl>
|
|
@@ -5699,7 +5985,15 @@ await client.crm.upsertCrmDeal({
|
|
|
5699
5985
|
<dl>
|
|
5700
5986
|
<dd>
|
|
5701
5987
|
|
|
5702
|
-
**
|
|
5988
|
+
**request:** `Schematic.UpsertBillingProductRequestBody`
|
|
5989
|
+
|
|
5990
|
+
</dd>
|
|
5991
|
+
</dl>
|
|
5992
|
+
|
|
5993
|
+
<dl>
|
|
5994
|
+
<dd>
|
|
5995
|
+
|
|
5996
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5703
5997
|
|
|
5704
5998
|
</dd>
|
|
5705
5999
|
</dl>
|
|
@@ -5710,7 +6004,7 @@ await client.crm.upsertCrmDeal({
|
|
|
5710
6004
|
</dl>
|
|
5711
6005
|
</details>
|
|
5712
6006
|
|
|
5713
|
-
<details><summary><code>client.
|
|
6007
|
+
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">countPlans</a>({ ...params }) -> Schematic.CountPlansResponse</code></summary>
|
|
5714
6008
|
<dl>
|
|
5715
6009
|
<dd>
|
|
5716
6010
|
|
|
@@ -5723,7 +6017,7 @@ await client.crm.upsertCrmDeal({
|
|
|
5723
6017
|
<dd>
|
|
5724
6018
|
|
|
5725
6019
|
```typescript
|
|
5726
|
-
await client.
|
|
6020
|
+
await client.plans.countPlans();
|
|
5727
6021
|
```
|
|
5728
6022
|
|
|
5729
6023
|
</dd>
|
|
@@ -5739,7 +6033,7 @@ await client.crm.listCrmProducts();
|
|
|
5739
6033
|
<dl>
|
|
5740
6034
|
<dd>
|
|
5741
6035
|
|
|
5742
|
-
**request:** `Schematic.
|
|
6036
|
+
**request:** `Schematic.CountPlansRequest`
|
|
5743
6037
|
|
|
5744
6038
|
</dd>
|
|
5745
6039
|
</dl>
|
|
@@ -5747,7 +6041,7 @@ await client.crm.listCrmProducts();
|
|
|
5747
6041
|
<dl>
|
|
5748
6042
|
<dd>
|
|
5749
6043
|
|
|
5750
|
-
**requestOptions:** `
|
|
6044
|
+
**requestOptions:** `Plans.RequestOptions`
|
|
5751
6045
|
|
|
5752
6046
|
</dd>
|
|
5753
6047
|
</dl>
|
|
@@ -5758,7 +6052,9 @@ await client.crm.listCrmProducts();
|
|
|
5758
6052
|
</dl>
|
|
5759
6053
|
</details>
|
|
5760
6054
|
|
|
5761
|
-
|
|
6055
|
+
## components
|
|
6056
|
+
|
|
6057
|
+
<details><summary><code>client.components.<a href="/src/api/resources/components/client/Client.ts">listComponents</a>({ ...params }) -> Schematic.ListComponentsResponse</code></summary>
|
|
5762
6058
|
<dl>
|
|
5763
6059
|
<dd>
|
|
5764
6060
|
|
|
@@ -5771,16 +6067,7 @@ await client.crm.listCrmProducts();
|
|
|
5771
6067
|
<dd>
|
|
5772
6068
|
|
|
5773
6069
|
```typescript
|
|
5774
|
-
await client.
|
|
5775
|
-
currency: "currency",
|
|
5776
|
-
description: "description",
|
|
5777
|
-
externalId: "external_id",
|
|
5778
|
-
interval: "interval",
|
|
5779
|
-
name: "name",
|
|
5780
|
-
price: "price",
|
|
5781
|
-
quantity: 1,
|
|
5782
|
-
sku: "sku",
|
|
5783
|
-
});
|
|
6070
|
+
await client.components.listComponents();
|
|
5784
6071
|
```
|
|
5785
6072
|
|
|
5786
6073
|
</dd>
|
|
@@ -5796,7 +6083,7 @@ await client.crm.upsertCrmProduct({
|
|
|
5796
6083
|
<dl>
|
|
5797
6084
|
<dd>
|
|
5798
6085
|
|
|
5799
|
-
**request:** `Schematic.
|
|
6086
|
+
**request:** `Schematic.ListComponentsRequest`
|
|
5800
6087
|
|
|
5801
6088
|
</dd>
|
|
5802
6089
|
</dl>
|
|
@@ -5804,7 +6091,7 @@ await client.crm.upsertCrmProduct({
|
|
|
5804
6091
|
<dl>
|
|
5805
6092
|
<dd>
|
|
5806
6093
|
|
|
5807
|
-
**requestOptions:** `
|
|
6094
|
+
**requestOptions:** `Components.RequestOptions`
|
|
5808
6095
|
|
|
5809
6096
|
</dd>
|
|
5810
6097
|
</dl>
|
|
@@ -5815,9 +6102,7 @@ await client.crm.upsertCrmProduct({
|
|
|
5815
6102
|
</dl>
|
|
5816
6103
|
</details>
|
|
5817
6104
|
|
|
5818
|
-
|
|
5819
|
-
|
|
5820
|
-
<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">createEventBatch</a>({ ...params }) -> Schematic.CreateEventBatchResponse</code></summary>
|
|
6105
|
+
<details><summary><code>client.components.<a href="/src/api/resources/components/client/Client.ts">createComponent</a>({ ...params }) -> Schematic.CreateComponentResponse</code></summary>
|
|
5821
6106
|
<dl>
|
|
5822
6107
|
<dd>
|
|
5823
6108
|
|
|
@@ -5830,12 +6115,9 @@ await client.crm.upsertCrmProduct({
|
|
|
5830
6115
|
<dd>
|
|
5831
6116
|
|
|
5832
6117
|
```typescript
|
|
5833
|
-
await client.
|
|
5834
|
-
|
|
5835
|
-
|
|
5836
|
-
eventType: "identify",
|
|
5837
|
-
},
|
|
5838
|
-
],
|
|
6118
|
+
await client.components.createComponent({
|
|
6119
|
+
entityType: "entitlement",
|
|
6120
|
+
name: "name",
|
|
5839
6121
|
});
|
|
5840
6122
|
```
|
|
5841
6123
|
|
|
@@ -5852,7 +6134,7 @@ await client.events.createEventBatch({
|
|
|
5852
6134
|
<dl>
|
|
5853
6135
|
<dd>
|
|
5854
6136
|
|
|
5855
|
-
**request:** `Schematic.
|
|
6137
|
+
**request:** `Schematic.CreateComponentRequestBody`
|
|
5856
6138
|
|
|
5857
6139
|
</dd>
|
|
5858
6140
|
</dl>
|
|
@@ -5860,7 +6142,7 @@ await client.events.createEventBatch({
|
|
|
5860
6142
|
<dl>
|
|
5861
6143
|
<dd>
|
|
5862
6144
|
|
|
5863
|
-
**requestOptions:** `
|
|
6145
|
+
**requestOptions:** `Components.RequestOptions`
|
|
5864
6146
|
|
|
5865
6147
|
</dd>
|
|
5866
6148
|
</dl>
|
|
@@ -5871,7 +6153,7 @@ await client.events.createEventBatch({
|
|
|
5871
6153
|
</dl>
|
|
5872
6154
|
</details>
|
|
5873
6155
|
|
|
5874
|
-
<details><summary><code>client.
|
|
6156
|
+
<details><summary><code>client.components.<a href="/src/api/resources/components/client/Client.ts">getComponent</a>(componentId) -> Schematic.GetComponentResponse</code></summary>
|
|
5875
6157
|
<dl>
|
|
5876
6158
|
<dd>
|
|
5877
6159
|
|
|
@@ -5884,7 +6166,7 @@ await client.events.createEventBatch({
|
|
|
5884
6166
|
<dd>
|
|
5885
6167
|
|
|
5886
6168
|
```typescript
|
|
5887
|
-
await client.
|
|
6169
|
+
await client.components.getComponent("component_id");
|
|
5888
6170
|
```
|
|
5889
6171
|
|
|
5890
6172
|
</dd>
|
|
@@ -5900,7 +6182,7 @@ await client.events.getEventSummaries();
|
|
|
5900
6182
|
<dl>
|
|
5901
6183
|
<dd>
|
|
5902
6184
|
|
|
5903
|
-
**
|
|
6185
|
+
**componentId:** `string` — component_id
|
|
5904
6186
|
|
|
5905
6187
|
</dd>
|
|
5906
6188
|
</dl>
|
|
@@ -5908,7 +6190,7 @@ await client.events.getEventSummaries();
|
|
|
5908
6190
|
<dl>
|
|
5909
6191
|
<dd>
|
|
5910
6192
|
|
|
5911
|
-
**requestOptions:** `
|
|
6193
|
+
**requestOptions:** `Components.RequestOptions`
|
|
5912
6194
|
|
|
5913
6195
|
</dd>
|
|
5914
6196
|
</dl>
|
|
@@ -5919,7 +6201,7 @@ await client.events.getEventSummaries();
|
|
|
5919
6201
|
</dl>
|
|
5920
6202
|
</details>
|
|
5921
6203
|
|
|
5922
|
-
<details><summary><code>client.
|
|
6204
|
+
<details><summary><code>client.components.<a href="/src/api/resources/components/client/Client.ts">updateComponent</a>(componentId, { ...params }) -> Schematic.UpdateComponentResponse</code></summary>
|
|
5923
6205
|
<dl>
|
|
5924
6206
|
<dd>
|
|
5925
6207
|
|
|
@@ -5932,7 +6214,7 @@ await client.events.getEventSummaries();
|
|
|
5932
6214
|
<dd>
|
|
5933
6215
|
|
|
5934
6216
|
```typescript
|
|
5935
|
-
await client.
|
|
6217
|
+
await client.components.updateComponent("component_id");
|
|
5936
6218
|
```
|
|
5937
6219
|
|
|
5938
6220
|
</dd>
|
|
@@ -5948,7 +6230,7 @@ await client.events.getEventSummaryBySubtype("key");
|
|
|
5948
6230
|
<dl>
|
|
5949
6231
|
<dd>
|
|
5950
6232
|
|
|
5951
|
-
**
|
|
6233
|
+
**componentId:** `string` — component_id
|
|
5952
6234
|
|
|
5953
6235
|
</dd>
|
|
5954
6236
|
</dl>
|
|
@@ -5956,7 +6238,15 @@ await client.events.getEventSummaryBySubtype("key");
|
|
|
5956
6238
|
<dl>
|
|
5957
6239
|
<dd>
|
|
5958
6240
|
|
|
5959
|
-
**
|
|
6241
|
+
**request:** `Schematic.UpdateComponentRequestBody`
|
|
6242
|
+
|
|
6243
|
+
</dd>
|
|
6244
|
+
</dl>
|
|
6245
|
+
|
|
6246
|
+
<dl>
|
|
6247
|
+
<dd>
|
|
6248
|
+
|
|
6249
|
+
**requestOptions:** `Components.RequestOptions`
|
|
5960
6250
|
|
|
5961
6251
|
</dd>
|
|
5962
6252
|
</dl>
|
|
@@ -5967,7 +6257,7 @@ await client.events.getEventSummaryBySubtype("key");
|
|
|
5967
6257
|
</dl>
|
|
5968
6258
|
</details>
|
|
5969
6259
|
|
|
5970
|
-
<details><summary><code>client.
|
|
6260
|
+
<details><summary><code>client.components.<a href="/src/api/resources/components/client/Client.ts">deleteComponent</a>(componentId) -> Schematic.DeleteComponentResponse</code></summary>
|
|
5971
6261
|
<dl>
|
|
5972
6262
|
<dd>
|
|
5973
6263
|
|
|
@@ -5980,7 +6270,7 @@ await client.events.getEventSummaryBySubtype("key");
|
|
|
5980
6270
|
<dd>
|
|
5981
6271
|
|
|
5982
6272
|
```typescript
|
|
5983
|
-
await client.
|
|
6273
|
+
await client.components.deleteComponent("component_id");
|
|
5984
6274
|
```
|
|
5985
6275
|
|
|
5986
6276
|
</dd>
|
|
@@ -5996,7 +6286,7 @@ await client.events.listEvents();
|
|
|
5996
6286
|
<dl>
|
|
5997
6287
|
<dd>
|
|
5998
6288
|
|
|
5999
|
-
**
|
|
6289
|
+
**componentId:** `string` — component_id
|
|
6000
6290
|
|
|
6001
6291
|
</dd>
|
|
6002
6292
|
</dl>
|
|
@@ -6004,7 +6294,7 @@ await client.events.listEvents();
|
|
|
6004
6294
|
<dl>
|
|
6005
6295
|
<dd>
|
|
6006
6296
|
|
|
6007
|
-
**requestOptions:** `
|
|
6297
|
+
**requestOptions:** `Components.RequestOptions`
|
|
6008
6298
|
|
|
6009
6299
|
</dd>
|
|
6010
6300
|
</dl>
|
|
@@ -6015,7 +6305,7 @@ await client.events.listEvents();
|
|
|
6015
6305
|
</dl>
|
|
6016
6306
|
</details>
|
|
6017
6307
|
|
|
6018
|
-
<details><summary><code>client.
|
|
6308
|
+
<details><summary><code>client.components.<a href="/src/api/resources/components/client/Client.ts">countComponents</a>({ ...params }) -> Schematic.CountComponentsResponse</code></summary>
|
|
6019
6309
|
<dl>
|
|
6020
6310
|
<dd>
|
|
6021
6311
|
|
|
@@ -6028,9 +6318,7 @@ await client.events.listEvents();
|
|
|
6028
6318
|
<dd>
|
|
6029
6319
|
|
|
6030
6320
|
```typescript
|
|
6031
|
-
await client.
|
|
6032
|
-
eventType: "identify",
|
|
6033
|
-
});
|
|
6321
|
+
await client.components.countComponents();
|
|
6034
6322
|
```
|
|
6035
6323
|
|
|
6036
6324
|
</dd>
|
|
@@ -6046,7 +6334,7 @@ await client.events.createEvent({
|
|
|
6046
6334
|
<dl>
|
|
6047
6335
|
<dd>
|
|
6048
6336
|
|
|
6049
|
-
**request:** `Schematic.
|
|
6337
|
+
**request:** `Schematic.CountComponentsRequest`
|
|
6050
6338
|
|
|
6051
6339
|
</dd>
|
|
6052
6340
|
</dl>
|
|
@@ -6054,7 +6342,7 @@ await client.events.createEvent({
|
|
|
6054
6342
|
<dl>
|
|
6055
6343
|
<dd>
|
|
6056
6344
|
|
|
6057
|
-
**requestOptions:** `
|
|
6345
|
+
**requestOptions:** `Components.RequestOptions`
|
|
6058
6346
|
|
|
6059
6347
|
</dd>
|
|
6060
6348
|
</dl>
|
|
@@ -6065,7 +6353,7 @@ await client.events.createEvent({
|
|
|
6065
6353
|
</dl>
|
|
6066
6354
|
</details>
|
|
6067
6355
|
|
|
6068
|
-
<details><summary><code>client.
|
|
6356
|
+
<details><summary><code>client.components.<a href="/src/api/resources/components/client/Client.ts">previewComponentData</a>({ ...params }) -> Schematic.PreviewComponentDataResponse</code></summary>
|
|
6069
6357
|
<dl>
|
|
6070
6358
|
<dd>
|
|
6071
6359
|
|
|
@@ -6078,7 +6366,7 @@ await client.events.createEvent({
|
|
|
6078
6366
|
<dd>
|
|
6079
6367
|
|
|
6080
6368
|
```typescript
|
|
6081
|
-
await client.
|
|
6369
|
+
await client.components.previewComponentData();
|
|
6082
6370
|
```
|
|
6083
6371
|
|
|
6084
6372
|
</dd>
|
|
@@ -6094,7 +6382,7 @@ await client.events.getEvent("event_id");
|
|
|
6094
6382
|
<dl>
|
|
6095
6383
|
<dd>
|
|
6096
6384
|
|
|
6097
|
-
**
|
|
6385
|
+
**request:** `Schematic.PreviewComponentDataRequest`
|
|
6098
6386
|
|
|
6099
6387
|
</dd>
|
|
6100
6388
|
</dl>
|
|
@@ -6102,7 +6390,7 @@ await client.events.getEvent("event_id");
|
|
|
6102
6390
|
<dl>
|
|
6103
6391
|
<dd>
|
|
6104
6392
|
|
|
6105
|
-
**requestOptions:** `
|
|
6393
|
+
**requestOptions:** `Components.RequestOptions`
|
|
6106
6394
|
|
|
6107
6395
|
</dd>
|
|
6108
6396
|
</dl>
|
|
@@ -6113,7 +6401,9 @@ await client.events.getEvent("event_id");
|
|
|
6113
6401
|
</dl>
|
|
6114
6402
|
</details>
|
|
6115
6403
|
|
|
6116
|
-
|
|
6404
|
+
## crm
|
|
6405
|
+
|
|
6406
|
+
<details><summary><code>client.crm.<a href="/src/api/resources/crm/client/Client.ts">upsertDealLineItemAssociation</a>({ ...params }) -> Schematic.UpsertDealLineItemAssociationResponse</code></summary>
|
|
6117
6407
|
<dl>
|
|
6118
6408
|
<dd>
|
|
6119
6409
|
|
|
@@ -6126,7 +6416,10 @@ await client.events.getEvent("event_id");
|
|
|
6126
6416
|
<dd>
|
|
6127
6417
|
|
|
6128
6418
|
```typescript
|
|
6129
|
-
await client.
|
|
6419
|
+
await client.crm.upsertDealLineItemAssociation({
|
|
6420
|
+
dealExternalId: "deal_external_id",
|
|
6421
|
+
lineItemExternalId: "line_item_external_id",
|
|
6422
|
+
});
|
|
6130
6423
|
```
|
|
6131
6424
|
|
|
6132
6425
|
</dd>
|
|
@@ -6142,7 +6435,15 @@ await client.events.getSegmentIntegrationStatus();
|
|
|
6142
6435
|
<dl>
|
|
6143
6436
|
<dd>
|
|
6144
6437
|
|
|
6145
|
-
**
|
|
6438
|
+
**request:** `Schematic.CreateCrmDealLineItemAssociationRequestBody`
|
|
6439
|
+
|
|
6440
|
+
</dd>
|
|
6441
|
+
</dl>
|
|
6442
|
+
|
|
6443
|
+
<dl>
|
|
6444
|
+
<dd>
|
|
6445
|
+
|
|
6446
|
+
**requestOptions:** `Crm.RequestOptions`
|
|
6146
6447
|
|
|
6147
6448
|
</dd>
|
|
6148
6449
|
</dl>
|
|
@@ -6153,9 +6454,7 @@ await client.events.getSegmentIntegrationStatus();
|
|
|
6153
6454
|
</dl>
|
|
6154
6455
|
</details>
|
|
6155
6456
|
|
|
6156
|
-
|
|
6157
|
-
|
|
6158
|
-
<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">getAudience</a>(planAudienceId) -> Schematic.GetAudienceResponse</code></summary>
|
|
6457
|
+
<details><summary><code>client.crm.<a href="/src/api/resources/crm/client/Client.ts">upsertLineItem</a>({ ...params }) -> Schematic.UpsertLineItemResponse</code></summary>
|
|
6159
6458
|
<dl>
|
|
6160
6459
|
<dd>
|
|
6161
6460
|
|
|
@@ -6168,7 +6467,13 @@ await client.events.getSegmentIntegrationStatus();
|
|
|
6168
6467
|
<dd>
|
|
6169
6468
|
|
|
6170
6469
|
```typescript
|
|
6171
|
-
await client.
|
|
6470
|
+
await client.crm.upsertLineItem({
|
|
6471
|
+
amount: "amount",
|
|
6472
|
+
interval: "interval",
|
|
6473
|
+
lineItemExternalId: "line_item_external_id",
|
|
6474
|
+
productExternalId: "product_external_id",
|
|
6475
|
+
quantity: 1,
|
|
6476
|
+
});
|
|
6172
6477
|
```
|
|
6173
6478
|
|
|
6174
6479
|
</dd>
|
|
@@ -6184,7 +6489,7 @@ await client.plans.getAudience("plan_audience_id");
|
|
|
6184
6489
|
<dl>
|
|
6185
6490
|
<dd>
|
|
6186
6491
|
|
|
6187
|
-
**
|
|
6492
|
+
**request:** `Schematic.CreateCrmLineItemRequestBody`
|
|
6188
6493
|
|
|
6189
6494
|
</dd>
|
|
6190
6495
|
</dl>
|
|
@@ -6192,7 +6497,7 @@ await client.plans.getAudience("plan_audience_id");
|
|
|
6192
6497
|
<dl>
|
|
6193
6498
|
<dd>
|
|
6194
6499
|
|
|
6195
|
-
**requestOptions:** `
|
|
6500
|
+
**requestOptions:** `Crm.RequestOptions`
|
|
6196
6501
|
|
|
6197
6502
|
</dd>
|
|
6198
6503
|
</dl>
|
|
@@ -6203,7 +6508,7 @@ await client.plans.getAudience("plan_audience_id");
|
|
|
6203
6508
|
</dl>
|
|
6204
6509
|
</details>
|
|
6205
6510
|
|
|
6206
|
-
<details><summary><code>client.
|
|
6511
|
+
<details><summary><code>client.crm.<a href="/src/api/resources/crm/client/Client.ts">upsertCrmDeal</a>({ ...params }) -> Schematic.UpsertCrmDealResponse</code></summary>
|
|
6207
6512
|
<dl>
|
|
6208
6513
|
<dd>
|
|
6209
6514
|
|
|
@@ -6216,25 +6521,10 @@ await client.plans.getAudience("plan_audience_id");
|
|
|
6216
6521
|
<dd>
|
|
6217
6522
|
|
|
6218
6523
|
```typescript
|
|
6219
|
-
await client.
|
|
6220
|
-
|
|
6221
|
-
|
|
6222
|
-
|
|
6223
|
-
{
|
|
6224
|
-
conditionType: "company",
|
|
6225
|
-
operator: "eq",
|
|
6226
|
-
resourceIds: ["resource_ids"],
|
|
6227
|
-
},
|
|
6228
|
-
],
|
|
6229
|
-
},
|
|
6230
|
-
],
|
|
6231
|
-
conditions: [
|
|
6232
|
-
{
|
|
6233
|
-
conditionType: "company",
|
|
6234
|
-
operator: "eq",
|
|
6235
|
-
resourceIds: ["resource_ids"],
|
|
6236
|
-
},
|
|
6237
|
-
],
|
|
6524
|
+
await client.crm.upsertCrmDeal({
|
|
6525
|
+
crmCompanyKey: "crm_company_key",
|
|
6526
|
+
crmType: "crm_type",
|
|
6527
|
+
dealExternalId: "deal_external_id",
|
|
6238
6528
|
});
|
|
6239
6529
|
```
|
|
6240
6530
|
|
|
@@ -6251,15 +6541,7 @@ await client.plans.updateAudience("plan_audience_id", {
|
|
|
6251
6541
|
<dl>
|
|
6252
6542
|
<dd>
|
|
6253
6543
|
|
|
6254
|
-
**
|
|
6255
|
-
|
|
6256
|
-
</dd>
|
|
6257
|
-
</dl>
|
|
6258
|
-
|
|
6259
|
-
<dl>
|
|
6260
|
-
<dd>
|
|
6261
|
-
|
|
6262
|
-
**request:** `Schematic.UpdateAudienceRequestBody`
|
|
6544
|
+
**request:** `Schematic.CreateCrmDealRequestBody`
|
|
6263
6545
|
|
|
6264
6546
|
</dd>
|
|
6265
6547
|
</dl>
|
|
@@ -6267,7 +6549,7 @@ await client.plans.updateAudience("plan_audience_id", {
|
|
|
6267
6549
|
<dl>
|
|
6268
6550
|
<dd>
|
|
6269
6551
|
|
|
6270
|
-
**requestOptions:** `
|
|
6552
|
+
**requestOptions:** `Crm.RequestOptions`
|
|
6271
6553
|
|
|
6272
6554
|
</dd>
|
|
6273
6555
|
</dl>
|
|
@@ -6278,7 +6560,7 @@ await client.plans.updateAudience("plan_audience_id", {
|
|
|
6278
6560
|
</dl>
|
|
6279
6561
|
</details>
|
|
6280
6562
|
|
|
6281
|
-
<details><summary><code>client.
|
|
6563
|
+
<details><summary><code>client.crm.<a href="/src/api/resources/crm/client/Client.ts">listCrmProducts</a>({ ...params }) -> Schematic.ListCrmProductsResponse</code></summary>
|
|
6282
6564
|
<dl>
|
|
6283
6565
|
<dd>
|
|
6284
6566
|
|
|
@@ -6291,7 +6573,7 @@ await client.plans.updateAudience("plan_audience_id", {
|
|
|
6291
6573
|
<dd>
|
|
6292
6574
|
|
|
6293
6575
|
```typescript
|
|
6294
|
-
await client.
|
|
6576
|
+
await client.crm.listCrmProducts();
|
|
6295
6577
|
```
|
|
6296
6578
|
|
|
6297
6579
|
</dd>
|
|
@@ -6307,7 +6589,7 @@ await client.plans.deleteAudience("plan_audience_id");
|
|
|
6307
6589
|
<dl>
|
|
6308
6590
|
<dd>
|
|
6309
6591
|
|
|
6310
|
-
**
|
|
6592
|
+
**request:** `Schematic.ListCrmProductsRequest`
|
|
6311
6593
|
|
|
6312
6594
|
</dd>
|
|
6313
6595
|
</dl>
|
|
@@ -6315,7 +6597,7 @@ await client.plans.deleteAudience("plan_audience_id");
|
|
|
6315
6597
|
<dl>
|
|
6316
6598
|
<dd>
|
|
6317
6599
|
|
|
6318
|
-
**requestOptions:** `
|
|
6600
|
+
**requestOptions:** `Crm.RequestOptions`
|
|
6319
6601
|
|
|
6320
6602
|
</dd>
|
|
6321
6603
|
</dl>
|
|
@@ -6326,7 +6608,7 @@ await client.plans.deleteAudience("plan_audience_id");
|
|
|
6326
6608
|
</dl>
|
|
6327
6609
|
</details>
|
|
6328
6610
|
|
|
6329
|
-
<details><summary><code>client.
|
|
6611
|
+
<details><summary><code>client.crm.<a href="/src/api/resources/crm/client/Client.ts">upsertCrmProduct</a>({ ...params }) -> Schematic.UpsertCrmProductResponse</code></summary>
|
|
6330
6612
|
<dl>
|
|
6331
6613
|
<dd>
|
|
6332
6614
|
|
|
@@ -6339,7 +6621,16 @@ await client.plans.deleteAudience("plan_audience_id");
|
|
|
6339
6621
|
<dd>
|
|
6340
6622
|
|
|
6341
6623
|
```typescript
|
|
6342
|
-
await client.
|
|
6624
|
+
await client.crm.upsertCrmProduct({
|
|
6625
|
+
currency: "currency",
|
|
6626
|
+
description: "description",
|
|
6627
|
+
externalId: "external_id",
|
|
6628
|
+
interval: "interval",
|
|
6629
|
+
name: "name",
|
|
6630
|
+
price: "price",
|
|
6631
|
+
quantity: 1,
|
|
6632
|
+
sku: "sku",
|
|
6633
|
+
});
|
|
6343
6634
|
```
|
|
6344
6635
|
|
|
6345
6636
|
</dd>
|
|
@@ -6355,7 +6646,7 @@ await client.plans.listPlans();
|
|
|
6355
6646
|
<dl>
|
|
6356
6647
|
<dd>
|
|
6357
6648
|
|
|
6358
|
-
**request:** `Schematic.
|
|
6649
|
+
**request:** `Schematic.CreateCrmProductRequestBody`
|
|
6359
6650
|
|
|
6360
6651
|
</dd>
|
|
6361
6652
|
</dl>
|
|
@@ -6363,7 +6654,7 @@ await client.plans.listPlans();
|
|
|
6363
6654
|
<dl>
|
|
6364
6655
|
<dd>
|
|
6365
6656
|
|
|
6366
|
-
**requestOptions:** `
|
|
6657
|
+
**requestOptions:** `Crm.RequestOptions`
|
|
6367
6658
|
|
|
6368
6659
|
</dd>
|
|
6369
6660
|
</dl>
|
|
@@ -6374,7 +6665,9 @@ await client.plans.listPlans();
|
|
|
6374
6665
|
</dl>
|
|
6375
6666
|
</details>
|
|
6376
6667
|
|
|
6377
|
-
|
|
6668
|
+
## events
|
|
6669
|
+
|
|
6670
|
+
<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">createEventBatch</a>({ ...params }) -> Schematic.CreateEventBatchResponse</code></summary>
|
|
6378
6671
|
<dl>
|
|
6379
6672
|
<dd>
|
|
6380
6673
|
|
|
@@ -6387,10 +6680,12 @@ await client.plans.listPlans();
|
|
|
6387
6680
|
<dd>
|
|
6388
6681
|
|
|
6389
6682
|
```typescript
|
|
6390
|
-
await client.
|
|
6391
|
-
|
|
6392
|
-
|
|
6393
|
-
|
|
6683
|
+
await client.events.createEventBatch({
|
|
6684
|
+
events: [
|
|
6685
|
+
{
|
|
6686
|
+
eventType: "identify",
|
|
6687
|
+
},
|
|
6688
|
+
],
|
|
6394
6689
|
});
|
|
6395
6690
|
```
|
|
6396
6691
|
|
|
@@ -6407,7 +6702,7 @@ await client.plans.createPlan({
|
|
|
6407
6702
|
<dl>
|
|
6408
6703
|
<dd>
|
|
6409
6704
|
|
|
6410
|
-
**request:** `Schematic.
|
|
6705
|
+
**request:** `Schematic.CreateEventBatchRequestBody`
|
|
6411
6706
|
|
|
6412
6707
|
</dd>
|
|
6413
6708
|
</dl>
|
|
@@ -6415,7 +6710,7 @@ await client.plans.createPlan({
|
|
|
6415
6710
|
<dl>
|
|
6416
6711
|
<dd>
|
|
6417
6712
|
|
|
6418
|
-
**requestOptions:** `
|
|
6713
|
+
**requestOptions:** `Events.RequestOptions`
|
|
6419
6714
|
|
|
6420
6715
|
</dd>
|
|
6421
6716
|
</dl>
|
|
@@ -6426,7 +6721,7 @@ await client.plans.createPlan({
|
|
|
6426
6721
|
</dl>
|
|
6427
6722
|
</details>
|
|
6428
6723
|
|
|
6429
|
-
<details><summary><code>client.
|
|
6724
|
+
<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">getEventSummaries</a>({ ...params }) -> Schematic.GetEventSummariesResponse</code></summary>
|
|
6430
6725
|
<dl>
|
|
6431
6726
|
<dd>
|
|
6432
6727
|
|
|
@@ -6439,7 +6734,7 @@ await client.plans.createPlan({
|
|
|
6439
6734
|
<dd>
|
|
6440
6735
|
|
|
6441
6736
|
```typescript
|
|
6442
|
-
await client.
|
|
6737
|
+
await client.events.getEventSummaries();
|
|
6443
6738
|
```
|
|
6444
6739
|
|
|
6445
6740
|
</dd>
|
|
@@ -6455,7 +6750,7 @@ await client.plans.getPlan("plan_id");
|
|
|
6455
6750
|
<dl>
|
|
6456
6751
|
<dd>
|
|
6457
6752
|
|
|
6458
|
-
**
|
|
6753
|
+
**request:** `Schematic.GetEventSummariesRequest`
|
|
6459
6754
|
|
|
6460
6755
|
</dd>
|
|
6461
6756
|
</dl>
|
|
@@ -6463,7 +6758,7 @@ await client.plans.getPlan("plan_id");
|
|
|
6463
6758
|
<dl>
|
|
6464
6759
|
<dd>
|
|
6465
6760
|
|
|
6466
|
-
**requestOptions:** `
|
|
6761
|
+
**requestOptions:** `Events.RequestOptions`
|
|
6467
6762
|
|
|
6468
6763
|
</dd>
|
|
6469
6764
|
</dl>
|
|
@@ -6474,7 +6769,7 @@ await client.plans.getPlan("plan_id");
|
|
|
6474
6769
|
</dl>
|
|
6475
6770
|
</details>
|
|
6476
6771
|
|
|
6477
|
-
<details><summary><code>client.
|
|
6772
|
+
<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">listEvents</a>({ ...params }) -> Schematic.ListEventsResponse</code></summary>
|
|
6478
6773
|
<dl>
|
|
6479
6774
|
<dd>
|
|
6480
6775
|
|
|
@@ -6487,9 +6782,7 @@ await client.plans.getPlan("plan_id");
|
|
|
6487
6782
|
<dd>
|
|
6488
6783
|
|
|
6489
6784
|
```typescript
|
|
6490
|
-
await client.
|
|
6491
|
-
name: "name",
|
|
6492
|
-
});
|
|
6785
|
+
await client.events.listEvents();
|
|
6493
6786
|
```
|
|
6494
6787
|
|
|
6495
6788
|
</dd>
|
|
@@ -6505,15 +6798,7 @@ await client.plans.updatePlan("plan_id", {
|
|
|
6505
6798
|
<dl>
|
|
6506
6799
|
<dd>
|
|
6507
6800
|
|
|
6508
|
-
**
|
|
6509
|
-
|
|
6510
|
-
</dd>
|
|
6511
|
-
</dl>
|
|
6512
|
-
|
|
6513
|
-
<dl>
|
|
6514
|
-
<dd>
|
|
6515
|
-
|
|
6516
|
-
**request:** `Schematic.UpdatePlanRequestBody`
|
|
6801
|
+
**request:** `Schematic.ListEventsRequest`
|
|
6517
6802
|
|
|
6518
6803
|
</dd>
|
|
6519
6804
|
</dl>
|
|
@@ -6521,7 +6806,7 @@ await client.plans.updatePlan("plan_id", {
|
|
|
6521
6806
|
<dl>
|
|
6522
6807
|
<dd>
|
|
6523
6808
|
|
|
6524
|
-
**requestOptions:** `
|
|
6809
|
+
**requestOptions:** `Events.RequestOptions`
|
|
6525
6810
|
|
|
6526
6811
|
</dd>
|
|
6527
6812
|
</dl>
|
|
@@ -6532,7 +6817,7 @@ await client.plans.updatePlan("plan_id", {
|
|
|
6532
6817
|
</dl>
|
|
6533
6818
|
</details>
|
|
6534
6819
|
|
|
6535
|
-
<details><summary><code>client.
|
|
6820
|
+
<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">createEvent</a>({ ...params }) -> Schematic.CreateEventResponse</code></summary>
|
|
6536
6821
|
<dl>
|
|
6537
6822
|
<dd>
|
|
6538
6823
|
|
|
@@ -6545,7 +6830,9 @@ await client.plans.updatePlan("plan_id", {
|
|
|
6545
6830
|
<dd>
|
|
6546
6831
|
|
|
6547
6832
|
```typescript
|
|
6548
|
-
await client.
|
|
6833
|
+
await client.events.createEvent({
|
|
6834
|
+
eventType: "identify",
|
|
6835
|
+
});
|
|
6549
6836
|
```
|
|
6550
6837
|
|
|
6551
6838
|
</dd>
|
|
@@ -6561,7 +6848,7 @@ await client.plans.deletePlan("plan_id");
|
|
|
6561
6848
|
<dl>
|
|
6562
6849
|
<dd>
|
|
6563
6850
|
|
|
6564
|
-
**
|
|
6851
|
+
**request:** `Schematic.CreateEventRequestBody`
|
|
6565
6852
|
|
|
6566
6853
|
</dd>
|
|
6567
6854
|
</dl>
|
|
@@ -6569,7 +6856,7 @@ await client.plans.deletePlan("plan_id");
|
|
|
6569
6856
|
<dl>
|
|
6570
6857
|
<dd>
|
|
6571
6858
|
|
|
6572
|
-
**requestOptions:** `
|
|
6859
|
+
**requestOptions:** `Events.RequestOptions`
|
|
6573
6860
|
|
|
6574
6861
|
</dd>
|
|
6575
6862
|
</dl>
|
|
@@ -6580,7 +6867,7 @@ await client.plans.deletePlan("plan_id");
|
|
|
6580
6867
|
</dl>
|
|
6581
6868
|
</details>
|
|
6582
6869
|
|
|
6583
|
-
<details><summary><code>client.
|
|
6870
|
+
<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">getEvent</a>(eventId) -> Schematic.GetEventResponse</code></summary>
|
|
6584
6871
|
<dl>
|
|
6585
6872
|
<dd>
|
|
6586
6873
|
|
|
@@ -6593,10 +6880,7 @@ await client.plans.deletePlan("plan_id");
|
|
|
6593
6880
|
<dd>
|
|
6594
6881
|
|
|
6595
6882
|
```typescript
|
|
6596
|
-
await client.
|
|
6597
|
-
isFreePlan: true,
|
|
6598
|
-
isTrialable: true,
|
|
6599
|
-
});
|
|
6883
|
+
await client.events.getEvent("event_id");
|
|
6600
6884
|
```
|
|
6601
6885
|
|
|
6602
6886
|
</dd>
|
|
@@ -6612,15 +6896,7 @@ await client.plans.upsertBillingProductPlan("plan_id", {
|
|
|
6612
6896
|
<dl>
|
|
6613
6897
|
<dd>
|
|
6614
6898
|
|
|
6615
|
-
**
|
|
6616
|
-
|
|
6617
|
-
</dd>
|
|
6618
|
-
</dl>
|
|
6619
|
-
|
|
6620
|
-
<dl>
|
|
6621
|
-
<dd>
|
|
6622
|
-
|
|
6623
|
-
**request:** `Schematic.UpsertBillingProductRequestBody`
|
|
6899
|
+
**eventId:** `string` — event_id
|
|
6624
6900
|
|
|
6625
6901
|
</dd>
|
|
6626
6902
|
</dl>
|
|
@@ -6628,7 +6904,7 @@ await client.plans.upsertBillingProductPlan("plan_id", {
|
|
|
6628
6904
|
<dl>
|
|
6629
6905
|
<dd>
|
|
6630
6906
|
|
|
6631
|
-
**requestOptions:** `
|
|
6907
|
+
**requestOptions:** `Events.RequestOptions`
|
|
6632
6908
|
|
|
6633
6909
|
</dd>
|
|
6634
6910
|
</dl>
|
|
@@ -6639,7 +6915,7 @@ await client.plans.upsertBillingProductPlan("plan_id", {
|
|
|
6639
6915
|
</dl>
|
|
6640
6916
|
</details>
|
|
6641
6917
|
|
|
6642
|
-
<details><summary><code>client.
|
|
6918
|
+
<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">getSegmentIntegrationStatus</a>() -> Schematic.GetSegmentIntegrationStatusResponse</code></summary>
|
|
6643
6919
|
<dl>
|
|
6644
6920
|
<dd>
|
|
6645
6921
|
|
|
@@ -6652,7 +6928,7 @@ await client.plans.upsertBillingProductPlan("plan_id", {
|
|
|
6652
6928
|
<dd>
|
|
6653
6929
|
|
|
6654
6930
|
```typescript
|
|
6655
|
-
await client.
|
|
6931
|
+
await client.events.getSegmentIntegrationStatus();
|
|
6656
6932
|
```
|
|
6657
6933
|
|
|
6658
6934
|
</dd>
|
|
@@ -6668,15 +6944,7 @@ await client.plans.countPlans();
|
|
|
6668
6944
|
<dl>
|
|
6669
6945
|
<dd>
|
|
6670
6946
|
|
|
6671
|
-
**
|
|
6672
|
-
|
|
6673
|
-
</dd>
|
|
6674
|
-
</dl>
|
|
6675
|
-
|
|
6676
|
-
<dl>
|
|
6677
|
-
<dd>
|
|
6678
|
-
|
|
6679
|
-
**requestOptions:** `Plans.RequestOptions`
|
|
6947
|
+
**requestOptions:** `Events.RequestOptions`
|
|
6680
6948
|
|
|
6681
6949
|
</dd>
|
|
6682
6950
|
</dl>
|