Class APIClient

Hierarchy

APIClient

Index

Constructors

constructor

new APIClient(options: APIClientOptions): APIClient
Parameters
- options: APIClientOptions
Returns APIClient
- Defined in src/rest/client.ts:56

Properties

`Private` agent

agent: unknown

`Readonly` authType

authType: APIAuthenticationPrefix

`Private` `Readonly` options

options: APIClientOptions

`Readonly` url

url: (<Path>(path: Path, query: Query<Path>) => string)

Type declaration

- <Path>(path: Path, query: Query<Path>): string
- Type Parameters
  - Path extends string
  Parameters
  - path: Path
  - query: Query<Path>
  Returns string

Methods

delete

delete<Path>(path: Path, body: (Extract<Endpoint<"DELETE", "/v1/users/@me/pats/:pat_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/projects/:project_id/tokens/:project_token_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/projects/@this/tokens/:project_token_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/projects/:project_id/secrets/:secret_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/projects/@this/secrets/:secret_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/channels/:channel_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/channels/tokens/:token", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/ignite/deployments/:deployment_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/ignite/containers/:container_id", void | {
    container: Container;
}, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/ignite/domains/:domain_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/pipe/rooms/:room_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/registry/images/:image", void, undefined>, {
    method: "DELETE";
    path: Path;
}>)["body"], query: Query<Path>, init?: RequestInit): Promise<(Extract<Endpoint<"DELETE", "/v1/users/@me/pats/:pat_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/projects/:project_id/tokens/:project_token_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/projects/@this/tokens/:project_token_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/projects/:project_id/secrets/:secret_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/projects/@this/secrets/:secret_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/channels/:channel_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/channels/tokens/:token", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/ignite/deployments/:deployment_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/ignite/containers/:container_id", void | {
    container: Container;
}, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/ignite/domains/:domain_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/pipe/rooms/:room_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/registry/images/:image", void, undefined>, {
    method: "DELETE";
    path: Path;
}>)["res"]>
Type Parameters
- Path extends "/v1/users/@me/pats/:pat_id" | "/v1/projects/:project_id/tokens/:project_token_id" | "/v1/projects/@this/tokens/:project_token_id" | "/v1/projects/:project_id/secrets/:secret_id" | "/v1/projects/@this/secrets/:secret_id" | "/v1/channels/:channel_id" | "/v1/channels/tokens/:token" | "/v1/ignite/deployments/:deployment_id" | "/v1/ignite/containers/:container_id" | "/v1/ignite/domains/:domain_id" | "/v1/pipe/rooms/:room_id" | "/v1/registry/images/:image"
Parameters
- path: Path
- body: (Extract<Endpoint<"DELETE", "/v1/users/@me/pats/:pat_id", void, undefined>, {
      method: "DELETE";
      path: Path;
  }> | Extract<Endpoint<"DELETE", "/v1/projects/:project_id/tokens/:project_token_id", void, undefined>, {
      method: "DELETE";
      path: Path;
  }> | Extract<Endpoint<"DELETE", "/v1/projects/@this/tokens/:project_token_id", void, undefined>, {
      method: "DELETE";
      path: Path;
  }> | Extract<Endpoint<"DELETE", "/v1/projects/:project_id/secrets/:secret_id", void, undefined>, {
      method: "DELETE";
      path: Path;
  }> | Extract<Endpoint<"DELETE", "/v1/projects/@this/secrets/:secret_id", void, undefined>, {
      method: "DELETE";
      path: Path;
  }> | Extract<Endpoint<"DELETE", "/v1/channels/:channel_id", void, undefined>, {
      method: "DELETE";
      path: Path;
  }> | Extract<Endpoint<"DELETE", "/v1/channels/tokens/:token", void, undefined>, {
      method: "DELETE";
      path: Path;
  }> | Extract<Endpoint<"DELETE", "/v1/ignite/deployments/:deployment_id", void, undefined>, {
      method: "DELETE";
      path: Path;
  }> | Extract<Endpoint<"DELETE", "/v1/ignite/containers/:container_id", void | {
      container: Container;
  }, undefined>, {
      method: "DELETE";
      path: Path;
  }> | Extract<Endpoint<"DELETE", "/v1/ignite/domains/:domain_id", void, undefined>, {
      method: "DELETE";
      path: Path;
  }> | Extract<Endpoint<"DELETE", "/v1/pipe/rooms/:room_id", void, undefined>, {
      method: "DELETE";
      path: Path;
  }> | Extract<Endpoint<"DELETE", "/v1/registry/images/:image", void, undefined>, {
      method: "DELETE";
      path: Path;
  }>)["body"]
- query: Query<Path>
- Optional init: RequestInit
Returns Promise<(Extract<Endpoint<"DELETE", "/v1/users/@me/pats/:pat_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/projects/:project_id/tokens/:project_token_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/projects/@this/tokens/:project_token_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/projects/:project_id/secrets/:secret_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/projects/@this/secrets/:secret_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/channels/:channel_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/channels/tokens/:token", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/ignite/deployments/:deployment_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/ignite/containers/:container_id", void | {
    container: Container;
}, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/ignite/domains/:domain_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/pipe/rooms/:room_id", void, undefined>, {
    method: "DELETE";
    path: Path;
}> | Extract<Endpoint<"DELETE", "/v1/registry/images/:image", void, undefined>, {
    method: "DELETE";
    path: Path;
}>)["res"]>
- Defined in src/rest/client.ts:118

`Private` executeRequest

executeRequest<T>(request: Request): Promise<T>
Type Parameters
- T
Parameters
- request: Request
Returns Promise<T>
- Defined in src/rest/client.ts:139

get

get<Path>(path: Path, query: Query<Path>, init?: RequestInit): Promise<(Extract<Endpoint<"GET", "/v1/users/@me", {
    leap_token: null | string;
    project_member_role_map: Record<`project_${string}`, MemberRole>;
    projects: Project[];
    user: SelfUser;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/users/@me/pats", {
    pats: PAT[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/projects/:project_id/members/@me", {
    project_member: Member;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/projects/:project_id/tokens", {
    project_tokens: ProjectToken[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/projects/@this/tokens", {
    project_tokens: ProjectToken[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/projects/:project_id/members", {
    members: Member[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/projects/@this/members", {
    members: Member[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/projects/:project_id/secrets", {
    secrets: Secret[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/projects/@this/secrets", {
    secrets: Secret[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/channels/:channel_id", {
    channel: Channel;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/channels/:channel_id/tokens", {
    tokens: ChannelToken[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/channels/:channel_id/state", {
    state: State;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/channels", {
    channels: Channel[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/channels/tokens/:token", {
    token: ChannelToken;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/channels/:channel_id/stats", {
    stats: {
        online_count: number;
    };
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/deployments", {
    deployments: Deployment[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/deployments/:deployment_id/containers", {
    containers: Container[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/containers/:container_id/logs", {
    logs: ContainerLog[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/deployments/search", {
    deployment: Deployment;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/deployments/:deployment_id", {
    deployment: Deployment;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/gateways/:gateway_id", {
    gateway: Gateway;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/deployments/:deployment_id/gateways", {
    gateways: Gateway[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/deployments/:deployment_id/storage", Record<"volume" | "build_cache", null | Record<"provisioned_size" | "used_size", number>>, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/domains/:domain_id", {
    domain: Domain;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/pipe/rooms", {
    rooms: Room[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/registry/images", {
    images: string[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/registry/images/:image/manifests", {
    manifests: {
        digest: {
            digest: string;
            size: number;
            uploaded: string;
        };
        tag: null | string;
    }[];
}, undefined>, {
    method: "GET";
    path: Path;
}>)["res"]>
Type Parameters
- Path extends "/v1/users/@me" | "/v1/users/@me/pats" | "/v1/projects/:project_id/members/@me" | "/v1/projects/:project_id/tokens" | "/v1/projects/@this/tokens" | "/v1/projects/:project_id/members" | "/v1/projects/@this/members" | "/v1/projects/:project_id/secrets" | "/v1/projects/@this/secrets" | "/v1/channels" | "/v1/channels/:channel_id" | "/v1/channels/:channel_id/tokens" | "/v1/channels/:channel_id/state" | "/v1/channels/tokens/:token" | "/v1/channels/:channel_id/stats" | "/v1/ignite/deployments" | "/v1/ignite/deployments/:deployment_id/containers" | "/v1/ignite/deployments/:deployment_id" | "/v1/ignite/containers/:container_id/logs" | "/v1/ignite/deployments/search" | "/v1/ignite/gateways/:gateway_id" | "/v1/ignite/deployments/:deployment_id/gateways" | "/v1/ignite/deployments/:deployment_id/storage" | "/v1/ignite/domains/:domain_id" | "/v1/pipe/rooms" | "/v1/registry/images" | "/v1/registry/images/:image/manifests"
Parameters
- path: Path
- query: Query<Path>
- Optional init: RequestInit
Returns Promise<(Extract<Endpoint<"GET", "/v1/users/@me", {
    leap_token: null | string;
    project_member_role_map: Record<`project_${string}`, MemberRole>;
    projects: Project[];
    user: SelfUser;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/users/@me/pats", {
    pats: PAT[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/projects/:project_id/members/@me", {
    project_member: Member;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/projects/:project_id/tokens", {
    project_tokens: ProjectToken[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/projects/@this/tokens", {
    project_tokens: ProjectToken[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/projects/:project_id/members", {
    members: Member[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/projects/@this/members", {
    members: Member[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/projects/:project_id/secrets", {
    secrets: Secret[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/projects/@this/secrets", {
    secrets: Secret[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/channels/:channel_id", {
    channel: Channel;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/channels/:channel_id/tokens", {
    tokens: ChannelToken[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/channels/:channel_id/state", {
    state: State;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/channels", {
    channels: Channel[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/channels/tokens/:token", {
    token: ChannelToken;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/channels/:channel_id/stats", {
    stats: {
        online_count: number;
    };
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/deployments", {
    deployments: Deployment[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/deployments/:deployment_id/containers", {
    containers: Container[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/containers/:container_id/logs", {
    logs: ContainerLog[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/deployments/search", {
    deployment: Deployment;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/deployments/:deployment_id", {
    deployment: Deployment;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/gateways/:gateway_id", {
    gateway: Gateway;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/deployments/:deployment_id/gateways", {
    gateways: Gateway[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/deployments/:deployment_id/storage", Record<"volume" | "build_cache", null | Record<"provisioned_size" | "used_size", number>>, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/ignite/domains/:domain_id", {
    domain: Domain;
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/pipe/rooms", {
    rooms: Room[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/registry/images", {
    images: string[];
}, undefined>, {
    method: "GET";
    path: Path;
}> | Extract<Endpoint<"GET", "/v1/registry/images/:image/manifests", {
    manifests: {
        digest: {
            digest: string;
            size: number;
            uploaded: string;
        };
        tag: null | string;
    }[];
}, undefined>, {
    method: "GET";
    path: Path;
}>)["res"]>
- Defined in src/rest/client.ts:67

patch

patch<Path>(path: Path, body: (Extract<Endpoint<"PATCH", "/v1/channels/:channel_id/state", void, State>, {
    method: "PATCH";
    path: Path;
}> | Extract<Endpoint<"PATCH", "/v1/channels/tokens/:token", {
    token: ChannelToken;
}, {
    expiresAt?: null | Timestamp;
    state: State;
}>, {
    method: "PATCH";
    path: Path;
}> | Extract<Endpoint<"PATCH", "/v1/ignite/deployments/:deployment_id", {
    deployment: Deployment;
}, Partial<DeploymentConfig>>, {
    method: "PATCH";
    path: Path;
}> | Extract<Endpoint<"PATCH", "/v1/ignite/deployments/:deployment_id/metadata", {
    deployment: Deployment;
}, Partial<DeploymentMetaData>>, {
    method: "PATCH";
    path: Path;
}> | Extract<Endpoint<"PATCH", "/v1/ignite/deployments/:deployment_id/health-check", {
    health_check: HealthCheck;
}, Partial<Omit<HealthCheck, "id">>>, {
    method: "PATCH";
    path: Path;
}>)["body"], query: Query<Path>, init?: RequestInit): Promise<(Extract<Endpoint<"PATCH", "/v1/channels/:channel_id/state", void, State>, {
    method: "PATCH";
    path: Path;
}> | Extract<Endpoint<"PATCH", "/v1/channels/tokens/:token", {
    token: ChannelToken;
}, {
    expiresAt?: null | Timestamp;
    state: State;
}>, {
    method: "PATCH";
    path: Path;
}> | Extract<Endpoint<"PATCH", "/v1/ignite/deployments/:deployment_id", {
    deployment: Deployment;
}, Partial<DeploymentConfig>>, {
    method: "PATCH";
    path: Path;
}> | Extract<Endpoint<"PATCH", "/v1/ignite/deployments/:deployment_id/metadata", {
    deployment: Deployment;
}, Partial<DeploymentMetaData>>, {
    method: "PATCH";
    path: Path;
}> | Extract<Endpoint<"PATCH", "/v1/ignite/deployments/:deployment_id/health-check", {
    health_check: HealthCheck;
}, Partial<Omit<HealthCheck, "id">>>, {
    method: "PATCH";
    path: Path;
}>)["res"]>
Type Parameters
- Path extends "/v1/channels/:channel_id/state" | "/v1/channels/tokens/:token" | "/v1/ignite/deployments/:deployment_id" | "/v1/ignite/deployments/:deployment_id/metadata" | "/v1/ignite/deployments/:deployment_id/health-check"
Parameters
- path: Path
- body: (Extract<Endpoint<"PATCH", "/v1/channels/:channel_id/state", void, State>, {
      method: "PATCH";
      path: Path;
  }> | Extract<Endpoint<"PATCH", "/v1/channels/tokens/:token", {
      token: ChannelToken;
  }, {
      expiresAt?: null | Timestamp;
      state: State;
  }>, {
      method: "PATCH";
      path: Path;
  }> | Extract<Endpoint<"PATCH", "/v1/ignite/deployments/:deployment_id", {
      deployment: Deployment;
  }, Partial<DeploymentConfig>>, {
      method: "PATCH";
      path: Path;
  }> | Extract<Endpoint<"PATCH", "/v1/ignite/deployments/:deployment_id/metadata", {
      deployment: Deployment;
  }, Partial<DeploymentMetaData>>, {
      method: "PATCH";
      path: Path;
  }> | Extract<Endpoint<"PATCH", "/v1/ignite/deployments/:deployment_id/health-check", {
      health_check: HealthCheck;
  }, Partial<Omit<HealthCheck, "id">>>, {
      method: "PATCH";
      path: Path;
  }>)["body"]
- query: Query<Path>
- Optional init: RequestInit
Returns Promise<(Extract<Endpoint<"PATCH", "/v1/channels/:channel_id/state", void, State>, {
    method: "PATCH";
    path: Path;
}> | Extract<Endpoint<"PATCH", "/v1/channels/tokens/:token", {
    token: ChannelToken;
}, {
    expiresAt?: null | Timestamp;
    state: State;
}>, {
    method: "PATCH";
    path: Path;
}> | Extract<Endpoint<"PATCH", "/v1/ignite/deployments/:deployment_id", {
    deployment: Deployment;
}, Partial<DeploymentConfig>>, {
    method: "PATCH";
    path: Path;
}> | Extract<Endpoint<"PATCH", "/v1/ignite/deployments/:deployment_id/metadata", {
    deployment: Deployment;
}, Partial<DeploymentMetaData>>, {
    method: "PATCH";
    path: Path;
}> | Extract<Endpoint<"PATCH", "/v1/ignite/deployments/:deployment_id/health-check", {
    health_check: HealthCheck;
}, Partial<Omit<HealthCheck, "id">>>, {
    method: "PATCH";
    path: Path;
}>)["res"]>
- Defined in src/rest/client.ts:107

post

post<Path>(path: Path, body: (Extract<Endpoint<"POST", "/v1/users/@me/pats", {
    pat: PAT;
}, {
    name: string;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/projects/:project_id/tokens", {
    project_token: ProjectToken & {
        project: Project;
    };
}, {
    flags: number;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/projects/@this/tokens", {
    project_token: ProjectToken & {
        project: Project;
    };
}, {
    flags: number;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/channels", {
    channel: Channel;
}, {
    state: null | Record<string, any>;
    type: ChannelType;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/channels/tokens", {
    token: ChannelToken;
}, {
    state: State;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/channels/tokens/:token/messages", void, {
    d: unknown;
    e: string;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/channels/:channel_id/messages", void, {
    d: unknown;
    e: string;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/containers", {
    container: Container;
}, undefined>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/containers/:container_id", never, {
    container_id: `container_${string}`;
    deployment_id: `deployment_${string}`;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments", {
    deployment: Deployment;
}, CreateDeploymentConfig>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/gateways/:gateway_id/domains", void, {
    domain: string;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/gateways", {
    gateway: Gateway;
}, {
    name: string;
    protocol: null | "http";
    target_port: number;
    type: GatewayType;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/rollouts", {
    rollout: DeploymentRollout;
}, undefined>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/health-check", {
    health_check: HealthCheck;
}, Omit<HealthCheck, "id">>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/pipe/rooms", {
    room: Room;
}, {
    delivery_protocols: DeliveryProtocol[];
    ephemeral: boolean;
    ingest_protocol: "rtmp" | "rtp";
    llhls_config?: {
        artificial_delay: number;
        max_playout_bitrate_preset: string;
        wcl_delay: number;
    };
    name: string;
    region: US_EAST_1;
}>, {
    method: "POST";
    path: Path;
}>)["body"], query: Query<Path>, init?: RequestInit): Promise<(Extract<Endpoint<"POST", "/v1/users/@me/pats", {
    pat: PAT;
}, {
    name: string;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/projects/:project_id/tokens", {
    project_token: ProjectToken & {
        project: Project;
    };
}, {
    flags: number;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/projects/@this/tokens", {
    project_token: ProjectToken & {
        project: Project;
    };
}, {
    flags: number;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/channels", {
    channel: Channel;
}, {
    state: null | Record<string, any>;
    type: ChannelType;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/channels/tokens", {
    token: ChannelToken;
}, {
    state: State;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/channels/tokens/:token/messages", void, {
    d: unknown;
    e: string;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/channels/:channel_id/messages", void, {
    d: unknown;
    e: string;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/containers", {
    container: Container;
}, undefined>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/containers/:container_id", never, {
    container_id: `container_${string}`;
    deployment_id: `deployment_${string}`;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments", {
    deployment: Deployment;
}, CreateDeploymentConfig>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/gateways/:gateway_id/domains", void, {
    domain: string;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/gateways", {
    gateway: Gateway;
}, {
    name: string;
    protocol: null | "http";
    target_port: number;
    type: GatewayType;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/rollouts", {
    rollout: DeploymentRollout;
}, undefined>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/health-check", {
    health_check: HealthCheck;
}, Omit<HealthCheck, "id">>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/pipe/rooms", {
    room: Room;
}, {
    delivery_protocols: DeliveryProtocol[];
    ephemeral: boolean;
    ingest_protocol: "rtmp" | "rtp";
    llhls_config?: {
        artificial_delay: number;
        max_playout_bitrate_preset: string;
        wcl_delay: number;
    };
    name: string;
    region: US_EAST_1;
}>, {
    method: "POST";
    path: Path;
}>)["res"]>
Type Parameters
- Path extends "/v1/users/@me/pats" | "/v1/projects/:project_id/tokens" | "/v1/projects/@this/tokens" | "/v1/channels" | "/v1/channels/tokens" | "/v1/channels/tokens/:token/messages" | "/v1/channels/:channel_id/messages" | "/v1/ignite/deployments" | "/v1/ignite/deployments/:deployment_id/containers" | "/v1/ignite/deployments/:deployment_id/containers/:container_id" | "/v1/ignite/gateways/:gateway_id/domains" | "/v1/ignite/deployments/:deployment_id/gateways" | "/v1/ignite/deployments/:deployment_id/rollouts" | "/v1/ignite/deployments/:deployment_id/health-check" | "/v1/pipe/rooms"
Parameters
- path: Path
- body: (Extract<Endpoint<"POST", "/v1/users/@me/pats", {
      pat: PAT;
  }, {
      name: string;
  }>, {
      method: "POST";
      path: Path;
  }> | Extract<Endpoint<"POST", "/v1/projects/:project_id/tokens", {
      project_token: ProjectToken & {
          project: Project;
      };
  }, {
      flags: number;
  }>, {
      method: "POST";
      path: Path;
  }> | Extract<Endpoint<"POST", "/v1/projects/@this/tokens", {
      project_token: ProjectToken & {
          project: Project;
      };
  }, {
      flags: number;
  }>, {
      method: "POST";
      path: Path;
  }> | Extract<Endpoint<"POST", "/v1/channels", {
      channel: Channel;
  }, {
      state: null | Record<string, any>;
      type: ChannelType;
  }>, {
      method: "POST";
      path: Path;
  }> | Extract<Endpoint<"POST", "/v1/channels/tokens", {
      token: ChannelToken;
  }, {
      state: State;
  }>, {
      method: "POST";
      path: Path;
  }> | Extract<Endpoint<"POST", "/v1/channels/tokens/:token/messages", void, {
      d: unknown;
      e: string;
  }>, {
      method: "POST";
      path: Path;
  }> | Extract<Endpoint<"POST", "/v1/channels/:channel_id/messages", void, {
      d: unknown;
      e: string;
  }>, {
      method: "POST";
      path: Path;
  }> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/containers", {
      container: Container;
  }, undefined>, {
      method: "POST";
      path: Path;
  }> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/containers/:container_id", never, {
      container_id: `container_${string}`;
      deployment_id: `deployment_${string}`;
  }>, {
      method: "POST";
      path: Path;
  }> | Extract<Endpoint<"POST", "/v1/ignite/deployments", {
      deployment: Deployment;
  }, CreateDeploymentConfig>, {
      method: "POST";
      path: Path;
  }> | Extract<Endpoint<"POST", "/v1/ignite/gateways/:gateway_id/domains", void, {
      domain: string;
  }>, {
      method: "POST";
      path: Path;
  }> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/gateways", {
      gateway: Gateway;
  }, {
      name: string;
      protocol: null | "http";
      target_port: number;
      type: GatewayType;
  }>, {
      method: "POST";
      path: Path;
  }> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/rollouts", {
      rollout: DeploymentRollout;
  }, undefined>, {
      method: "POST";
      path: Path;
  }> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/health-check", {
      health_check: HealthCheck;
  }, Omit<HealthCheck, "id">>, {
      method: "POST";
      path: Path;
  }> | Extract<Endpoint<"POST", "/v1/pipe/rooms", {
      room: Room;
  }, {
      delivery_protocols: DeliveryProtocol[];
      ephemeral: boolean;
      ingest_protocol: "rtmp" | "rtp";
      llhls_config?: {
          artificial_delay: number;
          max_playout_bitrate_preset: string;
          wcl_delay: number;
      };
      name: string;
      region: US_EAST_1;
  }>, {
      method: "POST";
      path: Path;
  }>)["body"]
- query: Query<Path>
- Optional init: RequestInit
Returns Promise<(Extract<Endpoint<"POST", "/v1/users/@me/pats", {
    pat: PAT;
}, {
    name: string;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/projects/:project_id/tokens", {
    project_token: ProjectToken & {
        project: Project;
    };
}, {
    flags: number;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/projects/@this/tokens", {
    project_token: ProjectToken & {
        project: Project;
    };
}, {
    flags: number;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/channels", {
    channel: Channel;
}, {
    state: null | Record<string, any>;
    type: ChannelType;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/channels/tokens", {
    token: ChannelToken;
}, {
    state: State;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/channels/tokens/:token/messages", void, {
    d: unknown;
    e: string;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/channels/:channel_id/messages", void, {
    d: unknown;
    e: string;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/containers", {
    container: Container;
}, undefined>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/containers/:container_id", never, {
    container_id: `container_${string}`;
    deployment_id: `deployment_${string}`;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments", {
    deployment: Deployment;
}, CreateDeploymentConfig>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/gateways/:gateway_id/domains", void, {
    domain: string;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/gateways", {
    gateway: Gateway;
}, {
    name: string;
    protocol: null | "http";
    target_port: number;
    type: GatewayType;
}>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/rollouts", {
    rollout: DeploymentRollout;
}, undefined>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/ignite/deployments/:deployment_id/health-check", {
    health_check: HealthCheck;
}, Omit<HealthCheck, "id">>, {
    method: "POST";
    path: Path;
}> | Extract<Endpoint<"POST", "/v1/pipe/rooms", {
    room: Room;
}, {
    delivery_protocols: DeliveryProtocol[];
    ephemeral: boolean;
    ingest_protocol: "rtmp" | "rtp";
    llhls_config?: {
        artificial_delay: number;
        max_playout_bitrate_preset: string;
        wcl_delay: number;
    };
    name: string;
    region: US_EAST_1;
}>, {
    method: "POST";
    path: Path;
}>)["res"]>
- Defined in src/rest/client.ts:81

put

put<Path>(path: Path, body: (Extract<Endpoint<"PUT", "/v1/projects/:project_id/secrets/:name", {
    secret: Secret;
}, string>, {
    method: "PUT";
    path: Path;
}> | Extract<Endpoint<"PUT", "/v1/projects/@this/secrets/:name", {
    secret: Secret;
}, string>, {
    method: "PUT";
    path: Path;
}> | Extract<Endpoint<"PUT", "/v1/channels/:channel_id", {
    channel: Channel;
}, {
    state: null | Record<string, any>;
    type: ChannelType;
}>, {
    method: "PUT";
    path: Path;
}> | Extract<Endpoint<"PUT", "/v1/channels/:channel_id/subscribers/:token", void, undefined>, {
    method: "PUT";
    path: Path;
}> | Extract<Endpoint<"PUT", "/v1/channels/:channel_id/state", void, State>, {
    method: "PUT";
    path: Path;
}> | Extract<Endpoint<"PUT", "/v1/ignite/containers/:container_id/state", void, {
    preferred_state: RUNNING | STOPPED;
}>, {
    method: "PUT";
    path: Path;
}>)["body"], query: Query<Path>, init?: RequestInit): Promise<(Extract<Endpoint<"PUT", "/v1/projects/:project_id/secrets/:name", {
    secret: Secret;
}, string>, {
    method: "PUT";
    path: Path;
}> | Extract<Endpoint<"PUT", "/v1/projects/@this/secrets/:name", {
    secret: Secret;
}, string>, {
    method: "PUT";
    path: Path;
}> | Extract<Endpoint<"PUT", "/v1/channels/:channel_id", {
    channel: Channel;
}, {
    state: null | Record<string, any>;
    type: ChannelType;
}>, {
    method: "PUT";
    path: Path;
}> | Extract<Endpoint<"PUT", "/v1/channels/:channel_id/subscribers/:token", void, undefined>, {
    method: "PUT";
    path: Path;
}> | Extract<Endpoint<"PUT", "/v1/channels/:channel_id/state", void, State>, {
    method: "PUT";
    path: Path;
}> | Extract<Endpoint<"PUT", "/v1/ignite/containers/:container_id/state", void, {
    preferred_state: RUNNING | STOPPED;
}>, {
    method: "PUT";
    path: Path;
}>)["res"]>
Type Parameters
- Path extends "/v1/projects/:project_id/secrets/:name" | "/v1/projects/@this/secrets/:name" | "/v1/channels/:channel_id" | "/v1/channels/:channel_id/subscribers/:token" | "/v1/channels/:channel_id/state" | "/v1/ignite/containers/:container_id/state"
Parameters
- path: Path
- body: (Extract<Endpoint<"PUT", "/v1/projects/:project_id/secrets/:name", {
      secret: Secret;
  }, string>, {
      method: "PUT";
      path: Path;
  }> | Extract<Endpoint<"PUT", "/v1/projects/@this/secrets/:name", {
      secret: Secret;
  }, string>, {
      method: "PUT";
      path: Path;
  }> | Extract<Endpoint<"PUT", "/v1/channels/:channel_id", {
      channel: Channel;
  }, {
      state: null | Record<string, any>;
      type: ChannelType;
  }>, {
      method: "PUT";
      path: Path;
  }> | Extract<Endpoint<"PUT", "/v1/channels/:channel_id/subscribers/:token", void, undefined>, {
      method: "PUT";
      path: Path;
  }> | Extract<Endpoint<"PUT", "/v1/channels/:channel_id/state", void, State>, {
      method: "PUT";
      path: Path;
  }> | Extract<Endpoint<"PUT", "/v1/ignite/containers/:container_id/state", void, {
      preferred_state: RUNNING | STOPPED;
  }>, {
      method: "PUT";
      path: Path;
  }>)["body"]
- query: Query<Path>
- Optional init: RequestInit
Returns Promise<(Extract<Endpoint<"PUT", "/v1/projects/:project_id/secrets/:name", {
    secret: Secret;
}, string>, {
    method: "PUT";
    path: Path;
}> | Extract<Endpoint<"PUT", "/v1/projects/@this/secrets/:name", {
    secret: Secret;
}, string>, {
    method: "PUT";
    path: Path;
}> | Extract<Endpoint<"PUT", "/v1/channels/:channel_id", {
    channel: Channel;
}, {
    state: null | Record<string, any>;
    type: ChannelType;
}>, {
    method: "PUT";
    path: Path;
}> | Extract<Endpoint<"PUT", "/v1/channels/:channel_id/subscribers/:token", void, undefined>, {
    method: "PUT";
    path: Path;
}> | Extract<Endpoint<"PUT", "/v1/channels/:channel_id/state", void, State>, {
    method: "PUT";
    path: Path;
}> | Extract<Endpoint<"PUT", "/v1/ignite/containers/:container_id/state", void, {
    preferred_state: RUNNING | STOPPED;
}>, {
    method: "PUT";
    path: Path;
}>)["res"]>
- Defined in src/rest/client.ts:92

raw

raw<T>(request: Request): Promise<T>
Type Parameters
- T
Parameters
- request: Request
Returns Promise<T>
- Defined in src/rest/client.ts:129

`Private` request

request<T>(method: Method, path: string, body: unknown, query?: Record<string, undefined | string | number>, init?: RequestInit): Promise<T>
Type Parameters
- T
Parameters
- method: Method
- path: string
- body: unknown
- query: Record<string, undefined | string | number> = {}
- init: RequestInit = {}
Returns Promise<T>
- Defined in src/rest/client.ts:183

`Static` getAuthType

getAuthType(auth: `ptk_${string}` | `pat_${string}` | `bearer_${string}`): APIAuthenticationPrefix
Parameters
- auth: `ptk_${string}` | `pat_${string}` | `bearer_${string}`
Returns APIAuthenticationPrefix
- Defined in src/rest/client.ts:40

Class APIClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: APIClientOptions

Returns APIClient

Properties

Private agent

Readonly authType

Private Readonly options

Readonly url

Type declaration

Type Parameters

Path extends string

Parameters

path: Path

query: Query<Path>

Returns string

Methods

delete

Type Parameters

Parameters

path: Path

query: Query<Path>

Optional init: RequestInit

Private executeRequest

Type Parameters

T

Parameters

request: Request

Returns Promise<T>

get

Type Parameters

Parameters

path: Path

query: Query<Path>

Optional init: RequestInit

patch

Type Parameters

Path extends "/v1/channels/:channel_id/state" | "/v1/channels/tokens/:token" | "/v1/ignite/deployments/:deployment_id" | "/v1/ignite/deployments/:deployment_id/metadata" | "/v1/ignite/deployments/:deployment_id/health-check"

Parameters

path: Path

query: Query<Path>

Optional init: RequestInit

post

Type Parameters

Parameters

path: Path

query: Query<Path>

Optional init: RequestInit

put

Type Parameters

Path extends "/v1/projects/:project_id/secrets/:name" | "/v1/projects/@this/secrets/:name" | "/v1/channels/:channel_id" | "/v1/channels/:channel_id/subscribers/:token" | "/v1/channels/:channel_id/state" | "/v1/ignite/containers/:container_id/state"

Parameters

path: Path

query: Query<Path>

Optional init: RequestInit

raw

Type Parameters

T

Parameters

request: Request

Returns Promise<T>

Private request

Type Parameters

T

Parameters

method: Method

path: string

body: unknown

query: Record<string, undefined | string | number> = {}

init: RequestInit = {}

Returns Promise<T>

Static getAuthType

Parameters

`Private` agent

`Readonly` authType

`Private` `Readonly` options

`Readonly` url

`Optional` init: RequestInit

`Private` executeRequest

`Optional` init: RequestInit

`Optional` init: RequestInit

`Optional` init: RequestInit

`Optional` init: RequestInit

`Private` request

`Static` getAuthType