Class BatchApi

Hierarchy

BatchApi

Index

Constructors

Properties

Methods

archive create read

Constructors

constructor

new BatchApi(configuration, requestFactory?, responseProcessor?): BatchApi
Parameters
- configuration: Configuration
- Optional requestFactory: BatchApiRequestFactory
- Optional responseProcessor: BatchApiResponseProcessor
Returns BatchApi
- Defined in codegen/crm/associations/types/PromiseAPI.ts:15

Properties

`Private` api

api: ObservableBatchApi

Methods

archive

archive(fromObjectType, toObjectType, batchInputPublicAssociation, _options?): Promise<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: Configuration
Returns Promise<void>
- Defined in codegen/crm/associations/types/PromiseAPI.ts:30

create

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: Configuration
Returns Promise<BatchResponsePublicAssociation | BatchResponsePublicAssociationWithErrors>
- Defined in codegen/crm/associations/types/PromiseAPI.ts:42

read

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: Configuration
Returns Promise<BatchResponsePublicAssociationMulti | BatchResponsePublicAssociationMultiWithErrors>
- Defined in codegen/crm/associations/types/PromiseAPI.ts:54

Generated using TypeDoc