@hubspot/app-connect-sdk 1.0.0-alpha.1

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

@@ -0,0 +1,166 @@
+import { op } from '../../op.ts';
+import type { AutomationActions } from './actions-types.generated.ts';
+
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+export * from './actions-types.generated.ts';
+
+const callbacks: AutomationActions.CallbacksAPI = {
+  complete: (input) =>
+    op.post('/automation/actions/callbacks/2026-03/{callbackId}/complete', {
+      pathParams: { callbackId: input.callbackId },
+      body: input.data,
+    }),
+  completeBatch: (input) =>
+    op.post('/automation/actions/callbacks/2026-03/complete', { body: input }),
+};
+
+const definitions: AutomationActions.DefinitionsAPI = {
+  create: (input) =>
+    op.post('/automation/actions/2026-03/{appId}', {
+      pathParams: { appId: input.appId },
+      body: input.data,
+    }),
+  createRequiresObject: (input) =>
+    op.post(
+      '/automation/actions/2026-03/{appId}/{definitionId}/requires-object',
+      {
+        pathParams: { appId: input.appId, definitionId: input.definitionId },
+        body: input.data,
+      }
+    ),
+  delete: (input) =>
+    op.del('/automation/actions/2026-03/{appId}/{definitionId}', {
+      pathParams: { appId: input.appId, definitionId: input.definitionId },
+    }),
+  get: (input) =>
+    op.get('/automation/actions/2026-03/{appId}/{definitionId}', {
+      pathParams: { appId: input.appId, definitionId: input.definitionId },
+      queryParams: { archived: input.archived },
+    }),
+  getRequiresObject: (input) =>
+    op.get(
+      '/automation/actions/2026-03/{appId}/{definitionId}/requires-object',
+      { pathParams: { appId: input.appId, definitionId: input.definitionId } }
+    ),
+  list: (input) =>
+    op.get('/automation/actions/2026-03/{appId}', {
+      pathParams: { appId: input.appId },
+      queryParams: {
+        after: input.after,
+        archived: input.archived,
+        limit: input.limit,
+      },
+    }),
+  update: (input) =>
+    op.patch('/automation/actions/2026-03/{appId}/{definitionId}', {
+      pathParams: { appId: input.appId, definitionId: input.definitionId },
+      body: input.data,
+    }),
+};
+
+const functions: AutomationActions.FunctionsAPI = {
+  createOrReplace: (input) =>
+    op.put(
+      '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}',
+      {
+        pathParams: {
+          appId: input.appId,
+          definitionId: input.definitionId,
+          functionId: input.functionId,
+          functionType: input.functionType,
+        },
+        body: input.data,
+        contentType: 'text/plain',
+      }
+    ),
+  createOrReplaceByFunctionType: (input) =>
+    op.put(
+      '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}',
+      {
+        pathParams: {
+          appId: input.appId,
+          definitionId: input.definitionId,
+          functionType: input.functionType,
+        },
+        body: input.data,
+        contentType: 'text/plain',
+      }
+    ),
+  delete: (input) =>
+    op.del(
+      '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}',
+      {
+        pathParams: {
+          appId: input.appId,
+          definitionId: input.definitionId,
+          functionId: input.functionId,
+          functionType: input.functionType,
+        },
+      }
+    ),
+  deleteByFunctionType: (input) =>
+    op.del(
+      '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}',
+      {
+        pathParams: {
+          appId: input.appId,
+          definitionId: input.definitionId,
+          functionType: input.functionType,
+        },
+      }
+    ),
+  get: (input) =>
+    op.get(
+      '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}/{functionId}',
+      {
+        pathParams: {
+          appId: input.appId,
+          definitionId: input.definitionId,
+          functionId: input.functionId,
+          functionType: input.functionType,
+        },
+      }
+    ),
+  getByFunctionType: (input) =>
+    op.get(
+      '/automation/actions/2026-03/{appId}/{definitionId}/functions/{functionType}',
+      {
+        pathParams: {
+          appId: input.appId,
+          definitionId: input.definitionId,
+          functionType: input.functionType,
+        },
+      }
+    ),
+  list: (input) =>
+    op.get('/automation/actions/2026-03/{appId}/{definitionId}/functions', {
+      pathParams: { appId: input.appId, definitionId: input.definitionId },
+    }),
+};
+
+const revisions: AutomationActions.RevisionsAPI = {
+  get: (input) =>
+    op.get(
+      '/automation/actions/2026-03/{appId}/{definitionId}/revisions/{revisionId}',
+      {
+        pathParams: {
+          appId: input.appId,
+          definitionId: input.definitionId,
+          revisionId: input.revisionId,
+        },
+      }
+    ),
+  list: (input) =>
+    op.get('/automation/actions/2026-03/{appId}/{definitionId}/revisions', {
+      pathParams: { appId: input.appId, definitionId: input.definitionId },
+      queryParams: { after: input.after, limit: input.limit },
+    }),
+};
+
+export const automationActions: AutomationActions.API = {
+  callbacks: callbacks,
+  definitions: definitions,
+  functions: functions,
+  revisions: revisions,
+};

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

@@ -0,0 +1,456 @@
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+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 interface GetEnrollmentByContactIdInput {
+      contactId: string;
+    }
+
+    export type GetEnrollmentByContactIdOutput =
+      Schemas.PublicSequenceEnrollmentResponse;
+
+    export interface GetInput {
+      sequenceId: string;
+      userId: string;
+    }
+
+    export type GetOutput = Schemas.PublicSequenceResponse;
+
+    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 =
+      Schemas.CollectionResponseWithTotalPublicSequenceLiteResponse;
+  }
+
+  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;
+    }
+
+    /**
+     * 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 interface Paging {
+      next?: Schemas.NextPage;
+      prev?: Schemas.PreviousPage;
+    }
+
+    /**
+     * 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 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 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 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 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;
+      /**
+       * 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 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 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 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 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 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;
+    }
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { automationSequences } from '@hubspot/api-client-core';
+   * client.send(automationSequences.basic.createEnrollment(input));
+   * ```
+   */
+  export interface BasicAPI {
+    /**
+     * Enroll a contact in a sequence
+     * @apiPath /automation/sequences/2026-03/enrollments
+     * @apiMethod POST
+     * @requiredScopes sequences-enrollments-public-write-access
+     */
+    createEnrollment: (
+      input: Basic.CreateEnrollmentInput
+    ) => Operation<Basic.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>;
+    /**
+     * Retrieve the enrollment status of a contact
+     * @apiPath /automation/sequences/2026-03/enrollments/contact/{contactId}
+     * @apiMethod GET
+     * @requiredScopes sequences-public-read-access
+     */
+    getEnrollmentByContactId: (
+      input: Basic.GetEnrollmentByContactIdInput
+    ) => Operation<Basic.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;
+  }
+}

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

@@ -0,0 +1,34 @@
+import { op } from '../../op.ts';
+import type { AutomationSequences } from './sequences-types.generated.ts';
+
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+export * from './sequences-types.generated.ts';
+
+const basic: AutomationSequences.BasicAPI = {
+  createEnrollment: (input) =>
+    op.post('/automation/sequences/2026-03/enrollments', {
+      queryParams: { userId: input.userId },
+      body: input.data,
+    }),
+  get: (input) =>
+    op.get('/automation/sequences/2026-03/{sequenceId}', {
+      pathParams: { sequenceId: input.sequenceId },
+      queryParams: { userId: input.userId },
+    }),
+  getEnrollmentByContactId: (input) =>
+    op.get('/automation/sequences/2026-03/enrollments/contact/{contactId}', {
+      pathParams: { contactId: input.contactId },
+    }),
+  list: (input) =>
+    op.get('/automation/sequences/2026-03', {
+      queryParams: {
+        userId: input.userId,
+        after: input.after,
+        limit: input.limit,
+        name: input.name,
+      },
+    }),
+};
+
+export const automationSequences: AutomationSequences.API = { basic: basic };