Class: UltracartClient::Webhook

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/webhook.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Webhook

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/ultracart_api/models/webhook.rb', line 142

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'api_user_oid')
    self.api_user_oid = attributes[:'api_user_oid']
  end

  if attributes.has_key?(:'api_version')
    self.api_version = attributes[:'api_version']
  end

  if attributes.has_key?(:'application_profile')
    self.application_profile = attributes[:'application_profile']
  end

  if attributes.has_key?(:'authentication_type')
    self.authentication_type = attributes[:'authentication_type']
  end

  if attributes.has_key?(:'basic_password')
    self.basic_password = attributes[:'basic_password']
  end

  if attributes.has_key?(:'basic_username')
    self.basic_username = attributes[:'basic_username']
  end

  if attributes.has_key?(:'consecutive_failures')
    self.consecutive_failures = attributes[:'consecutive_failures']
  end

  if attributes.has_key?(:'disabled')
    self.disabled = attributes[:'disabled']
  end

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

  if attributes.has_key?(:'iam_access_key')
    self.iam_access_key = attributes[:'iam_access_key']
  end

  if attributes.has_key?(:'iam_secret_key')
    self.iam_secret_key = attributes[:'iam_secret_key']
  end

  if attributes.has_key?(:'maximum_events')
    self.maximum_events = attributes[:'maximum_events']
  end

  if attributes.has_key?(:'maximum_size')
    self.maximum_size = attributes[:'maximum_size']
  end

  if attributes.has_key?(:'merchant_id')
    self.merchant_id = attributes[:'merchant_id']
  end

  if attributes.has_key?(:'next_retry_after')
    self.next_retry_after = attributes[:'next_retry_after']
  end

  if attributes.has_key?(:'pending')
    self.pending = attributes[:'pending']
  end

  if attributes.has_key?(:'webhook_oid')
    self.webhook_oid = attributes[:'webhook_oid']
  end

  if attributes.has_key?(:'webhook_url')
    self.webhook_url = attributes[:'webhook_url']
  end
end

Instance Attribute Details

#api_user_oid ⇒ Object

Populated if webhook associated with an API user



18
19
20
 
# File 'lib/ultracart_api/models/webhook.rb', line 18

def api_user_oid
  @api_user_oid
end

#api_version ⇒ Object

Version of the API objects that are sent in notifications



21
22
23
 
# File 'lib/ultracart_api/models/webhook.rb', line 21

def api_version
  @api_version
end

#application_profile ⇒ Object

Returns the value of attribute application_profile.



23
24
25
 
# File 'lib/ultracart_api/models/webhook.rb', line 23

def application_profile
  @application_profile
end

#authentication_type ⇒ Object

The type of authentication this webhook will use when communicating with your server



26
27
28
 
# File 'lib/ultracart_api/models/webhook.rb', line 26

def authentication_type
  @authentication_type
end

#basic_password ⇒ Object

Basic authentication password



29
30
31
 
# File 'lib/ultracart_api/models/webhook.rb', line 29

def basic_password
  @basic_password
end

#basic_username ⇒ Object

Basic authentication user name



32
33
34
 
# File 'lib/ultracart_api/models/webhook.rb', line 32

def basic_username
  @basic_username
end

#consecutive_failures ⇒ Object

The number of consecutive failures that have occurred trying to deliver notifications to the target server



35
36
37
 
# File 'lib/ultracart_api/models/webhook.rb', line 35

def consecutive_failures
  @consecutive_failures
end

#disabled ⇒ Object

True if the webhook has been disabled



38
39
40
 
# File 'lib/ultracart_api/models/webhook.rb', line 38

def disabled
  @disabled
end

#event_categories ⇒ Object

The categories of events. Individual events and subscriptions are handled in the child objects. _placeholders parameter effects the population of this on a retrieval.



41
42
43
 
# File 'lib/ultracart_api/models/webhook.rb', line 41

def event_categories
  @event_categories
end

#iam_access_key ⇒ Object

IAM Access Key for AWS SQS Delivery



44
45
46
 
# File 'lib/ultracart_api/models/webhook.rb', line 44

def iam_access_key
  @iam_access_key
end

#iam_secret_key ⇒ Object

IAM Secret Key for AWS SQS Delivery



47
48
49
 
# File 'lib/ultracart_api/models/webhook.rb', line 47

def iam_secret_key
  @iam_secret_key
end

#maximum_events ⇒ Object

The maximum number of events in the payload that UltraCart will deliver



50
51
52
 
# File 'lib/ultracart_api/models/webhook.rb', line 50

def maximum_events
  @maximum_events
end

#maximum_size ⇒ Object

The maximum size of the payload that UltraCart will deliver



53
54
55
 
# File 'lib/ultracart_api/models/webhook.rb', line 53

def maximum_size
  @maximum_size
end

#merchant_id ⇒ Object

The UltraCart merchant ID that owns this webhook



56
57
58
 
# File 'lib/ultracart_api/models/webhook.rb', line 56

def merchant_id
  @merchant_id
end

#next_retry_after ⇒ Object

The next time UltraCart will attempt delivery if failures have been occurring



59
60
61
 
# File 'lib/ultracart_api/models/webhook.rb', line 59

def next_retry_after
  @next_retry_after
end

#pending ⇒ Object

The number of pending events for this webhook



62
63
64
 
# File 'lib/ultracart_api/models/webhook.rb', line 62

def pending
  @pending
end

#webhook_oid ⇒ Object

The object identifier for this webhook



65
66
67
 
# File 'lib/ultracart_api/models/webhook.rb', line 65

def webhook_oid
  @webhook_oid
end

#webhook_url ⇒ Object

The URL to deliver events to. Must be HTTPS for customer related information.



68
69
70
 
# File 'lib/ultracart_api/models/webhook.rb', line 68

def webhook_url
  @webhook_url
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'api_user_oid' => :'api_user_oid',
    :'api_version' => :'api_version',
    :'application_profile' => :'application_profile',
    :'authentication_type' => :'authentication_type',
    :'basic_password' => :'basic_password',
    :'basic_username' => :'basic_username',
    :'consecutive_failures' => :'consecutive_failures',
    :'disabled' => :'disabled',
    :'event_categories' => :'event_categories',
    :'iam_access_key' => :'iam_access_key',
    :'iam_secret_key' => :'iam_secret_key',
    :'maximum_events' => :'maximum_events',
    :'maximum_size' => :'maximum_size',
    :'merchant_id' => :'merchant_id',
    :'next_retry_after' => :'next_retry_after',
    :'pending' => :'pending',
    :'webhook_oid' => :'webhook_oid',
    :'webhook_url' => :'webhook_url'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/ultracart_api/models/webhook.rb', line 117

def self.swagger_types
  {
    :'api_user_oid' => :'Integer',
    :'api_version' => :'String',
    :'application_profile' => :'ApiUserApplicationProfile',
    :'authentication_type' => :'String',
    :'basic_password' => :'String',
    :'basic_username' => :'String',
    :'consecutive_failures' => :'Integer',
    :'disabled' => :'BOOLEAN',
    :'event_categories' => :'Array<WebhookEventCategory>',
    :'iam_access_key' => :'String',
    :'iam_secret_key' => :'String',
    :'maximum_events' => :'Integer',
    :'maximum_size' => :'Integer',
    :'merchant_id' => :'String',
    :'next_retry_after' => :'String',
    :'pending' => :'Integer',
    :'webhook_oid' => :'Integer',
    :'webhook_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/ultracart_api/models/webhook.rb', line 262

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      api_user_oid == o.api_user_oid &&
      api_version == o.api_version &&
      application_profile == o.application_profile &&
      authentication_type == o.authentication_type &&
      basic_password == o.basic_password &&
      basic_username == o.basic_username &&
      consecutive_failures == o.consecutive_failures &&
      disabled == o.disabled &&
      event_categories == o.event_categories &&
      iam_access_key == o.iam_access_key &&
      iam_secret_key == o.iam_secret_key &&
      maximum_events == o.maximum_events &&
      maximum_size == o.maximum_size &&
      merchant_id == o.merchant_id &&
      next_retry_after == o.next_retry_after &&
      pending == o.pending &&
      webhook_oid == o.webhook_oid &&
      webhook_url == o.webhook_url
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/ultracart_api/models/webhook.rb', line 321

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = UltracartClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/ultracart_api/models/webhook.rb', line 387

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

#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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/ultracart_api/models/webhook.rb', line 300

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


287
288
289
 
# File 'lib/ultracart_api/models/webhook.rb', line 287

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



293
294
295
 
# File 'lib/ultracart_api/models/webhook.rb', line 293

def hash
  [api_user_oid, api_version, application_profile, authentication_type, basic_password, basic_username, consecutive_failures, disabled, event_categories, iam_access_key, iam_secret_key, maximum_events, maximum_size, merchant_id, next_retry_after, pending, webhook_oid, webhook_url].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



225
226
227
228
 
# File 'lib/ultracart_api/models/webhook.rb', line 225

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



367
368
369
 
# File 'lib/ultracart_api/models/webhook.rb', line 367

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



373
374
375
376
377
378
379
380
381
 
# File 'lib/ultracart_api/models/webhook.rb', line 373

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



361
362
363
 
# File 'lib/ultracart_api/models/webhook.rb', line 361

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



232
233
234
235
236
237
238
 
# File 'lib/ultracart_api/models/webhook.rb', line 232

def valid?
  api_version_validator = EnumAttributeValidator.new('String', ['2017-03-01'])
  return false unless api_version_validator.valid?(@api_version)
  authentication_type_validator = EnumAttributeValidator.new('String', ['none', 'basic'])
  return false unless authentication_type_validator.valid?(@authentication_type)
  true
end