seasonpassclientmodels

package
v0.20.0 Latest Latest
Warning

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

 Go to latest Published: Jun 7, 2022 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// ExcessStrategyMethodNONE captures enum value "NONE"
	ExcessStrategyMethodNONE string = "NONE"

	// ExcessStrategyMethodCURRENCY captures enum value "CURRENCY"
	ExcessStrategyMethodCURRENCY string = "CURRENCY"
)
View Source 
const (

	// ListSeasonInfoStatusDRAFT captures enum value "DRAFT"
	ListSeasonInfoStatusDRAFT string = "DRAFT"

	// ListSeasonInfoStatusPUBLISHED captures enum value "PUBLISHED"
	ListSeasonInfoStatusPUBLISHED string = "PUBLISHED"

	// ListSeasonInfoStatusRETIRED captures enum value "RETIRED"
	ListSeasonInfoStatusRETIRED string = "RETIRED"
)
View Source 
const (

	// LocalizedSeasonInfoStatusDRAFT captures enum value "DRAFT"
	LocalizedSeasonInfoStatusDRAFT string = "DRAFT"

	// LocalizedSeasonInfoStatusPUBLISHED captures enum value "PUBLISHED"
	LocalizedSeasonInfoStatusPUBLISHED string = "PUBLISHED"

	// LocalizedSeasonInfoStatusRETIRED captures enum value "RETIRED"
	LocalizedSeasonInfoStatusRETIRED string = "RETIRED"
)
View Source 
const (

	// RewardCreateTypeITEM captures enum value "ITEM"
	RewardCreateTypeITEM string = "ITEM"

	// RewardCreateTypeCURRENCY captures enum value "CURRENCY"
	RewardCreateTypeCURRENCY string = "CURRENCY"
)
View Source 
const (

	// RewardInfoItemTypeAPP captures enum value "APP"
	RewardInfoItemTypeAPP string = "APP"

	// RewardInfoItemTypeCOINS captures enum value "COINS"
	RewardInfoItemTypeCOINS string = "COINS"

	// RewardInfoItemTypeINGAMEITEM captures enum value "INGAMEITEM"
	RewardInfoItemTypeINGAMEITEM string = "INGAMEITEM"

	// RewardInfoItemTypeBUNDLE captures enum value "BUNDLE"
	RewardInfoItemTypeBUNDLE string = "BUNDLE"

	// RewardInfoItemTypeCODE captures enum value "CODE"
	RewardInfoItemTypeCODE string = "CODE"

	// RewardInfoItemTypeSUBSCRIPTION captures enum value "SUBSCRIPTION"
	RewardInfoItemTypeSUBSCRIPTION string = "SUBSCRIPTION"

	// RewardInfoItemTypeSEASON captures enum value "SEASON"
	RewardInfoItemTypeSEASON string = "SEASON"
)
View Source 
const (

	// RewardInfoTypeITEM captures enum value "ITEM"
	RewardInfoTypeITEM string = "ITEM"

	// RewardInfoTypeCURRENCY captures enum value "CURRENCY"
	RewardInfoTypeCURRENCY string = "CURRENCY"
)
View Source 
const (

	// RewardUpdateTypeITEM captures enum value "ITEM"
	RewardUpdateTypeITEM string = "ITEM"

	// RewardUpdateTypeCURRENCY captures enum value "CURRENCY"
	RewardUpdateTypeCURRENCY string = "CURRENCY"
)
View Source 
const (

	// SeasonInfoStatusDRAFT captures enum value "DRAFT"
	SeasonInfoStatusDRAFT string = "DRAFT"

	// SeasonInfoStatusPUBLISHED captures enum value "PUBLISHED"
	SeasonInfoStatusPUBLISHED string = "PUBLISHED"

	// SeasonInfoStatusRETIRED captures enum value "RETIRED"
	SeasonInfoStatusRETIRED string = "RETIRED"
)
View Source 
const (

	// SeasonSummaryStatusDRAFT captures enum value "DRAFT"
	SeasonSummaryStatusDRAFT string = "DRAFT"

	// SeasonSummaryStatusPUBLISHED captures enum value "PUBLISHED"
	SeasonSummaryStatusPUBLISHED string = "PUBLISHED"

	// SeasonSummaryStatusRETIRED captures enum value "RETIRED"
	SeasonSummaryStatusRETIRED string = "RETIRED"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ClaimableRewards 

type ClaimableRewards struct {

	// Claiming rewards, zero based tier index as key, rewards per pass as value
	// Required: true
	ClaimingRewards map[string]map[string][]string `json:"claimingRewards"`

	// To claim rewards, zero based tier index as key, rewards per pass as value
	// Required: true
	ToClaimRewards map[string]map[string][]string `json:"toClaimRewards"`
}

ClaimableRewards A DTO object for claimable rewards.

swagger:model ClaimableRewards

func (*ClaimableRewards) MarshalBinary 

func (m *ClaimableRewards) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ClaimableRewards) UnmarshalBinary 

func (m *ClaimableRewards) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ClaimableRewards) Validate 

func (m *ClaimableRewards) Validate(formats strfmt.Registry) error

Validate validates this claimable rewards

type ClaimableUserSeasonInfo 

type ClaimableUserSeasonInfo struct {

	// Claiming rewards, zero based tier index as key, rewards per pass as value
	// Required: true
	ClaimingRewards map[string]map[string][]string `json:"claimingRewards"`

	// whether cleared all tiers
	// Required: true
	Cleared *bool `json:"cleared"`

	// created at
	// Required: true
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"createdAt"`

	// gained exp for current tier
	// Required: true
	CurrentExp *int32 `json:"currentExp"`

	// current tier index, zero based
	// Required: true
	CurrentTierIndex *int32 `json:"currentTierIndex"`

	// enroll date time
	// Required: true
	// Format: date-time
	EnrolledAt strfmt.DateTime `json:"enrolledAt"`

	// enrolled passes
	// Required: true
	// Unique: true
	EnrolledPasses []string `json:"enrolledPasses"`

	// id
	// Required: true
	ID *string `json:"id"`

	// last tier index, zero based
	// Required: true
	LastTierIndex *int32 `json:"lastTierIndex"`

	// namespace
	// Required: true
	Namespace *string `json:"namespace"`

	// required exp for current tier
	// Required: true
	RequiredExp *int32 `json:"requiredExp"`

	// season summary
	Season *SeasonSummary `json:"season,omitempty"`

	// season id
	// Required: true
	SeasonID *string `json:"seasonId"`

	// To claim rewards, zero based tier index as key, rewards per pass as value
	// Required: true
	ToClaimRewards map[string]map[string][]string `json:"toClaimRewards"`

	// updated at
	// Required: true
	// Format: date-time
	UpdatedAt strfmt.DateTime `json:"updatedAt"`

	// user id
	// Required: true
	UserID *string `json:"userId"`
}

ClaimableUserSeasonInfo A DTO object for claimable user season data.

swagger:model ClaimableUserSeasonInfo

func (*ClaimableUserSeasonInfo) MarshalBinary 

func (m *ClaimableUserSeasonInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ClaimableUserSeasonInfo) UnmarshalBinary 

func (m *ClaimableUserSeasonInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ClaimableUserSeasonInfo) Validate 

func (m *ClaimableUserSeasonInfo) Validate(formats strfmt.Registry) error

Validate validates this claimable user season info

type ErrorEntity 

type ErrorEntity struct {

	// internal server error stack trace in configured environment
	DevStackTrace string `json:"devStackTrace,omitempty"`

	// numeric error code
	// Required: true
	ErrorCode *int32 `json:"errorCode"`

	// error message
	// Required: true
	ErrorMessage *string `json:"errorMessage"`

	// message variables
	MessageVariables map[string]string `json:"messageVariables,omitempty"`
}

ErrorEntity error entity

swagger:model ErrorEntity

func (*ErrorEntity) MarshalBinary 

func (m *ErrorEntity) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorEntity) UnmarshalBinary 

func (m *ErrorEntity) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorEntity) Validate 

func (m *ErrorEntity) Validate(formats strfmt.Registry) error

Validate validates this error entity

type ExcessStrategy 

type ExcessStrategy struct {

	// virtual currency for grant, required while method is CURRENCY
	Currency string `json:"currency,omitempty"`

	// method while excess the final tier exp
	// Required: true
	// Enum: [NONE CURRENCY]
	Method *string `json:"method"`

	// percent per exp, required while method is CURRENCY
	PercentPerExp int32 `json:"percentPerExp,omitempty"`
}

ExcessStrategy excess strategy

swagger:model ExcessStrategy

func (*ExcessStrategy) MarshalBinary 

func (m *ExcessStrategy) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ExcessStrategy) UnmarshalBinary 

func (m *ExcessStrategy) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ExcessStrategy) Validate 

func (m *ExcessStrategy) Validate(formats strfmt.Registry) error

Validate validates this excess strategy

type FieldValidationError 

type FieldValidationError struct {

	// error code
	ErrorCode string `json:"errorCode,omitempty"`

	// error field
	ErrorField string `json:"errorField,omitempty"`

	// error message
	ErrorMessage string `json:"errorMessage,omitempty"`

	// error value
	ErrorValue string `json:"errorValue,omitempty"`

	// message variables
	MessageVariables map[string]string `json:"messageVariables,omitempty"`
}

FieldValidationError field validation error

swagger:model FieldValidationError

func (*FieldValidationError) MarshalBinary 

func (m *FieldValidationError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FieldValidationError) UnmarshalBinary 

func (m *FieldValidationError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FieldValidationError) Validate 

func (m *FieldValidationError) Validate(formats strfmt.Registry) error

Validate validates this field validation error

type Image 

type Image struct {

	// image for
	As string `json:"as,omitempty"`

	// image caption
	Caption string `json:"caption,omitempty"`

	// height
	// Required: true
	Height *int32 `json:"height"`

	// imageUrl
	// Required: true
	ImageURL *string `json:"imageUrl"`

	// smallImageUrl
	SmallImageURL string `json:"smallImageUrl,omitempty"`

	// width
	// Required: true
	Width *int32 `json:"width"`
}

Image image

swagger:model Image

func (*Image) MarshalBinary 

func (m *Image) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Image) UnmarshalBinary 

func (m *Image) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Image) Validate 

func (m *Image) Validate(formats strfmt.Registry) error

Validate validates this image

type ListSeasonInfo 

type ListSeasonInfo struct {

	// created at
	// Required: true
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"createdAt"`

	// default language, BCP 47 language tag
	// Required: true
	DefaultLanguage *string `json:"defaultLanguage"`

	// end date time
	// Required: true
	// Format: date-time
	End strfmt.DateTime `json:"end"`

	// id
	// Required: true
	ID *string `json:"id"`

	// name, max length is 127
	// Required: true
	Name *string `json:"name"`

	// namespace
	// Required: true
	Namespace *string `json:"namespace"`

	// pass codes
	// Unique: true
	PassCodes []string `json:"passCodes"`

	// publishedAt
	// Format: date-time
	PublishedAt *strfmt.DateTime `json:"publishedAt,omitempty"`

	// start date time
	// Required: true
	// Format: date-time
	Start strfmt.DateTime `json:"start"`

	// status
	// Required: true
	// Enum: [DRAFT PUBLISHED RETIRED]
	Status *string `json:"status"`

	// updated at
	// Required: true
	// Format: date-time
	UpdatedAt strfmt.DateTime `json:"updatedAt"`
}

ListSeasonInfo A DTO object for listing season info.

swagger:model ListSeasonInfo

func (*ListSeasonInfo) MarshalBinary 

func (m *ListSeasonInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ListSeasonInfo) UnmarshalBinary 

func (m *ListSeasonInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ListSeasonInfo) Validate 

func (m *ListSeasonInfo) Validate(formats strfmt.Registry) error

Validate validates this list season info

type ListSeasonInfoPagingSlicedResult 

type ListSeasonInfoPagingSlicedResult struct {

	// data
	// Required: true
	Data []*ListSeasonInfo `json:"data"`

	// paging
	Paging *Paging `json:"paging,omitempty"`
}

ListSeasonInfoPagingSlicedResult list season info paging sliced result

swagger:model ListSeasonInfoPagingSlicedResult

func (*ListSeasonInfoPagingSlicedResult) MarshalBinary 

func (m *ListSeasonInfoPagingSlicedResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ListSeasonInfoPagingSlicedResult) UnmarshalBinary 

func (m *ListSeasonInfoPagingSlicedResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ListSeasonInfoPagingSlicedResult) Validate 

func (m *ListSeasonInfoPagingSlicedResult) Validate(formats strfmt.Registry) error

Validate validates this list season info paging sliced result

type ListUserSeasonInfo 

type ListUserSeasonInfo struct {

	// whether cleared all tiers
	// Required: true
	Cleared *bool `json:"cleared"`

	// current tier index, zero based
	// Required: true
	CurrentTierIndex *int32 `json:"currentTierIndex"`

	// enroll date time
	// Required: true
	// Format: date-time
	EnrolledAt strfmt.DateTime `json:"enrolledAt"`

	// id
	// Required: true
	ID *string `json:"id"`

	// last tier index, zero based
	// Required: true
	LastTierIndex *int32 `json:"lastTierIndex"`

	// namespace
	// Required: true
	Namespace *string `json:"namespace"`

	// season summary
	// Required: true
	Season *SeasonSummary `json:"season"`

	// season id
	// Required: true
	SeasonID *string `json:"seasonId"`

	// user id
	// Required: true
	UserID *string `json:"userId"`
}

ListUserSeasonInfo A DTO object for listing user season data.

swagger:model ListUserSeasonInfo

func (*ListUserSeasonInfo) MarshalBinary 

func (m *ListUserSeasonInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ListUserSeasonInfo) UnmarshalBinary 

func (m *ListUserSeasonInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ListUserSeasonInfo) Validate 

func (m *ListUserSeasonInfo) Validate(formats strfmt.Registry) error

Validate validates this list user season info

type ListUserSeasonInfoPagingSlicedResult 

type ListUserSeasonInfoPagingSlicedResult struct {

	// data
	// Required: true
	Data []*ListUserSeasonInfo `json:"data"`

	// paging
	Paging *Paging `json:"paging,omitempty"`

	// total
	Total int64 `json:"total,omitempty"`
}

ListUserSeasonInfoPagingSlicedResult list user season info paging sliced result

swagger:model ListUserSeasonInfoPagingSlicedResult

func (*ListUserSeasonInfoPagingSlicedResult) MarshalBinary 

func (m *ListUserSeasonInfoPagingSlicedResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ListUserSeasonInfoPagingSlicedResult) UnmarshalBinary 

func (m *ListUserSeasonInfoPagingSlicedResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ListUserSeasonInfoPagingSlicedResult) Validate 

func (m *ListUserSeasonInfoPagingSlicedResult) Validate(formats strfmt.Registry) error

Validate validates this list user season info paging sliced result

type Localization 

type Localization struct {

	// description info
	Description string `json:"description,omitempty"`

	// title info
	Title string `json:"title,omitempty"`
}

Localization localization

swagger:model Localization

func (*Localization) MarshalBinary 

func (m *Localization) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Localization) UnmarshalBinary 

func (m *Localization) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Localization) Validate 

func (m *Localization) Validate(formats strfmt.Registry) error

Validate validates this localization

type LocalizedPassInfo 

type LocalizedPassInfo struct {

	// autoEnroll
	// Required: true
	AutoEnroll *bool `json:"autoEnroll"`

	// code
	// Required: true
	Code *string `json:"code"`

	// created at
	// Required: true
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"createdAt"`

	// description info
	Description string `json:"description,omitempty"`

	// displayOrder
	// Required: true
	DisplayOrder *string `json:"displayOrder"`

	// images
	Images []*Image `json:"images"`

	// current language
	// Required: true
	Language *string `json:"language"`

	// namespace
	// Required: true
	Namespace *string `json:"namespace"`

	// pass item id
	// Required: true
	PassItemID *string `json:"passItemId"`

	// season id
	// Required: true
	SeasonID *string `json:"seasonId"`

	// title info
	Title string `json:"title,omitempty"`

	// updated at
	// Required: true
	// Format: date-time
	UpdatedAt strfmt.DateTime `json:"updatedAt"`
}

LocalizedPassInfo A DTO object for public user retrieving pass info.

swagger:model LocalizedPassInfo

func (*LocalizedPassInfo) MarshalBinary 

func (m *LocalizedPassInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LocalizedPassInfo) UnmarshalBinary 

func (m *LocalizedPassInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LocalizedPassInfo) Validate 

func (m *LocalizedPassInfo) Validate(formats strfmt.Registry) error

Validate validates this localized pass info

type LocalizedSeasonInfo 

type LocalizedSeasonInfo struct {

	// whether auto claim rewards
	// Required: true
	AutoClaim *bool `json:"autoClaim"`

	// created at
	// Required: true
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"createdAt"`

	// description info
	Description string `json:"description,omitempty"`

	// end date time
	// Required: true
	// Format: date-time
	End strfmt.DateTime `json:"end"`

	// id
	// Required: true
	ID *string `json:"id"`

	// images
	Images []*Image `json:"images"`

	// current language
	// Required: true
	Language *string `json:"language"`

	// name, max length is 127
	// Required: true
	Name *string `json:"name"`

	// namespace
	// Required: true
	Namespace *string `json:"namespace"`

	// pass codes
	// Unique: true
	PassCodes []string `json:"passCodes"`

	// passes info
	// Required: true
	Passes []*LocalizedPassInfo `json:"passes"`

	// publishedAt
	// Format: date-time
	PublishedAt *strfmt.DateTime `json:"publishedAt,omitempty"`

	// rewards info
	// Required: true
	Rewards map[string]RewardInfo `json:"rewards"`

	// start date time
	// Required: true
	// Format: date-time
	Start strfmt.DateTime `json:"start"`

	// status
	// Required: true
	// Enum: [DRAFT PUBLISHED RETIRED]
	Status *string `json:"status"`

	// tier item id
	// Required: true
	TierItemID *string `json:"tierItemId"`

	// tiers info
	// Required: true
	Tiers []*Tier `json:"tiers"`

	// title info
	Title string `json:"title,omitempty"`

	// updated at
	// Required: true
	// Format: date-time
	UpdatedAt strfmt.DateTime `json:"updatedAt"`
}

LocalizedSeasonInfo A DTO object for public user retrieving season info.

swagger:model LocalizedSeasonInfo

func (*LocalizedSeasonInfo) MarshalBinary 

func (m *LocalizedSeasonInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*LocalizedSeasonInfo) UnmarshalBinary 

func (m *LocalizedSeasonInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*LocalizedSeasonInfo) Validate 

func (m *LocalizedSeasonInfo) Validate(formats strfmt.Registry) error

Validate validates this localized season info

type Ownership 

type Ownership struct {

	// ownership
	// Required: true
	Owned *bool `json:"owned"`
}

Ownership ownership

swagger:model Ownership

func (*Ownership) MarshalBinary 

func (m *Ownership) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Ownership) UnmarshalBinary 

func (m *Ownership) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Ownership) Validate 

func (m *Ownership) Validate(formats strfmt.Registry) error

Validate validates this ownership

type Paging 

type Paging struct {

	// next
	Next string `json:"next,omitempty"`

	// previous
	Previous string `json:"previous,omitempty"`
}

Paging paging

swagger:model Paging

func (*Paging) MarshalBinary 

func (m *Paging) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Paging) UnmarshalBinary 

func (m *Paging) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Paging) Validate 

func (m *Paging) Validate(formats strfmt.Registry) error

Validate validates this paging

type PassCreate 

type PassCreate struct {

	// autoEnroll for free pass, default false
	AutoEnroll bool `json:"autoEnroll"`

	// code, allowed characters from a-z0-9_:- and start/end in alphanumeric, max length is 255
	// Required: true
	Code *string `json:"code"`

	// displayOrder for frontend to arrange the pass
	// Required: true
	DisplayOrder *int32 `json:"displayOrder"`

	// images
	Images []*Image `json:"images"`

	// localization, {language: localization} map
	// Required: true
	Localizations map[string]Localization `json:"localizations"`

	// pass item id
	// Required: true
	PassItemID *string `json:"passItemId"`
}

PassCreate A DTO object for creating pass API call.

swagger:model PassCreate

func (*PassCreate) MarshalBinary 

func (m *PassCreate) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PassCreate) UnmarshalBinary 

func (m *PassCreate) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PassCreate) Validate 

func (m *PassCreate) Validate(formats strfmt.Registry) error

Validate validates this pass create

type PassInfo 

type PassInfo struct {

	// autoEnroll
	// Required: true
	AutoEnroll *bool `json:"autoEnroll"`

	// code
	// Required: true
	Code *string `json:"code"`

	// created at
	// Required: true
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"createdAt"`

	// displayOrder
	// Required: true
	DisplayOrder *string `json:"displayOrder"`

	// images
	Images []*Image `json:"images"`

	// localization, {language: localization} map
	// Required: true
	Localizations map[string]Localization `json:"localizations"`

	// namespace
	// Required: true
	Namespace *string `json:"namespace"`

	// pass item id
	// Required: true
	PassItemID *string `json:"passItemId"`

	// pass item name
	// Required: true
	PassItemName *string `json:"passItemName"`

	// season id
	// Required: true
	SeasonID *string `json:"seasonId"`

	// updated at
	// Required: true
	// Format: date-time
	UpdatedAt strfmt.DateTime `json:"updatedAt"`
}

PassInfo A DTO object for pass info.

swagger:model PassInfo

func (*PassInfo) MarshalBinary 

func (m *PassInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PassInfo) UnmarshalBinary 

func (m *PassInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PassInfo) Validate 

func (m *PassInfo) Validate(formats strfmt.Registry) error

Validate validates this pass info

type PassUpdate 

type PassUpdate struct {

	// autoEnroll for free pass
	AutoEnroll bool `json:"autoEnroll"`

	// displayOrder for frontend to arrange the pass
	DisplayOrder int32 `json:"displayOrder,omitempty"`

	// images
	Images []*Image `json:"images"`

	// localization, {language: localization} map
	Localizations map[string]Localization `json:"localizations,omitempty"`

	// pass item id
	PassItemID string `json:"passItemId,omitempty"`
}

PassUpdate A DTO object for updating pass API call.

swagger:model PassUpdate

func (*PassUpdate) MarshalBinary 

func (m *PassUpdate) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PassUpdate) UnmarshalBinary 

func (m *PassUpdate) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PassUpdate) Validate 

func (m *PassUpdate) Validate(formats strfmt.Registry) error

Validate validates this pass update

type RewardCreate 

type RewardCreate struct {

	// code, allowed characters from a-z0-9_:- and start/end in alphanumeric, max length is 255
	// Required: true
	Code *string `json:"code"`

	// currency, required when reward type is CURRENCY
	Currency *RewardCurrency `json:"currency,omitempty"`

	// image, thumbnail for reward
	Image *Image `json:"image,omitempty"`

	// itemId, required when reward type is ITEM, the item type should be one of: INGAMEITEM,COINS,BUNDLE
	ItemID string `json:"itemId,omitempty"`

	// Item quantity or Currency amount, default 1
	Quantity int32 `json:"quantity,omitempty"`

	// type, at current only support ITEM
	// Required: true
	// Enum: [ITEM CURRENCY]
	Type *string `json:"type"`
}

RewardCreate A DTO object for creating reward API call.

swagger:model RewardCreate

func (*RewardCreate) MarshalBinary 

func (m *RewardCreate) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RewardCreate) UnmarshalBinary 

func (m *RewardCreate) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RewardCreate) Validate 

func (m *RewardCreate) Validate(formats strfmt.Registry) error

Validate validates this reward create

type RewardCurrency 

type RewardCurrency struct {

	// currency code, alphabet uppercase
	// Required: true
	CurrencyCode *string `json:"currencyCode"`

	// namespace, allowed values: game namespace or publisher namespace
	// Required: true
	Namespace *string `json:"namespace"`
}

RewardCurrency A DTO object for reward currency.

swagger:model RewardCurrency

func (*RewardCurrency) MarshalBinary 

func (m *RewardCurrency) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RewardCurrency) UnmarshalBinary 

func (m *RewardCurrency) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RewardCurrency) Validate 

func (m *RewardCurrency) Validate(formats strfmt.Registry) error

Validate validates this reward currency

type RewardInfo 

type RewardInfo struct {

	// code
	// Required: true
	Code *string `json:"code"`

	// currency, required when reward type is CURRENCY
	Currency *RewardCurrency `json:"currency,omitempty"`

	// image, thumbnail for reward
	Image *Image `json:"image,omitempty"`

	// itemId, required when reward type is ITEM
	ItemID string `json:"itemId,omitempty"`

	// itemName, required when reward type is ITEM
	ItemName string `json:"itemName,omitempty"`

	// itemSku, required when reward type is ITEM
	ItemSku string `json:"itemSku,omitempty"`

	// itemType, required when reward type is ITEM
	// Enum: [APP COINS INGAMEITEM BUNDLE CODE SUBSCRIPTION SEASON]
	ItemType string `json:"itemType,omitempty"`

	// namespace
	// Required: true
	Namespace *string `json:"namespace"`

	// Item quantity or Currency amount, default 1
	Quantity int32 `json:"quantity,omitempty"`

	// seasonId
	// Required: true
	SeasonID *string `json:"seasonId"`

	// type
	// Required: true
	// Enum: [ITEM CURRENCY]
	Type *string `json:"type"`
}

RewardInfo A DTO object for reward info.

swagger:model RewardInfo

func (*RewardInfo) MarshalBinary 

func (m *RewardInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RewardInfo) UnmarshalBinary 

func (m *RewardInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RewardInfo) Validate 

func (m *RewardInfo) Validate(formats strfmt.Registry) error

Validate validates this reward info

type RewardUpdate 

type RewardUpdate struct {

	// currency, required when reward type is CURRENCY
	Currency *RewardCurrency `json:"currency,omitempty"`

	// image, thumbnail for reward
	Image *Image `json:"image,omitempty"`

	// itemId, required when reward type is ITEM, the item type should be one of: INGAMEITEM,COINS,BUNDLE
	ItemID string `json:"itemId,omitempty"`

	// nullFields
	// Unique: true
	NullFields []string `json:"nullFields"`

	// Item quantity or Currency amount, default 1
	Quantity int32 `json:"quantity,omitempty"`

	// type, at current only support ITEM
	// Enum: [ITEM CURRENCY]
	Type string `json:"type,omitempty"`
}

RewardUpdate A DTO object for updating reward API call.

swagger:model RewardUpdate

func (*RewardUpdate) MarshalBinary 

func (m *RewardUpdate) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RewardUpdate) UnmarshalBinary 

func (m *RewardUpdate) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RewardUpdate) Validate 

func (m *RewardUpdate) Validate(formats strfmt.Registry) error

Validate validates this reward update

type SeasonCloneRequest 

type SeasonCloneRequest struct {

	// end date time
	// Required: true
	// Format: date-time
	End strfmt.DateTime `json:"end"`

	// name, max length is 127
	// Required: true
	Name *string `json:"name"`

	// start date time
	// Required: true
	// Format: date-time
	Start strfmt.DateTime `json:"start"`
}

SeasonCloneRequest A DTO object for clone season API call.

swagger:model SeasonCloneRequest

func (*SeasonCloneRequest) MarshalBinary 

func (m *SeasonCloneRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SeasonCloneRequest) UnmarshalBinary 

func (m *SeasonCloneRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SeasonCloneRequest) Validate 

func (m *SeasonCloneRequest) Validate(formats strfmt.Registry) error

Validate validates this season clone request

type SeasonCreate 

type SeasonCreate struct {

	// whether auto claim rewards, default true
	AutoClaim bool `json:"autoClaim"`

	// default language, BCP 47 language tag, default is en
	DefaultLanguage string `json:"defaultLanguage,omitempty"`

	// default exp required for a tier
	// Required: true
	DefaultRequiredExp *int32 `json:"defaultRequiredExp"`

	// draft store id
	// Required: true
	DraftStoreID *string `json:"draftStoreId"`

	// end date time
	// Required: true
	// Format: date-time
	End strfmt.DateTime `json:"end"`

	// strategy while exceed final tier exp, default NONE
	ExcessStrategy *ExcessStrategy `json:"excessStrategy,omitempty"`

	// images
	Images []*Image `json:"images"`

	// localization, {language: localization} map
	// Required: true
	Localizations map[string]Localization `json:"localizations"`

	// name, max length is 127
	// Required: true
	Name *string `json:"name"`

	// start date time
	// Required: true
	// Format: date-time
	Start strfmt.DateTime `json:"start"`

	// tier item id
	// Required: true
	TierItemID *string `json:"tierItemId"`
}

SeasonCreate A DTO object for creating season API call.

swagger:model SeasonCreate

func (*SeasonCreate) MarshalBinary 

func (m *SeasonCreate) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SeasonCreate) UnmarshalBinary 

func (m *SeasonCreate) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SeasonCreate) Validate 

func (m *SeasonCreate) Validate(formats strfmt.Registry) error

Validate validates this season create

type SeasonInfo 

type SeasonInfo struct {

	// whether auto claim rewards
	// Required: true
	AutoClaim *bool `json:"autoClaim"`

	// created at
	// Required: true
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"createdAt"`

	// default language, BCP 47 language tag
	// Required: true
	DefaultLanguage *string `json:"defaultLanguage"`

	// default required exp for a tier
	// Required: true
	DefaultRequiredExp *int32 `json:"defaultRequiredExp"`

	// draft store id
	// Required: true
	DraftStoreID *string `json:"draftStoreId"`

	// end date time
	// Required: true
	// Format: date-time
	End strfmt.DateTime `json:"end"`

	// strategy while exceed final tier exp
	// Required: true
	ExcessStrategy *ExcessStrategy `json:"excessStrategy"`

	// id
	// Required: true
	ID *string `json:"id"`

	// images
	Images []*Image `json:"images"`

	// localization, {language: localization} map
	// Required: true
	Localizations map[string]Localization `json:"localizations"`

	// name, max length is 127
	// Required: true
	Name *string `json:"name"`

	// namespace
	// Required: true
	Namespace *string `json:"namespace"`

	// pass codes
	// Unique: true
	PassCodes []string `json:"passCodes"`

	// publishedAt
	// Format: date-time
	PublishedAt *strfmt.DateTime `json:"publishedAt,omitempty"`

	// start date time
	// Required: true
	// Format: date-time
	Start strfmt.DateTime `json:"start"`

	// status
	// Required: true
	// Enum: [DRAFT PUBLISHED RETIRED]
	Status *string `json:"status"`

	// tier item id
	// Required: true
	TierItemID *string `json:"tierItemId"`

	// tier item name
	// Required: true
	TierItemName *string `json:"tierItemName"`

	// updated at
	// Required: true
	// Format: date-time
	UpdatedAt strfmt.DateTime `json:"updatedAt"`
}

SeasonInfo A DTO object for season info.

swagger:model SeasonInfo

func (*SeasonInfo) MarshalBinary 

func (m *SeasonInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SeasonInfo) UnmarshalBinary 

func (m *SeasonInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SeasonInfo) Validate 

func (m *SeasonInfo) Validate(formats strfmt.Registry) error

Validate validates this season info

type SeasonSummary 

type SeasonSummary struct {

	// end date time
	// Required: true
	// Format: date-time
	End strfmt.DateTime `json:"end"`

	// id
	// Required: true
	ID *string `json:"id"`

	// name, max length is 127
	// Required: true
	Name *string `json:"name"`

	// namespace
	// Required: true
	Namespace *string `json:"namespace"`

	// season pass codes
	// Unique: true
	PassCodes []string `json:"passCodes"`

	// previous season, only present in some situation
	Previous *SeasonSummary `json:"previous,omitempty"`

	// publishedAt
	// Format: date-time
	PublishedAt *strfmt.DateTime `json:"publishedAt,omitempty"`

	// start date time
	// Required: true
	// Format: date-time
	Start strfmt.DateTime `json:"start"`

	// status
	// Required: true
	// Enum: [DRAFT PUBLISHED RETIRED]
	Status *string `json:"status"`
}

SeasonSummary A DTO object for season summary.

swagger:model SeasonSummary

func (*SeasonSummary) MarshalBinary 

func (m *SeasonSummary) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SeasonSummary) UnmarshalBinary 

func (m *SeasonSummary) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SeasonSummary) Validate 

func (m *SeasonSummary) Validate(formats strfmt.Registry) error

Validate validates this season summary

type SeasonUpdate 

type SeasonUpdate struct {

	// whether auto claim rewards
	AutoClaim bool `json:"autoClaim"`

	// default language, BCP 47 language tag
	DefaultLanguage string `json:"defaultLanguage,omitempty"`

	// default exp required for a tier
	DefaultRequiredExp int32 `json:"defaultRequiredExp,omitempty"`

	// draft store id
	DraftStoreID string `json:"draftStoreId,omitempty"`

	// end date time
	// Format: date-time
	End *strfmt.DateTime `json:"end,omitempty"`

	// strategy while exceed final tier exp
	ExcessStrategy *ExcessStrategy `json:"excessStrategy,omitempty"`

	// images
	Images []*Image `json:"images"`

	// localization, {language: localization} map
	Localizations map[string]Localization `json:"localizations,omitempty"`

	// name, max length is 127
	Name string `json:"name,omitempty"`

	// start date time
	// Format: date-time
	Start *strfmt.DateTime `json:"start,omitempty"`

	// tier item id
	TierItemID string `json:"tierItemId,omitempty"`
}

SeasonUpdate A DTO object for updating season API call.

swagger:model SeasonUpdate

func (*SeasonUpdate) MarshalBinary 

func (m *SeasonUpdate) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SeasonUpdate) UnmarshalBinary 

func (m *SeasonUpdate) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SeasonUpdate) Validate 

func (m *SeasonUpdate) Validate(formats strfmt.Registry) error

Validate validates this season update

type Tier 

type Tier struct {

	// tier id, auto generated.
	ID string `json:"id,omitempty"`

	// required exp for tier, it will automatically use season defaultRequiredExp if not set
	RequiredExp int32 `json:"requiredExp,omitempty"`

	// rewards map, passCode as key, rewardCode list as value
	Rewards map[string][]string `json:"rewards,omitempty"`
}

Tier tier

swagger:model Tier

func (*Tier) MarshalBinary 

func (m *Tier) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Tier) UnmarshalBinary 

func (m *Tier) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Tier) Validate 

func (m *Tier) Validate(formats strfmt.Registry) error

Validate validates this tier

type TierCreate 

type TierCreate struct {

	// zero based tier index to be inserted at, -1 means appending to the end, default -1
	Index int32 `json:"index,omitempty"`

	// create tier quantity, default 1
	Quantity int32 `json:"quantity,omitempty"`

	// tier content, default null tier
	Tier *TierInput `json:"tier,omitempty"`
}

TierCreate A DTO object for creating tier API call.

swagger:model TierCreate

func (*TierCreate) MarshalBinary 

func (m *TierCreate) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TierCreate) UnmarshalBinary 

func (m *TierCreate) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TierCreate) Validate 

func (m *TierCreate) Validate(formats strfmt.Registry) error

Validate validates this tier create

type TierInput 

type TierInput struct {

	// required exp for tier, it will automatically use season defaultRequiredExp if not set
	RequiredExp int32 `json:"requiredExp,omitempty"`

	// rewards map, passCode as key, rewardCode list as value
	Rewards map[string][]string `json:"rewards,omitempty"`
}

TierInput A DTO object for tier input.

swagger:model TierInput

func (*TierInput) MarshalBinary 

func (m *TierInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TierInput) UnmarshalBinary 

func (m *TierInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TierInput) Validate 

func (m *TierInput) Validate(formats strfmt.Registry) error

Validate validates this tier input

type TierPagingSlicedResult 

type TierPagingSlicedResult struct {

	// data
	// Required: true
	Data []*Tier `json:"data"`

	// paging
	Paging *Paging `json:"paging,omitempty"`

	// total
	Total int64 `json:"total,omitempty"`
}

TierPagingSlicedResult tier paging sliced result

swagger:model TierPagingSlicedResult

func (*TierPagingSlicedResult) MarshalBinary 

func (m *TierPagingSlicedResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TierPagingSlicedResult) UnmarshalBinary 

func (m *TierPagingSlicedResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TierPagingSlicedResult) Validate 

func (m *TierPagingSlicedResult) Validate(formats strfmt.Registry) error

Validate validates this tier paging sliced result

type TierReorder added in v0.12.0 

type TierReorder struct {

	// new index tier should be moved to, zero based, -1 means appending to the end
	NewIndex int32 `json:"newIndex,omitempty"`
}

TierReorder tier reorder

swagger:model TierReorder

func (*TierReorder) MarshalBinary added in v0.12.0 

func (m *TierReorder) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TierReorder) UnmarshalBinary added in v0.12.0 

func (m *TierReorder) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TierReorder) Validate added in v0.12.0 

func (m *TierReorder) Validate(formats strfmt.Registry) error

Validate validates this tier reorder

type UserExpGrant 

type UserExpGrant struct {

	// exp to grant
	Exp int32 `json:"exp,omitempty"`
}

UserExpGrant A DTO object for granting user exp.

swagger:model UserExpGrant

func (*UserExpGrant) MarshalBinary 

func (m *UserExpGrant) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UserExpGrant) UnmarshalBinary 

func (m *UserExpGrant) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UserExpGrant) Validate 

func (m *UserExpGrant) Validate(formats strfmt.Registry) error

Validate validates this user exp grant

type UserPassGrant 

type UserPassGrant struct {

	// pass code, required if passItemId null
	PassCode string `json:"passCode,omitempty"`

	// pass item id, required if passCode null and ignored if passCode present
	PassItemID string `json:"passItemId,omitempty"`
}

UserPassGrant A DTO object for granting user pass.

swagger:model UserPassGrant

func (*UserPassGrant) MarshalBinary 

func (m *UserPassGrant) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UserPassGrant) UnmarshalBinary 

func (m *UserPassGrant) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UserPassGrant) Validate 

func (m *UserPassGrant) Validate(formats strfmt.Registry) error

Validate validates this user pass grant

type UserPurchasable 

type UserPurchasable struct {

	// pass item id
	PassItemID string `json:"passItemId,omitempty"`

	// tier item count, default 1
	TierItemCount int32 `json:"tierItemCount,omitempty"`

	// tier item id
	TierItemID string `json:"tierItemId,omitempty"`
}

UserPurchasable A DTO object for user purchasable.

swagger:model UserPurchasable

func (*UserPurchasable) MarshalBinary 

func (m *UserPurchasable) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UserPurchasable) UnmarshalBinary 

func (m *UserPurchasable) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UserPurchasable) Validate 

func (m *UserPurchasable) Validate(formats strfmt.Registry) error

Validate validates this user purchasable

type UserRewardClaim 

type UserRewardClaim struct {

	// pass code
	// Required: true
	PassCode *string `json:"passCode"`

	// reward code
	// Required: true
	RewardCode *string `json:"rewardCode"`

	// tier index
	// Required: true
	TierIndex *int32 `json:"tierIndex"`
}

UserRewardClaim A DTO object for claiming user reward.

swagger:model UserRewardClaim

func (*UserRewardClaim) MarshalBinary 

func (m *UserRewardClaim) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UserRewardClaim) UnmarshalBinary 

func (m *UserRewardClaim) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UserRewardClaim) Validate 

func (m *UserRewardClaim) Validate(formats strfmt.Registry) error

Validate validates this user reward claim

type UserSeasonSummary 

type UserSeasonSummary struct {

	// whether cleared all tiers
	Cleared bool `json:"cleared"`

	// created at
	// Format: date-time
	CreatedAt *strfmt.DateTime `json:"createdAt,omitempty"`

	// gained exp for current tier
	CurrentExp int32 `json:"currentExp,omitempty"`

	// current tier index, zero based
	CurrentTierIndex int32 `json:"currentTierIndex,omitempty"`

	// enroll date time
	// Format: date-time
	EnrolledAt *strfmt.DateTime `json:"enrolledAt,omitempty"`

	// enrolled passes
	// Unique: true
	EnrolledPasses []string `json:"enrolledPasses"`

	// id
	ID string `json:"id,omitempty"`

	// last tier index, zero based
	LastTierIndex int32 `json:"lastTierIndex,omitempty"`

	// namespace
	// Required: true
	Namespace *string `json:"namespace"`

	// required exp for current tier
	RequiredExp int32 `json:"requiredExp,omitempty"`

	// season id
	SeasonID string `json:"seasonId,omitempty"`

	// updated at
	// Format: date-time
	UpdatedAt *strfmt.DateTime `json:"updatedAt,omitempty"`

	// user id
	// Required: true
	UserID *string `json:"userId"`
}

UserSeasonSummary A DTO object for user season summary.

swagger:model UserSeasonSummary

func (*UserSeasonSummary) MarshalBinary 

func (m *UserSeasonSummary) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UserSeasonSummary) UnmarshalBinary 

func (m *UserSeasonSummary) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UserSeasonSummary) Validate 

func (m *UserSeasonSummary) Validate(formats strfmt.Registry) error

Validate validates this user season summary

type UserTierGrant 

type UserTierGrant struct {

	// count to grant
	Count int32 `json:"count,omitempty"`
}

UserTierGrant A DTO object for granting user tier.

swagger:model UserTierGrant

func (*UserTierGrant) MarshalBinary 

func (m *UserTierGrant) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UserTierGrant) UnmarshalBinary 

func (m *UserTierGrant) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UserTierGrant) Validate 

func (m *UserTierGrant) Validate(formats strfmt.Registry) error

Validate validates this user tier grant

type ValidationErrorEntity 

type ValidationErrorEntity struct {

	// numeric error code
	// Required: true
	ErrorCode *int32 `json:"errorCode"`

	// error message
	// Required: true
	ErrorMessage *string `json:"errorMessage"`

	// errors
	Errors []*FieldValidationError `json:"errors"`
}

ValidationErrorEntity validation error entity

swagger:model ValidationErrorEntity

func (*ValidationErrorEntity) MarshalBinary 

func (m *ValidationErrorEntity) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ValidationErrorEntity) UnmarshalBinary 

func (m *ValidationErrorEntity) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ValidationErrorEntity) Validate 

func (m *ValidationErrorEntity) Validate(formats strfmt.Registry) error

Validate validates this validation error entity

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.