@outseta/react 0.3.2 → 0.3.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@outseta/react",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "React hooks and components for the Outseta API",
   "license": "MIT",
   "repository": {
@@ -19,7 +19,7 @@
   },
   "dependencies": {
     "@tanstack/react-query": "^5.0.0",
-    "@outseta/api-client": "0.3.2"
+    "@outseta/api-client": "0.3.4"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0"

package/src/generated/outsetaAPI.schemas.ts

@@ -2642,6 +2642,8 @@ export interface TokenPayload {
   /** @nullable */
   id_token?: string | null;
   /** @nullable */
+  refresh_token?: string | null;
+  /** @nullable */
   token_type?: string | null;
 }
 
@@ -2713,6 +2715,30 @@ as a fallback if they cannot produce a primary code.
   recovery_codes_available?: boolean | null;
 }
 
+/**
+ * Request body for POST /api/v1/tokens/two-factor: the challenge token
+from the login response plus the user's one-time code. Property names are
+snake_case to match the wire format of the token endpoints.
+            
+The action binds the body as a loose JObject at runtime; this type
+exists so the API docs describe the body instead of an opaque data
+parameter (see [OpenApiRequestBody] on the action).
+ */
+export interface TwoFactorVerifyRequest {
+  /**
+   * The challenge_token returned by POST /api/v1/tokens when
+two-factor authentication is required. Echo it back verbatim.
+   * @nullable
+   */
+  challenge_token?: string | null;
+  /**
+   * The user's one-time code: the emailed code for an Email challenge,
+or the current code from their authenticator app for a Totp challenge.
+   * @nullable
+   */
+  code?: string | null;
+}
+
 export interface PasswordPayload {
   /** @nullable */
   Password?: string | null;
@@ -3593,6 +3619,8 @@ export type SendGridDomainAuthenticationAllOf = {
   LastValidationAttempt?: string | null;
   /** @nullable */
   DnsEntries?: DnsEntry[] | null;
+  /** @nullable */
+  LegacyDnsEntries?: DnsEntry[] | null;
 };
 
 export type SendGridDomainAuthentication = AbstractQcountBean & SendGridDomainAuthenticationAllOf;
@@ -5836,13 +5864,6 @@ export type AuthGetTokenParams = {
 data: unknown | null;
 };
 
-export type AuthVerifyTwoFactorTokenParams = {
-/**
- * @nullable
- */
-data: unknown | null;
-};
-
 export type AuthResendTwoFactorParams = {
 /**
  * @nullable

package/src/generated/public/public.ts

@@ -13,7 +13,6 @@ import type {
   AuthResendTwoFactorParams,
   AuthSwitchTwoFactorMechanismParams,
   AuthVerifyTwoFactorRecoveryParams,
-  AuthVerifyTwoFactorTokenParams,
   TokenPayload,
   TokenTwoFactorEnrollmentBeginEmailParams,
   TokenTwoFactorEnrollmentBeginTotpParams,
@@ -21,7 +20,8 @@ import type {
   TokenTwoFactorEnrollmentConfirmTotpParams,
   TwoFactorChallengePayload,
   TwoFactorEnrollmentConfirmationPayload,
-  TwoFactorTotpEnrollmentPayload
+  TwoFactorTotpEnrollmentPayload,
+  TwoFactorVerifyRequest
 } from '../outsetaAPI.schemas';
 
 import { customFetch } from '../../mutator';
@@ -36,9 +36,9 @@ type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
             
     { "username": "user@example.com", "password": "their-password" }
             
-On success the response is `200` with an access token:
+On success the response is `200` with an access token and refresh token:
             
-    { "access_token": "eyJ...", "token_type": "Bearer", "expires_in": 31536000 }
+    { "access_token": "eyJ...", "refresh_token": "...", "token_type": "Bearer", "expires_in": 31536000 }
             
 **Two-factor authentication.** If the user has a verified 2FA method,
 the password alone is not enough. After verifying the password this
@@ -140,23 +140,24 @@ authenticator app):
 On success the response is `200` with the final access token, in the
 same shape as `POST /api/v1/tokens`:
             
-    { "access_token": "eyJ...", "token_type": "Bearer", "expires_in": 31536000 }
+    { "access_token": "eyJ...", "refresh_token": "...", "token_type": "Bearer", "expires_in": 31536000 }
             
 An incorrect code returns `400` (`invalid_grant`). A code has at most
 five attempts before the challenge locks. An expired challenge returns
 `410` (`challenge_expired`) — restart at `POST /api/v1/tokens`. The
 endpoint is rate limited to 10 requests per minute (`429`).
- * @summary Complete a two-factor login challenge and obtain a JWT access token.
+ * @summary Complete login when user has two-factor authentication enabled.
  */
 export const authVerifyTwoFactorToken = (
-    params: AuthVerifyTwoFactorTokenParams,
+    twoFactorVerifyRequest: TwoFactorVerifyRequest,
  options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
 ) => {
       
       
       return customFetch<TokenPayload>(
       {url: `/api/v1/tokens/two-factor`, method: 'POST',
-        params, signal
+      headers: {'Content-Type': 'application/json', },
+      data: twoFactorVerifyRequest, signal
     },
       options);
     }
@@ -164,8 +165,8 @@ export const authVerifyTwoFactorToken = (
 
 
 export const getAuthVerifyTwoFactorTokenMutationOptions = <TError = string,
-    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof authVerifyTwoFactorToken>>, TError,{params: AuthVerifyTwoFactorTokenParams}, TContext>, request?: SecondParameter<typeof customFetch>}
-): UseMutationOptions<Awaited<ReturnType<typeof authVerifyTwoFactorToken>>, TError,{params: AuthVerifyTwoFactorTokenParams}, TContext> => {
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof authVerifyTwoFactorToken>>, TError,{data: TwoFactorVerifyRequest}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof authVerifyTwoFactorToken>>, TError,{data: TwoFactorVerifyRequest}, TContext> => {
 
 const mutationKey = ['authVerifyTwoFactorToken'];
 const {mutation: mutationOptions, request: requestOptions} = options ?
@@ -177,10 +178,10 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
       
 
 
-      const mutationFn: MutationFunction<Awaited<ReturnType<typeof authVerifyTwoFactorToken>>, {params: AuthVerifyTwoFactorTokenParams}> = (props) => {
-          const {params} = props ?? {};
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof authVerifyTwoFactorToken>>, {data: TwoFactorVerifyRequest}> = (props) => {
+          const {data} = props ?? {};
 
-          return  authVerifyTwoFactorToken(params,requestOptions)
+          return  authVerifyTwoFactorToken(data,requestOptions)
         }
 
         
@@ -189,18 +190,18 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
   return  { mutationFn, ...mutationOptions }}
 
     export type AuthVerifyTwoFactorTokenMutationResult = NonNullable<Awaited<ReturnType<typeof authVerifyTwoFactorToken>>>
-    
+    export type AuthVerifyTwoFactorTokenMutationBody = TwoFactorVerifyRequest
     export type AuthVerifyTwoFactorTokenMutationError = string
 
     /**
- * @summary Complete a two-factor login challenge and obtain a JWT access token.
+ * @summary Complete login when user has two-factor authentication enabled.
  */
 export const useAuthVerifyTwoFactorToken = <TError = string,
-    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof authVerifyTwoFactorToken>>, TError,{params: AuthVerifyTwoFactorTokenParams}, TContext>, request?: SecondParameter<typeof customFetch>}
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof authVerifyTwoFactorToken>>, TError,{data: TwoFactorVerifyRequest}, TContext>, request?: SecondParameter<typeof customFetch>}
  ): UseMutationResult<
         Awaited<ReturnType<typeof authVerifyTwoFactorToken>>,
         TError,
-        {params: AuthVerifyTwoFactorTokenParams},
+        {data: TwoFactorVerifyRequest},
         TContext
       > => {
 
@@ -374,8 +375,7 @@ requests per minute (`429`).
             
 Used by the embed login widget; the hosted Razor flow has its own
 equivalent action on the AuthenticationController.
- * @summary Complete a two-factor login challenge with a recovery code instead of
-the primary one-time code, and obtain a JWT access token.
+ * @summary Complete login with a two-factor recovery code.
  */
 export const authVerifyTwoFactorRecovery = (
     params: AuthVerifyTwoFactorRecoveryParams,
@@ -422,8 +422,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
     export type AuthVerifyTwoFactorRecoveryMutationError = string
 
     /**
- * @summary Complete a two-factor login challenge with a recovery code instead of
-the primary one-time code, and obtain a JWT access token.
+ * @summary Complete login with a two-factor recovery code.
  */
 export const useAuthVerifyTwoFactorRecovery = <TError = string,
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof authVerifyTwoFactorRecovery>>, TError,{params: AuthVerifyTwoFactorRecoveryParams}, TContext>, request?: SecondParameter<typeof customFetch>}