Class: Line::Bot::V2::MessagingApi::SubscribedMembershipUser

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

Overview

Object containing user membership subscription information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(membership_no:, joined_time:, next_billing_date:, total_subscription_months:, **dynamic_attributes) ⇒ SubscribedMembershipUser

Returns a new instance of SubscribedMembershipUser.

Parameters:

  • membership_no (Integer) —

    The user’s member number in the membership plan.

  • joined_time (Integer) —

    UNIX timestamp at which the user subscribed to the membership.

  • next_billing_date (String) —

    Next payment date for membership plan. - Format: yyyy-MM-dd (e.g. 2024-02-08) - Timezone: UTC+9

  • total_subscription_months (Integer) —

    The period of time in months that the user has been subscribed to a membership plan. If a user previously canceled and then re-subscribed to the same membership plan, only the period after the re-subscription will be counted.



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

def initialize(
  membership_no:,
  joined_time:,
  next_billing_date:,
  total_subscription_months:,
  **dynamic_attributes
)
  
  @membership_no = membership_no
  @joined_time = joined_time
  @next_billing_date = next_billing_date
  @total_subscription_months = total_subscription_months

  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

#joined_time ⇒ Integer

Returns UNIX timestamp at which the user subscribed to the membership.

Returns:

  • (Integer) —

    UNIX timestamp at which the user subscribed to the membership.



21
22
23
 
# File 'lib/line/bot/v2/messaging_api/model/subscribed_membership_user.rb', line 21

def joined_time
  @joined_time
end

#membership_no ⇒ Integer

Returns The user’s member number in the membership plan.

Returns:

  • (Integer) —

    The user’s member number in the membership plan.



18
19
20
 
# File 'lib/line/bot/v2/messaging_api/model/subscribed_membership_user.rb', line 18

def membership_no
  @membership_no
end

#next_billing_date ⇒ String

Returns Next payment date for membership plan. - Format: yyyy-MM-dd (e.g. 2024-02-08) - Timezone: UTC+9.

Returns:

  • (String) —

    Next payment date for membership plan. - Format: yyyy-MM-dd (e.g. 2024-02-08) - Timezone: UTC+9



24
25
26
 
# File 'lib/line/bot/v2/messaging_api/model/subscribed_membership_user.rb', line 24

def next_billing_date
  @next_billing_date
end

#total_subscription_months ⇒ Integer

Returns The period of time in months that the user has been subscribed to a membership plan. If a user previously canceled and then re-subscribed to the same membership plan, only the period after the re-subscription will be counted.

Returns:

  • (Integer) —

    The period of time in months that the user has been subscribed to a membership plan. If a user previously canceled and then re-subscribed to the same membership plan, only the period after the re-subscription will be counted.



27
28
29
 
# File 'lib/line/bot/v2/messaging_api/model/subscribed_membership_user.rb', line 27

def total_subscription_months
  @total_subscription_months
end

Class Method Details

.create(args) ⇒ Line::Bot::V2::MessagingApi::SubscribedMembershipUser

Create an instance of the class from a hash

Parameters:

  • args (Hash) —

    Hash containing all the required attributes

Returns:



62
63
64
65
 
# File 'lib/line/bot/v2/messaging_api/model/subscribed_membership_user.rb', line 62

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



69
70
71
72
73
74
75
 
# File 'lib/line/bot/v2/messaging_api/model/subscribed_membership_user.rb', line 69

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



78
79
80
 
# File 'lib/line/bot/v2/messaging_api/model/subscribed_membership_user.rb', line 78

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