@outseta/react 0.3.0 → 0.3.2

package/src/generated/email/email.ts

@@ -25,6 +25,33 @@ import type {
 
 import { customFetch } from '../../mutator';
 
+// https://stackoverflow.com/questions/49579094/typescript-conditional-types-filter-out-readonly-properties-pick-only-requir/49579497#49579497
+type IfEquals<X, Y, A = X, B = never> = (<T>() => T extends X ? 1 : 2) extends <
+T,
+>() => T extends Y ? 1 : 2
+? A
+: B;
+
+type WritableKeys<T> = {
+[P in keyof T]-?: IfEquals<
+  { [Q in P]: T[P] },
+  { -readonly [Q in P]: T[P] },
+  P
+>;
+}[keyof T];
+
+type UnionToIntersection<U> =
+  (U extends any ? (k: U)=>void : never) extends ((k: infer I)=>void) ? I : never;
+type DistributeReadOnlyOverUnions<T> = T extends any ? NonReadonly<T> : never;
+
+type Writable<T> = Pick<T, WritableKeys<T>>;
+type NonReadonly<T> = [T] extends [UnionToIntersection<T>] ? {
+  [P in keyof Writable<T>]: T[P] extends object
+    ? NonReadonly<NonNullable<T[P]>>
+    : T[P];
+} : DistributeReadOnlyOverUnions<T>;
+
+
 
 type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
@@ -106,7 +133,7 @@ directly. If both are provided, they are merged.
  * @summary Create a new broadcast campaign.
  */
 export const campaignAddBroadcastEmail = (
-    campaignAddBroadcastEmailBody: CampaignAddBroadcastEmailBody,
+    campaignAddBroadcastEmailBody: NonReadonly<CampaignAddBroadcastEmailBody>,
  options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
 ) => {
       
@@ -122,8 +149,8 @@ export const campaignAddBroadcastEmail = (
 
 
 export const getCampaignAddBroadcastEmailMutationOptions = <TError = void,
-    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignAddBroadcastEmail>>, TError,{data: CampaignAddBroadcastEmailBody}, TContext>, request?: SecondParameter<typeof customFetch>}
-): UseMutationOptions<Awaited<ReturnType<typeof campaignAddBroadcastEmail>>, TError,{data: CampaignAddBroadcastEmailBody}, TContext> => {
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignAddBroadcastEmail>>, TError,{data: NonReadonly<CampaignAddBroadcastEmailBody>}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof campaignAddBroadcastEmail>>, TError,{data: NonReadonly<CampaignAddBroadcastEmailBody>}, TContext> => {
 
 const mutationKey = ['campaignAddBroadcastEmail'];
 const {mutation: mutationOptions, request: requestOptions} = options ?
@@ -135,7 +162,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
       
 
 
-      const mutationFn: MutationFunction<Awaited<ReturnType<typeof campaignAddBroadcastEmail>>, {data: CampaignAddBroadcastEmailBody}> = (props) => {
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof campaignAddBroadcastEmail>>, {data: NonReadonly<CampaignAddBroadcastEmailBody>}> = (props) => {
           const {data} = props ?? {};
 
           return  campaignAddBroadcastEmail(data,requestOptions)
@@ -147,18 +174,18 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
   return  { mutationFn, ...mutationOptions }}
 
     export type CampaignAddBroadcastEmailMutationResult = NonNullable<Awaited<ReturnType<typeof campaignAddBroadcastEmail>>>
-    export type CampaignAddBroadcastEmailMutationBody = CampaignAddBroadcastEmailBody
+    export type CampaignAddBroadcastEmailMutationBody = NonReadonly<CampaignAddBroadcastEmailBody>
     export type CampaignAddBroadcastEmailMutationError = void
 
     /**
  * @summary Create a new broadcast campaign.
  */
 export const useCampaignAddBroadcastEmail = <TError = void,
-    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignAddBroadcastEmail>>, TError,{data: CampaignAddBroadcastEmailBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignAddBroadcastEmail>>, TError,{data: NonReadonly<CampaignAddBroadcastEmailBody>}, TContext>, request?: SecondParameter<typeof customFetch>}
  ): UseMutationResult<
         Awaited<ReturnType<typeof campaignAddBroadcastEmail>>,
         TError,
-        {data: CampaignAddBroadcastEmailBody},
+        {data: NonReadonly<CampaignAddBroadcastEmailBody>},
         TContext
       > => {
 
@@ -243,7 +270,7 @@ directly. If both are provided, they are merged.
  */
 export const campaignUpdateBroadcastEmail = (
     broadcastCampaignUid: string | null,
-    campaignUpdateBroadcastEmailBody: CampaignUpdateBroadcastEmailBody,
+    campaignUpdateBroadcastEmailBody: NonReadonly<CampaignUpdateBroadcastEmailBody>,
  options?: SecondParameter<typeof customFetch>,) => {
       
       
@@ -258,8 +285,8 @@ export const campaignUpdateBroadcastEmail = (
 
 
 export const getCampaignUpdateBroadcastEmailMutationOptions = <TError = void,
-    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignUpdateBroadcastEmail>>, TError,{broadcastCampaignUid: string | null;data: CampaignUpdateBroadcastEmailBody}, TContext>, request?: SecondParameter<typeof customFetch>}
-): UseMutationOptions<Awaited<ReturnType<typeof campaignUpdateBroadcastEmail>>, TError,{broadcastCampaignUid: string | null;data: CampaignUpdateBroadcastEmailBody}, TContext> => {
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignUpdateBroadcastEmail>>, TError,{broadcastCampaignUid: string | null;data: NonReadonly<CampaignUpdateBroadcastEmailBody>}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof campaignUpdateBroadcastEmail>>, TError,{broadcastCampaignUid: string | null;data: NonReadonly<CampaignUpdateBroadcastEmailBody>}, TContext> => {
 
 const mutationKey = ['campaignUpdateBroadcastEmail'];
 const {mutation: mutationOptions, request: requestOptions} = options ?
@@ -271,7 +298,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
       
 
 
-      const mutationFn: MutationFunction<Awaited<ReturnType<typeof campaignUpdateBroadcastEmail>>, {broadcastCampaignUid: string | null;data: CampaignUpdateBroadcastEmailBody}> = (props) => {
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof campaignUpdateBroadcastEmail>>, {broadcastCampaignUid: string | null;data: NonReadonly<CampaignUpdateBroadcastEmailBody>}> = (props) => {
           const {broadcastCampaignUid,data} = props ?? {};
 
           return  campaignUpdateBroadcastEmail(broadcastCampaignUid,data,requestOptions)
@@ -283,18 +310,18 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
   return  { mutationFn, ...mutationOptions }}
 
     export type CampaignUpdateBroadcastEmailMutationResult = NonNullable<Awaited<ReturnType<typeof campaignUpdateBroadcastEmail>>>
-    export type CampaignUpdateBroadcastEmailMutationBody = CampaignUpdateBroadcastEmailBody
+    export type CampaignUpdateBroadcastEmailMutationBody = NonReadonly<CampaignUpdateBroadcastEmailBody>
     export type CampaignUpdateBroadcastEmailMutationError = void
 
     /**
  * @summary Update a broadcast campaign.
  */
 export const useCampaignUpdateBroadcastEmail = <TError = void,
-    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignUpdateBroadcastEmail>>, TError,{broadcastCampaignUid: string | null;data: CampaignUpdateBroadcastEmailBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignUpdateBroadcastEmail>>, TError,{broadcastCampaignUid: string | null;data: NonReadonly<CampaignUpdateBroadcastEmailBody>}, TContext>, request?: SecondParameter<typeof customFetch>}
  ): UseMutationResult<
         Awaited<ReturnType<typeof campaignUpdateBroadcastEmail>>,
         TError,
-        {broadcastCampaignUid: string | null;data: CampaignUpdateBroadcastEmailBody},
+        {broadcastCampaignUid: string | null;data: NonReadonly<CampaignUpdateBroadcastEmailBody>},
         TContext
       > => {
 
@@ -640,7 +667,7 @@ determines if the person is sent a welcome email and defaults to false.
  */
 export const emailListAddSubscription = (
     emailListUid: string | null,
-    emailListAddSubscriptionBody: EmailListAddSubscriptionBody,
+    emailListAddSubscriptionBody: NonReadonly<EmailListAddSubscriptionBody>,
  options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
 ) => {
       
@@ -656,8 +683,8 @@ export const emailListAddSubscription = (
 
 
 export const getEmailListAddSubscriptionMutationOptions = <TError = void,
-    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof emailListAddSubscription>>, TError,{emailListUid: string | null;data: EmailListAddSubscriptionBody}, TContext>, request?: SecondParameter<typeof customFetch>}
-): UseMutationOptions<Awaited<ReturnType<typeof emailListAddSubscription>>, TError,{emailListUid: string | null;data: EmailListAddSubscriptionBody}, TContext> => {
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof emailListAddSubscription>>, TError,{emailListUid: string | null;data: NonReadonly<EmailListAddSubscriptionBody>}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof emailListAddSubscription>>, TError,{emailListUid: string | null;data: NonReadonly<EmailListAddSubscriptionBody>}, TContext> => {
 
 const mutationKey = ['emailListAddSubscription'];
 const {mutation: mutationOptions, request: requestOptions} = options ?
@@ -669,7 +696,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
       
 
 
-      const mutationFn: MutationFunction<Awaited<ReturnType<typeof emailListAddSubscription>>, {emailListUid: string | null;data: EmailListAddSubscriptionBody}> = (props) => {
+      const mutationFn: MutationFunction<Awaited<ReturnType<typeof emailListAddSubscription>>, {emailListUid: string | null;data: NonReadonly<EmailListAddSubscriptionBody>}> = (props) => {
           const {emailListUid,data} = props ?? {};
 
           return  emailListAddSubscription(emailListUid,data,requestOptions)
@@ -681,18 +708,18 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
   return  { mutationFn, ...mutationOptions }}
 
     export type EmailListAddSubscriptionMutationResult = NonNullable<Awaited<ReturnType<typeof emailListAddSubscription>>>
-    export type EmailListAddSubscriptionMutationBody = EmailListAddSubscriptionBody
+    export type EmailListAddSubscriptionMutationBody = NonReadonly<EmailListAddSubscriptionBody>
     export type EmailListAddSubscriptionMutationError = void
 
     /**
  * @summary Subscribe a person to an email list.
  */
 export const useEmailListAddSubscription = <TError = void,
-    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof emailListAddSubscription>>, TError,{emailListUid: string | null;data: EmailListAddSubscriptionBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof emailListAddSubscription>>, TError,{emailListUid: string | null;data: NonReadonly<EmailListAddSubscriptionBody>}, TContext>, request?: SecondParameter<typeof customFetch>}
  ): UseMutationResult<
         Awaited<ReturnType<typeof emailListAddSubscription>>,
         TError,
-        {emailListUid: string | null;data: EmailListAddSubscriptionBody},
+        {emailListUid: string | null;data: NonReadonly<EmailListAddSubscriptionBody>},
         TContext
       > => {
 

package/src/generated/outsetaAPI.schemas.ts

@@ -40,9 +40,9 @@ export interface AbstractBean {
   /** @nullable */
   _objectType?: string | null;
   /** @minLength 1 */
-  Created: string;
+  readonly Created: string;
   /** @minLength 1 */
-  Updated: string;
+  readonly Updated: string;
 }
 
 /**
@@ -2633,11 +2633,163 @@ export const EmailListSubscriberStatus = {
   Confirmed: 4,
 } as const;
 
+export interface TokenPayload {
+  /** @nullable */
+  access_token?: string | null;
+  /** @nullable */
+  authentication_callback_url?: string | null;
+  expires_in?: number;
+  /** @nullable */
+  id_token?: string | null;
+  /** @nullable */
+  token_type?: string | null;
+}
+
+/**
+ * Returned when a login cannot complete with a password alone because the
+user has two-factor authentication enabled. Carries the opaque challenge
+token that must be echoed back to POST /api/v1/tokens/two-factor
+(or the recovery / resend / switch-mechanism endpoints) along with enough
+metadata for a client to render the verification step without a second
+round-trip. The property names are snake_case to match the wire format of
+the other token endpoints (see TokenPayload).
+ */
+export interface TwoFactorChallengePayload {
+  /**
+   * Present and true on the 202 response from POST /api/v1/tokens
+when the user has at least one verified 2FA method. Absent on the
+resend / switch-mechanism responses, which only ever follow an
+already-issued login challenge.
+   * @nullable
+   */
+  two_factor_required?: boolean | null;
+  /**
+   * Present and true instead of two_factor_required
+when the tenant forces 2FA but the user has not yet enrolled any
+method. In that case only challenge_token and
+expires_in are populated and the client must route the
+user through the mid-login enrollment endpoints
+(/api/v1/tokens/two-factor/enroll/...) before a token can be issued.
+   * @nullable
+   */
+  two_factor_enrollment_required?: boolean | null;
+  /**
+   * Short-lived signed JWT (audience outseta:2fa-challenge) that
+identifies this challenge. Echo it back verbatim to complete the login.
+   * @nullable
+   */
+  challenge_token?: string | null;
+  /**
+   * The mechanism this challenge was issued against: Email or
+Totp (authenticator app). For Email a code has already
+been sent to the user; for Totp the user reads the current
+code from their authenticator app and nothing is sent.
+   * @nullable
+   */
+  mechanism?: string | null;
+  /**
+   * A masked view of where an emailed code was sent (e.g. b***@outseta.com),
+suitable for display. Empty when mechanism is Totp.
+   * @nullable
+   */
+  masked_destination?: string | null;
+  /** Seconds until the challenge expires (600). After this the
+challenge_token can no longer be verified and the login must restart. */
+  expires_in?: number;
+  /**
+   * Every verified mechanism enrolled for this user (excluding recovery
+codes), e.g. ["Totp", "Email"]. A client can offer a
+"use a different method" option for any value other than the current
+mechanism via POST /api/v1/tokens/two-factor/switch-mechanism.
+   * @nullable
+   */
+  available_mechanisms?: string[] | null;
+  /**
+   * true when the user has a batch of recovery codes on file, in
+which case POST /api/v1/tokens/two-factor/recovery can be used
+as a fallback if they cannot produce a primary code.
+   * @nullable
+   */
+  recovery_codes_available?: boolean | null;
+}
+
 export interface PasswordPayload {
   /** @nullable */
   Password?: string | null;
 }
 
+/**
+ * Returned from POST /api/v1/tokens/two-factor/enroll/totp/begin when a
+user forced into 2FA chooses to enroll an authenticator app. Carries the
+shared secret in the three forms a client may need to present it, plus the
+challenge token the user's first generated code is confirmed against. The
+property names are snake_case to match the wire format of the other token
+endpoints (see TokenPayload).
+ */
+export interface TwoFactorTotpEnrollmentPayload {
+  /**
+   * Short-lived signed JWT identifying the enrollment-test challenge.
+Echo it back to POST /api/v1/tokens/two-factor/enroll/totp/confirm
+along with the first code from the authenticator app.
+   * @nullable
+   */
+  challenge_token?: string | null;
+  /**
+   * The Base32-encoded shared secret. Offer this for manual entry by users
+who cannot scan the QR code.
+   * @nullable
+   */
+  secret?: string | null;
+  /**
+   * The full otpauth://totp/... URI encoding the secret, issuer and
+parameters. Most authenticator apps add an account directly from this.
+   * @nullable
+   */
+  otpauth_uri?: string | null;
+  /**
+   * A QR code rendering of otpauth_uri as a PNG, Base64
+encoded — render it as an <img> for the user to scan.
+   * @nullable
+   */
+  qr_code_png_base64?: string | null;
+  /** Seconds until the enrollment-test challenge expires (600). */
+  expires_in?: number;
+}
+
+/**
+ * Returned from the mid-login enrollment confirm endpoints
+(POST /api/v1/tokens/two-factor/enroll/{email|totp}/confirm) once the
+user has proven control of the new mechanism. Completes a forced-enrollment
+login: it both finalizes the JWT access token and surfaces the freshly
+generated recovery codes. The property names are snake_case to match the
+wire format of the other token endpoints (see TokenPayload).
+ */
+export interface TwoFactorEnrollmentConfirmationPayload {
+  /** Always true on a success response; the enrollment is now active. */
+  confirmed?: boolean;
+  /**
+   * The user's recovery codes, generated as part of first-time enrollment.
+These are shown once and never returned again — prompt the user
+to store them somewhere safe. Each code is single-use at
+POST /api/v1/tokens/two-factor/recovery.
+   * @nullable
+   */
+  recovery_codes?: string[] | null;
+  /**
+   * The JWT access token. Use it as Authorization: bearer {access_token}
+for subsequent API calls — login is complete.
+   * @nullable
+   */
+  access_token?: string | null;
+  /**
+   * Always Bearer.
+   * @nullable
+   */
+  token_type?: string | null;
+  /** Seconds until the access token expires. */
+  expires_in?: number;
+}
+
 /**
  * @nullable
  */
@@ -3416,8 +3568,27 @@ export type SendGridDomainAuthenticationAllOf = {
    * @maxLength 250
    */
   DomainName: string;
+  /**
+   * @maxLength 100
+   * @nullable
+   */
+  SendGridSubuser?: string | null;
   IsValid?: boolean;
   IsBrandedLinksDisabled?: boolean;
+  IsLinkTrackingDnsValid?: boolean;
+  /**
+   * @maxLength 100
+   * @nullable
+   */
+  CloudflareCustomHostnameId?: string | null;
+  /**
+   * @maxLength 50
+   * @nullable
+   */
+  CloudflareSslStatus?: string | null;
+  /** @nullable */
+  CloudflareCustomHostnameCreatedAt?: string | null;
+  IsHttpsUpgradeAvailable?: boolean;
   /** @nullable */
   LastValidationAttempt?: string | null;
   /** @nullable */
@@ -5658,6 +5829,69 @@ export interface PersonSegmentRemovedWebhookPayload {
   ActivityEventData?: PersonSegmentRemovedActivityData;
 }
 
+export type AuthGetTokenParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};
+
+export type AuthVerifyTwoFactorTokenParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};
+
+export type AuthResendTwoFactorParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};
+
+export type AuthSwitchTwoFactorMechanismParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};
+
+export type AuthVerifyTwoFactorRecoveryParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};
+
+export type TokenTwoFactorEnrollmentBeginEmailParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};
+
+export type TokenTwoFactorEnrollmentBeginTotpParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};
+
+export type TokenTwoFactorEnrollmentConfirmEmailParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};
+
+export type TokenTwoFactorEnrollmentConfirmTotpParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};
+
 export type CaseGetAllCasesParams = {
 /**
  * Search string