Class ConnectionLevelFieldMappingAccessor

Hierarchy (View Summary)

ConnectionLevelElementAccessor<
FieldMappingInstance,
UpdateFieldMappingInstanceRequest,
>
- ConnectionLevelFieldMappingAccessor

Index

Constructors

Methods

uri getUniqueIdentifier get create patch put archive reset setup openConfiguration

Properties

selector elementKey endpoint client connectionSelector fieldMappingSelector query

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 ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:1927

Methods

`Protected`uri

uri(path?: string, query?: {}): string
Parameters
- Optionalpath: string
- Optionalquery: {}
Returns string
Inherited from ConnectionLevelElementAccessor.uri
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:1846

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ConnectionLevelElementAccessor.getUniqueIdentifier
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:1847

get

get(query?: { autoCreate?: boolean }): Promise<FieldMappingInstance>
Parameters
- Optionalquery: { autoCreate?: boolean }
Returns Promise<FieldMappingInstance>
Inherited from ConnectionLevelElementAccessor.get
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:1848

create

create(): Promise<FieldMappingInstance>
Returns Promise<FieldMappingInstance>
Inherited from ConnectionLevelElementAccessor.create
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:1851

patch

patch(
data: Partial<UpdateFieldMappingInstanceRequest>,
): Promise<FieldMappingInstance>
Parameters
- data: Partial<UpdateFieldMappingInstanceRequest>
Returns Promise<FieldMappingInstance>
Inherited from ConnectionLevelElementAccessor.patch
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:1852

put

put(data: UpdateFieldMappingInstanceRequest): Promise<FieldMappingInstance>
Parameters
- data: UpdateFieldMappingInstanceRequest
Returns Promise<FieldMappingInstance>
Inherited from ConnectionLevelElementAccessor.put
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:1853

archive

archive(): Promise<void>
Returns Promise<void>
Inherited from ConnectionLevelElementAccessor.archive
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:1854

reset

reset(): Promise<FieldMappingInstance>
Returns Promise<FieldMappingInstance>
Inherited from ConnectionLevelElementAccessor.reset
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:1855

setup

setup(): Promise<FieldMappingInstance>
Returns Promise<FieldMappingInstance>
Inherited from ConnectionLevelElementAccessor.setup
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:1856

openConfiguration

openConfiguration(
__namedParameters?: OpenFieldMappingInstanceConfigurationOptions,
): Promise<void>
Parameters
- Optional__namedParameters: OpenFieldMappingInstanceConfigurationOptions
Returns Promise<void>
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:1928

Properties

`Protected`selector

selector: string

`Protected`elementKey

elementKey: string

`Protected`endpoint

endpoint: string

client

client: IntegrationAppApiClient

connectionSelector

connectionSelector: string

fieldMappingSelector

fieldMappingSelector: string

query

query: InstanceKeyQuery