@outseta/react 0.5.3 → 0.5.5

package/dist/index.js

@@ -4834,6 +4834,7 @@ var QcountConfigSettingType = {
   MagicLinkLoginEnabled: 143,
   Support_DeleteClosedTicketsAfterMonths: 148,
   SingleSessionLogin: 149,
+  CRM_PasswordChangedEmailDisabled: 152,
   GoogleAnalyticsMeasurementId: 170,
   GoogleAnalyticsApiSecret: 171,
   Stripe_TaxEnabled: 190,
@@ -4928,6 +4929,7 @@ var ActivityType = {
   PlanUpdated: 401,
   AddOnCreated: 402,
   AddOnUpdated: 403,
+  TransactionalEmailSettingUpdated: 404,
   DiscordUserLinked: 500,
   DiscordUserAddedToServer: 501,
   DiscordUserRolesUpdated: 502,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@outseta/react",
-  "version": "0.5.3",
+  "version": "0.5.5",
   "description": "React hooks and components for the Outseta API",
   "license": "MIT",
   "repository": {
@@ -18,7 +18,7 @@
     }
   },
   "dependencies": {
-    "@outseta/api-client": "0.4.3"
+    "@outseta/api-client": "0.4.5"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0"

package/src/generated/crm/crm.ts

@@ -1583,7 +1583,8 @@ export const useAccountExtendRenewal = <TError = void,
     /**
  * 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.
+primary contact. The email is sent even when the Registration confirmation email is
+turned off under Email > Transactional emails.
  * @summary Send a confirmation email to people on an account.
  */
 export const accountSendConfirmationEmail = (

package/src/generated/outsetaAPI.schemas.ts

@@ -1820,6 +1820,8 @@ export type StripeInvoiceLineItemAllOf = {
    * @nullable
    */
   Currency?: string | null;
+  /** @nullable */
+  Description?: string | null;
   PeriodStart?: string;
   PeriodEnd?: string;
   /** @nullable */
@@ -1830,6 +1832,11 @@ export type StripeInvoiceLineItemAllOf = {
   StripePrice?: StripeInvoiceLineItemAllOfStripePrice;
   /** @nullable */
   EndDate?: string | null;
+  /**
+   * @maxLength 20
+   * @nullable
+   */
+  LineType?: string | null;
   /** @nullable */
   CurrencyAmount?: number | null;
   /** @nullable */
@@ -3497,7 +3504,7 @@ export type QcountConfigAllOf = {
 export type QcountConfig = AbstractQcountBean & QcountConfigAllOf;
 
 /**
- * `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, `143` - MagicLinkLoginEnabled, `148` - Support_DeleteClosedTicketsAfterMonths, `149` - SingleSessionLogin, `170` - GoogleAnalyticsMeasurementId, `171` - GoogleAnalyticsApiSecret, `190` - Stripe_TaxEnabled, `192` - Stripe_TaxIdTypes, `193` - Stripe_ApplePayMerchantIdDomainAssociation, `194` - Stripe_WebhookSecret, `195` - Stripe_OnlySyncOutsetaCustomers, `196` - Stripe_Checkout_RequireBillingAddress, `197` - Stripe_Checkout_RequireConsentTermsOfService, `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, `143` - MagicLinkLoginEnabled, `148` - Support_DeleteClosedTicketsAfterMonths, `149` - SingleSessionLogin, `152` - CRM_PasswordChangedEmailDisabled, `170` - GoogleAnalyticsMeasurementId, `171` - GoogleAnalyticsApiSecret, `190` - Stripe_TaxEnabled, `192` - Stripe_TaxIdTypes, `193` - Stripe_ApplePayMerchantIdDomainAssociation, `194` - Stripe_WebhookSecret, `195` - Stripe_OnlySyncOutsetaCustomers, `196` - Stripe_Checkout_RequireBillingAddress, `197` - Stripe_Checkout_RequireConsentTermsOfService, `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];
 
@@ -3531,6 +3538,7 @@ export const QcountConfigSettingType = {
   MagicLinkLoginEnabled: 143,
   Support_DeleteClosedTicketsAfterMonths: 148,
   SingleSessionLogin: 149,
+  CRM_PasswordChangedEmailDisabled: 152,
   GoogleAnalyticsMeasurementId: 170,
   GoogleAnalyticsApiSecret: 171,
   Stripe_TaxEnabled: 190,
@@ -3682,7 +3690,7 @@ export interface SlackChannelSetting {
 }
 
 /**
- * `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, `121` - AccountPersonRoleUpdated, `122` - AccountProductsChanged, `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, `304` - DealDeleted, `305` - DealDueDate, `306` - TaskCreated, `307` - TaskUpdated, `400` - PlanCreated, `401` - PlanUpdated, `402` - AddOnCreated, `403` - AddOnUpdated, `500` - DiscordUserLinked, `501` - DiscordUserAddedToServer, `502` - DiscordUserRolesUpdated, `503` - DiscordUserRemovedFromServer
+ * `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, `121` - AccountPersonRoleUpdated, `122` - AccountProductsChanged, `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, `304` - DealDeleted, `305` - DealDueDate, `306` - TaskCreated, `307` - TaskUpdated, `400` - PlanCreated, `401` - PlanUpdated, `402` - AddOnCreated, `403` - AddOnUpdated, `404` - TransactionalEmailSettingUpdated, `500` - DiscordUserLinked, `501` - DiscordUserAddedToServer, `502` - DiscordUserRolesUpdated, `503` - DiscordUserRemovedFromServer
  */
 export type ActivityType = typeof ActivityType[keyof typeof ActivityType];
 
@@ -3749,6 +3757,7 @@ export const ActivityType = {
   PlanUpdated: 401,
   AddOnCreated: 402,
   AddOnUpdated: 403,
+  TransactionalEmailSettingUpdated: 404,
   DiscordUserLinked: 500,
   DiscordUserAddedToServer: 501,
   DiscordUserRolesUpdated: 502,
@@ -3847,6 +3856,29 @@ export type TemplateEmailInstanceAllOf = {
 
 export type TemplateEmailInstance = AbstractQcountBean & TemplateEmailInstanceAllOf;
 
+export interface TransactionalEmailSetting {
+  /** @nullable */
+  Key?: string | null;
+  /** @nullable */
+  Name?: string | null;
+  /** @nullable */
+  SentWhen?: string | null;
+  /** @nullable */
+  TemplateSystemNames?: string[] | null;
+  IsEnabled?: boolean;
+}
+
+export interface TransactionalEmailSettingUpdateRequest {
+  /** @nullable */
+  Settings?: TransactionalEmailSettingUpdate[] | null;
+}
+
+export interface TransactionalEmailSettingUpdate {
+  /** @nullable */
+  Key?: string | null;
+  IsEnabled?: boolean;
+}
+
 /**
  * The fields of an email template that an update may change. Every field is optional:
 a field left out keeps its current value.
@@ -5093,6 +5125,9 @@ export interface ExtendSubscriptionOptions {
 export type BillSettingsAllOf = {
   DaysPastDueToSetAccountToCanceling?: number;
   IsInvoicePaymentEmailDisabled: boolean;
+  IsInvoiceReminderEmailDisabled: boolean;
+  IsPaymentProblemEmailDisabled: boolean;
+  IsPaymentInfoUpdatedEmailDisabled: boolean;
   PaymentsMode?: PaymentsMode;
   BillingSystem?: BillingSystem;
   RestrictSubscriptionActions?: boolean;
@@ -9891,6 +9926,32 @@ export type TemplateGetAllTemplateEmails200 = {
   items?: TemplateEmailInstance[];
 };
 
+export type TemplateGetTransactionalEmailSettingsParams = {
+/**
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
+ */
+limit?: LimitParameter;
+/**
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
+ */
+offset?: OffsetParameter;
+};
+
+export type TemplateGetTransactionalEmailSettings200 = {
+  metadata?: CollectionMetadata;
+  items?: TransactionalEmailSetting[];
+};
+
+/**
+ * @nullable
+ */
+export type TemplateUpdateTransactionalEmailSettingsBody = TransactionalEmailSettingUpdateRequest | null;
+
+export type TemplateUpdateTransactionalEmailSettings200 = {
+  metadata?: CollectionMetadata;
+  items?: TransactionalEmailSetting[];
+};
+
 export type TemplateGetTemplateEmailsParams = {
 /**
  * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.

package/src/generated/template/template.ts

@@ -22,7 +22,11 @@ import type {
   TemplateGetAllTemplatesParams,
   TemplateGetTemplateEmails200,
   TemplateGetTemplateEmailsParams,
+  TemplateGetTransactionalEmailSettings200,
+  TemplateGetTransactionalEmailSettingsParams,
   TemplateSendTemplateEmailBody,
+  TemplateUpdateTransactionalEmailSettings200,
+  TemplateUpdateTransactionalEmailSettingsBody,
   UpdateTemplateRequest
 } from '../outsetaAPI.schemas';
 
@@ -190,6 +194,144 @@ export function useTemplateGetAllTemplateEmails<TData = Awaited<ReturnType<typeo
 
 
 /**
+ * Each setting names the email templates it covers. A setting that is off stops the
+automatic email only; an email sent by hand, such as the send invoice button, is
+still sent.
+ * @summary The on/off settings for the transactional emails that Outseta sends to your customers.
+ */
+export const templateGetTransactionalEmailSettings = (
+    params?: TemplateGetTransactionalEmailSettingsParams,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<TemplateGetTransactionalEmailSettings200>(
+      {url: `/api/v1/templates/transactional-email-settings`, method: 'GET',
+        params, signal
+    },
+      options);
+    }
+  
+
+
+
+export const getTemplateGetTransactionalEmailSettingsQueryKey = (params?: TemplateGetTransactionalEmailSettingsParams,) => {
+    return [
+    `/api/v1/templates/transactional-email-settings`, ...(params ? [params]: [])
+    ] as const;
+    }
+
+    
+export const getTemplateGetTransactionalEmailSettingsQueryOptions = <TData = Awaited<ReturnType<typeof templateGetTransactionalEmailSettings>>, TError = void>(params?: TemplateGetTransactionalEmailSettingsParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof templateGetTransactionalEmailSettings>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getTemplateGetTransactionalEmailSettingsQueryKey(params);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof templateGetTransactionalEmailSettings>>> = ({ signal }) => templateGetTransactionalEmailSettings(params, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof templateGetTransactionalEmailSettings>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type TemplateGetTransactionalEmailSettingsQueryResult = NonNullable<Awaited<ReturnType<typeof templateGetTransactionalEmailSettings>>>
+export type TemplateGetTransactionalEmailSettingsQueryError = void
+
+
+/**
+ * @summary The on/off settings for the transactional emails that Outseta sends to your customers.
+ */
+
+export function useTemplateGetTransactionalEmailSettings<TData = Awaited<ReturnType<typeof templateGetTransactionalEmailSettings>>, TError = void>(
+ params?: TemplateGetTransactionalEmailSettingsParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof templateGetTransactionalEmailSettings>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+  
+ ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } {
+
+  const queryOptions = getTemplateGetTransactionalEmailSettingsQueryOptions(params,options)
+
+  const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
+
+/**
+ * Send an object with a Settings list. Each item has Key and IsEnabled. A setting that
+is not in the list keeps its state. Each change is recorded in the activity log.
+Returns all settings.
+ * @summary Turns transactional emails on or off.
+ */
+export const templateUpdateTransactionalEmailSettings = (
+    templateUpdateTransactionalEmailSettingsBody: TemplateUpdateTransactionalEmailSettingsBody,
+ options?: SecondParameter<typeof customFetch>,) => {
+      
+      
+      return customFetch<TemplateUpdateTransactionalEmailSettings200>(
+      {url: `/api/v1/templates/transactional-email-settings`, method: 'PUT',
+      headers: {'Content-Type': 'application/json', },
+      data: templateUpdateTransactionalEmailSettingsBody
+    },
+      options);
+    }
+  
+
+
+export const getTemplateUpdateTransactionalEmailSettingsMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof templateUpdateTransactionalEmailSettings>>, TError,{data: TemplateUpdateTransactionalEmailSettingsBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof templateUpdateTransactionalEmailSettings>>, TError,{data: TemplateUpdateTransactionalEmailSettingsBody}, TContext> => {
+
+const mutationKey = ['templateUpdateTransactionalEmailSettings'];
+const {mutation: mutationOptions, request: requestOptions} = options ?
+      options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ?
+      options
+      : {...options, mutation: {...options.mutation, mutationKey}}
+      : {mutation: { mutationKey, }, request: undefined};
+
+      
+
+
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof templateUpdateTransactionalEmailSettings>>, {data: TemplateUpdateTransactionalEmailSettingsBody}> = (props) => {
+          const {data} = props ?? {};
+
+          return  templateUpdateTransactionalEmailSettings(data,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type TemplateUpdateTransactionalEmailSettingsMutationResult = NonNullable<Awaited<ReturnType<typeof templateUpdateTransactionalEmailSettings>>>
+    export type TemplateUpdateTransactionalEmailSettingsMutationBody = TemplateUpdateTransactionalEmailSettingsBody
+    export type TemplateUpdateTransactionalEmailSettingsMutationError = void
+
+    /**
+ * @summary Turns transactional emails on or off.
+ */
+export const useTemplateUpdateTransactionalEmailSettings = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof templateUpdateTransactionalEmailSettings>>, TError,{data: TemplateUpdateTransactionalEmailSettingsBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof templateUpdateTransactionalEmailSettings>>,
+        TError,
+        {data: TemplateUpdateTransactionalEmailSettingsBody},
+        TContext
+      > => {
+
+      const mutationOptions = getTemplateUpdateTransactionalEmailSettingsMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
  * Add personUid to the query string to see what one person was sent from this
 template.
  * @summary The one-off emails that were sent from this email template.