Class: TeamBattlesSdk::Generated::Models::CreateBanRequestBody

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

Overview

Creates a league team ban.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeObject

Instantiates a new CreateBanRequestBody and sets the default values.



46
47
48
# File 'lib/teambattles_sdk/generated/models/create_ban_request_body.rb', line 46

def initialize()
    @additional_data = Hash.new
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 create_ban_request_body

Raises:

  • (StandardError)


54
55
56
57
# File 'lib/teambattles_sdk/generated/models/create_ban_request_body.rb', line 54

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

Instance Method Details

#additional_dataObject

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/create_ban_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/create_ban_request_body.rb', line 39

def additional_data=(value)
    @additional_data = value
end

#expires_atObject

Gets the expiresAt property value. Expiration timestamp for temporary bans, in epoch milliseconds.

Returns:

  • a double



62
63
64
# File 'lib/teambattles_sdk/generated/models/create_ban_request_body.rb', line 62

def expires_at
    return @expires_at
end

#expires_at=(value) ⇒ Object

Sets the expiresAt property value. Expiration timestamp for temporary bans, in epoch milliseconds.

Parameters:

  • value

    Value to set for the expiresAt property.

Returns:

  • a void



70
71
72
# File 'lib/teambattles_sdk/generated/models/create_ban_request_body.rb', line 70

def expires_at=(value)
    @expires_at = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



77
78
79
80
81
82
83
84
# File 'lib/teambattles_sdk/generated/models/create_ban_request_body.rb', line 77

def get_field_deserializers()
    return {
        "expiresAt" => lambda {|n| @expires_at = n.get_object_value(lambda {|pn| Double.create_from_discriminator_value(pn) }) },
        "isPermanent" => lambda {|n| @is_permanent = n.get_boolean_value() },
        "reason" => lambda {|n| @reason = n.get_string_value() },
        "teamId" => lambda {|n| @team_id = n.get_string_value() },
    }
end

#is_permanentObject

Gets the isPermanent property value. Whether the ban never expires.

Returns:

  • a boolean



89
90
91
# File 'lib/teambattles_sdk/generated/models/create_ban_request_body.rb', line 89

def is_permanent
    return @is_permanent
end

#is_permanent=(value) ⇒ Object

Sets the isPermanent property value. Whether the ban never expires.

Parameters:

  • value

    Value to set for the isPermanent property.

Returns:

  • a void



97
98
99
# File 'lib/teambattles_sdk/generated/models/create_ban_request_body.rb', line 97

def is_permanent=(value)
    @is_permanent = value
end

#reasonObject

Gets the reason property value. Reason for the ban.

Returns:

  • a string



104
105
106
# File 'lib/teambattles_sdk/generated/models/create_ban_request_body.rb', line 104

def reason
    return @reason
end

#reason=(value) ⇒ Object

Sets the reason property value. Reason for the ban.

Parameters:

  • value

    Value to set for the reason property.

Returns:

  • a void



112
113
114
# File 'lib/teambattles_sdk/generated/models/create_ban_request_body.rb', line 112

def reason=(value)
    @reason = 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)


120
121
122
123
124
125
126
127
# File 'lib/teambattles_sdk/generated/models/create_ban_request_body.rb', line 120

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_object_value("expiresAt", @expires_at)
    writer.write_boolean_value("isPermanent", @is_permanent)
    writer.write_string_value("reason", @reason)
    writer.write_string_value("teamId", @team_id)
    writer.write_additional_data(@additional_data)
end

#team_idObject

Gets the teamId property value. Team ID to ban from the league.

Returns:

  • a string



132
133
134
# File 'lib/teambattles_sdk/generated/models/create_ban_request_body.rb', line 132

def team_id
    return @team_id
end

#team_id=(value) ⇒ Object

Sets the teamId property value. Team ID to ban from the league.

Parameters:

  • value

    Value to set for the teamId property.

Returns:

  • a void



140
141
142
# File 'lib/teambattles_sdk/generated/models/create_ban_request_body.rb', line 140

def team_id=(value)
    @team_id = value
end