Class: TripletexApi::Subscription
- Inherits:
-
Object
- Object
- TripletexApi::Subscription
- Defined in:
- lib/tripletex_api/models/subscription.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#changes ⇒ Object
Returns the value of attribute changes.
-
#event ⇒ Object
Event name (from v2/event) you wish to subscribe to.
-
#fields ⇒ Object
The fields in the object delivered with the notification callback, nested as in other API calls.
-
#id ⇒ Object
Returns the value of attribute id.
-
#status ⇒ Object
The status of the subscription.
-
#target_url ⇒ Object
The callback URL used for subscriptions (including authentication tokens).
-
#url ⇒ Object
Returns the value of attribute url.
-
#version ⇒ Object
Returns the value of attribute version.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Subscription
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Subscription
Initializes the object
90 91 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 |
# File 'lib/tripletex_api/models/subscription.rb', line 90 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 end |
Instance Attribute Details
#changes ⇒ Object
Returns the value of attribute changes.
22 23 24 |
# File 'lib/tripletex_api/models/subscription.rb', line 22 def changes @changes end |
#event ⇒ Object
Event name (from v2/event) you wish to subscribe to. Form should be: subject.verb.
27 28 29 |
# File 'lib/tripletex_api/models/subscription.rb', line 27 def event @event end |
#fields ⇒ Object
The fields in the object delivered with the notification callback, nested as in other API calls.
33 34 35 |
# File 'lib/tripletex_api/models/subscription.rb', line 33 def fields @fields end |
#id ⇒ Object
Returns the value of attribute id.
18 19 20 |
# File 'lib/tripletex_api/models/subscription.rb', line 18 def id @id end |
#status ⇒ Object
The status of the subscription.
36 37 38 |
# File 'lib/tripletex_api/models/subscription.rb', line 36 def status @status end |
#target_url ⇒ Object
The callback URL used for subscriptions (including authentication tokens). Must be absolute and use HTTPS.
30 31 32 |
# File 'lib/tripletex_api/models/subscription.rb', line 30 def target_url @target_url end |
#url ⇒ Object
Returns the value of attribute url.
24 25 26 |
# File 'lib/tripletex_api/models/subscription.rb', line 24 def url @url end |
#version ⇒ Object
Returns the value of attribute version.
20 21 22 |
# File 'lib/tripletex_api/models/subscription.rb', line 20 def version @version end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/tripletex_api/models/subscription.rb', line 61 def self.attribute_map { :'id' => :'id', :'version' => :'version', :'changes' => :'changes', :'url' => :'url', :'event' => :'event', :'target_url' => :'targetUrl', :'fields' => :'fields', :'status' => :'status' } end |
.swagger_types ⇒ Object
Attribute type mapping.
75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/tripletex_api/models/subscription.rb', line 75 def self.swagger_types { :'id' => :'Integer', :'version' => :'Integer', :'changes' => :'Array<Change>', :'url' => :'String', :'event' => :'String', :'target_url' => :'String', :'fields' => :'String', :'status' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
246 247 248 249 250 251 252 253 254 255 256 257 |
# File 'lib/tripletex_api/models/subscription.rb', line 246 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 end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 |
# File 'lib/tripletex_api/models/subscription.rb', line 295 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 = TripletexApi.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
361 362 363 364 365 366 367 368 369 370 371 372 373 |
# File 'lib/tripletex_api/models/subscription.rb', line 361 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
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 |
# File 'lib/tripletex_api/models/subscription.rb', line 274 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 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
261 262 263 |
# File 'lib/tripletex_api/models/subscription.rb', line 261 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
267 268 269 |
# File 'lib/tripletex_api/models/subscription.rb', line 267 def hash [id, version, changes, url, event, target_url, fields, status].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 |
# File 'lib/tripletex_api/models/subscription.rb', line 134 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 !@status.nil? && @status.to_s.length > 50 invalid_properties.push("invalid value for 'status', the character length must be smaller than or equal to 50.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
341 342 343 |
# File 'lib/tripletex_api/models/subscription.rb', line 341 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
347 348 349 350 351 352 353 354 355 |
# File 'lib/tripletex_api/models/subscription.rb', line 347 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
335 336 337 |
# File 'lib/tripletex_api/models/subscription.rb', line 335 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/tripletex_api/models/subscription.rb', line 173 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 !@status.nil? && @status.to_s.length > 50 return true end |