Class BatchApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createWithHttpInfo read readWithHttpInfo

Constructors

constructor

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

Methods

archive

archive(objectType, batchInputPropertyName, _options?): Promise<void>
Archive a provided list of properties. This method will return a 204 No Content response on success regardless of the initial state of the property (e.g. active, already archived, non-existent). Archive a batch of properties
Parameters
- objectType: string
- batchInputPropertyName: BatchInputPropertyName
- Optional_options: Configuration
Returns Promise<void>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:48

archiveWithHttpInfo

archiveWithHttpInfo(objectType, batchInputPropertyName, _options?): Promise<HttpInfo<void>>
Archive a provided list of properties. This method will return a 204 No Content response on success regardless of the initial state of the property (e.g. active, already archived, non-existent). Archive a batch of properties
Parameters
- objectType: string
- batchInputPropertyName: BatchInputPropertyName
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:37

create

create(objectType, batchInputPropertyCreate, _options?): Promise<BatchResponseProperty | BatchResponsePropertyWithErrors>
Create a batch of properties using the same rules as when creating an individual property. Create a batch of properties
Parameters
- objectType: string
- batchInputPropertyCreate: BatchInputPropertyCreate
- Optional_options: Configuration
Returns Promise<BatchResponseProperty | BatchResponsePropertyWithErrors>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:70

createWithHttpInfo

createWithHttpInfo(objectType, batchInputPropertyCreate, _options?): Promise<HttpInfo<BatchResponseProperty | BatchResponsePropertyWithErrors>>
Create a batch of properties using the same rules as when creating an individual property. Create a batch of properties
Parameters
- objectType: string
- batchInputPropertyCreate: BatchInputPropertyCreate
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseProperty | BatchResponsePropertyWithErrors>>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:59

read

read(objectType, batchReadInputPropertyName, _options?): Promise<BatchResponseProperty | BatchResponsePropertyWithErrors>
Read a provided list of properties. Read a batch of properties
Parameters
- objectType: string
- batchReadInputPropertyName: BatchReadInputPropertyName
- Optional_options: Configuration
Returns Promise<BatchResponseProperty | BatchResponsePropertyWithErrors>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:92

readWithHttpInfo

readWithHttpInfo(objectType, batchReadInputPropertyName, _options?): Promise<HttpInfo<BatchResponseProperty | BatchResponsePropertyWithErrors>>
Read a provided list of properties. Read a batch of properties
Parameters
- objectType: string
- batchReadInputPropertyName: BatchReadInputPropertyName
- Optional_options: Configuration
Returns Promise<HttpInfo<BatchResponseProperty | BatchResponsePropertyWithErrors>>
- Defined in codegen/crm/properties/types/PromiseAPI.ts:81