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

package/src/server/api-client-core/apis/crm/associations.generated.ts

@@ -0,0 +1,134 @@
+import { op } from '../../op.ts';
+import type { CRMAssociations } from './associations-types.generated.ts';
+
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+export * from './associations-types.generated.ts';
+
+const basic: CRMAssociations.BasicAPI = {
+  delete: (input) =>
+    op.del(
+      '/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}',
+      {
+        pathParams: {
+          objectId: input.objectId,
+          objectType: input.objectType,
+          toObjectId: input.toObjectId,
+          toObjectType: input.toObjectType,
+        },
+      }
+    ),
+  list: (input) =>
+    op.get(
+      '/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}',
+      {
+        pathParams: {
+          objectId: input.objectId,
+          objectType: input.objectType,
+          toObjectType: input.toObjectType,
+        },
+        queryParams: { after: input.after, limit: input.limit },
+      }
+    ),
+  requestHighUsageReport: (input) =>
+    op.post('/crm/associations/2026-03/usage/high-usage-report/{userId}', {
+      pathParams: { userId: input.userId },
+    }),
+  updateAssociationLabels: (input) =>
+    op.put(
+      '/crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}',
+      {
+        pathParams: {
+          objectId: input.objectId,
+          objectType: input.objectType,
+          toObjectId: input.toObjectId,
+          toObjectType: input.toObjectType,
+        },
+        body: input.data,
+      }
+    ),
+};
+
+const batch: CRMAssociations.BatchAPI = {
+  create: (input) =>
+    op.post(
+      '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/create',
+      {
+        pathParams: {
+          fromObjectType: input.fromObjectType,
+          toObjectType: input.toObjectType,
+        },
+        body: input.data,
+      }
+    ),
+  create2: (input) =>
+    op.put(
+      '/crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}',
+      {
+        pathParams: {
+          fromObjectId: input.fromObjectId,
+          fromObjectType: input.fromObjectType,
+          toObjectId: input.toObjectId,
+          toObjectType: input.toObjectType,
+        },
+      }
+    ),
+  createDefault: (input) =>
+    op.post(
+      '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/associate/default',
+      {
+        pathParams: {
+          fromObjectType: input.fromObjectType,
+          toObjectType: input.toObjectType,
+        },
+        body: input.data,
+      }
+    ),
+  delete: (input) =>
+    op.post(
+      '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive',
+      {
+        pathParams: {
+          fromObjectType: input.fromObjectType,
+          toObjectType: input.toObjectType,
+        },
+        body: input.data,
+      }
+    ),
+  deleteLabels: (input) =>
+    op.post(
+      '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive',
+      {
+        pathParams: {
+          fromObjectType: input.fromObjectType,
+          toObjectType: input.toObjectType,
+        },
+        body: input.data,
+      }
+    ),
+  get: (input) =>
+    op.post(
+      '/crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/read',
+      {
+        pathParams: {
+          fromObjectType: input.fromObjectType,
+          toObjectType: input.toObjectType,
+        },
+        body: input.data,
+      }
+    ),
+};
+
+const search: CRMAssociations.SearchAPI = {
+  search: (input) =>
+    op.post('/crm/objects/2026-03/{objectType}/search', {
+      pathParams: { objectType: input.objectType },
+      body: input.data,
+    }),
+};
+
+export const crmAssociations: CRMAssociations.API = {
+  basic: basic,
+  batch: batch,
+  search: search,
+};

package/src/server/api-client-core/apis/crm/calling-extensions-types.generated.ts

@@ -0,0 +1,565 @@
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+import type { Operation } from '../../types.ts';
+
+export namespace CRMCallingExtensions {
+  export namespace Advanced {
+    export type CreateInboundCallInput = Schemas.CompletedThirdPartyCallRequest;
+
+    export type CreateInboundCallOutput =
+      Schemas.CompletedThirdPartyCallResponse;
+
+    export type CreateRecordingReadyInput = Schemas.MarkRecordingAsReadyRequest;
+
+    export type CreateRecordingReadyOutput = void;
+  }
+
+  export namespace Basic {
+    export interface CreateChannelConnectionSettingsInput {
+      appId: number;
+      data: Schemas.ChannelConnectionSettingsRequest;
+    }
+
+    export type CreateChannelConnectionSettingsOutput =
+      Schemas.ChannelConnectionSettingsResponse;
+
+    export interface CreateRecordingSettingsInput {
+      appId: number;
+      data: Schemas.RecordingSettingsRequest;
+    }
+
+    export type CreateRecordingSettingsOutput =
+      Schemas.RecordingSettingsResponse;
+
+    export interface CreateSettingsInput {
+      appId: number;
+      data: Schemas.SettingsRequest;
+    }
+
+    export type CreateSettingsOutput = Schemas.SettingsResponse;
+
+    export interface DeleteChannelConnectionSettingsInput {
+      appId: number;
+    }
+
+    export type DeleteChannelConnectionSettingsOutput = void;
+
+    export interface DeleteSettingsInput {
+      appId: number;
+    }
+
+    export type DeleteSettingsOutput = void;
+
+    export interface GetChannelConnectionSettingsInput {
+      appId: number;
+    }
+
+    export type GetChannelConnectionSettingsOutput =
+      Schemas.ChannelConnectionSettingsResponse;
+
+    export interface GetRecordingSettingsInput {
+      appId: number;
+    }
+
+    export type GetRecordingSettingsOutput = Schemas.RecordingSettingsResponse;
+
+    export interface GetSettingsInput {
+      appId: number;
+    }
+
+    export type GetSettingsOutput = Schemas.SettingsResponse;
+
+    export interface UpdateChannelConnectionSettingsInput {
+      appId: number;
+      data: Schemas.ChannelConnectionSettingsPatchRequest;
+    }
+
+    export type UpdateChannelConnectionSettingsOutput =
+      Schemas.ChannelConnectionSettingsResponse;
+
+    export interface UpdateRecordingSettingsInput {
+      appId: number;
+      data: Schemas.RecordingSettingsPatchRequest;
+    }
+
+    export type UpdateRecordingSettingsOutput =
+      Schemas.RecordingSettingsResponse;
+
+    export interface UpdateSettingsInput {
+      appId: number;
+      data: Schemas.SettingsPatchRequest;
+    }
+
+    export type UpdateSettingsOutput = Schemas.SettingsResponse;
+  }
+
+  export namespace Schemas {
+    export interface ChannelConnectionSettingsPatchRequest {
+      /**
+       * Indicates whether the channel connection settings are ready.
+       */
+      isReady?: boolean;
+      /**
+       * The URL for the channel connection settings.
+       */
+      url?: string;
+    }
+
+    export interface ChannelConnectionSettingsRequest {
+      /**
+       * Indicates whether the channel connection settings are ready.
+       */
+      isReady: boolean;
+      /**
+       * The URL associated with the channel connection settings.
+       */
+      url: string;
+    }
+
+    export interface ChannelConnectionSettingsResponse {
+      /**
+       * The date and time when the channel connection settings were created.
+       */
+      createdAt: string;
+      /**
+       * Indicates whether the channel connection settings are ready for use.
+       */
+      isReady: boolean;
+      /**
+       * The date and time when the channel connection settings were last updated.
+       */
+      updatedAt: string;
+      /**
+       * The URL associated with the channel connection settings.
+       */
+      url: string;
+    }
+
+    export interface CompanyCallerId {
+      /**
+       * Specifies the type of caller ID, which is set to 'COMPANY' by default.
+       */
+      callerIdType: 'COMPANY';
+      /**
+       * The name associated with the company caller ID.
+       */
+      name?: string;
+      objectCoordinates: Schemas.ObjectCoordinates;
+    }
+
+    export interface CompletedThirdPartyCallRequest {
+      /**
+       * The timestamp indicating when the call started, formatted as a date-time string.
+       */
+      callStartedTimestamp?: string;
+      /**
+       * Indicates whether an engagement should be created for the call.
+       */
+      createEngagement: boolean;
+      /**
+       * The duration of the call in seconds.
+       */
+      durationSeconds?: number;
+      /**
+       * Contains additional properties related to the engagement.
+       */
+      engagementProperties: Record<string, string>;
+      /**
+       * The unique identifier for the call from an external system.
+       */
+      externalCallId: string;
+      /**
+       * The final status of the call, with accepted values including: BUSY, CALLING_CRM_USER, CANCELED, COMPLETED, CONNECTING, FAILED, HOLD, IN_PROGRESS, MISSED, NO_ANSWER, QUEUED, RINGING, UNKNOWN.
+       */
+      finalCallStatus:
+        | 'BUSY'
+        | 'CALLING_CRM_USER'
+        | 'CANCELED'
+        | 'COMPLETED'
+        | 'CONNECTING'
+        | 'FAILED'
+        | 'HOLD'
+        | 'IN_PROGRESS'
+        | 'MISSED'
+        | 'NO_ANSWER'
+        | 'QUEUED'
+        | 'RINGING'
+        | 'UNKNOWN';
+      fromNumber: Schemas.FormattedPhoneNumber;
+      potentialRecipientUserIds: number[];
+      toNumber: Schemas.FormattedPhoneNumber;
+      /**
+       * The ID of the user associated with the call.
+       */
+      userId?: number;
+    }
+
+    export interface CompletedThirdPartyCallResponse {
+      callerIdMatches: (Schemas.ContactCallerId | Schemas.CompanyCallerId)[];
+    }
+
+    export interface ContactCallerId {
+      /**
+       * Specifies the type of caller ID, with the default value being CONTACT.
+       */
+      callerIdType: 'CONTACT';
+      /**
+       * The email address of the contact.
+       */
+      email?: string;
+      /**
+       * The first name of the contact.
+       */
+      firstName?: string;
+      /**
+       * The last name of the contact.
+       */
+      lastName?: string;
+      objectCoordinates: Schemas.ObjectCoordinates;
+    }
+
+    export interface FormattedPhoneNumber {
+      /**
+       * The phone number formatted in E.164 standard.
+       */
+      e164Number: string;
+      /**
+       * The extension number associated with the phone number.
+       */
+      extension?: string;
+      /**
+       * The type of phone number, with accepted values including FIXED_LINE, MOBILE, VOIP, and others.
+       */
+      phoneNumberType:
+        | 'FIXED_LINE'
+        | 'FIXED_LINE_OR_MOBILE'
+        | 'MOBILE'
+        | 'PAGER'
+        | 'PERSONAL_NUMBER'
+        | 'PREMIUM_RATE'
+        | 'SHARED_COST'
+        | 'TOLL_FREE'
+        | 'UAN'
+        | 'UNKNOWN'
+        | 'VOICEMAIL'
+        | 'VOIP';
+    }
+
+    export interface MarkRecordingAsReadyRequest {
+      /**
+       * The unique identifier for the engagement associated with the call recording.
+       */
+      engagementId: number;
+    }
+
+    export interface ObjectCoordinates {
+      /**
+       * The unique identifier for the object.
+       */
+      objectId: number;
+      /**
+       * The type identifier for the object.
+       */
+      objectTypeId: string;
+      /**
+       * The unique identifier for the portal.
+       */
+      portalId: number;
+    }
+
+    export interface RecordingSettingsPatchRequest {
+      /**
+       * The URL used to access authenticated call recordings.
+       */
+      urlToRetrieveAuthedRecording?: string;
+    }
+
+    export interface RecordingSettingsRequest {
+      /**
+       * The URL used to access authenticated call recordings.
+       */
+      urlToRetrieveAuthedRecording: string;
+    }
+
+    export interface RecordingSettingsResponse {
+      /**
+       * The URL used to retrieve authenticated call recordings.
+       */
+      urlToRetrieveAuthedRecording: string;
+    }
+
+    export interface SettingsPatchRequest {
+      /**
+       * The height setting for the calling extension interface.
+       */
+      height?: number;
+      /**
+       * Specifies whether the calling extension is ready for use.
+       */
+      isReady?: boolean;
+      /**
+       * The name of the calling extension.
+       */
+      name?: string;
+      /**
+       * Indicates if the calling extension supports custom objects.
+       */
+      supportsCustomObjects?: boolean;
+      /**
+       * Indicates if the calling extension supports inbound calling.
+       */
+      supportsInboundCalling?: boolean;
+      /**
+       * The URL associated with the calling extension settings.
+       */
+      url?: string;
+      /**
+       * Indicates if the calling extension uses a calling window.
+       */
+      usesCallingWindow?: boolean;
+      /**
+       * Indicates if the calling extension uses a remote connection.
+       */
+      usesRemote?: boolean;
+      /**
+       * The width setting for the calling extension interface.
+       */
+      width?: number;
+    }
+
+    export interface SettingsRequest {
+      /**
+       * Specifies the height of the calling extension interface.
+       */
+      height: number;
+      /**
+       * Indicates if the calling extension is ready for use.
+       */
+      isReady: boolean;
+      /**
+       * The name of the calling extension.
+       */
+      name: string;
+      /**
+       * Indicates if the calling extension supports custom objects.
+       */
+      supportsCustomObjects: boolean;
+      /**
+       * Indicates if the calling extension supports inbound calling.
+       */
+      supportsInboundCalling: boolean;
+      /**
+       * The URL associated with the calling extension.
+       */
+      url: string;
+      /**
+       * Indicates if the calling extension uses a separate calling window.
+       */
+      usesCallingWindow: boolean;
+      /**
+       * Indicates if the calling extension uses remote services.
+       */
+      usesRemote: boolean;
+      /**
+       * Specifies the width of the calling extension interface.
+       */
+      width: number;
+    }
+
+    export interface SettingsResponse {
+      /**
+       * The date and time when the calling extension settings were created.
+       */
+      createdAt: string;
+      /**
+       * The height of the calling extension interface.
+       */
+      height: number;
+      /**
+       * Specifies whether the calling extension settings are ready for use.
+       */
+      isReady: boolean;
+      /**
+       * The name of the calling extension.
+       */
+      name: string;
+      /**
+       * Indicates if the calling extension supports custom objects.
+       */
+      supportsCustomObjects: boolean;
+      /**
+       * Indicates if the calling extension supports inbound calling.
+       */
+      supportsInboundCalling: boolean;
+      /**
+       * The date and time when the calling extension settings were last updated.
+       */
+      updatedAt: string;
+      /**
+       * The URL associated with the calling extension.
+       */
+      url: string;
+      /**
+       * Specifies if the calling extension uses a dedicated calling window.
+       */
+      usesCallingWindow: boolean;
+      /**
+       * Indicates if the calling extension uses a remote service.
+       */
+      usesRemote: boolean;
+      /**
+       * The width of the calling extension interface.
+       */
+      width: number;
+    }
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmCallingExtensions } from '@hubspot/api-client-core';
+   * client.send(crmCallingExtensions.advanced.createInboundCall(input));
+   * ```
+   */
+  export interface AdvancedAPI {
+    /**
+     * Submit details of an inbound call to the CRM.
+     * @apiPath /crm/extensions/calling/2026-03/inbound-call
+     * @apiMethod POST
+     * @requiredScopes contacts-write
+     */
+    createInboundCall: (
+      input: Advanced.CreateInboundCallInput
+    ) => Operation<Advanced.CreateInboundCallOutput>;
+    /**
+     * Mark a call recording as ready for retrieval.
+     * @apiPath /crm/extensions/calling/2026-03/recordings/ready
+     * @apiMethod POST
+     * @requiredScopes contacts-write
+     */
+    createRecordingReady: (
+      input: Advanced.CreateRecordingReadyInput
+    ) => Operation<Advanced.CreateRecordingReadyOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmCallingExtensions } from '@hubspot/api-client-core';
+   * client.send(crmCallingExtensions.basic.createChannelConnectionSettings(input));
+   * ```
+   */
+  export interface BasicAPI {
+    /**
+     * Create new channel connection settings for a specific app.
+     * @apiPath /crm/extensions/calling/2026-03/{appId}/settings/channel-connection
+     * @apiMethod POST
+     * @requiredScopes developers-write
+     */
+    createChannelConnectionSettings: (
+      input: Basic.CreateChannelConnectionSettingsInput
+    ) => Operation<Basic.CreateChannelConnectionSettingsOutput>;
+    /**
+     * Create recording settings for an app.
+     * @apiPath /crm/extensions/calling/2026-03/{appId}/settings/recording
+     * @apiMethod POST
+     * @requiredScopes developers-write
+     */
+    createRecordingSettings: (
+      input: Basic.CreateRecordingSettingsInput
+    ) => Operation<Basic.CreateRecordingSettingsOutput>;
+    /**
+     * Create new calling extension settings for a specific app.
+     * @apiPath /crm/extensions/calling/2026-03/{appId}/settings
+     * @apiMethod POST
+     * @requiredScopes developers-write
+     */
+    createSettings: (
+      input: Basic.CreateSettingsInput
+    ) => Operation<Basic.CreateSettingsOutput>;
+    /**
+     * Remove the channel connection settings for a specific app.
+     * @apiPath /crm/extensions/calling/2026-03/{appId}/settings/channel-connection
+     * @apiMethod DELETE
+     * @requiredScopes developers-write
+     */
+    deleteChannelConnectionSettings: (
+      input: Basic.DeleteChannelConnectionSettingsInput
+    ) => Operation<Basic.DeleteChannelConnectionSettingsOutput>;
+    /**
+     * Delete the calling extension settings for a specific app.
+     * @apiPath /crm/extensions/calling/2026-03/{appId}/settings
+     * @apiMethod DELETE
+     * @requiredScopes developers-write
+     */
+    deleteSettings: (
+      input: Basic.DeleteSettingsInput
+    ) => Operation<Basic.DeleteSettingsOutput>;
+    /**
+     * Retrieve the channel connection settings for a specific app.
+     * @apiPath /crm/extensions/calling/2026-03/{appId}/settings/channel-connection
+     * @apiMethod GET
+     * @requiredScopes developers-read
+     */
+    getChannelConnectionSettings: (
+      input: Basic.GetChannelConnectionSettingsInput
+    ) => Operation<Basic.GetChannelConnectionSettingsOutput>;
+    /**
+     * Retrieve recording settings for an app.
+     * @apiPath /crm/extensions/calling/2026-03/{appId}/settings/recording
+     * @apiMethod GET
+     * @requiredScopes developers-read
+     */
+    getRecordingSettings: (
+      input: Basic.GetRecordingSettingsInput
+    ) => Operation<Basic.GetRecordingSettingsOutput>;
+    /**
+     * Retrieve the calling extension settings for a specific app.
+     * @apiPath /crm/extensions/calling/2026-03/{appId}/settings
+     * @apiMethod GET
+     * @requiredScopes developers-read
+     */
+    getSettings: (
+      input: Basic.GetSettingsInput
+    ) => Operation<Basic.GetSettingsOutput>;
+    /**
+     * Update the channel connection settings for a specific app.
+     * @apiPath /crm/extensions/calling/2026-03/{appId}/settings/channel-connection
+     * @apiMethod PATCH
+     * @requiredScopes developers-write
+     */
+    updateChannelConnectionSettings: (
+      input: Basic.UpdateChannelConnectionSettingsInput
+    ) => Operation<Basic.UpdateChannelConnectionSettingsOutput>;
+    /**
+     * Update recording settings for an app.
+     * @apiPath /crm/extensions/calling/2026-03/{appId}/settings/recording
+     * @apiMethod PATCH
+     * @requiredScopes developers-write
+     */
+    updateRecordingSettings: (
+      input: Basic.UpdateRecordingSettingsInput
+    ) => Operation<Basic.UpdateRecordingSettingsOutput>;
+    /**
+     * Update the calling extension settings for a specific app.
+     * @apiPath /crm/extensions/calling/2026-03/{appId}/settings
+     * @apiMethod PATCH
+     * @requiredScopes developers-write
+     */
+    updateSettings: (
+      input: Basic.UpdateSettingsInput
+    ) => Operation<Basic.UpdateSettingsOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmCallingExtensions } from '@hubspot/api-client-core';
+   * client.send(crmCallingExtensions.advanced.createInboundCall(input));
+   * ```
+   */
+  export interface API {
+    advanced: AdvancedAPI;
+    basic: BasicAPI;
+  }
+}