@outseta/react 0.2.0 → 0.2.1

package/src/generated/email/email.ts

@@ -0,0 +1,992 @@
+// @ts-nocheck
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * Outseta API
+ * # Outseta REST API
+
+The Outseta REST API enables you to perform a variety of powerful tasks such as creating and updating people, accounts, subscriptions, and invoices. Outseta uses standard HTTP protocols within a compliant architecture that is simple to integrate. You can use the API both on the client or the server side; see the authentication section below for each scenario.
+
+**Base URL:** `https://{your-domain}.outseta.com/api/v1/`
+
+## API Guidelines
+
+1. The API will only respond to secured communication done over **HTTPS**. HTTP requests will be sent a `301` redirect to the corresponding HTTPS resource.
+2. Responses are sent in **JSON** format. In case the API request results in an error, it is represented by an `"error": {}` key in the JSON response.
+3. The request method (verb) determines the nature of the action: **GET** fetches data, **POST** creates new records, **PUT** updates existing records.
+4. The API responds with appropriate **HTTP status codes** for all requests.
+5. Use `donotlog=1` as a query parameter on any API call where you don't want the action to be logged in the activity log.
+
+## Authentication
+
+All API requests require authentication via one of two methods:
+
+### Server-Side (API Keys)
+
+Use API keys for server-to-server integrations. Create keys at **Settings > Integrations > API Keys**. Make sure to record the secret key when you create it.
+
+```
+Authorization: Outseta {api_key}:{api_secret}
+```
+
+**Example:**
+```
+Authorization: Outseta ce08fd5a-e1ee-4472-9c5f-b7575d8369b2:74fc1d2242a4eb7336d34b0e40cfbc5f
+```
+
+> **Warning:** Never expose API keys in client-side code. The API key and secret combined give full access to all data in your account.
+
+### Client-Side (Bearer Token)
+
+Do **not** use API keys on the client side — they can be easily copied. Instead, obtain a JWT access token by calling the `POST /tokens` endpoint from the server side with your credentials, then use it on the client:
+
+```
+Authorization: bearer {access_token}
+```
+
+Tokens are JWTs containing claims such as `PersonUid`, `AccountUid`, and subscription details. Tokens expire after approximately one year.
+
+Verify tokens server-side using Outseta's [JWKS endpoint](https://{your-domain}.outseta.com/.well-known/jwks.json).
+
+## Field Selection
+
+When you make an API request, you'll automatically get all the basic information from the main object and its immediate child objects. Referenced objects beyond the first level are returned as `null`.
+
+Change this behavior using the `fields` query parameter:
+
+- **Go deeper** — Request fields lower down in the object tree: `?fields=CurrentSubscription.Plan.*`
+- **Go lighter** — Request only the essentials for faster performance: `?fields=Uid,Name`
+- **Combination** — `?fields=Uid,Name,CurrentSubscription.Plan.Uid`
+- **Wildcard** — Use `*` to get all fields in an object: `?fields=*` or `?fields=CurrentSubscription.Plan.*`
+
+> **Tip:** When expanding nested paths, include `*` and intermediate path segments (e.g., `PersonAccount.*`) to preserve root-level and intermediate fields.
+
+**Examples:**
+
+```
+# Get the current subscription plan UID for an account
+GET /crm/accounts/{uid}?fields=CurrentSubscription.Plan.Uid
+
+# Get the account UID and plan UID for a list of accounts
+GET /crm/accounts?fields=Uid,CurrentSubscription.Plan.Uid
+
+# Get the full plan object for an account's current subscription
+GET /crm/accounts/{uid}?fields=CurrentSubscription.Plan.*
+
+# Get a person with their account and subscription info
+GET /crm/people/{uid}?fields=Uid,PersonAccount.Account.CurrentSubscription.Plan.Uid
+```
+
+If your request includes fields from a child object you will be limited to retrieving **25 items** per page. The maximum for requests not expanding child object fields is **100 items**.
+
+## Pagination
+
+List endpoints return paginated results with a `metadata` object and an `items` array:
+
+```json
+{
+  "metadata": {
+    "limit": 25,
+    "offset": 0,
+    "total": 142
+  },
+  "items": [ ... ]
+}
+```
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `offset` | integer | `0` | Page number (zero-based) |
+| `limit` | integer | `25` | Maximum number of records per page |
+
+**Examples:**
+```
+?offset=0&limit=20    # returns results 1-20
+?offset=1&limit=20    # returns results 21-40
+```
+
+## Sorting
+
+Sort results using the `orderBy` parameter with a property name and direction:
+
+```
+?orderBy=PropertyName+DESC
+```
+
+## Filtering
+
+Filter results by passing entity properties as query parameters.
+
+### Basic Filtering
+
+Filter on any field using the field name as a query parameter:
+
+```
+GET /crm/people?Email=john@example.com
+GET /crm/accounts?AccountStage=2
+```
+
+### Wildcard Matching
+
+| Pattern | Match Type | Example |
+|---------|-----------|---------|
+| `*value` | Ends with | `?Email=*@example.com` |
+| `value*` | Starts with | `?Name=Acme*` |
+| `*value*` | Contains | `?Name=*corp*` |
+
+### Comparison Operators
+
+For advanced filtering, append comparison operators to field names:
+
+| Operator | Description | Example |
+|----------|-------------|---------|
+| `__gt` | Greater than | `Created__gt=2024-01-01` |
+| `__gte` | Greater than or equal | `Amount__gte=100` |
+| `__lt` | Less than | `Created__lt=2024-12-31` |
+| `__lte` | Less than or equal | `Amount__lte=500` |
+| `__ne` | Not equal | `Status__ne=Active` |
+| `__isnull` | Is null (true/false) | `ProfileImageS3Url__isnull=true` |
+
+**Examples:**
+
+```
+# Date filtering
+GET /crm/accounts?Created__gt=2024-01-01
+GET /billing/subscriptions?EndDate__lt=2024-08-01
+
+# Numeric filtering
+GET /billing/invoices?Amount__gte=1000
+
+# Null value filtering
+GET /crm/people?ProfileImageS3Url__isnull=true
+
+# Multiple filters combined with field selection
+GET /billing/subscriptions?StartDate__gte=2024-01-01&Rate__lt=100&DiscountCode__isnull=false&fields=Uid,Amount,StartDate,DiscountCode,Plan.Name
+```
+
+## Account Billing Stages
+
+Account stages reflect the financial standing of each account and are not directly editable — they change automatically based on subscription activity.
+
+| Value | Stage | Description |
+|-------|-------|-------------|
+| `2` | Trialing | Currently on a free trial or free plan |
+| `3` | Subscribing | Active paid subscription (contributes to MRR) |
+| `4` | Canceling | Customer has indicated intent to cancel |
+| `5` | Expired | Subscription has ended after cancellation |
+| `6` | Trial Expired | Free trial ended without conversion to paid |
+
+Filter by stage: `GET /crm/accounts?AccountStage=3` returns all actively subscribing accounts.
+
+## Webhooks
+
+Use **Activity Notifications** to receive real-time callbacks when events occur in Outseta. Configure webhooks at **Settings > Notifications**.
+
+Common events include:
+- `Person Created` / `Person Updated`
+- `Account Created` / `Account Updated`
+- `Subscription Created` / `Subscription Updated`
+
+Always verify webhook signatures using the SHA256 secret provided in the Outseta dashboard.
+
+## Error Responses
+
+| Status Code | Description |
+|-------------|-------------|
+| `200` | Success |
+| `301` | Redirect — HTTP requests are redirected to HTTPS |
+| `400` | Bad request — invalid parameters or Uid format |
+| `401` | Unauthorized — missing or invalid authentication |
+| `404` | Entity not found |
+| `4XX` / `5XX` | Client or server error |
+
+Validation errors return a JSON body with `ErrorMessage` and `PropertyName` fields:
+
+```json
+{
+  "ErrorMessage": "Invalid company email",
+  "PropertyName": "Email"
+}
+```
+
+## Rate Limits
+
+Requests authorized by an API Key should not exceed **4 requests/second**.
+
+## Support
+
+For help regarding the Outseta API please email [support@outseta.com](mailto:support@outseta.com).
+
+ * OpenAPI spec version: v1
+ */
+import {
+  useMutation,
+  useQuery
+} from '@tanstack/react-query';
+import type {
+  MutationFunction,
+  QueryFunction,
+  QueryKey,
+  UseMutationOptions,
+  UseMutationResult,
+  UseQueryOptions,
+  UseQueryResult
+} from '@tanstack/react-query';
+
+import type {
+  BroadcastCampaign,
+  CampaignAddBroadcastEmailBody,
+  CampaignSendTestCampaignEmailBody,
+  CampaignUpdateBroadcastEmailBody,
+  EmailListAddSubscriptionBody,
+  EmailListGetAllSubscriptionsParams,
+  EmailListPerson
+} from '../outsetaAPI.schemas';
+
+import { customFetch } from '../../mutator';
+
+
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
+
+
+
+/**
+ * @summary Retrieves all non-archived broadcast campaigns.
+ */
+export const campaignGetAllBroadcastEmails = (
+    
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<BroadcastCampaign[]>(
+      {url: `/api/v1/email/campaigns/broadcasts`, method: 'GET', signal
+    },
+      options);
+    }
+  
+
+
+
+export const getCampaignGetAllBroadcastEmailsQueryKey = () => {
+    return [
+    `/api/v1/email/campaigns/broadcasts`
+    ] as const;
+    }
+
+    
+export const getCampaignGetAllBroadcastEmailsQueryOptions = <TData = Awaited<ReturnType<typeof campaignGetAllBroadcastEmails>>, TError = void>( options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof campaignGetAllBroadcastEmails>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getCampaignGetAllBroadcastEmailsQueryKey();
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof campaignGetAllBroadcastEmails>>> = ({ signal }) => campaignGetAllBroadcastEmails(requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof campaignGetAllBroadcastEmails>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type CampaignGetAllBroadcastEmailsQueryResult = NonNullable<Awaited<ReturnType<typeof campaignGetAllBroadcastEmails>>>
+export type CampaignGetAllBroadcastEmailsQueryError = void
+
+
+/**
+ * @summary Retrieves all non-archived broadcast campaigns.
+ */
+
+export function useCampaignGetAllBroadcastEmails<TData = Awaited<ReturnType<typeof campaignGetAllBroadcastEmails>>, TError = void>(
+  options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof campaignGetAllBroadcastEmails>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+  
+ ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } {
+
+  const queryOptions = getCampaignGetAllBroadcastEmailsQueryOptions(options)
+
+  const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
+
+/**
+ * @summary Creates a new broadcast campaign. To copy an existing broadcast, retrieve it and pass its
+data as the request body — the Uid, SendDateTime, and message counts are automatically reset.
+Recipients can be specified using EmailListUids and SegmentUids instead of populating
+RecipientData directly. If both are provided, they are merged.
+ */
+export const campaignAddBroadcastEmail = (
+    campaignAddBroadcastEmailBody: CampaignAddBroadcastEmailBody,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<BroadcastCampaign>(
+      {url: `/api/v1/email/campaigns/broadcasts`, method: 'POST',
+      headers: {'Content-Type': 'application/json', },
+      data: campaignAddBroadcastEmailBody, signal
+    },
+      options);
+    }
+  
+
+
+export const getCampaignAddBroadcastEmailMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignAddBroadcastEmail>>, TError,{data: CampaignAddBroadcastEmailBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof campaignAddBroadcastEmail>>, TError,{data: CampaignAddBroadcastEmailBody}, TContext> => {
+
+const mutationKey = ['campaignAddBroadcastEmail'];
+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 campaignAddBroadcastEmail>>, {data: CampaignAddBroadcastEmailBody}> = (props) => {
+          const {data} = props ?? {};
+
+          return  campaignAddBroadcastEmail(data,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type CampaignAddBroadcastEmailMutationResult = NonNullable<Awaited<ReturnType<typeof campaignAddBroadcastEmail>>>
+    export type CampaignAddBroadcastEmailMutationBody = CampaignAddBroadcastEmailBody
+    export type CampaignAddBroadcastEmailMutationError = void
+
+    /**
+ * @summary Creates a new broadcast campaign. To copy an existing broadcast, retrieve it and pass its
+data as the request body — the Uid, SendDateTime, and message counts are automatically reset.
+Recipients can be specified using EmailListUids and SegmentUids instead of populating
+RecipientData directly. If both are provided, they are merged.
+ */
+export const useCampaignAddBroadcastEmail = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignAddBroadcastEmail>>, TError,{data: CampaignAddBroadcastEmailBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof campaignAddBroadcastEmail>>,
+        TError,
+        {data: CampaignAddBroadcastEmailBody},
+        TContext
+      > => {
+
+      const mutationOptions = getCampaignAddBroadcastEmailMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Retrieves a single broadcast campaign by its Uid.
+ */
+export const campaignGetBroadcastEmail = (
+    broadcastCampaignUid: string | null,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<BroadcastCampaign>(
+      {url: `/api/v1/email/campaigns/broadcasts/${broadcastCampaignUid}`, method: 'GET', signal
+    },
+      options);
+    }
+  
+
+
+
+export const getCampaignGetBroadcastEmailQueryKey = (broadcastCampaignUid?: string | null,) => {
+    return [
+    `/api/v1/email/campaigns/broadcasts/${broadcastCampaignUid}`
+    ] as const;
+    }
+
+    
+export const getCampaignGetBroadcastEmailQueryOptions = <TData = Awaited<ReturnType<typeof campaignGetBroadcastEmail>>, TError = void>(broadcastCampaignUid: string | null, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof campaignGetBroadcastEmail>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getCampaignGetBroadcastEmailQueryKey(broadcastCampaignUid);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof campaignGetBroadcastEmail>>> = ({ signal }) => campaignGetBroadcastEmail(broadcastCampaignUid, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, enabled: !!(broadcastCampaignUid), ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof campaignGetBroadcastEmail>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type CampaignGetBroadcastEmailQueryResult = NonNullable<Awaited<ReturnType<typeof campaignGetBroadcastEmail>>>
+export type CampaignGetBroadcastEmailQueryError = void
+
+
+/**
+ * @summary Retrieves a single broadcast campaign by its Uid.
+ */
+
+export function useCampaignGetBroadcastEmail<TData = Awaited<ReturnType<typeof campaignGetBroadcastEmail>>, TError = void>(
+ broadcastCampaignUid: string | null, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof campaignGetBroadcastEmail>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+  
+ ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } {
+
+  const queryOptions = getCampaignGetBroadcastEmailQueryOptions(broadcastCampaignUid,options)
+
+  const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
+
+/**
+ * @summary Updates a broadcast campaign. Setting SendDateTime to a future date schedules the broadcast
+for sending and its status changes to Pending. Clearing SendDateTime unschedules the broadcast.
+Recipients can be specified using EmailListUids and SegmentUids instead of populating
+RecipientData directly. If both are provided, they are merged.
+ */
+export const campaignUpdateBroadcastEmail = (
+    broadcastCampaignUid: string | null,
+    campaignUpdateBroadcastEmailBody: CampaignUpdateBroadcastEmailBody,
+ options?: SecondParameter<typeof customFetch>,) => {
+      
+      
+      return customFetch<BroadcastCampaign>(
+      {url: `/api/v1/email/campaigns/broadcasts/${broadcastCampaignUid}`, method: 'PUT',
+      headers: {'Content-Type': 'application/json', },
+      data: campaignUpdateBroadcastEmailBody
+    },
+      options);
+    }
+  
+
+
+export const getCampaignUpdateBroadcastEmailMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignUpdateBroadcastEmail>>, TError,{broadcastCampaignUid: string | null;data: CampaignUpdateBroadcastEmailBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof campaignUpdateBroadcastEmail>>, TError,{broadcastCampaignUid: string | null;data: CampaignUpdateBroadcastEmailBody}, TContext> => {
+
+const mutationKey = ['campaignUpdateBroadcastEmail'];
+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 campaignUpdateBroadcastEmail>>, {broadcastCampaignUid: string | null;data: CampaignUpdateBroadcastEmailBody}> = (props) => {
+          const {broadcastCampaignUid,data} = props ?? {};
+
+          return  campaignUpdateBroadcastEmail(broadcastCampaignUid,data,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type CampaignUpdateBroadcastEmailMutationResult = NonNullable<Awaited<ReturnType<typeof campaignUpdateBroadcastEmail>>>
+    export type CampaignUpdateBroadcastEmailMutationBody = CampaignUpdateBroadcastEmailBody
+    export type CampaignUpdateBroadcastEmailMutationError = void
+
+    /**
+ * @summary Updates a broadcast campaign. Setting SendDateTime to a future date schedules the broadcast
+for sending and its status changes to Pending. Clearing SendDateTime unschedules the broadcast.
+Recipients can be specified using EmailListUids and SegmentUids instead of populating
+RecipientData directly. If both are provided, they are merged.
+ */
+export const useCampaignUpdateBroadcastEmail = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignUpdateBroadcastEmail>>, TError,{broadcastCampaignUid: string | null;data: CampaignUpdateBroadcastEmailBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof campaignUpdateBroadcastEmail>>,
+        TError,
+        {broadcastCampaignUid: string | null;data: CampaignUpdateBroadcastEmailBody},
+        TContext
+      > => {
+
+      const mutationOptions = getCampaignUpdateBroadcastEmailMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Deletes a broadcast campaign. Only campaigns in Draft or Pending status can be deleted.
+Campaigns that have been processed should be archived instead.
+ */
+export const campaignDeleteBroadcastCampaign = (
+    broadcastCampaignUid: string | null,
+ options?: SecondParameter<typeof customFetch>,) => {
+      
+      
+      return customFetch<Blob>(
+      {url: `/api/v1/email/campaigns/broadcasts/${broadcastCampaignUid}`, method: 'DELETE',
+        responseType: 'blob'
+    },
+      options);
+    }
+  
+
+
+export const getCampaignDeleteBroadcastCampaignMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignDeleteBroadcastCampaign>>, TError,{broadcastCampaignUid: string | null}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof campaignDeleteBroadcastCampaign>>, TError,{broadcastCampaignUid: string | null}, TContext> => {
+
+const mutationKey = ['campaignDeleteBroadcastCampaign'];
+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 campaignDeleteBroadcastCampaign>>, {broadcastCampaignUid: string | null}> = (props) => {
+          const {broadcastCampaignUid} = props ?? {};
+
+          return  campaignDeleteBroadcastCampaign(broadcastCampaignUid,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type CampaignDeleteBroadcastCampaignMutationResult = NonNullable<Awaited<ReturnType<typeof campaignDeleteBroadcastCampaign>>>
+    
+    export type CampaignDeleteBroadcastCampaignMutationError = void
+
+    /**
+ * @summary Deletes a broadcast campaign. Only campaigns in Draft or Pending status can be deleted.
+Campaigns that have been processed should be archived instead.
+ */
+export const useCampaignDeleteBroadcastCampaign = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignDeleteBroadcastCampaign>>, TError,{broadcastCampaignUid: string | null}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof campaignDeleteBroadcastCampaign>>,
+        TError,
+        {broadcastCampaignUid: string | null},
+        TContext
+      > => {
+
+      const mutationOptions = getCampaignDeleteBroadcastCampaignMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Unschedules a pending broadcast campaign, reverting its status to Draft.
+ */
+export const campaignUnscheduleBroadcastEmail = (
+    broadcastCampaignUid: string | null,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<BroadcastCampaign>(
+      {url: `/api/v1/email/campaigns/broadcasts/${broadcastCampaignUid}/unschedule`, method: 'POST', signal
+    },
+      options);
+    }
+  
+
+
+export const getCampaignUnscheduleBroadcastEmailMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignUnscheduleBroadcastEmail>>, TError,{broadcastCampaignUid: string | null}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof campaignUnscheduleBroadcastEmail>>, TError,{broadcastCampaignUid: string | null}, TContext> => {
+
+const mutationKey = ['campaignUnscheduleBroadcastEmail'];
+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 campaignUnscheduleBroadcastEmail>>, {broadcastCampaignUid: string | null}> = (props) => {
+          const {broadcastCampaignUid} = props ?? {};
+
+          return  campaignUnscheduleBroadcastEmail(broadcastCampaignUid,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type CampaignUnscheduleBroadcastEmailMutationResult = NonNullable<Awaited<ReturnType<typeof campaignUnscheduleBroadcastEmail>>>
+    
+    export type CampaignUnscheduleBroadcastEmailMutationError = void
+
+    /**
+ * @summary Unschedules a pending broadcast campaign, reverting its status to Draft.
+ */
+export const useCampaignUnscheduleBroadcastEmail = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignUnscheduleBroadcastEmail>>, TError,{broadcastCampaignUid: string | null}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof campaignUnscheduleBroadcastEmail>>,
+        TError,
+        {broadcastCampaignUid: string | null},
+        TContext
+      > => {
+
+      const mutationOptions = getCampaignUnscheduleBroadcastEmailMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Archives a broadcast campaign. Archived campaigns are excluded from the default list results.
+ */
+export const campaignArchiveBroadcastCampaign = (
+    broadcastCampaignUid: string | null,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<Blob>(
+      {url: `/api/v1/email/campaigns/broadcasts/${broadcastCampaignUid}/archive`, method: 'POST',
+        responseType: 'blob', signal
+    },
+      options);
+    }
+  
+
+
+export const getCampaignArchiveBroadcastCampaignMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignArchiveBroadcastCampaign>>, TError,{broadcastCampaignUid: string | null}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof campaignArchiveBroadcastCampaign>>, TError,{broadcastCampaignUid: string | null}, TContext> => {
+
+const mutationKey = ['campaignArchiveBroadcastCampaign'];
+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 campaignArchiveBroadcastCampaign>>, {broadcastCampaignUid: string | null}> = (props) => {
+          const {broadcastCampaignUid} = props ?? {};
+
+          return  campaignArchiveBroadcastCampaign(broadcastCampaignUid,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type CampaignArchiveBroadcastCampaignMutationResult = NonNullable<Awaited<ReturnType<typeof campaignArchiveBroadcastCampaign>>>
+    
+    export type CampaignArchiveBroadcastCampaignMutationError = void
+
+    /**
+ * @summary Archives a broadcast campaign. Archived campaigns are excluded from the default list results.
+ */
+export const useCampaignArchiveBroadcastCampaign = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignArchiveBroadcastCampaign>>, TError,{broadcastCampaignUid: string | null}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof campaignArchiveBroadcastCampaign>>,
+        TError,
+        {broadcastCampaignUid: string | null},
+        TContext
+      > => {
+
+      const mutationOptions = getCampaignArchiveBroadcastCampaignMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Sends a test email for a broadcast campaign to the logged-in user and optionally to additional
+recipients. Additional recipients are specified as a list of person Uids and must belong to the
+same account as the logged-in user.
+ */
+export const campaignSendTestCampaignEmail = (
+    campaignSendTestCampaignEmailBody: CampaignSendTestCampaignEmailBody,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<Blob>(
+      {url: `/api/v1/email/campaigns/broadcasts/sendtestemail`, method: 'POST',
+      headers: {'Content-Type': 'application/json', },
+      data: campaignSendTestCampaignEmailBody,
+        responseType: 'blob', signal
+    },
+      options);
+    }
+  
+
+
+export const getCampaignSendTestCampaignEmailMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignSendTestCampaignEmail>>, TError,{data: CampaignSendTestCampaignEmailBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof campaignSendTestCampaignEmail>>, TError,{data: CampaignSendTestCampaignEmailBody}, TContext> => {
+
+const mutationKey = ['campaignSendTestCampaignEmail'];
+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 campaignSendTestCampaignEmail>>, {data: CampaignSendTestCampaignEmailBody}> = (props) => {
+          const {data} = props ?? {};
+
+          return  campaignSendTestCampaignEmail(data,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type CampaignSendTestCampaignEmailMutationResult = NonNullable<Awaited<ReturnType<typeof campaignSendTestCampaignEmail>>>
+    export type CampaignSendTestCampaignEmailMutationBody = CampaignSendTestCampaignEmailBody
+    export type CampaignSendTestCampaignEmailMutationError = void
+
+    /**
+ * @summary Sends a test email for a broadcast campaign to the logged-in user and optionally to additional
+recipients. Additional recipients are specified as a list of person Uids and must belong to the
+same account as the logged-in user.
+ */
+export const useCampaignSendTestCampaignEmail = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof campaignSendTestCampaignEmail>>, TError,{data: CampaignSendTestCampaignEmailBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof campaignSendTestCampaignEmail>>,
+        TError,
+        {data: CampaignSendTestCampaignEmailBody},
+        TContext
+      > => {
+
+      const mutationOptions = getCampaignSendTestCampaignEmailMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Retrieves all the people subscribing to an email list.
+ */
+export const emailListGetAllSubscriptions = (
+    emailListUid: string | null,
+    params?: EmailListGetAllSubscriptionsParams,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<EmailListPerson[]>(
+      {url: `/api/v1/email/lists/${emailListUid}/subscriptions`, method: 'GET',
+        params, signal
+    },
+      options);
+    }
+  
+
+
+
+export const getEmailListGetAllSubscriptionsQueryKey = (emailListUid?: string | null,
+    params?: EmailListGetAllSubscriptionsParams,) => {
+    return [
+    `/api/v1/email/lists/${emailListUid}/subscriptions`, ...(params ? [params]: [])
+    ] as const;
+    }
+
+    
+export const getEmailListGetAllSubscriptionsQueryOptions = <TData = Awaited<ReturnType<typeof emailListGetAllSubscriptions>>, TError = void>(emailListUid: string | null,
+    params?: EmailListGetAllSubscriptionsParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof emailListGetAllSubscriptions>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getEmailListGetAllSubscriptionsQueryKey(emailListUid,params);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof emailListGetAllSubscriptions>>> = ({ signal }) => emailListGetAllSubscriptions(emailListUid,params, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, enabled: !!(emailListUid), ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof emailListGetAllSubscriptions>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type EmailListGetAllSubscriptionsQueryResult = NonNullable<Awaited<ReturnType<typeof emailListGetAllSubscriptions>>>
+export type EmailListGetAllSubscriptionsQueryError = void
+
+
+/**
+ * @summary Retrieves all the people subscribing to an email list.
+ */
+
+export function useEmailListGetAllSubscriptions<TData = Awaited<ReturnType<typeof emailListGetAllSubscriptions>>, TError = void>(
+ emailListUid: string | null,
+    params?: EmailListGetAllSubscriptionsParams, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof emailListGetAllSubscriptions>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+  
+ ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } {
+
+  const queryOptions = getEmailListGetAllSubscriptionsQueryOptions(emailListUid,params,options)
+
+  const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
+
+/**
+ * @summary Subscribe a person to an email list. To subscribe a new person, pass a Person object with an
+Email address. To subscribe an existing person, pass a Person object with a Uid. The
+SendWelcomeEmail property determines if the person is sent a welcome email and defaults to false.
+ */
+export const emailListAddSubscription = (
+    emailListUid: string | null,
+    emailListAddSubscriptionBody: EmailListAddSubscriptionBody,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<EmailListPerson>(
+      {url: `/api/v1/email/lists/${emailListUid}/subscriptions`, method: 'POST',
+      headers: {'Content-Type': 'application/json', },
+      data: emailListAddSubscriptionBody, signal
+    },
+      options);
+    }
+  
+
+
+export const getEmailListAddSubscriptionMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof emailListAddSubscription>>, TError,{emailListUid: string | null;data: EmailListAddSubscriptionBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof emailListAddSubscription>>, TError,{emailListUid: string | null;data: EmailListAddSubscriptionBody}, TContext> => {
+
+const mutationKey = ['emailListAddSubscription'];
+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 emailListAddSubscription>>, {emailListUid: string | null;data: EmailListAddSubscriptionBody}> = (props) => {
+          const {emailListUid,data} = props ?? {};
+
+          return  emailListAddSubscription(emailListUid,data,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type EmailListAddSubscriptionMutationResult = NonNullable<Awaited<ReturnType<typeof emailListAddSubscription>>>
+    export type EmailListAddSubscriptionMutationBody = EmailListAddSubscriptionBody
+    export type EmailListAddSubscriptionMutationError = void
+
+    /**
+ * @summary Subscribe a person to an email list. To subscribe a new person, pass a Person object with an
+Email address. To subscribe an existing person, pass a Person object with a Uid. The
+SendWelcomeEmail property determines if the person is sent a welcome email and defaults to false.
+ */
+export const useEmailListAddSubscription = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof emailListAddSubscription>>, TError,{emailListUid: string | null;data: EmailListAddSubscriptionBody}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof emailListAddSubscription>>,
+        TError,
+        {emailListUid: string | null;data: EmailListAddSubscriptionBody},
+        TContext
+      > => {
+
+      const mutationOptions = getEmailListAddSubscriptionMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+    /**
+ * @summary Remove a subscriber from an email list.
+ */
+export const emailListDeleteSubscription = (
+    emailListUid: string | null,
+    subscriptionUid: string | null,
+ options?: SecondParameter<typeof customFetch>,) => {
+      
+      
+      return customFetch<Blob>(
+      {url: `/api/v1/email/lists/${emailListUid}/subscriptions/${subscriptionUid}`, method: 'DELETE',
+        responseType: 'blob'
+    },
+      options);
+    }
+  
+
+
+export const getEmailListDeleteSubscriptionMutationOptions = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof emailListDeleteSubscription>>, TError,{emailListUid: string | null;subscriptionUid: string | null}, TContext>, request?: SecondParameter<typeof customFetch>}
+): UseMutationOptions<Awaited<ReturnType<typeof emailListDeleteSubscription>>, TError,{emailListUid: string | null;subscriptionUid: string | null}, TContext> => {
+
+const mutationKey = ['emailListDeleteSubscription'];
+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 emailListDeleteSubscription>>, {emailListUid: string | null;subscriptionUid: string | null}> = (props) => {
+          const {emailListUid,subscriptionUid} = props ?? {};
+
+          return  emailListDeleteSubscription(emailListUid,subscriptionUid,requestOptions)
+        }
+
+        
+
+
+  return  { mutationFn, ...mutationOptions }}
+
+    export type EmailListDeleteSubscriptionMutationResult = NonNullable<Awaited<ReturnType<typeof emailListDeleteSubscription>>>
+    
+    export type EmailListDeleteSubscriptionMutationError = void
+
+    /**
+ * @summary Remove a subscriber from an email list.
+ */
+export const useEmailListDeleteSubscription = <TError = void,
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof emailListDeleteSubscription>>, TError,{emailListUid: string | null;subscriptionUid: string | null}, TContext>, request?: SecondParameter<typeof customFetch>}
+ ): UseMutationResult<
+        Awaited<ReturnType<typeof emailListDeleteSubscription>>,
+        TError,
+        {emailListUid: string | null;subscriptionUid: string | null},
+        TContext
+      > => {
+
+      const mutationOptions = getEmailListDeleteSubscriptionMutationOptions(options);
+
+      return useMutation(mutationOptions);
+    }
+