@outseta/api-client 0.3.24 → 0.3.26

package/package.json

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

package/src/generated/models/campaignGetAllBroadcastEmailsParams.ts

@@ -4,11 +4,11 @@ import type { OffsetParameter } from './offsetParameter';
 
 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;
 };

package/src/generated/models/categoryGetAllCategoriesParams.ts

@@ -4,11 +4,11 @@ import type { OffsetParameter } from './offsetParameter';
 
 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;
 };

package/src/generated/models/definitionGetAllDefinitionsParams.ts

@@ -4,11 +4,11 @@ import type { OffsetParameter } from './offsetParameter';
 
 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;
 };

package/src/generated/models/dripCampaignGetAllDripCampaignsParams.ts

@@ -4,11 +4,11 @@ import type { OffsetParameter } from './offsetParameter';
 
 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;
 };

package/src/generated/models/index.ts

@@ -536,6 +536,7 @@ export * from './planWebhookEntityPlanAddOnsItemAddOn';
 export * from './planWebhookEntityPlanAddOnsItemAddOnBillingAddOnType';
 export * from './planWebhookEntityPlanFamily';
 export * from './processCodePayload';
+export * from './publicEmailListAddSubscriptionBody';
 export * from './qcount';
 export * from './qcountAllOf';
 export * from './qcountConfig';

package/src/generated/models/invoiceGetAllInvoicesParams.ts

@@ -4,11 +4,11 @@ import type { OffsetParameter } from './offsetParameter';
 
 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;
 /**

package/src/generated/models/limitParameter.ts

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

package/src/generated/models/offsetParameter.ts

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

package/src/generated/models/planFamilyGetAllPlanFamiliesParams.ts

@@ -4,11 +4,11 @@ import type { OffsetParameter } from './offsetParameter';
 
 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/models/planGetAllPlansParams.ts

@@ -4,11 +4,11 @@ import type { OffsetParameter } from './offsetParameter';
 
 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;
 };

package/src/generated/models/publicEmailListAddSubscriptionBody.ts

@@ -0,0 +1,7 @@
+// @ts-nocheck
+import type { EmailListPerson } from './emailListPerson';
+
+/**
+ * @nullable
+ */
+export type PublicEmailListAddSubscriptionBody = EmailListPerson | null;

package/src/generated/models/stripePriceAllOf.ts

@@ -13,6 +13,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
@@ -40,6 +46,11 @@ export type StripePriceAllOf = {
    * @nullable
    */
   TaxBehavior?: string | null;
+  /**
+   * @maxLength 36
+   * @nullable
+   */
+  TiersMode?: string | null;
   /** @nullable */
   TransformQuantity_DivideBy?: number | null;
   /**

package/src/generated/models/transactionsGetAllTransactionsByAccountIdParams.ts

@@ -4,11 +4,11 @@ import type { OffsetParameter } from './offsetParameter';
 
 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;
 };

package/src/generated/public/public.ts

@@ -4,6 +4,7 @@ import type {
   AuthResendTwoFactorParams,
   AuthSwitchTwoFactorMechanismParams,
   AuthVerifyTwoFactorRecoveryParams,
+  PublicEmailListAddSubscriptionBody,
   TokenPayload,
   TokenTwoFactorEnrollmentBeginEmailParams,
   TokenTwoFactorEnrollmentBeginTotpParams,
@@ -17,6 +18,84 @@ import type {
 
 import { customFetch } from '../../client';
 
+// 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>;
+
+
+/**
+ * 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 type publicEmailListAddSubscriptionResponse200 = {
+  data: Blob
+  status: 200
+}
+
+export type publicEmailListAddSubscriptionResponse400 = {
+  data: void
+  status: 400
+}
+
+export type publicEmailListAddSubscriptionResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type publicEmailListAddSubscriptionResponseSuccess = (publicEmailListAddSubscriptionResponse200) & {
+  headers: Headers;
+};
+export type publicEmailListAddSubscriptionResponseError = (publicEmailListAddSubscriptionResponse400 | publicEmailListAddSubscriptionResponse404) & {
+  headers: Headers;
+};
+
+export type publicEmailListAddSubscriptionResponse = (publicEmailListAddSubscriptionResponseSuccess | publicEmailListAddSubscriptionResponseError)
+
+export const getPublicEmailListAddSubscriptionUrl = (emailListUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/public/email/lists/${emailListUid}/subscriptions`
+}
+
+export const publicEmailListAddSubscription = async (emailListUid: string | null,
+    publicEmailListAddSubscriptionBody: NonReadonly<PublicEmailListAddSubscriptionBody>, options?: RequestInit): Promise<publicEmailListAddSubscriptionResponse> => {
+  
+  return customFetch<publicEmailListAddSubscriptionResponse>(getPublicEmailListAddSubscriptionUrl(emailListUid),
+  {      
+    ...options,
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      publicEmailListAddSubscriptionBody,)
+  }
+);}
+
+
 /**
  * Authenticates a user and returns a JWT access token (plus a refresh token).