Class: Sendpost::CreateWebhookRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/sendpost_ruby_sdk/models/create_webhook_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateWebhookRequest

Initializes the object



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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 123

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#clicked ⇒ Object

Trigger webhook on email message link being clicked.



43
44
45
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 43

def clicked
  @clicked
end

#delivered ⇒ Object

Trigger webhook on email message being delivered.



28
29
30
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 28

def delivered
  @delivered
end

#dropped ⇒ Object

Trigger webhook on email message being dropped.



31
32
33
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 31

def dropped
  @dropped
end

#enabled ⇒ Object

Is the webhook active or in a paused state?



19
20
21
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 19

def enabled
  @enabled
end

#hard_bounced ⇒ Object

Trigger webhook on email message being hard bounced.



37
38
39
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 37

def hard_bounced
  @hard_bounced
end

#opened ⇒ Object

Trigger webhook on email message being opened.



40
41
42
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 40

def opened
  @opened
end

#processed ⇒ Object

Trigger webhook on email message being processed.



25
26
27
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 25

def processed
  @processed
end

#sent ⇒ Object

Trigger webhook on email message being sent.



52
53
54
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 52

def sent
  @sent
end

#smtp_dropped ⇒ Object

Trigger webhook on email message being dropped by SMTP.



55
56
57
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 55

def smtp_dropped
  @smtp_dropped
end

#soft_bounced ⇒ Object

Trigger webhook on email message being soft bounced.



34
35
36
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 34

def soft_bounced
  @soft_bounced
end

#spam ⇒ Object

Trigger webhook on email message being marked as spam.



49
50
51
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 49

def spam
  @spam
end

#unique_click ⇒ Object

Trigger webhook on unique email clicks.



61
62
63
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 61

def unique_click
  @unique_click
end

#unique_open ⇒ Object

Trigger webhook on unique email opens.



58
59
60
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 58

def unique_open
  @unique_open
end

#unsubscribed ⇒ Object

Trigger webhook on email message being unsubscribed.



46
47
48
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 46

def unsubscribed
  @unsubscribed
end

#url ⇒ Object

URL endpoint to which webhook calls are sent.



22
23
24
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 22

def url
  @url
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 274

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Sendpost.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



85
86
87
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 85

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 90

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 64

def self.attribute_map
  {
    :'enabled' => :'enabled',
    :'url' => :'url',
    :'processed' => :'processed',
    :'delivered' => :'delivered',
    :'dropped' => :'dropped',
    :'soft_bounced' => :'softBounced',
    :'hard_bounced' => :'hardBounced',
    :'opened' => :'opened',
    :'clicked' => :'clicked',
    :'unsubscribed' => :'unsubscribed',
    :'spam' => :'spam',
    :'sent' => :'sent',
    :'smtp_dropped' => :'smtpDropped',
    :'unique_open' => :'uniqueOpen',
    :'unique_click' => :'uniqueClick'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 250

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



116
117
118
119
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 116

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

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 95

def self.openapi_types
  {
    :'enabled' => :'Boolean',
    :'url' => :'String',
    :'processed' => :'Boolean',
    :'delivered' => :'Boolean',
    :'dropped' => :'Boolean',
    :'soft_bounced' => :'Boolean',
    :'hard_bounced' => :'Boolean',
    :'opened' => :'Boolean',
    :'clicked' => :'Boolean',
    :'unsubscribed' => :'Boolean',
    :'spam' => :'Boolean',
    :'sent' => :'Boolean',
    :'smtp_dropped' => :'Boolean',
    :'unique_open' => :'Boolean',
    :'unique_click' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 215

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      enabled == o.enabled &&
      url == o.url &&
      processed == o.processed &&
      delivered == o.delivered &&
      dropped == o.dropped &&
      soft_bounced == o.soft_bounced &&
      hard_bounced == o.hard_bounced &&
      opened == o.opened &&
      clicked == o.clicked &&
      unsubscribed == o.unsubscribed &&
      spam == o.spam &&
      sent == o.sent &&
      smtp_dropped == o.smtp_dropped &&
      unique_open == o.unique_open &&
      unique_click == o.unique_click
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 345

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


237
238
239
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 237

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



243
244
245
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 243

def hash
  [enabled, url, processed, delivered, dropped, soft_bounced, hard_bounced, opened, clicked, unsubscribed, spam, sent, smtp_dropped, unique_open, unique_click].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



200
201
202
203
204
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 200

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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



321
322
323
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 321

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 327

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

#to_s ⇒ String

Returns the string representation of the object



315
316
317
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 315

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



208
209
210
211
 
# File 'lib/sendpost_ruby_sdk/models/create_webhook_request.rb', line 208

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