@hubspot/app-connect-sdk 1.0.0-alpha.2 → 1.0.0-alpha.21

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

@@ -2,375 +2,357 @@
 
 import type { Operation } from '../../types.ts';
 
-export namespace CRMAssociationsSchema {
-  export namespace Labels {
-    export interface CreateLabelInput {
-      data: Schemas.PublicAssociationDefinitionCreateRequest;
-      fromObjectType: string;
-      toObjectType: string;
-    }
-
-    export type CreateLabelOutput =
-      Schemas.CollectionResponseAssociationSpecWithLabelNoPaging;
-
-    export interface DeleteLabelInput {
-      associationTypeId: number;
-      fromObjectType: string;
-      toObjectType: string;
-    }
-
-    export type DeleteLabelOutput = void;
-
-    export interface ListLabelsInput {
-      fromObjectType: string;
-      toObjectType: string;
-    }
-
-    export type ListLabelsOutput =
-      Schemas.CollectionResponseAssociationSpecWithLabelNoPaging;
-
-    export interface UpdateLabelInput {
-      data: Schemas.PublicAssociationDefinitionUpdateRequest;
-      fromObjectType: string;
-      toObjectType: string;
-    }
-
-    export type UpdateLabelOutput = void;
+export namespace CRMAssociationsSchemaSchemas {
+  /**
+   * Defines the type, direction, and details of the relationship between two CRM objects.
+   */
+  export 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;
   }
 
-  export namespace Limits {
-    export interface BatchCreateInput {
-      data: Schemas.BatchInputPublicAssociationDefinitionConfigurationCreateRequest;
-      fromObjectType: string;
-      toObjectType: string;
-    }
+  export interface BatchInputPublicAssociationDefinitionConfigurationCreateRequest {
+    inputs: PublicAssociationDefinitionConfigurationCreateRequest[];
+  }
 
-    export type BatchCreateOutput =
-      Schemas.BatchResponsePublicAssociationDefinitionUserConfiguration;
+  export interface BatchInputPublicAssociationDefinitionConfigurationUpdateRequest {
+    inputs: PublicAssociationDefinitionConfigurationUpdateRequest[];
+  }
 
-    export interface BatchDeleteInput {
-      data: Schemas.BatchInputPublicAssociationSpec;
-      fromObjectType: string;
-      toObjectType: string;
-    }
+  export interface BatchInputPublicAssociationSpec {
+    inputs: PublicAssociationSpec[];
+  }
 
-    export type BatchDeleteOutput = void;
+  export interface BatchResponsePublicAssociationDefinitionConfigurationUpdateResult {
+    /**
+     * The date and time when the batch update operation was completed.
+     */
+    completedAt: string;
+    /**
+     * URLs linking to documentation or resources associated with the batch update operation.
+     */
+    links?: Record<string, string>;
+    /**
+     * The date and time when the batch update operation was requested.
+     */
+    requestedAt?: string;
+    results: PublicAssociationDefinitionConfigurationUpdateResult[];
+    /**
+     * The date and time when the batch update operation started.
+     */
+    startedAt: string;
+    /**
+     * The current status of the batch update operation, which can be CANCELED, COMPLETE, PENDING, or PROCESSING.
+     */
+    status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+  }
 
-    export interface BatchUpdateInput {
-      data: Schemas.BatchInputPublicAssociationDefinitionConfigurationUpdateRequest;
-      fromObjectType: string;
-      toObjectType: string;
-    }
+  export interface BatchResponsePublicAssociationDefinitionUserConfiguration {
+    /**
+     * The date and time when the batch operation was completed.
+     */
+    completedAt: string;
+    /**
+     * A collection of URLs linking to related documentation or resources associated with the batch operation.
+     */
+    links?: Record<string, string>;
+    /**
+     * The date and time when the batch operation was requested.
+     */
+    requestedAt?: string;
+    results: PublicAssociationDefinitionUserConfiguration[];
+    /**
+     * The date and time when the batch operation started.
+     */
+    startedAt: string;
+    /**
+     * The current status of the batch operation, which can be CANCELED, COMPLETE, PENDING, or PROCESSING.
+     */
+    status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+  }
 
-    export type BatchUpdateOutput =
-      Schemas.BatchResponsePublicAssociationDefinitionConfigurationUpdateResult;
+  export interface CollectionResponseAssociationSpecWithLabelNoPaging {
+    results: AssociationSpecWithLabel[];
+  }
 
-    export interface GetByObjectTypesInput {
-      fromObjectType: string;
-      toObjectType: string;
-    }
+  export interface CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging {
+    results: PublicAssociationDefinitionUserConfiguration[];
+  }
 
-    export type GetByObjectTypesOutput =
-      Schemas.CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging;
+  export interface PublicAssociationDefinitionConfigurationCreateRequest {
+    /**
+     * Specifies the category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED.
+     */
+    category:
+      | 'HUBSPOT_DEFINED'
+      | 'INTEGRATOR_DEFINED'
+      | 'USER_DEFINED'
+      | 'WORK';
+    /**
+     * The maximum number of target object IDs that can be associated with a single source object.
+     */
+    maxToObjectIds: number;
+    /**
+     * An integer used to uniquely identify a specific association type within its category.
+     */
+    typeId: number;
+  }
 
-    export type ListOutput =
-      Schemas.CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging;
+  export interface PublicAssociationDefinitionConfigurationUpdateRequest {
+    /**
+     * Specifies the category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED.
+     */
+    category:
+      | 'HUBSPOT_DEFINED'
+      | 'INTEGRATOR_DEFINED'
+      | 'USER_DEFINED'
+      | 'WORK';
+    /**
+     * Defines the maximum number of target object IDs that can be associated.
+     */
+    maxToObjectIds: number;
+    /**
+     * A unique identifier for the association type.
+     */
+    typeId: number;
   }
 
-  export namespace Schemas {
-    /**
-     * Defines the type, direction, and details of the relationship between two CRM objects.
-     */
-    export 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;
-    }
-
-    export interface BatchInputPublicAssociationDefinitionConfigurationCreateRequest {
-      inputs: Schemas.PublicAssociationDefinitionConfigurationCreateRequest[];
-    }
-
-    export interface BatchInputPublicAssociationDefinitionConfigurationUpdateRequest {
-      inputs: Schemas.PublicAssociationDefinitionConfigurationUpdateRequest[];
-    }
-
-    export interface BatchInputPublicAssociationSpec {
-      inputs: Schemas.PublicAssociationSpec[];
-    }
-
-    export interface BatchResponsePublicAssociationDefinitionConfigurationUpdateResult {
-      /**
-       * The date and time when the batch update operation was completed.
-       */
-      completedAt: string;
-      /**
-       * URLs linking to documentation or resources associated with the batch update operation.
-       */
-      links?: Record<string, string>;
-      /**
-       * The date and time when the batch update operation was requested.
-       */
-      requestedAt?: string;
-      results: Schemas.PublicAssociationDefinitionConfigurationUpdateResult[];
-      /**
-       * The date and time when the batch update operation started.
-       */
-      startedAt: string;
-      /**
-       * The current status of the batch update operation, which can be CANCELED, COMPLETE, PENDING, or PROCESSING.
-       */
-      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
-    }
-
-    export interface BatchResponsePublicAssociationDefinitionUserConfiguration {
-      /**
-       * The date and time when the batch operation was completed.
-       */
-      completedAt: string;
-      /**
-       * A collection of URLs linking to related documentation or resources associated with the batch operation.
-       */
-      links?: Record<string, string>;
-      /**
-       * The date and time when the batch operation was requested.
-       */
-      requestedAt?: string;
-      results: Schemas.PublicAssociationDefinitionUserConfiguration[];
-      /**
-       * The date and time when the batch operation started.
-       */
-      startedAt: string;
-      /**
-       * The current status of the batch operation, which can be CANCELED, COMPLETE, PENDING, or PROCESSING.
-       */
-      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
-    }
-
-    export interface CollectionResponseAssociationSpecWithLabelNoPaging {
-      results: Schemas.AssociationSpecWithLabel[];
-    }
-
-    export interface CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging {
-      results: Schemas.PublicAssociationDefinitionUserConfiguration[];
-    }
-
-    export interface PublicAssociationDefinitionConfigurationCreateRequest {
-      /**
-       * Specifies the category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED.
-       */
-      category:
-        | 'HUBSPOT_DEFINED'
-        | 'INTEGRATOR_DEFINED'
-        | 'USER_DEFINED'
-        | 'WORK';
-      /**
-       * The maximum number of target object IDs that can be associated with a single source object.
-       */
-      maxToObjectIds: number;
-      /**
-       * An integer used to uniquely identify a specific association type within its category.
-       */
-      typeId: number;
-    }
-
-    export interface PublicAssociationDefinitionConfigurationUpdateRequest {
-      /**
-       * Specifies the category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED.
-       */
-      category:
-        | 'HUBSPOT_DEFINED'
-        | 'INTEGRATOR_DEFINED'
-        | 'USER_DEFINED'
-        | 'WORK';
-      /**
-       * Defines the maximum number of target object IDs that can be associated.
-       */
-      maxToObjectIds: number;
-      /**
-       * A unique identifier for the association type.
-       */
-      typeId: number;
-    }
-
-    export interface PublicAssociationDefinitionConfigurationUpdateResult {
-      /**
-       * The category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED.
-       */
-      category:
-        | 'HUBSPOT_DEFINED'
-        | 'INTEGRATOR_DEFINED'
-        | 'USER_DEFINED'
-        | 'WORK';
-      /**
-       * An integer value used to uniquely identify a specific association type within its Association Category.
-       */
-      typeId: number;
-      /**
-       * The maximum number of object IDs that a user can enforce for associations.
-       */
-      userEnforcedMaxToObjectIds?: number;
-    }
-
-    export interface PublicAssociationDefinitionCreateRequest {
-      /**
-       * An optional descriptor that clarifies the reverse relationship in the association.
-       */
-      inverseLabel?: string;
-      /**
-       * A descriptor that provides context about the relationship between two associated CRM objects.
-       */
-      label: string;
-      /**
-       * The unique identifier for the association definition.
-       */
-      name: string;
-    }
-
-    export interface PublicAssociationDefinitionUpdateRequest {
-      /**
-       * The unique identifier for the association type.
-       */
-      associationTypeId: number;
-      /**
-       * An optional descriptor for the inverse relationship between associated records.
-       */
-      inverseLabel?: string;
-      /**
-       * A descriptor that provides context about the relationship between associated records.
-       */
-      label: string;
-    }
-
-    export interface PublicAssociationDefinitionUserConfiguration {
-      /**
-       * The category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED.
-       */
-      category:
-        | 'HUBSPOT_DEFINED'
-        | 'INTEGRATOR_DEFINED'
-        | 'USER_DEFINED'
-        | 'WORK';
-      /**
-       * A descriptor providing context about the relationship between associated records.
-       */
-      label?: string;
-      /**
-       * A unique integer identifier for the association type within its category.
-       */
-      typeId: number;
-      /**
-       * The maximum number of target object IDs that a user can enforce in an association.
-       */
-      userEnforcedMaxToObjectIds?: number;
-    }
-
-    export interface PublicAssociationSpec {
-      /**
-       * Specifies the category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED.
-       */
-      category: string;
-      /**
-       * A unique integer identifier for the specific association type within its category.
-       */
-      typeId: number;
-    }
+  export interface PublicAssociationDefinitionConfigurationUpdateResult {
+    /**
+     * The category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED.
+     */
+    category:
+      | 'HUBSPOT_DEFINED'
+      | 'INTEGRATOR_DEFINED'
+      | 'USER_DEFINED'
+      | 'WORK';
+    /**
+     * An integer value used to uniquely identify a specific association type within its Association Category.
+     */
+    typeId: number;
+    /**
+     * The maximum number of object IDs that a user can enforce for associations.
+     */
+    userEnforcedMaxToObjectIds?: number;
+  }
+
+  export interface PublicAssociationDefinitionCreateRequest {
+    /**
+     * An optional descriptor that clarifies the reverse relationship in the association.
+     */
+    inverseLabel?: string;
+    /**
+     * A descriptor that provides context about the relationship between two associated CRM objects.
+     */
+    label: string;
+    /**
+     * The unique identifier for the association definition.
+     */
+    name: string;
   }
 
+  export interface PublicAssociationDefinitionUpdateRequest {
+    /**
+     * The unique identifier for the association type.
+     */
+    associationTypeId: number;
+    /**
+     * An optional descriptor for the inverse relationship between associated records.
+     */
+    inverseLabel?: string;
+    /**
+     * A descriptor that provides context about the relationship between associated records.
+     */
+    label: string;
+  }
+
+  export interface PublicAssociationDefinitionUserConfiguration {
+    /**
+     * The category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED.
+     */
+    category:
+      | 'HUBSPOT_DEFINED'
+      | 'INTEGRATOR_DEFINED'
+      | 'USER_DEFINED'
+      | 'WORK';
+    /**
+     * A descriptor providing context about the relationship between associated records.
+     */
+    label?: string;
+    /**
+     * A unique integer identifier for the association type within its category.
+     */
+    typeId: number;
+    /**
+     * The maximum number of target object IDs that a user can enforce in an association.
+     */
+    userEnforcedMaxToObjectIds?: number;
+  }
+
+  export interface PublicAssociationSpec {
+    /**
+     * Specifies the category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED.
+     */
+    category: string;
+    /**
+     * A unique integer identifier for the specific association type within its category.
+     */
+    typeId: number;
+  }
+}
+
+export namespace CrmAssociationsschemaLabels {
+  export interface BatchCreateInput {
+    data: CRMAssociationsSchemaSchemas.BatchInputPublicAssociationDefinitionConfigurationCreateRequest;
+    fromObjectType: string;
+    toObjectType: string;
+  }
+
+  export type BatchCreateOutput =
+    CRMAssociationsSchemaSchemas.BatchResponsePublicAssociationDefinitionUserConfiguration;
+
+  export interface CreateLabelInput {
+    data: CRMAssociationsSchemaSchemas.PublicAssociationDefinitionCreateRequest;
+    fromObjectType: string;
+    toObjectType: string;
+  }
+
+  export type CreateLabelOutput =
+    CRMAssociationsSchemaSchemas.CollectionResponseAssociationSpecWithLabelNoPaging;
+
+  export interface DeleteLabelInput {
+    associationTypeId: number;
+    fromObjectType: string;
+    toObjectType: string;
+  }
+
+  export type DeleteLabelOutput = void;
+
+  export interface ListLabelsInput {
+    fromObjectType: string;
+    toObjectType: string;
+  }
+
+  export type ListLabelsOutput =
+    CRMAssociationsSchemaSchemas.CollectionResponseAssociationSpecWithLabelNoPaging;
+
+  export interface UpdateLabelInput {
+    data: CRMAssociationsSchemaSchemas.PublicAssociationDefinitionUpdateRequest;
+    fromObjectType: string;
+    toObjectType: string;
+  }
+
+  export type UpdateLabelOutput = void;
   /**
    * Usage example:
    * ```ts
-   * import { crmAssociationsSchema } from '@hubspot/api-client-core';
-   * client.send(crmAssociationsSchema.labels.createLabel(input));
+   * import { crmAssociationsschemaLabels } from '@hubspot/api-client-core';
+   * client.send(crmAssociationsschemaLabels.batchCreate(input));
    * ```
    */
-  export interface LabelsAPI {
+  export interface API {
+    /**
+     * Configure association limits
+     * @apiPath /crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/create
+     * @apiMethod POST
+     * @requiredScopes crm-public-object-api-access
+     */
+    batchCreate: (input: BatchCreateInput) => Operation<BatchCreateOutput>;
     /**
      * Create association label
      * @apiPath /crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels
      * @apiMethod POST
      * @requiredScopes crm-public-object-api-access
      */
-    createLabel: (
-      input: Labels.CreateLabelInput
-    ) => Operation<Labels.CreateLabelOutput>;
+    createLabel: (input: CreateLabelInput) => Operation<CreateLabelOutput>;
     /**
      * Delete association label
      * @apiPath /crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels/{associationTypeId}
      * @apiMethod DELETE
      * @requiredScopes crm-public-object-api-access
      */
-    deleteLabel: (
-      input: Labels.DeleteLabelInput
-    ) => Operation<Labels.DeleteLabelOutput>;
+    deleteLabel: (input: DeleteLabelInput) => Operation<DeleteLabelOutput>;
     /**
      * Retrieve association labels
      * @apiPath /crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels
      * @apiMethod GET
      * @requiredScopes crm-public-object-api-access
      */
-    listLabels: (
-      input: Labels.ListLabelsInput
-    ) => Operation<Labels.ListLabelsOutput>;
+    listLabels: (input: ListLabelsInput) => Operation<ListLabelsOutput>;
     /**
      * Update association label
      * @apiPath /crm/associations/2026-03/{fromObjectType}/{toObjectType}/labels
      * @apiMethod PUT
      * @requiredScopes crm-public-object-api-access
      */
-    updateLabel: (
-      input: Labels.UpdateLabelInput
-    ) => Operation<Labels.UpdateLabelOutput>;
+    updateLabel: (input: UpdateLabelInput) => Operation<UpdateLabelOutput>;
+  }
+}
+
+export namespace CrmAssociationsschemaLimits {
+  export interface BatchDeleteInput {
+    data: CRMAssociationsSchemaSchemas.BatchInputPublicAssociationSpec;
+    fromObjectType: string;
+    toObjectType: string;
+  }
+
+  export type BatchDeleteOutput = void;
+
+  export interface BatchUpdateInput {
+    data: CRMAssociationsSchemaSchemas.BatchInputPublicAssociationDefinitionConfigurationUpdateRequest;
+    fromObjectType: string;
+    toObjectType: string;
+  }
+
+  export type BatchUpdateOutput =
+    CRMAssociationsSchemaSchemas.BatchResponsePublicAssociationDefinitionConfigurationUpdateResult;
+
+  export interface GetByObjectTypesInput {
+    fromObjectType: string;
+    toObjectType: string;
   }
 
+  export type GetByObjectTypesOutput =
+    CRMAssociationsSchemaSchemas.CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging;
+
+  export type ListOutput =
+    CRMAssociationsSchemaSchemas.CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging;
   /**
    * Usage example:
    * ```ts
-   * import { crmAssociationsSchema } from '@hubspot/api-client-core';
-   * client.send(crmAssociationsSchema.limits.batchCreate(input));
+   * import { crmAssociationsschemaLimits } from '@hubspot/api-client-core';
+   * client.send(crmAssociationsschemaLimits.batchDelete(input));
    * ```
    */
-  export interface LimitsAPI {
-    /**
-     * Configure association limits
-     * @apiPath /crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/create
-     * @apiMethod POST
-     * @requiredScopes crm-public-object-api-access
-     */
-    batchCreate: (
-      input: Limits.BatchCreateInput
-    ) => Operation<Limits.BatchCreateOutput>;
+  export interface API {
     /**
      * Remove association limits
      * @apiPath /crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/purge
      * @apiMethod POST
      * @requiredScopes crm-public-object-api-access
      */
-    batchDelete: (
-      input: Limits.BatchDeleteInput
-    ) => Operation<Limits.BatchDeleteOutput>;
+    batchDelete: (input: BatchDeleteInput) => Operation<BatchDeleteOutput>;
     /**
      * Update association limits
      * @apiPath /crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}/batch/update
      * @apiMethod POST
      * @requiredScopes crm-public-object-api-access
      */
-    batchUpdate: (
-      input: Limits.BatchUpdateInput
-    ) => Operation<Limits.BatchUpdateOutput>;
+    batchUpdate: (input: BatchUpdateInput) => Operation<BatchUpdateOutput>;
     /**
      * Retrieve association limits
      * @apiPath /crm/associations/2026-03/definitions/configurations/{fromObjectType}/{toObjectType}
@@ -378,26 +360,14 @@ export namespace CRMAssociationsSchema {
      * @requiredScopes crm-public-object-api-access
      */
     getByObjectTypes: (
-      input: Limits.GetByObjectTypesInput
-    ) => Operation<Limits.GetByObjectTypesOutput>;
+      input: GetByObjectTypesInput
+    ) => Operation<GetByObjectTypesOutput>;
     /**
      * Retrieve all association limits
      * @apiPath /crm/associations/2026-03/definitions/configurations/all
      * @apiMethod GET
      * @requiredScopes crm-public-object-api-access
      */
-    list: () => Operation<Limits.ListOutput>;
-  }
-
-  /**
-   * Usage example:
-   * ```ts
-   * import { crmAssociationsSchema } from '@hubspot/api-client-core';
-   * client.send(crmAssociationsSchema.labels.createLabel(input));
-   * ```
-   */
-  export interface API {
-    labels: LabelsAPI;
-    limits: LimitsAPI;
+    list: () => Operation<ListOutput>;
   }
 }