Class: Pingram::PostUserRequest

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

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 = {}) ⇒ PostUserRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
139
140
141
142
143
144
145
146
147
 
# File 'lib/pingram/models/post_user_request.rb', line 92

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

Instance Attribute Details

#email ⇒ Object

User's email address for email notifications.



22
23
24
 
# File 'lib/pingram/models/post_user_request.rb', line 22

def email
  @email
end

#id ⇒ Object

Unique user identifier. Required.



19
20
21
 
# File 'lib/pingram/models/post_user_request.rb', line 19

def id
  @id
end

#number ⇒ Object

User's phone number for SMS/call notifications.



25
26
27
 
# File 'lib/pingram/models/post_user_request.rb', line 25

def number
  @number
end

#properties ⇒ Object

Custom key-value properties synced by the developer, used for audience segmentation (e.g. broadcast filters on user.properties.plan). Incremental identify calls shallow-merge keys (unset keys are preserved). Limits: max 25 keys, key length <= 64, string values <= 256 chars, serialized size <= 1KB.



42
43
44
 
# File 'lib/pingram/models/post_user_request.rb', line 42

def properties
  @properties
end

#push_tokens ⇒ Object

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



28
29
30
 
# File 'lib/pingram/models/post_user_request.rb', line 28

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"



37
38
39
 
# File 'lib/pingram/models/post_user_request.rb', line 37

def slack_channel
  @slack_channel
end

#slack_token ⇒ Object

Returns the value of attribute slack_token.



39
40
41
 
# File 'lib/pingram/models/post_user_request.rb', line 39

def slack_token
  @slack_token
end

#timezone ⇒ Object

User's timezone (e.g. "America/New_York") for scheduling.



34
35
36
 
# File 'lib/pingram/models/post_user_request.rb', line 34

def timezone
  @timezone
end

#web_push_tokens ⇒ Object

Web push subscription config from the browser.



31
32
33
 
# File 'lib/pingram/models/post_user_request.rb', line 31

def web_push_tokens
  @web_push_tokens
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



60
61
62
 
# File 'lib/pingram/models/post_user_request.rb', line 60

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



65
66
67
 
# File 'lib/pingram/models/post_user_request.rb', line 65

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/pingram/models/post_user_request.rb', line 45

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',
    :'properties' => :'properties'
  }
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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/pingram/models/post_user_request.rb', line 195

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



85
86
87
88
 
# File 'lib/pingram/models/post_user_request.rb', line 85

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

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/pingram/models/post_user_request.rb', line 70

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',
    :'properties' => :'Hash<String, GetUsersResponseUsersInnerPropertiesValue>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/pingram/models/post_user_request.rb', line 166

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 &&
      properties == o.properties
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


182
183
184
 
# File 'lib/pingram/models/post_user_request.rb', line 182

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



188
189
190
 
# File 'lib/pingram/models/post_user_request.rb', line 188

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



151
152
153
154
155
 
# File 'lib/pingram/models/post_user_request.rb', line 151

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



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/pingram/models/post_user_request.rb', line 217

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



159
160
161
162
 
# File 'lib/pingram/models/post_user_request.rb', line 159

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