api

package
v1.3.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 20, 2025 License: Unlicense Imports: 5 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_api_login_proto protoreflect.FileDescriptor
View Source
var File_api_register_proto protoreflect.FileDescriptor
View Source
var File_api_response_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type APIResponse

type APIResponse struct {
	Message       string   `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty" bson:"message"`                   // @gotags: bson:"message"
	Err           string   `protobuf:"bytes,2,opt,name=err,proto3" json:"err,omitempty" bson:"err"`                               // @gotags: bson:"err"
	RequiredScope string   `protobuf:"bytes,3,opt,name=requiredScope,proto3" json:"requiredScope,omitempty" bson:"requiredScope"` // @gotags: bson:"requiredScope"
	NoExistCards  []string `protobuf:"bytes,4,rep,name=noExistCards,proto3" json:"noExistCards,omitempty" bson:"noExistCards"`    // @gotags: bson:"noExistCards"
	InvalidCards  []string `protobuf:"bytes,5,rep,name=invalidCards,proto3" json:"invalidCards,omitempty" bson:"invalidCards"`    // @gotags: bson:"invalidCards"
	DeckCode      string   `protobuf:"bytes,6,opt,name=deckCode,proto3" json:"deckCode,omitempty" bson:"deckCode"`                // @gotags: bson:"deckCode"
	SetCode       string   `protobuf:"bytes,7,opt,name=setCode,proto3" json:"setCode,omitempty" bson:"setCode"`                   // @gotags: bson:"setCode"
	CardId        string   `protobuf:"bytes,8,opt,name=cardId,proto3" json:"cardId,omitempty" bson:"cardId"`                      // @gotags: bson:"cardId"
	// contains filtered or unexported fields
}

APIResponse - Represents a generic API response that can get returned from the API. Some fields are not used and will be nulled out on response

func (*APIResponse) Descriptor deprecated

func (*APIResponse) Descriptor() ([]byte, []int)

Deprecated: Use APIResponse.ProtoReflect.Descriptor instead.

func (*APIResponse) GetCardId added in v1.3.2

func (x *APIResponse) GetCardId() string

func (*APIResponse) GetDeckCode

func (x *APIResponse) GetDeckCode() string

func (*APIResponse) GetErr

func (x *APIResponse) GetErr() string

func (*APIResponse) GetInvalidCards

func (x *APIResponse) GetInvalidCards() []string

func (*APIResponse) GetMessage

func (x *APIResponse) GetMessage() string

func (*APIResponse) GetNoExistCards

func (x *APIResponse) GetNoExistCards() []string

func (*APIResponse) GetRequiredScope

func (x *APIResponse) GetRequiredScope() string

func (*APIResponse) GetSetCode

func (x *APIResponse) GetSetCode() string

func (*APIResponse) ProtoMessage

func (*APIResponse) ProtoMessage()

func (*APIResponse) ProtoReflect

func (x *APIResponse) ProtoReflect() protoreflect.Message

func (*APIResponse) Reset

func (x *APIResponse) Reset()

func (*APIResponse) String

func (x *APIResponse) String() string

type LoginRequest

type LoginRequest struct {
	Email    string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty" bson:"email"`          // @gotags: bson:"email"
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty" bson:"password"` // @gotags: bson:"password"
	// contains filtered or unexported fields
}

LoginRequest - Represents a login request to be sent to the /login endpoint

func (*LoginRequest) Descriptor deprecated

func (*LoginRequest) Descriptor() ([]byte, []int)

Deprecated: Use LoginRequest.ProtoReflect.Descriptor instead.

func (*LoginRequest) GetEmail

func (x *LoginRequest) GetEmail() string

func (*LoginRequest) GetPassword

func (x *LoginRequest) GetPassword() string

func (*LoginRequest) ProtoMessage

func (*LoginRequest) ProtoMessage()

func (*LoginRequest) ProtoReflect

func (x *LoginRequest) ProtoReflect() protoreflect.Message

func (*LoginRequest) Reset

func (x *LoginRequest) Reset()

func (*LoginRequest) String

func (x *LoginRequest) String() string

type RegisterRequest

type RegisterRequest struct {
	Email    string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty" bson:"email"`          // @gotags: bson:"email"
	Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty" bson:"username"` // @gotags: bson:"username"
	Password string `protobuf:"bytes,3,opt,name=password,proto3" json:"password,omitempty" bson:"password"` // @gotags: bson:"password"
	// contains filtered or unexported fields
}

RegisterRequest - Represents a POST request to be sent to the /register endpoint

func (*RegisterRequest) Descriptor deprecated

func (*RegisterRequest) Descriptor() ([]byte, []int)

Deprecated: Use RegisterRequest.ProtoReflect.Descriptor instead.

func (*RegisterRequest) GetEmail

func (x *RegisterRequest) GetEmail() string

func (*RegisterRequest) GetPassword

func (x *RegisterRequest) GetPassword() string

func (*RegisterRequest) GetUsername

func (x *RegisterRequest) GetUsername() string

func (*RegisterRequest) ProtoMessage

func (*RegisterRequest) ProtoMessage()

func (*RegisterRequest) ProtoReflect

func (x *RegisterRequest) ProtoReflect() protoreflect.Message

func (*RegisterRequest) Reset

func (x *RegisterRequest) Reset()

func (*RegisterRequest) String

func (x *RegisterRequest) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL