@outseta/api-client 0.2.3 → 0.2.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@outseta/api-client",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "Generated API client for the Outseta REST API",
   "license": "MIT",
   "repository": {
@@ -17,12 +17,6 @@
       "import": "./dist/index.js"
     }
   },
-  "scripts": {
-    "build": "rimraf dist && bun build src/index.ts --outdir dist --target node --format esm --packages external",
-    "typecheck": "tsc --noEmit",
-    "lint": "eslint src --ignore-pattern generated",
-    "test": "bun test --env-file ../../.env.test"
-  },
   "dependencies": {},
   "devDependencies": {
     "@types/bun": "^1.3.10",
@@ -35,5 +29,11 @@
   "publishConfig": {
     "access": "public",
     "provenance": true
+  },
+  "scripts": {
+    "build": "rimraf dist && bun build src/index.ts --outdir dist --target node --format esm --packages external",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --ignore-pattern generated",
+    "test": "bun test --env-file ../../.env.test"
   }
-}
+}

package/src/generated/activity/activity.ts

@@ -8,10 +8,12 @@ import type {
 import { customFetch } from '../../client';
 
 /**
- * @summary Retrieves all the activities. One or multiple parameters can be defined to filter the results.
-ActivityType=[100,101] where ActivityUpdated = 100 and AcccountUpdated = 101
+ * One or multiple parameters can be defined to filter the results.
+ActivityType=[100,101] where ActivityUpdated = 100 and AcccountUpdated = 101.
 Results will be limited to the last year unless ActivityDateTime is specified,
-possibly with ActivityDateTime__gt/ActivityDateTime__gte and ActivityDateTime__lt/ActivityDateTime__lte
+possibly with ActivityDateTime__gt/ActivityDateTime__gte and
+ActivityDateTime__lt/ActivityDateTime__lte.
+ * @summary Retrieve all activities, optionally filtered.
  */
 export type activityGetAllResponse200 = {
   data: Activity[]
@@ -68,10 +70,11 @@ export const activityGetAll = async (params?: ActivityGetAllParams, options?: Re
 
 
 /**
- * @summary Record custom events associated to an account, person or deal. These activities show up
-on the activity feed of the corresponding entity and can be leveraged to trigger drip
-campaigns and other automation. For integration with drip campaigns make sure that what
-you pass in the Title property matches the start / stop value specified for the campaign.
+ * These activities show up on the activity feed of the corresponding entity and can be
+leveraged to trigger drip campaigns and other automation. For integration with drip
+campaigns make sure that what you pass in the Title property matches the start / stop
+value specified for the campaign.
+ * @summary Record a custom event associated to an account, person or deal.
  */
 export type activityAddCustomActivityResponse200 = {
   data: Blob

package/src/generated/attribute/attribute.ts

@@ -0,0 +1,94 @@
+// @ts-nocheck
+import type {
+  Definition
+} from '.././models';
+
+import { customFetch } from '../../client';
+
+/**
+ * entityType is the name of an EntityType enum value, for example: Account, Person,
+Deal. Definitions describe the labels, system names, and control types of
+the custom attributes that have been added to that entity.
+ * @summary Returns all custom attribute definitions for the given entity type.
+ */
+export type definitionGetAllDefinitionsResponse200 = {
+  data: Definition[]
+  status: 200
+}
+    
+export type definitionGetAllDefinitionsResponseSuccess = (definitionGetAllDefinitionsResponse200) & {
+  headers: Headers;
+};
+;
+
+export type definitionGetAllDefinitionsResponse = (definitionGetAllDefinitionsResponseSuccess)
+
+export const getDefinitionGetAllDefinitionsUrl = (entityType: string | null,) => {
+
+
+  
+
+  return `/api/v1/attributes/${entityType}/definitions`
+}
+
+export const definitionGetAllDefinitions = async (entityType: string | null, options?: RequestInit): Promise<definitionGetAllDefinitionsResponse> => {
+  
+  return customFetch<definitionGetAllDefinitionsResponse>(getDefinitionGetAllDefinitionsUrl(entityType),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+
+/**
+ * The entityType segment of the URL must match the type the definition belongs to
+(e.g. Account, Person, Deal).
+ * @summary Returns a single custom attribute definition by UID.
+ */
+export type definitionGetDefinitionResponse200 = {
+  data: Definition
+  status: 200
+}
+
+export type definitionGetDefinitionResponse400 = {
+  data: void
+  status: 400
+}
+
+export type definitionGetDefinitionResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type definitionGetDefinitionResponseSuccess = (definitionGetDefinitionResponse200) & {
+  headers: Headers;
+};
+export type definitionGetDefinitionResponseError = (definitionGetDefinitionResponse400 | definitionGetDefinitionResponse404) & {
+  headers: Headers;
+};
+
+export type definitionGetDefinitionResponse = (definitionGetDefinitionResponseSuccess | definitionGetDefinitionResponseError)
+
+export const getDefinitionGetDefinitionUrl = (definitionUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/attributes/definitions/${definitionUid}`
+}
+
+export const definitionGetDefinition = async (definitionUid: string | null, options?: RequestInit): Promise<definitionGetDefinitionResponse> => {
+  
+  return customFetch<definitionGetDefinitionResponse>(getDefinitionGetDefinitionUrl(definitionUid),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+

package/src/generated/billing/billing.ts

@@ -4,6 +4,7 @@ import type {
   DiscountCouponAddDiscountCouponBody,
   Invoice,
   InvoiceAddInvoiceBody,
+  InvoiceUpdateInvoiceBody,
   PaymentInformation,
   PaymentInformationSavePaymentInformationBody,
   Plan,
@@ -27,8 +28,9 @@ import type {
 import { customFetch } from '../../client';
 
 /**
- * @summary Add a new discount coupon. Only one of AmountOff or PercentOff should be set.
+ * Only one of AmountOff or PercentOff should be set.
 Duration values: 1 = Forever, 2 = Once, 3 = Repeating (DurationInMonths must be set).
+ * @summary Add a new discount coupon.
  */
 export type discountCouponAddDiscountCouponResponse200 = {
   data: DiscountCoupon
@@ -114,8 +116,9 @@ export const usageAddUsage = async (usageAddUsageBody: UsageAddUsageBody, option
 
 
 /**
- * @summary Retrieves all transactions for a given account. Transactions are tied to accounts and invoices.
+ * Transactions are tied to accounts and invoices.
 BillingTransactionType: Invoice = 1, Payment = 2, Credit = 3, Refund = 4, Chargeback = 5.
+ * @summary Retrieve all transactions for a given account.
  */
 export type transactionsGetAllTransactionsByAccountIdResponse200 = {
   data: Transaction[]
@@ -162,8 +165,9 @@ export const transactionsGetAllTransactionsByAccountId = async (accountUid: stri
 
 
 /**
- * @summary Adds a payment to an invoice. If the amount matches the outstanding amount of the invoice,
-the invoice will be marked as Paid.
+ * If the amount matches the outstanding amount of the invoice, the invoice will be marked
+as Paid.
+ * @summary Add a payment to an invoice.
  */
 export type transactionsAddPaymentTransactionResponse200 = {
   data: Transaction
@@ -291,6 +295,51 @@ export const subscriptionAddOnAddSubscriptionAddOn = async (subscriptionAddOnAdd
 );}
 
 
+/**
+ * Admins and API key callers see every invoice. Non-admin users see only invoices
+belonging to the account they are the primary contact of.
+Pass excludeInvoiceUid as a query parameter to omit a specific invoice from the result set.
+ * @summary Returns all invoices, optionally restricted to the requester's account.
+ */
+export type invoiceGetAllInvoicesResponse200 = {
+  data: Invoice[]
+  status: 200
+}
+
+export type invoiceGetAllInvoicesResponse401 = {
+  data: void
+  status: 401
+}
+    
+export type invoiceGetAllInvoicesResponseSuccess = (invoiceGetAllInvoicesResponse200) & {
+  headers: Headers;
+};
+export type invoiceGetAllInvoicesResponseError = (invoiceGetAllInvoicesResponse401) & {
+  headers: Headers;
+};
+
+export type invoiceGetAllInvoicesResponse = (invoiceGetAllInvoicesResponseSuccess | invoiceGetAllInvoicesResponseError)
+
+export const getInvoiceGetAllInvoicesUrl = () => {
+
+
+  
+
+  return `/api/v1/billing/invoices`
+}
+
+export const invoiceGetAllInvoices = async ( options?: RequestInit): Promise<invoiceGetAllInvoicesResponse> => {
+  
+  return customFetch<invoiceGetAllInvoicesResponse>(getInvoiceGetAllInvoicesUrl(),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+
 /**
  * @summary Create an ad-hoc invoice for a given account.
  */
@@ -334,6 +383,329 @@ export const invoiceAddInvoice = async (invoiceAddInvoiceBody: InvoiceAddInvoice
 );}
 
 
+/**
+ * @summary Returns a single invoice by UID.
+ */
+export type invoiceGetInvoiceResponse200 = {
+  data: Invoice
+  status: 200
+}
+
+export type invoiceGetInvoiceResponse400 = {
+  data: void
+  status: 400
+}
+
+export type invoiceGetInvoiceResponse401 = {
+  data: void
+  status: 401
+}
+
+export type invoiceGetInvoiceResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type invoiceGetInvoiceResponseSuccess = (invoiceGetInvoiceResponse200) & {
+  headers: Headers;
+};
+export type invoiceGetInvoiceResponseError = (invoiceGetInvoiceResponse400 | invoiceGetInvoiceResponse401 | invoiceGetInvoiceResponse404) & {
+  headers: Headers;
+};
+
+export type invoiceGetInvoiceResponse = (invoiceGetInvoiceResponseSuccess | invoiceGetInvoiceResponseError)
+
+export const getInvoiceGetInvoiceUrl = (invoiceUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/billing/invoices/${invoiceUid}`
+}
+
+export const invoiceGetInvoice = async (invoiceUid: string | null, options?: RequestInit): Promise<invoiceGetInvoiceResponse> => {
+  
+  return customFetch<invoiceGetInvoiceResponse>(getInvoiceGetInvoiceUrl(invoiceUid),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+
+/**
+ * Only invoices created manually via the API or admin UI can be updated; invoices
+generated by a subscription's billing cycle are immutable and will return a
+validation error.
+ * @summary Update an ad-hoc (manually created) invoice.
+ */
+export type invoiceUpdateInvoiceResponse200 = {
+  data: Invoice
+  status: 200
+}
+
+export type invoiceUpdateInvoiceResponse400 = {
+  data: void
+  status: 400
+}
+
+export type invoiceUpdateInvoiceResponse401 = {
+  data: void
+  status: 401
+}
+
+export type invoiceUpdateInvoiceResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type invoiceUpdateInvoiceResponseSuccess = (invoiceUpdateInvoiceResponse200) & {
+  headers: Headers;
+};
+export type invoiceUpdateInvoiceResponseError = (invoiceUpdateInvoiceResponse400 | invoiceUpdateInvoiceResponse401 | invoiceUpdateInvoiceResponse404) & {
+  headers: Headers;
+};
+
+export type invoiceUpdateInvoiceResponse = (invoiceUpdateInvoiceResponseSuccess | invoiceUpdateInvoiceResponseError)
+
+export const getInvoiceUpdateInvoiceUrl = (invoiceUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/billing/invoices/${invoiceUid}`
+}
+
+export const invoiceUpdateInvoice = async (invoiceUid: string | null,
+    invoiceUpdateInvoiceBody: InvoiceUpdateInvoiceBody, options?: RequestInit): Promise<invoiceUpdateInvoiceResponse> => {
+  
+  return customFetch<invoiceUpdateInvoiceResponse>(getInvoiceUpdateInvoiceUrl(invoiceUid),
+  {      
+    ...options,
+    method: 'PUT',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      invoiceUpdateInvoiceBody,)
+  }
+);}
+
+
+/**
+ * @summary Delete an invoice.
+ */
+export type invoiceDeleteInvoiceResponse200 = {
+  data: Blob
+  status: 200
+}
+
+export type invoiceDeleteInvoiceResponse400 = {
+  data: void
+  status: 400
+}
+
+export type invoiceDeleteInvoiceResponse401 = {
+  data: void
+  status: 401
+}
+
+export type invoiceDeleteInvoiceResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type invoiceDeleteInvoiceResponseSuccess = (invoiceDeleteInvoiceResponse200) & {
+  headers: Headers;
+};
+export type invoiceDeleteInvoiceResponseError = (invoiceDeleteInvoiceResponse400 | invoiceDeleteInvoiceResponse401 | invoiceDeleteInvoiceResponse404) & {
+  headers: Headers;
+};
+
+export type invoiceDeleteInvoiceResponse = (invoiceDeleteInvoiceResponseSuccess | invoiceDeleteInvoiceResponseError)
+
+export const getInvoiceDeleteInvoiceUrl = (invoiceUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/billing/invoices/${invoiceUid}`
+}
+
+export const invoiceDeleteInvoice = async (invoiceUid: string | null, options?: RequestInit): Promise<invoiceDeleteInvoiceResponse> => {
+  
+  return customFetch<invoiceDeleteInvoiceResponse>(getInvoiceDeleteInvoiceUrl(invoiceUid),
+  {      
+    ...options,
+    method: 'DELETE'
+    
+    
+  }
+);}
+
+
+/**
+ * Response body is a binary PDF (Content-Type: application/pdf) served as an
+attachment named invoice-{Number}-{InvoiceDate}-{AccountName}.pdf.
+ * @summary Returns a rendered PDF copy of an invoice.
+ */
+export type invoiceGetInvoiceAsPdfResponse200 = {
+  data: Blob
+  status: 200
+}
+
+export type invoiceGetInvoiceAsPdfResponse400 = {
+  data: void
+  status: 400
+}
+
+export type invoiceGetInvoiceAsPdfResponse401 = {
+  data: void
+  status: 401
+}
+
+export type invoiceGetInvoiceAsPdfResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type invoiceGetInvoiceAsPdfResponseSuccess = (invoiceGetInvoiceAsPdfResponse200) & {
+  headers: Headers;
+};
+export type invoiceGetInvoiceAsPdfResponseError = (invoiceGetInvoiceAsPdfResponse400 | invoiceGetInvoiceAsPdfResponse401 | invoiceGetInvoiceAsPdfResponse404) & {
+  headers: Headers;
+};
+
+export type invoiceGetInvoiceAsPdfResponse = (invoiceGetInvoiceAsPdfResponseSuccess | invoiceGetInvoiceAsPdfResponseError)
+
+export const getInvoiceGetInvoiceAsPdfUrl = (invoiceUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/billing/invoices/${invoiceUid}/pdf`
+}
+
+export const invoiceGetInvoiceAsPdf = async (invoiceUid: string | null, options?: RequestInit): Promise<invoiceGetInvoiceAsPdfResponse> => {
+  
+  return customFetch<invoiceGetInvoiceAsPdfResponse>(getInvoiceGetInvoiceAsPdfUrl(invoiceUid),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+
+/**
+ * Optional query parameters:
+  note - free-text note to include in the email body.
+  bcc  - comma-separated list of email addresses to BCC.
+ * @summary Email an invoice to the account's billing contact.
+ */
+export type invoiceSendInvoiceEmailResponse200 = {
+  data: Blob
+  status: 200
+}
+
+export type invoiceSendInvoiceEmailResponse400 = {
+  data: void
+  status: 400
+}
+
+export type invoiceSendInvoiceEmailResponse401 = {
+  data: void
+  status: 401
+}
+
+export type invoiceSendInvoiceEmailResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type invoiceSendInvoiceEmailResponseSuccess = (invoiceSendInvoiceEmailResponse200) & {
+  headers: Headers;
+};
+export type invoiceSendInvoiceEmailResponseError = (invoiceSendInvoiceEmailResponse400 | invoiceSendInvoiceEmailResponse401 | invoiceSendInvoiceEmailResponse404) & {
+  headers: Headers;
+};
+
+export type invoiceSendInvoiceEmailResponse = (invoiceSendInvoiceEmailResponseSuccess | invoiceSendInvoiceEmailResponseError)
+
+export const getInvoiceSendInvoiceEmailUrl = (invoiceUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/billing/invoices/${invoiceUid}/sendinvoiceemail`
+}
+
+export const invoiceSendInvoiceEmail = async (invoiceUid: string | null, options?: RequestInit): Promise<invoiceSendInvoiceEmailResponse> => {
+  
+  return customFetch<invoiceSendInvoiceEmailResponse>(getInvoiceSendInvoiceEmailUrl(invoiceUid),
+  {      
+    ...options,
+    method: 'POST'
+    
+    
+  }
+);}
+
+
+/**
+ * Returns 400 Bad Request if the invoice is not in the Paid status.
+ * @summary Send the "invoice paid" receipt email to the account's billing contact.
+ */
+export type invoiceSendInvoicePaidEmailResponse200 = {
+  data: Blob
+  status: 200
+}
+
+export type invoiceSendInvoicePaidEmailResponse400 = {
+  data: void
+  status: 400
+}
+
+export type invoiceSendInvoicePaidEmailResponse401 = {
+  data: void
+  status: 401
+}
+
+export type invoiceSendInvoicePaidEmailResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type invoiceSendInvoicePaidEmailResponseSuccess = (invoiceSendInvoicePaidEmailResponse200) & {
+  headers: Headers;
+};
+export type invoiceSendInvoicePaidEmailResponseError = (invoiceSendInvoicePaidEmailResponse400 | invoiceSendInvoicePaidEmailResponse401 | invoiceSendInvoicePaidEmailResponse404) & {
+  headers: Headers;
+};
+
+export type invoiceSendInvoicePaidEmailResponse = (invoiceSendInvoicePaidEmailResponseSuccess | invoiceSendInvoicePaidEmailResponseError)
+
+export const getInvoiceSendInvoicePaidEmailUrl = (invoiceUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/billing/invoices/${invoiceUid}/sendinvoicepaidemail`
+}
+
+export const invoiceSendInvoicePaidEmail = async (invoiceUid: string | null, options?: RequestInit): Promise<invoiceSendInvoicePaidEmailResponse> => {
+  
+  return customFetch<invoiceSendInvoicePaidEmailResponse>(getInvoiceSendInvoicePaidEmailUrl(invoiceUid),
+  {      
+    ...options,
+    method: 'POST'
+    
+    
+  }
+);}
+
+
 /**
  * @summary Retrieves a subscription.
  */
@@ -441,8 +813,9 @@ export const subscriptionAddDiscountToSubscription = async (subscriptionUid: str
 
 
 /**
- * @summary Indicate that an upgrade of plan is required. When a subscription is flagged, next time
-the user authenticates the authentication widget will prompt the user to change plan.
+ * When a subscription is flagged, next time the user authenticates the authentication
+widget will prompt the user to change plan.
+ * @summary Indicate that an upgrade of plan is required.
  */
 export type subscriptionSetSubscriptionUpgradeRequiredResponse200 = {
   data: Subscription
@@ -496,10 +869,11 @@ export const subscriptionSetSubscriptionUpgradeRequired = async (subscriptionUid
 
 
 /**
- * @summary Preview what the initial or renewal invoice would look like if an account were to register
-with this subscription. Returns an invoice object with information about the amount outstanding.
-BillingRenewalTerm values: 1 = Monthly, 2 = Yearly, 3 = Quarterly, 4 = OneTime.
-Pass asOf=renewal to see the renewal invoice instead of the initial invoice.
+ * Returns an invoice object with information about the amount outstanding if an account
+were to register with this subscription. BillingRenewalTerm values: 1 = Monthly,
+2 = Yearly, 3 = Quarterly, 4 = OneTime. Pass asOf=renewal to see the renewal invoice
+instead of the initial invoice.
+ * @summary Preview the initial or renewal invoice for a hypothetical subscription.
  */
 export type subscriptionFirstTimeSubscriptionPreviewResponse200 = {
   data: Invoice
@@ -543,8 +917,8 @@ export const subscriptionFirstTimeSubscriptionPreview = async (subscriptionFirst
 
 
 /**
- * @summary Add a subscription to an account for the first time. Returns an invoice object
-with information about the amount outstanding.
+ * Returns an invoice object with information about the amount outstanding.
+ * @summary Add a subscription to an account for the first time.
  */
 export type subscriptionFirstTimeSubscriptionResponse200 = {
   data: Invoice
@@ -587,8 +961,9 @@ export const subscriptionFirstTimeSubscription = async (subscriptionFirstTimeSub
 
 
 /**
- * @summary Preview what the invoice would look like when changing a subscription. Returns an invoice object
-with information about the amount outstanding. This method does not commit the subscription change.
+ * Returns an invoice object with information about the amount outstanding. This method
+does not commit the subscription change.
+ * @summary Preview the invoice for a subscription change.
  */
 export type subscriptionChangeSubscriptionPreviewResponse200 = {
   data: Invoice
@@ -651,8 +1026,8 @@ export const subscriptionChangeSubscriptionPreview = async (subscriptionUid: str
 
 
 /**
- * @summary Change a subscription on an account. Returns an invoice object with information about
-the amount outstanding.
+ * Returns an invoice object with information about the amount outstanding.
+ * @summary Change a subscription on an account.
  */
 export type subscriptionChangeSubscriptionResponse200 = {
   data: Subscription

package/src/generated/crm/crm.ts

@@ -280,11 +280,13 @@ export const dealDeleteDeal = async (dealUid: string | null, options?: RequestIn
 
 
 /**
- * @summary Register a new account. This is the same endpoint the sign up embed uses to create accounts.
-At a minimum you must pass one Primary Contact with an Email address and one Subscription
-record with a reference to a Plan. Other fields (e.g. Account Name, Billing Address,
-Payment Information, etc.) can be passed as desired. A confirmation email will be sent
-to the user unless you've specifically toggled this option off on the AUTH > SIGN UP AND LOGIN page.
+ * This is the same endpoint the sign up embed uses to create accounts. At a minimum you
+must pass one Primary Contact with an Email address and one Subscription record with a
+reference to a Plan. Other fields (e.g. Account Name, Billing Address, Payment
+Information, etc.) can be passed as desired. A confirmation email will be sent to the
+user unless you've specifically toggled this option off on the AUTH > SIGN UP AND LOGIN
+page.
+ * @summary Register a new account.
  */
 export type registrationRegisterAccountResponse200 = {
   data: Account
@@ -373,9 +375,9 @@ export const accountGetAllAccounts = async (params?: AccountGetAllAccountsParams
 
 
 /**
- * @summary Add a new account.
-To add an account with an existing person, the Account payload include something like this:
+ * To add an account with an existing person, the Account payload include something like this:
 { ... other Account properties ..., "PersonAccount": [ { "Person": { "Uid": [personUid] }, "IsPrimary": "true" } ] }
+ * @summary Add a new account.
  */
 export type accountAddAccountResponse200 = {
   data: Blob
@@ -530,9 +532,10 @@ export const accountDeleteAccount = async (accountUid: string | null, options?:
 
 
 /**
- * @summary Update account information. You can update one or multiple properties on the object.
-Any property that you include in the json schema will be updated.
-To update custom properties just include them in the same way that they are included when you do a get on the object.
+ * You can update one or multiple properties on the object. Any property that you
+include in the json schema will be updated. To update custom properties just
+include them in the same way that they are included when you do a get on the object.
+ * @summary Update account information.
  */
 export type accountUpdateAccountResponse200 = {
   data: Account
@@ -750,10 +753,10 @@ export const accountDeleteMembership = async (accountUid: string | null,
 
 
 /**
- * @summary Add a cancellation request to an account. The account needs to be in subscribing stage.
-The stage will automatically change over to cancelling. If the account has a subscription
-attached to it then at the subscription renewal the subscription will end and the account
-will be automatically set to expired.
+ * The account needs to be in subscribing stage. The stage will automatically change over to
+cancelling. If the account has a subscription attached to it then at the subscription
+renewal the subscription will end and the account will be automatically set to expired.
+ * @summary Add a cancellation request to an account.
  */
 export type accountCancelAccountResponse200 = {
   data: Blob
@@ -913,9 +916,10 @@ export const accountExtendTrial = async (accountUid: string | null,
 
 
 /**
- * @summary Send a confirmation email to people on an account. Pass personUid as a query parameter
-to send to a specific person, or personUid=* to send to all people on the account.
-If no personUid is provided, the email is sent to the primary contact.
+ * Pass personUid as a query parameter to send to a specific person, or personUid=* to send
+to all people on the account. If no personUid is provided, the email is sent to the
+primary contact.
+ * @summary Send a confirmation email to people on an account.
  */
 export type accountSendConfirmationEmailResponse200 = {
   data: Blob
@@ -1111,9 +1115,10 @@ export const personGetPerson = async (personUid: string | null, options?: Reques
 
 
 /**
- * @summary Update a person record. You can update one or multiple properties on the object.
-Any property that you include in the json schema will be updated.
-To update custom properties just include them in the same way that they are included when you do a get on the object.
+ * You can update one or multiple properties on the object. Any property that you
+include in the json schema will be updated. To update custom properties just
+include them in the same way that they are included when you do a get on the object.
+ * @summary Update a person record.
  */
 export type personUpdatePersonResponse200 = {
   data: Person
@@ -1273,8 +1278,65 @@ export const personSetTemporaryPassword = async (personUid: string | null,
 
 
 /**
- * @summary Initiate the forgot password flow by sending an email to the user with a link to a page
-where they can reset their password. The reset password token in the link is valid for 30 minutes.
+ * All prior recovery codes are invalidated. Existing TOTP/Email mechanisms are intentionally
+left in place — the admin returns the new codes to the user out of band, the user logs in
+with one, then re-enrolls their device. Mirrors the temporary-password flow at
+SetTemporaryPassword.
+ * @summary Regenerate 2FA recovery codes for a user locked out of their authenticator.
+ */
+export type personRegenerateTwoFactorRecoveryCodesResponse200 = {
+  data: Blob
+  status: 200
+}
+
+export type personRegenerateTwoFactorRecoveryCodesResponse400 = {
+  data: void
+  status: 400
+}
+
+export type personRegenerateTwoFactorRecoveryCodesResponse401 = {
+  data: void
+  status: 401
+}
+
+export type personRegenerateTwoFactorRecoveryCodesResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type personRegenerateTwoFactorRecoveryCodesResponseSuccess = (personRegenerateTwoFactorRecoveryCodesResponse200) & {
+  headers: Headers;
+};
+export type personRegenerateTwoFactorRecoveryCodesResponseError = (personRegenerateTwoFactorRecoveryCodesResponse400 | personRegenerateTwoFactorRecoveryCodesResponse401 | personRegenerateTwoFactorRecoveryCodesResponse404) & {
+  headers: Headers;
+};
+
+export type personRegenerateTwoFactorRecoveryCodesResponse = (personRegenerateTwoFactorRecoveryCodesResponseSuccess | personRegenerateTwoFactorRecoveryCodesResponseError)
+
+export const getPersonRegenerateTwoFactorRecoveryCodesUrl = (personUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/crm/people/${personUid}/regenerateTwoFactorRecoveryCodes`
+}
+
+export const personRegenerateTwoFactorRecoveryCodes = async (personUid: string | null, options?: RequestInit): Promise<personRegenerateTwoFactorRecoveryCodesResponse> => {
+  
+  return customFetch<personRegenerateTwoFactorRecoveryCodesResponse>(getPersonRegenerateTwoFactorRecoveryCodesUrl(personUid),
+  {      
+    ...options,
+    method: 'PUT'
+    
+    
+  }
+);}
+
+
+/**
+ * Sends an email to the user with a link to a page where they can reset their password.
+The reset password token in the link is valid for 30 minutes.
+ * @summary Initiate the forgot password flow.
  */
 export type personForgotPasswordResponse200 = {
   data: Blob

package/src/generated/email/email.ts

@@ -54,10 +54,11 @@ export const campaignGetAllBroadcastEmails = async ( options?: RequestInit): Pro
 
 
 /**
- * @summary Creates a new broadcast campaign. To copy an existing broadcast, retrieve it and pass its
-data as the request body — the Uid, SendDateTime, and message counts are automatically reset.
-Recipients can be specified using EmailListUids and SegmentUids instead of populating
-RecipientData directly. If both are provided, they are merged.
+ * To copy an existing broadcast, retrieve it and pass its data as the request body — the
+Uid, SendDateTime, and message counts are automatically reset. Recipients can be
+specified using EmailListUids and SegmentUids instead of populating RecipientData
+directly. If both are provided, they are merged.
+ * @summary Create a new broadcast campaign.
  */
 export type campaignAddBroadcastEmailResponse200 = {
   data: BroadcastCampaign
@@ -152,10 +153,11 @@ export const campaignGetBroadcastEmail = async (broadcastCampaignUid: string | n
 
 
 /**
- * @summary Updates a broadcast campaign. Setting SendDateTime to a future date schedules the broadcast
-for sending and its status changes to Pending. Clearing SendDateTime unschedules the broadcast.
-Recipients can be specified using EmailListUids and SegmentUids instead of populating
-RecipientData directly. If both are provided, they are merged.
+ * Setting SendDateTime to a future date schedules the broadcast for sending and its status
+changes to Pending. Clearing SendDateTime unschedules the broadcast. Recipients can be
+specified using EmailListUids and SegmentUids instead of populating RecipientData
+directly. If both are provided, they are merged.
+ * @summary Update a broadcast campaign.
  */
 export type campaignUpdateBroadcastEmailResponse200 = {
   data: BroadcastCampaign
@@ -209,8 +211,9 @@ export const campaignUpdateBroadcastEmail = async (broadcastCampaignUid: string
 
 
 /**
- * @summary Deletes a broadcast campaign. Only campaigns in Draft or Pending status can be deleted.
-Campaigns that have been processed should be archived instead.
+ * Only campaigns in Draft or Pending status can be deleted. Campaigns that have been
+processed should be archived instead.
+ * @summary Delete a broadcast campaign.
  */
 export type campaignDeleteBroadcastCampaignResponse200 = {
   data: Blob
@@ -366,9 +369,10 @@ export const campaignArchiveBroadcastCampaign = async (broadcastCampaignUid: str
 
 
 /**
- * @summary Sends a test email for a broadcast campaign to the logged-in user and optionally to additional
-recipients. Additional recipients are specified as a list of person Uids and must belong to the
-same account as the logged-in user.
+ * Sends to the logged-in user and optionally to additional recipients. Additional
+recipients are specified as a list of person Uids and must belong to the same account
+as the logged-in user.
+ * @summary Send a test email for a broadcast campaign.
  */
 export type campaignSendTestCampaignEmailResponse200 = {
   data: Blob
@@ -467,9 +471,10 @@ export const emailListGetAllSubscriptions = async (emailListUid: string | null,
 
 
 /**
- * @summary Subscribe a person to an email list. To subscribe a new person, pass a Person object with an
-Email address. To subscribe an existing person, pass a Person object with a Uid. The
-SendWelcomeEmail property determines if the person is sent a welcome email and defaults to false.
+ * To subscribe a new person, pass a Person object with an Email address. To subscribe an
+existing person, pass a Person object with a Uid. The SendWelcomeEmail property
+determines if the person is sent a welcome email and defaults to false.
+ * @summary Subscribe a person to an email list.
  */
 export type emailListAddSubscriptionResponse200 = {
   data: EmailListPerson

package/src/generated/models/activityType.ts

@@ -1,7 +1,7 @@
 // @ts-nocheck
 
 /**
- * `10` - Custom, `50` - Note, `51` - Email, `52` - PhoneCall, `53` - Meeting, `54` - Chat, `100` - AccountCreated, `101` - AccountUpdated, `102` - AccountAddPerson, `103` - AccountStageUpdated, `104` - AccountDeleted, `105` - AccountBillingInformationUpdated, `106` - AccountSubscriptionPlanUpdated, `107` - AccountSubscriptionPaymentCollected, `108` - AccountSubscriptionPaymentDeclined, `109` - AccountBillingInformationRequested, `110` - AccountBillingInvoiceEmailSent, `111` - AccountRemovePerson, `112` - AccountPaidSubscriptionCreated, `113` - AccountBillingInformationRemoved, `114` - AccountPrimaryPersonUpdated, `115` - AccountBillingInvoiceCreated, `116` - AccountSubscriptionStarted, `117` - AccountSubscriptionRenewalExtended, `118` - AccountSubscriptionAddOnsChanged, `119` - AccountSubscriptionCancellationRequested, `120` - AccountBillingInvoiceDeleted, `200` - PersonCreated, `201` - PersonUpdated, `202` - PersonDeleted, `203` - PersonLogin, `204` - PersonListSubscribed, `205` - PersonListUnsubscribed, `206` - PersonSegmentAdded, `207` - PersonSegmentRemoved, `208` - PersonEmailOpened, `209` - PersonEmailClicked, `210` - PersonEmailBounce, `211` - PersonEmailSpam, `212` - PersonSupportTicketCreated, `213` - PersonSupportTicketUpdated, `214` - PersonLeadFormSubmitted, `215` - PersonListConfirmed, `216` - PersonEmailSubscribed, `217` - PersonEmailUnsubscribed, `218` - PersonTemporaryPasswordSet, `219` - PersonSupportTicketClosed, `300` - DealCreated, `301` - DealUpdated, `302` - DealAddPerson, `303` - DealAddAccount, `304` - DealDeleted, `305` - DealDueDate, `306` - TaskCreated, `307` - TaskUpdated, `400` - PlanCreated, `401` - PlanUpdated, `402` - AddOnCreated, `403` - AddOnUpdated, `500` - DiscordUserLinked, `501` - DiscordUserAddedToServer, `502` - DiscordUserRolesUpdated, `503` - DiscordUserRemovedFromServer, `1000` - OutsetaSuspiciousBehavior
+ * `10` - Custom, `50` - Note, `51` - Email, `52` - PhoneCall, `53` - Meeting, `54` - Chat, `100` - AccountCreated, `101` - AccountUpdated, `102` - AccountAddPerson, `103` - AccountStageUpdated, `104` - AccountDeleted, `105` - AccountBillingInformationUpdated, `106` - AccountSubscriptionPlanUpdated, `107` - AccountSubscriptionPaymentCollected, `108` - AccountSubscriptionPaymentDeclined, `109` - AccountBillingInformationRequested, `110` - AccountBillingInvoiceEmailSent, `111` - AccountRemovePerson, `112` - AccountPaidSubscriptionCreated, `113` - AccountBillingInformationRemoved, `114` - AccountPrimaryPersonUpdated, `115` - AccountBillingInvoiceCreated, `116` - AccountSubscriptionStarted, `117` - AccountSubscriptionRenewalExtended, `118` - AccountSubscriptionAddOnsChanged, `119` - AccountSubscriptionCancellationRequested, `120` - AccountBillingInvoiceDeleted, `200` - PersonCreated, `201` - PersonUpdated, `202` - PersonDeleted, `203` - PersonLogin, `204` - PersonListSubscribed, `205` - PersonListUnsubscribed, `206` - PersonSegmentAdded, `207` - PersonSegmentRemoved, `208` - PersonEmailOpened, `209` - PersonEmailClicked, `210` - PersonEmailBounce, `211` - PersonEmailSpam, `212` - PersonSupportTicketCreated, `213` - PersonSupportTicketUpdated, `214` - PersonLeadFormSubmitted, `215` - PersonListConfirmed, `216` - PersonEmailSubscribed, `217` - PersonEmailUnsubscribed, `218` - PersonTemporaryPasswordSet, `219` - PersonSupportTicketClosed, `220` - PersonTwoFactorRecoveryCodesRegenerated, `300` - DealCreated, `301` - DealUpdated, `302` - DealAddPerson, `303` - DealAddAccount, `304` - DealDeleted, `305` - DealDueDate, `306` - TaskCreated, `307` - TaskUpdated, `400` - PlanCreated, `401` - PlanUpdated, `402` - AddOnCreated, `403` - AddOnUpdated, `500` - DiscordUserLinked, `501` - DiscordUserAddedToServer, `502` - DiscordUserRolesUpdated, `503` - DiscordUserRemovedFromServer, `1000` - OutsetaSuspiciousBehavior
  */
 export type ActivityType = typeof ActivityType[keyof typeof ActivityType];
 
@@ -55,6 +55,7 @@ export const ActivityType = {
   PersonEmailUnsubscribed: 217,
   PersonTemporaryPasswordSet: 218,
   PersonSupportTicketClosed: 219,
+  PersonTwoFactorRecoveryCodesRegenerated: 220,
   DealCreated: 300,
   DealUpdated: 301,
   DealAddPerson: 302,

package/src/generated/models/articleGetAllArticlesParams.ts

@@ -2,6 +2,7 @@
 
 export type ArticleGetAllArticlesParams = {
 /**
+ * Matches on title or body of the article
  * @nullable
  */
 q?: string | null;

package/src/generated/models/crmSettingsAllOf.ts

@@ -63,4 +63,5 @@ export type CrmSettingsAllOf = {
   RegistrationConfirmationEmailDelaySeconds?: number;
   /** @nullable */
   RegistrationCallbackUrlLocations?: string | null;
+  TwoFactorAuthenticationAvailable?: boolean;
 };

package/src/generated/models/index.ts

@@ -227,6 +227,7 @@ export * from './invoiceLineItemAllOf';
 export * from './invoiceLineItemAllOfInvoice';
 export * from './invoiceLineItemAllOfLineItemType';
 export * from './invoiceStatusChangeOptions';
+export * from './invoiceUpdateInvoiceBody';
 export * from './jwtKey';
 export * from './jwtKeyAllOf';
 export * from './jwtKeyAllOfQcount';

package/src/generated/models/invoiceUpdateInvoiceBody.ts

@@ -0,0 +1,7 @@
+// @ts-nocheck
+import type { Invoice } from './invoice';
+
+/**
+ * @nullable
+ */
+export type InvoiceUpdateInvoiceBody = Invoice | null;

package/src/generated/models/paymentsGatewayActivationStatus.ts

@@ -1,7 +1,7 @@
 // @ts-nocheck
 
 /**
- * `0` - Disabled, `1` - ForteEnabled, `2` - StripeEnabled
+ * `0` - Disabled, `1` - ForteEnabled, `2` - StripeEnabled, `3` - CustomEnabled
  */
 export type PaymentsGatewayActivationStatus = typeof PaymentsGatewayActivationStatus[keyof typeof PaymentsGatewayActivationStatus];
 
@@ -11,4 +11,5 @@ export const PaymentsGatewayActivationStatus = {
   Disabled: 0,
   ForteEnabled: 1,
   StripeEnabled: 2,
+  CustomEnabled: 3,
 } as const;

package/src/generated/models/qcountConfigSettingType.ts

@@ -1,7 +1,7 @@
 // @ts-nocheck
 
 /**
- * `100` - Slack, `102` - MagicLinkApiKey, `103` - MagicLinkApiKeySecret, `104` - OAuth_HideCreateAccountLink, `105` - Chat_IsOffline, `106` - HostedPageCustomCode, `107` - RegistrationConfirmationEmailDelaySeconds, `108` - AccountCancellationReasons, `110` - WebhookSignatureKey, `111` - HostedProfileBackLink, `112` - AccountCancellationReasonRequired, `114` - Email_OutsetaBrandingDisabled, `119` - Email_BlacklistedInboundEmails, `121` - PasswordPolicy, `123` - CRM_FieldSortingEnabled, `124` - CRM_RegistrationCallbackLocations, `125` - KnowledgeBaseVersion, `126` - Support_SpamThreshold, `127` - Email_RestrictedPhrases, `128` - KnowledgeBaseLanguage, `130` - Billing_System, `131` - Billing_RestrictSubscriptionActions, `190` - Stripe_TaxEnabled, `192` - Stripe_TaxIdTypes, `193` - Stripe_ApplePayMerchantIdDomainAssociation, `194` - Stripe_WebhookSecret, `200` - Webflow_AccessToken, `201` - Webflow_SyncEnabled, `202` - Webflow_SyncConfiguration, `203` - Webflow_ApiVersion, `550` - CopyQcount_AddOnMap, `551` - CopyQcount_AccountMap, `552` - CopyQcount_DiscountCouponMap, `553` - CopyQcount_InvoiceMap, `554` - CopyQcount_PersonMap, `555` - CopyQcount_PlanMap, `556` - CopyQcount_PlanFamilyMap, `557` - CopyQcount_SubscriptionMap, `558` - CopyQcount_TransactionMap, `570` - StripeMigration_LastAccountId, `571` - StripeMigration_LastInvoiceId, `572` - StripeMigration_LastExpiredSubscriptionId, `573` - StripeMigration_LastPostExportSubscriptionId, `574` - StripeMigration_LastUsageId, `575` - StripeMigration_SubscriptionExportDate, `576` - StripeMigration_SubscriptionExportIds, `577` - StripeMigration_SubscriptionAddOnExportIds, `578` - StripeMigration_SubscriptionCutoverDate, `579` - StripeMigration_LastPreCutoverExportSubscriptionId
+ * `100` - Slack, `102` - MagicLinkApiKey, `103` - MagicLinkApiKeySecret, `104` - OAuth_HideCreateAccountLink, `105` - Chat_IsOffline, `106` - HostedPageCustomCode, `107` - RegistrationConfirmationEmailDelaySeconds, `108` - AccountCancellationReasons, `110` - WebhookSignatureKey, `111` - HostedProfileBackLink, `112` - AccountCancellationReasonRequired, `114` - Email_OutsetaBrandingDisabled, `119` - Email_BlacklistedInboundEmails, `121` - PasswordPolicy, `123` - CRM_FieldSortingEnabled, `124` - CRM_RegistrationCallbackLocations, `125` - KnowledgeBaseVersion, `126` - Support_SpamThreshold, `127` - Email_RestrictedPhrases, `128` - KnowledgeBaseLanguage, `130` - Billing_System, `131` - Billing_RestrictSubscriptionActions, `140` - TwoFactorAuthenticationEnabled, `142` - ForceTwoFactorAuthentication, `190` - Stripe_TaxEnabled, `192` - Stripe_TaxIdTypes, `193` - Stripe_ApplePayMerchantIdDomainAssociation, `194` - Stripe_WebhookSecret, `200` - Webflow_AccessToken, `201` - Webflow_SyncEnabled, `202` - Webflow_SyncConfiguration, `203` - Webflow_ApiVersion, `550` - CopyQcount_AddOnMap, `551` - CopyQcount_AccountMap, `552` - CopyQcount_DiscountCouponMap, `553` - CopyQcount_InvoiceMap, `554` - CopyQcount_PersonMap, `555` - CopyQcount_PlanMap, `556` - CopyQcount_PlanFamilyMap, `557` - CopyQcount_SubscriptionMap, `558` - CopyQcount_TransactionMap, `570` - StripeMigration_LastAccountId, `571` - StripeMigration_LastInvoiceId, `572` - StripeMigration_LastExpiredSubscriptionId, `573` - StripeMigration_LastPostExportSubscriptionId, `574` - StripeMigration_LastUsageId, `575` - StripeMigration_SubscriptionExportDate, `576` - StripeMigration_SubscriptionExportIds, `577` - StripeMigration_SubscriptionAddOnExportIds, `578` - StripeMigration_SubscriptionCutoverDate, `579` - StripeMigration_LastPreCutoverExportSubscriptionId
  */
 export type QcountConfigSettingType = typeof QcountConfigSettingType[keyof typeof QcountConfigSettingType];
 
@@ -30,6 +30,8 @@ export const QcountConfigSettingType = {
   KnowledgeBaseLanguage: 128,
   Billing_System: 130,
   Billing_RestrictSubscriptionActions: 131,
+  TwoFactorAuthenticationEnabled: 140,
+  ForceTwoFactorAuthentication: 142,
   Stripe_TaxEnabled: 190,
   Stripe_TaxIdTypes: 192,
   Stripe_ApplePayMerchantIdDomainAssociation: 193,

package/src/generated/models/setupIntent.ts

@@ -28,6 +28,7 @@ export interface SetupIntent {
   PaymentToken?: string | null;
   /** @nullable */
   PlanUid?: string | null;
+  SetupFutureUsage?: boolean;
   /** @nullable */
   ToltReferralId?: string | null;
 }

package/src/generated/support/support.ts

@@ -13,9 +13,9 @@ import type {
 import { customFetch } from '../../client';
 
 /**
- * @summary Returns all cases, optionally filtered by search string, tag, and/or assignment.
-Assigned cases can be filtered by passing in the AssignedToPersonClientIdentifier,
+ * Assigned cases can be filtered by passing in the AssignedToPersonClientIdentifier,
 which is the Uid of the person the case is assigned to.
+ * @summary Returns all cases, optionally filtered by search string, tag, and/or assignment.
  */
 export type caseGetAllCasesResponse200 = {
   data: Case[]
@@ -278,8 +278,7 @@ export const caseAddClientResponse = async (caseUid: string | null,
 
 
 /**
- * @summary Retrieves all knowledge base articles.
-Matches on title or body of the article"
+ * @summary Retrieve all knowledge base articles.
  */
 export type articleGetAllArticlesResponse200 = {
   data: Article[]