@outseta/api-client 0.1.1 → 0.2.1

package/src/generated/email/email.ts

@@ -0,0 +1,798 @@
+// @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 type {
+  BroadcastCampaign,
+  CampaignAddBroadcastEmailBody,
+  CampaignSendTestCampaignEmailBody,
+  CampaignUpdateBroadcastEmailBody,
+  EmailListAddSubscriptionBody,
+  EmailListGetAllSubscriptionsParams,
+  EmailListPerson
+} from '.././models';
+
+import { customFetch } from '../../client';
+
+/**
+ * @summary Retrieves all non-archived broadcast campaigns.
+ */
+export type campaignGetAllBroadcastEmailsResponse200 = {
+  data: BroadcastCampaign[]
+  status: 200
+}
+
+export type campaignGetAllBroadcastEmailsResponse401 = {
+  data: void
+  status: 401
+}
+    
+export type campaignGetAllBroadcastEmailsResponseSuccess = (campaignGetAllBroadcastEmailsResponse200) & {
+  headers: Headers;
+};
+export type campaignGetAllBroadcastEmailsResponseError = (campaignGetAllBroadcastEmailsResponse401) & {
+  headers: Headers;
+};
+
+export type campaignGetAllBroadcastEmailsResponse = (campaignGetAllBroadcastEmailsResponseSuccess | campaignGetAllBroadcastEmailsResponseError)
+
+export const getCampaignGetAllBroadcastEmailsUrl = () => {
+
+
+  
+
+  return `/api/v1/email/campaigns/broadcasts`
+}
+
+export const campaignGetAllBroadcastEmails = async ( options?: RequestInit): Promise<campaignGetAllBroadcastEmailsResponse> => {
+  
+  return customFetch<campaignGetAllBroadcastEmailsResponse>(getCampaignGetAllBroadcastEmailsUrl(),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+
+/**
+ * @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 type campaignAddBroadcastEmailResponse200 = {
+  data: BroadcastCampaign
+  status: 200
+}
+
+export type campaignAddBroadcastEmailResponse401 = {
+  data: void
+  status: 401
+}
+    
+export type campaignAddBroadcastEmailResponseSuccess = (campaignAddBroadcastEmailResponse200) & {
+  headers: Headers;
+};
+export type campaignAddBroadcastEmailResponseError = (campaignAddBroadcastEmailResponse401) & {
+  headers: Headers;
+};
+
+export type campaignAddBroadcastEmailResponse = (campaignAddBroadcastEmailResponseSuccess | campaignAddBroadcastEmailResponseError)
+
+export const getCampaignAddBroadcastEmailUrl = () => {
+
+
+  
+
+  return `/api/v1/email/campaigns/broadcasts`
+}
+
+export const campaignAddBroadcastEmail = async (campaignAddBroadcastEmailBody: CampaignAddBroadcastEmailBody, options?: RequestInit): Promise<campaignAddBroadcastEmailResponse> => {
+  
+  return customFetch<campaignAddBroadcastEmailResponse>(getCampaignAddBroadcastEmailUrl(),
+  {      
+    ...options,
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      campaignAddBroadcastEmailBody,)
+  }
+);}
+
+
+/**
+ * @summary Retrieves a single broadcast campaign by its Uid.
+ */
+export type campaignGetBroadcastEmailResponse200 = {
+  data: BroadcastCampaign
+  status: 200
+}
+
+export type campaignGetBroadcastEmailResponse400 = {
+  data: void
+  status: 400
+}
+
+export type campaignGetBroadcastEmailResponse401 = {
+  data: void
+  status: 401
+}
+
+export type campaignGetBroadcastEmailResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type campaignGetBroadcastEmailResponseSuccess = (campaignGetBroadcastEmailResponse200) & {
+  headers: Headers;
+};
+export type campaignGetBroadcastEmailResponseError = (campaignGetBroadcastEmailResponse400 | campaignGetBroadcastEmailResponse401 | campaignGetBroadcastEmailResponse404) & {
+  headers: Headers;
+};
+
+export type campaignGetBroadcastEmailResponse = (campaignGetBroadcastEmailResponseSuccess | campaignGetBroadcastEmailResponseError)
+
+export const getCampaignGetBroadcastEmailUrl = (broadcastCampaignUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/email/campaigns/broadcasts/${broadcastCampaignUid}`
+}
+
+export const campaignGetBroadcastEmail = async (broadcastCampaignUid: string | null, options?: RequestInit): Promise<campaignGetBroadcastEmailResponse> => {
+  
+  return customFetch<campaignGetBroadcastEmailResponse>(getCampaignGetBroadcastEmailUrl(broadcastCampaignUid),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+
+/**
+ * @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 type campaignUpdateBroadcastEmailResponse200 = {
+  data: BroadcastCampaign
+  status: 200
+}
+
+export type campaignUpdateBroadcastEmailResponse400 = {
+  data: void
+  status: 400
+}
+
+export type campaignUpdateBroadcastEmailResponse401 = {
+  data: void
+  status: 401
+}
+
+export type campaignUpdateBroadcastEmailResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type campaignUpdateBroadcastEmailResponseSuccess = (campaignUpdateBroadcastEmailResponse200) & {
+  headers: Headers;
+};
+export type campaignUpdateBroadcastEmailResponseError = (campaignUpdateBroadcastEmailResponse400 | campaignUpdateBroadcastEmailResponse401 | campaignUpdateBroadcastEmailResponse404) & {
+  headers: Headers;
+};
+
+export type campaignUpdateBroadcastEmailResponse = (campaignUpdateBroadcastEmailResponseSuccess | campaignUpdateBroadcastEmailResponseError)
+
+export const getCampaignUpdateBroadcastEmailUrl = (broadcastCampaignUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/email/campaigns/broadcasts/${broadcastCampaignUid}`
+}
+
+export const campaignUpdateBroadcastEmail = async (broadcastCampaignUid: string | null,
+    campaignUpdateBroadcastEmailBody: CampaignUpdateBroadcastEmailBody, options?: RequestInit): Promise<campaignUpdateBroadcastEmailResponse> => {
+  
+  return customFetch<campaignUpdateBroadcastEmailResponse>(getCampaignUpdateBroadcastEmailUrl(broadcastCampaignUid),
+  {      
+    ...options,
+    method: 'PUT',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      campaignUpdateBroadcastEmailBody,)
+  }
+);}
+
+
+/**
+ * @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 type campaignDeleteBroadcastCampaignResponse200 = {
+  data: Blob
+  status: 200
+}
+
+export type campaignDeleteBroadcastCampaignResponse400 = {
+  data: void
+  status: 400
+}
+
+export type campaignDeleteBroadcastCampaignResponse401 = {
+  data: void
+  status: 401
+}
+
+export type campaignDeleteBroadcastCampaignResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type campaignDeleteBroadcastCampaignResponseSuccess = (campaignDeleteBroadcastCampaignResponse200) & {
+  headers: Headers;
+};
+export type campaignDeleteBroadcastCampaignResponseError = (campaignDeleteBroadcastCampaignResponse400 | campaignDeleteBroadcastCampaignResponse401 | campaignDeleteBroadcastCampaignResponse404) & {
+  headers: Headers;
+};
+
+export type campaignDeleteBroadcastCampaignResponse = (campaignDeleteBroadcastCampaignResponseSuccess | campaignDeleteBroadcastCampaignResponseError)
+
+export const getCampaignDeleteBroadcastCampaignUrl = (broadcastCampaignUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/email/campaigns/broadcasts/${broadcastCampaignUid}`
+}
+
+export const campaignDeleteBroadcastCampaign = async (broadcastCampaignUid: string | null, options?: RequestInit): Promise<campaignDeleteBroadcastCampaignResponse> => {
+  
+  return customFetch<campaignDeleteBroadcastCampaignResponse>(getCampaignDeleteBroadcastCampaignUrl(broadcastCampaignUid),
+  {      
+    ...options,
+    method: 'DELETE'
+    
+    
+  }
+);}
+
+
+/**
+ * @summary Unschedules a pending broadcast campaign, reverting its status to Draft.
+ */
+export type campaignUnscheduleBroadcastEmailResponse200 = {
+  data: BroadcastCampaign
+  status: 200
+}
+
+export type campaignUnscheduleBroadcastEmailResponse400 = {
+  data: void
+  status: 400
+}
+
+export type campaignUnscheduleBroadcastEmailResponse401 = {
+  data: void
+  status: 401
+}
+
+export type campaignUnscheduleBroadcastEmailResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type campaignUnscheduleBroadcastEmailResponseSuccess = (campaignUnscheduleBroadcastEmailResponse200) & {
+  headers: Headers;
+};
+export type campaignUnscheduleBroadcastEmailResponseError = (campaignUnscheduleBroadcastEmailResponse400 | campaignUnscheduleBroadcastEmailResponse401 | campaignUnscheduleBroadcastEmailResponse404) & {
+  headers: Headers;
+};
+
+export type campaignUnscheduleBroadcastEmailResponse = (campaignUnscheduleBroadcastEmailResponseSuccess | campaignUnscheduleBroadcastEmailResponseError)
+
+export const getCampaignUnscheduleBroadcastEmailUrl = (broadcastCampaignUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/email/campaigns/broadcasts/${broadcastCampaignUid}/unschedule`
+}
+
+export const campaignUnscheduleBroadcastEmail = async (broadcastCampaignUid: string | null, options?: RequestInit): Promise<campaignUnscheduleBroadcastEmailResponse> => {
+  
+  return customFetch<campaignUnscheduleBroadcastEmailResponse>(getCampaignUnscheduleBroadcastEmailUrl(broadcastCampaignUid),
+  {      
+    ...options,
+    method: 'POST'
+    
+    
+  }
+);}
+
+
+/**
+ * @summary Archives a broadcast campaign. Archived campaigns are excluded from the default list results.
+ */
+export type campaignArchiveBroadcastCampaignResponse200 = {
+  data: Blob
+  status: 200
+}
+
+export type campaignArchiveBroadcastCampaignResponse400 = {
+  data: void
+  status: 400
+}
+
+export type campaignArchiveBroadcastCampaignResponse401 = {
+  data: void
+  status: 401
+}
+
+export type campaignArchiveBroadcastCampaignResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type campaignArchiveBroadcastCampaignResponseSuccess = (campaignArchiveBroadcastCampaignResponse200) & {
+  headers: Headers;
+};
+export type campaignArchiveBroadcastCampaignResponseError = (campaignArchiveBroadcastCampaignResponse400 | campaignArchiveBroadcastCampaignResponse401 | campaignArchiveBroadcastCampaignResponse404) & {
+  headers: Headers;
+};
+
+export type campaignArchiveBroadcastCampaignResponse = (campaignArchiveBroadcastCampaignResponseSuccess | campaignArchiveBroadcastCampaignResponseError)
+
+export const getCampaignArchiveBroadcastCampaignUrl = (broadcastCampaignUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/email/campaigns/broadcasts/${broadcastCampaignUid}/archive`
+}
+
+export const campaignArchiveBroadcastCampaign = async (broadcastCampaignUid: string | null, options?: RequestInit): Promise<campaignArchiveBroadcastCampaignResponse> => {
+  
+  return customFetch<campaignArchiveBroadcastCampaignResponse>(getCampaignArchiveBroadcastCampaignUrl(broadcastCampaignUid),
+  {      
+    ...options,
+    method: 'POST'
+    
+    
+  }
+);}
+
+
+/**
+ * @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 type campaignSendTestCampaignEmailResponse200 = {
+  data: Blob
+  status: 200
+}
+
+export type campaignSendTestCampaignEmailResponse401 = {
+  data: void
+  status: 401
+}
+    
+export type campaignSendTestCampaignEmailResponseSuccess = (campaignSendTestCampaignEmailResponse200) & {
+  headers: Headers;
+};
+export type campaignSendTestCampaignEmailResponseError = (campaignSendTestCampaignEmailResponse401) & {
+  headers: Headers;
+};
+
+export type campaignSendTestCampaignEmailResponse = (campaignSendTestCampaignEmailResponseSuccess | campaignSendTestCampaignEmailResponseError)
+
+export const getCampaignSendTestCampaignEmailUrl = () => {
+
+
+  
+
+  return `/api/v1/email/campaigns/broadcasts/sendtestemail`
+}
+
+export const campaignSendTestCampaignEmail = async (campaignSendTestCampaignEmailBody: CampaignSendTestCampaignEmailBody, options?: RequestInit): Promise<campaignSendTestCampaignEmailResponse> => {
+  
+  return customFetch<campaignSendTestCampaignEmailResponse>(getCampaignSendTestCampaignEmailUrl(),
+  {      
+    ...options,
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      campaignSendTestCampaignEmailBody,)
+  }
+);}
+
+
+/**
+ * @summary Retrieves all the people subscribing to an email list.
+ */
+export type emailListGetAllSubscriptionsResponse200 = {
+  data: EmailListPerson[]
+  status: 200
+}
+
+export type emailListGetAllSubscriptionsResponse400 = {
+  data: void
+  status: 400
+}
+
+export type emailListGetAllSubscriptionsResponse401 = {
+  data: void
+  status: 401
+}
+    
+export type emailListGetAllSubscriptionsResponseSuccess = (emailListGetAllSubscriptionsResponse200) & {
+  headers: Headers;
+};
+export type emailListGetAllSubscriptionsResponseError = (emailListGetAllSubscriptionsResponse400 | emailListGetAllSubscriptionsResponse401) & {
+  headers: Headers;
+};
+
+export type emailListGetAllSubscriptionsResponse = (emailListGetAllSubscriptionsResponseSuccess | emailListGetAllSubscriptionsResponseError)
+
+export const getEmailListGetAllSubscriptionsUrl = (emailListUid: string | null,
+    params?: EmailListGetAllSubscriptionsParams,) => {
+  const normalizedParams = new URLSearchParams();
+
+  Object.entries(params || {}).forEach(([key, value]) => {
+    
+    if (value !== undefined) {
+      normalizedParams.append(key, value === null ? 'null' : value.toString())
+    }
+  });
+
+  const stringifiedParams = normalizedParams.toString();
+
+  return stringifiedParams.length > 0 ? `/api/v1/email/lists/${emailListUid}/subscriptions?${stringifiedParams}` : `/api/v1/email/lists/${emailListUid}/subscriptions`
+}
+
+export const emailListGetAllSubscriptions = async (emailListUid: string | null,
+    params?: EmailListGetAllSubscriptionsParams, options?: RequestInit): Promise<emailListGetAllSubscriptionsResponse> => {
+  
+  return customFetch<emailListGetAllSubscriptionsResponse>(getEmailListGetAllSubscriptionsUrl(emailListUid,params),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+
+/**
+ * @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 type emailListAddSubscriptionResponse200 = {
+  data: EmailListPerson
+  status: 200
+}
+
+export type emailListAddSubscriptionResponse400 = {
+  data: void
+  status: 400
+}
+
+export type emailListAddSubscriptionResponse401 = {
+  data: void
+  status: 401
+}
+
+export type emailListAddSubscriptionResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type emailListAddSubscriptionResponseSuccess = (emailListAddSubscriptionResponse200) & {
+  headers: Headers;
+};
+export type emailListAddSubscriptionResponseError = (emailListAddSubscriptionResponse400 | emailListAddSubscriptionResponse401 | emailListAddSubscriptionResponse404) & {
+  headers: Headers;
+};
+
+export type emailListAddSubscriptionResponse = (emailListAddSubscriptionResponseSuccess | emailListAddSubscriptionResponseError)
+
+export const getEmailListAddSubscriptionUrl = (emailListUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/email/lists/${emailListUid}/subscriptions`
+}
+
+export const emailListAddSubscription = async (emailListUid: string | null,
+    emailListAddSubscriptionBody: EmailListAddSubscriptionBody, options?: RequestInit): Promise<emailListAddSubscriptionResponse> => {
+  
+  return customFetch<emailListAddSubscriptionResponse>(getEmailListAddSubscriptionUrl(emailListUid),
+  {      
+    ...options,
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      emailListAddSubscriptionBody,)
+  }
+);}
+
+
+/**
+ * @summary Remove a subscriber from an email list.
+ */
+export type emailListDeleteSubscriptionResponse200 = {
+  data: Blob
+  status: 200
+}
+
+export type emailListDeleteSubscriptionResponse400 = {
+  data: void
+  status: 400
+}
+
+export type emailListDeleteSubscriptionResponse401 = {
+  data: void
+  status: 401
+}
+
+export type emailListDeleteSubscriptionResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type emailListDeleteSubscriptionResponseSuccess = (emailListDeleteSubscriptionResponse200) & {
+  headers: Headers;
+};
+export type emailListDeleteSubscriptionResponseError = (emailListDeleteSubscriptionResponse400 | emailListDeleteSubscriptionResponse401 | emailListDeleteSubscriptionResponse404) & {
+  headers: Headers;
+};
+
+export type emailListDeleteSubscriptionResponse = (emailListDeleteSubscriptionResponseSuccess | emailListDeleteSubscriptionResponseError)
+
+export const getEmailListDeleteSubscriptionUrl = (emailListUid: string | null,
+    subscriptionUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/email/lists/${emailListUid}/subscriptions/${subscriptionUid}`
+}
+
+export const emailListDeleteSubscription = async (emailListUid: string | null,
+    subscriptionUid: string | null, options?: RequestInit): Promise<emailListDeleteSubscriptionResponse> => {
+  
+  return customFetch<emailListDeleteSubscriptionResponse>(getEmailListDeleteSubscriptionUrl(emailListUid,subscriptionUid),
+  {      
+    ...options,
+    method: 'DELETE'
+    
+    
+  }
+);}
+
+