Class: TeamBattlesSdk::Generated::Models::DiscoverLeaguesRequestBody

Inherits:
Object
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/teambattles_sdk/generated/models/discover_leagues_request_body.rb

Overview

Filters and offset pagination for discovering leagues.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

Instantiates a new DiscoverLeaguesRequestBody and sets the default values.



46
47
48
49
50
 
# File 'lib/teambattles_sdk/generated/models/discover_leagues_request_body.rb', line 46

def initialize()
    @additional_data = Hash.new
    @limit = 12
    @page = 1
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a discover_leagues_request_body

Raises:

  • (StandardError) 


56
57
58
59
 
# File 'lib/teambattles_sdk/generated/models/discover_leagues_request_body.rb', line 56

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return DiscoverLeaguesRequestBody.new
end

Instance Method Details

#additional_data ⇒ Object

Gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Returns:

  • a i_dictionary



31
32
33
 
# File 'lib/teambattles_sdk/generated/models/discover_leagues_request_body.rb', line 31

def additional_data
    return @additional_data
end

#additional_data=(value) ⇒ Object

Sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Parameters:

  • value —

    Value to set for the AdditionalData property.

Returns:

  • a void



39
40
41
 
# File 'lib/teambattles_sdk/generated/models/discover_leagues_request_body.rb', line 39

def additional_data=(value)
    @additional_data = value
end

#game_id ⇒ Object

Gets the gameId property value. Filter to leagues that include this game id.

Returns:

  • a string



64
65
66
 
# File 'lib/teambattles_sdk/generated/models/discover_leagues_request_body.rb', line 64

def game_id
    return @game_id
end

#game_id=(value) ⇒ Object

Sets the gameId property value. Filter to leagues that include this game id.

Parameters:

  • value —

    Value to set for the gameId property.

Returns:

  • a void



72
73
74
 
# File 'lib/teambattles_sdk/generated/models/discover_leagues_request_body.rb', line 72

def game_id=(value)
    @game_id = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



79
80
81
82
83
84
85
86
 
# File 'lib/teambattles_sdk/generated/models/discover_leagues_request_body.rb', line 79

def get_field_deserializers()
    return {
        "gameId" => lambda {|n| @game_id = n.get_string_value() },
        "limit" => lambda {|n| @limit = n.get_number_value() },
        "page" => lambda {|n| @page = n.get_number_value() },
        "search" => lambda {|n| @search = n.get_string_value() },
    }
end

#limit ⇒ Object

Gets the limit property value. Page size (1-50). Defaults to 12.

Returns:

  • a integer



91
92
93
 
# File 'lib/teambattles_sdk/generated/models/discover_leagues_request_body.rb', line 91

def limit
    return @limit
end

#limit=(value) ⇒ Object

Sets the limit property value. Page size (1-50). Defaults to 12.

Parameters:

  • value —

    Value to set for the limit property.

Returns:

  • a void



99
100
101
 
# File 'lib/teambattles_sdk/generated/models/discover_leagues_request_body.rb', line 99

def limit=(value)
    @limit = value
end

#page ⇒ Object

Gets the page property value. 1-based page number. Defaults to 1.

Returns:

  • a integer



106
107
108
 
# File 'lib/teambattles_sdk/generated/models/discover_leagues_request_body.rb', line 106

def page
    return @page
end

#page=(value) ⇒ Object

Sets the page property value. 1-based page number. Defaults to 1.

Parameters:

  • value —

    Value to set for the page property.

Returns:

  • a void



114
115
116
 
# File 'lib/teambattles_sdk/generated/models/discover_leagues_request_body.rb', line 114

def page=(value)
    @page = value
end

#search ⇒ Object

Gets the search property value. Free-text search across league names.

Returns:

  • a string



121
122
123
 
# File 'lib/teambattles_sdk/generated/models/discover_leagues_request_body.rb', line 121

def search
    return @search
end

#search=(value) ⇒ Object

Sets the search property value. Free-text search across league names.

Parameters:

  • value —

    Value to set for the search property.

Returns:

  • a void



129
130
131
 
# File 'lib/teambattles_sdk/generated/models/discover_leagues_request_body.rb', line 129

def search=(value)
    @search = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


137
138
139
140
141
142
143
144
 
# File 'lib/teambattles_sdk/generated/models/discover_leagues_request_body.rb', line 137

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_string_value("gameId", @game_id)
    writer.write_number_value("limit", @limit)
    writer.write_number_value("page", @page)
    writer.write_string_value("search", @search)
    writer.write_additional_data(@additional_data)
end