chirpstack/api/js/api/tenant_pb.d.ts
Orne Brocaar f776dd3898 Split private gateways under tenant in uplink / downlink.
This makes it possible to share uplink data with other tenants, but do
not allow other tenants to use these gateways for downlinks.
2023-02-14 13:41:22 +00:00

581 lines
22 KiB
TypeScript
Vendored

// package: api
// file: api/tenant.proto
import * as jspb from "google-protobuf";
import * as google_api_annotations_pb from "../google/api/annotations_pb";
import * as google_protobuf_timestamp_pb from "google-protobuf/google/protobuf/timestamp_pb";
import * as google_protobuf_empty_pb from "google-protobuf/google/protobuf/empty_pb";
export class Tenant extends jspb.Message {
getId(): string;
setId(value: string): void;
getName(): string;
setName(value: string): void;
getDescription(): string;
setDescription(value: string): void;
getCanHaveGateways(): boolean;
setCanHaveGateways(value: boolean): void;
getMaxGatewayCount(): number;
setMaxGatewayCount(value: number): void;
getMaxDeviceCount(): number;
setMaxDeviceCount(value: number): void;
getPrivateGatewaysUp(): boolean;
setPrivateGatewaysUp(value: boolean): void;
getPrivateGatewaysDown(): boolean;
setPrivateGatewaysDown(value: boolean): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): Tenant.AsObject;
static toObject(includeInstance: boolean, msg: Tenant): Tenant.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: Tenant, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): Tenant;
static deserializeBinaryFromReader(message: Tenant, reader: jspb.BinaryReader): Tenant;
}
export namespace Tenant {
export type AsObject = {
id: string,
name: string,
description: string,
canHaveGateways: boolean,
maxGatewayCount: number,
maxDeviceCount: number,
privateGatewaysUp: boolean,
privateGatewaysDown: boolean,
}
}
export class TenantListItem extends jspb.Message {
getId(): string;
setId(value: string): void;
hasCreatedAt(): boolean;
clearCreatedAt(): void;
getCreatedAt(): google_protobuf_timestamp_pb.Timestamp | undefined;
setCreatedAt(value?: google_protobuf_timestamp_pb.Timestamp): void;
hasUpdatedAt(): boolean;
clearUpdatedAt(): void;
getUpdatedAt(): google_protobuf_timestamp_pb.Timestamp | undefined;
setUpdatedAt(value?: google_protobuf_timestamp_pb.Timestamp): void;
getName(): string;
setName(value: string): void;
getCanHaveGateways(): boolean;
setCanHaveGateways(value: boolean): void;
getPrivateGatewaysUp(): boolean;
setPrivateGatewaysUp(value: boolean): void;
getPrivateGatewaysDown(): boolean;
setPrivateGatewaysDown(value: boolean): void;
getMaxGatewayCount(): number;
setMaxGatewayCount(value: number): void;
getMaxDeviceCount(): number;
setMaxDeviceCount(value: number): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): TenantListItem.AsObject;
static toObject(includeInstance: boolean, msg: TenantListItem): TenantListItem.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: TenantListItem, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): TenantListItem;
static deserializeBinaryFromReader(message: TenantListItem, reader: jspb.BinaryReader): TenantListItem;
}
export namespace TenantListItem {
export type AsObject = {
id: string,
createdAt?: google_protobuf_timestamp_pb.Timestamp.AsObject,
updatedAt?: google_protobuf_timestamp_pb.Timestamp.AsObject,
name: string,
canHaveGateways: boolean,
privateGatewaysUp: boolean,
privateGatewaysDown: boolean,
maxGatewayCount: number,
maxDeviceCount: number,
}
}
export class CreateTenantRequest extends jspb.Message {
hasTenant(): boolean;
clearTenant(): void;
getTenant(): Tenant | undefined;
setTenant(value?: Tenant): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): CreateTenantRequest.AsObject;
static toObject(includeInstance: boolean, msg: CreateTenantRequest): CreateTenantRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: CreateTenantRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): CreateTenantRequest;
static deserializeBinaryFromReader(message: CreateTenantRequest, reader: jspb.BinaryReader): CreateTenantRequest;
}
export namespace CreateTenantRequest {
export type AsObject = {
tenant?: Tenant.AsObject,
}
}
export class CreateTenantResponse extends jspb.Message {
getId(): string;
setId(value: string): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): CreateTenantResponse.AsObject;
static toObject(includeInstance: boolean, msg: CreateTenantResponse): CreateTenantResponse.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: CreateTenantResponse, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): CreateTenantResponse;
static deserializeBinaryFromReader(message: CreateTenantResponse, reader: jspb.BinaryReader): CreateTenantResponse;
}
export namespace CreateTenantResponse {
export type AsObject = {
id: string,
}
}
export class GetTenantRequest extends jspb.Message {
getId(): string;
setId(value: string): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): GetTenantRequest.AsObject;
static toObject(includeInstance: boolean, msg: GetTenantRequest): GetTenantRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: GetTenantRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): GetTenantRequest;
static deserializeBinaryFromReader(message: GetTenantRequest, reader: jspb.BinaryReader): GetTenantRequest;
}
export namespace GetTenantRequest {
export type AsObject = {
id: string,
}
}
export class GetTenantResponse extends jspb.Message {
hasTenant(): boolean;
clearTenant(): void;
getTenant(): Tenant | undefined;
setTenant(value?: Tenant): void;
hasCreatedAt(): boolean;
clearCreatedAt(): void;
getCreatedAt(): google_protobuf_timestamp_pb.Timestamp | undefined;
setCreatedAt(value?: google_protobuf_timestamp_pb.Timestamp): void;
hasUpdatedAt(): boolean;
clearUpdatedAt(): void;
getUpdatedAt(): google_protobuf_timestamp_pb.Timestamp | undefined;
setUpdatedAt(value?: google_protobuf_timestamp_pb.Timestamp): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): GetTenantResponse.AsObject;
static toObject(includeInstance: boolean, msg: GetTenantResponse): GetTenantResponse.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: GetTenantResponse, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): GetTenantResponse;
static deserializeBinaryFromReader(message: GetTenantResponse, reader: jspb.BinaryReader): GetTenantResponse;
}
export namespace GetTenantResponse {
export type AsObject = {
tenant?: Tenant.AsObject,
createdAt?: google_protobuf_timestamp_pb.Timestamp.AsObject,
updatedAt?: google_protobuf_timestamp_pb.Timestamp.AsObject,
}
}
export class UpdateTenantRequest extends jspb.Message {
hasTenant(): boolean;
clearTenant(): void;
getTenant(): Tenant | undefined;
setTenant(value?: Tenant): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): UpdateTenantRequest.AsObject;
static toObject(includeInstance: boolean, msg: UpdateTenantRequest): UpdateTenantRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: UpdateTenantRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): UpdateTenantRequest;
static deserializeBinaryFromReader(message: UpdateTenantRequest, reader: jspb.BinaryReader): UpdateTenantRequest;
}
export namespace UpdateTenantRequest {
export type AsObject = {
tenant?: Tenant.AsObject,
}
}
export class DeleteTenantRequest extends jspb.Message {
getId(): string;
setId(value: string): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): DeleteTenantRequest.AsObject;
static toObject(includeInstance: boolean, msg: DeleteTenantRequest): DeleteTenantRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: DeleteTenantRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): DeleteTenantRequest;
static deserializeBinaryFromReader(message: DeleteTenantRequest, reader: jspb.BinaryReader): DeleteTenantRequest;
}
export namespace DeleteTenantRequest {
export type AsObject = {
id: string,
}
}
export class ListTenantsRequest extends jspb.Message {
getLimit(): number;
setLimit(value: number): void;
getOffset(): number;
setOffset(value: number): void;
getSearch(): string;
setSearch(value: string): void;
getUserId(): string;
setUserId(value: string): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): ListTenantsRequest.AsObject;
static toObject(includeInstance: boolean, msg: ListTenantsRequest): ListTenantsRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: ListTenantsRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): ListTenantsRequest;
static deserializeBinaryFromReader(message: ListTenantsRequest, reader: jspb.BinaryReader): ListTenantsRequest;
}
export namespace ListTenantsRequest {
export type AsObject = {
limit: number,
offset: number,
search: string,
userId: string,
}
}
export class ListTenantsResponse extends jspb.Message {
getTotalCount(): number;
setTotalCount(value: number): void;
clearResultList(): void;
getResultList(): Array<TenantListItem>;
setResultList(value: Array<TenantListItem>): void;
addResult(value?: TenantListItem, index?: number): TenantListItem;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): ListTenantsResponse.AsObject;
static toObject(includeInstance: boolean, msg: ListTenantsResponse): ListTenantsResponse.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: ListTenantsResponse, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): ListTenantsResponse;
static deserializeBinaryFromReader(message: ListTenantsResponse, reader: jspb.BinaryReader): ListTenantsResponse;
}
export namespace ListTenantsResponse {
export type AsObject = {
totalCount: number,
resultList: Array<TenantListItem.AsObject>,
}
}
export class TenantUser extends jspb.Message {
getTenantId(): string;
setTenantId(value: string): void;
getUserId(): string;
setUserId(value: string): void;
getIsAdmin(): boolean;
setIsAdmin(value: boolean): void;
getIsDeviceAdmin(): boolean;
setIsDeviceAdmin(value: boolean): void;
getIsGatewayAdmin(): boolean;
setIsGatewayAdmin(value: boolean): void;
getEmail(): string;
setEmail(value: string): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): TenantUser.AsObject;
static toObject(includeInstance: boolean, msg: TenantUser): TenantUser.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: TenantUser, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): TenantUser;
static deserializeBinaryFromReader(message: TenantUser, reader: jspb.BinaryReader): TenantUser;
}
export namespace TenantUser {
export type AsObject = {
tenantId: string,
userId: string,
isAdmin: boolean,
isDeviceAdmin: boolean,
isGatewayAdmin: boolean,
email: string,
}
}
export class TenantUserListItem extends jspb.Message {
getTenantId(): string;
setTenantId(value: string): void;
getUserId(): string;
setUserId(value: string): void;
hasCreatedAt(): boolean;
clearCreatedAt(): void;
getCreatedAt(): google_protobuf_timestamp_pb.Timestamp | undefined;
setCreatedAt(value?: google_protobuf_timestamp_pb.Timestamp): void;
hasUpdatedAt(): boolean;
clearUpdatedAt(): void;
getUpdatedAt(): google_protobuf_timestamp_pb.Timestamp | undefined;
setUpdatedAt(value?: google_protobuf_timestamp_pb.Timestamp): void;
getEmail(): string;
setEmail(value: string): void;
getIsAdmin(): boolean;
setIsAdmin(value: boolean): void;
getIsDeviceAdmin(): boolean;
setIsDeviceAdmin(value: boolean): void;
getIsGatewayAdmin(): boolean;
setIsGatewayAdmin(value: boolean): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): TenantUserListItem.AsObject;
static toObject(includeInstance: boolean, msg: TenantUserListItem): TenantUserListItem.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: TenantUserListItem, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): TenantUserListItem;
static deserializeBinaryFromReader(message: TenantUserListItem, reader: jspb.BinaryReader): TenantUserListItem;
}
export namespace TenantUserListItem {
export type AsObject = {
tenantId: string,
userId: string,
createdAt?: google_protobuf_timestamp_pb.Timestamp.AsObject,
updatedAt?: google_protobuf_timestamp_pb.Timestamp.AsObject,
email: string,
isAdmin: boolean,
isDeviceAdmin: boolean,
isGatewayAdmin: boolean,
}
}
export class AddTenantUserRequest extends jspb.Message {
hasTenantUser(): boolean;
clearTenantUser(): void;
getTenantUser(): TenantUser | undefined;
setTenantUser(value?: TenantUser): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): AddTenantUserRequest.AsObject;
static toObject(includeInstance: boolean, msg: AddTenantUserRequest): AddTenantUserRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: AddTenantUserRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): AddTenantUserRequest;
static deserializeBinaryFromReader(message: AddTenantUserRequest, reader: jspb.BinaryReader): AddTenantUserRequest;
}
export namespace AddTenantUserRequest {
export type AsObject = {
tenantUser?: TenantUser.AsObject,
}
}
export class GetTenantUserRequest extends jspb.Message {
getTenantId(): string;
setTenantId(value: string): void;
getUserId(): string;
setUserId(value: string): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): GetTenantUserRequest.AsObject;
static toObject(includeInstance: boolean, msg: GetTenantUserRequest): GetTenantUserRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: GetTenantUserRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): GetTenantUserRequest;
static deserializeBinaryFromReader(message: GetTenantUserRequest, reader: jspb.BinaryReader): GetTenantUserRequest;
}
export namespace GetTenantUserRequest {
export type AsObject = {
tenantId: string,
userId: string,
}
}
export class GetTenantUserResponse extends jspb.Message {
hasTenantUser(): boolean;
clearTenantUser(): void;
getTenantUser(): TenantUser | undefined;
setTenantUser(value?: TenantUser): void;
hasCreatedAt(): boolean;
clearCreatedAt(): void;
getCreatedAt(): google_protobuf_timestamp_pb.Timestamp | undefined;
setCreatedAt(value?: google_protobuf_timestamp_pb.Timestamp): void;
hasUpdatedAt(): boolean;
clearUpdatedAt(): void;
getUpdatedAt(): google_protobuf_timestamp_pb.Timestamp | undefined;
setUpdatedAt(value?: google_protobuf_timestamp_pb.Timestamp): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): GetTenantUserResponse.AsObject;
static toObject(includeInstance: boolean, msg: GetTenantUserResponse): GetTenantUserResponse.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: GetTenantUserResponse, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): GetTenantUserResponse;
static deserializeBinaryFromReader(message: GetTenantUserResponse, reader: jspb.BinaryReader): GetTenantUserResponse;
}
export namespace GetTenantUserResponse {
export type AsObject = {
tenantUser?: TenantUser.AsObject,
createdAt?: google_protobuf_timestamp_pb.Timestamp.AsObject,
updatedAt?: google_protobuf_timestamp_pb.Timestamp.AsObject,
}
}
export class UpdateTenantUserRequest extends jspb.Message {
hasTenantUser(): boolean;
clearTenantUser(): void;
getTenantUser(): TenantUser | undefined;
setTenantUser(value?: TenantUser): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): UpdateTenantUserRequest.AsObject;
static toObject(includeInstance: boolean, msg: UpdateTenantUserRequest): UpdateTenantUserRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: UpdateTenantUserRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): UpdateTenantUserRequest;
static deserializeBinaryFromReader(message: UpdateTenantUserRequest, reader: jspb.BinaryReader): UpdateTenantUserRequest;
}
export namespace UpdateTenantUserRequest {
export type AsObject = {
tenantUser?: TenantUser.AsObject,
}
}
export class DeleteTenantUserRequest extends jspb.Message {
getTenantId(): string;
setTenantId(value: string): void;
getUserId(): string;
setUserId(value: string): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): DeleteTenantUserRequest.AsObject;
static toObject(includeInstance: boolean, msg: DeleteTenantUserRequest): DeleteTenantUserRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: DeleteTenantUserRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): DeleteTenantUserRequest;
static deserializeBinaryFromReader(message: DeleteTenantUserRequest, reader: jspb.BinaryReader): DeleteTenantUserRequest;
}
export namespace DeleteTenantUserRequest {
export type AsObject = {
tenantId: string,
userId: string,
}
}
export class ListTenantUsersRequest extends jspb.Message {
getTenantId(): string;
setTenantId(value: string): void;
getLimit(): number;
setLimit(value: number): void;
getOffset(): number;
setOffset(value: number): void;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): ListTenantUsersRequest.AsObject;
static toObject(includeInstance: boolean, msg: ListTenantUsersRequest): ListTenantUsersRequest.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: ListTenantUsersRequest, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): ListTenantUsersRequest;
static deserializeBinaryFromReader(message: ListTenantUsersRequest, reader: jspb.BinaryReader): ListTenantUsersRequest;
}
export namespace ListTenantUsersRequest {
export type AsObject = {
tenantId: string,
limit: number,
offset: number,
}
}
export class ListTenantUsersResponse extends jspb.Message {
getTotalCount(): number;
setTotalCount(value: number): void;
clearResultList(): void;
getResultList(): Array<TenantUserListItem>;
setResultList(value: Array<TenantUserListItem>): void;
addResult(value?: TenantUserListItem, index?: number): TenantUserListItem;
serializeBinary(): Uint8Array;
toObject(includeInstance?: boolean): ListTenantUsersResponse.AsObject;
static toObject(includeInstance: boolean, msg: ListTenantUsersResponse): ListTenantUsersResponse.AsObject;
static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
static serializeBinaryToWriter(message: ListTenantUsersResponse, writer: jspb.BinaryWriter): void;
static deserializeBinary(bytes: Uint8Array): ListTenantUsersResponse;
static deserializeBinaryFromReader(message: ListTenantUsersResponse, reader: jspb.BinaryReader): ListTenantUsersResponse;
}
export namespace ListTenantUsersResponse {
export type AsObject = {
totalCount: number,
resultList: Array<TenantUserListItem.AsObject>,
}
}