Class: ApimaticApi::Transformation

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/apimatic_api/models/transformation.rb

Overview

Transformation structure encapsulates all the details of a Transformation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(id:, transformed_on:, user_id:, inputted_file:, generated_file:, export_format:, transformation_source:, transformation_input:, code_gen_version:, success:, import_summary:, api_validation_summary:, additional_properties: nil) ⇒ Transformation

Returns a new instance of Transformation.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/apimatic_api/models/transformation.rb', line 88

def initialize(id:, transformed_on:, user_id:, inputted_file:,
               generated_file:, export_format:, transformation_source:,
               transformation_input:, code_gen_version:, success:,
               import_summary:, api_validation_summary:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @id = id
  @transformed_on = transformed_on
  @user_id = user_id
  @inputted_file = inputted_file
  @generated_file = generated_file
  @export_format = export_format
  @transformation_source = transformation_source
  @transformation_input = transformation_input
  @code_gen_version = code_gen_version
  @success = success
  @import_summary = import_summary
  @api_validation_summary = api_validation_summary
  @additional_properties = additional_properties
end

Instance Attribute Details

#api_validation_summary ⇒ ApiValidationSummary

Successful Transformation Flag

Returns:



58
59
60
 
# File 'lib/apimatic_api/models/transformation.rb', line 58

def api_validation_summary
  @api_validation_summary
end

#code_gen_version ⇒ String

CodeGen Engine Version

Returns:

  • (String) 


46
47
48
 
# File 'lib/apimatic_api/models/transformation.rb', line 46

def code_gen_version
  @code_gen_version
end

#export_format ⇒ String

Desired Specification format

Returns:

  • (String) 


34
35
36
 
# File 'lib/apimatic_api/models/transformation.rb', line 34

def export_format
  @export_format
end

#generated_file ⇒ String

API Specification file transformed to desired format

Returns:

  • (String) 


30
31
32
 
# File 'lib/apimatic_api/models/transformation.rb', line 30

def generated_file
  @generated_file
end

#id ⇒ String

Unique Transformation Identifier

Returns:

  • (String) 


14
15
16
 
# File 'lib/apimatic_api/models/transformation.rb', line 14

def id
  @id
end

#import_summary ⇒ ApiValidationSummary

Successful Transformation Flag

Returns:



54
55
56
 
# File 'lib/apimatic_api/models/transformation.rb', line 54

def import_summary
  @import_summary
end

#inputted_file ⇒ String

API Specification file to be transformed

Returns:

  • (String) 


26
27
28
 
# File 'lib/apimatic_api/models/transformation.rb', line 26

def inputted_file
  @inputted_file
end

#success ⇒ TrueClass | FalseClass

Successful Transformation Flag

Returns:

  • (TrueClass | FalseClass) 


50
51
52
 
# File 'lib/apimatic_api/models/transformation.rb', line 50

def success
  @success
end

#transformation_input ⇒ String

Via File or URL

Returns:

  • (String) 


42
43
44
 
# File 'lib/apimatic_api/models/transformation.rb', line 42

def transformation_input
  @transformation_input
end

#transformation_source ⇒ String

Source of Transformation

Returns:

  • (String) 


38
39
40
 
# File 'lib/apimatic_api/models/transformation.rb', line 38

def transformation_source
  @transformation_source
end

#transformed_on ⇒ String

Transformation Date and Time

Returns:

  • (String) 


18
19
20
 
# File 'lib/apimatic_api/models/transformation.rb', line 18

def transformed_on
  @transformed_on
end

#user_id ⇒ String

Unique User Identifier

Returns:

  • (String) 


22
23
24
 
# File 'lib/apimatic_api/models/transformation.rb', line 22

def user_id
  @user_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
147
148
149
150
151
152
153
154
155
 
# File 'lib/apimatic_api/models/transformation.rb', line 112

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  id = hash.key?('id') ? hash['id'] : nil
  transformed_on = hash.key?('transformedOn') ? hash['transformedOn'] : nil
  user_id = hash.key?('userId') ? hash['userId'] : nil
  inputted_file = hash.key?('inputtedFile') ? hash['inputtedFile'] : nil
  generated_file = hash.key?('generatedFile') ? hash['generatedFile'] : nil
  export_format = hash.key?('exportFormat') ? hash['exportFormat'] : nil
  transformation_source =
    hash.key?('transformationSource') ? hash['transformationSource'] : nil
  transformation_input =
    hash.key?('transformationInput') ? hash['transformationInput'] : nil
  code_gen_version =
    hash.key?('codeGenVersion') ? hash['codeGenVersion'] : nil
  success = hash.key?('success') ? hash['success'] : nil
  import_summary = ApiValidationSummary.from_hash(hash['importSummary']) if
    hash['importSummary']
  api_validation_summary = ApiValidationSummary.from_hash(hash['apiValidationSummary']) if
    hash['apiValidationSummary']

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  Transformation.new(id: id,
                     transformed_on: transformed_on,
                     user_id: user_id,
                     inputted_file: inputted_file,
                     generated_file: generated_file,
                     export_format: export_format,
                     transformation_source: transformation_source,
                     transformation_input: transformation_input,
                     code_gen_version: code_gen_version,
                     success: success,
                     import_summary: import_summary,
                     api_validation_summary: api_validation_summary,
                     additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/apimatic_api/models/transformation.rb', line 61

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['id'] = 'id'
  @_hash['transformed_on'] = 'transformedOn'
  @_hash['user_id'] = 'userId'
  @_hash['inputted_file'] = 'inputtedFile'
  @_hash['generated_file'] = 'generatedFile'
  @_hash['export_format'] = 'exportFormat'
  @_hash['transformation_source'] = 'transformationSource'
  @_hash['transformation_input'] = 'transformationInput'
  @_hash['code_gen_version'] = 'codeGenVersion'
  @_hash['success'] = 'success'
  @_hash['import_summary'] = 'importSummary'
  @_hash['api_validation_summary'] = 'apiValidationSummary'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



84
85
86
 
# File 'lib/apimatic_api/models/transformation.rb', line 84

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



79
80
81
 
# File 'lib/apimatic_api/models/transformation.rb', line 79

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/apimatic_api/models/transformation.rb', line 169

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} id: #{@id.inspect}, transformed_on: #{@transformed_on.inspect}, user_id:"\
  " #{@user_id.inspect}, inputted_file: #{@inputted_file.inspect}, generated_file:"\
  " #{@generated_file.inspect}, export_format: #{@export_format.inspect},"\
  " transformation_source: #{@transformation_source.inspect}, transformation_input:"\
  " #{@transformation_input.inspect}, code_gen_version: #{@code_gen_version.inspect}, success:"\
  " #{@success.inspect}, import_summary: #{@import_summary.inspect}, api_validation_summary:"\
  " #{@api_validation_summary.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



158
159
160
161
162
163
164
165
166
 
# File 'lib/apimatic_api/models/transformation.rb', line 158

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} id: #{@id}, transformed_on: #{@transformed_on}, user_id: #{@user_id},"\
  " inputted_file: #{@inputted_file}, generated_file: #{@generated_file}, export_format:"\
  " #{@export_format}, transformation_source: #{@transformation_source}, transformation_input:"\
  " #{@transformation_input}, code_gen_version: #{@code_gen_version}, success: #{@success},"\
  " import_summary: #{@import_summary}, api_validation_summary: #{@api_validation_summary},"\
  " additional_properties: #{@additional_properties}>"
end