Class BatchApi

Index

Constructors

Methods

read readWithHttpInfo upsert upsertWithHttpInfo

Constructors

constructor

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

Methods

read

read(batchInputPublicObjectId, _options?): Promise<BatchResponseDealToDealSplits | BatchResponseDealToDealSplitsWithErrors>
Read a batch of deal split objects by their associated deal object internal ID
Parameters
- batchInputPublicObjectId: BatchInputPublicObjectId
- Optional_options: PromiseConfigurationOptions
Returns Promise<BatchResponseDealToDealSplits | BatchResponseDealToDealSplitsWithErrors>
- Defined in codegen/crm/objects/deal_splits/types/PromiseAPI.ts:48

readWithHttpInfo

readWithHttpInfo(batchInputPublicObjectId, _options?): Promise<HttpInfo<BatchResponseDealToDealSplits | BatchResponseDealToDealSplitsWithErrors>>
Read a batch of deal split objects by their associated deal object internal ID
Parameters
- batchInputPublicObjectId: BatchInputPublicObjectId
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BatchResponseDealToDealSplits | BatchResponseDealToDealSplitsWithErrors>>
- Defined in codegen/crm/objects/deal_splits/types/PromiseAPI.ts:27

upsert

upsert(publicDealSplitsBatchCreateRequest, _options?): Promise<BatchResponseDealToDealSplits | BatchResponseDealToDealSplitsWithErrors>
Create or replace deal splits for deals with the provided IDs. Deal split percentages for each deal must sum up to 1.0 (100%) and may have up to 8 decimal places
Parameters
- publicDealSplitsBatchCreateRequest: PublicDealSplitsBatchCreateRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<BatchResponseDealToDealSplits | BatchResponseDealToDealSplitsWithErrors>
- Defined in codegen/crm/objects/deal_splits/types/PromiseAPI.ts:90

upsertWithHttpInfo

upsertWithHttpInfo(publicDealSplitsBatchCreateRequest, _options?): Promise<HttpInfo<BatchResponseDealToDealSplits | BatchResponseDealToDealSplitsWithErrors>>
Create or replace deal splits for deals with the provided IDs. Deal split percentages for each deal must sum up to 1.0 (100%) and may have up to 8 decimal places
Parameters
- publicDealSplitsBatchCreateRequest: PublicDealSplitsBatchCreateRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BatchResponseDealToDealSplits | BatchResponseDealToDealSplitsWithErrors>>
- Defined in codegen/crm/objects/deal_splits/types/PromiseAPI.ts:69