Class: TripletexRubyClient::Subscription

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/models/subscription.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Subscription

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 99

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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auth_header_name ⇒ Object

Custom authentication header name



38
39
40
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 38

def auth_header_name
  @auth_header_name
end

#auth_header_value ⇒ Object

Custom authentication header value (write only)



41
42
43
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 41

def auth_header_value
  @auth_header_value
end

#changes ⇒ Object

Returns the value of attribute changes.



21
22
23
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 21

def changes
  @changes
end

#event ⇒ Object

Event name (from /v2/event) you wish to subscribe to. Form should be: subject.verb.



26
27
28
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 26

def event
  @event
end

#fields ⇒ Object

The fields in the object delivered with the notification callback, nested as in other API calls.



32
33
34
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 32

def fields
  @fields
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 17

def id
  @id
end

#status ⇒ Object

The status of the subscription.



35
36
37
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 35

def status
  @status
end

#target_url ⇒ Object

The callback URL used for subscriptions (including authentication tokens). Must be absolute and use HTTPS. Basic authentication is supported.



29
30
31
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 29

def target_url
  @target_url
end

#url ⇒ Object

Returns the value of attribute url.



23
24
25
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 23

def url
  @url
end

#version ⇒ Object

Returns the value of attribute version.



19
20
21
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 19

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 66

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'event' => :'event',
    :'target_url' => :'targetUrl',
    :'fields' => :'fields',
    :'status' => :'status',
    :'auth_header_name' => :'authHeaderName',
    :'auth_header_value' => :'authHeaderValue'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'event' => :'String',
    :'target_url' => :'String',
    :'fields' => :'String',
    :'status' => :'String',
    :'auth_header_name' => :'String',
    :'auth_header_value' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 286

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      event == o.event &&
      target_url == o.target_url &&
      fields == o.fields &&
      status == o.status &&
      auth_header_name == o.auth_header_name &&
      auth_header_value == o.auth_header_value
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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 337

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 = TripletexRubyClient.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



403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 403

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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 316

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


303
304
305
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 303

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



309
310
311
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 309

def hash
  [id, version, changes, url, event, target_url, fields, status, auth_header_name, auth_header_value].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



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
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 150

def list_invalid_properties
  invalid_properties = Array.new
  if @event.nil?
    invalid_properties.push('invalid value for "event", event cannot be nil.')
  end

  if @event.to_s.length > 255
    invalid_properties.push('invalid value for "event", the character length must be smaller than or equal to 255.')
  end

  if @event.to_s.length < 1
    invalid_properties.push('invalid value for "event", the character length must be great than or equal to 1.')
  end

  if @target_url.nil?
    invalid_properties.push('invalid value for "target_url", target_url cannot be nil.')
  end

  if @target_url.to_s.length > 255
    invalid_properties.push('invalid value for "target_url", the character length must be smaller than or equal to 255.')
  end

  if @target_url.to_s.length < 1
    invalid_properties.push('invalid value for "target_url", the character length must be great than or equal to 1.')
  end

  if !@fields.nil? && @fields.to_s.length > 255
    invalid_properties.push('invalid value for "fields", the character length must be smaller than or equal to 255.')
  end

  if !@auth_header_name.nil? && @auth_header_name.to_s.length > 255
    invalid_properties.push('invalid value for "auth_header_name", the character length must be smaller than or equal to 255.')
  end

  if !@auth_header_value.nil? && @auth_header_value.to_s.length > 4096
    invalid_properties.push('invalid value for "auth_header_value", the character length must be smaller than or equal to 4096.')
  end

  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



383
384
385
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 383

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



389
390
391
392
393
394
395
396
397
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 389

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



377
378
379
 
# File 'lib/tripletex_ruby_client/models/subscription.rb', line 377

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



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

def valid?
  return false if @event.nil?
  return false if @event.to_s.length > 255
  return false if @event.to_s.length < 1
  return false if @target_url.nil?
  return false if @target_url.to_s.length > 255
  return false if @target_url.to_s.length < 1
  return false if !@fields.nil? && @fields.to_s.length > 255
  status_validator = EnumAttributeValidator.new('String', ['ACTIVE', 'DISABLED', 'DISABLED_TOO_MANY_ERRORS', 'DISABLED_RATE_LIMIT_EXCEEDED', 'DISABLED_MISUSE'])
  return false unless status_validator.valid?(@status)
  return false if !@auth_header_name.nil? && @auth_header_name.to_s.length > 255
  return false if !@auth_header_value.nil? && @auth_header_value.to_s.length > 4096
  true
end