@outseta/react 0.4.25 → 0.4.27

package/package.json

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

package/src/generated/crm/crm.ts

@@ -35,6 +35,7 @@ import type {
   PersonForgotPasswordBody,
   PersonGetAllPeople200,
   PersonGetAllPeopleParams,
+  PersonRequestMagicLinkBody,
   PersonSetTemporaryPasswordBody,
   PersonUpdatePersonBody
 } from '../outsetaAPI.schemas';
@@ -1795,4 +1796,73 @@ export const usePersonForgotPassword = <TError = void,
 
       return useMutation(mutationOptions);
     }
+    /**
+ * Sends an email containing a single-use, time-limited link that signs
+the recipient in without a password. Always responds 200 regardless
+of whether the email matches a known user or whether the feature is
+enabled, so the endpoint cannot be used to enumerate accounts.
+ * @summary Request a passwordless magic link to sign in.
+ */
+export const personRequestMagicLink = (
+    personRequestMagicLinkBody: NonReadonly<PersonRequestMagicLinkBody>,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<Blob>(
+      {url: `/api/v1/crm/people/requestMagicLink`, method: 'POST',
+      headers: {'Content-Type': 'application/json', },
+      data: personRequestMagicLinkBody,
+        responseType: 'blob', signal
+    },
+      options);
+    }
+  
+
+
+export const getPersonRequestMagicLinkMutationOptions = <TError = unknown,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof personRequestMagicLink>>, TError,{data: NonReadonly<PersonRequestMagicLinkBody>}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof personRequestMagicLink>>, TError,{data: NonReadonly<PersonRequestMagicLinkBody>}, TContext> => {
+
+const mutationKey = ['personRequestMagicLink'];
+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 personRequestMagicLink>>, {data: NonReadonly<PersonRequestMagicLinkBody>}> = (props) => {
+          const {data} = props ?? {};
+
+          return  personRequestMagicLink(data,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type PersonRequestMagicLinkMutationResult = NonNullable<Awaited<ReturnType<typeof personRequestMagicLink>>>
+    export type PersonRequestMagicLinkMutationBody = NonReadonly<PersonRequestMagicLinkBody>
+    export type PersonRequestMagicLinkMutationError = unknown
+
+    /**
+ * @summary Request a passwordless magic link to sign in.
+ */
+export const usePersonRequestMagicLink = <TError = unknown,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof personRequestMagicLink>>, TError,{data: NonReadonly<PersonRequestMagicLinkBody>}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof personRequestMagicLink>>,
+        TError,
+        {data: NonReadonly<PersonRequestMagicLinkBody>},
+        TContext
+      > => {
+
+      const mutationOptions = getPersonRequestMagicLinkMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
     

package/src/generated/outsetaAPI.schemas.ts

@@ -3432,7 +3432,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, `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, `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];
 
@@ -3463,6 +3463,7 @@ export const QcountConfigSettingType = {
   Billing_RestrictSubscriptionActions: 131,
   TwoFactorAuthenticationEnabled: 140,
   ForceTwoFactorAuthentication: 142,
+  MagicLinkLoginEnabled: 143,
   Stripe_TaxEnabled: 190,
   Stripe_TaxIdTypes: 192,
   Stripe_ApplePayMerchantIdDomainAssociation: 193,
@@ -4381,7 +4382,7 @@ export interface FlatfileImportData {
 }
 
 /**
- * `1` - UpdateSegmentBackGroundTask, `2` - ImportPeopleTask, `3` - ImportAccountTask, `4` - ImportDealTask, `5` - ImportEmailList, `6` - RescheduleDripCampaignTask, `7` - DeleteSegmentPeopleTask, `8` - StartDripCampaignTask, `9` - WebflowSyncTask, `10` - UpdatePersonSegmentsTask, `11` - ImportDiscountCouponTask, `12` - RemoveDiscordUserFromAllServersTask, `13` - SendInvoiceEmailTask, `14` - UpdateDiscordUserRolesTask, `15` - StripeBillingSyncTask, `16` - UpdateStripeDefaultSourceTask, `17` - DeleteScheduledCampaignMessagesTask, `18` - SendSpamCheckEmailTask, `19` - UpdateDiscordMemberRolesTask, `20` - SendInvoicePaidEmailTask, `21` - ResendTrialLimitEmailTask
+ * `1` - UpdateSegmentBackGroundTask, `2` - ImportPeopleTask, `3` - ImportAccountTask, `4` - ImportDealTask, `5` - ImportEmailList, `6` - RescheduleDripCampaignTask, `7` - DeleteSegmentPeopleTask, `8` - StartDripCampaignTask, `9` - WebflowSyncTask, `10` - UpdatePersonSegmentsTask, `11` - ImportDiscountCouponTask, `12` - RemoveDiscordUserFromAllServersTask, `13` - SendInvoiceEmailTask, `14` - UpdateDiscordUserRolesTask, `15` - StripeBillingSyncTask, `16` - UpdateStripeDefaultSourceTask, `17` - DeleteScheduledCampaignMessagesTask, `18` - SendSpamCheckEmailTask, `19` - UpdateDiscordMemberRolesTask, `20` - SendInvoicePaidEmailTask, `21` - ResendTrialLimitEmailTask, `22` - UpdateStripeSubscriptionApplicationFeePercentTask
  */
 export type BackGroundTaskType = typeof BackGroundTaskType[keyof typeof BackGroundTaskType];
 
@@ -4409,6 +4410,7 @@ export const BackGroundTaskType = {
   UpdateDiscordMemberRolesTask: 19,
   SendInvoicePaidEmailTask: 20,
   ResendTrialLimitEmailTask: 21,
+  UpdateStripeSubscriptionApplicationFeePercentTask: 22,
 } as const;
 
 /**
@@ -9134,6 +9136,13 @@ export type AuthGetTokenParams = {
 data: unknown | null;
 };
 
+export type AuthMagicLinkTokenParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};
+
 export type AuthResendTwoFactorParams = {
 /**
  * @nullable
@@ -9562,6 +9571,11 @@ export type PersonSetTemporaryPasswordBody = TemporaryPasswordModel | null;
  */
 export type PersonForgotPasswordBody = Person | null;
 
+/**
+ * @nullable
+ */
+export type PersonRequestMagicLinkBody = Person | null;
+
 export type DiscountCouponGetDiscountCouponByCodeParams = {
 /**
  * The unique identifier of the plan to validate the coupon against

package/src/generated/public/public.ts

@@ -10,6 +10,7 @@ import type {
 
 import type {
   AuthGetTokenParams,
+  AuthMagicLinkTokenParams,
   AuthResendTwoFactorParams,
   AuthSwitchTwoFactorMechanismParams,
   AuthVerifyTwoFactorRecoveryParams,
@@ -228,6 +229,85 @@ export const useAuthGetToken = <TError = string,
       return useMutation(mutationOptions);
     }
     /**
+ * Call this with the magicToken carried by the link from a
+"magic link" email (requested via POST /api/v1/crm/people/requestMagicLink):
+            
+    { "magic_token": "eyJ..." }
+            
+The link proves control of the email inbox, which satisfies the first
+factor. The response then matches POST /api/v1/tokens:
+            
+ - 200 with an access token when no further factor is required;
+ - 202 with a two_factor_required challenge when the user
+   has a non-email second factor (e.g. an authenticator app) that must
+   still be cleared via POST /api/v1/tokens/two-factor. Email is
+   never offered as that second factor — it was already the first.
+            
+An invalid, expired, already-used token (or a tenant without magic-link
+login enabled) returns 400 (invalid_grant).
+ * @summary Exchange a magic-link token for an access token (passwordless login).
+ */
+export const authMagicLinkToken = (
+    params: AuthMagicLinkTokenParams,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<TokenPayload | TwoFactorChallengePayload>(
+      {url: `/api/v1/tokens/magic-link`, method: 'POST',
+        params, signal
+    },
+      options);
+    }
+  
+
+
+export const getAuthMagicLinkTokenMutationOptions = <TError = string,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof authMagicLinkToken>>, TError,{params: AuthMagicLinkTokenParams}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof authMagicLinkToken>>, TError,{params: AuthMagicLinkTokenParams}, TContext> => {
+
+const mutationKey = ['authMagicLinkToken'];
+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 authMagicLinkToken>>, {params: AuthMagicLinkTokenParams}> = (props) => {
+          const {params} = props ?? {};
+
+          return  authMagicLinkToken(params,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type AuthMagicLinkTokenMutationResult = NonNullable<Awaited<ReturnType<typeof authMagicLinkToken>>>
+    
+    export type AuthMagicLinkTokenMutationError = string
+
+    /**
+ * @summary Exchange a magic-link token for an access token (passwordless login).
+ */
+export const useAuthMagicLinkToken = <TError = string,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof authMagicLinkToken>>, TError,{params: AuthMagicLinkTokenParams}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof authMagicLinkToken>>,
+        TError,
+        {params: AuthMagicLinkTokenParams},
+        TContext
+      > => {
+
+      const mutationOptions = getAuthMagicLinkTokenMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
  * Call this after `POST /api/v1/tokens` returns `two_factor_required`.
 Post the challenge token from that response together with the user's
 one-time code (the emailed code, or the current code from their