Class: Pingram::SenderPostBodyTo

Inherits:
ApiModelBase show all
Defined in:
lib/pingram/models/sender_post_body_to.rb

Overview

Recipient user. Provide id, email, or number to identify the user.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ SenderPostBodyTo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
168
169
170
171
172
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 107

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

Creation timestamp. Read-only.



49
50
51
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 49

def created_at
  @created_at
end

#email ⇒ Object

User’s email address for email notifications.



23
24
25
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 23

def email
  @email
end

#email_suppression_status ⇒ Object

Returns the value of attribute email_suppression_status.



51
52
53
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 51

def email_suppression_status
  @email_suppression_status
end

#id ⇒ Object

Unique user identifier. Required.



20
21
22
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 20

def id
  @id
end

#last_seen_time ⇒ Object

Last activity timestamp. Updated automatically. Read-only.



43
44
45
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 43

def last_seen_time
  @last_seen_time
end

#number ⇒ Object

User’s phone number for SMS/call notifications.



26
27
28
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 26

def number
  @number
end

#push_tokens ⇒ Object

Mobile push tokens (FCM, APN) for push notifications.



29
30
31
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 29

def push_tokens
  @push_tokens
end

#slack_channel ⇒ Object

The destination channel of slack notifications sent to this user. Can be either of the following: - Channel name, e.g. \“test\” - Channel name with # prefix, e.g. \“#test\” - Channel ID, e.g. \“C1234567890\” - User ID for DM, e.g. \“U1234567890\” - Username with @ prefix, e.g. \“@test\”



38
39
40
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 38

def slack_channel
  @slack_channel
end

#slack_token ⇒ Object

Returns the value of attribute slack_token.



40
41
42
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 40

def slack_token
  @slack_token
end

#timezone ⇒ Object

User’s timezone (e.g. \“America/New_York\”) for scheduling.



35
36
37
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 35

def timezone
  @timezone
end

#updated_at ⇒ Object

Last update timestamp. Read-only.



46
47
48
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 46

def updated_at
  @updated_at
end

#web_push_tokens ⇒ Object

Web push subscription config from the browser.



32
33
34
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 32

def web_push_tokens
  @web_push_tokens
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



72
73
74
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 72

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



77
78
79
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 77

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 54

def self.attribute_map
  {
    :'id' => :'id',
    :'email' => :'email',
    :'number' => :'number',
    :'push_tokens' => :'pushTokens',
    :'web_push_tokens' => :'webPushTokens',
    :'timezone' => :'timezone',
    :'slack_channel' => :'slackChannel',
    :'slack_token' => :'slackToken',
    :'last_seen_time' => :'lastSeenTime',
    :'updated_at' => :'updatedAt',
    :'created_at' => :'createdAt',
    :'email_suppression_status' => :'emailSuppressionStatus'
  }
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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 223

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



100
101
102
103
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 82

def self.openapi_types
  {
    :'id' => :'String',
    :'email' => :'String',
    :'number' => :'String',
    :'push_tokens' => :'Array<GetUsersResponseUsersInnerPushTokensInner>',
    :'web_push_tokens' => :'Array<GetUsersResponseUsersInnerWebPushTokensInner>',
    :'timezone' => :'String',
    :'slack_channel' => :'String',
    :'slack_token' => :'GetUsersResponseUsersInnerSlackToken',
    :'last_seen_time' => :'String',
    :'updated_at' => :'String',
    :'created_at' => :'String',
    :'email_suppression_status' => :'GetUsersResponseUsersInnerEmailSuppressionStatus'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 191

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      email == o.email &&
      number == o.number &&
      push_tokens == o.push_tokens &&
      web_push_tokens == o.web_push_tokens &&
      timezone == o.timezone &&
      slack_channel == o.slack_channel &&
      slack_token == o.slack_token &&
      last_seen_time == o.last_seen_time &&
      updated_at == o.updated_at &&
      created_at == o.created_at &&
      email_suppression_status == o.email_suppression_status
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


210
211
212
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 210

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



216
217
218
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 216

def hash
  [id, email, number, push_tokens, web_push_tokens, timezone, slack_channel, slack_token, last_seen_time, updated_at, created_at, email_suppression_status].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



176
177
178
179
180
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 176

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 245

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



184
185
186
187
 
# File 'lib/pingram/models/sender_post_body_to.rb', line 184

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end