Class ForgeClient`Abstract`

Hierarchy (view full)

ForgeClient

Index

Constructors

Properties

auth? axios host region root token?

Methods

delete fetch get getBuffer getStream patch post put reset setAuthorization

Constructors

constructor

new ForgeClient(root, auth, host?, region?): ForgeClient
Initializes new client with specific authentication method.
Parameters
- root: string
  Root path for all endpoints (must not contain any slashes at the beginning nor end).
- auth: IAuthOptions
  Authentication object, containing either client_id and client_secret properties (for 2-legged authentication), or a single token property (for 2-legged or 3-legged authentication with pre-generated access token).
- Optional host: string
  Forge API host (must not contain slash at the end).
- Optional region: Region
  Forge availability region ("US" or "EMEA").
Returns ForgeClient
- Defined in common.ts:39

Properties

`Protected` `Optional` auth

auth?: AuthenticationClient

`Protected` axios

axios: AxiosInstance

`Protected` host

host: string

`Protected` region

region: Region

`Protected` root

root: string

`Protected` `Optional` token

token?: string

Methods

`Protected` delete

delete(endpoint, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
- Defined in common.ts:161

`Protected` fetch

fetch(config): Promise<AxiosResponse<any, any>>
Parameters
- config: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<any, any>>
- Defined in common.ts:101

`Protected` get

get(endpoint, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
- Defined in common.ts:107

`Protected` getBuffer

getBuffer(endpoint, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
- Defined in common.ts:116

`Protected` getStream

getStream(endpoint, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
- Defined in common.ts:125

`Protected` patch

patch(endpoint, data, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- data: any
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
- Defined in common.ts:152

`Protected` post

post(endpoint, data, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- data: any
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
- Defined in common.ts:134

`Protected` put

put(endpoint, data, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- data: any
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
- Defined in common.ts:143

reset

reset(auth?, host?, region?): void
Resets client to specific authentication method, Forge host, and availability region.
Parameters
- Optional auth: IAuthOptions
  Authentication object, containing either client_id and client_secret properties (for 2-legged authentication), or a single token property (for 2-legged or 3-legged authentication with pre-generated access token).
- Optional host: string
  Forge API host.
- Optional region: Region
  Forge availability region ("US" or "EMEA").
Returns void
- Defined in common.ts:71

`Protected` setAuthorization

setAuthorization(options, scopes): Promise<void>
Parameters
- options: any
- scopes: string[]
Returns Promise<void>
- Defined in common.ts:90

Generated using TypeDoc