Class: Line::Bot::V2::Insight::GetNumberOfFollowersResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/line/bot/v2/insight/model/get_number_of_followers_response.rb

Overview

Get number of followers

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(status: nil, followers: nil, targeted_reaches: nil, blocks: nil, **dynamic_attributes) ⇒ GetNumberOfFollowersResponse

Returns a new instance of GetNumberOfFollowersResponse.

Parameters:

  • status (String, nil) (defaults to: nil) —

    (‘ready’|‘unready’|‘out_of_service’) Calculation status.

  • followers (Integer, nil) (defaults to: nil) —

    The number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn’t decrease even if a user later blocks the account or when they delete their LINE account.

  • targeted_reaches (Integer, nil) (defaults to: nil) —

    The number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty.

  • blocks (Integer, nil) (defaults to: nil) —

    The number of users blocking the account as of the specified date. The number decreases when a user unblocks the account.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/line/bot/v2/insight/model/get_number_of_followers_response.rb', line 34

def initialize(
  status: nil,
  followers: nil,
  targeted_reaches: nil,
  blocks: nil,
  **dynamic_attributes
)
  
  @status = status
  @followers = followers
  @targeted_reaches = targeted_reaches
  @blocks = blocks

  dynamic_attributes.each do |key, value|
    self.class.attr_accessor key

    if value.is_a?(Hash)
      struct_klass = Struct.new(*value.keys.map(&:to_sym))
      struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
      instance_variable_set("@#{key}", struct_klass.new(*struct_values))
    else
      instance_variable_set("@#{key}", value)
    end
  end
end

Instance Attribute Details

#blocks ⇒ Integer?

Returns The number of users blocking the account as of the specified date. The number decreases when a user unblocks the account.

Returns:

  • (Integer, nil) —

    The number of users blocking the account as of the specified date. The number decreases when a user unblocks the account.



28
29
30
 
# File 'lib/line/bot/v2/insight/model/get_number_of_followers_response.rb', line 28

def blocks
  @blocks
end

#followers ⇒ Integer?

Returns The number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn’t decrease even if a user later blocks the account or when they delete their LINE account.

Returns:

  • (Integer, nil) —

    The number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn’t decrease even if a user later blocks the account or when they delete their LINE account.



22
23
24
 
# File 'lib/line/bot/v2/insight/model/get_number_of_followers_response.rb', line 22

def followers
  @followers
end

#status ⇒ String?

Returns (‘ready’|‘unready’|‘out_of_service’) Calculation status.

Returns:

  • (String, nil) —

    (‘ready’|‘unready’|‘out_of_service’) Calculation status.



19
20
21
 
# File 'lib/line/bot/v2/insight/model/get_number_of_followers_response.rb', line 19

def status
  @status
end

#targeted_reaches ⇒ Integer?

Returns The number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty.

Returns:

  • (Integer, nil) —

    The number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty.



25
26
27
 
# File 'lib/line/bot/v2/insight/model/get_number_of_followers_response.rb', line 25

def targeted_reaches
  @targeted_reaches
end

Class Method Details

.create(args) ⇒ Line::Bot::V2::Insight::GetNumberOfFollowersResponse

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



63
64
65
66
 
# File 'lib/line/bot/v2/insight/model/get_number_of_followers_response.rb', line 63

def self.create(args) # steep:ignore
  symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
  return new(**symbolized_args) # steep:ignore
end

Instance Method Details

#==(other) ⇒ Boolean

Returns true if the objects are equal, false otherwise.

Parameters:

  • other (Object) —

    Object to compare

Returns:

  • (Boolean) —

    true if the objects are equal, false otherwise



70
71
72
73
74
75
76
 
# File 'lib/line/bot/v2/insight/model/get_number_of_followers_response.rb', line 70

def ==(other)
  return false unless self.class == other.class

  instance_variables.all? do |var|
      instance_variable_get(var) == other.instance_variable_get(var)
  end
end

#hash ⇒ Integer

Returns Hash code of the object.

Returns:

  • (Integer) —

    Hash code of the object



79
80
81
 
# File 'lib/line/bot/v2/insight/model/get_number_of_followers_response.rb', line 79

def hash
  [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
end