Class: TelegramBot::GiveawayWinners

Inherits:
Object
  • Object
show all
Defined in:
lib/telegram-bot/models/giveaway_winners.rb

Overview

This object represents a message about the completion of a giveaway with public winners.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GiveawayWinners

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 99

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TelegramBot::GiveawayWinners` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TelegramBot::GiveawayWinners`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'chat')
    self.chat = attributes[:'chat']
  else
    self.chat = nil
  end

  if attributes.key?(:'giveaway_message_id')
    self.giveaway_message_id = attributes[:'giveaway_message_id']
  else
    self.giveaway_message_id = nil
  end

  if attributes.key?(:'winners_selection_date')
    self.winners_selection_date = attributes[:'winners_selection_date']
  else
    self.winners_selection_date = nil
  end

  if attributes.key?(:'winner_count')
    self.winner_count = attributes[:'winner_count']
  else
    self.winner_count = nil
  end

  if attributes.key?(:'winners')
    if (value = attributes[:'winners']).is_a?(Array)
      self.winners = value
    end
  else
    self.winners = nil
  end

  if attributes.key?(:'additional_chat_count')
    self.additional_chat_count = attributes[:'additional_chat_count']
  end

  if attributes.key?(:'premium_subscription_month_count')
    self.premium_subscription_month_count = attributes[:'premium_subscription_month_count']
  end

  if attributes.key?(:'unclaimed_prize_count')
    self.unclaimed_prize_count = attributes[:'unclaimed_prize_count']
  end

  if attributes.key?(:'only_new_members')
    self.only_new_members = attributes[:'only_new_members']
  end

  if attributes.key?(:'was_refunded')
    self.was_refunded = attributes[:'was_refunded']
  end

  if attributes.key?(:'prize_description')
    self.prize_description = attributes[:'prize_description']
  end
end

Instance Attribute Details

#additional_chat_count ⇒ Object

Optional. The number of other chats the user had to join in order to be eligible for the giveaway



35
36
37
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 35

def additional_chat_count
  @additional_chat_count
end

#chat ⇒ Object

The chat that created the giveaway



20
21
22
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 20

def chat
  @chat
end

#giveaway_message_id ⇒ Object

Identifier of the message with the giveaway in the chat



23
24
25
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 23

def giveaway_message_id
  @giveaway_message_id
end

#only_new_members ⇒ Object

Optional. True, if only users who had joined the chats after the giveaway started were eligible to win



44
45
46
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 44

def only_new_members
  @only_new_members
end

#premium_subscription_month_count ⇒ Object

Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for



38
39
40
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 38

def premium_subscription_month_count
  @premium_subscription_month_count
end

#prize_description ⇒ Object

Optional. Description of additional giveaway prize



50
51
52
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 50

def prize_description
  @prize_description
end

#unclaimed_prize_count ⇒ Object

Optional. Number of undistributed prizes



41
42
43
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 41

def unclaimed_prize_count
  @unclaimed_prize_count
end

#was_refunded ⇒ Object

Optional. True, if the giveaway was canceled because the payment for it was refunded



47
48
49
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 47

def was_refunded
  @was_refunded
end

#winner_count ⇒ Object

Total number of winners in the giveaway



29
30
31
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 29

def winner_count
  @winner_count
end

#winners ⇒ Object

List of up to 100 winners of the giveaway



32
33
34
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 32

def winners
  @winners
end

#winners_selection_date ⇒ Object

Point in time (Unix timestamp) when winners of the giveaway were selected



26
27
28
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 26

def winners_selection_date
  @winners_selection_date
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 266

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = TelegramBot.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



70
71
72
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 53

def self.attribute_map
  {
    :'chat' => :'chat',
    :'giveaway_message_id' => :'giveaway_message_id',
    :'winners_selection_date' => :'winners_selection_date',
    :'winner_count' => :'winner_count',
    :'winners' => :'winners',
    :'additional_chat_count' => :'additional_chat_count',
    :'premium_subscription_month_count' => :'premium_subscription_month_count',
    :'unclaimed_prize_count' => :'unclaimed_prize_count',
    :'only_new_members' => :'only_new_members',
    :'was_refunded' => :'was_refunded',
    :'prize_description' => :'prize_description'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 242

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 92

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 75

def self.openapi_types
  {
    :'chat' => :'Chat',
    :'giveaway_message_id' => :'Integer',
    :'winners_selection_date' => :'Integer',
    :'winner_count' => :'Integer',
    :'winners' => :'Array<User>',
    :'additional_chat_count' => :'Integer',
    :'premium_subscription_month_count' => :'Integer',
    :'unclaimed_prize_count' => :'Integer',
    :'only_new_members' => :'Boolean',
    :'was_refunded' => :'Boolean',
    :'prize_description' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 211

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      chat == o.chat &&
      giveaway_message_id == o.giveaway_message_id &&
      winners_selection_date == o.winners_selection_date &&
      winner_count == o.winner_count &&
      winners == o.winners &&
      additional_chat_count == o.additional_chat_count &&
      premium_subscription_month_count == o.premium_subscription_month_count &&
      unclaimed_prize_count == o.unclaimed_prize_count &&
      only_new_members == o.only_new_members &&
      was_refunded == o.was_refunded &&
      prize_description == o.prize_description
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 337

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


229
230
231
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 229

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



235
236
237
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 235

def hash
  [chat, giveaway_message_id, winners_selection_date, winner_count, winners, additional_chat_count, premium_subscription_month_count, unclaimed_prize_count, only_new_members, was_refunded, prize_description].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 171

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @chat.nil?
    invalid_properties.push('invalid value for "chat", chat cannot be nil.')
  end

  if @giveaway_message_id.nil?
    invalid_properties.push('invalid value for "giveaway_message_id", giveaway_message_id cannot be nil.')
  end

  if @winners_selection_date.nil?
    invalid_properties.push('invalid value for "winners_selection_date", winners_selection_date cannot be nil.')
  end

  if @winner_count.nil?
    invalid_properties.push('invalid value for "winner_count", winner_count cannot be nil.')
  end

  if @winners.nil?
    invalid_properties.push('invalid value for "winners", winners cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



313
314
315
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 313

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 319

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



307
308
309
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 307

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



199
200
201
202
203
204
205
206
207
 
# File 'lib/telegram-bot/models/giveaway_winners.rb', line 199

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @chat.nil?
  return false if @giveaway_message_id.nil?
  return false if @winners_selection_date.nil?
  return false if @winner_count.nil?
  return false if @winners.nil?
  true
end