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

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

@@ -0,0 +1,750 @@
+// DO NOT MODIFY - This code was generated by @hubspot/api-client-next-generator
+
+import type { Operation } from '../../types.ts';
+
+export namespace CRMAssociations {
+  export namespace Basic {
+    export interface DeleteInput {
+      objectId: string;
+      objectType: string;
+      toObjectId: string;
+      toObjectType: string;
+    }
+
+    export type DeleteOutput = void;
+
+    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;
+      objectId: string;
+      objectType: string;
+      toObjectType: string;
+    }
+
+    export type ListOutput =
+      Schemas.CollectionResponseMultiAssociatedObjectWithLabelForwardPaging;
+
+    export interface RequestHighUsageReportInput {
+      userId: number;
+    }
+
+    export type RequestHighUsageReportOutput = Schemas.ReportCreationResponse;
+
+    export interface UpdateAssociationLabelsInput {
+      data: Schemas.AssociationSpec[];
+      objectId: string;
+      objectType: string;
+      toObjectId: string;
+      toObjectType: string;
+    }
+
+    export type UpdateAssociationLabelsOutput = Schemas.LabelsBetweenObjectPair;
+  }
+
+  export namespace Batch {
+    export interface Create2Input {
+      fromObjectId: string;
+      fromObjectType: string;
+      toObjectId: string;
+      toObjectType: string;
+    }
+
+    export type Create2Output = Schemas.BatchResponsePublicDefaultAssociation;
+
+    export interface CreateDefaultInput {
+      data: Schemas.BatchInputPublicDefaultAssociationMultiPost;
+      fromObjectType: string;
+      toObjectType: string;
+    }
+
+    export type CreateDefaultOutput =
+      Schemas.BatchResponsePublicDefaultAssociation;
+
+    export interface CreateInput {
+      data: Schemas.BatchInputPublicAssociationMultiPost;
+      fromObjectType: string;
+      toObjectType: string;
+    }
+
+    export type CreateOutput = Schemas.BatchResponseLabelsBetweenObjectPair;
+
+    export interface DeleteInput {
+      data: Schemas.BatchInputPublicAssociationMultiArchive;
+      fromObjectType: string;
+      toObjectType: string;
+    }
+
+    export interface DeleteLabelsInput {
+      data: Schemas.BatchInputPublicAssociationMultiPost;
+      fromObjectType: string;
+      toObjectType: string;
+    }
+
+    export type DeleteLabelsOutput = void;
+
+    export type DeleteOutput = void;
+
+    export interface GetInput {
+      data: Schemas.BatchInputPublicFetchAssociationsBatchRequest;
+      fromObjectType: string;
+      toObjectType: string;
+    }
+
+    export type GetOutput =
+      Schemas.BatchResponsePublicAssociationMultiWithLabel;
+  }
+
+  export namespace Schemas {
+    /**
+     * Defines the type, direction, and details of the relationship between two CRM objects.
+     */
+    export interface AssociationSpec {
+      /**
+       * The category of the association, such as "HUBSPOT_DEFINED".
+       */
+      associationCategory:
+        | 'HUBSPOT_DEFINED'
+        | 'INTEGRATOR_DEFINED'
+        | 'USER_DEFINED'
+        | 'WORK';
+      /**
+       * The ID representing the specific type of association.
+       */
+      associationTypeId: number;
+    }
+
+    /**
+     * Defines the type, direction, and details of the relationship between two CRM objects.
+     */
+    export interface AssociationSpecWithLabel {
+      /**
+       * The category of the association, such as HUBSPOT_DEFINED, USER_DEFINED, or INTEGRATOR_DEFINED.
+       */
+      category:
+        | 'HUBSPOT_DEFINED'
+        | 'INTEGRATOR_DEFINED'
+        | 'USER_DEFINED'
+        | 'WORK';
+      /**
+       * A label describing the association between two objects.
+       */
+      label?: string;
+      /**
+       * The unique identifier for the type of association.
+       */
+      typeId: number;
+    }
+
+    export interface BatchInputPublicAssociationMultiArchive {
+      inputs: Schemas.PublicAssociationMultiArchive[];
+    }
+
+    export interface BatchInputPublicAssociationMultiPost {
+      inputs: Schemas.PublicAssociationMultiPost[];
+    }
+
+    export interface BatchInputPublicDefaultAssociationMultiPost {
+      inputs: Schemas.PublicDefaultAssociationMultiPost[];
+    }
+
+    export interface BatchInputPublicFetchAssociationsBatchRequest {
+      inputs: Schemas.PublicFetchAssociationsBatchRequest[];
+    }
+
+    export interface BatchResponseLabelsBetweenObjectPair {
+      /**
+       * The timestamp when the batch processing was completed, in ISO 8601 format.
+       */
+      completedAt: string;
+      /**
+       * An object containing relevant links related to the batch request.
+       */
+      links?: Record<string, string>;
+      /**
+       * The timestamp when the batch request was initially made, in ISO 8601 format.
+       */
+      requestedAt?: string;
+      results: Schemas.LabelsBetweenObjectPair[];
+      /**
+       * The timestamp when the batch processing began, in ISO 8601 format.
+       */
+      startedAt: string;
+      /**
+       * The status of the batch processing request: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE".
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+
+    export interface BatchResponsePublicAssociationMultiWithLabel {
+      /**
+       * The timestamp when the batch processing was completed, in ISO 8601 format.
+       */
+      completedAt: string;
+      /**
+       * An object containing relevant links related to the batch request.
+       */
+      links?: Record<string, string>;
+      /**
+       * The timestamp when the batch request was initially made, in ISO 8601 format.
+       */
+      requestedAt?: string;
+      results: Schemas.PublicAssociationMultiWithLabel[];
+      /**
+       * The timestamp when the batch processing began, in ISO 8601 format.
+       */
+      startedAt: string;
+      /**
+       * The status of the batch processing request: "PENDING", "PROCESSING", "CANCELED", or "COMPLETE".
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+
+    /**
+     * The response returned after performing a batch operation on associations.
+     */
+    export interface BatchResponsePublicDefaultAssociation {
+      /**
+       * The timestamp when the batch process was completed, in ISO 8601 format.
+       */
+      completedAt: string;
+      errors?: Schemas.StandardError[];
+      /**
+       * An object containing relevant links related to the batch request.
+       */
+      links?: Record<string, string>;
+      /**
+       * The number of errors encountered during the batch processing.
+       */
+      numErrors?: number;
+      /**
+       * The timestamp when the batch process was initiated, in ISO 8601 format.
+       */
+      requestedAt?: string;
+      results: Schemas.PublicDefaultAssociation[];
+      /**
+       * The timestamp when the batch process began execution, in ISO 8601 format.
+       */
+      startedAt: string;
+      /**
+       * The status of the batch processing request: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE".
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+
+    export interface CollectionResponseMultiAssociatedObjectWithLabelForwardPaging {
+      paging?: Schemas.ForwardPaging;
+      results: Schemas.MultiAssociatedObjectWithLabel[];
+    }
+
+    /**
+     * Represents a list of simple objects returned from an API request, along with the total count of objects available.
+     */
+    export interface CollectionResponseWithTotalSimplePublicObject {
+      paging?: Schemas.Paging;
+      results: Schemas.SimplePublicObject[];
+      /**
+       * The total number of objects in the collection.
+       */
+      total: number;
+    }
+
+    export interface DateTime {
+      /**
+       * Indicates whether the DateTime value represents only a date without a time component.
+       */
+      dateOnly: boolean;
+      /**
+       * The integer value representing the shift in minutes from UTC for the DateTime value.
+       */
+      timeZoneShift: number;
+      /**
+       * The integer value representing a specific point in time.
+       */
+      value: number;
+    }
+
+    export interface ErrorDetail {
+      /**
+       * The status code associated with the error detail
+       */
+      code?: string;
+      /**
+       * Context about the error condition
+       */
+      context?: Record<string, string[]>;
+      /**
+       * The name of the field or parameter in which the error was found.
+       */
+      in?: string;
+      /**
+       * A human readable message describing the error along with remediation steps where appropriate
+       */
+      message: string;
+      /**
+       * A specific category that contains more specific detail about the error
+       */
+      subCategory?: string;
+    }
+
+    /**
+     * Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against.
+     */
+    export interface Filter {
+      /**
+       * The upper boundary value when using ranged-based filters.
+       */
+      highValue?: string;
+      /**
+       * The comparison operator used in the filter, such as "EQ" or "GT".
+       */
+      operator:
+        | 'BETWEEN'
+        | 'CONTAINS_TOKEN'
+        | 'EQ'
+        | 'GT'
+        | 'GTE'
+        | 'HAS_PROPERTY'
+        | 'IN'
+        | 'LT'
+        | 'LTE'
+        | 'NEQ'
+        | 'NOT_CONTAINS_TOKEN'
+        | 'NOT_HAS_PROPERTY'
+        | 'NOT_IN';
+      /**
+       * The name of the property to apply the filter to.
+       */
+      propertyName: string;
+      /**
+       * The value to match against the property.
+       */
+      value?: string;
+      /**
+       * The values to match against the property.
+       */
+      values?: string[];
+    }
+
+    export interface FilterGroup {
+      filters: Schemas.Filter[];
+    }
+
+    export interface ForwardPaging {
+      next?: Schemas.NextPage;
+    }
+
+    /**
+     * The relationship descriptors applicable between two object types.
+     */
+    export interface LabelsBetweenObjectPair {
+      /**
+       * The ID of the source object in the association.
+       */
+      fromObjectId: string;
+      /**
+       * The type ID of the source object in the association.
+       */
+      fromObjectTypeId: string;
+      /**
+       * An array of labels associated with the relationship between the objects.
+       */
+      labels: string[];
+      /**
+       * The ID of the target object in the association.
+       */
+      toObjectId: string;
+      /**
+       * The type ID of the target object in the association.
+       */
+      toObjectTypeId: string;
+    }
+
+    /**
+     * Represents an object that is associated with multiple other objects, with optional context.
+     */
+    export interface MultiAssociatedObjectWithLabel {
+      associationTypes: Schemas.AssociationSpecWithLabel[];
+      /**
+       * The unique identifier for the target object in the association.
+       */
+      toObjectId: 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 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 paging cursor token for retrieving previous pages.
+       */
+      before: string;
+      /**
+       * A URL that can be used to retrieve the previous pages' results.
+       */
+      link?: string;
+    }
+
+    export interface PublicAssociationMultiArchive {
+      from: Schemas.PublicObjectId;
+      to: Schemas.PublicObjectId[];
+    }
+
+    export interface PublicAssociationMultiPost {
+      from: Schemas.PublicObjectId;
+      to: Schemas.PublicObjectId;
+      types: Schemas.AssociationSpec[];
+    }
+
+    export interface PublicAssociationMultiWithLabel {
+      from: Schemas.PublicObjectId;
+      paging?: Schemas.Paging;
+      to: Schemas.MultiAssociatedObjectWithLabel[];
+    }
+
+    export interface PublicDefaultAssociation {
+      associationSpec: Schemas.AssociationSpec;
+      from: Schemas.PublicObjectId;
+      to: Schemas.PublicObjectId;
+    }
+
+    export interface PublicDefaultAssociationMultiPost {
+      from: Schemas.PublicObjectId;
+      to: Schemas.PublicObjectId;
+    }
+
+    export interface PublicFetchAssociationsBatchRequest {
+      /**
+       * A paging cursor token used to retrieve the next set of results in a paginated response.
+       */
+      after?: string;
+      /**
+       * The unique identifier for the object whose associations are being fetched.
+       */
+      id: string;
+    }
+
+    /**
+     * Contains the Id of a Public Object
+     */
+    export interface PublicObjectId {
+      /**
+       * ID of the object
+       */
+      id: string;
+    }
+
+    /**
+     * Describes a search request
+     */
+    export interface PublicObjectSearchRequest {
+      /**
+       * A paging cursor token for retrieving subsequent pages.
+       */
+      after: string;
+      /**
+       * Up to 6 groups of filters defining additional query criteria.
+       */
+      filterGroups: Schemas.FilterGroup[];
+      /**
+       * The maximum results to return, up to 200 objects.
+       */
+      limit: number;
+      /**
+       * A list of property names to include in the response.
+       */
+      properties: string[];
+      /**
+       * The search query string, up to 3000 characters.
+       */
+      query?: string;
+      /**
+       * Specifies sorting order based on object properties.
+       */
+      sorts: string[];
+    }
+
+    export interface ReportCreationResponse {
+      enqueueTime: Schemas.DateTime;
+      /**
+       * Email of the user
+       */
+      userEmail: string;
+      /**
+       * ID of the user
+       */
+      userId: number;
+    }
+
+    /**
+     * A simple public object.
+     */
+    export interface SimplePublicObject {
+      /**
+       * Whether the object is archived.
+       */
+      archived: boolean;
+      /**
+       * The timestamp when the object was archived, in ISO 8601 format.
+       */
+      archivedAt?: string;
+      /**
+       * The timestamp when the object was created, in ISO 8601 format.
+       */
+      createdAt: string;
+      /**
+       * The unique ID of the object.
+       */
+      id: string;
+      /**
+       * A unique identifier for tracing the creation request.
+       */
+      objectWriteTraceId?: string;
+      /**
+       * Key-value pairs representing the properties of the object.
+       */
+      properties: Record<string, string>;
+      /**
+       * Key-value pairs representing the properties of the object along with their history.
+       */
+      propertiesWithHistory?: Record<string, Schemas.ValueWithTimestamp[]>;
+      /**
+       * The timestamp when the object was last updated, in ISO 8601 format.
+       */
+      updatedAt: string;
+      /**
+       * The URL associated with the object.
+       */
+      url?: string;
+    }
+
+    /**
+     * Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.
+     */
+    export interface StandardError {
+      /**
+       * The main category of the error.
+       */
+      category: string;
+      /**
+       * Additional context-specific information related to the error.
+       */
+      context: Record<string, string[]>;
+      /**
+       * The detailed error objects.
+       */
+      errors: Schemas.ErrorDetail[];
+      /**
+       * A unique ID for the error instance.
+       */
+      id?: string;
+      /**
+       * URLs linking to documentation or resources associated with the error.
+       */
+      links: Record<string, string>;
+      /**
+       * A human-readable string describing the error and possible remediation steps.
+       */
+      message: string;
+      /**
+       * The HTTP status code associated with the error.
+       */
+      status: string;
+      /**
+       * A more specific error category within each main category.
+       */
+      subCategory?: Record<string, never>;
+    }
+
+    /**
+     * Property model that includes timestamp.
+     */
+    export interface ValueWithTimestamp {
+      /**
+       * The unique ID of the property.
+       */
+      sourceId?: string;
+      /**
+       * A human-readable label.
+       */
+      sourceLabel?: string;
+      /**
+       * The property type.
+       */
+      sourceType: string;
+      /**
+       * The timestamp when the property was updated, in ISO 8601 format.
+       */
+      timestamp: string;
+      /**
+       * The ID of the user who last updated the property.
+       */
+      updatedByUserId?: number;
+      /**
+       * The property value.
+       */
+      value: string;
+    }
+  }
+
+  export namespace Search {
+    export interface SearchInput {
+      data: Schemas.PublicObjectSearchRequest;
+      objectType: string;
+    }
+
+    export type SearchOutput =
+      Schemas.CollectionResponseWithTotalSimplePublicObject;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmAssociations } from '@hubspot/api-client-core';
+   * client.send(crmAssociations.basic.delete(input));
+   * ```
+   */
+  export interface BasicAPI {
+    /**
+     * Delete associations between two records
+     * @apiPath /crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}
+     * @apiMethod DELETE
+     * @requiredScopes crm-public-object-api-access, oauth, oauth-access
+     */
+    delete: (input: Basic.DeleteInput) => Operation<Basic.DeleteOutput>;
+    /**
+     * Retrieve all associations by object type
+     * @apiPath /crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}
+     * @apiMethod GET
+     * @requiredScopes crm-public-object-api-access, oauth, oauth-access
+     */
+    list: (input: Basic.ListInput) => Operation<Basic.ListOutput>;
+    /**
+     * Report high usage
+     * @apiPath /crm/associations/2026-03/usage/high-usage-report/{userId}
+     * @apiMethod POST
+     * @requiredScopes crm-public-object-api-access
+     */
+    requestHighUsageReport: (
+      input: Basic.RequestHighUsageReportInput
+    ) => Operation<Basic.RequestHighUsageReportOutput>;
+    /**
+     * Associate records (labelled)
+     * @apiPath /crm/objects/2026-03/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}
+     * @apiMethod PUT
+     * @requiredScopes crm-public-object-api-access, oauth, oauth-access
+     */
+    updateAssociationLabels: (
+      input: Basic.UpdateAssociationLabelsInput
+    ) => Operation<Basic.UpdateAssociationLabelsOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmAssociations } from '@hubspot/api-client-core';
+   * client.send(crmAssociations.batch.create(input));
+   * ```
+   */
+  export interface BatchAPI {
+    /**
+     * Associate records (labelled)
+     * @apiPath /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/create
+     * @apiMethod POST
+     * @requiredScopes crm-public-object-api-access
+     */
+    create: (input: Batch.CreateInput) => Operation<Batch.CreateOutput>;
+    /**
+     * Associate records (default)
+     * @apiPath /crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}
+     * @apiMethod PUT
+     * @requiredScopes crm-public-object-api-access, oauth, oauth-access
+     */
+    create2: (input: Batch.Create2Input) => Operation<Batch.Create2Output>;
+    /**
+     * Associate records (default)
+     * @apiPath /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/associate/default
+     * @apiMethod POST
+     * @requiredScopes crm-public-object-api-access
+     */
+    createDefault: (
+      input: Batch.CreateDefaultInput
+    ) => Operation<Batch.CreateDefaultOutput>;
+    /**
+     * Remove associations
+     * @apiPath /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/archive
+     * @apiMethod POST
+     * @requiredScopes crm-public-object-api-access
+     */
+    delete: (input: Batch.DeleteInput) => Operation<Batch.DeleteOutput>;
+    /**
+     * Delete specific labels
+     * @apiPath /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/labels/archive
+     * @apiMethod POST
+     * @requiredScopes crm-public-object-api-access
+     */
+    deleteLabels: (
+      input: Batch.DeleteLabelsInput
+    ) => Operation<Batch.DeleteLabelsOutput>;
+    /**
+     * Retrieve associations
+     * @apiPath /crm/associations/2026-03/{fromObjectType}/{toObjectType}/batch/read
+     * @apiMethod POST
+     * @requiredScopes crm-public-object-api-access
+     */
+    get: (input: Batch.GetInput) => Operation<Batch.GetOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmAssociations } from '@hubspot/api-client-core';
+   * client.send(crmAssociations.search.search(input));
+   * ```
+   */
+  export interface SearchAPI {
+    /**
+     * @apiPath /crm/objects/2026-03/{objectType}/search
+     * @apiMethod POST
+     * @requiredScopes crm-public-object-api-access, oauth, oauth-access
+     */
+    search: (input: Search.SearchInput) => Operation<Search.SearchOutput>;
+  }
+
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmAssociations } from '@hubspot/api-client-core';
+   * client.send(crmAssociations.basic.delete(input));
+   * ```
+   */
+  export interface API {
+    basic: BasicAPI;
+    batch: BatchAPI;
+    search: SearchAPI;
+  }
+}