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

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

@@ -0,0 +1,725 @@
+import { Operation } from "../../types.js";
+
+//#region src/server/api-client-core/apis/crm/partner-clients-types.generated.d.ts
+declare namespace CRMPartnerClients {
+  namespace Basic {
+    interface DeleteInput {
+      objectId: string;
+      objectType: string;
+      toObjectId: string;
+      toObjectType: 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;
+      partnerClientId: 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 ListAssociationsInput {
+      /**
+       * 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;
+      partnerClientId: string;
+      toObjectType: string;
+    }
+    type ListAssociationsOutput = Schemas.CollectionResponseMultiAssociatedObjectWithLabelForwardPaging;
+    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;
+      /**
+       * 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 UpdateAssociationLabelsInput {
+      data: Schemas.AssociationSpec[];
+      objectId: string;
+      objectType: string;
+      toObjectId: string;
+      toObjectType: string;
+    }
+    type UpdateAssociationLabelsOutput = Schemas.LabelsBetweenObjectPair;
+    interface UpdateInput {
+      data: Schemas.SimplePublicObjectInput;
+      /**
+       * The name of a property whose values are unique for this object type
+       */
+      idProperty?: string;
+      partnerClientId: string;
+    }
+    type UpdateOutput = Schemas.SimplePublicObject;
+  }
+  namespace Batch {
+    interface CreateInput {
+      fromObjectId: string;
+      fromObjectType: string;
+      toObjectId: string;
+      toObjectType: string;
+    }
+    type CreateOutput = Schemas.BatchResponsePublicDefaultAssociation;
+    interface GetInput {
+      /**
+       * Whether to return only results that have been archived.
+       */
+      archived?: boolean;
+      data: Schemas.BatchReadInputSimplePublicObjectId;
+    }
+    type GetOutput = Schemas.BatchResponseSimplePublicObject;
+    type UpdateInput = Schemas.BatchInputSimplePublicObjectBatchInput;
+    type UpdateOutput = Schemas.BatchResponseSimplePublicObject;
+  }
+  namespace Schemas {
+    /**
+     * Contains the id and type of an association
+     */
+    interface AssociatedId {
+      /**
+       * The ID for the association type.
+       */
+      id: string;
+      /**
+       * The type of associations.
+       */
+      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;
+    }
+    /**
+     * Defines the type, direction, and details of the relationship between two CRM objects.
+     */
+    interface AssociationSpecWithLabel {
+      /**
+       * Association category. Can be HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED or WORK
+       */
+      category: 'HUBSPOT_DEFINED' | 'INTEGRATOR_DEFINED' | 'USER_DEFINED' | 'WORK';
+      /**
+       * An optional descriptor that provides additional context about the relationship between associated records, such as "Mentor" and "Mentee".
+       */
+      label?: string;
+      /**
+       * An integer value used to uniquely identify a specific association type within its Association Category.
+       */
+      typeId: number;
+    }
+    interface BatchInputSimplePublicObjectBatchInput {
+      inputs: Schemas.SimplePublicObjectBatchInput[];
+    }
+    /**
+     * 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 {
+      /**
+       * The name of a property whose values are unique for this object.
+       */
+      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[];
+    }
+    /**
+     * The response returned after performing a batch operation on associations.
+     */
+    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 total number of errors that occurred during the operation.
+       */
+      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. Can be: "PENDING", "PROCESSING", "CANCELED", or "COMPLETE".
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+    /**
+     * 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: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE"
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+    interface CollectionResponseAssociatedId {
+      paging?: Schemas.Paging;
+      results: Schemas.AssociatedId[];
+    }
+    interface CollectionResponseMultiAssociatedObjectWithLabelForwardPaging {
+      paging?: Schemas.ForwardPaging;
+      results: Schemas.MultiAssociatedObjectWithLabel[];
+    }
+    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;
+    }
+    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.
+     */
+    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;
+    }
+    /**
+     * The relationship descriptors applicable between two object types.
+     */
+    interface LabelsBetweenObjectPair {
+      /**
+       * Source unique ID of the object.
+       */
+      fromObjectId: string;
+      /**
+       * Source object type.
+       */
+      fromObjectTypeId: string;
+      labels: string[];
+      /**
+       * Target unique ID of the object.
+       */
+      toObjectId: string;
+      /**
+       * Target object type.
+       */
+      toObjectTypeId: string;
+    }
+    /**
+     * Represents an object that is associated with multiple other objects, with optional context.
+     */
+    interface MultiAssociatedObjectWithLabel {
+      associationTypes: Schemas.AssociationSpecWithLabel[];
+      /**
+       * Target unique ID of the object.
+       */
+      toObjectId: string;
+    }
+    /**
+     * 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 PublicDefaultAssociation {
+      associationSpec: Schemas.AssociationSpec;
+      from: Schemas.PublicObjectId;
+      to: Schemas.PublicObjectId;
+    }
+    /**
+     * 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;
+      /**
+       * The URL associated with the object.
+       */
+      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 unique ID of the object.
+       */
+      id: string;
+      /**
+       * The name of a unique identifier property, which can be used for identifying objects instead of the object ID.
+       */
+      idProperty?: string;
+      /**
+       * A unique identifier for tracing the 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>;
+    }
+    /**
+     * 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;
+      /**
+       * The URL on the API that provide direct navigation to the corresponding UI pages for the connectors.
+       */
+      url?: string;
+    }
+    /**
+     * Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.
+     */
+    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.
+     */
+    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 {
+    type SearchInput = Schemas.PublicObjectSearchRequest;
+    type SearchOutput = Schemas.CollectionResponseWithTotalSimplePublicObject;
+  }
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmPartnerClients } from '@hubspot/api-client-core';
+   * client.send(crmPartnerClients.basic.delete(input));
+   * ```
+   */
+  interface BasicAPI {
+    /**
+     * deletes all 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 details of a specific partner client.
+     * @apiPath /crm/objects/2026-03/partner_clients/{partnerClientId}
+     * @apiMethod GET
+     * @requiredScopes crm.objects.partner-clients.read
+     */
+    get: (input: Basic.GetInput) => Operation<Basic.GetOutput>;
+    /**
+     * Retrieve a list of partner clients.
+     * @apiPath /crm/objects/2026-03/partner_clients
+     * @apiMethod GET
+     * @requiredScopes crm.objects.partner-clients.read
+     */
+    list: (input?: Basic.ListInput) => Operation<Basic.ListOutput>;
+    /**
+     * List associations of a partner client by type
+     * @apiPath /crm/objects/2026-03/partner_clients/{partnerClientId}/associations/{toObjectType}
+     * @apiMethod GET
+     * @requiredScopes crm.objects.partner-clients.read
+     */
+    listAssociations: (input: Basic.ListAssociationsInput) => Operation<Basic.ListAssociationsOutput>;
+    /**
+     * Update properties of a specific partner client.
+     * @apiPath /crm/objects/2026-03/partner_clients/{partnerClientId}
+     * @apiMethod PATCH
+     * @requiredScopes crm.objects.partner-clients.write
+     */
+    update: (input: Basic.UpdateInput) => Operation<Basic.UpdateOutput>;
+    /**
+     * Set association labels between two records.
+     * @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 { crmPartnerClients } from '@hubspot/api-client-core';
+   * client.send(crmPartnerClients.batch.create(input));
+   * ```
+   */
+  interface BatchAPI {
+    /**
+     * Create the default (most generic) association type between two object types
+     * @apiPath /crm/objects/2026-03/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}
+     * @apiMethod PUT
+     * @requiredScopes crm-public-object-api-access, oauth, oauth-access
+     */
+    create: (input: Batch.CreateInput) => Operation<Batch.CreateOutput>;
+    /**
+     * Retrieve a batch of partner client objects.
+     * @apiPath /crm/objects/2026-03/partner_clients/batch/read
+     * @apiMethod POST
+     * @requiredScopes crm.objects.partner-clients.read
+     */
+    get: (input: Batch.GetInput) => Operation<Batch.GetOutput>;
+    /**
+     * Update multiple partner client records in a single request.
+     * @apiPath /crm/objects/2026-03/partner_clients/batch/update
+     * @apiMethod POST
+     * @requiredScopes crm.objects.partner-clients.write
+     */
+    update: (input: Batch.UpdateInput) => Operation<Batch.UpdateOutput>;
+  }
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmPartnerClients } from '@hubspot/api-client-core';
+   * client.send(crmPartnerClients.search.search(input));
+   * ```
+   */
+  interface SearchAPI {
+    /**
+     * Search for partner clients using specified criteria.
+     * @apiPath /crm/objects/2026-03/partner_clients/search
+     * @apiMethod POST
+     * @requiredScopes crm.objects.partner-clients.read
+     */
+    search: (input: Search.SearchInput) => Operation<Search.SearchOutput>;
+  }
+  /**
+   * Usage example:
+   * ```ts
+   * import { crmPartnerClients } from '@hubspot/api-client-core';
+   * client.send(crmPartnerClients.basic.delete(input));
+   * ```
+   */
+  interface API {
+    basic: BasicAPI;
+    batch: BatchAPI;
+    search: SearchAPI;
+  }
+}
+//#endregion
+export { CRMPartnerClients };
+//# sourceMappingURL=partner-clients-types.generated.d.ts.map