spot-sdk-ts
Version:
TypeScript bindings based on protobufs (proto3) provided by Boston Dynamics
638 lines • 28.6 kB
TypeScript
import { RequestHeader, ResponseHeader } from "../header";
import _m0 from "protobufjs/minimal";
export declare const protobufPackage = "bosdyn.api.spot_cam";
/** Network configuration data. */
export interface NetworkTuple {
/** a big-endian representation of an IPv4 address */
address: number | undefined;
/** The mask used for defining the system's subnet */
netmask: number | undefined;
/** A global routing is set up for the address defined below (if present) */
gateway: number | undefined;
/**
* If MTU is present, and <16 bits wide, then it is set for the ethernet interface's MTU
* if not, the MTU is set to 1500
*/
mtu: number | undefined;
}
/** Retrieve current network configuration. */
export interface GetNetworkSettingsRequest {
/** Common request header. */
header: RequestHeader | undefined;
}
/** Provides the current network configuration. */
export interface GetNetworkSettingsResponse {
/** Common response header. */
header: ResponseHeader | undefined;
/** Current network configuration. */
settings: NetworkTuple | undefined;
}
/** Request the SSL certificate currently in use. */
export interface GetSSLCertRequest {
/** Common request header. */
header: RequestHeader | undefined;
}
/** Provides the SSL certificate currently in use. */
export interface GetSSLCertResponse {
/** Common response header. */
header: ResponseHeader | undefined;
/** An ASCII-armored representation of the SSL certificate */
certificate: string;
}
/** Servers used in the ICE resolution process. */
export interface ICEServer {
/** STUN or TURN server. */
type: ICEServer_servertype;
/** Network address of the server. */
address: string;
/** Only the least significant 16 bits are used. */
port: number;
}
/** Possible types of servers */
export declare enum ICEServer_servertype {
UNKNOWN = 0,
STUN = 1,
TURN = 2,
UNRECOGNIZED = -1
}
export declare function iCEServer_servertypeFromJSON(object: any): ICEServer_servertype;
export declare function iCEServer_servertypeToJSON(object: ICEServer_servertype): string;
/** Request the servers used for ICE resolution. */
export interface GetICEConfigurationRequest {
/** Common request header. */
header: RequestHeader | undefined;
}
/** Provides the ICE resolution servers. */
export interface GetICEConfigurationResponse {
/** Common response header. */
header: ResponseHeader | undefined;
/** List of servers used for ICE resolution. */
servers: ICEServer[];
}
/**
* Modify the ICE configuration.
* Note: this configuration replaces any configuration currently present.
* It is *not* appended.
*/
export interface SetICEConfigurationRequest {
/** Common request header. */
header: RequestHeader | undefined;
/** List of servers used for ICE resolution. */
servers: ICEServer[];
}
/** Result of modifying the ICE configuration. */
export interface SetICEConfigurationResponse {
/** Common response header. */
header: ResponseHeader | undefined;
}
export declare const NetworkTuple: {
encode(message: NetworkTuple, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): NetworkTuple;
fromJSON(object: any): NetworkTuple;
toJSON(message: NetworkTuple): unknown;
fromPartial<I extends {
address?: number | undefined;
netmask?: number | undefined;
gateway?: number | undefined;
mtu?: number | undefined;
} & {
address?: number | undefined;
netmask?: number | undefined;
gateway?: number | undefined;
mtu?: number | undefined;
} & { [K in Exclude<keyof I, keyof NetworkTuple>]: never; }>(object: I): NetworkTuple;
};
export declare const GetNetworkSettingsRequest: {
encode(message: GetNetworkSettingsRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): GetNetworkSettingsRequest;
fromJSON(object: any): GetNetworkSettingsRequest;
toJSON(message: GetNetworkSettingsRequest): unknown;
fromPartial<I extends {
header?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
} & {
header?: ({
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & { [K in Exclude<keyof I["header"], keyof RequestHeader>]: never; }) | undefined;
} & { [K_1 in Exclude<keyof I, "header">]: never; }>(object: I): GetNetworkSettingsRequest;
};
export declare const GetNetworkSettingsResponse: {
encode(message: GetNetworkSettingsResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): GetNetworkSettingsResponse;
fromJSON(object: any): GetNetworkSettingsResponse;
toJSON(message: GetNetworkSettingsResponse): unknown;
fromPartial<I extends {
header?: {
requestHeader?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
requestReceivedTimestamp?: Date | undefined;
responseTimestamp?: Date | undefined;
error?: {
code?: import("../header").CommonError_Code | undefined;
message?: string | undefined;
data?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} | undefined;
request?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} | undefined;
settings?: {
address?: number | undefined;
netmask?: number | undefined;
gateway?: number | undefined;
mtu?: number | undefined;
} | undefined;
} & {
header?: ({
requestHeader?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
requestReceivedTimestamp?: Date | undefined;
responseTimestamp?: Date | undefined;
error?: {
code?: import("../header").CommonError_Code | undefined;
message?: string | undefined;
data?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} | undefined;
request?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} & {
requestHeader?: ({
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & { [K in Exclude<keyof I["header"]["requestHeader"], keyof RequestHeader>]: never; }) | undefined;
requestReceivedTimestamp?: Date | undefined;
responseTimestamp?: Date | undefined;
error?: ({
code?: import("../header").CommonError_Code | undefined;
message?: string | undefined;
data?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} & {
code?: import("../header").CommonError_Code | undefined;
message?: string | undefined;
data?: ({
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & { [K_1 in Exclude<keyof I["header"]["error"]["data"], keyof import("../../../google/protobuf/any").Any>]: never; }) | undefined;
} & { [K_2 in Exclude<keyof I["header"]["error"], keyof import("../header").CommonError>]: never; }) | undefined;
request?: ({
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & { [K_3 in Exclude<keyof I["header"]["request"], keyof import("../../../google/protobuf/any").Any>]: never; }) | undefined;
} & { [K_4 in Exclude<keyof I["header"], keyof ResponseHeader>]: never; }) | undefined;
settings?: ({
address?: number | undefined;
netmask?: number | undefined;
gateway?: number | undefined;
mtu?: number | undefined;
} & {
address?: number | undefined;
netmask?: number | undefined;
gateway?: number | undefined;
mtu?: number | undefined;
} & { [K_5 in Exclude<keyof I["settings"], keyof NetworkTuple>]: never; }) | undefined;
} & { [K_6 in Exclude<keyof I, keyof GetNetworkSettingsResponse>]: never; }>(object: I): GetNetworkSettingsResponse;
};
export declare const GetSSLCertRequest: {
encode(message: GetSSLCertRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): GetSSLCertRequest;
fromJSON(object: any): GetSSLCertRequest;
toJSON(message: GetSSLCertRequest): unknown;
fromPartial<I extends {
header?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
} & {
header?: ({
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & { [K in Exclude<keyof I["header"], keyof RequestHeader>]: never; }) | undefined;
} & { [K_1 in Exclude<keyof I, "header">]: never; }>(object: I): GetSSLCertRequest;
};
export declare const GetSSLCertResponse: {
encode(message: GetSSLCertResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): GetSSLCertResponse;
fromJSON(object: any): GetSSLCertResponse;
toJSON(message: GetSSLCertResponse): unknown;
fromPartial<I extends {
header?: {
requestHeader?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
requestReceivedTimestamp?: Date | undefined;
responseTimestamp?: Date | undefined;
error?: {
code?: import("../header").CommonError_Code | undefined;
message?: string | undefined;
data?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} | undefined;
request?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} | undefined;
certificate?: string | undefined;
} & {
header?: ({
requestHeader?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
requestReceivedTimestamp?: Date | undefined;
responseTimestamp?: Date | undefined;
error?: {
code?: import("../header").CommonError_Code | undefined;
message?: string | undefined;
data?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} | undefined;
request?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} & {
requestHeader?: ({
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & { [K in Exclude<keyof I["header"]["requestHeader"], keyof RequestHeader>]: never; }) | undefined;
requestReceivedTimestamp?: Date | undefined;
responseTimestamp?: Date | undefined;
error?: ({
code?: import("../header").CommonError_Code | undefined;
message?: string | undefined;
data?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} & {
code?: import("../header").CommonError_Code | undefined;
message?: string | undefined;
data?: ({
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & { [K_1 in Exclude<keyof I["header"]["error"]["data"], keyof import("../../../google/protobuf/any").Any>]: never; }) | undefined;
} & { [K_2 in Exclude<keyof I["header"]["error"], keyof import("../header").CommonError>]: never; }) | undefined;
request?: ({
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & { [K_3 in Exclude<keyof I["header"]["request"], keyof import("../../../google/protobuf/any").Any>]: never; }) | undefined;
} & { [K_4 in Exclude<keyof I["header"], keyof ResponseHeader>]: never; }) | undefined;
certificate?: string | undefined;
} & { [K_5 in Exclude<keyof I, keyof GetSSLCertResponse>]: never; }>(object: I): GetSSLCertResponse;
};
export declare const ICEServer: {
encode(message: ICEServer, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): ICEServer;
fromJSON(object: any): ICEServer;
toJSON(message: ICEServer): unknown;
fromPartial<I extends {
type?: ICEServer_servertype | undefined;
address?: string | undefined;
port?: number | undefined;
} & {
type?: ICEServer_servertype | undefined;
address?: string | undefined;
port?: number | undefined;
} & { [K in Exclude<keyof I, keyof ICEServer>]: never; }>(object: I): ICEServer;
};
export declare const GetICEConfigurationRequest: {
encode(message: GetICEConfigurationRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): GetICEConfigurationRequest;
fromJSON(object: any): GetICEConfigurationRequest;
toJSON(message: GetICEConfigurationRequest): unknown;
fromPartial<I extends {
header?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
} & {
header?: ({
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & { [K in Exclude<keyof I["header"], keyof RequestHeader>]: never; }) | undefined;
} & { [K_1 in Exclude<keyof I, "header">]: never; }>(object: I): GetICEConfigurationRequest;
};
export declare const GetICEConfigurationResponse: {
encode(message: GetICEConfigurationResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): GetICEConfigurationResponse;
fromJSON(object: any): GetICEConfigurationResponse;
toJSON(message: GetICEConfigurationResponse): unknown;
fromPartial<I extends {
header?: {
requestHeader?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
requestReceivedTimestamp?: Date | undefined;
responseTimestamp?: Date | undefined;
error?: {
code?: import("../header").CommonError_Code | undefined;
message?: string | undefined;
data?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} | undefined;
request?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} | undefined;
servers?: {
type?: ICEServer_servertype | undefined;
address?: string | undefined;
port?: number | undefined;
}[] | undefined;
} & {
header?: ({
requestHeader?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
requestReceivedTimestamp?: Date | undefined;
responseTimestamp?: Date | undefined;
error?: {
code?: import("../header").CommonError_Code | undefined;
message?: string | undefined;
data?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} | undefined;
request?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} & {
requestHeader?: ({
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & { [K in Exclude<keyof I["header"]["requestHeader"], keyof RequestHeader>]: never; }) | undefined;
requestReceivedTimestamp?: Date | undefined;
responseTimestamp?: Date | undefined;
error?: ({
code?: import("../header").CommonError_Code | undefined;
message?: string | undefined;
data?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} & {
code?: import("../header").CommonError_Code | undefined;
message?: string | undefined;
data?: ({
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & { [K_1 in Exclude<keyof I["header"]["error"]["data"], keyof import("../../../google/protobuf/any").Any>]: never; }) | undefined;
} & { [K_2 in Exclude<keyof I["header"]["error"], keyof import("../header").CommonError>]: never; }) | undefined;
request?: ({
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & { [K_3 in Exclude<keyof I["header"]["request"], keyof import("../../../google/protobuf/any").Any>]: never; }) | undefined;
} & { [K_4 in Exclude<keyof I["header"], keyof ResponseHeader>]: never; }) | undefined;
servers?: ({
type?: ICEServer_servertype | undefined;
address?: string | undefined;
port?: number | undefined;
}[] & ({
type?: ICEServer_servertype | undefined;
address?: string | undefined;
port?: number | undefined;
} & {
type?: ICEServer_servertype | undefined;
address?: string | undefined;
port?: number | undefined;
} & { [K_5 in Exclude<keyof I["servers"][number], keyof ICEServer>]: never; })[] & { [K_6 in Exclude<keyof I["servers"], keyof {
type?: ICEServer_servertype | undefined;
address?: string | undefined;
port?: number | undefined;
}[]>]: never; }) | undefined;
} & { [K_7 in Exclude<keyof I, keyof GetICEConfigurationResponse>]: never; }>(object: I): GetICEConfigurationResponse;
};
export declare const SetICEConfigurationRequest: {
encode(message: SetICEConfigurationRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): SetICEConfigurationRequest;
fromJSON(object: any): SetICEConfigurationRequest;
toJSON(message: SetICEConfigurationRequest): unknown;
fromPartial<I extends {
header?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
servers?: {
type?: ICEServer_servertype | undefined;
address?: string | undefined;
port?: number | undefined;
}[] | undefined;
} & {
header?: ({
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & { [K in Exclude<keyof I["header"], keyof RequestHeader>]: never; }) | undefined;
servers?: ({
type?: ICEServer_servertype | undefined;
address?: string | undefined;
port?: number | undefined;
}[] & ({
type?: ICEServer_servertype | undefined;
address?: string | undefined;
port?: number | undefined;
} & {
type?: ICEServer_servertype | undefined;
address?: string | undefined;
port?: number | undefined;
} & { [K_1 in Exclude<keyof I["servers"][number], keyof ICEServer>]: never; })[] & { [K_2 in Exclude<keyof I["servers"], keyof {
type?: ICEServer_servertype | undefined;
address?: string | undefined;
port?: number | undefined;
}[]>]: never; }) | undefined;
} & { [K_3 in Exclude<keyof I, keyof SetICEConfigurationRequest>]: never; }>(object: I): SetICEConfigurationRequest;
};
export declare const SetICEConfigurationResponse: {
encode(message: SetICEConfigurationResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): SetICEConfigurationResponse;
fromJSON(object: any): SetICEConfigurationResponse;
toJSON(message: SetICEConfigurationResponse): unknown;
fromPartial<I extends {
header?: {
requestHeader?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
requestReceivedTimestamp?: Date | undefined;
responseTimestamp?: Date | undefined;
error?: {
code?: import("../header").CommonError_Code | undefined;
message?: string | undefined;
data?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} | undefined;
request?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} | undefined;
} & {
header?: ({
requestHeader?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
requestReceivedTimestamp?: Date | undefined;
responseTimestamp?: Date | undefined;
error?: {
code?: import("../header").CommonError_Code | undefined;
message?: string | undefined;
data?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} | undefined;
request?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} & {
requestHeader?: ({
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} & { [K in Exclude<keyof I["header"]["requestHeader"], keyof RequestHeader>]: never; }) | undefined;
requestReceivedTimestamp?: Date | undefined;
responseTimestamp?: Date | undefined;
error?: ({
code?: import("../header").CommonError_Code | undefined;
message?: string | undefined;
data?: {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} | undefined;
} & {
code?: import("../header").CommonError_Code | undefined;
message?: string | undefined;
data?: ({
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & { [K_1 in Exclude<keyof I["header"]["error"]["data"], keyof import("../../../google/protobuf/any").Any>]: never; }) | undefined;
} & { [K_2 in Exclude<keyof I["header"]["error"], keyof import("../header").CommonError>]: never; }) | undefined;
request?: ({
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & {
typeUrl?: string | undefined;
value?: Uint8Array | undefined;
} & { [K_3 in Exclude<keyof I["header"]["request"], keyof import("../../../google/protobuf/any").Any>]: never; }) | undefined;
} & { [K_4 in Exclude<keyof I["header"], keyof ResponseHeader>]: never; }) | undefined;
} & { [K_5 in Exclude<keyof I, "header">]: never; }>(object: I): SetICEConfigurationResponse;
};
declare type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
export declare type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
[K in keyof T]?: DeepPartial<T[K]>;
} : Partial<T>;
declare type KeysOfUnion<T> = T extends T ? keyof T : never;
export declare type Exact<P, I extends P> = P extends Builtin ? P : P & {
[K in keyof P]: Exact<P[K], I[K]>;
} & {
[K in Exclude<keyof I, KeysOfUnion<P>>]: never;
};
export {};
//# sourceMappingURL=network.d.ts.map