@outseta/react 0.5.0 → 0.5.2

package/package.json

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

package/src/generated/billing-v2/billing-v2.ts

@@ -586,6 +586,7 @@ export function useDiscountCouponGetDiscountCouponRedemptions<TData = Awaited<Re
 
 
 /**
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected.
  * @summary Add a usage entry for an add-on that bills for usage at the end of the month.
  */
 export const usageAddUsage = (
@@ -924,6 +925,8 @@ export function useSubscriptionAddOnGetAllSubscriptionsAddOns<TData = Awaited<Re
 
 
 /**
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected;
+use PUT /billing/stripe/subscriptions/{subscriptionUid}/change instead.
  * @summary Add an add-on to a subscription.
  */
 export const subscriptionAddOnAddSubscriptionAddOn = (
@@ -1123,7 +1126,9 @@ export const useSubscriptionAddOnAddSubscriptionAddOnPreview = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * When a subscription add-on is flagged, the next time the user authenticates the
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected.
+            
+When a subscription add-on is flagged, the next time the user authenticates the
 authentication widget will prompt the user to change their add-on.
  * @summary Indicate that an upgrade of an add-on is required.
  */
@@ -1189,7 +1194,10 @@ export const useSubscriptionAddOnSetAddOnUpgradeRequired = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * Removes the add-on from the subscription going forward and returns the updated
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected;
+use PUT /billing/stripe/subscriptions/{subscriptionUid}/change instead.
+            
+Removes the add-on from the subscription going forward and returns the updated
 subscription.
  * @summary End an add-on on a subscription.
  */
@@ -1252,6 +1260,7 @@ export const useSubscriptionAddOnEndSubscriptionAddOn = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected.
  * @summary Immediately ends an add-on.
  */
 export const subscriptionAddOnExpireSubscriptionAddOn = (
@@ -1386,6 +1395,8 @@ export function useInvoiceGetAllInvoices<TData = Awaited<ReturnType<typeof invoi
 
 
 /**
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected;
+use POST /billing/stripe/invoices instead.
  * @summary Create an ad-hoc invoice for a given account.
  */
 export const invoiceAddInvoice = (
@@ -1518,7 +1529,9 @@ export function useInvoiceGetInvoice<TData = Awaited<ReturnType<typeof invoiceGe
 
 
 /**
- * Only invoices created manually via the API or admin UI can be updated; invoices
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected.
+            
+Only invoices created manually via the API or admin UI can be updated; invoices
 generated by a subscription's billing cycle are immutable and will return a
 validation error.
  * @summary Update an ad-hoc (manually created) invoice.
@@ -2054,6 +2067,7 @@ export const useSubscriptionDeleteSubscription = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected.
  * @summary Add a discount to a subscription.
  */
 export const subscriptionAddDiscountToSubscription = (
@@ -2182,7 +2196,9 @@ export const useSubscriptionExpireDiscountCouponSubscription = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * When a subscription is flagged, next time the user authenticates the authentication
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected.
+            
+When a subscription is flagged, next time the user authenticates the authentication
 widget will prompt the user to change plan.
  * @summary Indicate that an upgrade of plan is required.
  */
@@ -2318,7 +2334,10 @@ export const useSubscriptionFirstTimeSubscriptionPreview = <TError = unknown,
       return useMutation(mutationOptions);
     }
     /**
- * Returns the new subscription.
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected;
+use POST /billing/stripe/subscriptions instead.
+            
+Returns the new subscription.
             
 Outseta sets the subscription's dates itself, except ExpirationDate:
             
@@ -2465,7 +2484,10 @@ export const useSubscriptionChangeSubscriptionPreview = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * Returns the new subscription; its StartDate is when the change takes effect. When only add-ons
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected;
+use PUT /billing/stripe/subscriptions/{subscriptionUid}/change instead.
+            
+Returns the new subscription; its StartDate is when the change takes effect. When only add-ons
 change, returns the existing subscription.
             
 A change of plan, BillingRenewalTerm or quantity ends the current subscription and creates a new

package/src/generated/billing-v3/billing-v3.ts

@@ -167,7 +167,9 @@ export function useStripeInvoiceLineItemsGetAll<TData = Awaited<ReturnType<typeo
 
 
 /**
- * Access ends now. This sets the line item's EndDate and updates the account's products
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
+            
+Access ends now. This sets the line item's EndDate and updates the account's products
 and stage. The invoice is not changed.
  * @summary End the product access that a line item gives.
  */
@@ -577,7 +579,10 @@ export function useStripePromotionCodesGetAll<TData = Awaited<ReturnType<typeof
 
 
 /**
- * A promotion code belongs to a coupon. The code is also created in the connected Stripe
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected;
+use POST /billing/discountcoupons instead.
+            
+A promotion code belongs to a coupon. The code is also created in the connected Stripe
 account.
  * @summary Add a new promotion code.
  */
@@ -711,7 +716,9 @@ export function useStripePromotionCodesGet<TData = Awaited<ReturnType<typeof str
 
 
 /**
- * The code can no longer be redeemed. It is also ended in the connected Stripe account.
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
+            
+The code can no longer be redeemed. It is also ended in the connected Stripe account.
 No other change is made. The promotion code to end is identified by the Uid in the
 request body.
  * @summary End a promotion code.
@@ -919,7 +926,10 @@ export function useStripeProductFamiliesGetAll<TData = Awaited<ReturnType<typeof
 
 
 /**
- * A product added to this family is removed from any other family.
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected;
+use POST /billing/planfamilies instead.
+            
+A product added to this family is removed from any other family.
  * @summary Add a new product family.
  */
 export const stripeProductFamiliesPost = (
@@ -1052,7 +1062,10 @@ export function useStripeProductFamiliesGet<TData = Awaited<ReturnType<typeof st
 
 
 /**
- * A product added to this family is removed from any other family.
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected;
+use PUT /billing/planfamilies/{planFamilyUid} instead.
+            
+A product added to this family is removed from any other family.
  * @summary Update a product family.
  */
 export const stripeProductFamiliesPut = (
@@ -1248,7 +1261,10 @@ export function useStripeCouponsGetAll<TData = Awaited<ReturnType<typeof stripeC
 
 
 /**
- * Set exactly one of PercentOff or CurrencyAmountOff. The coupon is also created in the
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected;
+use POST /billing/discountcoupons instead.
+            
+Set exactly one of PercentOff or CurrencyAmountOff. The coupon is also created in the
 connected Stripe account.
  * @summary Add a new coupon.
  */
@@ -1521,6 +1537,7 @@ export function useStripeCouponsGetRedemptions<TData = Awaited<ReturnType<typeof
 
 
 /**
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
  * @summary Import all coupons and promotion codes from the connected Stripe account.
  */
 export const stripeCouponsSyncCouponsFromStripe = (
@@ -1583,6 +1600,7 @@ export const useStripeCouponsSyncCouponsFromStripe = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
  * @summary Import a coupon from the connected Stripe account.
  */
 export const stripeCouponsSyncCouponFromStripe = (
@@ -1718,7 +1736,10 @@ export function useStripeInvoicesGetAll<TData = Awaited<ReturnType<typeof stripe
 
 
 /**
- * The invoice is created for an account, and also in the connected Stripe account.
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected;
+use POST /billing/invoices instead.
+            
+The invoice is created for an account, and also in the connected Stripe account.
  * @summary Add a new invoice.
  */
 export const stripeInvoicesPost = (
@@ -1922,7 +1943,9 @@ export function useStripeInvoicesGetInvoiceAsPdf<TData = Awaited<ReturnType<type
 
 
 /**
- * NewStatus is one of paid (paid outside Stripe), uncollectible or void. The change is
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
+            
+NewStatus is one of paid (paid outside Stripe), uncollectible or void. The change is
 also made in the connected Stripe account.
  * @summary Change the status of an invoice.
  */
@@ -1990,7 +2013,9 @@ export const useStripeInvoicesChangeInvoiceStatus = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * CreditType is one of account_balance, payment_method (refund to the payment method) or
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
+            
+CreditType is one of account_balance, payment_method (refund to the payment method) or
 out_of_band. The credit note is created in the connected Stripe account.
  * @summary Issue a credit note against an invoice.
  */
@@ -2058,6 +2083,7 @@ export const useStripeInvoicesIssueInvoiceCredit = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
  * @summary Email an invoice to the account.
  */
 export const stripeInvoicesSendInvoiceEmail = (
@@ -2121,6 +2147,7 @@ export const useStripeInvoicesSendInvoiceEmail = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
  * @summary Import all invoices from the connected Stripe account.
  */
 export const stripeInvoicesSyncInvoicesFromStripe = (
@@ -2252,7 +2279,10 @@ export function useStripeSubscriptionsGetAll<TData = Awaited<ReturnType<typeof s
 
 
 /**
- * The subscription is created for an account, and also in the connected Stripe account.
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected;
+use PUT /billing/subscriptions/firsttimesubscription instead.
+            
+The subscription is created for an account, and also in the connected Stripe account.
 Identify each item's StripePrice by Uid or StripeId. A discount can name a
 StripePromotionCode, or a StripeCoupon, in which case the first promotion code of
 that coupon that the account can redeem is used.
@@ -2320,7 +2350,9 @@ export const useStripeSubscriptionsCreate = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * By default the subscription ends at the end of the current billing period. Pass
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
+            
+By default the subscription ends at the end of the current billing period. Pass
 cancelImmediately=true in the query string to end it now.
  * @summary Cancel a subscription.
  */
@@ -2384,7 +2416,9 @@ export const useStripeSubscriptionsCancel = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * Behavior is one of Stripe's pause_collection behaviors: keep_as_draft,
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
+            
+Behavior is one of Stripe's pause_collection behaviors: keep_as_draft,
 mark_uncollectible or void. ResumesAt is optional; without it, collection stays paused
 until resumed.
  * @summary Pause payment collection on a subscription.
@@ -2452,7 +2486,10 @@ export const useStripeSubscriptionsPauseCollection = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * Use this, for example, to move a subscription to another price. Identify each item's
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected;
+use PUT /billing/subscriptions/{subscriptionUid}/changesubscription instead.
+            
+Use this, for example, to move a subscription to another price. Identify each item's
 StripePrice by Uid or StripeId. A user token can only change a subscription on its own
 account, and only as the account's primary contact.
  * @summary Change the items of a subscription.
@@ -2588,7 +2625,9 @@ export const useStripeSubscriptionsPreviewChange = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * This sets the subscription's trial end to ToDate, without proration.
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
+            
+This sets the subscription's trial end to ToDate, without proration.
  * @summary Extend the date of a subscription's next invoice.
  */
 export const stripeSubscriptionsExtendTrial = (
@@ -2654,7 +2693,9 @@ export const useStripeSubscriptionsExtendTrial = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * The scheduled changes no longer happen, and the subscription keeps its current items.
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
+            
+The scheduled changes no longer happen, and the subscription keeps its current items.
 Nothing happens when there is no active schedule.
  * @summary Release a subscription's active schedule.
  */
@@ -2718,6 +2759,7 @@ export const useStripeSubscriptionsReleaseSchedule = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
  * @summary Resume payment collection on a paused subscription.
  */
 export const stripeSubscriptionsResumeCollection = (
@@ -2780,7 +2822,9 @@ export const useStripeSubscriptionsResumeCollection = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * The trial ends now, so that the subscription starts and is invoiced.
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
+            
+The trial ends now, so that the subscription starts and is invoiced.
  * @summary Start a trialing subscription.
  */
 export const stripeSubscriptionsStart = (
@@ -2843,7 +2887,9 @@ export const useStripeSubscriptionsStart = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * Pass productUid in the query string to import only the subscriptions to that
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
+            
+Pass productUid in the query string to import only the subscriptions to that
 product's prices. The response is an import result wrapped in a Count property.
  * @summary Import subscriptions from the connected Stripe account.
  */
@@ -2908,7 +2954,9 @@ export const useStripeSubscriptionsSyncSubscriptionsFromStripe = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * A subscription set to end at the end of its billing period renews instead.
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
+            
+A subscription set to end at the end of its billing period renews instead.
  * @summary Remove a subscription's pending cancellation.
  */
 export const stripeSubscriptionsUncancel = (
@@ -3040,7 +3088,10 @@ export function useStripeProductsGetAll<TData = Awaited<ReturnType<typeof stripe
 
 
 /**
- * The product is also created in the connected Stripe account.
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected;
+use POST /billing/plans or POST /billing/addons instead.
+            
+The product is also created in the connected Stripe account.
  * @summary Add a new product.
  */
 export const stripeProductsPost = (
@@ -3105,6 +3156,7 @@ export const useStripeProductsPost = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
  * @summary Import all products and their prices from the connected Stripe account.
  */
 export const stripeProductsSyncProductsFromStripe = (
@@ -3235,7 +3287,10 @@ export function useStripeProductsGet<TData = Awaited<ReturnType<typeof stripePro
 
 
 /**
- * The changes are also sent to the connected Stripe account.
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected;
+use PUT /billing/plans/{planUid} or PUT /billing/addons/{addOnUid} instead.
+            
+The changes are also sent to the connected Stripe account.
  * @summary Update a product.
  */
 export const stripeProductsPut = (
@@ -3300,6 +3355,7 @@ export const useStripeProductsPut = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
+ * Applies to Stripe Billing (v3) only. With Outseta billing (v2) the request is rejected.
  * @summary Import a product and its prices from the connected Stripe account.
  */
 export const stripeProductsSyncProductFromStripe = (

package/src/generated/outsetaAPI.schemas.ts

@@ -821,6 +821,8 @@ export type StripeInvoiceAllOf = {
   /** @nullable */
   CustomerId?: string | null;
   /** @nullable */
+  EffectiveDate?: string | null;
+  /** @nullable */
   PaymentStatus?: string | null;
   /** @nullable */
   StripeCreditNotes?: StripeCreditNote[] | null;
@@ -1405,6 +1407,12 @@ export type StripeProductFamilyAllOf = {
   IsActive?: boolean;
   IsDefault?: boolean;
   /** @nullable */
+  BillingCycleAnchorDayOfMonth?: number | null;
+  /** @nullable */
+  BillingCycleAnchorHour?: number | null;
+  /** @nullable */
+  BillingCycleAnchorMonth?: number | null;
+  /** @nullable */
   StripeProducts?: StripeProduct[] | null;
   [key: string]: unknown | null;
 };
@@ -1503,6 +1511,8 @@ export type StripeSubscriptionAllOf = {
   /** @nullable */
   ApplicationFeePercent?: number | null;
   /** @nullable */
+  BillingCycleAnchor?: string | null;
+  /** @nullable */
   CancelAt?: string | null;
   CancelAtPeriodEnd?: boolean;
   /** @nullable */
@@ -1540,14 +1550,14 @@ export type StripeSubscriptionAllOf = {
   /** @nullable */
   AccountUid?: string | null;
   /** @nullable */
-  BillingCycleAnchor?: string | null;
-  /** @nullable */
   CollectionMethod?: string | null;
   /** @nullable */
   CustomerId?: string | null;
   /** @nullable */
   DaysUntilDue?: number | null;
   /** @nullable */
+  PaymentUrl?: string | null;
+  /** @nullable */
   ScheduleId?: string | null;
   /** @nullable */
   StripeDiscountIds?: string[] | null;
@@ -3555,6 +3565,11 @@ export const QcountConfigSettingType = {
   StripeMigration_LastPreCutoverExportSubscriptionId: 579,
 } as const;
 
+export interface TeamTwoFactorSettings {
+  Enabled?: boolean;
+  Required?: boolean;
+}
+
 export type DiscordServerAllOf = {
   /**
    * @maxLength 250
@@ -5728,6 +5743,8 @@ export type AccountWebhookEntityStripeInvoicesItem = {
   /** @nullable */
   CustomerId?: string | null;
   /** @nullable */
+  EffectiveDate?: string | null;
+  /** @nullable */
   PaymentStatus?: string | null;
   /** @nullable */
   StripePaymentMethodId?: string | null;
@@ -5790,6 +5807,8 @@ export type AccountWebhookEntityStripeSubscriptionsItem = {
   /** @nullable */
   ApplicationFeePercent?: number | null;
   /** @nullable */
+  BillingCycleAnchor?: string | null;
+  /** @nullable */
   CancelAt?: string | null;
   CancelAtPeriodEnd?: boolean;
   /**
@@ -5817,14 +5836,14 @@ export type AccountWebhookEntityStripeSubscriptionsItem = {
   /** @nullable */
   AccountUid?: string | null;
   /** @nullable */
-  BillingCycleAnchor?: string | null;
-  /** @nullable */
   CollectionMethod?: string | null;
   /** @nullable */
   CustomerId?: string | null;
   /** @nullable */
   DaysUntilDue?: number | null;
   /** @nullable */
+  PaymentUrl?: string | null;
+  /** @nullable */
   ScheduleId?: string | null;
   /** @nullable */
   StripeDiscountIds?: string[] | null;
@@ -7543,6 +7562,8 @@ export type AccountWebhookEntityPrimaryStripeSubscription = {
   /** @nullable */
   ApplicationFeePercent?: number | null;
   /** @nullable */
+  BillingCycleAnchor?: string | null;
+  /** @nullable */
   CancelAt?: string | null;
   CancelAtPeriodEnd?: boolean;
   /**
@@ -7570,14 +7591,14 @@ export type AccountWebhookEntityPrimaryStripeSubscription = {
   /** @nullable */
   AccountUid?: string | null;
   /** @nullable */
-  BillingCycleAnchor?: string | null;
-  /** @nullable */
   CollectionMethod?: string | null;
   /** @nullable */
   CustomerId?: string | null;
   /** @nullable */
   DaysUntilDue?: number | null;
   /** @nullable */
+  PaymentUrl?: string | null;
+  /** @nullable */
   ScheduleId?: string | null;
   /** @nullable */
   StripeDiscountIds?: string[] | null;