Class FieldMappingAccessor

Hierarchy (view full)

ElementAccessor<FieldMapping, UpdateFieldMappingRequest, FieldMappingSelector>
- FieldMappingAccessor

Index

Constructors

Properties

Methods

getUniqueIdentifier get put patch archive getPath getAppSchema apply reset

Constructors

constructor

new FieldMappingAccessor(client, selector): FieldMappingAccessor
Parameters
- client: IntegrationAppApiClient
- selector: string | FieldMappingSelector
Returns FieldMappingAccessor
Overrides ElementAccessor.constructor
- Defined in field-mappings/accessors.ts:50

Properties

`Protected`options

options: {
    client: IntegrationAppApiClient;
    path: string;
    selector: string | FieldMappingSelector;
}

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ElementAccessor.getUniqueIdentifier
- Defined in accessors.ts:44

get

get(): Promise<FieldMapping>
Returns Promise<FieldMapping>
Inherited from ElementAccessor.get
- Defined in accessors.ts:48

put

put(data): Promise<FieldMapping>
Parameters
- data: UpdateFieldMappingRequest
Returns Promise<FieldMapping>
Inherited from ElementAccessor.put
- Defined in accessors.ts:52

patch

patch(data): Promise<FieldMapping>
Parameters
- data: Partial<UpdateFieldMappingRequest>
Returns Promise<FieldMapping>
Inherited from ElementAccessor.patch
- Defined in accessors.ts:56

archive

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

getPath

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

getAppSchema

getAppSchema(): Promise<any>
Returns Promise<any>
- Defined in field-mappings/accessors.ts:61

apply

apply(integrationKeys): Promise<FieldMapping[]>
Parameters
- integrationKeys: string[]
Returns Promise<FieldMapping[]>
- Defined in field-mappings/accessors.ts:65

reset

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