Type Alias CirclesOfTrust

Type declaration

• createCircleOfTrust:function

  • createCircleOfTrust(
        cotId?: string,
        cotData?: CircleOfTrustSkeleton,
    ): Promise<CircleOfTrustSkeleton>

    Create circle of trust

    Parameters

    • OptionalcotId: string

      circle of trust id/name
    • OptionalcotData: CircleOfTrustSkeleton

      circle of trust data

    Returns Promise<CircleOfTrustSkeleton>

• createCirclesOfTrustExportTemplate:function

  • createCirclesOfTrustExportTemplate(): CirclesOfTrustExportInterface

    Create an empty agent export template

    Returns CirclesOfTrustExportInterface

    an empty agent export template

• deleteCircleOfTrust:function

  • deleteCircleOfTrust(cotId: string): Promise<CircleOfTrustSkeleton>

    Delete circle of trust

    Parameters

    • cotId: string

      circle of trust id/name

    Returns Promise<CircleOfTrustSkeleton>

• deleteCirclesOfTrust:function

  • deleteCirclesOfTrust(
        entityProviders?: string[],
    ): Promise<CircleOfTrustSkeleton[]>

    Delete circles of trust

    Parameters

    • OptionalentityProviders: string[]

      filter by entity providers

    Returns Promise<CircleOfTrustSkeleton[]>

• exportCircleOfTrust:function

  • exportCircleOfTrust(cotId: string): Promise<CirclesOfTrustExportInterface>

    Export circle of trust

    Parameters

    • cotId: string

      circle of trust id/name

    Returns Promise<CirclesOfTrustExportInterface>

• exportCirclesOfTrust:function

  • exportCirclesOfTrust(
        entityProviders?: string[],
    ): Promise<CirclesOfTrustExportInterface>

    Export all circles of trust

    Parameters

    • OptionalentityProviders: string[]

      filter by entity providers

    Returns Promise<CirclesOfTrustExportInterface>

• getCircleOfTrust:function

  • getCircleOfTrust(cotId: string): Promise<CircleOfTrustSkeleton>

    Get circle of trust

    Parameters

    • cotId: string

      circle of trust id/name

    Returns Promise<CircleOfTrustSkeleton>

    a promise resolving to a circle of trust object

    Deprecated

    since v2.0.0 use readCircleOfTrust instead

    readCircleOfTrust(cotId: string): Promise<CircleOfTrustSkeleton>
    Copy

• getCirclesOfTrust:function

  • getCirclesOfTrust(): Promise<CircleOfTrustSkeleton[]>

    Get all circles of trust

    Returns Promise<CircleOfTrustSkeleton[]>

    a promise resolving to an array of circle of trust objects

    Deprecated

    since v2.0.0 use readCirclesOfTrust instead

    readCirclesOfTrust(): Promise<CircleOfTrustSkeleton[]>
    Copy

• importCircleOfTrust:function

  • importCircleOfTrust(
        cotId: string,
        importData: CirclesOfTrustExportInterface,
    ): Promise<CircleOfTrustSkeleton>

    Import a circle of trust by id/name from file

    Parameters

    • cotId: string

      Circle of trust id/name
    • importData: CirclesOfTrustExportInterface

      Import data

    Returns Promise<CircleOfTrustSkeleton>

    a promise resolving to the circle of trust object that was created or updated. Note: If the circle of trust already exists and does not need updating, null is returned.

• importCirclesOfTrust:function

  • importCirclesOfTrust(
        importData: CirclesOfTrustExportInterface,
        entityProviders?: string[],
    ): Promise<CircleOfTrustSkeleton[]>

    Import all circles of trust

    Parameters

    • importData: CirclesOfTrustExportInterface

      Import data
    • OptionalentityProviders: string[]

      filter by entity providers

    Returns Promise<CircleOfTrustSkeleton[]>

    a promise resolving to an array of circle of trust objects that were created or updated. Note: If a circle of trust already exists and does not need updating, it is omitted from the response array.

• importFirstCircleOfTrust:function

  • importFirstCircleOfTrust(
        importData: CirclesOfTrustExportInterface,
    ): Promise<CircleOfTrustSkeleton>

    Import first circle of trust

    Parameters

    • importData: CirclesOfTrustExportInterface

      Import data

    Returns Promise<CircleOfTrustSkeleton>

    a promise resolving to the circle of trust object that was created or updated. Note: If the circle of trust already exists and does not need updating, null is returned.

• readCircleOfTrust:function

  • readCircleOfTrust(cotId: string): Promise<CircleOfTrustSkeleton>

    Read circle of trust

    Parameters

    • cotId: string

      circle of trust id/name

    Returns Promise<CircleOfTrustSkeleton>

• readCirclesOfTrust:function

  • readCirclesOfTrust(entityProviders?: string[]): Promise<CircleOfTrustSkeleton[]>

    Read all circles of trust

    Parameters

    • OptionalentityProviders: string[]

      filter by entity providers

    Returns Promise<CircleOfTrustSkeleton[]>

• updateCircleOfTrust:function

  • updateCircleOfTrust(
        cotId: string,
        cotData: CircleOfTrustSkeleton,
    ): Promise<CircleOfTrustSkeleton>

    Update circle of trust

    Parameters

    • cotId: string

      circle of trust id/name
    • cotData: CircleOfTrustSkeleton

      circle of trust data

    Returns Promise<CircleOfTrustSkeleton>