Class: TelegramBot::Giveaway

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

Overview

This object represents a message about a scheduled giveaway.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Giveaway

Initializes the object

Parameters:

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

    Model attributes in the form of hash



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
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
 
# File 'lib/telegram-bot/models/giveaway.rb', line 84

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TelegramBot::Giveaway` 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::Giveaway`. 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?(:'chats')
    if (value = attributes[:'chats']).is_a?(Array)
      self.chats = value
    end
  else
    self.chats = 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?(:'only_new_members')
    self.only_new_members = attributes[:'only_new_members']
  end

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

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

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

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

Instance Attribute Details

#chats ⇒ Object

The list of chats which the user must join to participate in the giveaway



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

def chats
  @chats
end

#country_codes ⇒ Object

Optional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways.



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

def country_codes
  @country_codes
end

#has_public_winners ⇒ Object

Optional. True, if the list of giveaway winners will be visible to everyone



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

def has_public_winners
  @has_public_winners
end

#only_new_members ⇒ Object

Optional. True, if only users who join the chats after the giveaway started should be eligible to win



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

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



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

def premium_subscription_month_count
  @premium_subscription_month_count
end

#prize_description ⇒ Object

Optional. Description of additional giveaway prize



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

def prize_description
  @prize_description
end

#winner_count ⇒ Object

The number of users which are supposed to be selected as winners of the giveaway



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

def winner_count
  @winner_count
end

#winners_selection_date ⇒ Object

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



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

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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/telegram-bot/models/giveaway.rb', line 224

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



58
59
60
 
# File 'lib/telegram-bot/models/giveaway.rb', line 58

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/telegram-bot/models/giveaway.rb', line 44

def self.attribute_map
  {
    :'chats' => :'chats',
    :'winners_selection_date' => :'winners_selection_date',
    :'winner_count' => :'winner_count',
    :'only_new_members' => :'only_new_members',
    :'has_public_winners' => :'has_public_winners',
    :'prize_description' => :'prize_description',
    :'country_codes' => :'country_codes',
    :'premium_subscription_month_count' => :'premium_subscription_month_count'
  }
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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/telegram-bot/models/giveaway.rb', line 200

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



77
78
79
80
 
# File 'lib/telegram-bot/models/giveaway.rb', line 77

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/telegram-bot/models/giveaway.rb', line 63

def self.openapi_types
  {
    :'chats' => :'Array<Chat>',
    :'winners_selection_date' => :'Integer',
    :'winner_count' => :'Integer',
    :'only_new_members' => :'Boolean',
    :'has_public_winners' => :'Boolean',
    :'prize_description' => :'String',
    :'country_codes' => :'Array<String>',
    :'premium_subscription_month_count' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/telegram-bot/models/giveaway.rb', line 172

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      chats == o.chats &&
      winners_selection_date == o.winners_selection_date &&
      winner_count == o.winner_count &&
      only_new_members == o.only_new_members &&
      has_public_winners == o.has_public_winners &&
      prize_description == o.prize_description &&
      country_codes == o.country_codes &&
      premium_subscription_month_count == o.premium_subscription_month_count
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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/telegram-bot/models/giveaway.rb', line 295

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


187
188
189
 
# File 'lib/telegram-bot/models/giveaway.rb', line 187

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



193
194
195
 
# File 'lib/telegram-bot/models/giveaway.rb', line 193

def hash
  [chats, winners_selection_date, winner_count, only_new_members, has_public_winners, prize_description, country_codes, premium_subscription_month_count].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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/telegram-bot/models/giveaway.rb', line 142

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @chats.nil?
    invalid_properties.push('invalid value for "chats", chats 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

  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



271
272
273
 
# File 'lib/telegram-bot/models/giveaway.rb', line 271

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



277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/telegram-bot/models/giveaway.rb', line 277

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



265
266
267
 
# File 'lib/telegram-bot/models/giveaway.rb', line 265

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



162
163
164
165
166
167
168
 
# File 'lib/telegram-bot/models/giveaway.rb', line 162

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