@hubspot/app-connect-sdk 1.0.0-alpha.2 → 1.0.0-alpha.21

package/src/server/api-client-core/apis/automation/sequences-types.generated.ts

@@ -2,413 +2,410 @@
 
 import type { Operation } from '../../types.ts';
 
-export namespace AutomationSequences {
-  export namespace Basic {
-    export interface CreateEnrollmentInput {
-      data: Schemas.PublicSequenceEnrollmentRequest;
-      userId: string;
-    }
-
-    export type CreateEnrollmentOutput =
-      Schemas.PublicSequenceEnrollmentLiteResponse;
+export namespace AutomationSequencesSchemas {
+  export interface CollectionResponseWithTotalPublicSequenceLiteResponse {
+    paging?: Paging;
+    /**
+     * An array of PublicSequenceLiteResponse objects, each representing a lightweight version of a sequence.
+     */
+    results: PublicSequenceLiteResponse[];
+    /**
+     * An integer representing the total number of sequence items available.
+     */
+    total: number;
+  }
 
-    export interface GetEnrollmentByContactIdInput {
-      contactId: string;
-    }
+  /**
+   * Specifies the paging information needed to retrieve the next set of results in a paginated API response
+   */
+  export interface NextPage {
+    /**
+     * A paging cursor token for retrieving subsequent pages.
+     */
+    after: string;
+    /**
+     * A URL that can be used to retrieve the next page results.
+     */
+    link?: string;
+  }
 
-    export type GetEnrollmentByContactIdOutput =
-      Schemas.PublicSequenceEnrollmentResponse;
+  export interface Paging {
+    next?: NextPage;
+    prev?: PreviousPage;
+  }
 
-    export interface GetInput {
-      sequenceId: string;
-      userId: string;
-    }
+  /**
+   * specifies the paging information needed to retrieve the previous set of results in a paginated API response
+   */
+  export interface PreviousPage {
+    /**
+     * A string token used to identify the position before the current page in the pagination sequence.
+     */
+    before: string;
+    /**
+     * A URL string that provides a direct link to the previous page of results.
+     */
+    link?: string;
+  }
 
-    export type GetOutput = Schemas.PublicSequenceResponse;
+  export interface PublicEmailPatternResponse {
+    /**
+     * The date and time when the email pattern was created.
+     */
+    createdAt: string;
+    /**
+     * The unique identifier of the email pattern.
+     */
+    id: string;
+    /**
+     * The unique identifier of the email template associated with the pattern.
+     */
+    templateId: string;
+    /**
+     * The order identifying the previous step to which the email thread is linked.
+     */
+    threadEmailToStepOrder?: number;
+    /**
+     * The date and time when the email pattern was last updated.
+     */
+    updatedAt: string;
+  }
 
-    export interface ListInput {
-      /**
-       * The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
-       */
-      after?: string;
-      /**
-       * The maximum number of results to display per page.
-       */
-      limit?: number;
-      name?: string;
-      userId: string;
-    }
+  export interface PublicSequenceEnrollmentLiteResponse {
+    /**
+     * The date and time when the contact was enrolled in the sequence.
+     */
+    enrolledAt: string;
+    /**
+     * The unique identifier for the sequence enrollment.
+     */
+    id: string;
+    /**
+     * The email address of the contact enrolled in the sequence.
+     */
+    toEmail: string;
+    /**
+     * The date and time when the sequence enrollment was last updated.
+     */
+    updatedAt: string;
+  }
 
-    export type ListOutput =
-      Schemas.CollectionResponseWithTotalPublicSequenceLiteResponse;
+  export interface PublicSequenceEnrollmentRequest {
+    /**
+     * The unique identifier of the contact to be enrolled in the sequence.
+     */
+    contactId: string;
+    /**
+     * The alias email address used by the sender when enrolling the contact.
+     */
+    senderAliasAddress?: string;
+    /**
+     * The email address of the sender enrolling the contact in the sequence.
+     */
+    senderEmail: string;
+    /**
+     * The unique identifier of the sequence in which the contact will be enrolled.
+     */
+    sequenceId: string;
   }
 
-  export namespace Schemas {
-    export interface CollectionResponseWithTotalPublicSequenceLiteResponse {
-      paging?: Schemas.Paging;
-      /**
-       * An array of PublicSequenceLiteResponse objects, each representing a lightweight version of a sequence.
-       */
-      results: Schemas.PublicSequenceLiteResponse[];
-      /**
-       * An integer representing the total number of sequence items available.
-       */
-      total: number;
-    }
+  export interface PublicSequenceEnrollmentResponse {
+    /**
+     * The date and time when the contact was enrolled in the sequence.
+     */
+    enrolledAt: string;
+    /**
+     * The identifier of the user who enrolled the contact in the sequence.
+     */
+    enrolledBy: string;
+    /**
+     * The email address of the user who enrolled the contact in the sequence.
+     */
+    enrolledByEmail: string;
+    /**
+     * The unique identifier for the sequence enrollment.
+     */
+    id: string;
+    /**
+     * The unique identifier of the sequence in which the contact is enrolled.
+     */
+    sequenceId: string;
+    /**
+     * The name of the sequence in which the contact is enrolled.
+     */
+    sequenceName: string;
+    /**
+     * The email address of the contact enrolled in the sequence.
+     */
+    toEmail: string;
+    /**
+     * The date and time when the sequence enrollment was last updated.
+     */
+    updatedAt: string;
+  }
 
+  export interface PublicSequenceLiteResponse {
+    /**
+     * The date and time when the sequence was created.
+     */
+    createdAt: string;
     /**
-     * Specifies the paging information needed to retrieve the next set of results in a paginated API response
-     */
-    export interface NextPage {
-      /**
-       * A paging cursor token for retrieving subsequent pages.
-       */
-      after: string;
-      /**
-       * A URL that can be used to retrieve the next page results.
-       */
-      link?: string;
-    }
+     * The ID of the folder containing the sequence.
+     */
+    folderId?: string;
+    /**
+     * The unique identifier of the sequence.
+     */
+    id: string;
+    /**
+     * The name of the sequence.
+     */
+    name: string;
+    /**
+     * The date and time when the sequence was last updated.
+     */
+    updatedAt: string;
+    /**
+     * The ID of the user associated with the sequence.
+     */
+    userId: string;
+  }
 
-    export interface Paging {
-      next?: Schemas.NextPage;
-      prev?: Schemas.PreviousPage;
-    }
+  export interface PublicSequenceResponse {
+    /**
+     * The date and time when the sequence was created.
+     */
+    createdAt: string;
+    /**
+     * An array of dependencies for the sequence steps, each represented as a PublicSequenceStepDependencyResponse object.
+     */
+    dependencies: PublicSequenceStepDependencyResponse[];
+    /**
+     * The identifier of the folder containing the sequence.
+     */
+    folderId?: string;
+    /**
+     * The unique identifier for the sequence.
+     */
+    id: string;
+    /**
+     * The name of the sequence.
+     */
+    name: string;
+    settings?: PublicSequenceSettingsResponse;
+    /**
+     * An array of steps included in the sequence, each represented by a PublicSequenceStepResponse object.
+     */
+    steps: PublicSequenceStepResponse[];
+    /**
+     * The date and time when the sequence was last updated.
+     */
+    updatedAt: string;
+    /**
+     * The ID of the user associated with the sequence.
+     */
+    userId: string;
+  }
 
+  export interface PublicSequenceSettingsResponse {
+    /**
+     * The timestamp of when the sequence settings were created.
+     */
+    createdAt: string;
+    /**
+     * Specifies the days on which follow-up actions are allowed.
+     */
+    eligibleFollowUpDays: 'BUSINESS_DAYS' | 'EVERYDAY' | 'WEEKDAYS_ONLY';
+    /**
+     * The unique identifier for the sequence settings.
+     */
+    id: string;
+    /**
+     * Indicates whether individual task reminders are enabled.
+     */
+    individualTaskRemindersEnabled: boolean;
     /**
-     * specifies the paging information needed to retrieve the previous set of results in a paginated API response
-     */
-    export interface PreviousPage {
-      /**
-       * A string token used to identify the position before the current page in the pagination sequence.
-       */
-      before: string;
-      /**
-       * A URL string that provides a direct link to the previous page of results.
-       */
-      link?: string;
-    }
+     * (deprecated) Defines the unenrollment strategy, with accepted values being ACCOUNT_BASED or LEAD_BASED. If ACCOUNT_BASED is used, all contacts associated with the same company will be unenrolled if one contact meets any of the unenrollment criteria.
+     */
+    sellingStrategy: 'ACCOUNT_BASED' | 'LEAD_BASED';
+    /**
+     * Indicates the end minute of the time window during which automated emails can be sent.
+     */
+    sendWindowEndMinute: number;
+    /**
+     * Indicates the start minute of the time window during which automated emails can be sent.
+     */
+    sendWindowStartMinute: number;
+    /**
+     * Specifies the minute of day at which task reminders are triggered.
+     */
+    taskReminderMinute: number;
+    /**
+     * The timestamp of when the sequence settings were last updated.
+     */
+    updatedAt: string;
+  }
 
-    export interface PublicEmailPatternResponse {
-      /**
-       * The date and time when the email pattern was created.
-       */
-      createdAt: string;
-      /**
-       * The unique identifier of the email pattern.
-       */
-      id: string;
-      /**
-       * The unique identifier of the email template associated with the pattern.
-       */
-      templateId: string;
-      /**
-       * The order identifying the previous step to which the email thread is linked.
-       */
-      threadEmailToStepOrder?: number;
-      /**
-       * The date and time when the email pattern was last updated.
-       */
-      updatedAt: string;
-    }
+  export interface PublicSequenceStepDependencyResponse {
+    /**
+     * The date and time when the step dependency was created.
+     */
+    createdAt: string;
+    /**
+     * The type of dependency between sequence steps with accepted values being TASK_COMPLETION or MANUAL_PAUSE.
+     */
+    dependencyType: 'MANUAL_PAUSE' | 'TASK_COMPLETION';
+    /**
+     * The unique identifier of the step dependency.
+     */
+    id: string;
+    /**
+     * The unique identifier of the sequence step that is responsible for creating and resolving this dependency.
+     */
+    reliesOnSequenceStepId: string;
+    /**
+     * The order number of the step that is responsible for creating and resolving this dependency.
+     */
+    reliesOnStepOrder: number;
+    /**
+     * The unique identifier of the sequence step that requires this dependency.
+     */
+    requiredBySequenceStepId: string;
+    /**
+     * The order number of the step that requires this dependency.
+     */
+    requiredByStepOrder: number;
+    /**
+     * The date and time when the step dependency was last updated.
+     */
+    updatedAt: string;
+  }
 
-    export interface PublicSequenceEnrollmentLiteResponse {
-      /**
-       * The date and time when the contact was enrolled in the sequence.
-       */
-      enrolledAt: string;
-      /**
-       * The unique identifier for the sequence enrollment.
-       */
-      id: string;
-      /**
-       * The email address of the contact enrolled in the sequence.
-       */
-      toEmail: string;
-      /**
-       * The date and time when the sequence enrollment was last updated.
-       */
-      updatedAt: string;
-    }
+  export interface PublicSequenceStepResponse {
+    /**
+     * The type of action to be performed in the sequence step.
+     */
+    actionType: 'EMAIL' | 'FINISH_ENROLLMENT' | 'TASK';
+    /**
+     * The date and time when the sequence step was created.
+     */
+    createdAt: string;
+    /**
+     * The delay in milliseconds before the sequence step is executed.
+     */
+    delayMillis: number;
+    emailPattern?: PublicEmailPatternResponse;
+    /**
+     * The unique identifier of the sequence step.
+     */
+    id: string;
+    /**
+     * The order of the step within the sequence.
+     */
+    stepOrder: number;
+    taskPattern?: PublicTaskPatternResponse;
+    /**
+     * The date and time when the sequence step was last updated.
+     */
+    updatedAt: string;
+  }
 
-    export interface PublicSequenceEnrollmentRequest {
-      /**
-       * The unique identifier of the contact to be enrolled in the sequence.
-       */
-      contactId: string;
-      /**
-       * The alias email address used by the sender when enrolling the contact.
-       */
-      senderAliasAddress?: string;
-      /**
-       * The email address of the sender enrolling the contact in the sequence.
-       */
-      senderEmail: string;
-      /**
-       * The unique identifier of the sequence in which the contact will be enrolled.
-       */
-      sequenceId: string;
-    }
+  export interface PublicTaskPatternResponse {
+    /**
+     * The date and time when the task pattern was created.
+     */
+    createdAt: string;
+    /**
+     * The unique identifier for the task pattern.
+     */
+    id: string;
+    /**
+     * Additional notes or comments associated with the task.
+     */
+    notes?: string;
+    /**
+     * The identifier for the queue associated with the task.
+     */
+    queueId?: number;
+    /**
+     * The subject line of the task.
+     */
+    subject?: string;
+    /**
+     * The priority level assigned to the task.
+     */
+    taskPriority: 'HIGH' | 'LOW' | 'MEDIUM' | 'NONE';
+    /**
+     * The type of task, such as an email or call.
+     */
+    taskType:
+      | 'CALL'
+      | 'EMAIL'
+      | 'LINKED_IN_CONNECT'
+      | 'LINKED_IN_MESSAGE'
+      | 'MEETING'
+      | 'TODO';
+    /**
+     * The identifier for the template used in the task.
+     */
+    templateId?: number;
+    /**
+     * The order of the step to which the email thread is related.
+     */
+    threadEmailToStepOrder?: number;
+    /**
+     * The date and time when the task pattern was last updated.
+     */
+    updatedAt: string;
+  }
+}
 
-    export interface PublicSequenceEnrollmentResponse {
-      /**
-       * The date and time when the contact was enrolled in the sequence.
-       */
-      enrolledAt: string;
-      /**
-       * The identifier of the user who enrolled the contact in the sequence.
-       */
-      enrolledBy: string;
-      /**
-       * The email address of the user who enrolled the contact in the sequence.
-       */
-      enrolledByEmail: string;
-      /**
-       * The unique identifier for the sequence enrollment.
-       */
-      id: string;
-      /**
-       * The unique identifier of the sequence in which the contact is enrolled.
-       */
-      sequenceId: string;
-      /**
-       * The name of the sequence in which the contact is enrolled.
-       */
-      sequenceName: string;
-      /**
-       * The email address of the contact enrolled in the sequence.
-       */
-      toEmail: string;
-      /**
-       * The date and time when the sequence enrollment was last updated.
-       */
-      updatedAt: string;
-    }
+export namespace AutomationSequences {
+  export interface CreateEnrollmentInput {
+    data: AutomationSequencesSchemas.PublicSequenceEnrollmentRequest;
+    userId: string;
+  }
 
-    export interface PublicSequenceLiteResponse {
-      /**
-       * The date and time when the sequence was created.
-       */
-      createdAt: string;
-      /**
-       * The ID of the folder containing the sequence.
-       */
-      folderId?: string;
-      /**
-       * The unique identifier of the sequence.
-       */
-      id: string;
-      /**
-       * The name of the sequence.
-       */
-      name: string;
-      /**
-       * The date and time when the sequence was last updated.
-       */
-      updatedAt: string;
-      /**
-       * The ID of the user associated with the sequence.
-       */
-      userId: string;
-    }
+  export type CreateEnrollmentOutput =
+    AutomationSequencesSchemas.PublicSequenceEnrollmentLiteResponse;
 
-    export interface PublicSequenceResponse {
-      /**
-       * The date and time when the sequence was created.
-       */
-      createdAt: string;
-      /**
-       * An array of dependencies for the sequence steps, each represented as a PublicSequenceStepDependencyResponse object.
-       */
-      dependencies: Schemas.PublicSequenceStepDependencyResponse[];
-      /**
-       * The identifier of the folder containing the sequence.
-       */
-      folderId?: string;
-      /**
-       * The unique identifier for the sequence.
-       */
-      id: string;
-      /**
-       * The name of the sequence.
-       */
-      name: string;
-      settings?: Schemas.PublicSequenceSettingsResponse;
-      /**
-       * An array of steps included in the sequence, each represented by a PublicSequenceStepResponse object.
-       */
-      steps: Schemas.PublicSequenceStepResponse[];
-      /**
-       * The date and time when the sequence was last updated.
-       */
-      updatedAt: string;
-      /**
-       * The ID of the user associated with the sequence.
-       */
-      userId: string;
-    }
+  export interface GetEnrollmentByContactIdInput {
+    contactId: string;
+  }
 
-    export interface PublicSequenceSettingsResponse {
-      /**
-       * The timestamp of when the sequence settings were created.
-       */
-      createdAt: string;
-      /**
-       * Specifies the days on which follow-up actions are allowed.
-       */
-      eligibleFollowUpDays: 'BUSINESS_DAYS' | 'EVERYDAY' | 'WEEKDAYS_ONLY';
-      /**
-       * The unique identifier for the sequence settings.
-       */
-      id: string;
-      /**
-       * Indicates whether individual task reminders are enabled.
-       */
-      individualTaskRemindersEnabled: boolean;
-      /**
-       * (deprecated) Defines the unenrollment strategy, with accepted values being ACCOUNT_BASED or LEAD_BASED. If ACCOUNT_BASED is used, all contacts associated with the same company will be unenrolled if one contact meets any of the unenrollment criteria.
-       */
-      sellingStrategy: 'ACCOUNT_BASED' | 'LEAD_BASED';
-      /**
-       * Indicates the end minute of the time window during which automated emails can be sent.
-       */
-      sendWindowEndMinute: number;
-      /**
-       * Indicates the start minute of the time window during which automated emails can be sent.
-       */
-      sendWindowStartMinute: number;
-      /**
-       * Specifies the minute of day at which task reminders are triggered.
-       */
-      taskReminderMinute: number;
-      /**
-       * The timestamp of when the sequence settings were last updated.
-       */
-      updatedAt: string;
-    }
+  export type GetEnrollmentByContactIdOutput =
+    AutomationSequencesSchemas.PublicSequenceEnrollmentResponse;
 
-    export interface PublicSequenceStepDependencyResponse {
-      /**
-       * The date and time when the step dependency was created.
-       */
-      createdAt: string;
-      /**
-       * The type of dependency between sequence steps with accepted values being TASK_COMPLETION or MANUAL_PAUSE.
-       */
-      dependencyType: 'MANUAL_PAUSE' | 'TASK_COMPLETION';
-      /**
-       * The unique identifier of the step dependency.
-       */
-      id: string;
-      /**
-       * The unique identifier of the sequence step that is responsible for creating and resolving this dependency.
-       */
-      reliesOnSequenceStepId: string;
-      /**
-       * The order number of the step that is responsible for creating and resolving this dependency.
-       */
-      reliesOnStepOrder: number;
-      /**
-       * The unique identifier of the sequence step that requires this dependency.
-       */
-      requiredBySequenceStepId: string;
-      /**
-       * The order number of the step that requires this dependency.
-       */
-      requiredByStepOrder: number;
-      /**
-       * The date and time when the step dependency was last updated.
-       */
-      updatedAt: string;
-    }
+  export interface GetInput {
+    sequenceId: string;
+    userId: string;
+  }
 
-    export interface PublicSequenceStepResponse {
-      /**
-       * The type of action to be performed in the sequence step.
-       */
-      actionType: 'EMAIL' | 'FINISH_ENROLLMENT' | 'TASK';
-      /**
-       * The date and time when the sequence step was created.
-       */
-      createdAt: string;
-      /**
-       * The delay in milliseconds before the sequence step is executed.
-       */
-      delayMillis: number;
-      emailPattern?: Schemas.PublicEmailPatternResponse;
-      /**
-       * The unique identifier of the sequence step.
-       */
-      id: string;
-      /**
-       * The order of the step within the sequence.
-       */
-      stepOrder: number;
-      taskPattern?: Schemas.PublicTaskPatternResponse;
-      /**
-       * The date and time when the sequence step was last updated.
-       */
-      updatedAt: string;
-    }
+  export type GetOutput = AutomationSequencesSchemas.PublicSequenceResponse;
 
-    export interface PublicTaskPatternResponse {
-      /**
-       * The date and time when the task pattern was created.
-       */
-      createdAt: string;
-      /**
-       * The unique identifier for the task pattern.
-       */
-      id: string;
-      /**
-       * Additional notes or comments associated with the task.
-       */
-      notes?: string;
-      /**
-       * The identifier for the queue associated with the task.
-       */
-      queueId?: number;
-      /**
-       * The subject line of the task.
-       */
-      subject?: string;
-      /**
-       * The priority level assigned to the task.
-       */
-      taskPriority: 'HIGH' | 'LOW' | 'MEDIUM' | 'NONE';
-      /**
-       * The type of task, such as an email or call.
-       */
-      taskType:
-        | 'CALL'
-        | 'EMAIL'
-        | 'LINKED_IN_CONNECT'
-        | 'LINKED_IN_MESSAGE'
-        | 'MEETING'
-        | 'TODO';
-      /**
-       * The identifier for the template used in the task.
-       */
-      templateId?: number;
-      /**
-       * The order of the step to which the email thread is related.
-       */
-      threadEmailToStepOrder?: number;
-      /**
-       * The date and time when the task pattern was last updated.
-       */
-      updatedAt: string;
-    }
+  export interface ListInput {
+    /**
+     * The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
+     */
+    after?: string;
+    /**
+     * The maximum number of results to display per page.
+     */
+    limit?: number;
+    name?: string;
+    userId: string;
   }
 
+  export type ListOutput =
+    AutomationSequencesSchemas.CollectionResponseWithTotalPublicSequenceLiteResponse;
   /**
    * Usage example:
    * ```ts
    * import { automationSequences } from '@hubspot/api-client-core';
-   * client.send(automationSequences.basic.createEnrollment(input));
+   * client.send(automationSequences.createEnrollment(input));
    * ```
    */
-  export interface BasicAPI {
+  export interface API {
     /**
      * Enroll a contact in a sequence
      * @apiPath /automation/sequences/2026-03/enrollments
@@ -416,15 +413,15 @@ export namespace AutomationSequences {
      * @requiredScopes sequences-enrollments-public-write-access
      */
     createEnrollment: (
-      input: Basic.CreateEnrollmentInput
-    ) => Operation<Basic.CreateEnrollmentOutput>;
+      input: CreateEnrollmentInput
+    ) => Operation<CreateEnrollmentOutput>;
     /**
      * Retrieve details for a sequence
      * @apiPath /automation/sequences/2026-03/{sequenceId}
      * @apiMethod GET
      * @requiredScopes sequences-public-read-access
      */
-    get: (input: Basic.GetInput) => Operation<Basic.GetOutput>;
+    get: (input: GetInput) => Operation<GetOutput>;
     /**
      * Retrieve the enrollment status of a contact
      * @apiPath /automation/sequences/2026-03/enrollments/contact/{contactId}
@@ -432,25 +429,14 @@ export namespace AutomationSequences {
      * @requiredScopes sequences-public-read-access
      */
     getEnrollmentByContactId: (
-      input: Basic.GetEnrollmentByContactIdInput
-    ) => Operation<Basic.GetEnrollmentByContactIdOutput>;
+      input: GetEnrollmentByContactIdInput
+    ) => Operation<GetEnrollmentByContactIdOutput>;
     /**
      * Retrieve sequences
      * @apiPath /automation/sequences/2026-03
      * @apiMethod GET
      * @requiredScopes sequences-public-read-access
      */
-    list: (input: Basic.ListInput) => Operation<Basic.ListOutput>;
-  }
-
-  /**
-   * Usage example:
-   * ```ts
-   * import { automationSequences } from '@hubspot/api-client-core';
-   * client.send(automationSequences.basic.createEnrollment(input));
-   * ```
-   */
-  export interface API {
-    basic: BasicAPI;
+    list: (input: ListInput) => Operation<ListOutput>;
   }
 }