Class BasicApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createDefault createDefaultWithHttpInfo createWithHttpInfo getPage getPageWithHttpInfo

Constructors

constructor

new BasicApi(configuration, requestFactory?, responseProcessor?): BasicApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: BasicApiRequestFactory
- OptionalresponseProcessor: BasicApiResponseProcessor
Returns BasicApi
- Defined in codegen/crm/associations/v4/types/PromiseAPI.ts:24

Methods

archiveWithHttpInfo

archiveWithHttpInfo(objectType, objectId, toObjectType, toObjectId, _options?): Promise<HttpInfo<void>>
deletes all associations between two records. Delete
Parameters
- objectType: string
- objectId: string
- toObjectType: string
- toObjectId: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/associations/v4/types/PromiseAPI.ts:40

create

create(objectType, objectId, toObjectType, toObjectId, associationSpec, _options?): Promise<LabelsBetweenObjectPair>
Set association labels between two records. Create
Parameters
- objectType: string
- objectId: string
- toObjectType: string
- toObjectId: string
- associationSpec: AssociationSpec[]
- Optional_options: PromiseConfigurationOptions
Returns Promise<LabelsBetweenObjectPair>
- Defined in codegen/crm/associations/v4/types/PromiseAPI.ts:117

createDefault

createDefault(fromObjectType, fromObjectId, toObjectType, toObjectId, _options?): Promise<BatchResponsePublicDefaultAssociation>
Create the default (most generic) association type between two object types Create Default
Parameters
- fromObjectType: string
- fromObjectId: string
- toObjectType: string
- toObjectId: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<BatchResponsePublicDefaultAssociation>
- Defined in codegen/crm/associations/v4/types/PromiseAPI.ts:167

createDefaultWithHttpInfo

createDefaultWithHttpInfo(fromObjectType, fromObjectId, toObjectType, toObjectId, _options?): Promise<HttpInfo<BatchResponsePublicDefaultAssociation>>
Create the default (most generic) association type between two object types Create Default
Parameters
- fromObjectType: string
- fromObjectId: string
- toObjectType: string
- toObjectId: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<BatchResponsePublicDefaultAssociation>>
- Defined in codegen/crm/associations/v4/types/PromiseAPI.ts:142

createWithHttpInfo

createWithHttpInfo(objectType, objectId, toObjectType, toObjectId, associationSpec, _options?): Promise<HttpInfo<LabelsBetweenObjectPair>>
Set association labels between two records. Create
Parameters
- objectType: string
- objectId: string
- toObjectType: string
- toObjectId: string
- associationSpec: AssociationSpec[]
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<LabelsBetweenObjectPair>>
- Defined in codegen/crm/associations/v4/types/PromiseAPI.ts:91

getPage

getPage(objectType, objectId, toObjectType, after?, limit?, _options?): Promise<CollectionResponseMultiAssociatedObjectWithLabelForwardPaging>
List all associations of an object by object type. Limit 500 per call. List
Parameters
- objectType: string
- objectId: string
- toObjectType: string
- Optionalafter: string
  The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
- Optionallimit: number
  The maximum number of results to display per page.
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponseMultiAssociatedObjectWithLabelForwardPaging>
- Defined in codegen/crm/associations/v4/types/PromiseAPI.ts:219

getPageWithHttpInfo

getPageWithHttpInfo(objectType, objectId, toObjectType, after?, limit?, _options?): Promise<HttpInfo<CollectionResponseMultiAssociatedObjectWithLabelForwardPaging>>
List all associations of an object by object type. Limit 500 per call. List
Parameters
- objectType: string
- objectId: string
- toObjectType: string
- Optionalafter: string
  The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
- Optionallimit: number
  The maximum number of results to display per page.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponseMultiAssociatedObjectWithLabelForwardPaging>>
- Defined in codegen/crm/associations/v4/types/PromiseAPI.ts:193

Class BasicApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BasicApi

Methods

archive

Parameters

Returns Promise<void>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

create

Parameters

Returns Promise<LabelsBetweenObjectPair>

createDefault

Parameters

Returns Promise<BatchResponsePublicDefaultAssociation>

createDefaultWithHttpInfo

Parameters

Returns Promise<HttpInfo<BatchResponsePublicDefaultAssociation>>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<LabelsBetweenObjectPair>>

getPage

Parameters

Returns Promise<CollectionResponseMultiAssociatedObjectWithLabelForwardPaging>

getPageWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponseMultiAssociatedObjectWithLabelForwardPaging>>

Settings

On This Page