Class DefinitionConfigurationsApi

Index

Constructors

Methods

batchCreate batchCreateWithHttpInfo batchRemove batchRemoveWithHttpInfo batchUpdate batchUpdateWithHttpInfo getAll getAllBetweenTwoObjectTypes getAllBetweenTwoObjectTypesWithHttpInfo getAllWithHttpInfo

Constructors

constructor

new DefinitionConfigurationsApi(configuration, requestFactory?, responseProcessor?): DefinitionConfigurationsApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: DefinitionConfigurationsApiRequestFactory
- OptionalresponseProcessor: DefinitionConfigurationsApiResponseProcessor
Returns DefinitionConfigurationsApi
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:22

Methods

batchCreate

batchCreate(fromObjectType, toObjectType, batchInputPublicAssociationDefinitionConfigurationCreateRequest, _options?): Promise<BatchResponsePublicAssociationDefinitionUserConfiguration | BatchResponsePublicAssociationDefinitionUserConfigurationWithErrors>
Batch create user configurations between two object types Create
Parameters
- fromObjectType: string
- toObjectType: string
- batchInputPublicAssociationDefinitionConfigurationCreateRequest: BatchInputPublicAssociationDefinitionConfigurationCreateRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<BatchResponsePublicAssociationDefinitionUserConfiguration | BatchResponsePublicAssociationDefinitionUserConfigurationWithErrors>
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:61

batchCreateWithHttpInfo

batchCreateWithHttpInfo(fromObjectType, toObjectType, batchInputPublicAssociationDefinitionConfigurationCreateRequest, _options?): Promise<HttpInfo<BatchResponsePublicAssociationDefinitionUserConfiguration | BatchResponsePublicAssociationDefinitionUserConfigurationWithErrors>>
Batch create user configurations between two object types Create
Parameters
- fromObjectType: string
- toObjectType: string
- batchInputPublicAssociationDefinitionConfigurationCreateRequest: BatchInputPublicAssociationDefinitionConfigurationCreateRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BatchResponsePublicAssociationDefinitionUserConfiguration | BatchResponsePublicAssociationDefinitionUserConfigurationWithErrors>>
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:37

batchRemove

batchRemove(fromObjectType, toObjectType, batchInputPublicAssociationSpec, _options?): Promise<void>
Batch delete user configurations between two object types Delete
Parameters
- fromObjectType: string
- toObjectType: string
- batchInputPublicAssociationSpec: BatchInputPublicAssociationSpec
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:109

batchRemoveWithHttpInfo

batchRemoveWithHttpInfo(fromObjectType, toObjectType, batchInputPublicAssociationSpec, _options?): Promise<HttpInfo<void>>
Batch delete user configurations between two object types Delete
Parameters
- fromObjectType: string
- toObjectType: string
- batchInputPublicAssociationSpec: BatchInputPublicAssociationSpec
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:85

getAllBetweenTwoObjectTypes

getAllBetweenTwoObjectTypes(fromObjectType, toObjectType, _options?): Promise<CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging>
Returns user configurations on all association definitions between two object types Read
Parameters
- fromObjectType: string
- toObjectType: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging>
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:245

getAllBetweenTwoObjectTypesWithHttpInfo

getAllBetweenTwoObjectTypesWithHttpInfo(fromObjectType, toObjectType, _options?): Promise<HttpInfo<CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging>>
Returns user configurations on all association definitions between two object types Read
Parameters
- fromObjectType: string
- toObjectType: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging>>
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:222

getAllWithHttpInfo

getAllWithHttpInfo(_options?): Promise<HttpInfo<CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging>>
Returns all user configurations available on a given portal Read All
Parameters
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging>>
- Defined in codegen/crm/associations/v4/schema/types/PromiseAPI.ts:178

Class DefinitionConfigurationsApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DefinitionConfigurationsApi

Methods

batchCreate

Parameters

Returns Promise<BatchResponsePublicAssociationDefinitionUserConfiguration | BatchResponsePublicAssociationDefinitionUserConfigurationWithErrors>

batchCreateWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponsePublicAssociationDefinitionUserConfiguration | BatchResponsePublicAssociationDefinitionUserConfigurationWithErrors>>

batchRemove

Parameters

Returns Promise<void>

batchRemoveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

batchUpdate

Parameters

Returns Promise<BatchResponsePublicAssociationDefinitionConfigurationUpdateResult | BatchResponsePublicAssociationDefinitionConfigurationUpdateResultWithErrors>

batchUpdateWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponsePublicAssociationDefinitionConfigurationUpdateResult | BatchResponsePublicAssociationDefinitionConfigurationUpdateResultWithErrors>>

getAll

Parameters

Returns Promise<CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging>

getAllBetweenTwoObjectTypes

Parameters

Returns Promise<CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging>

getAllBetweenTwoObjectTypesWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging>>

getAllWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponsePublicAssociationDefinitionUserConfigurationNoPaging>>

Settings

On This Page