Class GatewayConfigs

Hierarchy

APIResource
- GatewayConfigs

Index

Constructors

Properties

Methods

create retrieve update list delete

Constructors

constructor

new GatewayConfigs(client: Runloop): Runloop.GatewayConfigs
Parameters
- client: Runloop
Returns Runloop.GatewayConfigs
Inherited from APIResource.constructor
- Defined in src/resource.ts:8

Properties

`Protected`_client

_client: Runloop

Methods

create

create(
body: Runloop.GatewayConfigCreateParams,
options?: RequestOptions<unknown>,
): APIPromise<Runloop.GatewayConfigView>
[Beta] Create a new GatewayConfig to proxy API requests through the credential gateway. The config specifies the target endpoint and how credentials should be applied.
Parameters
- body: Runloop.GatewayConfigCreateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.GatewayConfigView>
- Defined in src/resources/gateway-configs.ts:14

retrieve

retrieve(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<Runloop.GatewayConfigView>
[Beta] Get a specific GatewayConfig by its unique identifier.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.GatewayConfigView>
- Defined in src/resources/gateway-configs.ts:21

update

update(
    id: string,
    body?: Runloop.GatewayConfigUpdateParams,
    options?: RequestOptions<unknown>,
): APIPromise<Runloop.GatewayConfigView>
[Beta] Update an existing GatewayConfig. All fields are optional.
Parameters
- id: string
- Optionalbody: Runloop.GatewayConfigUpdateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.GatewayConfigView>
- Defined in src/resources/gateway-configs.ts:28
update(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<Runloop.GatewayConfigView>
[Beta] Update an existing GatewayConfig. All fields are optional.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.GatewayConfigView>
- Defined in src/resources/gateway-configs.ts:33

list

list(
    query?: Runloop.GatewayConfigListParams,
    options?: RequestOptions<unknown>,
): PagePromise<
    Runloop.GatewayConfigViewsGatewayConfigsCursorIDPage,
    Runloop.GatewayConfigView,
>
[Beta] List all GatewayConfigs for the authenticated account, including system-provided configs like 'anthropic' and 'openai'.
Parameters
- Optionalquery: Runloop.GatewayConfigListParams
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<
Runloop.GatewayConfigViewsGatewayConfigsCursorIDPage,
Runloop.GatewayConfigView,
>
- Defined in src/resources/gateway-configs.ts:49
list(
    options?: RequestOptions<unknown>,
): PagePromise<
    Runloop.GatewayConfigViewsGatewayConfigsCursorIDPage,
    Runloop.GatewayConfigView,
>
[Beta] List all GatewayConfigs for the authenticated account, including system-provided configs like 'anthropic' and 'openai'.
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns PagePromise<
Runloop.GatewayConfigViewsGatewayConfigsCursorIDPage,
Runloop.GatewayConfigView,
>
- Defined in src/resources/gateway-configs.ts:53

delete

delete(
    id: string,
    body?: Runloop.GatewayConfigDeleteParams | null,
    options?: RequestOptions<unknown>,
): APIPromise<Runloop.GatewayConfigView>
[Beta] Delete an existing GatewayConfig. This action is irreversible.
Parameters
- id: string
- Optionalbody: Runloop.GatewayConfigDeleteParams | null
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Runloop.GatewayConfigView>
- Defined in src/resources/gateway-configs.ts:72