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

package/dist/server/api-client-core/apis/crm/objects-types.generated.d.ts

@@ -0,0 +1,712 @@
+import { Operation } from "../../types.js";
+
+//#region src/server/api-client-core/apis/crm/objects-types.generated.d.ts
+declare namespace CRMObjects {
+  namespace Basic {
+    interface CreateInput {
+      data: Schemas.SimplePublicObjectInputForCreate;
+      objectType: string;
+    }
+    type CreateOutput = Schemas.SimplePublicObject;
+    interface DeleteInput {
+      objectId: string;
+      objectType: string;
+    }
+    type DeleteOutput = void;
+    interface GetInput {
+      /**
+       * Whether to return only results that have been archived.
+       */
+      archived?: boolean;
+      /**
+       * A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
+       */
+      associations?: string[];
+      /**
+       * The name of a property whose values are unique for this object type
+       */
+      idProperty?: string;
+      objectId: string;
+      objectType: string;
+      /**
+       * A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
+       */
+      properties?: string[];
+      /**
+       * A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.
+       */
+      propertiesWithHistory?: string[];
+    }
+    type GetOutput = Schemas.SimplePublicObjectWithAssociations;
+    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;
+      /**
+       * Whether to return only results that have been archived.
+       */
+      archived?: boolean;
+      /**
+       * A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
+       */
+      associations?: string[];
+      /**
+       * The maximum number of results to display per page.
+       */
+      limit?: number;
+      objectType: string;
+      /**
+       * A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
+       */
+      properties?: string[];
+      /**
+       * A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.
+       */
+      propertiesWithHistory?: string[];
+    }
+    type ListOutput = Schemas.CollectionResponseSimplePublicObjectWithAssociationsForwardPaging;
+    interface UpdateInput {
+      data: Schemas.SimplePublicObjectInput;
+      /**
+       * The name of a property whose values are unique for this object type
+       */
+      idProperty?: string;
+      objectId: string;
+      objectType: string;
+    }
+    type UpdateOutput = Schemas.SimplePublicObject;
+  }
+  namespace Batch {
+    interface CreateInput {
+      data: Schemas.BatchInputSimplePublicObjectBatchInputForCreate;
+      objectType: string;
+    }
+    type CreateOutput = Schemas.BatchResponseSimplePublicObject;
+    interface DeleteInput {
+      data: Schemas.BatchInputSimplePublicObjectId;
+      objectType: string;
+    }
+    type DeleteOutput = void;
+    interface GetInput {
+      /**
+       * Whether to return only results that have been archived.
+       */
+      archived?: boolean;
+      data: Schemas.BatchReadInputSimplePublicObjectId;
+      objectType: string;
+    }
+    type GetOutput = Schemas.BatchResponseSimplePublicObject;
+    interface UpdateInput {
+      data: Schemas.BatchInputSimplePublicObjectBatchInput;
+      objectType: string;
+    }
+    type UpdateOutput = Schemas.BatchResponseSimplePublicObject;
+    interface UpsertInput {
+      data: Schemas.BatchInputSimplePublicObjectBatchInputUpsert;
+      objectType: string;
+    }
+    type UpsertOutput = Schemas.BatchResponseSimplePublicUpsertObject;
+  }
+  namespace Schemas {
+    /**
+     * Contains the id and type of an association
+     */
+    interface AssociatedId {
+      /**
+       * The ID for the association type.
+       */
+      id: string;
+      /**
+       * The type of association.
+       */
+      type: string;
+    }
+    /**
+     * Defines the type, direction, and details of the relationship between two CRM objects.
+     */
+    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;
+    }
+    interface BatchInputSimplePublicObjectBatchInput {
+      inputs: Schemas.SimplePublicObjectBatchInput[];
+    }
+    interface BatchInputSimplePublicObjectBatchInputForCreate {
+      inputs: Schemas.SimplePublicObjectBatchInputForCreate[];
+    }
+    interface BatchInputSimplePublicObjectBatchInputUpsert {
+      inputs: Schemas.SimplePublicObjectBatchInputUpsert[];
+    }
+    interface BatchInputSimplePublicObjectId {
+      inputs: Schemas.SimplePublicObjectId[];
+    }
+    /**
+     * Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property.
+     */
+    interface BatchReadInputSimplePublicObjectId {
+      /**
+       * When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.
+       */
+      idProperty?: string;
+      inputs: Schemas.SimplePublicObjectId[];
+      /**
+       * Key-value pairs for setting properties for the new object.
+       */
+      properties: string[];
+      /**
+       * Key-value pairs for setting properties for the new object and their histories.
+       */
+      propertiesWithHistory: string[];
+    }
+    /**
+     * A public object batch response object
+     */
+    interface BatchResponseSimplePublicObject {
+      /**
+       * 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.SimplePublicObject[];
+      /**
+       * The timestamp when the batch processing began, in ISO 8601 format.
+       */
+      startedAt: string;
+      /**
+       * The status of the batch processing request. Expected value is "COMPLETE".
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+    /**
+     * Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.
+     */
+    interface BatchResponseSimplePublicUpsertObject {
+      /**
+       * The timestamp when the batch process 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 process was initiated, in ISO 8601 format.
+       */
+      requestedAt?: string;
+      results: Schemas.SimplePublicUpsertObject[];
+      /**
+       * The timestamp when the batch process began execution, in ISO 8601 format.
+       */
+      startedAt: string;
+      /**
+       * The status of the batch processing request. Expected value is "COMPLETE".
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+    interface CollectionResponseAssociatedId {
+      paging?: Schemas.Paging;
+      results: Schemas.AssociatedId[];
+    }
+    interface CollectionResponseSimplePublicObjectWithAssociationsForwardPaging {
+      paging?: Schemas.ForwardPaging;
+      results: Schemas.SimplePublicObjectWithAssociations[];
+    }
+    /**
+     * Represents a list of simple objects returned from an API request, along with the total count of objects available.
+     */
+    interface CollectionResponseWithTotalSimplePublicObject {
+      paging?: Schemas.Paging;
+      results: Schemas.SimplePublicObject[];
+      /**
+       * The number of available results
+       */
+      total: number;
+    }
+    /**
+     * 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.
+     */
+    interface Filter {
+      /**
+       * The upper boundary value when using ranged-based filters.
+       */
+      highValue?: string;
+      /**
+       * null
+       */
+      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[];
+    }
+    interface FilterGroup {
+      filters: Schemas.Filter[];
+    }
+    interface ForwardPaging {
+      next?: Schemas.NextPage;
+    }
+    /**
+     * Specifies the paging information needed to retrieve the next set of results in a paginated API response
+     */
+    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;
+    }
+    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
+     */
+    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;
+    }
+    interface PublicAssociationsForObject {
+      to: Schemas.PublicObjectId;
+      types: Schemas.AssociationSpec[];
+    }
+    /**
+     * Contains the Id of a Public Object
+     */
+    interface PublicObjectId {
+      /**
+       * The unique ID of the object.
+       */
+      id: string;
+    }
+    /**
+     * Describes a search request
+     */
+    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[];
+    }
+    /**
+     * A simple public object.
+     */
+    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;
+      /**
+       * An identifier used for tracing the write request for the object.
+       */
+      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;
+      /**
+       * Direct URL for this object in the portal
+       */
+      url?: string;
+    }
+    /**
+     * Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties.
+     */
+    interface SimplePublicObjectBatchInput {
+      /**
+       * The id to be updated. This can be the object id, or the unique property value of the idProperty property
+       */
+      id: string;
+      /**
+       * The name of a property whose values are unique for this object
+       */
+      idProperty?: string;
+      /**
+       * A unique identifier for tracing the request.
+       */
+      objectWriteTraceId?: string;
+      /**
+       * Key-value pairs representing the properties of the object.
+       */
+      properties: Record<string, string>;
+    }
+    /**
+     * An input object that contains a collection of objects to be created together in a batch.
+     */
+    interface SimplePublicObjectBatchInputForCreate {
+      associations: Schemas.PublicAssociationsForObject[];
+      /**
+       * An identifier used for tracing the creation or update request of the object.
+       */
+      objectWriteTraceId?: string;
+      /**
+       * Key value pairs representing the properties of the object.
+       */
+      properties: Record<string, string>;
+    }
+    /**
+     * Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID.
+     */
+    interface SimplePublicObjectBatchInputUpsert {
+      /**
+       * The unique ID of the object.
+       */
+      id: string;
+      /**
+       * The name of a property whose values are unique for this object
+       */
+      idProperty?: string;
+      /**
+       * An identifier for tracing the creation request.
+       */
+      objectWriteTraceId?: string;
+      /**
+       * Key value pairs representing the properties of the object.
+       */
+      properties: Record<string, string>;
+    }
+    /**
+     * Contains the Id of a Public Object
+     */
+    interface SimplePublicObjectId {
+      /**
+       * The unique ID of the object.
+       */
+      id: string;
+    }
+    /**
+     * Represents the input required to create or update a CRM object, containing an object with property names and their corresponding values.
+     */
+    interface SimplePublicObjectInput {
+      /**
+       * Key value pairs representing the properties of the object.
+       */
+      properties: Record<string, string>;
+    }
+    /**
+     * Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects.
+     */
+    interface SimplePublicObjectInputForCreate {
+      associations: Schemas.PublicAssociationsForObject[];
+      /**
+       * Key-value pairs for setting properties for the new object.
+       */
+      properties: Record<string, string>;
+    }
+    /**
+     * Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.
+     */
+    interface SimplePublicObjectWithAssociations {
+      /**
+       * Whether the object is archived.
+       */
+      archived: boolean;
+      /**
+       * The timestamp when the object was archived, in ISO 8601 format.
+       */
+      archivedAt?: string;
+      /**
+       * A list defining relationships with other objects.
+       */
+      associations?: Record<string, Schemas.CollectionResponseAssociatedId>;
+      /**
+       * The timestamp when the object was created, in ISO 8601 format.
+       */
+      createdAt: string;
+      /**
+       * The unique ID of the object.
+       */
+      id: string;
+      /**
+       * An identifier used for tracing the creation or update request of the object.
+       */
+      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;
+      /**
+       * Direct URL for this object in HubSpot
+       */
+      url?: string;
+    }
+    /**
+     * Represents a CRM object that has either been created or updated (upserted)
+     */
+    interface SimplePublicUpsertObject {
+      /**
+       * 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;
+      /**
+       * Whether the property is new.
+       */
+      new: boolean;
+      /**
+       * An identifier used for tracing the write request for the object.
+       */
+      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;
+      /**
+       * Direct URL for this object in HubSpot
+       */
+      url?: string;
+    }
+    /**
+     * Property model that includes timestamp.
+     */
+    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;
+    }
+  }
+  namespace Search {
+    interface SearchInput {
+      data: Schemas.PublicObjectSearchRequest;
+      objectType: string;
+    }
+    type SearchOutput = Schemas.CollectionResponseWithTotalSimplePublicObject;
+  }
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmObjects } from '@hubspot/api-client-core';
+   * client.send(crmObjects.basic.create(input));
+   * ```
+   */
+  interface BasicAPI {
+    /**
+     * Create
+     * @apiPath /crm/objects/2026-03/{objectType}
+     * @apiMethod POST
+     * @requiredScopes crm-public-object-api-access, oauth, oauth-access
+     */
+    create: (input: Basic.CreateInput) => Operation<Basic.CreateOutput>;
+    /**
+     * Archive
+     * @apiPath /crm/objects/2026-03/{objectType}/{objectId}
+     * @apiMethod DELETE
+     * @requiredScopes crm-public-object-api-access, oauth, oauth-access
+     */
+    delete: (input: Basic.DeleteInput) => Operation<Basic.DeleteOutput>;
+    /**
+     * Read
+     * @apiPath /crm/objects/2026-03/{objectType}/{objectId}
+     * @apiMethod GET
+     * @requiredScopes crm-public-object-api-access, oauth, oauth-access
+     */
+    get: (input: Basic.GetInput) => Operation<Basic.GetOutput>;
+    /**
+     * List
+     * @apiPath /crm/objects/2026-03/{objectType}
+     * @apiMethod GET
+     * @requiredScopes crm-public-object-api-access, oauth, oauth-access
+     */
+    list: (input: Basic.ListInput) => Operation<Basic.ListOutput>;
+    /**
+     * Update
+     * @apiPath /crm/objects/2026-03/{objectType}/{objectId}
+     * @apiMethod PATCH
+     * @requiredScopes crm-public-object-api-access, oauth, oauth-access
+     */
+    update: (input: Basic.UpdateInput) => Operation<Basic.UpdateOutput>;
+  }
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmObjects } from '@hubspot/api-client-core';
+   * client.send(crmObjects.batch.create(input));
+   * ```
+   */
+  interface BatchAPI {
+    /**
+     * Create a batch of objects
+     * @apiPath /crm/objects/2026-03/{objectType}/batch/create
+     * @apiMethod POST
+     * @requiredScopes crm-public-object-api-access, oauth, oauth-access
+     */
+    create: (input: Batch.CreateInput) => Operation<Batch.CreateOutput>;
+    /**
+     * Archive a batch of objects by ID
+     * @apiPath /crm/objects/2026-03/{objectType}/batch/archive
+     * @apiMethod POST
+     * @requiredScopes crm-public-object-api-access, oauth, oauth-access
+     */
+    delete: (input: Batch.DeleteInput) => Operation<Batch.DeleteOutput>;
+    /**
+     * Read a batch of objects by internal ID, or unique property values
+     * @apiPath /crm/objects/2026-03/{objectType}/batch/read
+     * @apiMethod POST
+     * @requiredScopes crm-public-object-api-access, oauth, oauth-access
+     */
+    get: (input: Batch.GetInput) => Operation<Batch.GetOutput>;
+    /**
+     * Update a batch of objects by internal ID, or unique property values
+     * @apiPath /crm/objects/2026-03/{objectType}/batch/update
+     * @apiMethod POST
+     * @requiredScopes crm-public-object-api-access, oauth, oauth-access
+     */
+    update: (input: Batch.UpdateInput) => Operation<Batch.UpdateOutput>;
+    /**
+     * Create or update a batch of objects by unique property values
+     * @apiPath /crm/objects/2026-03/{objectType}/batch/upsert
+     * @apiMethod POST
+     * @requiredScopes crm-public-object-api-access, oauth, oauth-access
+     */
+    upsert: (input: Batch.UpsertInput) => Operation<Batch.UpsertOutput>;
+  }
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmObjects } from '@hubspot/api-client-core';
+   * client.send(crmObjects.search.search(input));
+   * ```
+   */
+  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 { crmObjects } from '@hubspot/api-client-core';
+   * client.send(crmObjects.basic.create(input));
+   * ```
+   */
+  interface API {
+    basic: BasicAPI;
+    batch: BatchAPI;
+    search: SearchAPI;
+  }
+}
+//#endregion
+export { CRMObjects };
+//# sourceMappingURL=objects-types.generated.d.ts.map