Type Alias Mapping

Type declaration

• createMapping:function

  • createMapping(
        mappingId: string,
        mappingData: MappingSkeleton,
    ): Promise<MappingSkeleton>

    Create mapping

    Parameters

    • mappingId: string

      id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')
    • mappingData: MappingSkeleton

      mapping object

    Returns Promise<MappingSkeleton>

    a promise that resolves to an mapping object

• createMappingExportTemplate:function

  • createMappingExportTemplate(): MappingExportInterface

    Create an empty mapping export template

    Returns MappingExportInterface

    an empty mapping export template

• deleteMapping:function

  • deleteMapping(mappingId: string): Promise<MappingSkeleton>

    Delete mapping

    Parameters

    • mappingId: string

      id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')

    Returns Promise<MappingSkeleton>

    a promise that resolves an mapping object

• deleteMappings:function

  • deleteMappings(
        connectorId?: string,
        moType?: string,
    ): Promise<MappingSkeleton[]>

    Delete all mappings

    Parameters

    • OptionalconnectorId: string

      limit mappings to connector
    • OptionalmoType: string

      limit mappings to managed object type

    Returns Promise<MappingSkeleton[]>

    a promise that resolves to an array of mapping objects

• exportMapping:function

  • exportMapping(
        mappingId: string,
        options?: MappingExportOptions,
    ): Promise<MappingExportInterface>

    Export mapping

    Parameters

    • mappingId: string

      id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')
    • Optionaloptions: MappingExportOptions

      export options

    Returns Promise<MappingExportInterface>

    a promise that resolves to a MappingExportInterface object

• exportMappings:function

  • exportMappings(options?: MappingExportOptions): Promise<MappingExportInterface>

    Export all mappings

    Parameters

    • Optionaloptions: MappingExportOptions

      export options

    Returns Promise<MappingExportInterface>

    a promise that resolves to a MappingExportInterface object

• importFirstMapping:function

  • importFirstMapping(
        importData: MappingExportInterface,
        options?: MappingImportOptions,
    ): Promise<MappingSkeleton>

    Import first mapping

    Parameters

    • importData: MappingExportInterface

      import data
    • Optionaloptions: MappingImportOptions

      import options

    Returns Promise<MappingSkeleton>

    a promise resolving to a MappingSkeleton object

• importMapping:function

  • importMapping(
        mappingId: string,
        importData: MappingExportInterface,
        options?: MappingImportOptions,
    ): Promise<MappingSkeleton>

    Import mapping

    Parameters

    • mappingId: string

      id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')
    • importData: MappingExportInterface

      import data
    • Optionaloptions: MappingImportOptions

      import options

    Returns Promise<MappingSkeleton>

    a promise resolving to a MappingSkeleton object

• importMappings:function

  • importMappings(
        importData: MappingExportInterface,
        options?: MappingImportOptions,
    ): Promise<MappingSkeleton[]>

    Import all mappings

    Parameters

    • importData: MappingExportInterface

      import data
    • Optionaloptions: MappingImportOptions

      import options

    Returns Promise<MappingSkeleton[]>

    a promise resolving to an array of MappingSkeleton objects

• isLegacyMapping:function

  • isLegacyMapping(mappingId: string): boolean

    Helper that returns a boolean indicating whether the mapping is a legacy mapping or not given the id

    Parameters

    • mappingId: string

      the mapping id

    Returns boolean

    true if the mapping is a legacy mapping, false otherwise

    Throws

    if the id is invalid

• readMapping:function

  • readMapping(mappingId: string): Promise<MappingSkeleton>

    Read mapping

    Parameters

    • mappingId: string

      id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')

    Returns Promise<MappingSkeleton>

    a promise that resolves an mapping object

• readMappings:function

  • readMappings(connectorId?: string, moType?: string): Promise<MappingSkeleton[]>

    Read mappings

    Parameters

    • OptionalconnectorId: string

      limit mappings to connector
    • OptionalmoType: string

      limit mappings to managed object type

    Returns Promise<MappingSkeleton[]>

    a promise that resolves to an array of mapping objects

• readSyncMappings:function

  • readSyncMappings(): Promise<MappingSkeleton[]>

    Read mappings from sync.json (legacy)

    Returns Promise<MappingSkeleton[]>

    a promise that resolves to an array of mapping objects

• updateMapping:function

  • updateMapping(
        mappingId: string,
        mappingData: MappingSkeleton,
    ): Promise<MappingSkeleton>

    Update or create mapping

    Parameters

    • mappingId: string

      id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')
    • mappingData: MappingSkeleton

      mapping object

    Returns Promise<MappingSkeleton>

    a promise that resolves to an mapping object

• updateSyncMappings:function

  • updateSyncMappings(mappings: MappingSkeleton[]): Promise<MappingSkeleton[]>

    Update or create mappings in sync.json (legacy)

    Parameters

    • mappings: MappingSkeleton[]

    Returns Promise<MappingSkeleton[]>

    a promise that resolves to an mapping object