@outseta/api-client 0.2.0 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +17 -19
- package/package.json +3 -6
- package/src/__tests__/accounts-crud.integration.test.ts +41 -39
- package/src/__tests__/client.test.ts +3 -3
- package/src/__tests__/people.integration.test.ts +28 -32
- package/src/__tests__/setup.ts +5 -6
- package/src/__tests__/support.integration.test.ts +28 -35
- package/src/client.ts +38 -23
- package/src/generated/activity/activity.ts +115 -0
- package/src/generated/billing/billing.ts +786 -0
- package/src/generated/crm/crm.ts +1143 -221
- package/src/generated/email/email.ts +578 -0
- package/src/generated/models/abstractBean.ts +2 -220
- package/src/generated/models/abstractQcountBean.ts +0 -220
- package/src/generated/models/abstractQcountBeanAllOf.ts +0 -220
- package/src/generated/models/abstractQcountBeanAllOfActivityEventData.ts +0 -220
- package/src/generated/models/abstractSchemaLessBean.ts +0 -220
- package/src/generated/models/abstractSchemaLessBeanAllOf.ts +0 -220
- package/src/generated/models/abstractSchemaLessBeanAllOfSchemaLessData.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfCharge.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfChargeAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfCoupon.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfCouponAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfCreditNote.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfCreditNoteAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfCustomer.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfCustomerAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfDiscount.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfDiscountAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfInvoice.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfInvoiceAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfInvoiceLineItem.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfInvoiceLineItemAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfInvoicePayment.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfInvoicePaymentAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfMeter.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfMeterAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfPaymentMethod.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfPaymentMethodAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfPrice.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfPriceAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfProduct.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfProductAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfPromotionCode.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfPromotionCodeAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfRefund.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfRefundAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfSubscription.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfSubscriptionAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfSubscriptionItem.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfSubscriptionItemAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfSubscriptionSchedule.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfSubscriptionScheduleAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfSubscriptionSchedulePhase.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfSubscriptionSchedulePhaseAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfSubscriptionSchedulePhaseItem.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfSubscriptionSchedulePhaseItemAllOf.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfTaxId.ts +0 -220
- package/src/generated/models/abstractStripeBeanOfTaxIdAllOf.ts +0 -220
- package/src/generated/models/acceptTermsAndConditionsLocations.ts +0 -220
- package/src/generated/models/account.ts +0 -220
- package/src/generated/models/accountAddAccountBody.ts +0 -220
- package/src/generated/models/accountAddAccountParams.ts +0 -220
- package/src/generated/models/accountAddPersonToAccountBody.ts +7 -0
- package/src/generated/models/accountAllOf.ts +0 -220
- package/src/generated/models/accountAllOfBillingAddress.ts +0 -220
- package/src/generated/models/accountAllOfCurrentSubscription.ts +0 -220
- package/src/generated/models/accountAllOfLatestSubscription.ts +0 -220
- package/src/generated/models/accountAllOfMailingAddress.ts +0 -220
- package/src/generated/models/accountAllOfPaymentInformation.ts +0 -220
- package/src/generated/models/accountAllOfPrimaryContact.ts +0 -220
- package/src/generated/models/accountAllOfPrimaryStripeSubscription.ts +0 -220
- package/src/generated/models/accountAllOfPrimarySubscription.ts +0 -220
- package/src/generated/models/accountCancelAccountBody.ts +7 -0
- package/src/generated/models/accountCancelation.ts +0 -220
- package/src/generated/models/accountCancelationAllOf.ts +2 -220
- package/src/generated/models/accountCancelationAllOfAccount.ts +0 -220
- package/src/generated/models/accountCancelationAllOfLastPlan.ts +0 -220
- package/src/generated/models/accountExtendTrialBody.ts +7 -0
- package/src/generated/models/accountGetAllAccountsParams.ts +0 -220
- package/src/generated/models/accountRegistrationMode.ts +0 -220
- package/src/generated/models/accountStage.ts +2 -221
- package/src/generated/models/accountTaxId.ts +0 -220
- package/src/generated/models/accountTaxIdAllOf.ts +0 -220
- package/src/generated/models/accountTaxIdAllOfAccount.ts +0 -220
- package/src/generated/models/accountUpdateAccountBody.ts +7 -0
- package/src/generated/models/accountUpdateMembershipBody.ts +7 -0
- package/src/generated/models/activity.ts +0 -220
- package/src/generated/models/activityAddCustomActivityBody.ts +7 -0
- package/src/generated/models/activityAllOf.ts +0 -220
- package/src/generated/models/activityCRMDealTrigger.ts +0 -220
- package/src/generated/models/activityCRMDealTriggerAllOf.ts +0 -220
- package/src/generated/models/activityCRMDealTriggerAllOfDealPipelineStage.ts +0 -220
- package/src/generated/models/activityCriteria.ts +0 -220
- package/src/generated/models/activityCriteriaActivityType.ts +0 -220
- package/src/generated/models/activityGetAllParams.ts +21 -0
- package/src/generated/models/activityNotification.ts +0 -220
- package/src/generated/models/activityNotificationAllOf.ts +0 -220
- package/src/generated/models/activityType.ts +0 -220
- package/src/generated/models/addOn.ts +0 -220
- package/src/generated/models/addOnAllOf.ts +0 -220
- package/src/generated/models/address.ts +0 -220
- package/src/generated/models/addressAllOf.ts +0 -220
- package/src/generated/models/apiKey.ts +0 -220
- package/src/generated/models/apiKeyAllOf.ts +0 -225
- package/src/generated/models/apiKeyAllOfQcount.ts +0 -220
- package/src/generated/models/apiKeyType.ts +0 -220
- package/src/generated/models/article.ts +0 -220
- package/src/generated/models/articleAllOf.ts +0 -220
- package/src/generated/models/articleAllOfCategory.ts +0 -220
- package/src/generated/models/articleGetAllArticlesParams.ts +8 -0
- package/src/generated/models/backGroundTaskType.ts +3 -221
- package/src/generated/models/billSettings.ts +0 -220
- package/src/generated/models/billSettingsAllOf.ts +0 -220
- package/src/generated/models/billingAddOnType.ts +0 -220
- package/src/generated/models/billingDiscountDuration.ts +0 -220
- package/src/generated/models/billingInvoiceStatus.ts +0 -220
- package/src/generated/models/billingRenewalTerm.ts +0 -220
- package/src/generated/models/billingSystem.ts +0 -220
- package/src/generated/models/billingTransactionType.ts +0 -220
- package/src/generated/models/broadcastCampaign.ts +0 -220
- package/src/generated/models/broadcastCampaignAllOf.ts +4 -220
- package/src/generated/models/broadcastCampaignAllOfCampaign.ts +0 -220
- package/src/generated/models/broadcastCampaignAllOfMessage.ts +0 -220
- package/src/generated/models/broadcastCampaignStatus.ts +2 -221
- package/src/generated/models/campaign.ts +0 -220
- package/src/generated/models/campaignAddBroadcastEmailBody.ts +7 -0
- package/src/generated/models/campaignAllOf.ts +0 -220
- package/src/generated/models/campaignSendTestCampaignEmailBody.ts +7 -0
- package/src/generated/models/campaignType.ts +0 -220
- package/src/generated/models/campaignUpdateBroadcastEmailBody.ts +7 -0
- package/src/generated/models/cancelationStatus.ts +16 -0
- package/src/generated/models/case.ts +0 -220
- package/src/generated/models/caseAddCaseBody.ts +7 -0
- package/src/generated/models/caseAddCaseParams.ts +9 -0
- package/src/generated/models/caseAllOf.ts +0 -220
- package/src/generated/models/caseAllOfLastCaseHistory.ts +0 -220
- package/src/generated/models/caseGetAllCasesParams.ts +0 -220
- package/src/generated/models/caseHistory.ts +0 -220
- package/src/generated/models/caseHistoryAllOf.ts +0 -220
- package/src/generated/models/caseTag.ts +0 -220
- package/src/generated/models/caseTagAllOf.ts +0 -220
- package/src/generated/models/caseTagAllOfCase.ts +0 -220
- package/src/generated/models/caseTagAllOfTag.ts +0 -220
- package/src/generated/models/category.ts +0 -220
- package/src/generated/models/categoryAllOf.ts +0 -220
- package/src/generated/models/chatSettings.ts +0 -220
- package/src/generated/models/chatSettingsAllOf.ts +0 -220
- package/src/generated/models/clientApplication.ts +0 -220
- package/src/generated/models/clientApplicationAllOf.ts +0 -220
- package/src/generated/models/contentGroup.ts +0 -220
- package/src/generated/models/contentGroupAllOf.ts +0 -220
- package/src/generated/models/contentGroupItem.ts +0 -220
- package/src/generated/models/contentGroupItemAllOf.ts +0 -220
- package/src/generated/models/contentGroupItemMatchMode.ts +0 -220
- package/src/generated/models/crmSettings.ts +0 -220
- package/src/generated/models/crmSettingsAllOf.ts +2 -220
- package/src/generated/models/crmSettingsAllOfEmailList.ts +0 -220
- package/src/generated/models/database.ts +0 -220
- package/src/generated/models/databaseAllOf.ts +0 -220
- package/src/generated/models/databaseType.ts +0 -220
- package/src/generated/models/deal.ts +0 -220
- package/src/generated/models/dealAddDealBody.ts +7 -0
- package/src/generated/models/dealAllOf.ts +0 -220
- package/src/generated/models/dealAllOfAccount.ts +0 -220
- package/src/generated/models/dealAllOfDealPipelineStage.ts +0 -220
- package/src/generated/models/dealAllOfOwner.ts +0 -220
- package/src/generated/models/dealGetAllDealsParams.ts +14 -0
- package/src/generated/models/dealPerson.ts +0 -220
- package/src/generated/models/dealPersonAllOf.ts +0 -220
- package/src/generated/models/dealPersonAllOfDeal.ts +0 -220
- package/src/generated/models/dealPersonAllOfPerson.ts +0 -220
- package/src/generated/models/dealPipeline.ts +0 -220
- package/src/generated/models/dealPipelineAllOf.ts +0 -220
- package/src/generated/models/dealPipelineStage.ts +0 -220
- package/src/generated/models/dealPipelineStageAllOf.ts +0 -220
- package/src/generated/models/dealPipelineStageAllOfDealPipeline.ts +0 -220
- package/src/generated/models/dealUpdateDealBody.ts +7 -0
- package/src/generated/models/definition.ts +0 -220
- package/src/generated/models/definitionAllOf.ts +0 -220
- package/src/generated/models/deserializationStatus.ts +0 -220
- package/src/generated/models/discordRole.ts +0 -220
- package/src/generated/models/discordRoleAllOf.ts +0 -220
- package/src/generated/models/discordRoleAllOfDiscordServer.ts +0 -220
- package/src/generated/models/discordRolePlan.ts +0 -220
- package/src/generated/models/discordRolePlanAllOf.ts +0 -220
- package/src/generated/models/discordRolePlanAllOfDiscordRole.ts +0 -220
- package/src/generated/models/discordRolePlanAllOfPlan.ts +0 -220
- package/src/generated/models/discordServer.ts +0 -220
- package/src/generated/models/discordServerAllOf.ts +0 -220
- package/src/generated/models/discordUser.ts +0 -220
- package/src/generated/models/discordUserAllOf.ts +0 -220
- package/src/generated/models/discountCoupon.ts +0 -220
- package/src/generated/models/discountCouponAddDiscountCouponBody.ts +7 -0
- package/src/generated/models/discountCouponAllOf.ts +0 -220
- package/src/generated/models/discountCouponPlan.ts +0 -220
- package/src/generated/models/discountCouponPlanAllOf.ts +0 -220
- package/src/generated/models/discountCouponPlanAllOfDiscountCoupon.ts +0 -220
- package/src/generated/models/discountCouponPlanAllOfPlan.ts +0 -220
- package/src/generated/models/discountCouponSubscription.ts +0 -220
- package/src/generated/models/discountCouponSubscriptionAllOf.ts +0 -220
- package/src/generated/models/discountCouponSubscriptionAllOfDiscountCoupon.ts +0 -220
- package/src/generated/models/discountCouponSubscriptionAllOfSubscription.ts +0 -220
- package/src/generated/models/dnsEntry.ts +2 -220
- package/src/generated/models/dripCampaign.ts +0 -220
- package/src/generated/models/dripCampaignAllOf.ts +0 -220
- package/src/generated/models/dripCampaignAllOfCampaign.ts +0 -220
- package/src/generated/models/dripCampaignMessage.ts +0 -220
- package/src/generated/models/dripCampaignMessageAllOf.ts +0 -220
- package/src/generated/models/dripCampaignMessageAllOfDripCampaign.ts +0 -220
- package/src/generated/models/dripCampaignMessageAllOfMessage.ts +0 -220
- package/src/generated/models/emailLink.ts +0 -220
- package/src/generated/models/emailLinkAllOf.ts +0 -220
- package/src/generated/models/emailList.ts +0 -220
- package/src/generated/models/emailListAddSubscriptionBody.ts +7 -0
- package/src/generated/models/emailListAllOf.ts +0 -220
- package/src/generated/models/emailListGetAllSubscriptionsParams.ts +9 -0
- package/src/generated/models/emailListPerson.ts +0 -220
- package/src/generated/models/emailListPersonAllOf.ts +0 -220
- package/src/generated/models/emailListPersonAllOfEmailList.ts +0 -220
- package/src/generated/models/emailListPersonAllOfPerson.ts +0 -220
- package/src/generated/models/emailListSubscriberStatus.ts +0 -220
- package/src/generated/models/emailSubscriptionsPayload.ts +0 -220
- package/src/generated/models/entityType.ts +0 -220
- package/src/generated/models/extendRenewalParams.ts +0 -220
- package/src/generated/models/extendSubscriptionOptions.ts +5 -0
- package/src/generated/models/extendTrialParams.ts +0 -220
- package/src/generated/models/flatfileImportData.ts +0 -220
- package/src/generated/models/flatfileImportDataSchemalessData.ts +0 -220
- package/src/generated/models/index.ts +66 -221
- package/src/generated/models/invoice.ts +0 -220
- package/src/generated/models/invoiceAddInvoiceBody.ts +7 -0
- package/src/generated/models/invoiceAllOf.ts +8 -220
- package/src/generated/models/invoiceAllOfSubscription.ts +0 -220
- package/src/generated/models/invoiceCreditOptions.ts +0 -220
- package/src/generated/models/invoiceLineItem.ts +0 -220
- package/src/generated/models/invoiceLineItemAllOf.ts +0 -220
- package/src/generated/models/invoiceLineItemAllOfInvoice.ts +0 -220
- package/src/generated/models/invoiceLineItemAllOfLineItemType.ts +0 -220
- package/src/generated/models/invoiceStatusChangeOptions.ts +0 -220
- package/src/generated/models/jwtKey.ts +0 -220
- package/src/generated/models/jwtKeyAllOf.ts +0 -225
- package/src/generated/models/jwtKeyAllOfQcount.ts +0 -220
- package/src/generated/models/leadForm.ts +0 -220
- package/src/generated/models/leadFormAllOf.ts +0 -220
- package/src/generated/models/leadFormAllOfDealPipelineStage.ts +0 -220
- package/src/generated/models/leadFormSubmission.ts +0 -220
- package/src/generated/models/leadFormSubmissionAllOf.ts +0 -220
- package/src/generated/models/lineItemType.ts +0 -220
- package/src/generated/models/message.ts +0 -220
- package/src/generated/models/messageAllOf.ts +1 -220
- package/src/generated/models/messageAllOfTemplate.ts +0 -220
- package/src/generated/models/noCodeSettings.ts +0 -220
- package/src/generated/models/noCodeSettingsAllOf.ts +0 -220
- package/src/generated/models/noCodeSettingsAllOfAccount.ts +0 -220
- package/src/generated/models/oAuthService.ts +0 -220
- package/src/generated/models/passwordChangeModel.ts +0 -220
- package/src/generated/models/passwordPayload.ts +0 -220
- package/src/generated/models/pauseCollectionOptions.ts +0 -220
- package/src/generated/models/paymentInformation.ts +0 -220
- package/src/generated/models/paymentInformationAllOf.ts +0 -220
- package/src/generated/models/paymentInformationSavePaymentInformationBody.ts +7 -0
- package/src/generated/models/paymentsGatewayActivationStatus.ts +0 -220
- package/src/generated/models/paymentsMode.ts +0 -220
- package/src/generated/models/person.ts +0 -220
- package/src/generated/models/personAccount.ts +0 -220
- package/src/generated/models/personAccountAllOf.ts +0 -220
- package/src/generated/models/personAccountAllOfAccount.ts +0 -220
- package/src/generated/models/personAccountAllOfPerson.ts +0 -220
- package/src/generated/models/personAddPersonBody.ts +7 -0
- package/src/generated/models/personAllOf.ts +3 -233
- package/src/generated/models/personAllOfAccount.ts +0 -220
- package/src/generated/models/personAllOfDiscordUser.ts +0 -220
- package/src/generated/models/personAllOfMailingAddress.ts +0 -220
- package/src/generated/models/personForgotPasswordBody.ts +7 -0
- package/src/generated/models/personGetAllPeopleParams.ts +9 -0
- package/src/generated/models/personSegmentAddedActivityData.ts +11 -0
- package/src/generated/models/personSegmentAddedWebhookPayload.ts +123 -0
- package/src/generated/models/personSegmentAddedWebhookPayloadAccount.ts +141 -0
- package/src/generated/models/personSegmentAddedWebhookPayloadAccountAccountStage.ts +20 -0
- package/src/generated/models/personSegmentAddedWebhookPayloadDealPeopleItem.ts +15 -0
- package/src/generated/models/personSegmentAddedWebhookPayloadDiscordUser.ts +35 -0
- package/src/generated/models/personSegmentAddedWebhookPayloadEmailListPersonItem.ts +48 -0
- package/src/generated/models/personSegmentAddedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus.ts +15 -0
- package/src/generated/models/personSegmentAddedWebhookPayloadLeadFormSubmissionsItem.ts +21 -0
- package/src/generated/models/personSegmentAddedWebhookPayloadMailingAddress.ts +58 -0
- package/src/generated/models/personSegmentAddedWebhookPayloadOAuthIntegrationStatus.ts +13 -0
- package/src/generated/models/personSegmentAddedWebhookPayloadPersonAccountItem.ts +20 -0
- package/src/generated/models/personSegmentAddedWebhookPayloadPersonAccountItemAccount.ts +14 -0
- package/src/generated/models/personSegmentRemovedActivityData.ts +11 -0
- package/src/generated/models/personSegmentRemovedWebhookPayload.ts +123 -0
- package/src/generated/models/personSegmentRemovedWebhookPayloadAccount.ts +141 -0
- package/src/generated/models/personSegmentRemovedWebhookPayloadAccountAccountStage.ts +20 -0
- package/src/generated/models/personSegmentRemovedWebhookPayloadDealPeopleItem.ts +15 -0
- package/src/generated/models/personSegmentRemovedWebhookPayloadDiscordUser.ts +35 -0
- package/src/generated/models/personSegmentRemovedWebhookPayloadEmailListPersonItem.ts +48 -0
- package/src/generated/models/personSegmentRemovedWebhookPayloadEmailListPersonItemEmailListSubscriberStatus.ts +15 -0
- package/src/generated/models/personSegmentRemovedWebhookPayloadLeadFormSubmissionsItem.ts +21 -0
- package/src/generated/models/personSegmentRemovedWebhookPayloadMailingAddress.ts +58 -0
- package/src/generated/models/personSegmentRemovedWebhookPayloadOAuthIntegrationStatus.ts +13 -0
- package/src/generated/models/personSegmentRemovedWebhookPayloadPersonAccountItem.ts +20 -0
- package/src/generated/models/personSegmentRemovedWebhookPayloadPersonAccountItemAccount.ts +14 -0
- package/src/generated/models/personSetTemporaryPasswordBody.ts +7 -0
- package/src/generated/models/personUpdatePersonBody.ts +7 -0
- package/src/generated/models/plan.ts +0 -220
- package/src/generated/models/planAddOn.ts +0 -220
- package/src/generated/models/planAddOnAllOf.ts +0 -220
- package/src/generated/models/planAddOnAllOfAddOn.ts +0 -220
- package/src/generated/models/planAddOnAllOfPlan.ts +0 -220
- package/src/generated/models/planAllOf.ts +0 -220
- package/src/generated/models/planAllOfPlanFamily.ts +0 -220
- package/src/generated/models/planFamily.ts +0 -220
- package/src/generated/models/planFamilyAllOf.ts +0 -220
- package/src/generated/models/processCodePayload.ts +0 -220
- package/src/generated/models/qcount.ts +1 -221
- package/src/generated/models/qcountAllOf.ts +0 -240
- package/src/generated/models/qcountConfig.ts +0 -220
- package/src/generated/models/qcountConfigAllOf.ts +0 -220
- package/src/generated/models/qcountConfigSettingType.ts +2 -234
- package/src/generated/models/qcountStatus.ts +0 -220
- package/src/generated/models/registrationField.ts +0 -220
- package/src/generated/models/resendEmailsRequest.ts +6 -0
- package/src/generated/models/segment.ts +0 -220
- package/src/generated/models/segmentAllOf.ts +0 -220
- package/src/generated/models/segmentPerson.ts +0 -220
- package/src/generated/models/segmentPersonAllOf.ts +0 -220
- package/src/generated/models/segmentPersonAllOfPerson.ts +0 -220
- package/src/generated/models/segmentPersonAllOfSegment.ts +0 -220
- package/src/generated/models/sendGridDomainAuthentication.ts +0 -220
- package/src/generated/models/sendGridDomainAuthenticationAllOf.ts +1 -220
- package/src/generated/models/sendTestEmailRequest.ts +0 -220
- package/src/generated/models/sendTestEmailRequest2.ts +0 -220
- package/src/generated/models/sendTestEmailRequest2BroadcastCampaign.ts +0 -220
- package/src/generated/models/sendTestEmailRequestDripCampaign.ts +0 -220
- package/src/generated/models/sessionFlowDataAfterCompletionHostedConfirmationOptions.ts +0 -220
- package/src/generated/models/sessionFlowDataAfterCompletionOptions.ts +0 -220
- package/src/generated/models/sessionFlowDataAfterCompletionOptionsHostedConfirmation.ts +0 -220
- package/src/generated/models/sessionFlowDataAfterCompletionOptionsRedirect.ts +0 -220
- package/src/generated/models/sessionFlowDataAfterCompletionRedirectOptions.ts +0 -220
- package/src/generated/models/sessionFlowDataOptions.ts +0 -220
- package/src/generated/models/sessionFlowDataOptionsAfterCompletion.ts +0 -220
- package/src/generated/models/sessionFlowDataOptionsSubscriptionCancel.ts +0 -220
- package/src/generated/models/sessionFlowDataOptionsSubscriptionUpdate.ts +0 -220
- package/src/generated/models/sessionFlowDataOptionsSubscriptionUpdateConfirm.ts +0 -220
- package/src/generated/models/sessionFlowDataSubscriptionCancelOptions.ts +0 -220
- package/src/generated/models/sessionFlowDataSubscriptionCancelOptionsRetention.ts +0 -220
- package/src/generated/models/sessionFlowDataSubscriptionCancelRetentionCouponOfferOptions.ts +0 -220
- package/src/generated/models/sessionFlowDataSubscriptionCancelRetentionOptions.ts +0 -220
- package/src/generated/models/sessionFlowDataSubscriptionCancelRetentionOptionsCouponOffer.ts +0 -220
- package/src/generated/models/sessionFlowDataSubscriptionUpdateConfirmDiscountOptions.ts +0 -220
- package/src/generated/models/sessionFlowDataSubscriptionUpdateConfirmItemOptions.ts +0 -220
- package/src/generated/models/sessionFlowDataSubscriptionUpdateConfirmOptions.ts +0 -220
- package/src/generated/models/sessionFlowDataSubscriptionUpdateOptions.ts +0 -220
- package/src/generated/models/setupIntent.ts +2 -220
- package/src/generated/models/setupIntentBillingAddress.ts +0 -220
- package/src/generated/models/slackChannelSetting.ts +0 -220
- package/src/generated/models/spamStatus.ts +0 -220
- package/src/generated/models/stripeBillingSyncParams.ts +0 -220
- package/src/generated/models/stripeCharge.ts +0 -220
- package/src/generated/models/stripeChargeAllOf.ts +0 -220
- package/src/generated/models/stripeChargeAllOfAccount.ts +0 -220
- package/src/generated/models/stripeChargeAllOfStripePaymentMethod.ts +0 -220
- package/src/generated/models/stripeCheckoutParams.ts +0 -220
- package/src/generated/models/stripeCoupon.ts +0 -220
- package/src/generated/models/stripeCouponAllOf.ts +0 -220
- package/src/generated/models/stripeCreditNote.ts +0 -220
- package/src/generated/models/stripeCreditNoteAllOf.ts +9 -220
- package/src/generated/models/stripeDiscount.ts +0 -220
- package/src/generated/models/stripeDiscountAllOf.ts +0 -220
- package/src/generated/models/stripeDiscountAllOfAccount.ts +0 -220
- package/src/generated/models/stripeDiscountAllOfStripeCoupon.ts +0 -220
- package/src/generated/models/stripeDiscountAllOfStripeInvoice.ts +0 -220
- package/src/generated/models/stripeDiscountAllOfStripePromotionCode.ts +0 -220
- package/src/generated/models/stripeDiscountAllOfStripeSubscription.ts +0 -220
- package/src/generated/models/stripeInvoice.ts +0 -220
- package/src/generated/models/stripeInvoiceAllOf.ts +9 -220
- package/src/generated/models/stripeInvoiceAllOfAccount.ts +0 -220
- package/src/generated/models/stripeInvoiceDiscountAmount.ts +0 -220
- package/src/generated/models/stripeInvoiceDiscountAmountAllOf.ts +0 -220
- package/src/generated/models/stripeInvoiceDiscountAmountAllOfStripeDiscount.ts +0 -220
- package/src/generated/models/stripeInvoiceDiscountAmountAllOfStripeInvoice.ts +0 -220
- package/src/generated/models/stripeInvoiceLineItem.ts +0 -220
- package/src/generated/models/stripeInvoiceLineItemAllOf.ts +0 -220
- package/src/generated/models/stripeInvoiceLineItemAllOfStripeInvoice.ts +0 -220
- package/src/generated/models/stripeInvoiceLineItemAllOfStripePrice.ts +0 -220
- package/src/generated/models/stripeInvoicePayment.ts +0 -220
- package/src/generated/models/stripeInvoicePaymentAllOf.ts +0 -220
- package/src/generated/models/stripeInvoicePaymentAllOfStripeInvoice.ts +0 -220
- package/src/generated/models/stripeMeter.ts +0 -220
- package/src/generated/models/stripeMeterAllOf.ts +0 -220
- package/src/generated/models/stripePaymentMethod.ts +0 -220
- package/src/generated/models/stripePaymentMethodAllOf.ts +0 -220
- package/src/generated/models/stripePaymentMethodAllOfAccount.ts +0 -220
- package/src/generated/models/stripePrice.ts +0 -220
- package/src/generated/models/stripePriceAllOf.ts +2 -220
- package/src/generated/models/stripePriceAllOfRecurringStripeMeter.ts +0 -220
- package/src/generated/models/stripePriceAllOfStripeProduct.ts +0 -220
- package/src/generated/models/stripeProduct.ts +0 -220
- package/src/generated/models/stripeProductAllOf.ts +5 -220
- package/src/generated/models/stripeProductAllOfStripeProductFamily.ts +0 -220
- package/src/generated/models/stripeProductCrossSell.ts +0 -220
- package/src/generated/models/stripeProductCrossSellAllOf.ts +0 -220
- package/src/generated/models/stripeProductCrossSellAllOfCrossSellProduct.ts +0 -220
- package/src/generated/models/stripeProductCrossSellAllOfStripeProduct.ts +0 -220
- package/src/generated/models/stripeProductFamily.ts +0 -220
- package/src/generated/models/stripeProductFamilyAllOf.ts +0 -220
- package/src/generated/models/stripePromotionCode.ts +0 -220
- package/src/generated/models/stripePromotionCodeAllOf.ts +0 -220
- package/src/generated/models/stripePromotionCodeAllOfAccount.ts +0 -220
- package/src/generated/models/stripePromotionCodeAllOfStripeCoupon.ts +0 -220
- package/src/generated/models/stripeRefund.ts +0 -220
- package/src/generated/models/stripeRefundAllOf.ts +0 -220
- package/src/generated/models/stripeRefundAllOfStripeCharge.ts +0 -220
- package/src/generated/models/stripeSubscription.ts +0 -220
- package/src/generated/models/stripeSubscriptionAllOf.ts +4 -220
- package/src/generated/models/stripeSubscriptionAllOfAccount.ts +0 -220
- package/src/generated/models/stripeSubscriptionAllOfCurrentStripeSubscriptionSchedule.ts +0 -220
- package/src/generated/models/stripeSubscriptionAllOfStripeSubscriptionCancellation.ts +0 -220
- package/src/generated/models/stripeSubscriptionCancellation.ts +0 -220
- package/src/generated/models/stripeSubscriptionCancellationAllOf.ts +0 -220
- package/src/generated/models/stripeSubscriptionItem.ts +0 -220
- package/src/generated/models/stripeSubscriptionItemAllOf.ts +0 -220
- package/src/generated/models/stripeSubscriptionItemAllOfStripePrice.ts +0 -220
- package/src/generated/models/stripeSubscriptionItemAllOfStripeSubscription.ts +0 -220
- package/src/generated/models/stripeSubscriptionSchedule.ts +0 -220
- package/src/generated/models/stripeSubscriptionScheduleAllOf.ts +0 -220
- package/src/generated/models/stripeSubscriptionScheduleAllOfStripeSubscription.ts +0 -220
- package/src/generated/models/stripeSubscriptionSchedulePhase.ts +0 -220
- package/src/generated/models/stripeSubscriptionSchedulePhaseAllOf.ts +0 -220
- package/src/generated/models/stripeSubscriptionSchedulePhaseAllOfStripeSubscriptionSchedule.ts +0 -220
- package/src/generated/models/stripeSubscriptionSchedulePhaseItem.ts +0 -220
- package/src/generated/models/stripeSubscriptionSchedulePhaseItemAllOf.ts +0 -220
- package/src/generated/models/stripeSubscriptionSchedulePhaseItemAllOfStripePrice.ts +0 -220
- package/src/generated/models/subscription.ts +0 -220
- package/src/generated/models/subscriptionAddOn.ts +0 -220
- package/src/generated/models/subscriptionAddOnAddSubscriptionAddOnBody.ts +7 -0
- package/src/generated/models/subscriptionAddOnAllOf.ts +0 -220
- package/src/generated/models/subscriptionAddOnAllOfAddOn.ts +0 -220
- package/src/generated/models/subscriptionAddOnAllOfSubscription.ts +0 -220
- package/src/generated/models/subscriptionAllOf.ts +0 -220
- package/src/generated/models/subscriptionAllOfAccount.ts +0 -220
- package/src/generated/models/subscriptionAllOfLatestInvoice.ts +0 -220
- package/src/generated/models/subscriptionAllOfPlan.ts +0 -220
- package/src/generated/models/subscriptionChangeSubscriptionBody.ts +7 -0
- package/src/generated/models/subscriptionChangeSubscriptionParams.ts +9 -0
- package/src/generated/models/subscriptionChangeSubscriptionPreviewBody.ts +7 -0
- package/src/generated/models/subscriptionChangeSubscriptionPreviewParams.ts +9 -0
- package/src/generated/models/subscriptionFirstTimeSubscriptionBody.ts +7 -0
- package/src/generated/models/subscriptionFirstTimeSubscriptionPreviewBody.ts +7 -0
- package/src/generated/models/subscriptionFirstTimeSubscriptionPreviewParams.ts +9 -0
- package/src/generated/models/subscriptionSetSubscriptionUpgradeRequiredBody.ts +7 -0
- package/src/generated/models/supportArticleStatus.ts +0 -220
- package/src/generated/models/supportCaseHistoryType.ts +0 -220
- package/src/generated/models/supportCaseSource.ts +0 -220
- package/src/generated/models/supportCaseStatus.ts +0 -220
- package/src/generated/models/supportSettings.ts +0 -220
- package/src/generated/models/supportSettingsAllOf.ts +0 -220
- package/src/generated/models/tag.ts +0 -220
- package/src/generated/models/tagAllOf.ts +0 -220
- package/src/generated/models/tagColor.ts +0 -220
- package/src/generated/models/tagUidList.ts +0 -220
- package/src/generated/models/task.ts +0 -220
- package/src/generated/models/taskAllOf.ts +0 -220
- package/src/generated/models/taskAllOfAccount.ts +0 -220
- package/src/generated/models/taskAllOfAssignee.ts +0 -220
- package/src/generated/models/taskAllOfDeal.ts +0 -220
- package/src/generated/models/taskAllOfPerson.ts +0 -220
- package/src/generated/models/taskAllOfType.ts +0 -220
- package/src/generated/models/taskStatus.ts +0 -220
- package/src/generated/models/taskType.ts +0 -220
- package/src/generated/models/taskTypeAllOf.ts +0 -220
- package/src/generated/models/taxRate.ts +0 -220
- package/src/generated/models/taxRateAllOf.ts +0 -220
- package/src/generated/models/template.ts +0 -220
- package/src/generated/models/templateAllOf.ts +0 -220
- package/src/generated/models/temporaryPasswordModel.ts +0 -220
- package/src/generated/models/transaction.ts +0 -220
- package/src/generated/models/transactionAllOf.ts +0 -220
- package/src/generated/models/transactionAllOfAccount.ts +0 -220
- package/src/generated/models/transactionAllOfInvoice.ts +0 -220
- package/src/generated/models/transactionsAddPaymentTransactionBody.ts +7 -0
- package/src/generated/models/translation.ts +0 -220
- package/src/generated/models/translationAllOf.ts +0 -220
- package/src/generated/models/usage.ts +0 -220
- package/src/generated/models/usageAddUsageBody.ts +7 -0
- package/src/generated/models/usageAllOf.ts +0 -220
- package/src/generated/models/usageAllOfInvoice.ts +0 -220
- package/src/generated/models/webflowCollection.ts +0 -220
- package/src/generated/models/webflowConfiguration.ts +0 -220
- package/src/generated/models/webflowConfigurationSyncConfiguration.ts +0 -220
- package/src/generated/models/webflowField.ts +0 -220
- package/src/generated/models/webflowFieldMapping.ts +0 -220
- package/src/generated/models/webflowFieldMappingWebflowField.ts +0 -220
- package/src/generated/models/webflowSite.ts +0 -220
- package/src/generated/models/webflowSyncConfiguration.ts +0 -220
- package/src/generated/models/webflowSyncConfigurationCollection.ts +0 -220
- package/src/generated/models/webflowSyncConfigurationSite.ts +0 -220
- package/src/generated/models/webflowSyncError.ts +0 -220
- package/src/generated/models/webflowSyncItem.ts +0 -220
- package/src/generated/models/webflowSyncLog.ts +0 -220
- package/src/generated/support/support.ts +341 -221
- package/src/index.ts +2 -0
- package/src/generated/models/qcountAllOfLogDatabase.ts +0 -227
- package/src/generated/zod.ts +0 -191087
package/src/generated/crm/crm.ts
CHANGED
|
@@ -1,233 +1,323 @@
|
|
|
1
1
|
// @ts-nocheck
|
|
2
|
-
/**
|
|
3
|
-
* Generated by orval v7.21.0 🍺
|
|
4
|
-
* Do not edit manually.
|
|
5
|
-
* Outseta API
|
|
6
|
-
* # Outseta REST API
|
|
7
|
-
|
|
8
|
-
The Outseta REST API enables you to perform a variety of powerful tasks such as creating and updating people, accounts, subscriptions, and invoices. Outseta uses standard HTTP protocols within a compliant architecture that is simple to integrate. You can use the API both on the client or the server side; see the authentication section below for each scenario.
|
|
9
|
-
|
|
10
|
-
**Base URL:** `https://{your-domain}.outseta.com/api/v1/`
|
|
11
|
-
|
|
12
|
-
## API Guidelines
|
|
13
|
-
|
|
14
|
-
1. The API will only respond to secured communication done over **HTTPS**. HTTP requests will be sent a `301` redirect to the corresponding HTTPS resource.
|
|
15
|
-
2. Responses are sent in **JSON** format. In case the API request results in an error, it is represented by an `"error": {}` key in the JSON response.
|
|
16
|
-
3. The request method (verb) determines the nature of the action: **GET** fetches data, **POST** creates new records, **PUT** updates existing records.
|
|
17
|
-
4. The API responds with appropriate **HTTP status codes** for all requests.
|
|
18
|
-
5. Use `donotlog=1` as a query parameter on any API call where you don't want the action to be logged in the activity log.
|
|
19
|
-
|
|
20
|
-
## Authentication
|
|
21
|
-
|
|
22
|
-
All API requests require authentication via one of two methods:
|
|
23
|
-
|
|
24
|
-
### Server-Side (API Keys)
|
|
25
|
-
|
|
26
|
-
Use API keys for server-to-server integrations. Create keys at **Settings > Integrations > API Keys**. Make sure to record the secret key when you create it.
|
|
27
|
-
|
|
28
|
-
```
|
|
29
|
-
Authorization: Outseta {api_key}:{api_secret}
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
**Example:**
|
|
33
|
-
```
|
|
34
|
-
Authorization: Outseta ce08fd5a-e1ee-4472-9c5f-b7575d8369b2:74fc1d2242a4eb7336d34b0e40cfbc5f
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
> **Warning:** Never expose API keys in client-side code. The API key and secret combined give full access to all data in your account.
|
|
38
|
-
|
|
39
|
-
### Client-Side (Bearer Token)
|
|
40
|
-
|
|
41
|
-
Do **not** use API keys on the client side — they can be easily copied. Instead, obtain a JWT access token by calling the `POST /tokens` endpoint from the server side with your credentials, then use it on the client:
|
|
42
|
-
|
|
43
|
-
```
|
|
44
|
-
Authorization: bearer {access_token}
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
Tokens are JWTs containing claims such as `PersonUid`, `AccountUid`, and subscription details. Tokens expire after approximately one year.
|
|
48
|
-
|
|
49
|
-
Verify tokens server-side using Outseta's [JWKS endpoint](https://{your-domain}.outseta.com/.well-known/jwks.json).
|
|
50
|
-
|
|
51
|
-
## Field Selection
|
|
52
|
-
|
|
53
|
-
When you make an API request, you'll automatically get all the basic information from the main object and its immediate child objects. Referenced objects beyond the first level are returned as `null`.
|
|
54
|
-
|
|
55
|
-
Change this behavior using the `fields` query parameter:
|
|
56
|
-
|
|
57
|
-
- **Go deeper** — Request fields lower down in the object tree: `?fields=CurrentSubscription.Plan.*`
|
|
58
|
-
- **Go lighter** — Request only the essentials for faster performance: `?fields=Uid,Name`
|
|
59
|
-
- **Combination** — `?fields=Uid,Name,CurrentSubscription.Plan.Uid`
|
|
60
|
-
- **Wildcard** — Use `*` to get all fields in an object: `?fields=*` or `?fields=CurrentSubscription.Plan.*`
|
|
61
|
-
|
|
62
|
-
> **Tip:** When expanding nested paths, include `*` and intermediate path segments (e.g., `PersonAccount.*`) to preserve root-level and intermediate fields.
|
|
63
|
-
|
|
64
|
-
**Examples:**
|
|
65
|
-
|
|
66
|
-
```
|
|
67
|
-
# Get the current subscription plan UID for an account
|
|
68
|
-
GET /crm/accounts/{uid}?fields=CurrentSubscription.Plan.Uid
|
|
69
|
-
|
|
70
|
-
# Get the account UID and plan UID for a list of accounts
|
|
71
|
-
GET /crm/accounts?fields=Uid,CurrentSubscription.Plan.Uid
|
|
72
|
-
|
|
73
|
-
# Get the full plan object for an account's current subscription
|
|
74
|
-
GET /crm/accounts/{uid}?fields=CurrentSubscription.Plan.*
|
|
75
|
-
|
|
76
|
-
# Get a person with their account and subscription info
|
|
77
|
-
GET /crm/people/{uid}?fields=Uid,PersonAccount.Account.CurrentSubscription.Plan.Uid
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
If your request includes fields from a child object you will be limited to retrieving **25 items** per page. The maximum for requests not expanding child object fields is **100 items**.
|
|
81
|
-
|
|
82
|
-
## Pagination
|
|
83
|
-
|
|
84
|
-
List endpoints return paginated results with a `metadata` object and an `items` array:
|
|
85
|
-
|
|
86
|
-
```json
|
|
87
|
-
{
|
|
88
|
-
"metadata": {
|
|
89
|
-
"limit": 25,
|
|
90
|
-
"offset": 0,
|
|
91
|
-
"total": 142
|
|
92
|
-
},
|
|
93
|
-
"items": [ ... ]
|
|
94
|
-
}
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
| Parameter | Type | Default | Description |
|
|
98
|
-
|-----------|------|---------|-------------|
|
|
99
|
-
| `offset` | integer | `0` | Page number (zero-based) |
|
|
100
|
-
| `limit` | integer | `25` | Maximum number of records per page |
|
|
101
|
-
|
|
102
|
-
**Examples:**
|
|
103
|
-
```
|
|
104
|
-
?offset=0&limit=20 # returns results 1-20
|
|
105
|
-
?offset=1&limit=20 # returns results 21-40
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
## Sorting
|
|
109
|
-
|
|
110
|
-
Sort results using the `orderBy` parameter with a property name and direction:
|
|
111
|
-
|
|
112
|
-
```
|
|
113
|
-
?orderBy=PropertyName+DESC
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
## Filtering
|
|
117
|
-
|
|
118
|
-
Filter results by passing entity properties as query parameters.
|
|
119
|
-
|
|
120
|
-
### Basic Filtering
|
|
121
|
-
|
|
122
|
-
Filter on any field using the field name as a query parameter:
|
|
123
|
-
|
|
124
|
-
```
|
|
125
|
-
GET /crm/people?Email=john@example.com
|
|
126
|
-
GET /crm/accounts?AccountStage=2
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
### Wildcard Matching
|
|
130
|
-
|
|
131
|
-
| Pattern | Match Type | Example |
|
|
132
|
-
|---------|-----------|---------|
|
|
133
|
-
| `*value` | Ends with | `?Email=*@example.com` |
|
|
134
|
-
| `value*` | Starts with | `?Name=Acme*` |
|
|
135
|
-
| `*value*` | Contains | `?Name=*corp*` |
|
|
136
|
-
|
|
137
|
-
### Comparison Operators
|
|
138
|
-
|
|
139
|
-
For advanced filtering, append comparison operators to field names:
|
|
140
|
-
|
|
141
|
-
| Operator | Description | Example |
|
|
142
|
-
|----------|-------------|---------|
|
|
143
|
-
| `__gt` | Greater than | `Created__gt=2024-01-01` |
|
|
144
|
-
| `__gte` | Greater than or equal | `Amount__gte=100` |
|
|
145
|
-
| `__lt` | Less than | `Created__lt=2024-12-31` |
|
|
146
|
-
| `__lte` | Less than or equal | `Amount__lte=500` |
|
|
147
|
-
| `__ne` | Not equal | `Status__ne=Active` |
|
|
148
|
-
| `__isnull` | Is null (true/false) | `ProfileImageS3Url__isnull=true` |
|
|
149
|
-
|
|
150
|
-
**Examples:**
|
|
151
|
-
|
|
152
|
-
```
|
|
153
|
-
# Date filtering
|
|
154
|
-
GET /crm/accounts?Created__gt=2024-01-01
|
|
155
|
-
GET /billing/subscriptions?EndDate__lt=2024-08-01
|
|
156
|
-
|
|
157
|
-
# Numeric filtering
|
|
158
|
-
GET /billing/invoices?Amount__gte=1000
|
|
159
|
-
|
|
160
|
-
# Null value filtering
|
|
161
|
-
GET /crm/people?ProfileImageS3Url__isnull=true
|
|
162
|
-
|
|
163
|
-
# Multiple filters combined with field selection
|
|
164
|
-
GET /billing/subscriptions?StartDate__gte=2024-01-01&Rate__lt=100&DiscountCode__isnull=false&fields=Uid,Amount,StartDate,DiscountCode,Plan.Name
|
|
165
|
-
```
|
|
166
|
-
|
|
167
|
-
## Account Billing Stages
|
|
168
|
-
|
|
169
|
-
Account stages reflect the financial standing of each account and are not directly editable — they change automatically based on subscription activity.
|
|
170
|
-
|
|
171
|
-
| Value | Stage | Description |
|
|
172
|
-
|-------|-------|-------------|
|
|
173
|
-
| `2` | Trialing | Currently on a free trial or free plan |
|
|
174
|
-
| `3` | Subscribing | Active paid subscription (contributes to MRR) |
|
|
175
|
-
| `4` | Canceling | Customer has indicated intent to cancel |
|
|
176
|
-
| `5` | Expired | Subscription has ended after cancellation |
|
|
177
|
-
| `6` | Trial Expired | Free trial ended without conversion to paid |
|
|
178
|
-
|
|
179
|
-
Filter by stage: `GET /crm/accounts?AccountStage=3` returns all actively subscribing accounts.
|
|
180
|
-
|
|
181
|
-
## Webhooks
|
|
182
|
-
|
|
183
|
-
Use **Activity Notifications** to receive real-time callbacks when events occur in Outseta. Configure webhooks at **Settings > Notifications**.
|
|
184
|
-
|
|
185
|
-
Common events include:
|
|
186
|
-
- `Person Created` / `Person Updated`
|
|
187
|
-
- `Account Created` / `Account Updated`
|
|
188
|
-
- `Subscription Created` / `Subscription Updated`
|
|
189
|
-
|
|
190
|
-
Always verify webhook signatures using the SHA256 secret provided in the Outseta dashboard.
|
|
191
|
-
|
|
192
|
-
## Error Responses
|
|
193
|
-
|
|
194
|
-
| Status Code | Description |
|
|
195
|
-
|-------------|-------------|
|
|
196
|
-
| `200` | Success |
|
|
197
|
-
| `301` | Redirect — HTTP requests are redirected to HTTPS |
|
|
198
|
-
| `400` | Bad request — invalid parameters or Uid format |
|
|
199
|
-
| `401` | Unauthorized — missing or invalid authentication |
|
|
200
|
-
| `404` | Entity not found |
|
|
201
|
-
| `4XX` / `5XX` | Client or server error |
|
|
202
|
-
|
|
203
|
-
Validation errors return a JSON body with `ErrorMessage` and `PropertyName` fields:
|
|
204
|
-
|
|
205
|
-
```json
|
|
206
|
-
{
|
|
207
|
-
"ErrorMessage": "Invalid company email",
|
|
208
|
-
"PropertyName": "Email"
|
|
209
|
-
}
|
|
210
|
-
```
|
|
211
|
-
|
|
212
|
-
## Rate Limits
|
|
213
|
-
|
|
214
|
-
Requests authorized by an API Key should not exceed **4 requests/second**.
|
|
215
|
-
|
|
216
|
-
## Support
|
|
217
|
-
|
|
218
|
-
For help regarding the Outseta API please email [support@outseta.com](mailto:support@outseta.com).
|
|
219
|
-
|
|
220
|
-
* OpenAPI spec version: v1
|
|
221
|
-
*/
|
|
222
2
|
import type {
|
|
223
3
|
Account,
|
|
224
4
|
AccountAddAccountBody,
|
|
225
5
|
AccountAddAccountParams,
|
|
226
|
-
|
|
6
|
+
AccountAddPersonToAccountBody,
|
|
7
|
+
AccountCancelAccountBody,
|
|
8
|
+
AccountExtendTrialBody,
|
|
9
|
+
AccountGetAllAccountsParams,
|
|
10
|
+
AccountUpdateAccountBody,
|
|
11
|
+
AccountUpdateMembershipBody,
|
|
12
|
+
Deal,
|
|
13
|
+
DealAddDealBody,
|
|
14
|
+
DealGetAllDealsParams,
|
|
15
|
+
DealUpdateDealBody,
|
|
16
|
+
Person,
|
|
17
|
+
PersonAccount,
|
|
18
|
+
PersonAddPersonBody,
|
|
19
|
+
PersonForgotPasswordBody,
|
|
20
|
+
PersonGetAllPeopleParams,
|
|
21
|
+
PersonSetTemporaryPasswordBody,
|
|
22
|
+
PersonUpdatePersonBody
|
|
227
23
|
} from '.././models';
|
|
228
24
|
|
|
229
25
|
import { customFetch } from '../../client';
|
|
230
26
|
|
|
27
|
+
/**
|
|
28
|
+
* @summary Retrieves all the deals associated with your account.
|
|
29
|
+
*/
|
|
30
|
+
export type dealGetAllDealsResponse200 = {
|
|
31
|
+
data: Deal[]
|
|
32
|
+
status: 200
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
export type dealGetAllDealsResponse400 = {
|
|
36
|
+
data: void
|
|
37
|
+
status: 400
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
export type dealGetAllDealsResponse401 = {
|
|
41
|
+
data: void
|
|
42
|
+
status: 401
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export type dealGetAllDealsResponseSuccess = (dealGetAllDealsResponse200) & {
|
|
46
|
+
headers: Headers;
|
|
47
|
+
};
|
|
48
|
+
export type dealGetAllDealsResponseError = (dealGetAllDealsResponse400 | dealGetAllDealsResponse401) & {
|
|
49
|
+
headers: Headers;
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
export type dealGetAllDealsResponse = (dealGetAllDealsResponseSuccess | dealGetAllDealsResponseError)
|
|
53
|
+
|
|
54
|
+
export const getDealGetAllDealsUrl = (params?: DealGetAllDealsParams,) => {
|
|
55
|
+
const normalizedParams = new URLSearchParams();
|
|
56
|
+
|
|
57
|
+
Object.entries(params || {}).forEach(([key, value]) => {
|
|
58
|
+
|
|
59
|
+
if (value !== undefined) {
|
|
60
|
+
normalizedParams.append(key, value === null ? 'null' : value.toString())
|
|
61
|
+
}
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
const stringifiedParams = normalizedParams.toString();
|
|
65
|
+
|
|
66
|
+
return stringifiedParams.length > 0 ? `/api/v1/crm/deals?${stringifiedParams}` : `/api/v1/crm/deals`
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export const dealGetAllDeals = async (params?: DealGetAllDealsParams, options?: RequestInit): Promise<dealGetAllDealsResponse> => {
|
|
70
|
+
|
|
71
|
+
return customFetch<dealGetAllDealsResponse>(getDealGetAllDealsUrl(params),
|
|
72
|
+
{
|
|
73
|
+
...options,
|
|
74
|
+
method: 'GET'
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
}
|
|
78
|
+
);}
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* @summary Add a new deal.
|
|
83
|
+
*/
|
|
84
|
+
export type dealAddDealResponse200 = {
|
|
85
|
+
data: Deal
|
|
86
|
+
status: 200
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
export type dealAddDealResponse401 = {
|
|
90
|
+
data: void
|
|
91
|
+
status: 401
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
export type dealAddDealResponseSuccess = (dealAddDealResponse200) & {
|
|
95
|
+
headers: Headers;
|
|
96
|
+
};
|
|
97
|
+
export type dealAddDealResponseError = (dealAddDealResponse401) & {
|
|
98
|
+
headers: Headers;
|
|
99
|
+
};
|
|
100
|
+
|
|
101
|
+
export type dealAddDealResponse = (dealAddDealResponseSuccess | dealAddDealResponseError)
|
|
102
|
+
|
|
103
|
+
export const getDealAddDealUrl = () => {
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
return `/api/v1/crm/deals`
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
export const dealAddDeal = async (dealAddDealBody: DealAddDealBody, options?: RequestInit): Promise<dealAddDealResponse> => {
|
|
112
|
+
|
|
113
|
+
return customFetch<dealAddDealResponse>(getDealAddDealUrl(),
|
|
114
|
+
{
|
|
115
|
+
...options,
|
|
116
|
+
method: 'POST',
|
|
117
|
+
headers: { 'Content-Type': 'application/json', ...options?.headers },
|
|
118
|
+
body: JSON.stringify(
|
|
119
|
+
dealAddDealBody,)
|
|
120
|
+
}
|
|
121
|
+
);}
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* @summary Retrieves one deal associated with your account.
|
|
126
|
+
*/
|
|
127
|
+
export type dealGetDealResponse200 = {
|
|
128
|
+
data: Deal
|
|
129
|
+
status: 200
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
export type dealGetDealResponse400 = {
|
|
133
|
+
data: void
|
|
134
|
+
status: 400
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
export type dealGetDealResponse401 = {
|
|
138
|
+
data: void
|
|
139
|
+
status: 401
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
export type dealGetDealResponse404 = {
|
|
143
|
+
data: void
|
|
144
|
+
status: 404
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
export type dealGetDealResponseSuccess = (dealGetDealResponse200) & {
|
|
148
|
+
headers: Headers;
|
|
149
|
+
};
|
|
150
|
+
export type dealGetDealResponseError = (dealGetDealResponse400 | dealGetDealResponse401 | dealGetDealResponse404) & {
|
|
151
|
+
headers: Headers;
|
|
152
|
+
};
|
|
153
|
+
|
|
154
|
+
export type dealGetDealResponse = (dealGetDealResponseSuccess | dealGetDealResponseError)
|
|
155
|
+
|
|
156
|
+
export const getDealGetDealUrl = (dealUid: string | null,) => {
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
return `/api/v1/crm/deals/${dealUid}`
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
export const dealGetDeal = async (dealUid: string | null, options?: RequestInit): Promise<dealGetDealResponse> => {
|
|
165
|
+
|
|
166
|
+
return customFetch<dealGetDealResponse>(getDealGetDealUrl(dealUid),
|
|
167
|
+
{
|
|
168
|
+
...options,
|
|
169
|
+
method: 'GET'
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
}
|
|
173
|
+
);}
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
/**
|
|
177
|
+
* @summary Update a deal.
|
|
178
|
+
*/
|
|
179
|
+
export type dealUpdateDealResponse200 = {
|
|
180
|
+
data: Deal
|
|
181
|
+
status: 200
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
export type dealUpdateDealResponse400 = {
|
|
185
|
+
data: void
|
|
186
|
+
status: 400
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
export type dealUpdateDealResponse401 = {
|
|
190
|
+
data: void
|
|
191
|
+
status: 401
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
export type dealUpdateDealResponse404 = {
|
|
195
|
+
data: void
|
|
196
|
+
status: 404
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
export type dealUpdateDealResponseSuccess = (dealUpdateDealResponse200) & {
|
|
200
|
+
headers: Headers;
|
|
201
|
+
};
|
|
202
|
+
export type dealUpdateDealResponseError = (dealUpdateDealResponse400 | dealUpdateDealResponse401 | dealUpdateDealResponse404) & {
|
|
203
|
+
headers: Headers;
|
|
204
|
+
};
|
|
205
|
+
|
|
206
|
+
export type dealUpdateDealResponse = (dealUpdateDealResponseSuccess | dealUpdateDealResponseError)
|
|
207
|
+
|
|
208
|
+
export const getDealUpdateDealUrl = (dealUid: string | null,) => {
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
return `/api/v1/crm/deals/${dealUid}`
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
export const dealUpdateDeal = async (dealUid: string | null,
|
|
217
|
+
dealUpdateDealBody: DealUpdateDealBody, options?: RequestInit): Promise<dealUpdateDealResponse> => {
|
|
218
|
+
|
|
219
|
+
return customFetch<dealUpdateDealResponse>(getDealUpdateDealUrl(dealUid),
|
|
220
|
+
{
|
|
221
|
+
...options,
|
|
222
|
+
method: 'PUT',
|
|
223
|
+
headers: { 'Content-Type': 'application/json', ...options?.headers },
|
|
224
|
+
body: JSON.stringify(
|
|
225
|
+
dealUpdateDealBody,)
|
|
226
|
+
}
|
|
227
|
+
);}
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
/**
|
|
231
|
+
* @summary Delete a deal.
|
|
232
|
+
*/
|
|
233
|
+
export type dealDeleteDealResponse200 = {
|
|
234
|
+
data: Blob
|
|
235
|
+
status: 200
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
export type dealDeleteDealResponse400 = {
|
|
239
|
+
data: void
|
|
240
|
+
status: 400
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
export type dealDeleteDealResponse401 = {
|
|
244
|
+
data: void
|
|
245
|
+
status: 401
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
export type dealDeleteDealResponse404 = {
|
|
249
|
+
data: void
|
|
250
|
+
status: 404
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
export type dealDeleteDealResponseSuccess = (dealDeleteDealResponse200) & {
|
|
254
|
+
headers: Headers;
|
|
255
|
+
};
|
|
256
|
+
export type dealDeleteDealResponseError = (dealDeleteDealResponse400 | dealDeleteDealResponse401 | dealDeleteDealResponse404) & {
|
|
257
|
+
headers: Headers;
|
|
258
|
+
};
|
|
259
|
+
|
|
260
|
+
export type dealDeleteDealResponse = (dealDeleteDealResponseSuccess | dealDeleteDealResponseError)
|
|
261
|
+
|
|
262
|
+
export const getDealDeleteDealUrl = (dealUid: string | null,) => {
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
return `/api/v1/crm/deals/${dealUid}`
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
export const dealDeleteDeal = async (dealUid: string | null, options?: RequestInit): Promise<dealDeleteDealResponse> => {
|
|
271
|
+
|
|
272
|
+
return customFetch<dealDeleteDealResponse>(getDealDeleteDealUrl(dealUid),
|
|
273
|
+
{
|
|
274
|
+
...options,
|
|
275
|
+
method: 'DELETE'
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
}
|
|
279
|
+
);}
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
/**
|
|
283
|
+
* @summary Register a new account. This is the same endpoint the sign up embed uses to create accounts.
|
|
284
|
+
At a minimum you must pass one Primary Contact with an Email address and one Subscription
|
|
285
|
+
record with a reference to a Plan. Other fields (e.g. Account Name, Billing Address,
|
|
286
|
+
Payment Information, etc.) can be passed as desired. A confirmation email will be sent
|
|
287
|
+
to the user unless you've specifically toggled this option off on the AUTH > SIGN UP AND LOGIN page.
|
|
288
|
+
*/
|
|
289
|
+
export type registrationRegisterAccountResponse200 = {
|
|
290
|
+
data: Account
|
|
291
|
+
status: 200
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
export type registrationRegisterAccountResponseSuccess = (registrationRegisterAccountResponse200) & {
|
|
295
|
+
headers: Headers;
|
|
296
|
+
};
|
|
297
|
+
;
|
|
298
|
+
|
|
299
|
+
export type registrationRegisterAccountResponse = (registrationRegisterAccountResponseSuccess)
|
|
300
|
+
|
|
301
|
+
export const getRegistrationRegisterAccountUrl = () => {
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
return `/api/v1/crm/registrations`
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
export const registrationRegisterAccount = async ( options?: RequestInit): Promise<registrationRegisterAccountResponse> => {
|
|
310
|
+
|
|
311
|
+
return customFetch<registrationRegisterAccountResponse>(getRegistrationRegisterAccountUrl(),
|
|
312
|
+
{
|
|
313
|
+
...options,
|
|
314
|
+
method: 'POST'
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
}
|
|
318
|
+
);}
|
|
319
|
+
|
|
320
|
+
|
|
231
321
|
/**
|
|
232
322
|
* @summary Returns all accounts, optionally filtered by segment or search query.
|
|
233
323
|
*/
|
|
@@ -387,3 +477,835 @@ export const accountGetAccount = async (accountUid: string | null, options?: Req
|
|
|
387
477
|
);}
|
|
388
478
|
|
|
389
479
|
|
|
480
|
+
/**
|
|
481
|
+
* @summary Delete an account record.
|
|
482
|
+
*/
|
|
483
|
+
export type accountDeleteAccountResponse200 = {
|
|
484
|
+
data: Blob
|
|
485
|
+
status: 200
|
|
486
|
+
}
|
|
487
|
+
|
|
488
|
+
export type accountDeleteAccountResponse400 = {
|
|
489
|
+
data: void
|
|
490
|
+
status: 400
|
|
491
|
+
}
|
|
492
|
+
|
|
493
|
+
export type accountDeleteAccountResponse401 = {
|
|
494
|
+
data: void
|
|
495
|
+
status: 401
|
|
496
|
+
}
|
|
497
|
+
|
|
498
|
+
export type accountDeleteAccountResponse404 = {
|
|
499
|
+
data: void
|
|
500
|
+
status: 404
|
|
501
|
+
}
|
|
502
|
+
|
|
503
|
+
export type accountDeleteAccountResponseSuccess = (accountDeleteAccountResponse200) & {
|
|
504
|
+
headers: Headers;
|
|
505
|
+
};
|
|
506
|
+
export type accountDeleteAccountResponseError = (accountDeleteAccountResponse400 | accountDeleteAccountResponse401 | accountDeleteAccountResponse404) & {
|
|
507
|
+
headers: Headers;
|
|
508
|
+
};
|
|
509
|
+
|
|
510
|
+
export type accountDeleteAccountResponse = (accountDeleteAccountResponseSuccess | accountDeleteAccountResponseError)
|
|
511
|
+
|
|
512
|
+
export const getAccountDeleteAccountUrl = (accountUid: string | null,) => {
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
return `/api/v1/crm/accounts/${accountUid}`
|
|
518
|
+
}
|
|
519
|
+
|
|
520
|
+
export const accountDeleteAccount = async (accountUid: string | null, options?: RequestInit): Promise<accountDeleteAccountResponse> => {
|
|
521
|
+
|
|
522
|
+
return customFetch<accountDeleteAccountResponse>(getAccountDeleteAccountUrl(accountUid),
|
|
523
|
+
{
|
|
524
|
+
...options,
|
|
525
|
+
method: 'DELETE'
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
}
|
|
529
|
+
);}
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
/**
|
|
533
|
+
* @summary Update account information. You can update one or multiple properties on the object.
|
|
534
|
+
Any property that you include in the json schema will be updated.
|
|
535
|
+
To update custom properties just include them in the same way that they are included when you do a get on the object.
|
|
536
|
+
*/
|
|
537
|
+
export type accountUpdateAccountResponse200 = {
|
|
538
|
+
data: Account
|
|
539
|
+
status: 200
|
|
540
|
+
}
|
|
541
|
+
|
|
542
|
+
export type accountUpdateAccountResponse400 = {
|
|
543
|
+
data: void
|
|
544
|
+
status: 400
|
|
545
|
+
}
|
|
546
|
+
|
|
547
|
+
export type accountUpdateAccountResponse401 = {
|
|
548
|
+
data: void
|
|
549
|
+
status: 401
|
|
550
|
+
}
|
|
551
|
+
|
|
552
|
+
export type accountUpdateAccountResponse404 = {
|
|
553
|
+
data: void
|
|
554
|
+
status: 404
|
|
555
|
+
}
|
|
556
|
+
|
|
557
|
+
export type accountUpdateAccountResponseSuccess = (accountUpdateAccountResponse200) & {
|
|
558
|
+
headers: Headers;
|
|
559
|
+
};
|
|
560
|
+
export type accountUpdateAccountResponseError = (accountUpdateAccountResponse400 | accountUpdateAccountResponse401 | accountUpdateAccountResponse404) & {
|
|
561
|
+
headers: Headers;
|
|
562
|
+
};
|
|
563
|
+
|
|
564
|
+
export type accountUpdateAccountResponse = (accountUpdateAccountResponseSuccess | accountUpdateAccountResponseError)
|
|
565
|
+
|
|
566
|
+
export const getAccountUpdateAccountUrl = (accountUid: string | null,) => {
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
return `/api/v1/crm/accounts/${accountUid}`
|
|
572
|
+
}
|
|
573
|
+
|
|
574
|
+
export const accountUpdateAccount = async (accountUid: string | null,
|
|
575
|
+
accountUpdateAccountBody: AccountUpdateAccountBody, options?: RequestInit): Promise<accountUpdateAccountResponse> => {
|
|
576
|
+
|
|
577
|
+
return customFetch<accountUpdateAccountResponse>(getAccountUpdateAccountUrl(accountUid),
|
|
578
|
+
{
|
|
579
|
+
...options,
|
|
580
|
+
method: 'PUT',
|
|
581
|
+
headers: { 'Content-Type': 'application/json', ...options?.headers },
|
|
582
|
+
body: JSON.stringify(
|
|
583
|
+
accountUpdateAccountBody,)
|
|
584
|
+
}
|
|
585
|
+
);}
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
/**
|
|
589
|
+
* @summary Add a person to an existing account. Set sendWelcomeEmail=true to send a welcome email to the person added.
|
|
590
|
+
*/
|
|
591
|
+
export type accountAddPersonToAccountResponse200 = {
|
|
592
|
+
data: PersonAccount
|
|
593
|
+
status: 200
|
|
594
|
+
}
|
|
595
|
+
|
|
596
|
+
export type accountAddPersonToAccountResponse400 = {
|
|
597
|
+
data: void
|
|
598
|
+
status: 400
|
|
599
|
+
}
|
|
600
|
+
|
|
601
|
+
export type accountAddPersonToAccountResponse401 = {
|
|
602
|
+
data: void
|
|
603
|
+
status: 401
|
|
604
|
+
}
|
|
605
|
+
|
|
606
|
+
export type accountAddPersonToAccountResponse404 = {
|
|
607
|
+
data: void
|
|
608
|
+
status: 404
|
|
609
|
+
}
|
|
610
|
+
|
|
611
|
+
export type accountAddPersonToAccountResponseSuccess = (accountAddPersonToAccountResponse200) & {
|
|
612
|
+
headers: Headers;
|
|
613
|
+
};
|
|
614
|
+
export type accountAddPersonToAccountResponseError = (accountAddPersonToAccountResponse400 | accountAddPersonToAccountResponse401 | accountAddPersonToAccountResponse404) & {
|
|
615
|
+
headers: Headers;
|
|
616
|
+
};
|
|
617
|
+
|
|
618
|
+
export type accountAddPersonToAccountResponse = (accountAddPersonToAccountResponseSuccess | accountAddPersonToAccountResponseError)
|
|
619
|
+
|
|
620
|
+
export const getAccountAddPersonToAccountUrl = (accountUid: string | null,) => {
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
return `/api/v1/crm/accounts/${accountUid}/memberships`
|
|
626
|
+
}
|
|
627
|
+
|
|
628
|
+
export const accountAddPersonToAccount = async (accountUid: string | null,
|
|
629
|
+
accountAddPersonToAccountBody: AccountAddPersonToAccountBody, options?: RequestInit): Promise<accountAddPersonToAccountResponse> => {
|
|
630
|
+
|
|
631
|
+
return customFetch<accountAddPersonToAccountResponse>(getAccountAddPersonToAccountUrl(accountUid),
|
|
632
|
+
{
|
|
633
|
+
...options,
|
|
634
|
+
method: 'POST',
|
|
635
|
+
headers: { 'Content-Type': 'application/json', ...options?.headers },
|
|
636
|
+
body: JSON.stringify(
|
|
637
|
+
accountAddPersonToAccountBody,)
|
|
638
|
+
}
|
|
639
|
+
);}
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
/**
|
|
643
|
+
* @summary Update an account membership. This is the method by which you can change the primary contact of an account.
|
|
644
|
+
*/
|
|
645
|
+
export type accountUpdateMembershipResponse200 = {
|
|
646
|
+
data: Blob
|
|
647
|
+
status: 200
|
|
648
|
+
}
|
|
649
|
+
|
|
650
|
+
export type accountUpdateMembershipResponse400 = {
|
|
651
|
+
data: void
|
|
652
|
+
status: 400
|
|
653
|
+
}
|
|
654
|
+
|
|
655
|
+
export type accountUpdateMembershipResponse401 = {
|
|
656
|
+
data: void
|
|
657
|
+
status: 401
|
|
658
|
+
}
|
|
659
|
+
|
|
660
|
+
export type accountUpdateMembershipResponse404 = {
|
|
661
|
+
data: void
|
|
662
|
+
status: 404
|
|
663
|
+
}
|
|
664
|
+
|
|
665
|
+
export type accountUpdateMembershipResponseSuccess = (accountUpdateMembershipResponse200) & {
|
|
666
|
+
headers: Headers;
|
|
667
|
+
};
|
|
668
|
+
export type accountUpdateMembershipResponseError = (accountUpdateMembershipResponse400 | accountUpdateMembershipResponse401 | accountUpdateMembershipResponse404) & {
|
|
669
|
+
headers: Headers;
|
|
670
|
+
};
|
|
671
|
+
|
|
672
|
+
export type accountUpdateMembershipResponse = (accountUpdateMembershipResponseSuccess | accountUpdateMembershipResponseError)
|
|
673
|
+
|
|
674
|
+
export const getAccountUpdateMembershipUrl = (accountUid: string | null,
|
|
675
|
+
membershipUid: string | null,) => {
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
return `/api/v1/crm/accounts/${accountUid}/memberships/${membershipUid}`
|
|
681
|
+
}
|
|
682
|
+
|
|
683
|
+
export const accountUpdateMembership = async (accountUid: string | null,
|
|
684
|
+
membershipUid: string | null,
|
|
685
|
+
accountUpdateMembershipBody: AccountUpdateMembershipBody, options?: RequestInit): Promise<accountUpdateMembershipResponse> => {
|
|
686
|
+
|
|
687
|
+
return customFetch<accountUpdateMembershipResponse>(getAccountUpdateMembershipUrl(accountUid,membershipUid),
|
|
688
|
+
{
|
|
689
|
+
...options,
|
|
690
|
+
method: 'PUT',
|
|
691
|
+
headers: { 'Content-Type': 'application/json', ...options?.headers },
|
|
692
|
+
body: JSON.stringify(
|
|
693
|
+
accountUpdateMembershipBody,)
|
|
694
|
+
}
|
|
695
|
+
);}
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
/**
|
|
699
|
+
* @summary Remove a person from an account. Note that you cannot remove the primary contact of an account.
|
|
700
|
+
*/
|
|
701
|
+
export type accountDeleteMembershipResponse200 = {
|
|
702
|
+
data: Blob
|
|
703
|
+
status: 200
|
|
704
|
+
}
|
|
705
|
+
|
|
706
|
+
export type accountDeleteMembershipResponse400 = {
|
|
707
|
+
data: void
|
|
708
|
+
status: 400
|
|
709
|
+
}
|
|
710
|
+
|
|
711
|
+
export type accountDeleteMembershipResponse401 = {
|
|
712
|
+
data: void
|
|
713
|
+
status: 401
|
|
714
|
+
}
|
|
715
|
+
|
|
716
|
+
export type accountDeleteMembershipResponse404 = {
|
|
717
|
+
data: void
|
|
718
|
+
status: 404
|
|
719
|
+
}
|
|
720
|
+
|
|
721
|
+
export type accountDeleteMembershipResponseSuccess = (accountDeleteMembershipResponse200) & {
|
|
722
|
+
headers: Headers;
|
|
723
|
+
};
|
|
724
|
+
export type accountDeleteMembershipResponseError = (accountDeleteMembershipResponse400 | accountDeleteMembershipResponse401 | accountDeleteMembershipResponse404) & {
|
|
725
|
+
headers: Headers;
|
|
726
|
+
};
|
|
727
|
+
|
|
728
|
+
export type accountDeleteMembershipResponse = (accountDeleteMembershipResponseSuccess | accountDeleteMembershipResponseError)
|
|
729
|
+
|
|
730
|
+
export const getAccountDeleteMembershipUrl = (accountUid: string | null,
|
|
731
|
+
membershipUid: string | null,) => {
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
return `/api/v1/crm/accounts/${accountUid}/memberships/${membershipUid}`
|
|
737
|
+
}
|
|
738
|
+
|
|
739
|
+
export const accountDeleteMembership = async (accountUid: string | null,
|
|
740
|
+
membershipUid: string | null, options?: RequestInit): Promise<accountDeleteMembershipResponse> => {
|
|
741
|
+
|
|
742
|
+
return customFetch<accountDeleteMembershipResponse>(getAccountDeleteMembershipUrl(accountUid,membershipUid),
|
|
743
|
+
{
|
|
744
|
+
...options,
|
|
745
|
+
method: 'DELETE'
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
}
|
|
749
|
+
);}
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
/**
|
|
753
|
+
* @summary Add a cancellation request to an account. The account needs to be in subscribing stage.
|
|
754
|
+
The stage will automatically change over to cancelling. If the account has a subscription
|
|
755
|
+
attached to it then at the subscription renewal the subscription will end and the account
|
|
756
|
+
will be automatically set to expired.
|
|
757
|
+
*/
|
|
758
|
+
export type accountCancelAccountResponse200 = {
|
|
759
|
+
data: Blob
|
|
760
|
+
status: 200
|
|
761
|
+
}
|
|
762
|
+
|
|
763
|
+
export type accountCancelAccountResponse400 = {
|
|
764
|
+
data: void
|
|
765
|
+
status: 400
|
|
766
|
+
}
|
|
767
|
+
|
|
768
|
+
export type accountCancelAccountResponse401 = {
|
|
769
|
+
data: void
|
|
770
|
+
status: 401
|
|
771
|
+
}
|
|
772
|
+
|
|
773
|
+
export type accountCancelAccountResponse404 = {
|
|
774
|
+
data: void
|
|
775
|
+
status: 404
|
|
776
|
+
}
|
|
777
|
+
|
|
778
|
+
export type accountCancelAccountResponseSuccess = (accountCancelAccountResponse200) & {
|
|
779
|
+
headers: Headers;
|
|
780
|
+
};
|
|
781
|
+
export type accountCancelAccountResponseError = (accountCancelAccountResponse400 | accountCancelAccountResponse401 | accountCancelAccountResponse404) & {
|
|
782
|
+
headers: Headers;
|
|
783
|
+
};
|
|
784
|
+
|
|
785
|
+
export type accountCancelAccountResponse = (accountCancelAccountResponseSuccess | accountCancelAccountResponseError)
|
|
786
|
+
|
|
787
|
+
export const getAccountCancelAccountUrl = (accountUid: string | null,) => {
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
return `/api/v1/crm/accounts/${accountUid}/cancel`
|
|
793
|
+
}
|
|
794
|
+
|
|
795
|
+
export const accountCancelAccount = async (accountUid: string | null,
|
|
796
|
+
accountCancelAccountBody: AccountCancelAccountBody, options?: RequestInit): Promise<accountCancelAccountResponse> => {
|
|
797
|
+
|
|
798
|
+
return customFetch<accountCancelAccountResponse>(getAccountCancelAccountUrl(accountUid),
|
|
799
|
+
{
|
|
800
|
+
...options,
|
|
801
|
+
method: 'PUT',
|
|
802
|
+
headers: { 'Content-Type': 'application/json', ...options?.headers },
|
|
803
|
+
body: JSON.stringify(
|
|
804
|
+
accountCancelAccountBody,)
|
|
805
|
+
}
|
|
806
|
+
);}
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
/**
|
|
810
|
+
* @summary Remove a previous cancellation request from an account.
|
|
811
|
+
*/
|
|
812
|
+
export type accountRemoveCancellationResponse200 = {
|
|
813
|
+
data: Blob
|
|
814
|
+
status: 200
|
|
815
|
+
}
|
|
816
|
+
|
|
817
|
+
export type accountRemoveCancellationResponse400 = {
|
|
818
|
+
data: void
|
|
819
|
+
status: 400
|
|
820
|
+
}
|
|
821
|
+
|
|
822
|
+
export type accountRemoveCancellationResponse401 = {
|
|
823
|
+
data: void
|
|
824
|
+
status: 401
|
|
825
|
+
}
|
|
826
|
+
|
|
827
|
+
export type accountRemoveCancellationResponse404 = {
|
|
828
|
+
data: void
|
|
829
|
+
status: 404
|
|
830
|
+
}
|
|
831
|
+
|
|
832
|
+
export type accountRemoveCancellationResponseSuccess = (accountRemoveCancellationResponse200) & {
|
|
833
|
+
headers: Headers;
|
|
834
|
+
};
|
|
835
|
+
export type accountRemoveCancellationResponseError = (accountRemoveCancellationResponse400 | accountRemoveCancellationResponse401 | accountRemoveCancellationResponse404) & {
|
|
836
|
+
headers: Headers;
|
|
837
|
+
};
|
|
838
|
+
|
|
839
|
+
export type accountRemoveCancellationResponse = (accountRemoveCancellationResponseSuccess | accountRemoveCancellationResponseError)
|
|
840
|
+
|
|
841
|
+
export const getAccountRemoveCancellationUrl = (accountUid: string | null,) => {
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
return `/api/v1/crm/accounts/${accountUid}/remove-cancellation`
|
|
847
|
+
}
|
|
848
|
+
|
|
849
|
+
export const accountRemoveCancellation = async (accountUid: string | null, options?: RequestInit): Promise<accountRemoveCancellationResponse> => {
|
|
850
|
+
|
|
851
|
+
return customFetch<accountRemoveCancellationResponse>(getAccountRemoveCancellationUrl(accountUid),
|
|
852
|
+
{
|
|
853
|
+
...options,
|
|
854
|
+
method: 'PUT'
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
}
|
|
858
|
+
);}
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
/**
|
|
862
|
+
* @summary Extend the date that a trial subscription expires.
|
|
863
|
+
*/
|
|
864
|
+
export type accountExtendTrialResponse200 = {
|
|
865
|
+
data: Blob
|
|
866
|
+
status: 200
|
|
867
|
+
}
|
|
868
|
+
|
|
869
|
+
export type accountExtendTrialResponse400 = {
|
|
870
|
+
data: void
|
|
871
|
+
status: 400
|
|
872
|
+
}
|
|
873
|
+
|
|
874
|
+
export type accountExtendTrialResponse401 = {
|
|
875
|
+
data: void
|
|
876
|
+
status: 401
|
|
877
|
+
}
|
|
878
|
+
|
|
879
|
+
export type accountExtendTrialResponse404 = {
|
|
880
|
+
data: void
|
|
881
|
+
status: 404
|
|
882
|
+
}
|
|
883
|
+
|
|
884
|
+
export type accountExtendTrialResponseSuccess = (accountExtendTrialResponse200) & {
|
|
885
|
+
headers: Headers;
|
|
886
|
+
};
|
|
887
|
+
export type accountExtendTrialResponseError = (accountExtendTrialResponse400 | accountExtendTrialResponse401 | accountExtendTrialResponse404) & {
|
|
888
|
+
headers: Headers;
|
|
889
|
+
};
|
|
890
|
+
|
|
891
|
+
export type accountExtendTrialResponse = (accountExtendTrialResponseSuccess | accountExtendTrialResponseError)
|
|
892
|
+
|
|
893
|
+
export const getAccountExtendTrialUrl = (accountUid: string | null,) => {
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
return `/api/v1/crm/accounts/${accountUid}/extend-trial`
|
|
899
|
+
}
|
|
900
|
+
|
|
901
|
+
export const accountExtendTrial = async (accountUid: string | null,
|
|
902
|
+
accountExtendTrialBody: AccountExtendTrialBody, options?: RequestInit): Promise<accountExtendTrialResponse> => {
|
|
903
|
+
|
|
904
|
+
return customFetch<accountExtendTrialResponse>(getAccountExtendTrialUrl(accountUid),
|
|
905
|
+
{
|
|
906
|
+
...options,
|
|
907
|
+
method: 'PUT',
|
|
908
|
+
headers: { 'Content-Type': 'application/json', ...options?.headers },
|
|
909
|
+
body: JSON.stringify(
|
|
910
|
+
accountExtendTrialBody,)
|
|
911
|
+
}
|
|
912
|
+
);}
|
|
913
|
+
|
|
914
|
+
|
|
915
|
+
/**
|
|
916
|
+
* @summary Send a confirmation email to people on an account. Pass personUid as a query parameter
|
|
917
|
+
to send to a specific person, or personUid=* to send to all people on the account.
|
|
918
|
+
If no personUid is provided, the email is sent to the primary contact.
|
|
919
|
+
*/
|
|
920
|
+
export type accountSendConfirmationEmailResponse200 = {
|
|
921
|
+
data: Blob
|
|
922
|
+
status: 200
|
|
923
|
+
}
|
|
924
|
+
|
|
925
|
+
export type accountSendConfirmationEmailResponse400 = {
|
|
926
|
+
data: void
|
|
927
|
+
status: 400
|
|
928
|
+
}
|
|
929
|
+
|
|
930
|
+
export type accountSendConfirmationEmailResponse401 = {
|
|
931
|
+
data: void
|
|
932
|
+
status: 401
|
|
933
|
+
}
|
|
934
|
+
|
|
935
|
+
export type accountSendConfirmationEmailResponse404 = {
|
|
936
|
+
data: void
|
|
937
|
+
status: 404
|
|
938
|
+
}
|
|
939
|
+
|
|
940
|
+
export type accountSendConfirmationEmailResponseSuccess = (accountSendConfirmationEmailResponse200) & {
|
|
941
|
+
headers: Headers;
|
|
942
|
+
};
|
|
943
|
+
export type accountSendConfirmationEmailResponseError = (accountSendConfirmationEmailResponse400 | accountSendConfirmationEmailResponse401 | accountSendConfirmationEmailResponse404) & {
|
|
944
|
+
headers: Headers;
|
|
945
|
+
};
|
|
946
|
+
|
|
947
|
+
export type accountSendConfirmationEmailResponse = (accountSendConfirmationEmailResponseSuccess | accountSendConfirmationEmailResponseError)
|
|
948
|
+
|
|
949
|
+
export const getAccountSendConfirmationEmailUrl = (accountUid: string | null,) => {
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
return `/api/v1/crm/accounts/${accountUid}/send-confirmation-email`
|
|
955
|
+
}
|
|
956
|
+
|
|
957
|
+
export const accountSendConfirmationEmail = async (accountUid: string | null, options?: RequestInit): Promise<accountSendConfirmationEmailResponse> => {
|
|
958
|
+
|
|
959
|
+
return customFetch<accountSendConfirmationEmailResponse>(getAccountSendConfirmationEmailUrl(accountUid),
|
|
960
|
+
{
|
|
961
|
+
...options,
|
|
962
|
+
method: 'PUT'
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
}
|
|
966
|
+
);}
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
/**
|
|
970
|
+
* @summary Retrieves all the people associated with your account.
|
|
971
|
+
*/
|
|
972
|
+
export type personGetAllPeopleResponse200 = {
|
|
973
|
+
data: Person[]
|
|
974
|
+
status: 200
|
|
975
|
+
}
|
|
976
|
+
|
|
977
|
+
export type personGetAllPeopleResponse401 = {
|
|
978
|
+
data: void
|
|
979
|
+
status: 401
|
|
980
|
+
}
|
|
981
|
+
|
|
982
|
+
export type personGetAllPeopleResponseSuccess = (personGetAllPeopleResponse200) & {
|
|
983
|
+
headers: Headers;
|
|
984
|
+
};
|
|
985
|
+
export type personGetAllPeopleResponseError = (personGetAllPeopleResponse401) & {
|
|
986
|
+
headers: Headers;
|
|
987
|
+
};
|
|
988
|
+
|
|
989
|
+
export type personGetAllPeopleResponse = (personGetAllPeopleResponseSuccess | personGetAllPeopleResponseError)
|
|
990
|
+
|
|
991
|
+
export const getPersonGetAllPeopleUrl = (params?: PersonGetAllPeopleParams,) => {
|
|
992
|
+
const normalizedParams = new URLSearchParams();
|
|
993
|
+
|
|
994
|
+
Object.entries(params || {}).forEach(([key, value]) => {
|
|
995
|
+
|
|
996
|
+
if (value !== undefined) {
|
|
997
|
+
normalizedParams.append(key, value === null ? 'null' : value.toString())
|
|
998
|
+
}
|
|
999
|
+
});
|
|
1000
|
+
|
|
1001
|
+
const stringifiedParams = normalizedParams.toString();
|
|
1002
|
+
|
|
1003
|
+
return stringifiedParams.length > 0 ? `/api/v1/crm/people?${stringifiedParams}` : `/api/v1/crm/people`
|
|
1004
|
+
}
|
|
1005
|
+
|
|
1006
|
+
export const personGetAllPeople = async (params?: PersonGetAllPeopleParams, options?: RequestInit): Promise<personGetAllPeopleResponse> => {
|
|
1007
|
+
|
|
1008
|
+
return customFetch<personGetAllPeopleResponse>(getPersonGetAllPeopleUrl(params),
|
|
1009
|
+
{
|
|
1010
|
+
...options,
|
|
1011
|
+
method: 'GET'
|
|
1012
|
+
|
|
1013
|
+
|
|
1014
|
+
}
|
|
1015
|
+
);}
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
/**
|
|
1019
|
+
* @summary Add a new person.
|
|
1020
|
+
*/
|
|
1021
|
+
export type personAddPersonResponse200 = {
|
|
1022
|
+
data: Person
|
|
1023
|
+
status: 200
|
|
1024
|
+
}
|
|
1025
|
+
|
|
1026
|
+
export type personAddPersonResponse401 = {
|
|
1027
|
+
data: void
|
|
1028
|
+
status: 401
|
|
1029
|
+
}
|
|
1030
|
+
|
|
1031
|
+
export type personAddPersonResponseSuccess = (personAddPersonResponse200) & {
|
|
1032
|
+
headers: Headers;
|
|
1033
|
+
};
|
|
1034
|
+
export type personAddPersonResponseError = (personAddPersonResponse401) & {
|
|
1035
|
+
headers: Headers;
|
|
1036
|
+
};
|
|
1037
|
+
|
|
1038
|
+
export type personAddPersonResponse = (personAddPersonResponseSuccess | personAddPersonResponseError)
|
|
1039
|
+
|
|
1040
|
+
export const getPersonAddPersonUrl = () => {
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
return `/api/v1/crm/people`
|
|
1046
|
+
}
|
|
1047
|
+
|
|
1048
|
+
export const personAddPerson = async (personAddPersonBody: PersonAddPersonBody, options?: RequestInit): Promise<personAddPersonResponse> => {
|
|
1049
|
+
|
|
1050
|
+
return customFetch<personAddPersonResponse>(getPersonAddPersonUrl(),
|
|
1051
|
+
{
|
|
1052
|
+
...options,
|
|
1053
|
+
method: 'POST',
|
|
1054
|
+
headers: { 'Content-Type': 'application/json', ...options?.headers },
|
|
1055
|
+
body: JSON.stringify(
|
|
1056
|
+
personAddPersonBody,)
|
|
1057
|
+
}
|
|
1058
|
+
);}
|
|
1059
|
+
|
|
1060
|
+
|
|
1061
|
+
/**
|
|
1062
|
+
* @summary Retrieves a person.
|
|
1063
|
+
*/
|
|
1064
|
+
export type personGetPersonResponse200 = {
|
|
1065
|
+
data: Person
|
|
1066
|
+
status: 200
|
|
1067
|
+
}
|
|
1068
|
+
|
|
1069
|
+
export type personGetPersonResponse400 = {
|
|
1070
|
+
data: void
|
|
1071
|
+
status: 400
|
|
1072
|
+
}
|
|
1073
|
+
|
|
1074
|
+
export type personGetPersonResponse401 = {
|
|
1075
|
+
data: void
|
|
1076
|
+
status: 401
|
|
1077
|
+
}
|
|
1078
|
+
|
|
1079
|
+
export type personGetPersonResponse404 = {
|
|
1080
|
+
data: void
|
|
1081
|
+
status: 404
|
|
1082
|
+
}
|
|
1083
|
+
|
|
1084
|
+
export type personGetPersonResponseSuccess = (personGetPersonResponse200) & {
|
|
1085
|
+
headers: Headers;
|
|
1086
|
+
};
|
|
1087
|
+
export type personGetPersonResponseError = (personGetPersonResponse400 | personGetPersonResponse401 | personGetPersonResponse404) & {
|
|
1088
|
+
headers: Headers;
|
|
1089
|
+
};
|
|
1090
|
+
|
|
1091
|
+
export type personGetPersonResponse = (personGetPersonResponseSuccess | personGetPersonResponseError)
|
|
1092
|
+
|
|
1093
|
+
export const getPersonGetPersonUrl = (personUid: string | null,) => {
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
return `/api/v1/crm/people/${personUid}`
|
|
1099
|
+
}
|
|
1100
|
+
|
|
1101
|
+
export const personGetPerson = async (personUid: string | null, options?: RequestInit): Promise<personGetPersonResponse> => {
|
|
1102
|
+
|
|
1103
|
+
return customFetch<personGetPersonResponse>(getPersonGetPersonUrl(personUid),
|
|
1104
|
+
{
|
|
1105
|
+
...options,
|
|
1106
|
+
method: 'GET'
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
}
|
|
1110
|
+
);}
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
/**
|
|
1114
|
+
* @summary Update a person record. You can update one or multiple properties on the object.
|
|
1115
|
+
Any property that you include in the json schema will be updated.
|
|
1116
|
+
To update custom properties just include them in the same way that they are included when you do a get on the object.
|
|
1117
|
+
*/
|
|
1118
|
+
export type personUpdatePersonResponse200 = {
|
|
1119
|
+
data: Person
|
|
1120
|
+
status: 200
|
|
1121
|
+
}
|
|
1122
|
+
|
|
1123
|
+
export type personUpdatePersonResponse400 = {
|
|
1124
|
+
data: void
|
|
1125
|
+
status: 400
|
|
1126
|
+
}
|
|
1127
|
+
|
|
1128
|
+
export type personUpdatePersonResponse401 = {
|
|
1129
|
+
data: void
|
|
1130
|
+
status: 401
|
|
1131
|
+
}
|
|
1132
|
+
|
|
1133
|
+
export type personUpdatePersonResponse404 = {
|
|
1134
|
+
data: void
|
|
1135
|
+
status: 404
|
|
1136
|
+
}
|
|
1137
|
+
|
|
1138
|
+
export type personUpdatePersonResponseSuccess = (personUpdatePersonResponse200) & {
|
|
1139
|
+
headers: Headers;
|
|
1140
|
+
};
|
|
1141
|
+
export type personUpdatePersonResponseError = (personUpdatePersonResponse400 | personUpdatePersonResponse401 | personUpdatePersonResponse404) & {
|
|
1142
|
+
headers: Headers;
|
|
1143
|
+
};
|
|
1144
|
+
|
|
1145
|
+
export type personUpdatePersonResponse = (personUpdatePersonResponseSuccess | personUpdatePersonResponseError)
|
|
1146
|
+
|
|
1147
|
+
export const getPersonUpdatePersonUrl = (personUid: string | null,) => {
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
return `/api/v1/crm/people/${personUid}`
|
|
1153
|
+
}
|
|
1154
|
+
|
|
1155
|
+
export const personUpdatePerson = async (personUid: string | null,
|
|
1156
|
+
personUpdatePersonBody: PersonUpdatePersonBody, options?: RequestInit): Promise<personUpdatePersonResponse> => {
|
|
1157
|
+
|
|
1158
|
+
return customFetch<personUpdatePersonResponse>(getPersonUpdatePersonUrl(personUid),
|
|
1159
|
+
{
|
|
1160
|
+
...options,
|
|
1161
|
+
method: 'PUT',
|
|
1162
|
+
headers: { 'Content-Type': 'application/json', ...options?.headers },
|
|
1163
|
+
body: JSON.stringify(
|
|
1164
|
+
personUpdatePersonBody,)
|
|
1165
|
+
}
|
|
1166
|
+
);}
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
/**
|
|
1170
|
+
* @summary Delete a person record.
|
|
1171
|
+
*/
|
|
1172
|
+
export type personDeletePersonResponse200 = {
|
|
1173
|
+
data: Blob
|
|
1174
|
+
status: 200
|
|
1175
|
+
}
|
|
1176
|
+
|
|
1177
|
+
export type personDeletePersonResponse400 = {
|
|
1178
|
+
data: void
|
|
1179
|
+
status: 400
|
|
1180
|
+
}
|
|
1181
|
+
|
|
1182
|
+
export type personDeletePersonResponse401 = {
|
|
1183
|
+
data: void
|
|
1184
|
+
status: 401
|
|
1185
|
+
}
|
|
1186
|
+
|
|
1187
|
+
export type personDeletePersonResponse404 = {
|
|
1188
|
+
data: void
|
|
1189
|
+
status: 404
|
|
1190
|
+
}
|
|
1191
|
+
|
|
1192
|
+
export type personDeletePersonResponseSuccess = (personDeletePersonResponse200) & {
|
|
1193
|
+
headers: Headers;
|
|
1194
|
+
};
|
|
1195
|
+
export type personDeletePersonResponseError = (personDeletePersonResponse400 | personDeletePersonResponse401 | personDeletePersonResponse404) & {
|
|
1196
|
+
headers: Headers;
|
|
1197
|
+
};
|
|
1198
|
+
|
|
1199
|
+
export type personDeletePersonResponse = (personDeletePersonResponseSuccess | personDeletePersonResponseError)
|
|
1200
|
+
|
|
1201
|
+
export const getPersonDeletePersonUrl = (personUid: string | null,) => {
|
|
1202
|
+
|
|
1203
|
+
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
return `/api/v1/crm/people/${personUid}`
|
|
1207
|
+
}
|
|
1208
|
+
|
|
1209
|
+
export const personDeletePerson = async (personUid: string | null, options?: RequestInit): Promise<personDeletePersonResponse> => {
|
|
1210
|
+
|
|
1211
|
+
return customFetch<personDeletePersonResponse>(getPersonDeletePersonUrl(personUid),
|
|
1212
|
+
{
|
|
1213
|
+
...options,
|
|
1214
|
+
method: 'DELETE'
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
}
|
|
1218
|
+
);}
|
|
1219
|
+
|
|
1220
|
+
|
|
1221
|
+
/**
|
|
1222
|
+
* @summary Set a temporary password for a user. The user needs to update the password with the next login.
|
|
1223
|
+
*/
|
|
1224
|
+
export type personSetTemporaryPasswordResponse200 = {
|
|
1225
|
+
data: Blob
|
|
1226
|
+
status: 200
|
|
1227
|
+
}
|
|
1228
|
+
|
|
1229
|
+
export type personSetTemporaryPasswordResponse400 = {
|
|
1230
|
+
data: void
|
|
1231
|
+
status: 400
|
|
1232
|
+
}
|
|
1233
|
+
|
|
1234
|
+
export type personSetTemporaryPasswordResponse401 = {
|
|
1235
|
+
data: void
|
|
1236
|
+
status: 401
|
|
1237
|
+
}
|
|
1238
|
+
|
|
1239
|
+
export type personSetTemporaryPasswordResponse404 = {
|
|
1240
|
+
data: void
|
|
1241
|
+
status: 404
|
|
1242
|
+
}
|
|
1243
|
+
|
|
1244
|
+
export type personSetTemporaryPasswordResponseSuccess = (personSetTemporaryPasswordResponse200) & {
|
|
1245
|
+
headers: Headers;
|
|
1246
|
+
};
|
|
1247
|
+
export type personSetTemporaryPasswordResponseError = (personSetTemporaryPasswordResponse400 | personSetTemporaryPasswordResponse401 | personSetTemporaryPasswordResponse404) & {
|
|
1248
|
+
headers: Headers;
|
|
1249
|
+
};
|
|
1250
|
+
|
|
1251
|
+
export type personSetTemporaryPasswordResponse = (personSetTemporaryPasswordResponseSuccess | personSetTemporaryPasswordResponseError)
|
|
1252
|
+
|
|
1253
|
+
export const getPersonSetTemporaryPasswordUrl = (personUid: string | null,) => {
|
|
1254
|
+
|
|
1255
|
+
|
|
1256
|
+
|
|
1257
|
+
|
|
1258
|
+
return `/api/v1/crm/people/${personUid}/setTemporaryPassword`
|
|
1259
|
+
}
|
|
1260
|
+
|
|
1261
|
+
export const personSetTemporaryPassword = async (personUid: string | null,
|
|
1262
|
+
personSetTemporaryPasswordBody: PersonSetTemporaryPasswordBody, options?: RequestInit): Promise<personSetTemporaryPasswordResponse> => {
|
|
1263
|
+
|
|
1264
|
+
return customFetch<personSetTemporaryPasswordResponse>(getPersonSetTemporaryPasswordUrl(personUid),
|
|
1265
|
+
{
|
|
1266
|
+
...options,
|
|
1267
|
+
method: 'PUT',
|
|
1268
|
+
headers: { 'Content-Type': 'application/json', ...options?.headers },
|
|
1269
|
+
body: JSON.stringify(
|
|
1270
|
+
personSetTemporaryPasswordBody,)
|
|
1271
|
+
}
|
|
1272
|
+
);}
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
/**
|
|
1276
|
+
* @summary Initiate the forgot password flow by sending an email to the user with a link to a page
|
|
1277
|
+
where they can reset their password. The reset password token in the link is valid for 30 minutes.
|
|
1278
|
+
*/
|
|
1279
|
+
export type personForgotPasswordResponse200 = {
|
|
1280
|
+
data: Blob
|
|
1281
|
+
status: 200
|
|
1282
|
+
}
|
|
1283
|
+
|
|
1284
|
+
export type personForgotPasswordResponseSuccess = (personForgotPasswordResponse200) & {
|
|
1285
|
+
headers: Headers;
|
|
1286
|
+
};
|
|
1287
|
+
;
|
|
1288
|
+
|
|
1289
|
+
export type personForgotPasswordResponse = (personForgotPasswordResponseSuccess)
|
|
1290
|
+
|
|
1291
|
+
export const getPersonForgotPasswordUrl = () => {
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
|
|
1296
|
+
return `/api/v1/crm/people/forgotPassword`
|
|
1297
|
+
}
|
|
1298
|
+
|
|
1299
|
+
export const personForgotPassword = async (personForgotPasswordBody: PersonForgotPasswordBody, options?: RequestInit): Promise<personForgotPasswordResponse> => {
|
|
1300
|
+
|
|
1301
|
+
return customFetch<personForgotPasswordResponse>(getPersonForgotPasswordUrl(),
|
|
1302
|
+
{
|
|
1303
|
+
...options,
|
|
1304
|
+
method: 'POST',
|
|
1305
|
+
headers: { 'Content-Type': 'application/json', ...options?.headers },
|
|
1306
|
+
body: JSON.stringify(
|
|
1307
|
+
personForgotPasswordBody,)
|
|
1308
|
+
}
|
|
1309
|
+
);}
|
|
1310
|
+
|
|
1311
|
+
|