Class: SmsRu::Limit

Inherits:
Object
  • Object
show all
Defined in:
lib/sms_ru/data.rb

Overview

Result of SmsRu::My#limit (daily sending limit).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#total_limit ⇒ Integer (readonly)

Returns the daily limit.

Returns:

  • (Integer) —

    the daily limit



187
188
189
190
191
192
193
194
195
196
 
# File 'lib/sms_ru/data.rb', line 187

class Limit < Data.define(:total_limit, :used_today)
  # @param hash [Hash] the parsed /my/limit response
  # @return [SmsRu::Limit]
  def self.build(hash)
    new(total_limit: Coerce.integer(hash["total_limit"]), used_today: Coerce.integer(hash["used_today"]))
  end

  # @return [Integer] how many more messages can be sent today
  def available_today = total_limit - used_today
end

#used_today ⇒ Integer (readonly)

Returns the number of messages sent today.

Returns:

  • (Integer) —

    the number of messages sent today



187
188
189
190
191
192
193
194
195
196
 
# File 'lib/sms_ru/data.rb', line 187

class Limit < Data.define(:total_limit, :used_today)
  # @param hash [Hash] the parsed /my/limit response
  # @return [SmsRu::Limit]
  def self.build(hash)
    new(total_limit: Coerce.integer(hash["total_limit"]), used_today: Coerce.integer(hash["used_today"]))
  end

  # @return [Integer] how many more messages can be sent today
  def available_today = total_limit - used_today
end

Class Method Details

.build(hash) ⇒ SmsRu::Limit

Parameters:

  • hash (Hash) —

    the parsed /my/limit response

Returns:



190
191
192
 
# File 'lib/sms_ru/data.rb', line 190

def self.build(hash)
  new(total_limit: Coerce.integer(hash["total_limit"]), used_today: Coerce.integer(hash["used_today"]))
end

Instance Method Details

#available_today ⇒ Integer

Returns how many more messages can be sent today.

Returns:

  • (Integer) —

    how many more messages can be sent today



195
 
# File 'lib/sms_ru/data.rb', line 195

def available_today = total_limit - used_today