Class Federation

Hierarchy

UrlSection
- Federation

Index

Constructors

constructor

Methods

Constructors

constructor

new Federation(prv: PathSegment, id?: string, service?: any): Federation

Overrides UrlSection.constructor
- Defined in paths/Federation.ts:5
Parameters
- prv: PathSegment
- Optional id: string
- Optional service: any
Returns Federation

Methods

get

get(): Promise<FederationInfo>

- Defined in paths/Federation.ts:13
Returns information on a federation and associated accounts.
Required Permissions
Permission Description
ReadAccounts Viewing user account info (including name, business name, address and phone number/account number)
API Group
Medium

Returns Promise<FederationInfo>

getEndpoint

getEndpoint(withValue?: boolean): string

Inherited from UrlSection.getEndpoint
- Defined in PathSegment.ts:26
Parameters
- Default value withValue: boolean = true
Returns string

Protected getRest

getRest(): RestClient

Inherited from UrlSection.getRest
- Defined in PathSegment.ts:34
Returns RestClient

toString

toString(withValue?: boolean): string

Inherited from UrlSection.toString
- Defined in PathSegment.ts:18
Parameters
- Default value withValue: boolean = true
Returns string

Generated using TypeDoc