Class FieldMappingInstanceAccessor

Hierarchy (view full)

ElementInstanceAccessor<FieldMappingInstance, FieldMappingInstanceSelector, CreateFieldMappingInstanceRequest, UpdateFieldMappingInstanceRequest>
- FieldMappingInstanceAccessor

Index

Constructors

Properties

Methods

getUniqueIdentifier get getId create put patch archive delete getPath setup reset openConfiguration

Constructors

constructor

new FieldMappingInstanceAccessor(client, selector): FieldMappingInstanceAccessor
Parameters
- client: IntegrationAppApiClient
- selector: string | FieldMappingInstanceSelector
Returns FieldMappingInstanceAccessor
Overrides ElementInstanceAccessor.constructor
- Defined in field-mappings/accessors.ts:91

Properties

`Protected`options

options: {
    client: IntegrationAppApiClient;
    instancePath: string;
    selector: string | FieldMappingInstanceSelector;
    type?: WorkspaceElementType;
}

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ElementInstanceAccessor.getUniqueIdentifier
- Defined in accessors.ts:154

get

get(): Promise<FieldMappingInstance>
Returns Promise<FieldMappingInstance>
Inherited from ElementInstanceAccessor.get
- Defined in accessors.ts:158

getId

getId(): Promise<string>
Returns Promise<string>
Inherited from ElementInstanceAccessor.getId
- Defined in accessors.ts:162

create

create(data?): Promise<FieldMappingInstance>
Parameters
- Optionaldata: CreateFieldMappingInstanceRequest
Returns Promise<FieldMappingInstance>
Inherited from ElementInstanceAccessor.create
- Defined in accessors.ts:181

put

put(data): Promise<FieldMappingInstance>
Parameters
- data: CreateFieldMappingInstanceRequest
Returns Promise<FieldMappingInstance>
Inherited from ElementInstanceAccessor.put
- Defined in accessors.ts:200

patch

patch(data): Promise<FieldMappingInstance>
Parameters
- data: UpdateFieldMappingInstanceRequest
Returns Promise<FieldMappingInstance>
Inherited from ElementInstanceAccessor.patch
- Defined in accessors.ts:210

archive

archive(): Promise<void>
Returns Promise<void>
Inherited from ElementInstanceAccessor.archive
- Defined in accessors.ts:220

delete

delete(): Promise<void>
Returns Promise<void>
Deprecated
- use archive instead
Inherited from ElementInstanceAccessor.delete
- Defined in accessors.ts:227

`Protected`getPath

getPath(operation?): string
Parameters
- operation: string = ''
Returns string
Inherited from ElementInstanceAccessor.getPath
- Defined in accessors.ts:231

setup

setup(): Promise<void>
Returns Promise<void>
- Defined in field-mappings/accessors.ts:102

reset

reset(): Promise<void>
Returns Promise<void>
- Defined in field-mappings/accessors.ts:107

openConfiguration

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