Class Proxy

Hierarchy

APIResource
- Proxy

Index

Constructors

Properties

Methods

Constructors

constructor

new Proxy(client: GboxClient): GboxClient.V1.Boxes.Proxy
Parameters
- client: GboxClient
Returns GboxClient.V1.Boxes.Proxy
Inherited from APIResource.constructor
- Defined in src/core/resource.ts:8

Properties

`Protected`_client

_client: GboxClient

Methods

clear

clear(boxID: string, options?: RequestOptions): APIPromise<void>
Clear the proxy for the box
Parameters
- boxID: string
- Optionaloptions: RequestOptions
Returns APIPromise<void>
Example
```
await client.v1.boxes.proxy.clear(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
);
```
- Defined in src/resources/v1/boxes/proxy.ts:20

get

get(
boxID: string,
options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.ProxyGetResponse>
Get the proxy for the box
Parameters
- boxID: string
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.ProxyGetResponse>
Example
```
const proxy = await client.v1.boxes.proxy.get(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
);
```
- Defined in src/resources/v1/boxes/proxy.ts:37

set

set(
    boxID: string,
    body: GboxClient.V1.Boxes.ProxySetParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.ProxySetResponse>
Set the proxy for the box
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.ProxySetParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.ProxySetResponse>
Example
```
const response = await client.v1.boxes.proxy.set(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { host: '127.0.0.1', port: 8080 },
);
```
- Defined in src/resources/v1/boxes/proxy.ts:52