Protocol Documentation¶

Table of Contents¶

mini_vending/accounts/v1/accounts.proto
mini_vending/accounts/v1/roles.proto
mini_vending/accounts/v1/auth.proto
mini_vending/accounts/v1/merchant.proto
Scalar Value Types

mini_vending/accounts/v1/accounts.proto¶

Account¶

Field	Type	Label	Description
accountId	int64
role	string
email	string
status	string
lastLoginAt	google.protobuf.Timestamp
registeredAt	google.protobuf.Timestamp
createdAt	google.protobuf.Timestamp
updatedAt	google.protobuf.Timestamp

GetAccountRequest¶

Field	Type	Label	Description
accountId	int64

GetAccountResponse¶

Field	Type	Label	Description
account	Account

GetAccountsRequest¶

Field	Type	Label
limit	int64
offset	int64
email	string	optional
status	string	optional
orderByReg	string	optional

GetAccountsResponse¶

Field	Type	Label	Description
accounts	Account	repeated
count	int64

AccountsService¶

Method Name	Request Type	Response Type	Description
Get	GetAccountRequest	GetAccountResponse
GetList	GetAccountsRequest	GetAccountsResponse

Top

mini_vending/accounts/v1/roles.proto¶

GetRolesRequest¶

GetRolesResponse¶

Field	Type	Label	Description
role	string
scheme	GetRolesResponse.SchemeEntry	repeated

GetRolesResponse.SchemeEntry¶

Field	Type	Label	Description
key	string
value	Methods

Methods¶

Field	Type	Label	Description
methods	string	repeated

RolesService¶

Method Name	Request Type	Response Type	Description
Get	GetRolesRequest	GetRolesResponse

Top

mini_vending/accounts/v1/auth.proto¶

CheckTokenRequest¶

CheckTokenResponse¶

Field	Type	Label	Description
accountId	int64
merchantId	int64
email	string
role	string

LoginRequest¶

Field	Type	Label	Description
email	string
password	string

LoginResponse¶

Field	Type	Label	Description
accessToken	string
refreshToken	string

MerchantRegisterRequest¶

Field	Type	Label	Description
email	string
password	string
name	string
phone	string

MerchantRegisterResponse¶

Field	Type	Label	Description
accountId	int64
merchantId	int64
accessToken	string
refreshToken	string

RefreshRequest¶

Field	Type	Label	Description
accessToken	string
refreshToken	string

RefreshResponse¶

Field	Type	Label	Description
accessToken	string
refreshToken	string

AuthService¶

Method Name	Request Type	Response Type
Login	LoginRequest	LoginResponse
Refresh	RefreshRequest	RefreshResponse
MerchantRegister	MerchantRegisterRequest	MerchantRegisterResponse
CheckToken	CheckTokenRequest	CheckTokenResponse

Top

mini_vending/accounts/v1/merchant.proto¶

CreateMerchantRequest¶

CreateMerchantRequest contains the information needed to create a new merchant

Field	Type	Description
email	string	Merchant's email address (must be unique and valid)
phone	string	Merchant's phone number
name	string	Merchant's display name
password	string	Merchant's password

CreateMerchantResponse¶

CreateMerchantResponse contains the newly created merchant

Field	Type	Label	Description
accountId	int64		The newly created account ID
merchantId	int64		The newly created merchant ID

GetMerchantRequest¶

GetMerchantRequest contains the merchant ID to retrieve

Field	Type	Label	Description
merchantId	int64		The merchant ID to retrieve

GetMerchantResponse¶

GetMerchantResponse contains the merchant data

Field	Type	Label	Description
merchant	Merchant		The merchant data

GetMerchantsRequest¶

GetMerchantsRequest contains pagination parameters for listing merchants

Field	Type	Label	Description
limit	int64		Limit number of results
offset	int64		Offset for pagination
status	string	optional	Optional status filter
email	string	optional	Optional email search filter
name	string	optional	Optional name search filter
orderByReg	string	optional	Optional order by date filter

GetMerchantsResponse¶

GetMerchantsResponse contains the list of merchants

Field	Type	Label	Description
merchants	Merchant	repeated	List of merchants
count	int64		Total count of merchants matching the filters

Merchant¶

Merchant represents a merchant entity in the system

Field	Type	Description
merchantId	int64	Unique identifier for the merchant
accountId	int64	Account ID for the merchant
role	string	Role ID for the merchant
phone	string	Merchant's phone number
email	string	Merchant's email address (must be unique)
name	string	Merchant's display name
status	string	Merchant's status
lastLoginAt	google.protobuf.Timestamp	Timestamp of last login
registeredAt	google.protobuf.Timestamp	Timestamp when the merchant was registered
createdAt	google.protobuf.Timestamp	Timestamp when the merchant was created
updatedAt	google.protobuf.Timestamp	Timestamp when the merchant was last updated

UpdateMerchantRequest¶

UpdateMerchantRequest contains the information to update a merchant

Field	Type	Label	Description
merchantId	int64		The merchant ID to update
phone	string	optional	Optional phone number update
email	string	optional	Optional email update
name	string	optional	Optional name update

UpdateMerchantResponse¶

UpdateMerchantResponse contains the result of the update operation

Field	Type	Label	Description
success	bool		Success indicator

MerchantsService¶

MerchantService provides merchant management operations

Method Name	Request Type	Response Type	Description
Create	CreateMerchantRequest	CreateMerchantResponse	CreateMerchant creates a new merchant
GetList	GetMerchantsRequest	GetMerchantsResponse	GetMerchants retrieves a paginated list of merchants
Get	GetMerchantRequest	GetMerchantResponse	GetMerchant retrieves a single merchant by ID
Update	UpdateMerchantRequest	UpdateMerchantResponse	UpdateMerchant updates merchant information

Scalar Value Types¶

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)