@outseta/react 0.4.18 → 0.4.20

package/package.json

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

package/src/generated/outsetaAPI.schemas.ts

@@ -1248,6 +1248,12 @@ export type StripePriceAllOf = {
    * @nullable
    */
   Currency?: string | null;
+  /** @nullable */
+  CustomUnitAmount_Maximum?: number | null;
+  /** @nullable */
+  CustomUnitAmount_Minimum?: number | null;
+  /** @nullable */
+  CustomUnitAmount_Preset?: number | null;
   IsActive?: boolean;
   /**
    * @maxLength 250
@@ -1275,6 +1281,11 @@ export type StripePriceAllOf = {
    * @nullable
    */
   TaxBehavior?: string | null;
+  /**
+   * @maxLength 36
+   * @nullable
+   */
+  TiersMode?: string | null;
   /** @nullable */
   TransformQuantity_DivideBy?: number | null;
   /**
@@ -8992,22 +9003,22 @@ export type DiscordUserRemovedFromServerWebhookPayloadAllOf = {
 export type DiscordUserRemovedFromServerWebhookPayload = PersonWebhookEntity & DiscordUserRemovedFromServerWebhookPayloadAllOf;
 
 /**
- * Maximum number of records per page.
+ * 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.
  */
 export type LimitParameter = number;
 
 /**
- * Zero-based page index.
+ * 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).
  */
 export type OffsetParameter = number;
 
 export type DefinitionGetAllDefinitionsParams = {
 /**
- * Maximum number of records per page.
+ * 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 index.
+ * 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;
 };
@@ -9017,6 +9028,11 @@ export type DefinitionGetAllDefinitions200 = {
   items?: Definition[];
 };
 
+/**
+ * @nullable
+ */
+export type PublicEmailListAddSubscriptionBody = EmailListPerson | null;
+
 export type AuthGetTokenParams = {
 /**
  * @nullable
@@ -9124,11 +9140,11 @@ export type ArticleAddArticleBody = Article | null;
 
 export type CategoryGetAllCategoriesParams = {
 /**
- * Maximum number of records per page.
+ * 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 index.
+ * 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;
 };
@@ -9140,11 +9156,11 @@ export type CategoryGetAllCategories200 = {
 
 export type DripCampaignGetAllDripCampaignsParams = {
 /**
- * Maximum number of records per page.
+ * 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 index.
+ * 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;
 };
@@ -9181,11 +9197,11 @@ export type DripCampaignSendTestCampaignEmailBody = SendTestEmailRequest | null;
 
 export type CampaignGetAllBroadcastEmailsParams = {
 /**
- * Maximum number of records per page.
+ * 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 index.
+ * 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;
 };
@@ -9406,11 +9422,11 @@ export type UsageAddUsageBody = Usage | null;
 
 export type TransactionsGetAllTransactionsByAccountIdParams = {
 /**
- * Maximum number of records per page.
+ * 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 index.
+ * 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;
 };
@@ -9460,11 +9476,11 @@ export type SubscriptionAddOnSetAddOnUpgradeRequiredBody = SubscriptionAddOn | n
 
 export type InvoiceGetAllInvoicesParams = {
 /**
- * Maximum number of records per page.
+ * 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 index.
+ * 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;
 /**
@@ -9557,11 +9573,11 @@ export type SubscriptionChangeSubscriptionBody = Subscription | null;
 
 export type PlanGetAllPlansParams = {
 /**
- * Maximum number of records per page.
+ * 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 index.
+ * 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;
 };
@@ -9583,11 +9599,11 @@ export type PlanUpdatePlanBody = Plan | null;
 
 export type PlanFamilyGetAllPlanFamiliesParams = {
 /**
- * Maximum number of records per page.
+ * 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 index.
+ * 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;
 };

package/src/generated/public/public.ts

@@ -13,6 +13,7 @@ import type {
   AuthResendTwoFactorParams,
   AuthSwitchTwoFactorMechanismParams,
   AuthVerifyTwoFactorRecoveryParams,
+  PublicEmailListAddSubscriptionBody,
   TokenPayload,
   TokenTwoFactorEnrollmentBeginEmailParams,
   TokenTwoFactorEnrollmentBeginTotpParams,
@@ -26,12 +27,107 @@ 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];
 
 
 
 /**
+ * This endpoint does not require authentication. The email list must be public, and the
+subscription is subject to bot protection and the list's double opt-in settings.
+ * @summary Publicly subscribe a person to an email list.
+ */
+export const publicEmailListAddSubscription = (
+    emailListUid: string | null,
+    publicEmailListAddSubscriptionBody: NonReadonly<PublicEmailListAddSubscriptionBody>,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<Blob>(
+      {url: `/api/v1/public/email/lists/${emailListUid}/subscriptions`, method: 'POST',
+      headers: {'Content-Type': 'application/json', },
+      data: publicEmailListAddSubscriptionBody,
+        responseType: 'blob', signal
+    },
+      options);
+    }
+  
+
+
+export const getPublicEmailListAddSubscriptionMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof publicEmailListAddSubscription>>, TError,{emailListUid: string | null;data: NonReadonly<PublicEmailListAddSubscriptionBody>}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof publicEmailListAddSubscription>>, TError,{emailListUid: string | null;data: NonReadonly<PublicEmailListAddSubscriptionBody>}, TContext> => {
+
+const mutationKey = ['publicEmailListAddSubscription'];
+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 publicEmailListAddSubscription>>, {emailListUid: string | null;data: NonReadonly<PublicEmailListAddSubscriptionBody>}> = (props) => {
+          const {emailListUid,data} = props ?? {};
+
+          return  publicEmailListAddSubscription(emailListUid,data,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type PublicEmailListAddSubscriptionMutationResult = NonNullable<Awaited<ReturnType<typeof publicEmailListAddSubscription>>>
+    export type PublicEmailListAddSubscriptionMutationBody = NonReadonly<PublicEmailListAddSubscriptionBody>
+    export type PublicEmailListAddSubscriptionMutationError = void
+
+    /**
+ * @summary Publicly subscribe a person to an email list.
+ */
+export const usePublicEmailListAddSubscription = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof publicEmailListAddSubscription>>, TError,{emailListUid: string | null;data: NonReadonly<PublicEmailListAddSubscriptionBody>}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof publicEmailListAddSubscription>>,
+        TError,
+        {emailListUid: string | null;data: NonReadonly<PublicEmailListAddSubscriptionBody>},
+        TContext
+      > => {
+
+      const mutationOptions = getPublicEmailListAddSubscriptionMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
  * Authenticates a user and returns a JWT access token (plus a refresh token).
             
 Post a JSON body with the user's credentials: