Class SettingsApiWrapper

Hierarchy

BaseApiWrapper<SettingsApi>
- SettingsApiWrapper

Index

Constructors

constructor

Properties

Accessors

observers

Methods

Constructors

constructor

new SettingsApiWrapper(accessToken: string, basePath?: string): SettingsApiWrapper

Overrides BaseApiWrapper.constructor
- Defined in src/apis/settingsApiWrapper.ts:15
Parameters
- accessToken: string
- Optional basePath: string
Returns SettingsApiWrapper

Properties

Protected Readonly api

api: SettingsApi

Static type

type: string = "settings"

Accessors

observers

get observers(): Observer[]

Inherited from BaseApiWrapper.observers
- Defined in src/apis/baseApiWrapper.ts:36
Returns Observer[]

Methods

createDeveloperAccount

createDeveloperAccount(req: CreateDeveloperAccountCreateRequest): Promise<DeveloperAccountResponse>

- Defined in src/apis/settingsApiWrapper.ts:23
Create or add a developer account. Developer accounts can be used as for escrow, minting and transferring assets. To add your own external account, add a signature and the address of the account. This verified account can then be used as a verified depositor

Parameters
- req: CreateDeveloperAccountCreateRequest
  
  Parameters to add a depositor address to s project environment
Returns Promise<DeveloperAccountResponse>

deleteDeveloperAccount

deleteDeveloperAccount(id: string): Promise<DeveloperAccountDeleteResponse>

- Defined in src/apis/settingsApiWrapper.ts:45
Delete a developer account from a project.

Parameters
- id: string
  
  Id of the developer account
Returns Promise<DeveloperAccountDeleteResponse>

getDeveloperAccount

getDeveloperAccount(req: GetDeveloperAccountRequest): Promise<DeveloperAccountResponse>

- Defined in src/apis/settingsApiWrapper.ts:37
Retrieve the list of the developer accounts for the current project

Parameters
- req: GetDeveloperAccountRequest
Returns Promise<DeveloperAccountResponse>

getDeveloperAccounts

getDeveloperAccounts(): Promise<DeveloperAccountListResponse>

- Defined in src/apis/settingsApiWrapper.ts:30
Lists the developer accounts of a project.

Returns Promise<DeveloperAccountListResponse>

getVerificationPayload

getVerificationPayload(address: string): Promise<string>

- Defined in src/apis/settingsApiWrapper.ts:53
Generate message, which should be signed for verification of the address ownership.

Parameters
- address: string
  
  Specifies the address
Returns Promise<string>

subscribe

subscribe(observer: Observer): void

Inherited from BaseApiWrapper.subscribe
- Defined in src/apis/baseApiWrapper.ts:32
Parameters
- observer: Observer
Returns void

Generated using TypeDoc