@outseta/api-client 0.2.5 → 0.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@outseta/api-client",
-  "version": "0.2.5",
+  "version": "0.3.1",
   "description": "Generated API client for the Outseta REST API",
   "license": "MIT",
   "repository": {

package/src/client.ts

@@ -60,6 +60,13 @@ export function createClient(creds: OutsetaCredentials): OutsetaClient {
  * Consumers pass `{ client }` in the options to inject a client from
  * `createClient()`.
  */
+export function withClient(
+  client: OutsetaClient,
+  init: RequestInit = {},
+): RequestInit {
+  return { ...init, client } as OutsetaRequestInit as RequestInit;
+}
+
 export const customFetch = async <T>(
   url: string,
   options: OutsetaRequestInit,

package/src/generated/models/authGetTokenParams.ts

@@ -0,0 +1,8 @@
+// @ts-nocheck
+
+export type AuthGetTokenParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};

package/src/generated/models/authResendTwoFactorParams.ts

@@ -0,0 +1,8 @@
+// @ts-nocheck
+
+export type AuthResendTwoFactorParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};

package/src/generated/models/authSwitchTwoFactorMechanismParams.ts

@@ -0,0 +1,8 @@
+// @ts-nocheck
+
+export type AuthSwitchTwoFactorMechanismParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};

package/src/generated/models/authVerifyTwoFactorRecoveryParams.ts

@@ -0,0 +1,8 @@
+// @ts-nocheck
+
+export type AuthVerifyTwoFactorRecoveryParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};

package/src/generated/models/authVerifyTwoFactorTokenParams.ts

@@ -0,0 +1,8 @@
+// @ts-nocheck
+
+export type AuthVerifyTwoFactorTokenParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};

package/src/generated/models/index.ts

@@ -99,6 +99,11 @@ export * from './article';
 export * from './articleAllOf';
 export * from './articleAllOfCategory';
 export * from './articleGetAllArticlesParams';
+export * from './authGetTokenParams';
+export * from './authResendTwoFactorParams';
+export * from './authSwitchTwoFactorMechanismParams';
+export * from './authVerifyTwoFactorRecoveryParams';
+export * from './authVerifyTwoFactorTokenParams';
 export * from './backGroundTaskType';
 export * from './billSettings';
 export * from './billSettingsAllOf';
@@ -464,6 +469,11 @@ export * from './taxRateAllOf';
 export * from './template';
 export * from './templateAllOf';
 export * from './temporaryPasswordModel';
+export * from './tokenPayload';
+export * from './tokenTwoFactorEnrollmentBeginEmailParams';
+export * from './tokenTwoFactorEnrollmentBeginTotpParams';
+export * from './tokenTwoFactorEnrollmentConfirmEmailParams';
+export * from './tokenTwoFactorEnrollmentConfirmTotpParams';
 export * from './transaction';
 export * from './transactionAllOf';
 export * from './transactionAllOfAccount';
@@ -471,6 +481,9 @@ export * from './transactionAllOfInvoice';
 export * from './transactionsAddPaymentTransactionBody';
 export * from './translation';
 export * from './translationAllOf';
+export * from './twoFactorChallengePayload';
+export * from './twoFactorEnrollmentConfirmationPayload';
+export * from './twoFactorTotpEnrollmentPayload';
 export * from './usage';
 export * from './usageAddUsageBody';
 export * from './usageAllOf';

package/src/generated/models/tokenPayload.ts

@@ -0,0 +1,13 @@
+// @ts-nocheck
+
+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;
+}

package/src/generated/models/tokenTwoFactorEnrollmentBeginEmailParams.ts

@@ -0,0 +1,8 @@
+// @ts-nocheck
+
+export type TokenTwoFactorEnrollmentBeginEmailParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};

package/src/generated/models/tokenTwoFactorEnrollmentBeginTotpParams.ts

@@ -0,0 +1,8 @@
+// @ts-nocheck
+
+export type TokenTwoFactorEnrollmentBeginTotpParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};

package/src/generated/models/tokenTwoFactorEnrollmentConfirmEmailParams.ts

@@ -0,0 +1,8 @@
+// @ts-nocheck
+
+export type TokenTwoFactorEnrollmentConfirmEmailParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};

package/src/generated/models/tokenTwoFactorEnrollmentConfirmTotpParams.ts

@@ -0,0 +1,8 @@
+// @ts-nocheck
+
+export type TokenTwoFactorEnrollmentConfirmTotpParams = {
+/**
+ * @nullable
+ */
+data: unknown | null;
+};

package/src/generated/models/twoFactorChallengePayload.ts

@@ -0,0 +1,69 @@
+// @ts-nocheck
+
+/**
+ * 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;
+}

package/src/generated/models/twoFactorEnrollmentConfirmationPayload.ts

@@ -0,0 +1,35 @@
+// @ts-nocheck
+
+/**
+ * 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;
+}

package/src/generated/models/twoFactorTotpEnrollmentPayload.ts

@@ -0,0 +1,39 @@
+// @ts-nocheck
+
+/**
+ * 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;
+}