sdksio-apimatic-sdk 3.0.0

data/lib/apimatic_api/models/paramter_format_details.rb

@@ -0,0 +1,48 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # ParamterFormatDetails Model.
+  class ParamterFormatDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Specify Parameter Format
+    # @return [String]
+    attr_accessor :param_format
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['param_format'] = 'ParamFormat'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(param_format = nil)
+      @param_format = param_format
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      param_format = hash.key?('ParamFormat') ? hash['ParamFormat'] : nil
+
+      # Create object from extracted values.
+      ParamterFormatDetails.new(param_format)
+    end
+  end
+end

data/lib/apimatic_api/models/platforms.rb

@@ -0,0 +1,39 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # The structure contains platforms that APIMatic CodeGen can generate SDKs and
+  # Docs in.
+  class Platforms
+    PLATFORMS = [
+      # .NET Standard Library
+      CS_NET_STANDARD_LIB = 'CS_NET_STANDARD_LIB'.freeze,
+
+      # JAVA
+      JAVA_ECLIPSE_JRE_LIB = 'JAVA_ECLIPSE_JRE_LIB'.freeze,
+
+      # PHP
+      PHP_GENERIC_LIB_V2 = 'PHP_GENERIC_LIB'.freeze,
+
+      # Python
+      PYTHON_GENERIC_LIB = 'PYTHON_GENERIC_LIB'.freeze,
+
+      # Ruby
+      RUBY_GENERIC_LIB = 'RUBY_GENERIC_LIB'.freeze,
+
+      # Typescript
+      TS_GENERIC_LIB = 'TS_GENERIC_LIB'.freeze,
+
+      # Go
+      GO_GENERIC_LIB = 'GO_GENERIC_LIB'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PLATFORMS.include?(value)
+    end
+  end
+end

data/lib/apimatic_api/models/platforms_template.rb

@@ -0,0 +1,49 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # PlatformsTemplate Model.
+  class PlatformsTemplate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The structure contains platforms that APIMatic CodeGen can generate SDKs
+    # and Docs in.
+    # @return [Platforms]
+    attr_accessor :template
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['template'] = 'template'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(template = Platforms::CS_NET_STANDARD_LIB)
+      @template = template
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      template = hash['template'] ||= Platforms::CS_NET_STANDARD_LIB
+
+      # Create object from extracted values.
+      PlatformsTemplate.new(template)
+    end
+  end
+end

data/lib/apimatic_api/models/server.rb

@@ -0,0 +1,69 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # The user can specify multiple servers within an environment. A server
+  # comprises of a name and a URL. The names of the hosts remain consistent over
+  # different environments but their values may vary. The URL values can contain
+  # any number of parameters defined.
+  class Server < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique Server identifier
+    # @return [String]
+    attr_accessor :id
+
+    # Server Name
+    # @return [String]
+    attr_accessor :name
+
+    # Server URL
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   name = nil,
+                   url = nil)
+      @id = id
+      @name = name
+      @url = url
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      url = hash.key?('url') ? hash['url'] : nil
+
+      # Create object from extracted values.
+      Server.new(id,
+                 name,
+                 url)
+    end
+  end
+end

data/lib/apimatic_api/models/server_configuration.rb

@@ -0,0 +1,105 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # Server configurations can be used to create multiple environments, multiple
+  # servers that can be used with specific endpoints and server URLs with
+  # template paramters.
+  class ServerConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Server Config Identifier
+    # @return [String]
+    attr_accessor :id
+
+    # Default Environment
+    # @return [String]
+    attr_accessor :default_environment
+
+    # Default Server
+    # @return [String]
+    attr_accessor :default_server
+
+    # Environment Identifier and Name
+    # @return [Array[Environment]]
+    attr_accessor :environments
+
+    # Parameter Attributes
+    # @return [Array[Parameter]]
+    attr_accessor :parameters
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['default_environment'] = 'defaultEnvironment'
+      @_hash['default_server'] = 'defaultServer'
+      @_hash['environments'] = 'environments'
+      @_hash['parameters'] = 'parameters'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   default_environment = nil,
+                   default_server = nil,
+                   environments = nil,
+                   parameters = nil)
+      @id = id
+      @default_environment = default_environment
+      @default_server = default_server
+      @environments = environments
+      @parameters = parameters
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      default_environment =
+        hash.key?('defaultEnvironment') ? hash['defaultEnvironment'] : nil
+      default_server = hash.key?('defaultServer') ? hash['defaultServer'] : nil
+      # Parameter is an array, so we need to iterate through it
+      environments = nil
+      unless hash['environments'].nil?
+        environments = []
+        hash['environments'].each do |structure|
+          environments << (Environment.from_hash(structure) if structure)
+        end
+      end
+
+      environments = nil unless hash.key?('environments')
+      # Parameter is an array, so we need to iterate through it
+      parameters = nil
+      unless hash['parameters'].nil?
+        parameters = []
+        hash['parameters'].each do |structure|
+          parameters << (Parameter.from_hash(structure) if structure)
+        end
+      end
+
+      parameters = nil unless hash.key?('parameters')
+
+      # Create object from extracted values.
+      ServerConfiguration.new(id,
+                              default_environment,
+                              default_server,
+                              environments,
+                              parameters)
+    end
+  end
+end

data/lib/apimatic_api/models/test_gen_settings.rb

@@ -0,0 +1,70 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # This structure helps specify additional test configurations which affects
+  # how test cases are generated.
+  class TestGenSettings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error margin for comparing values in decimal places
+    # @return [Float]
+    attr_accessor :precision_delta
+
+    # Number of seconds after which if the endpoint is not returning any
+    # response, the test is forced to fail e.g. a timeout of 60
+    # @return [Integer]
+    attr_accessor :test_timeout
+
+    # The parameters allows to provide values for configuration file for use in
+    # the test environment
+    # @return [Object]
+    attr_accessor :configuration
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['precision_delta'] = 'precisionDelta'
+      @_hash['test_timeout'] = 'testTimeout'
+      @_hash['configuration'] = 'configuration'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(precision_delta = nil,
+                   test_timeout = nil,
+                   configuration = nil)
+      @precision_delta = precision_delta
+      @test_timeout = test_timeout
+      @configuration = configuration
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      precision_delta =
+        hash.key?('precisionDelta') ? hash['precisionDelta'] : nil
+      test_timeout = hash.key?('testTimeout') ? hash['testTimeout'] : nil
+      configuration = hash.key?('configuration') ? hash['configuration'] : nil
+
+      # Create object from extracted values.
+      TestGenSettings.new(precision_delta,
+                          test_timeout,
+                          configuration)
+    end
+  end
+end

data/lib/apimatic_api/models/transform_via_file_request_body.rb

@@ -0,0 +1,61 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # TransformViaFileRequestBody Model.
+  class TransformViaFileRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The API specification file.<br>The type of the specification file should
+    # be any of the [supported
+    # formats](https://docs.apimatic.io/api-transformer/overview-transformer#sup
+    # ported-input-formats).
+    # @return [Binary]
+    attr_accessor :file
+
+    # The structure contains API specification formats that Transformer can
+    # convert to.
+    # @return [ExportFormats]
+    attr_accessor :export_format
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['file'] = 'file'
+      @_hash['export_format'] = 'export_format'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(file = nil,
+                   export_format = nil)
+      @file = file
+      @export_format = export_format
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      file = hash.key?('file') ? hash['file'] : nil
+      export_format = hash.key?('export_format') ? hash['export_format'] : nil
+
+      # Create object from extracted values.
+      TransformViaFileRequestBody.new(file,
+                                      export_format)
+    end
+  end
+end

data/lib/apimatic_api/models/transform_via_url_request.rb

@@ -0,0 +1,60 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # This structure puts together the URL of the file to be transformed, along
+  # with the desired export format.
+  class TransformViaUrlRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The URL for the API specification file.<br><br>**Note:** This URL should
+    # be publicly accessible.
+    # @return [String]
+    attr_accessor :url
+
+    # The structure contains API specification formats that Transformer can
+    # convert to.
+    # @return [ExportFormats]
+    attr_accessor :export_format
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['url'] = 'url'
+      @_hash['export_format'] = 'export_format'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(url = nil,
+                   export_format = nil)
+      @url = url
+      @export_format = export_format
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      url = hash.key?('url') ? hash['url'] : nil
+      export_format = hash.key?('export_format') ? hash['export_format'] : nil
+
+      # Create object from extracted values.
+      TransformViaUrlRequest.new(url,
+                                 export_format)
+    end
+  end
+end

data/lib/apimatic_api/models/transformation.rb

@@ -0,0 +1,152 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # Transformation structure encapsulates all the details of a Transformation.
+  class Transformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique Transformation Identifier
+    # @return [String]
+    attr_accessor :id
+
+    # Transformation Date and Time
+    # @return [String]
+    attr_accessor :transformed_on
+
+    # Unique User Identifier
+    # @return [String]
+    attr_accessor :user_id
+
+    # API Specification file to be transformed
+    # @return [String]
+    attr_accessor :inputted_file
+
+    # API Specification file transformed to desired format
+    # @return [String]
+    attr_accessor :generated_file
+
+    # Desired Specification format
+    # @return [String]
+    attr_accessor :export_format
+
+    # Source of Transformation
+    # @return [String]
+    attr_accessor :transformation_source
+
+    # Via File or URL
+    # @return [String]
+    attr_accessor :transformation_input
+
+    # CodeGen Engine Version
+    # @return [String]
+    attr_accessor :code_gen_version
+
+    # Successful Transformation Flag
+    # @return [TrueClass | FalseClass]
+    attr_accessor :success
+
+    # Successful Transformation Flag
+    # @return [ApiValidationSummary]
+    attr_accessor :import_summary
+
+    # Successful Transformation Flag
+    # @return [ApiValidationSummary]
+    attr_accessor :api_validation_summary
+
+    # A mapping from model property names to API property names.
+    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
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   transformed_on = nil,
+                   user_id = nil,
+                   inputted_file = nil,
+                   generated_file = nil,
+                   export_format = nil,
+                   transformation_source = nil,
+                   transformation_input = nil,
+                   code_gen_version = nil,
+                   success = nil,
+                   import_summary = nil,
+                   api_validation_summary = 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
+    end
+
+    # Creates an instance of the object from a hash.
+    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 object from extracted values.
+      Transformation.new(id,
+                         transformed_on,
+                         user_id,
+                         inputted_file,
+                         generated_file,
+                         export_format,
+                         transformation_source,
+                         transformation_input,
+                         code_gen_version,
+                         success,
+                         import_summary,
+                         api_validation_summary)
+    end
+  end
+end