@outseta/api-client 0.3.30 → 0.3.31

package/package.json

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

package/src/generated/models/index.ts

@@ -557,6 +557,7 @@ export * from './segmentPersonAllOfPerson';
 export * from './segmentPersonAllOfSegment';
 export * from './sendGridDomainAuthentication';
 export * from './sendGridDomainAuthenticationAllOf';
+export * from './sendTemplateEmailRequest';
 export * from './sendTestEmailRequest';
 export * from './sendTestEmailRequest2';
 export * from './sendTestEmailRequest2BroadcastCampaign';
@@ -715,6 +716,15 @@ export * from './taxRateAllOf';
 export * from './teamRole';
 export * from './template';
 export * from './templateAllOf';
+export * from './templateEmailInstance';
+export * from './templateEmailInstanceAllOf';
+export * from './templateEmailInstanceAllOfRecipient';
+export * from './templateEmailInstanceAllOfTemplate';
+export * from './templateGetAllTemplateEmails200';
+export * from './templateGetAllTemplateEmailsParams';
+export * from './templateGetTemplateEmails200';
+export * from './templateGetTemplateEmailsParams';
+export * from './templateSendTemplateEmailBody';
 export * from './temporaryPasswordModel';
 export * from './tokenPayload';
 export * from './tokenTwoFactorEnrollmentBeginEmailParams';

package/src/generated/models/sendTemplateEmailRequest.ts

@@ -0,0 +1,24 @@
+// @ts-nocheck
+
+export interface SendTemplateEmailRequest {
+  /**
+   * The Uid of the person to send the email to. Required.
+   * @nullable
+   */
+  PersonUid?: string | null;
+  /**
+   * The from address. Defaults to the support email address for the account.
+   * @nullable
+   */
+  FromEmail?: string | null;
+  /**
+   * The from name. Defaults to the company name.
+   * @nullable
+   */
+  FromName?: string | null;
+  /**
+   * Overrides the subject of the template.
+   * @nullable
+   */
+  Subject?: string | null;
+}

package/src/generated/models/templateEmailInstance.ts

@@ -0,0 +1,5 @@
+// @ts-nocheck
+import type { AbstractQcountBean } from './abstractQcountBean';
+import type { TemplateEmailInstanceAllOf } from './templateEmailInstanceAllOf';
+
+export type TemplateEmailInstance = AbstractQcountBean & TemplateEmailInstanceAllOf;

package/src/generated/models/templateEmailInstanceAllOf.ts

@@ -0,0 +1,47 @@
+// @ts-nocheck
+import type { TemplateEmailInstanceAllOfTemplate } from './templateEmailInstanceAllOfTemplate';
+import type { TemplateEmailInstanceAllOfRecipient } from './templateEmailInstanceAllOfRecipient';
+
+export type TemplateEmailInstanceAllOf = {
+  /** @nullable */
+  Template?: TemplateEmailInstanceAllOfTemplate;
+  /** @nullable */
+  Recipient?: TemplateEmailInstanceAllOfRecipient;
+  /**
+   * @maxLength 50
+   * @nullable
+   */
+  UniqueMessageId?: string | null;
+  /**
+   * @maxLength 1000
+   * @nullable
+   */
+  Subject?: string | null;
+  /**
+   * @maxLength 250
+   * @nullable
+   */
+  FromEmail?: string | null;
+  /**
+   * @maxLength 250
+   * @nullable
+   */
+  FromName?: string | null;
+  SendDateTime?: string;
+  /** @nullable */
+  ProcessDateTime?: string | null;
+  /** @nullable */
+  DeliverDateTime?: string | null;
+  /** @nullable */
+  BounceDateTime?: string | null;
+  /** @nullable */
+  SpamDateTime?: string | null;
+  /** @nullable */
+  OpenDateTime?: string | null;
+  /** @nullable */
+  ClickDateTime?: string | null;
+  /** @nullable */
+  UnsubscribeDateTime?: string | null;
+  /** @nullable */
+  SendError?: string | null;
+};

package/src/generated/models/templateEmailInstanceAllOfRecipient.ts

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

package/src/generated/models/templateEmailInstanceAllOfTemplate.ts

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

package/src/generated/models/templateGetAllTemplateEmails200.ts

@@ -0,0 +1,8 @@
+// @ts-nocheck
+import type { CollectionMetadata } from './collectionMetadata';
+import type { TemplateEmailInstance } from './templateEmailInstance';
+
+export type TemplateGetAllTemplateEmails200 = {
+  metadata?: CollectionMetadata;
+  items?: TemplateEmailInstance[];
+};

package/src/generated/models/templateGetAllTemplateEmailsParams.ts

@@ -0,0 +1,14 @@
+// @ts-nocheck
+import type { LimitParameter } from './limitParameter';
+import type { OffsetParameter } from './offsetParameter';
+
+export type TemplateGetAllTemplateEmailsParams = {
+/**
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
+ */
+limit?: LimitParameter;
+/**
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
+ */
+offset?: OffsetParameter;
+};

package/src/generated/models/templateGetTemplateEmails200.ts

@@ -0,0 +1,8 @@
+// @ts-nocheck
+import type { CollectionMetadata } from './collectionMetadata';
+import type { TemplateEmailInstance } from './templateEmailInstance';
+
+export type TemplateGetTemplateEmails200 = {
+  metadata?: CollectionMetadata;
+  items?: TemplateEmailInstance[];
+};

package/src/generated/models/templateGetTemplateEmailsParams.ts

@@ -0,0 +1,14 @@
+// @ts-nocheck
+import type { LimitParameter } from './limitParameter';
+import type { OffsetParameter } from './offsetParameter';
+
+export type TemplateGetTemplateEmailsParams = {
+/**
+ * Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
+ */
+limit?: LimitParameter;
+/**
+ * Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).
+ */
+offset?: OffsetParameter;
+};

package/src/generated/models/templateSendTemplateEmailBody.ts

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

package/src/generated/template/template.ts

@@ -0,0 +1,188 @@
+// @ts-nocheck
+import type {
+  TemplateEmailInstance,
+  TemplateGetAllTemplateEmails200,
+  TemplateGetAllTemplateEmailsParams,
+  TemplateGetTemplateEmails200,
+  TemplateGetTemplateEmailsParams,
+  TemplateSendTemplateEmailBody
+} from '.././models';
+
+import { customFetch } from '../../client';
+
+/**
+ * Filter with personUid to see what one person was sent, or with templateUid to
+restrict the results to a single template.
+ * @summary The one-off emails that were sent from any email template.
+ */
+export type templateGetAllTemplateEmailsResponse200 = {
+  data: TemplateGetAllTemplateEmails200
+  status: 200
+}
+
+export type templateGetAllTemplateEmailsResponse401 = {
+  data: void
+  status: 401
+}
+    
+export type templateGetAllTemplateEmailsResponseSuccess = (templateGetAllTemplateEmailsResponse200) & {
+  headers: Headers;
+};
+export type templateGetAllTemplateEmailsResponseError = (templateGetAllTemplateEmailsResponse401) & {
+  headers: Headers;
+};
+
+export type templateGetAllTemplateEmailsResponse = (templateGetAllTemplateEmailsResponseSuccess | templateGetAllTemplateEmailsResponseError)
+
+export const getTemplateGetAllTemplateEmailsUrl = (params?: TemplateGetAllTemplateEmailsParams,) => {
+  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/templates/emails?${stringifiedParams}` : `/api/v1/templates/emails`
+}
+
+export const templateGetAllTemplateEmails = async (params?: TemplateGetAllTemplateEmailsParams, options?: RequestInit): Promise<templateGetAllTemplateEmailsResponse> => {
+  
+  return customFetch<templateGetAllTemplateEmailsResponse>(getTemplateGetAllTemplateEmailsUrl(params),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+
+/**
+ * Add personUid to the query string to see what one person was sent from this
+template.
+ * @summary The one-off emails that were sent from this email template.
+ */
+export type templateGetTemplateEmailsResponse200 = {
+  data: TemplateGetTemplateEmails200
+  status: 200
+}
+
+export type templateGetTemplateEmailsResponse400 = {
+  data: void
+  status: 400
+}
+
+export type templateGetTemplateEmailsResponse401 = {
+  data: void
+  status: 401
+}
+
+export type templateGetTemplateEmailsResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type templateGetTemplateEmailsResponseSuccess = (templateGetTemplateEmailsResponse200) & {
+  headers: Headers;
+};
+export type templateGetTemplateEmailsResponseError = (templateGetTemplateEmailsResponse400 | templateGetTemplateEmailsResponse401 | templateGetTemplateEmailsResponse404) & {
+  headers: Headers;
+};
+
+export type templateGetTemplateEmailsResponse = (templateGetTemplateEmailsResponseSuccess | templateGetTemplateEmailsResponseError)
+
+export const getTemplateGetTemplateEmailsUrl = (templateUid: string | null,
+    params?: TemplateGetTemplateEmailsParams,) => {
+  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/templates/${templateUid}/emails?${stringifiedParams}` : `/api/v1/templates/${templateUid}/emails`
+}
+
+export const templateGetTemplateEmails = async (templateUid: string | null,
+    params?: TemplateGetTemplateEmailsParams, options?: RequestInit): Promise<templateGetTemplateEmailsResponse> => {
+  
+  return customFetch<templateGetTemplateEmailsResponse>(getTemplateGetTemplateEmailsUrl(templateUid,params),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+
+/**
+ * The email is merge-rendered for the person and sent immediately. No broadcast
+is created. People who have bounced, unsubscribed or reported spam are not sent
+the email. Only templates from Email > Email templates can be sent.
+            
+The response holds the record of the send. Read the open and click analytics
+for it later from the emails endpoint for the template. The template and the
+recipient are left out of the response unless they are asked for, for example
+fields=*,Template.Uid,Recipient.Uid.
+ * @summary Send an email template to a single person as a one-off email.
+ */
+export type templateSendTemplateEmailResponse200 = {
+  data: TemplateEmailInstance
+  status: 200
+}
+
+export type templateSendTemplateEmailResponse400 = {
+  data: void
+  status: 400
+}
+
+export type templateSendTemplateEmailResponse401 = {
+  data: void
+  status: 401
+}
+
+export type templateSendTemplateEmailResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type templateSendTemplateEmailResponseSuccess = (templateSendTemplateEmailResponse200) & {
+  headers: Headers;
+};
+export type templateSendTemplateEmailResponseError = (templateSendTemplateEmailResponse400 | templateSendTemplateEmailResponse401 | templateSendTemplateEmailResponse404) & {
+  headers: Headers;
+};
+
+export type templateSendTemplateEmailResponse = (templateSendTemplateEmailResponseSuccess | templateSendTemplateEmailResponseError)
+
+export const getTemplateSendTemplateEmailUrl = (templateUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/templates/${templateUid}/send`
+}
+
+export const templateSendTemplateEmail = async (templateUid: string | null,
+    templateSendTemplateEmailBody: TemplateSendTemplateEmailBody, options?: RequestInit): Promise<templateSendTemplateEmailResponse> => {
+  
+  return customFetch<templateSendTemplateEmailResponse>(getTemplateSendTemplateEmailUrl(templateUid),
+  {      
+    ...options,
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      templateSendTemplateEmailBody,)
+  }
+);}
+
+