Class BatchApi

Constructors

archiveWithHttpInfo(fromObjectType, toObjectType, batchInputPublicAssociation, _options?): Promise<HttpInfo<void>>
Remove the associations between all pairs of objects identified in the request body. Archive a batch of associations
Parameters
- fromObjectType: string
- toObjectType: string
- batchInputPublicAssociation: BatchInputPublicAssociation
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/associations/types/PromiseAPI.ts:32

create(fromObjectType, toObjectType, batchInputPublicAssociation, _options?): Promise<BatchResponsePublicAssociation | BatchResponsePublicAssociationWithErrors>
Associate all pairs of objects identified in the request body. Create a batch of associations
Parameters
- fromObjectType: string
- toObjectType: string
- batchInputPublicAssociation: BatchInputPublicAssociation
- Optional_options: PromiseConfigurationOptions
Returns Promise<BatchResponsePublicAssociation | BatchResponsePublicAssociationWithErrors>
- Defined in codegen/crm/associations/types/PromiseAPI.ts:104

createWithHttpInfo(fromObjectType, toObjectType, batchInputPublicAssociation, _options?): Promise<HttpInfo<BatchResponsePublicAssociation | BatchResponsePublicAssociationWithErrors>>
Associate all pairs of objects identified in the request body. Create a batch of associations
Parameters
- fromObjectType: string
- toObjectType: string
- batchInputPublicAssociation: BatchInputPublicAssociation
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BatchResponsePublicAssociation | BatchResponsePublicAssociationWithErrors>>
- Defined in codegen/crm/associations/types/PromiseAPI.ts:80

read(fromObjectType, toObjectType, batchInputPublicObjectId, _options?): Promise<BatchResponsePublicAssociationMulti | BatchResponsePublicAssociationMultiWithErrors>
Get the IDs of all {toObjectType} objects associated with those specified in the request body. Read a batch of associations
Parameters
- fromObjectType: string
- toObjectType: string
- batchInputPublicObjectId: BatchInputPublicObjectId
- Optional_options: PromiseConfigurationOptions
Returns Promise<BatchResponsePublicAssociationMulti | BatchResponsePublicAssociationMultiWithErrors>
- Defined in codegen/crm/associations/types/PromiseAPI.ts:152

readWithHttpInfo(fromObjectType, toObjectType, batchInputPublicObjectId, _options?): Promise<HttpInfo<BatchResponsePublicAssociationMulti | BatchResponsePublicAssociationMultiWithErrors>>
Get the IDs of all {toObjectType} objects associated with those specified in the request body. Read a batch of associations
Parameters
- fromObjectType: string
- toObjectType: string
- batchInputPublicObjectId: BatchInputPublicObjectId
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BatchResponsePublicAssociationMulti | BatchResponsePublicAssociationMultiWithErrors>>
- Defined in codegen/crm/associations/types/PromiseAPI.ts:128