Class default

Hierarchy

default
- default

Index

Constructors

constructor

new default(__namedParameters: {
requestBuilder: default;
requestHandler: default;
}): default
Parameters
- __namedParameters: {
  requestBuilder: default;
  requestHandler: default;
  }
  - requestBuilder: default
  - requestHandler: default
Returns default
Inherited from default.constructor
- Defined in collections/abstractCollection.ts:13

Properties

`Protected` requestBuilder

requestBuilder: default

`Protected` requestHandler

requestHandler: default

Methods

`Protected` createAndSendRequest

createAndSendRequest(pathname: string, __namedParameters?: {
    body?: unknown;
    method?: Method;
    query?: {
        [key: string]: number | string | string[];
    };
}): Promise<any>
Parameters
- pathname: string
- __namedParameters: {
      body?: unknown;
      method?: Method;
      query?: {
          [key: string]: number | string | string[];
      };
  } = {}
  - Optional body?: unknown
  - Optional method?: Method
  - Optional query?: {
    [key: string]: number | string | string[];
    }
    - [key: string]: number | string | string[]
Returns Promise<any>
Inherited from default.createAndSendRequest
- Defined in collections/abstractCollection.ts:24

deleteAccount

deleteAccount(key: string): Promise<void>
Parameters
- key: string
Returns Promise<void>
- Defined in collections/accounts.ts:51

get

get(options?: Either<Status, Ids>): Promise<ResultSetResponse<AccountResponse>>
Retrieve existing accounts

An account can be retrieved by either specifying a status, or by specifying a list of account ids. The options cannot cannot be combined.

A maximum of 50 ids is allowed.
Parameters
- Optional options: Either<Status, Ids>
Returns Promise<ResultSetResponse<AccountResponse>>
- Defined in collections/accounts.ts:29

getAccount

getAccount(key: string): Promise<AccountResponse>
Parameters
- key: string
Returns Promise<AccountResponse>
- Defined in collections/accounts.ts:37

getAccountLinksForAccount

getAccountLinksForAccount(key: string): Promise<ResultSetResponse<AccountLinkResponse>>
Parameters
- key: string
Returns Promise<ResultSetResponse<AccountLinkResponse>>
- Defined in collections/accounts.ts:57

post

post(account: Account): Promise<AccountResponse>
Parameters
- account: Account
Returns Promise<AccountResponse>
- Defined in collections/accounts.ts:11

putAccount

putAccount(key: string, account: Account): Promise<AccountResponse>
Parameters
- key: string
- account: Account
Returns Promise<AccountResponse>
- Defined in collections/accounts.ts:41

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: { requestBuilder: default; requestHandler: default; }

requestBuilder: default

requestHandler: default

Returns default

Properties

Protected requestBuilder

Protected requestHandler

Methods

Protected createAndSendRequest

Parameters

pathname: string

__namedParameters: { body?: unknown; method?: Method; query?: { [key: string]: number | string | string[]; }; } = {}

Optional body?: unknown

Optional method?: Method

Optional query?: { [key: string]: number | string | string[]; }

[key: string]: number | string | string[]

Returns Promise<any>

deleteAccount

Parameters

key: string

Returns Promise<void>

get

Parameters

Optional options: Either<Status, Ids>

Returns Promise<ResultSetResponse<AccountResponse>>

getAccount

Parameters

key: string

Returns Promise<AccountResponse>

getAccountLinksForAccount

Parameters

key: string

Returns Promise<ResultSetResponse<AccountLinkResponse>>

post

Parameters

account: Account

Returns Promise<AccountResponse>

putAccount

Parameters

key: string

account: Account

Returns Promise<AccountResponse>

Settings

Member Visibility

Theme

__namedParameters: {
requestBuilder: default;
requestHandler: default;
}

`Protected` requestBuilder

`Protected` requestHandler

`Protected` createAndSendRequest

__namedParameters: {
body?: unknown;
method?: Method;
query?: {
[key: string]: number | string | string[];
};
} = {}

`Optional` body?: unknown

`Optional` method?: Method

`Optional` query?: {
[key: string]: number | string | string[];
}

`Optional` options: Either<Status, Ids>