Class GboxClient

API Client for interfacing with the Gbox Client API.

Constructors

constructor

new GboxClient(__namedParameters?: ClientOptions): GboxClient
API Client for interfacing with the Gbox Client API.
Parameters
- Optional__namedParameters: ClientOptions = {}
Returns GboxClient
- Defined in src/client.ts:157

Properties

`Protected`_options

_options: ClientOptions

apiKey

apiKey: string

baseURL

baseURL: string

fetchOptions

fetchOptions: MergedRequestInit | undefined

`Protected` `Optional`idempotencyHeader

idempotencyHeader?: string

logger

logger: Logger

logLevel

logLevel: LogLevel | undefined

maxRetries

maxRetries: number

timeout

timeout: number

v1

v1: GboxClient.V1 = ...

`Static`APIConnectionError

APIConnectionError: typeof APIConnectionError = Errors.APIConnectionError

`Static`APIConnectionTimeoutError

APIConnectionTimeoutError: typeof APIConnectionTimeoutError = Errors.APIConnectionTimeoutError

`Static`APIError

APIError: typeof APIError = Errors.APIError

`Static`APIUserAbortError

APIUserAbortError: typeof APIUserAbortError = Errors.APIUserAbortError

`Static`AuthenticationError

AuthenticationError: typeof AuthenticationError = Errors.AuthenticationError

`Static`BadRequestError

BadRequestError: typeof BadRequestError = Errors.BadRequestError

`Static`ConflictError

ConflictError: typeof ConflictError = Errors.ConflictError

`Static`DEFAULT_TIMEOUT

DEFAULT_TIMEOUT: number = 60000

`Static`GboxClient

GboxClient: typeof GboxClient = ...

`Static`GboxClientError

GboxClientError: typeof GboxClientError = Errors.GboxClientError

`Static`InternalServerError

InternalServerError: typeof InternalServerError = Errors.InternalServerError

`Static`NotFoundError

NotFoundError: typeof NotFoundError = Errors.NotFoundError

`Static`PermissionDeniedError

PermissionDeniedError: typeof PermissionDeniedError = Errors.PermissionDeniedError

`Static`RateLimitError

RateLimitError: typeof RateLimitError = Errors.RateLimitError

`Static`toFile

toFile: (
    value: ToFileInput | PromiseLike<ToFileInput>,
    name?: string | null,
    options?: FilePropertyBag,
) => Promise<File> = Uploads.toFile

Type Declaration

- (
      value: ToFileInput | PromiseLike<ToFileInput>,
      name?: string | null,
      options?: FilePropertyBag,
  ): Promise<File>
- Helper for creating a File to pass to an SDK upload method from a variety of different data formats
  Parameters
  - value: ToFileInput | PromiseLike<ToFileInput>
    the raw content of the file. Can be an Uploadable, BlobLikePart, or AsyncIterable of BlobLikeParts
  - Optionalname: string | null
    the name of the file. If omitted, toFile will try to determine a file name from bits if possible
  - Optionaloptions: FilePropertyBag
    additional properties
    - type
      the MIME type of the content
    - lastModified
      the last modified timestamp
  Returns Promise<File>
  a File with the given properties

`Static`UnprocessableEntityError

UnprocessableEntityError: typeof UnprocessableEntityError = Errors.UnprocessableEntityError

Methods

`Protected`authHeaders

authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined>
Parameters
- opts: FinalRequestOptions
Returns Promise<NullableHeaders | undefined>
- Defined in src/client.ts:236

buildRequest

buildRequest(
inputOptions: FinalRequestOptions,
__namedParameters?: { retryCount?: number },
): Promise<{ req: FinalizedRequestInit; timeout: number; url: string }>
Parameters
- inputOptions: FinalRequestOptions
- __namedParameters: { retryCount?: number } = {}
Returns Promise<{ req: FinalizedRequestInit; timeout: number; url: string }>
- Defined in src/client.ts:608

buildURL

buildURL(
    path: string,
    query: Record<string, unknown> | null | undefined,
    defaultBaseURL?: string,
): string
Parameters
- path: string
- query: Record<string, unknown> | null | undefined
- OptionaldefaultBaseURL: string
Returns string
- Defined in src/client.ts:261

`Protected`defaultIdempotencyKey

defaultIdempotencyKey(): string
Returns string
- Defined in src/client.ts:248

`Protected`defaultQuery

defaultQuery(): Record<string, string | undefined> | undefined
Returns Record<string, string | undefined> | undefined
- Defined in src/client.ts:228

delete

delete<Rsp>(
path: string,
opts?: PromiseOrValue<RequestOptions>,
): APIPromise<Rsp>
Type Parameters
- Rsp
Parameters
- path: string
- Optionalopts: PromiseOrValue<RequestOptions>
Returns APIPromise<Rsp>
- Defined in src/client.ts:316

fetchWithTimeout

fetchWithTimeout(
    url: _RequestInfo,
    init: RequestInit | undefined,
    ms: number,
    controller: AbortController,
): Promise<Response>
Parameters
- url: _RequestInfo
- init: RequestInit | undefined
- ms: number
- controller: AbortController
Returns Promise<Response>
- Defined in src/client.ts:496

get

get<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>
Type Parameters
- Rsp
Parameters
- path: string
- Optionalopts: PromiseOrValue<RequestOptions>
Returns APIPromise<Rsp>
- Defined in src/client.ts:300

`Protected`makeStatusError

makeStatusError(
    status: number,
    error: Object,
    message: string | undefined,
    headers: Headers,
): APIError
Parameters
- status: number
- error: Object
- message: string | undefined
- headers: Headers
Returns APIError
- Defined in src/client.ts:252

patch

patch<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>
Type Parameters
- Rsp
Parameters
- path: string
- Optionalopts: PromiseOrValue<RequestOptions>
Returns APIPromise<Rsp>
- Defined in src/client.ts:308

post

post<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>
Type Parameters
- Rsp
Parameters
- path: string
- Optionalopts: PromiseOrValue<RequestOptions>
Returns APIPromise<Rsp>
- Defined in src/client.ts:304

`Protected`prepareOptions

prepareOptions(options: FinalRequestOptions): Promise<void>
Used as a callback for mutating the given FinalRequestOptions object.
Parameters
- options: FinalRequestOptions
Returns Promise<void>
- Defined in src/client.ts:287

`Protected`prepareRequest

prepareRequest(
request: RequestInit,
__namedParameters: { options: FinalRequestOptions; url: string },
): Promise<void>
Used as a callback for mutating the given RequestInit object.

This is useful for cases where you want to add certain headers based off of the request properties, e.g. method or url.
Parameters
- request: RequestInit
- __namedParameters: { options: FinalRequestOptions; url: string }
Returns Promise<void>
- Defined in src/client.ts:295

put

put<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>
Type Parameters
- Rsp
Parameters
- path: string
- Optionalopts: PromiseOrValue<RequestOptions>
Returns APIPromise<Rsp>
- Defined in src/client.ts:312

request

request<Rsp>(
options: PromiseOrValue<FinalRequestOptions>,
remainingRetries?: number | null,
): APIPromise<Rsp>
Type Parameters
- Rsp
Parameters
- options: PromiseOrValue<FinalRequestOptions>
- remainingRetries: number | null = null
Returns APIPromise<Rsp>
- Defined in src/client.ts:332

`Protected`stringifyQuery

stringifyQuery(query: Record<string, unknown>): string
Parameters
- query: Record<string, unknown>
Returns string
- Defined in src/client.ts:240

`Protected`validateHeaders

validateHeaders(__namedParameters: NullableHeaders): void
Parameters
- __namedParameters: NullableHeaders
Returns void
- Defined in src/client.ts:232

withOptions

withOptions(options: Partial<ClientOptions>): this
Create a new client instance re-using the same options given to the current client with optional overriding.
Parameters
- options: Partial<ClientOptions>
Returns this
- Defined in src/client.ts:204

Class GboxClient

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GboxClient

Properties

Protected_options

apiKey

baseURL

fetchOptions

Protected OptionalidempotencyHeader

logger

logLevel

maxRetries

timeout

v1

StaticAPIConnectionError

StaticAPIConnectionTimeoutError

StaticAPIError

StaticAPIUserAbortError

StaticAuthenticationError

StaticBadRequestError

StaticConflictError

StaticDEFAULT_TIMEOUT

StaticGboxClient

StaticGboxClientError

StaticInternalServerError

StaticNotFoundError

StaticPermissionDeniedError

StaticRateLimitError

StatictoFile

Type Declaration

Parameters

type

lastModified

Returns Promise<File>

StaticUnprocessableEntityError

Methods

ProtectedauthHeaders

Parameters

Returns Promise<NullableHeaders | undefined>

buildRequest

Parameters

Returns Promise<{ req: FinalizedRequestInit; timeout: number; url: string }>

buildURL

Parameters

Returns string

ProtecteddefaultIdempotencyKey

Returns string

ProtecteddefaultQuery

Returns Record<string, string | undefined> | undefined

delete

Type Parameters

Parameters

Returns APIPromise<Rsp>

fetchWithTimeout

Parameters

Returns Promise<Response>

get

Type Parameters

Parameters

Returns APIPromise<Rsp>

ProtectedmakeStatusError

Parameters

Returns APIError

patch

Type Parameters

Parameters

Returns APIPromise<Rsp>

post

Type Parameters

Parameters

Returns APIPromise<Rsp>

ProtectedprepareOptions

Parameters

Returns Promise<void>

`Protected`_options

`Protected` `Optional`idempotencyHeader

`Static`APIConnectionError

`Static`APIConnectionTimeoutError

`Static`APIError

`Static`APIUserAbortError

`Static`AuthenticationError

`Static`BadRequestError

`Static`ConflictError

`Static`DEFAULT_TIMEOUT

`Static`GboxClient

`Static`GboxClientError

`Static`InternalServerError

`Static`NotFoundError

`Static`PermissionDeniedError

`Static`RateLimitError

`Static`toFile

`Static`UnprocessableEntityError

`Protected`authHeaders

`Protected`defaultIdempotencyKey

`Protected`defaultQuery

`Protected`makeStatusError

`Protected`prepareOptions

`Protected`prepareRequest

`Protected`stringifyQuery

`Protected`validateHeaders