spot-sdk-ts
Version:
TypeScript bindings based on protobufs (proto3) provided by Boston Dynamics
208 lines • 9.71 kB
TypeScript
import { RequestHeader, ResponseHeader } from "./header";
import _m0 from "protobufjs/minimal";
export declare const protobufPackage = "bosdyn.api";
/** The GetAuthToken request message includes login information for the robot. */
export interface GetAuthTokenRequest {
/** Common request header. */
header: RequestHeader | undefined;
/** Username to authenticate with. Must be set if password is set. */
username: string;
/** Password to authenticate with. Not neccessary if token is set. */
password: string;
/** Token to authenticate with. Can be used in place of the password, to re-mint a token. */
token: string;
/**
* Deprecated as of 2.0.1. Application Token for authenticating with robots on older releases.
*
* @deprecated
*/
applicationToken: string;
}
/**
* The GetAuthToken response message includes an authentication token if the login information
* is correct and succeeds.
*/
export interface GetAuthTokenResponse {
header: ResponseHeader | undefined;
/** The status of the grpc GetAuthToken request. */
status: GetAuthTokenResponse_Status;
/** Token data. Only specified if status == STATUS_OK. */
token: string;
}
export declare enum GetAuthTokenResponse_Status {
/** STATUS_UNKNOWN - STATUS_UNKNOWN should never be used. If used, an internal error has happend. */
STATUS_UNKNOWN = 0,
/**
* STATUS_OK - STATUS_OK indicates that authentication has succeeded. The 'token' field field will
* be populated with a session token that can be used to authenticate the user.
*/
STATUS_OK = 1,
/**
* STATUS_INVALID_LOGIN - STATUS_INVALID_LOGIN indicates that authentication has failed since an invalid
* username and/or password were provided.
*/
STATUS_INVALID_LOGIN = 2,
/**
* STATUS_INVALID_TOKEN - STATUS_INVALID_TOKEN indicates that authentication has failed since the 'token'
* provided in the request is invalid. Reasons for the token being invalid could be
* because it has expired, because it is improperly formed, for the wrong robot, the
* user that the token is for has changed a password, or many other reasons. Clients
* should use username/password-based authentication when refreshing the token fails.
*/
STATUS_INVALID_TOKEN = 3,
/**
* STATUS_TEMPORARILY_LOCKED_OUT - STATUS_TEMPORARILY_LOCKED_OUT indicates that authentication has failed since
* authentication for the user is temporarily locked out due to too many unsuccessful
* attempts. Any new authentication attempts should be delayed so they may happen after
* the lock out period ends.
*/
STATUS_TEMPORARILY_LOCKED_OUT = 4,
/**
* STATUS_INVALID_APPLICATION_TOKEN - STATUS_INVALID_APPLICATION_TOKEN indicates that the 'application_token' field in the
* request was invalid.
*/
STATUS_INVALID_APPLICATION_TOKEN = 5,
/**
* STATUS_EXPIRED_APPLICATION_TOKEN - STATUS_EXPIRED_APPLICATION_TOKEN indicates that the 'application_token' field in the
* request was valid, but has expired.
*/
STATUS_EXPIRED_APPLICATION_TOKEN = 6,
UNRECOGNIZED = -1
}
export declare function getAuthTokenResponse_StatusFromJSON(object: any): GetAuthTokenResponse_Status;
export declare function getAuthTokenResponse_StatusToJSON(object: GetAuthTokenResponse_Status): string;
export declare const GetAuthTokenRequest: {
encode(message: GetAuthTokenRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): GetAuthTokenRequest;
fromJSON(object: any): GetAuthTokenRequest;
toJSON(message: GetAuthTokenRequest): unknown;
fromPartial<I extends {
header?: {
requestTimestamp?: Date | undefined;
clientName?: string | undefined;
disableRpcLogging?: boolean | undefined;
} | undefined;
username?: string | undefined;
password?: string | undefined;
token?: string | undefined;
applicationToken?: string | 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;
username?: string | undefined;
password?: string | undefined;
token?: string | undefined;
applicationToken?: string | undefined;
} & { [K_1 in Exclude<keyof I, keyof GetAuthTokenRequest>]: never; }>(object: I): GetAuthTokenRequest;
};
export declare const GetAuthTokenResponse: {
encode(message: GetAuthTokenResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number): GetAuthTokenResponse;
fromJSON(object: any): GetAuthTokenResponse;
toJSON(message: GetAuthTokenResponse): 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;
status?: GetAuthTokenResponse_Status | undefined;
token?: 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;
status?: GetAuthTokenResponse_Status | undefined;
token?: string | undefined;
} & { [K_5 in Exclude<keyof I, keyof GetAuthTokenResponse>]: never; }>(object: I): GetAuthTokenResponse;
};
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=auth.d.ts.map