@outseta/react 0.4.47 → 0.5.0

package/src/generated/crm/crm.ts

@@ -19,6 +19,8 @@ import type {
   AccountAddAccountParams,
   AccountAddPersonToAccountBody,
   AccountCancelAccountBody,
+  AccountExpireCurrentSubscriptionBody,
+  AccountExtendRenewalBody,
   AccountExtendTrialBody,
   AccountGetAllAccounts200,
   AccountGetAllAccountsParams,
@@ -1491,6 +1493,94 @@ export const useAccountExtendTrial = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
+ * Acts on the account's current subscription. The account must be in the Subscribing,
+Cancelling, Trialing, CancellingTrial or PastDue stage, and the request is rejected when
+a future subscription (a scheduled plan change) is waiting to start on the account.
+            
+ToDate is the new renewal date. It must be after the subscription's start date, on or
+after the date of the subscription's latest invoice, and not later than ExpirationDate.
+Moving the renewal date earlier gives no credit for the rest of the current term.
+            
+ExpirationDate is the date the subscription ends. Outseta ends the subscription when it
+reaches this date and sets its EndDate to it. When only ExpirationDate is sent and it is
+before the current renewal date, the renewal date moves to the expiration date.
+            
+Every request sets the expiration date. If ExpirationDate is omitted, the subscription's
+existing expiration date is removed, except when ToDate is later than it: then the
+expiration date moves to ToDate. To remove the expiration date, send an empty body ({}).
+To keep an expiration date while changing the renewal date, send both.
+            
+Times of day: ExpirationDate is first set to the time of day of the subscription's start
+date, and the checks above compare ToDate with the time of day you send. For example, with
+a subscription that started at 12:00 UTC, ToDate 2027-03-31T18:00:00Z is later than
+ExpirationDate 2027-03-31T00:00:00Z and is rejected. Send ToDate with the time of day of the
+current RenewalDate to avoid this. The saved renewal date keeps the time of day of the
+current RenewalDate.
+ * @summary Set the renewal date or expiration date of the current subscription.
+ */
+export const accountExtendRenewal = (
+    accountUid: string | null,
+    accountExtendRenewalBody: AccountExtendRenewalBody,
+ options?: SecondParameter<typeof customFetch>,) => {
+      
+      
+      return customFetch<Blob>(
+      {url: `/api/v1/crm/accounts/${accountUid}/extend-renewal`, method: 'PUT',
+      headers: {'Content-Type': 'application/json', },
+      data: accountExtendRenewalBody,
+        responseType: 'blob'
+    },
+      options);
+    }
+  
+
+
+export const getAccountExtendRenewalMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof accountExtendRenewal>>, TError,{accountUid: string | null;data: AccountExtendRenewalBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof accountExtendRenewal>>, TError,{accountUid: string | null;data: AccountExtendRenewalBody}, TContext> => {
+
+const mutationKey = ['accountExtendRenewal'];
+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 accountExtendRenewal>>, {accountUid: string | null;data: AccountExtendRenewalBody}> = (props) => {
+          const {accountUid,data} = props ?? {};
+
+          return  accountExtendRenewal(accountUid,data,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type AccountExtendRenewalMutationResult = NonNullable<Awaited<ReturnType<typeof accountExtendRenewal>>>
+    export type AccountExtendRenewalMutationBody = AccountExtendRenewalBody
+    export type AccountExtendRenewalMutationError = void
+
+    /**
+ * @summary Set the renewal date or expiration date of the current subscription.
+ */
+export const useAccountExtendRenewal = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof accountExtendRenewal>>, TError,{accountUid: string | null;data: AccountExtendRenewalBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof accountExtendRenewal>>,
+        TError,
+        {accountUid: string | null;data: AccountExtendRenewalBody},
+        TContext
+      > => {
+
+      const mutationOptions = getAccountExtendRenewalMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
  * 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.
@@ -1556,6 +1646,86 @@ export const useAccountSendConfirmationEmail = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3), cancel the Stripe
+subscription instead: POST /billing/stripe/subscriptions/{subscriptionUid}/cancel with
+cancelImmediately=true.
+            
+The subscription and its add-ons end now, and the account moves to the Expired stage
+(TrialExpired if it was in the Trialing stage). Any future subscription (a scheduled plan
+change) is deleted. Unpaid invoices on the subscription are marked uncollectible, so no
+more automatic payment attempts are made on them. You can still record a payment against
+them. No call is made to Stripe, and the payment method is not changed.
+            
+The request is rejected when the account is already in the Expired or TrialExpired stage,
+or when the subscription's renewal date is in the past.
+            
+The body is optional. Send CancelationReason and Comment to record why the account was
+cancelled. Without a body, the reason records who made the request.
+ * @summary Cancel an account's current subscription immediately.
+ */
+export const accountExpireCurrentSubscription = (
+    accountUid: string | null,
+    accountExpireCurrentSubscriptionBody: NonReadonly<AccountExpireCurrentSubscriptionBody>,
+ options?: SecondParameter<typeof customFetch>,) => {
+      
+      
+      return customFetch<Blob>(
+      {url: `/api/v1/crm/accounts/${accountUid}/expire-current-subscription`, method: 'PUT',
+      headers: {'Content-Type': 'application/json', },
+      data: accountExpireCurrentSubscriptionBody,
+        responseType: 'blob'
+    },
+      options);
+    }
+  
+
+
+export const getAccountExpireCurrentSubscriptionMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof accountExpireCurrentSubscription>>, TError,{accountUid: string | null;data: NonReadonly<AccountExpireCurrentSubscriptionBody>}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof accountExpireCurrentSubscription>>, TError,{accountUid: string | null;data: NonReadonly<AccountExpireCurrentSubscriptionBody>}, TContext> => {
+
+const mutationKey = ['accountExpireCurrentSubscription'];
+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 accountExpireCurrentSubscription>>, {accountUid: string | null;data: NonReadonly<AccountExpireCurrentSubscriptionBody>}> = (props) => {
+          const {accountUid,data} = props ?? {};
+
+          return  accountExpireCurrentSubscription(accountUid,data,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type AccountExpireCurrentSubscriptionMutationResult = NonNullable<Awaited<ReturnType<typeof accountExpireCurrentSubscription>>>
+    export type AccountExpireCurrentSubscriptionMutationBody = NonReadonly<AccountExpireCurrentSubscriptionBody>
+    export type AccountExpireCurrentSubscriptionMutationError = void
+
+    /**
+ * @summary Cancel an account's current subscription immediately.
+ */
+export const useAccountExpireCurrentSubscription = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof accountExpireCurrentSubscription>>, TError,{accountUid: string | null;data: NonReadonly<AccountExpireCurrentSubscriptionBody>}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof accountExpireCurrentSubscription>>,
+        TError,
+        {accountUid: string | null;data: NonReadonly<AccountExpireCurrentSubscriptionBody>},
+        TContext
+      > => {
+
+      const mutationOptions = getAccountExpireCurrentSubscriptionMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
  * Returns the people associated with your account.
  * @summary Retrieve all people.
  */

package/src/generated/outsetaAPI.schemas.ts

@@ -990,16 +990,6 @@ export type StripeProductAllOf = {
   IsQuantityEditable?: boolean;
   /** @nullable */
   MaximumPeople?: number | null;
-  /**
-   * @maxLength 8
-   * @nullable
-   */
-  MigratedAddOnUid?: string | null;
-  /**
-   * @maxLength 8
-   * @nullable
-   */
-  MigratedPlanUid?: string | null;
   /** @nullable */
   MinimumQuantity?: number | null;
   /**
@@ -1018,7 +1008,6 @@ export type StripeProductAllOf = {
   TrialPeriodDays?: number;
   /** @nullable */
   TrialUntilDate?: string | null;
-  CanDelete?: boolean;
   NumberOfPurchases?: number;
   NumberOfSubscriptions?: number;
   /** @nullable */
@@ -4875,9 +4864,17 @@ export interface ExtendTrialParams {
 }
 
 export interface ExtendRenewalParams {
-  /** @nullable */
+  /**
+   * The new renewal date of the subscription. Omit it to keep the current renewal date, unless
+ExpirationDate is earlier than it: then the renewal date moves to ExpirationDate.
+   * @nullable
+   */
   ToDate?: string | null;
-  /** @nullable */
+  /**
+   * The date the subscription ends. Omit it to remove the subscription's expiration date, unless
+ToDate is later than the existing expiration date: then the expiration date moves to ToDate.
+   * @nullable
+   */
   ExpirationDate?: string | null;
 }
 
@@ -5017,6 +5014,14 @@ export interface SessionFlowDataSubscriptionUpdateConfirmItemOptions {
   Quantity?: number | null;
 }
 
+export interface ImportResult {
+  CountImported?: number;
+  CountError?: number;
+  CountTotal?: number;
+  /** @nullable */
+  ErrorMessages?: string[] | null;
+}
+
 export interface InvoiceStatusChangeOptions {
   /** @nullable */
   NewStatus?: string | null;
@@ -6405,16 +6410,6 @@ export type AccountWebhookEntityCurrentStripeProductInstancesItem = {
   IsQuantityEditable?: boolean;
   /** @nullable */
   MaximumPeople?: number | null;
-  /**
-   * @maxLength 8
-   * @nullable
-   */
-  MigratedAddOnUid?: string | null;
-  /**
-   * @maxLength 8
-   * @nullable
-   */
-  MigratedPlanUid?: string | null;
   /** @nullable */
   MinimumQuantity?: number | null;
   /**
@@ -6431,7 +6426,6 @@ export type AccountWebhookEntityCurrentStripeProductInstancesItem = {
   TrialPeriodDays?: number;
   /** @nullable */
   TrialUntilDate?: string | null;
-  CanDelete?: boolean;
   NumberOfPurchases?: number;
   NumberOfSubscriptions?: number;
   /** @nullable */
@@ -10132,6 +10126,16 @@ export type AccountCancelAccountBody = AccountCancelation | null;
  */
 export type AccountExtendTrialBody = ExtendTrialParams | null;
 
+/**
+ * @nullable
+ */
+export type AccountExtendRenewalBody = ExtendRenewalParams | null;
+
+/**
+ * @nullable
+ */
+export type AccountExpireCurrentSubscriptionBody = AccountCancelation | null;
+
 export type PersonGetAllPeopleParams = {
 /**
  * Match on the person's first or last name or email address
@@ -10178,6 +10182,241 @@ export type PersonForgotPasswordBody = Person | null;
  */
 export type PersonRequestMagicLinkBody = Person | null;
 
+export type StripeInvoiceLineItemsGetAllParams = {
+/**
+ * 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 StripeInvoiceLineItemsGetAll200 = {
+  metadata?: CollectionMetadata;
+  items?: StripeInvoiceLineItem[];
+};
+
+export type StripePaymentMethodsGetAllParams = {
+/**
+ * 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 StripePaymentMethodsGetAll200 = {
+  metadata?: CollectionMetadata;
+  items?: StripePaymentMethod[];
+};
+
+export type StripePricesGetAllParams = {
+/**
+ * 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 StripePricesGetAll200 = {
+  metadata?: CollectionMetadata;
+  items?: StripePrice[];
+};
+
+export type StripePromotionCodesGetAllParams = {
+/**
+ * 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 StripePromotionCodesGetAll200 = {
+  metadata?: CollectionMetadata;
+  items?: StripePromotionCode[];
+};
+
+/**
+ * @nullable
+ */
+export type StripePromotionCodesCreateBody = StripePromotionCode | null;
+
+/**
+ * @nullable
+ */
+export type StripePromotionCodesUpdateBody = StripePromotionCode | null;
+
+export type StripeProductFamiliesGetAllParams = {
+/**
+ * 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 StripeProductFamiliesGetAll200 = {
+  metadata?: CollectionMetadata;
+  items?: StripeProductFamily[];
+};
+
+/**
+ * @nullable
+ */
+export type StripeProductFamiliesPostBody = StripeProductFamily | null;
+
+/**
+ * @nullable
+ */
+export type StripeProductFamiliesPutBody = StripeProductFamily | null;
+
+export type StripeCouponsGetAllParams = {
+/**
+ * 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 StripeCouponsGetAll200 = {
+  metadata?: CollectionMetadata;
+  items?: StripeCoupon[];
+};
+
+/**
+ * @nullable
+ */
+export type StripeCouponsCreateBody = StripeCoupon | null;
+
+export type StripeCouponsGetRedemptionsParams = {
+/**
+ * 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 StripeCouponsGetRedemptions200 = {
+  metadata?: CollectionMetadata;
+  items?: StripeDiscount[];
+};
+
+export type StripeInvoicesGetAllParams = {
+/**
+ * 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 StripeInvoicesGetAll200 = {
+  metadata?: CollectionMetadata;
+  items?: StripeInvoice[];
+};
+
+/**
+ * @nullable
+ */
+export type StripeInvoicesPostBody = StripeInvoice | null;
+
+/**
+ * @nullable
+ */
+export type StripeInvoicesChangeInvoiceStatusBody = InvoiceStatusChangeOptions | null;
+
+/**
+ * @nullable
+ */
+export type StripeInvoicesIssueInvoiceCreditBody = InvoiceCreditOptions | null;
+
+export type StripeSubscriptionsGetAllParams = {
+/**
+ * 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 StripeSubscriptionsGetAll200 = {
+  metadata?: CollectionMetadata;
+  items?: StripeSubscription[];
+};
+
+/**
+ * @nullable
+ */
+export type StripeSubscriptionsCreateBody = StripeSubscription | null;
+
+/**
+ * @nullable
+ */
+export type StripeSubscriptionsPauseCollectionBody = PauseCollectionOptions | null;
+
+/**
+ * @nullable
+ */
+export type StripeSubscriptionsChangeBody = StripeSubscription | null;
+
+/**
+ * @nullable
+ */
+export type StripeSubscriptionsPreviewChangeBody = StripeSubscription | null;
+
+/**
+ * @nullable
+ */
+export type StripeSubscriptionsExtendTrialBody = ExtendSubscriptionOptions | null;
+
+export type StripeProductsGetAllParams = {
+/**
+ * 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 StripeProductsGetAll200 = {
+  metadata?: CollectionMetadata;
+  items?: StripeProduct[];
+};
+
+/**
+ * @nullable
+ */
+export type StripeProductsPostBody = StripeProduct | null;
+
+/**
+ * @nullable
+ */
+export type StripeProductsPutBody = StripeProduct | null;
+
 export type DiscountCouponGetDiscountCouponByCodeParams = {
 /**
  * The unique identifier of the plan to validate the coupon against

package/src/generated/public/public.ts

@@ -697,7 +697,33 @@ export const useTokenTwoFactorEnrollmentBeginEmail = <TError = string,
 
       return useMutation(mutationOptions);
     }
-    export const tokenTwoFactorEnrollmentBeginTotp = (
+    /**
+ * Call this when `POST /api/v1/tokens` returned
+`two_factor_enrollment_required` and the user chooses an authenticator
+app. Post the enrollment token from that response:
+            
+    { "enrollment_token": "eyJ..." }
+            
+A fresh shared secret is generated and returned in three forms so you
+can present it however suits your client:
+            
+    {
+      "challenge_token": "eyJ...",
+      "secret": "JBSWY3DPEHPK3PXP",
+      "otpauth_uri": "otpauth://totp/Acme:user@example.com?secret=...&issuer=Acme&...",
+      "qr_code_png_base64": "iVBORw0KGgo...",
+      "expires_in": 600
+    }
+            
+Have the user add the secret to their authenticator app (by scanning
+`qr_code_png_base64`, opening `otpauth_uri`, or typing `secret`), then
+confirm a code via `POST /api/v1/tokens/two-factor/enroll/totp/confirm`.
+Returns `401` if the enrollment token is invalid/expired and `403` if
+forced enrollment does not apply to this user. Rate limited to 5
+requests per minute (`429`).
+ * @summary Begin authenticator-app (TOTP) enrollment during a forced-2FA login.
+ */
+export const tokenTwoFactorEnrollmentBeginTotp = (
     params: TokenTwoFactorEnrollmentBeginTotpParams,
  options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
 ) => {
@@ -741,7 +767,10 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
     
     export type TokenTwoFactorEnrollmentBeginTotpMutationError = string
 
-    export const useTokenTwoFactorEnrollmentBeginTotp = <TError = string,
+    /**
+ * @summary Begin authenticator-app (TOTP) enrollment during a forced-2FA login.
+ */
+export const useTokenTwoFactorEnrollmentBeginTotp = <TError = string,
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof tokenTwoFactorEnrollmentBeginTotp>>, TError,{params: TokenTwoFactorEnrollmentBeginTotpParams}, TContext>, request?: SecondParameter<typeof customFetch>}
  ): UseMutationResult<
         Awaited<ReturnType<typeof tokenTwoFactorEnrollmentBeginTotp>>,

package/src/index.ts

@@ -5,9 +5,12 @@ export type { OutsetaCredentials } from "@outseta/api-client";
 export * from "./components/index.js";
 
 // Generated React hooks and schema types
+// BEGIN generated tag exports (scripts/post-generate.mjs)
 export * from "./generated/activity/activity.js";
-export * from "./generated/billing/billing.js";
+export * from "./generated/billing-v2/billing-v2.js";
+export * from "./generated/billing-v3/billing-v3.js";
 export * from "./generated/crm/crm.js";
 export * from "./generated/email/email.js";
 export * from "./generated/support/support.js";
+// END generated tag exports
 export * from "./generated/outsetaAPI.schemas.js";