Class ConnectionLevelFieldMappingAccessor

Hierarchy (View Summary)

ConnectionLevelElementAccessor<
FieldMappingInstance,
UpdateFieldMappingInstanceRequest,
>
- ConnectionLevelFieldMappingAccessor

Index

Constructors

Properties

client connectionSelector fieldMappingSelector query endpoint selector elementKey

Methods

openConfiguration uri getUniqueIdentifier get create patch put archive reset setup

Constructors

constructor

new ConnectionLevelFieldMappingAccessor(
    client: IntegrationAppApiClient,
    connectionSelector: string,
    fieldMappingSelector: string,
    query: InstanceKeyQuery,
): ConnectionLevelFieldMappingAccessor
Parameters
- client: IntegrationAppApiClient
- connectionSelector: string
- fieldMappingSelector: string
- query: InstanceKeyQuery
Returns ConnectionLevelFieldMappingAccessor
Overrides ConnectionLevelElementAccessor.constructor
- Defined in field-mappings/accessors.ts:151

Properties

client

client: IntegrationAppApiClient

connectionSelector

connectionSelector: string

fieldMappingSelector

fieldMappingSelector: string

query

query: InstanceKeyQuery

`Protected`endpoint

endpoint: string

`Protected`selector

selector: string

`Protected`elementKey

elementKey: string

Methods

openConfiguration

openConfiguration(
__namedParameters?: OpenFieldMappingInstanceConfigurationOptions,
): Promise<void>
Parameters
- __namedParameters: OpenFieldMappingInstanceConfigurationOptions = {}
Returns Promise<void>
- Defined in field-mappings/accessors.ts:160

`Protected`uri

uri(path?: string, query?: {}): string
Parameters
- path: string = ''
- query: {} = {}
Returns string
Inherited from ConnectionLevelElementAccessor.uri
- Defined in integration-elements/connection-level-element.accessor.ts:19

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ConnectionLevelElementAccessor.getUniqueIdentifier
- Defined in integration-elements/connection-level-element.accessor.ts:23

get

get(query?: { autoCreate?: boolean }): Promise<FieldMappingInstance>
Parameters
- query: { autoCreate?: boolean } = {}
Returns Promise<FieldMappingInstance>
Inherited from ConnectionLevelElementAccessor.get
- Defined in integration-elements/connection-level-element.accessor.ts:27

create

create(): Promise<FieldMappingInstance>
Returns Promise<FieldMappingInstance>
Inherited from ConnectionLevelElementAccessor.create
- Defined in integration-elements/connection-level-element.accessor.ts:31

patch

patch(data: Partial<UpdateElement>): Promise<FieldMappingInstance>
Parameters
- data: Partial<UpdateElement>
Returns Promise<FieldMappingInstance>
Inherited from ConnectionLevelElementAccessor.patch
- Defined in integration-elements/connection-level-element.accessor.ts:35

put

put(data: UpdateFieldMappingInstanceRequest): Promise<FieldMappingInstance>
Parameters
- data: UpdateFieldMappingInstanceRequest
Returns Promise<FieldMappingInstance>
Inherited from ConnectionLevelElementAccessor.put
- Defined in integration-elements/connection-level-element.accessor.ts:39

archive

archive(): Promise<void>
Returns Promise<void>
Inherited from ConnectionLevelElementAccessor.archive
- Defined in integration-elements/connection-level-element.accessor.ts:43

reset

reset(): Promise<FieldMappingInstance>
Returns Promise<FieldMappingInstance>
Inherited from ConnectionLevelElementAccessor.reset
- Defined in integration-elements/connection-level-element.accessor.ts:47

setup

setup(): Promise<FieldMappingInstance>
Returns Promise<FieldMappingInstance>
Inherited from ConnectionLevelElementAccessor.setup
- Defined in integration-elements/connection-level-element.accessor.ts:51