Class: TCAClient::SubmissionCompleteWebhookRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/tca_client/models/submission_complete_webhook_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubmissionCompleteWebhookRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 132

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TCAClient::SubmissionCompleteWebhookRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TCAClient::SubmissionCompleteWebhookRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#capabilities ⇒ Object

Set of capabilities available to the current submission



49
50
51
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 49

def capabilities
  @capabilities
end

#character_count ⇒ Object

the number of characters in the submission



40
41
42
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 40

def character_count
  @character_count
end

#content_type ⇒ Object

the content type of the submission



31
32
33
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 31

def content_type
  @content_type
end

#created_time ⇒ Object

RFC3339 timestamp of when this submission was initially created. This is the time at which the POST to /submissions was made.



46
47
48
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 46

def created_time
  @created_time
end

#error_code ⇒ Object

an error code representing the type of error encountered (if applicable)



43
44
45
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 43

def error_code
  @error_code
end

#id ⇒ Object

the unique ID of the submission



28
29
30
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 28

def id
  @id
end

#metadata ⇒ Object

Returns the value of attribute metadata.



51
52
53
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 51

def metadata
  @metadata
end

#owner ⇒ Object

the owner of the submission



19
20
21
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 19

def owner
  @owner
end

#page_count ⇒ Object

the number of pages in the submission



34
35
36
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 34

def page_count
  @page_count
end

#status ⇒ Object

the current status of the Submission



25
26
27
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 25

def status
  @status
end

#title ⇒ Object

the title of the submission



22
23
24
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 22

def title
  @title
end

#word_count ⇒ Object

the number of words in the submission



37
38
39
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 37

def word_count
  @word_count
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



94
95
96
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 76

def self.attribute_map
  {
    :'owner' => :'owner',
    :'title' => :'title',
    :'status' => :'status',
    :'id' => :'id',
    :'content_type' => :'content_type',
    :'page_count' => :'page_count',
    :'word_count' => :'word_count',
    :'character_count' => :'character_count',
    :'error_code' => :'error_code',
    :'created_time' => :'created_time',
    :'capabilities' => :'capabilities',
    :'metadata' => :'metadata'
  }
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



267
268
269
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 267

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



123
124
125
126
127
128
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 123

def self.openapi_all_of
  [
  :'Submission',
  :'SubmissionCompleteWebhookRequestAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



117
118
119
120
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 117

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

.openapi_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 99

def self.openapi_types
  {
    :'owner' => :'String',
    :'title' => :'String',
    :'status' => :'String',
    :'id' => :'String',
    :'content_type' => :'String',
    :'page_count' => :'Integer',
    :'word_count' => :'Integer',
    :'character_count' => :'Integer',
    :'error_code' => :'String',
    :'created_time' => :'Time',
    :'capabilities' => :'Array<String>',
    :'metadata' => :'SubmissionCompleteWebhookRequestAllOfMetadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 235

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      owner == o.owner &&
      title == o.title &&
      status == o.status &&
      id == o.id &&
      content_type == o.content_type &&
      page_count == o.page_count &&
      word_count == o.word_count &&
      character_count == o.character_count &&
      error_code == o.error_code &&
      created_time == o.created_time &&
      capabilities == o.capabilities &&
      metadata == o.metadata
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



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
332
333
334
335
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 298

def _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 = TCAClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 369

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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 274

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


254
255
256
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



260
261
262
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 260

def hash
  [owner, title, status, id, content_type, page_count, word_count, character_count, error_code, created_time, capabilities, metadata].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



198
199
200
201
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 198

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



345
346
347
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 345

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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 351

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

Returns:

  • (String) —

    String presentation of the object



339
340
341
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 339

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



205
206
207
208
209
210
211
 
# File 'lib/tca_client/models/submission_complete_webhook_request.rb', line 205

def valid?
  status_validator = EnumAttributeValidator.new('String', ["CREATED", "PROCESSING", "COMPLETE", "DELETED", "ERROR"])
  return false unless status_validator.valid?(@status)
  error_code_validator = EnumAttributeValidator.new('String', ["UNSUPPORTED_FILETYPE", "PROCESSING_ERROR", "CANNOT_EXTRACT_TEXT", "TOO_LITTLE_TEXT", "TOO_MUCH_TEXT", "TOO_MANY_PAGES", "FILE_LOCKED", "CORRUPT_FILE"])
  return false unless error_code_validator.valid?(@error_code)
  true
end