UNPKG

@snap/camera-kit

Version:
644 lines 33.6 kB
import _m0 from "protobufjs/minimal"; export declare const protobufPackage = "com.snap.camerakit.v3"; /** GetRemoteApiSpecsRequest */ export interface GetRemoteApiSpecsRequest { } /** GetRemoteApiSpecsResponse */ export interface GetRemoteApiSpecsResponse { /** Remote API specifications that are defined for a CameraKit partners */ remoteApiSpecs: RemoteApiSpec[]; } /** * Defines a remote service with a list of endpoints and a single security configuration. * Original full specification data can be found in lenses/remote_api/remote_api_spec.proto. */ export interface RemoteApiSpec { /** ID of the API spec */ id: string; /** Hostname or hostname and port in format of host:port */ host: string; /** List of HTTP endpoints allowed by this API spec */ endpoints: RemoteEndpoint[]; /** Defines if secured connection (HTTPS) must be forced */ tlsRequired: boolean; /** Specifies caller's max request size in bytes for any of defined endpoints (optional value) */ maxRequestSizeBytes: number; /** Specifies caller's max response size in bytes for any of defined endpoints (optional value) */ maxResponseSizeBytes: number; /** Specifies caller's max response time in millis for any of defined endpoints (optional value) */ maxResponseTimeMillis: number; } /** Defines a remote API HTTP endpoint */ export interface RemoteEndpoint { /** URL path of the endpoint; could be fixed or parameterized */ path: string; /** HTTP methods allowed for requests to this endpoint */ methods: RemoteEndpoint_HttpRequestMethod[]; /** Parameters allowed for requests to this endpoint; required if path is parameterized */ parameters: RemoteParameter[]; /** ID used by clients to refer to this endpoint */ refId: string; } /** Possible HTTP request method on an endpoint */ export declare enum RemoteEndpoint_HttpRequestMethod { /** METHOD_UNSET - Undefined method */ METHOD_UNSET = 0, /** GET - HTTP GET */ GET = 1, /** POST - HTTP POST */ POST = 2, /** PUT - HTTP PUT */ PUT = 3, /** DELETE - HTTP DELETE */ DELETE = 4, /** PATCH - HTTP PATCH */ PATCH = 5, UNRECOGNIZED = -1 } /** Defines how a parameter is injected into an HTTP request */ export interface RemoteParameter { /** Unique name of the parameter */ name: string; /** Location of the parameter */ location: RemoteParameter_ParameterLocation; /** Is parameter optional */ optional: boolean; /** * (optional) Name of the parameter that will be used to construct the request (in query/headers/path). * `name` is used by clients to fill in the parameters in the request, whereas * `external_name` is what is used in the outgoing API request by the proxy. * If empty, `external_name` is assumed to be the same as `name`. */ externalName: string; /** * Default value if the parameter is not set. Useful for "standard" headers like content-type * and other similar cases. If a default value is provided, the parameter will be sent with every request. * Required for constant parameters. */ defaultValue: string; /** * Constant parameters have the same predefined value for all requests and * are always set by the proxy. Not allowed to be overridden by the caller. */ constant: boolean; } /** Possible location of a parameter */ export declare enum RemoteParameter_ParameterLocation { /** LOCATION_UNSET - Undefined location */ LOCATION_UNSET = 0, /** QUERY - Parameters that appear in the URL query */ QUERY = 1, /** HEADER - Parameters that appear in the HTTP request header */ HEADER = 2, /** PATH - Parameters that appear in the URL path (for parameterized path only) */ PATH = 3, UNRECOGNIZED = -1 } export declare const GetRemoteApiSpecsRequest: { encode(_: GetRemoteApiSpecsRequest, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): GetRemoteApiSpecsRequest; fromPartial<I extends {} & {} & Record<Exclude<keyof I, never>, never>>(_: I): GetRemoteApiSpecsRequest; }; export declare const GetRemoteApiSpecsResponse: { encode(message: GetRemoteApiSpecsResponse, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): GetRemoteApiSpecsResponse; fromPartial<I extends { remoteApiSpecs?: { id?: string | undefined; host?: string | undefined; endpoints?: { path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; }[] | undefined; tlsRequired?: boolean | undefined; maxRequestSizeBytes?: number | undefined; maxResponseSizeBytes?: number | undefined; maxResponseTimeMillis?: number | undefined; }[] | undefined; } & { remoteApiSpecs?: ({ id?: string | undefined; host?: string | undefined; endpoints?: { path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; }[] | undefined; tlsRequired?: boolean | undefined; maxRequestSizeBytes?: number | undefined; maxResponseSizeBytes?: number | undefined; maxResponseTimeMillis?: number | undefined; }[] & ({ id?: string | undefined; host?: string | undefined; endpoints?: { path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; }[] | undefined; tlsRequired?: boolean | undefined; maxRequestSizeBytes?: number | undefined; maxResponseSizeBytes?: number | undefined; maxResponseTimeMillis?: number | undefined; } & { id?: string | undefined; host?: string | undefined; endpoints?: ({ path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; }[] & ({ path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; } & { path?: string | undefined; methods?: (RemoteEndpoint_HttpRequestMethod[] & RemoteEndpoint_HttpRequestMethod[] & Record<Exclude<keyof I["remoteApiSpecs"][number]["endpoints"][number]["methods"], keyof RemoteEndpoint_HttpRequestMethod[]>, never>) | undefined; parameters?: ({ name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] & ({ name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; } & { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; } & Record<Exclude<keyof I["remoteApiSpecs"][number]["endpoints"][number]["parameters"][number], keyof RemoteParameter>, never>)[] & Record<Exclude<keyof I["remoteApiSpecs"][number]["endpoints"][number]["parameters"], keyof { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[]>, never>) | undefined; refId?: string | undefined; } & Record<Exclude<keyof I["remoteApiSpecs"][number]["endpoints"][number], keyof RemoteEndpoint>, never>)[] & Record<Exclude<keyof I["remoteApiSpecs"][number]["endpoints"], keyof { path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; }[]>, never>) | undefined; tlsRequired?: boolean | undefined; maxRequestSizeBytes?: number | undefined; maxResponseSizeBytes?: number | undefined; maxResponseTimeMillis?: number | undefined; } & Record<Exclude<keyof I["remoteApiSpecs"][number], keyof RemoteApiSpec>, never>)[] & Record<Exclude<keyof I["remoteApiSpecs"], keyof { id?: string | undefined; host?: string | undefined; endpoints?: { path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; }[] | undefined; tlsRequired?: boolean | undefined; maxRequestSizeBytes?: number | undefined; maxResponseSizeBytes?: number | undefined; maxResponseTimeMillis?: number | undefined; }[]>, never>) | undefined; } & Record<Exclude<keyof I, "remoteApiSpecs">, never>>(object: I): GetRemoteApiSpecsResponse; }; export declare const RemoteApiSpec: { encode(message: RemoteApiSpec, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): RemoteApiSpec; fromPartial<I extends { id?: string | undefined; host?: string | undefined; endpoints?: { path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; }[] | undefined; tlsRequired?: boolean | undefined; maxRequestSizeBytes?: number | undefined; maxResponseSizeBytes?: number | undefined; maxResponseTimeMillis?: number | undefined; } & { id?: string | undefined; host?: string | undefined; endpoints?: ({ path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; }[] & ({ path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; } & { path?: string | undefined; methods?: (RemoteEndpoint_HttpRequestMethod[] & RemoteEndpoint_HttpRequestMethod[] & Record<Exclude<keyof I["endpoints"][number]["methods"], keyof RemoteEndpoint_HttpRequestMethod[]>, never>) | undefined; parameters?: ({ name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] & ({ name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; } & { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; } & Record<Exclude<keyof I["endpoints"][number]["parameters"][number], keyof RemoteParameter>, never>)[] & Record<Exclude<keyof I["endpoints"][number]["parameters"], keyof { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[]>, never>) | undefined; refId?: string | undefined; } & Record<Exclude<keyof I["endpoints"][number], keyof RemoteEndpoint>, never>)[] & Record<Exclude<keyof I["endpoints"], keyof { path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; }[]>, never>) | undefined; tlsRequired?: boolean | undefined; maxRequestSizeBytes?: number | undefined; maxResponseSizeBytes?: number | undefined; maxResponseTimeMillis?: number | undefined; } & Record<Exclude<keyof I, keyof RemoteApiSpec>, never>>(object: I): RemoteApiSpec; }; export declare const RemoteEndpoint: { encode(message: RemoteEndpoint, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): RemoteEndpoint; fromPartial<I extends { path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; } & { path?: string | undefined; methods?: (RemoteEndpoint_HttpRequestMethod[] & RemoteEndpoint_HttpRequestMethod[] & Record<Exclude<keyof I["methods"], keyof RemoteEndpoint_HttpRequestMethod[]>, never>) | undefined; parameters?: ({ name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] & ({ name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; } & { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; } & Record<Exclude<keyof I["parameters"][number], keyof RemoteParameter>, never>)[] & Record<Exclude<keyof I["parameters"], keyof { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[]>, never>) | undefined; refId?: string | undefined; } & Record<Exclude<keyof I, keyof RemoteEndpoint>, never>>(object: I): RemoteEndpoint; }; export declare const RemoteParameter: { encode(message: RemoteParameter, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): RemoteParameter; fromPartial<I extends { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; } & { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; } & Record<Exclude<keyof I, keyof RemoteParameter>, never>>(object: I): RemoteParameter; }; /** The service handle Remote API specifications for CameraKit */ export declare const RemoteApiSpecsDefinition: { readonly name: "RemoteApiSpecs"; readonly fullName: "com.snap.camerakit.v3.RemoteApiSpecs"; readonly methods: { /** * GetRemoteApiSpecs provides lens Remote API specifications for CameraKit partners based on Snap Kit App ID. * https://docs.google.com/document/d/1UBFybr3eI7nEWiUzm_rAumKefaGW6ecpYp5zOCRIYRA/edit */ readonly getRemoteApiSpecs: { readonly name: "GetRemoteApiSpecs"; readonly requestType: { encode(_: GetRemoteApiSpecsRequest, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): GetRemoteApiSpecsRequest; fromPartial<I extends {} & {} & Record<Exclude<keyof I, never>, never>>(_: I): GetRemoteApiSpecsRequest; }; readonly requestStream: false; readonly responseType: { encode(message: GetRemoteApiSpecsResponse, writer?: _m0.Writer): _m0.Writer; decode(input: _m0.Reader | Uint8Array, length?: number): GetRemoteApiSpecsResponse; fromPartial<I_1 extends { remoteApiSpecs?: { id?: string | undefined; host?: string | undefined; endpoints?: { path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; }[] | undefined; tlsRequired?: boolean | undefined; maxRequestSizeBytes?: number | undefined; maxResponseSizeBytes?: number | undefined; maxResponseTimeMillis?: number | undefined; }[] | undefined; } & { remoteApiSpecs?: ({ id?: string | undefined; host?: string | undefined; endpoints?: { path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; }[] | undefined; tlsRequired?: boolean | undefined; maxRequestSizeBytes?: number | undefined; maxResponseSizeBytes?: number | undefined; maxResponseTimeMillis?: number | undefined; }[] & ({ id?: string | undefined; host?: string | undefined; endpoints?: { path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; }[] | undefined; tlsRequired?: boolean | undefined; maxRequestSizeBytes?: number | undefined; maxResponseSizeBytes?: number | undefined; maxResponseTimeMillis?: number | undefined; } & { id?: string | undefined; host?: string | undefined; endpoints?: ({ path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; }[] & ({ path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; } & { path?: string | undefined; methods?: (RemoteEndpoint_HttpRequestMethod[] & RemoteEndpoint_HttpRequestMethod[] & Record<Exclude<keyof I["remoteApiSpecs"][number]["endpoints"][number]["methods"], keyof RemoteEndpoint_HttpRequestMethod[]>, never>) | undefined; parameters?: ({ name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] & ({ name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; } & { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; } & Record<Exclude<keyof I["remoteApiSpecs"][number]["endpoints"][number]["parameters"][number], keyof RemoteParameter>, never>)[] & Record<Exclude<keyof I["remoteApiSpecs"][number]["endpoints"][number]["parameters"], keyof { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[]>, never>) | undefined; refId?: string | undefined; } & Record<Exclude<keyof I["remoteApiSpecs"][number]["endpoints"][number], keyof RemoteEndpoint>, never>)[] & Record<Exclude<keyof I["remoteApiSpecs"][number]["endpoints"], keyof { path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; }[]>, never>) | undefined; tlsRequired?: boolean | undefined; maxRequestSizeBytes?: number | undefined; maxResponseSizeBytes?: number | undefined; maxResponseTimeMillis?: number | undefined; } & Record<Exclude<keyof I["remoteApiSpecs"][number], keyof RemoteApiSpec>, never>)[] & Record<Exclude<keyof I["remoteApiSpecs"], keyof { id?: string | undefined; host?: string | undefined; endpoints?: { path?: string | undefined; methods?: RemoteEndpoint_HttpRequestMethod[] | undefined; parameters?: { name?: string | undefined; location?: RemoteParameter_ParameterLocation | undefined; optional?: boolean | undefined; externalName?: string | undefined; defaultValue?: string | undefined; constant?: boolean | undefined; }[] | undefined; refId?: string | undefined; }[] | undefined; tlsRequired?: boolean | undefined; maxRequestSizeBytes?: number | undefined; maxResponseSizeBytes?: number | undefined; maxResponseTimeMillis?: number | undefined; }[]>, never>) | undefined; } & Record<Exclude<keyof I_1, "remoteApiSpecs">, never>>(object: I_1): GetRemoteApiSpecsResponse; }; readonly responseStream: false; readonly options: { readonly idempotencyLevel: "NO_SIDE_EFFECTS"; }; }; }; }; type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined; export 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 { $case: string; } ? { [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]>; } & { $case: T["$case"]; } : T extends {} ? { [K in keyof T]?: DeepPartial<T[K]>; } : Partial<T>; type KeysOfUnion<T> = T extends T ? keyof T : never; export type Exact<P, I extends P> = P extends Builtin ? P : P & { [K in keyof P]: Exact<P[K], I[K]>; } & Record<Exclude<keyof I, KeysOfUnion<P>>, never>; export {}; //# sourceMappingURL=remote_api_spec.d.ts.map