Class BatchApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createWithHttpInfo read readWithHttpInfo update updateWithHttpInfo upsert upsertWithHttpInfo

Constructors

constructor

new BatchApi(configuration, requestFactory?, responseProcessor?): BatchApi
Parameters
- configuration: Configuration
- OptionalrequestFactory: BatchApiRequestFactory
- OptionalresponseProcessor: BatchApiResponseProcessor
Returns BatchApi
- Defined in codegen/crm/objects/types/PromiseAPI.ts:179

Methods

archiveWithHttpInfo

archiveWithHttpInfo(objectType, batchInputSimplePublicObjectId, _options?): Promise<HttpInfo<void>>
Archive a batch of objects by ID
Parameters
- objectType: string
- batchInputSimplePublicObjectId: BatchInputSimplePublicObjectId
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/objects/types/PromiseAPI.ts:192

create

create(objectType, batchInputSimplePublicObjectInputForCreate, _options?): Promise<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>
Create a batch of objects
Parameters
- objectType: string
- batchInputSimplePublicObjectInputForCreate: BatchInputSimplePublicObjectInputForCreate
- Optional_options: Configuration
Returns Promise<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>
- Defined in codegen/crm/objects/types/PromiseAPI.ts:222

createWithHttpInfo

createWithHttpInfo(objectType, batchInputSimplePublicObjectInputForCreate, _options?): Promise<HttpInfo<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>>
Create a batch of objects
Parameters
- objectType: string
- batchInputSimplePublicObjectInputForCreate: BatchInputSimplePublicObjectInputForCreate
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>>
- Defined in codegen/crm/objects/types/PromiseAPI.ts:212

read

read(objectType, batchReadInputSimplePublicObjectId, archived?, _options?): Promise<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>
Read a batch of objects by internal ID, or unique property values
Parameters
- objectType: string
- batchReadInputSimplePublicObjectId: BatchReadInputSimplePublicObjectId
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: Configuration
Returns Promise<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>
- Defined in codegen/crm/objects/types/PromiseAPI.ts:244

readWithHttpInfo

readWithHttpInfo(objectType, batchReadInputSimplePublicObjectId, archived?, _options?): Promise<HttpInfo<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>>
Read a batch of objects by internal ID, or unique property values
Parameters
- objectType: string
- batchReadInputSimplePublicObjectId: BatchReadInputSimplePublicObjectId
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>>
- Defined in codegen/crm/objects/types/PromiseAPI.ts:233

update

update(objectType, batchInputSimplePublicObjectBatchInput, _options?): Promise<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>
Update a batch of objects by internal ID, or unique property values
Parameters
- objectType: string
- batchInputSimplePublicObjectBatchInput: BatchInputSimplePublicObjectBatchInput
- Optional_options: Configuration
Returns Promise<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>
- Defined in codegen/crm/objects/types/PromiseAPI.ts:264

updateWithHttpInfo

updateWithHttpInfo(objectType, batchInputSimplePublicObjectBatchInput, _options?): Promise<HttpInfo<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>>
Update a batch of objects by internal ID, or unique property values
Parameters
- objectType: string
- batchInputSimplePublicObjectBatchInput: BatchInputSimplePublicObjectBatchInput
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>>
- Defined in codegen/crm/objects/types/PromiseAPI.ts:254

upsert

upsert(objectType, batchInputSimplePublicObjectBatchInputUpsert, _options?): Promise<BatchResponseSimplePublicUpsertObject | BatchResponseSimplePublicUpsertObjectWithErrors>
Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object. Create or update a batch of objects by unique property values
Parameters
- objectType: string
- batchInputSimplePublicObjectBatchInputUpsert: BatchInputSimplePublicObjectBatchInputUpsert
- Optional_options: Configuration
Returns Promise<BatchResponseSimplePublicUpsertObject | BatchResponseSimplePublicUpsertObjectWithErrors>
- Defined in codegen/crm/objects/types/PromiseAPI.ts:286

upsertWithHttpInfo

upsertWithHttpInfo(objectType, batchInputSimplePublicObjectBatchInputUpsert, _options?): Promise<HttpInfo<BatchResponseSimplePublicUpsertObject | BatchResponseSimplePublicUpsertObjectWithErrors>>
Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object. Create or update a batch of objects by unique property values
Parameters
- objectType: string
- batchInputSimplePublicObjectBatchInputUpsert: BatchInputSimplePublicObjectBatchInputUpsert
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseSimplePublicUpsertObject | BatchResponseSimplePublicUpsertObjectWithErrors>>
- Defined in codegen/crm/objects/types/PromiseAPI.ts:275

Class BatchApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BatchApi

Methods

archive

Parameters

Returns Promise<void>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

create

Parameters

Returns Promise<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>>

read

Parameters

Returns Promise<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>

readWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>>

update

Parameters

Returns Promise<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>

updateWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponseSimplePublicObject | BatchResponseSimplePublicObjectWithErrors>>

upsert

Parameters

Returns Promise<BatchResponseSimplePublicUpsertObject | BatchResponseSimplePublicUpsertObjectWithErrors>

upsertWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponseSimplePublicUpsertObject | BatchResponseSimplePublicUpsertObjectWithErrors>>

Settings

On This Page