@outseta/react 0.4.34 → 0.4.36

package/dist/index.js

@@ -1660,6 +1660,32 @@ var usePlanDeletePlan = (options) => {
   const mutationOptions = getPlanDeletePlanMutationOptions(options);
   return useMutation(mutationOptions);
 };
+var planAddOnGetAllPlanAddOns = (params, options, signal) => {
+  return customFetch2({
+    url: `/api/v1/billing/planaddons`,
+    method: "GET",
+    params,
+    signal
+  }, options);
+};
+var getPlanAddOnGetAllPlanAddOnsQueryKey = (params) => {
+  return [
+    `/api/v1/billing/planaddons`,
+    ...params ? [params] : []
+  ];
+};
+var getPlanAddOnGetAllPlanAddOnsQueryOptions = (params, options) => {
+  const { query: queryOptions, request: requestOptions } = options ?? {};
+  const queryKey = queryOptions?.queryKey ?? getPlanAddOnGetAllPlanAddOnsQueryKey(params);
+  const queryFn = ({ signal }) => planAddOnGetAllPlanAddOns(params, requestOptions, signal);
+  return { queryKey, queryFn, ...queryOptions };
+};
+function usePlanAddOnGetAllPlanAddOns(params, options) {
+  const queryOptions = getPlanAddOnGetAllPlanAddOnsQueryOptions(params, options);
+  const query = useQuery(queryOptions);
+  query.queryKey = queryOptions.queryKey;
+  return query;
+}
 var planFamilyGetAllPlanFamilies = (params, options, signal) => {
   return customFetch2({
     url: `/api/v1/billing/planfamilies`,
@@ -3879,6 +3905,10 @@ var AccountWebhookEntitySubscriptionsItemLatestInvoiceBillingInvoiceStatus = {
   Uncollectible: 6,
   Processing: 7
 };
+var AccountWebhookEntityCurrentStripeProductInstancesItemAccountRegistrationMode = {
+  Individual: 1,
+  Team: 2
+};
 var AccountWebhookEntityCurrentSubscriptionBillingRenewalTerm = {
   Monthly: 1,
   Yearly: 2,
@@ -4029,6 +4059,7 @@ export {
   AccountRegistrationMode,
   AccountStage,
   AccountWebhookEntityAccountStage,
+  AccountWebhookEntityCurrentStripeProductInstancesItemAccountRegistrationMode,
   AccountWebhookEntityCurrentSubscriptionBillingRenewalTerm,
   AccountWebhookEntityCurrentSubscriptionDiscountCouponSubscriptionsItemDiscountCouponDuration,
   AccountWebhookEntityCurrentSubscriptionLatestInvoiceBillingInvoiceStatus,
@@ -4301,6 +4332,8 @@ export {
   getPersonRequestMagicLinkMutationOptions,
   getPersonSetTemporaryPasswordMutationOptions,
   getPersonUpdatePersonMutationOptions,
+  getPlanAddOnGetAllPlanAddOnsQueryKey,
+  getPlanAddOnGetAllPlanAddOnsQueryOptions,
   getPlanAddPlanMutationOptions,
   getPlanDeletePlanMutationOptions,
   getPlanFamilyAddPlanFamilyMutationOptions,
@@ -4364,6 +4397,7 @@ export {
   personRequestMagicLink,
   personSetTemporaryPassword,
   personUpdatePerson,
+  planAddOnGetAllPlanAddOns,
   planAddPlan,
   planDeletePlan,
   planFamilyAddPlanFamily,
@@ -4488,6 +4522,7 @@ export {
   usePersonRequestMagicLink,
   usePersonSetTemporaryPassword,
   usePersonUpdatePerson,
+  usePlanAddOnGetAllPlanAddOns,
   usePlanAddPlan,
   usePlanDeletePlan,
   usePlanFamilyAddPlanFamily,

package/package.json

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

package/src/generated/billing/billing.ts

@@ -30,6 +30,8 @@ import type {
   PaymentInformation,
   PaymentInformationSavePaymentInformationBody,
   Plan,
+  PlanAddOnGetAllPlanAddOns200,
+  PlanAddOnGetAllPlanAddOnsParams,
   PlanAddPlanBody,
   PlanFamily,
   PlanFamilyAddPlanFamilyBody,
@@ -2835,6 +2837,80 @@ export const usePlanDeletePlan = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
+ * Standard filtering applies, so the associations of a single plan are retrieved
+with ?Plan.Uid={planUid} and those of a single add-on with ?AddOn.Uid={addOnUid}.
+A PlanAddOns collection nested inside a plan or an add-on holds at most 100
+entries, so a plan with more add-ons than that is read in full through this
+endpoint, which is paginated and has no such maximum.
+ * @summary Retrieve the associations between plans and add-ons.
+ */
+export const planAddOnGetAllPlanAddOns = (
+    params?: PlanAddOnGetAllPlanAddOnsParams,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<PlanAddOnGetAllPlanAddOns200>(
+      {url: `/api/v1/billing/planaddons`, method: 'GET',
+        params, signal
+    },
+      options);
+    }
+  
+
+
+
+export const getPlanAddOnGetAllPlanAddOnsQueryKey = (params?: PlanAddOnGetAllPlanAddOnsParams,) => {
+    return [
+    `/api/v1/billing/planaddons`, ...(params ? [params]: [])
+    ] as const;
+    }
+
+    
+export const getPlanAddOnGetAllPlanAddOnsQueryOptions = <TData = Awaited<ReturnType<typeof planAddOnGetAllPlanAddOns>>, TError = void>(params?: PlanAddOnGetAllPlanAddOnsParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof planAddOnGetAllPlanAddOns>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getPlanAddOnGetAllPlanAddOnsQueryKey(params);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof planAddOnGetAllPlanAddOns>>> = ({ signal }) => planAddOnGetAllPlanAddOns(params, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof planAddOnGetAllPlanAddOns>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type PlanAddOnGetAllPlanAddOnsQueryResult = NonNullable<Awaited<ReturnType<typeof planAddOnGetAllPlanAddOns>>>
+export type PlanAddOnGetAllPlanAddOnsQueryError = void
+
+
+/**
+ * @summary Retrieve the associations between plans and add-ons.
+ */
+
+export function usePlanAddOnGetAllPlanAddOns<TData = Awaited<ReturnType<typeof planAddOnGetAllPlanAddOns>>, TError = void>(
+ params?: PlanAddOnGetAllPlanAddOnsParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof planAddOnGetAllPlanAddOns>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+  
+ ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } {
+
+  const queryOptions = getPlanAddOnGetAllPlanAddOnsQueryOptions(params,options)
+
+  const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
+
+/**
  * @summary Retrieve all plan families.
  */
 export const planFamilyGetAllPlanFamilies = (

package/src/generated/outsetaAPI.schemas.ts

@@ -481,6 +481,11 @@ export type AccountAllOfPrimarySubscription = Subscription | null;
  */
 export type AccountAllOfPrimaryStripeSubscription = StripeSubscription | null;
 
+/**
+ * @nullable
+ */
+export type AccountAllOfStripeCheckoutMetadata = {[key: string]: string} | null;
+
 export type AccountAllOf = {
   /**
    * @minLength 1
@@ -595,6 +600,8 @@ export type AccountAllOf = {
   /** @nullable */
   CurrentStripeProducts?: string | null;
   /** @nullable */
+  CurrentStripeProductInstances?: StripeProduct[] | null;
+  /** @nullable */
   CurrentSubscription?: AccountAllOfCurrentSubscription;
   /** @nullable */
   DomainName?: string | null;
@@ -615,6 +622,8 @@ export type AccountAllOf = {
   /** @nullable */
   RecaptchaToken?: string | null;
   /** @nullable */
+  StripeCheckoutMetadata?: AccountAllOfStripeCheckoutMetadata;
+  /** @nullable */
   StripeNextInvoiceSequence?: number | null;
   /** @nullable */
   StripePrice?: string[] | null;
@@ -1004,6 +1013,8 @@ export type StripeProductAllOf = {
   NumberOfPurchases?: number;
   NumberOfSubscriptions?: number;
   /** @nullable */
+  Quantity?: number | null;
+  /** @nullable */
   StripeProductFamily?: StripeProductAllOfStripeProductFamily;
   [key: string]: unknown | null;
 };
@@ -4564,7 +4575,6 @@ export type CrmSettingsAllOf = {
   RegistrationConfirmationEmailDelaySeconds?: number;
   /** @nullable */
   RegistrationCallbackUrlLocations?: string | null;
-  TwoFactorAuthenticationAvailable?: boolean;
   MagicLinkLoginOnly?: boolean;
 };
 
@@ -6125,6 +6135,101 @@ export type AccountWebhookEntityTaxIdsItem = {
   IsInvalid?: boolean;
 };
 
+/**
+ * `1` - Individual, `2` - Team
+ */
+export type AccountWebhookEntityCurrentStripeProductInstancesItemAccountRegistrationMode = typeof AccountWebhookEntityCurrentStripeProductInstancesItemAccountRegistrationMode[keyof typeof AccountWebhookEntityCurrentStripeProductInstancesItemAccountRegistrationMode];
+
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const AccountWebhookEntityCurrentStripeProductInstancesItemAccountRegistrationMode = {
+  Individual: 1,
+  Team: 2,
+} as const;
+
+export type AccountWebhookEntityCurrentStripeProductInstancesItem = {
+  /**
+   * @maxLength 10
+   * @nullable
+   */
+  Uid?: string | null;
+  /** @nullable */
+  _objectType?: string | null;
+  /** @minLength 1 */
+  Created: string;
+  /** @minLength 1 */
+  Updated: string;
+  /**
+   * @maxLength 255
+   * @nullable
+   */
+  StripeId?: string | null;
+  IsLivemode?: boolean;
+  /**
+   * @maxLength 250
+   * @nullable
+   */
+  Name?: string | null;
+  /**
+   * @maxLength 255
+   * @nullable
+   */
+  DefaultPriceId?: string | null;
+  /** @nullable */
+  Description?: string | null;
+  IsActive?: boolean;
+  /**
+   * @maxLength 36
+   * @nullable
+   */
+  TaxCodeId?: string | null;
+  /**
+   * @maxLength 250
+   * @nullable
+   */
+  UnitLabel?: string | null;
+  /** `1` - Individual, `2` - Team */
+  AccountRegistrationMode?: AccountWebhookEntityCurrentStripeProductInstancesItemAccountRegistrationMode;
+  ExpiresAfterMonths?: number;
+  /** @nullable */
+  ExpirationDate?: string | null;
+  IsPerUser?: boolean;
+  IsQuantityEditable?: boolean;
+  /** @nullable */
+  MaximumPeople?: number | null;
+  /**
+   * @maxLength 8
+   * @nullable
+   */
+  MigratedAddOnUid?: string | null;
+  /**
+   * @maxLength 8
+   * @nullable
+   */
+  MigratedPlanUid?: string | null;
+  /** @nullable */
+  MinimumQuantity?: number | null;
+  /**
+   * @maxLength 250
+   * @nullable
+   */
+  PostLoginPath?: string | null;
+  /**
+   * @maxLength 500
+   * @nullable
+   */
+  PostPurchaseUrl?: string | null;
+  RequirePaymentInformation?: boolean;
+  TrialPeriodDays?: number;
+  /** @nullable */
+  TrialUntilDate?: string | null;
+  CanDelete?: boolean;
+  NumberOfPurchases?: number;
+  NumberOfSubscriptions?: number;
+  /** @nullable */
+  Quantity?: number | null;
+};
+
 /**
  * `1` - Monthly, `2` - Yearly, `3` - Quarterly, `4` - One Time
  */
@@ -7394,6 +7499,8 @@ export interface AccountWebhookEntity {
   /** @nullable */
   CurrentStripeProducts?: string | null;
   /** @nullable */
+  CurrentStripeProductInstances?: AccountWebhookEntityCurrentStripeProductInstancesItem[] | null;
+  /** @nullable */
   CurrentSubscription?: AccountWebhookEntityCurrentSubscription;
   /** @nullable */
   DomainName?: string | null;
@@ -10074,6 +10181,22 @@ export type PlanAddPlanBody = Plan | null;
  */
 export type PlanUpdatePlanBody = Plan | null;
 
+export type PlanAddOnGetAllPlanAddOnsParams = {
+/**
+ * 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 PlanAddOnGetAllPlanAddOns200 = {
+  metadata?: CollectionMetadata;
+  items?: PlanAddOn[];
+};
+
 export type PlanFamilyGetAllPlanFamiliesParams = {
 /**
  * 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.