Protocol Documentation

Table of Contents

• proto/account.proto

  • Account

  • AccountActivateMessage

  • AccountActivatedMessage

  • AccountBidReserveMessage

  • AccountCreateMessage

  • AccountCreatedMessage

  • AccountDepositMessage

  • AccountDepositedMessage

  • AccountGetData

  • AccountGetDataResponse

  • AccountReserveMessage

  • AccountReservedMessage

  • AccountSuspendMessage

  • AccountSuspendedMessage

  • AccountWithdrawMessage

  • AccountWithdrawnMessage

  • Account.Status

• proto/error.proto

  • EventError
  • EventErrorOccurred

• proto/product.proto

  • CommandCreateProduct
  • CommandDeleteProduct
  • CommandUpdateProduct
  • CreateProduct
  • DeleteProduct
  • EventProductCreated
  • EventProductDeleted
  • EventProductErrorOccurred
  • EventProductFound
  • EventProductUpdated
  • EventProductsFound
  • FindProduct
  • FindProducts
  • Product
  • ProductError
  • QueryFindProduct
  • QueryFindProducts
  • UpdateProduct

• proto/user.proto

  • EventUserData
  • EventUserError
  • EventUserRevoked
  • EventUserUpdated
  • EventUserVerified
  • User
  • UserId
  • UserMessageError

• Scalar Value Types

Top

proto/account.proto

Account

Account represent event message for user account.

Field	Type	Label	Description
id	string
user_id	string
reserved_funds	string
available_funds	string
status	Account.Status
created_at	string

AccountActivateMessage

Field	Type	Label	Description
id	string
user_id	string

AccountActivatedMessage

Field	Type	Label	Description
account	Account

AccountBidReserveMessage

Field	Type	Label	Description
account_id	string
user_id	string
bid_id	string
amount	string

AccountCreateMessage

AccountCreateMessage represent event message for user account creation.

Field	Type	Label	Description
user_id	string

AccountCreatedMessage

Field	Type	Label	Description
account	Account

AccountDepositMessage

Field	Type	Label	Description
id	string
user_id	string
amount	string

AccountDepositedMessage

Field	Type	Label	Description
account	Account

AccountGetData

Field	Type	Label	Description
user_id	string

AccountGetDataResponse

Field	Type	Label	Description
account	Account

AccountReserveMessage

Field	Type	Label	Description
id	string
user_id	string
amount	string

AccountReservedMessage

Field	Type	Label	Description
account	Account

AccountSuspendMessage

Field	Type	Label	Description
id	string
user_id	string

AccountSuspendedMessage

Field	Type	Label	Description
account	Account

AccountWithdrawMessage

Field	Type	Label	Description
id	string
user_id	string
amount	string

AccountWithdrawnMessage

Field	Type	Label	Description
account	Account

Account.Status

Name	Number	Description
UNKNOWN	0
ACTIVE	1
INACTIVE	2

Top

proto/error.proto

EventError

Field	Type	Label	Description
stream_name	string
consumer_name	string
subject	string
reference_event_key	string
message	string
code	int32
data	bytes
headers	string
time	google.protobuf.Timestamp

EventErrorOccurred

Field	Type	Label	Description
key	string
value	EventError

Top

proto/product.proto

CommandCreateProduct

Field	Type	Label	Description
key	string
value	CreateProduct

CommandDeleteProduct

Field	Type	Label	Description
key	string
value	DeleteProduct

CommandUpdateProduct

Field	Type	Label	Description
key	string
value	UpdateProduct

CreateProduct

Field	Type	Label	Description
name	string
media	string	repeated	it is a list of media urls.
description	string
created_by	string		it is user id.

DeleteProduct

Field	Type	Label	Description
id	string
created_by	string		it is user id.

EventProductCreated

Field	Type	Label	Description
key	string
value	Product

EventProductDeleted

Field	Type	Label	Description
key	string
value	Product

EventProductErrorOccurred

Field	Type	Label	Description
key	string
value	ProductError

EventProductFound

Field	Type	Label	Description
key	string
value	Product

EventProductUpdated

Field	Type	Label	Description
key	string
value	Product

EventProductsFound

Field	Type	Label	Description
key	string
value	Product	repeated

FindProduct

Field	Type	Label	Description
id	string

FindProducts

Product

Product message represent a product.

Field	Type	Label	Description
id	string
name	string
media	string	repeated	it is a list of media urls.
description	string
created_by	string		it is user id.
created_at	google.protobuf.Timestamp

ProductError

Field	Type	Label	Description
code	int32
message	string
reference_event_key	string

QueryFindProduct

Field	Type	Label	Description
key	string
value	FindProduct

QueryFindProducts

Field	Type	Label	Description
key	string
value	FindProducts

UpdateProduct

Field	Type	Label	Description
id	string
name	string
media	string	repeated	it is a list of media urls.
description	string
created_by	string		it is user id.

Top

proto/user.proto

EventUserData

EventUserData message represent event after user data request.

Field	Type	Label	Description
data	User

EventUserError

EventUserError message represent event after user message error.

Field	Type	Label	Description
data	UserMessageError

EventUserRevoked

EventUserRevoked message represent event after user revocation.

Field	Type	Label	Description
data	UserId

EventUserUpdated

EventUserUpdated message represent event after user update.

Field	Type	Label	Description
data	User

EventUserVerified

EventUserVerified message represent event after user verification.

Field	Type	Label	Description
data	UserId

User

User messages represent user data.

Field	Type	Label	Description
id	string
name	string
email	string
phone	string
photo	string
createdAt	int64
lastLogin	int64
disabled	bool

UserId

UserID message represent user id data.

Field	Type	Label	Description
id	string

UserMessageError

UserMessageError message represent data of user message error.

Field	Type	Label	Description
msgId	string
user	User
userId	UserId
msgError	string
msgCreatedAt	string

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)