sdksio-apimatic-sdk 3.0.0

data/lib/apimatic_api/models/code_generation.rb

@@ -0,0 +1,122 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module ApimaticApi
+  # The Code Generation structure encapsulates all the  the details of an SDK
+  # generation performed against an API Entity
+  class CodeGeneration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique Code Generation Identifier
+    # @return [String]
+    attr_accessor :id
+
+    # The structure contains platforms that APIMatic CodeGen can generate SDKs
+    # and Docs in.
+    # @return [Platforms]
+    attr_accessor :template
+
+    # The generated SDK
+    # @return [String]
+    attr_accessor :generated_file
+
+    # Generation Date and Time
+    # @return [DateTime]
+    attr_accessor :generated_on
+
+    # The md5 hash of the API Description
+    # @return [String]
+    attr_accessor :hash_code
+
+    # Generation Source
+    # @return [String]
+    attr_accessor :code_generation_source
+
+    # Generation Version
+    # @return [String]
+    attr_accessor :code_gen_version
+
+    # Generation Status
+    # @return [TrueClass | FalseClass]
+    attr_accessor :success
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['template'] = 'template'
+      @_hash['generated_file'] = 'generatedFile'
+      @_hash['generated_on'] = 'generatedOn'
+      @_hash['hash_code'] = 'hashCode'
+      @_hash['code_generation_source'] = 'codeGenerationSource'
+      @_hash['code_gen_version'] = 'codeGenVersion'
+      @_hash['success'] = 'success'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   template = Platforms::CS_NET_STANDARD_LIB,
+                   generated_file = nil,
+                   generated_on = nil,
+                   hash_code = nil,
+                   code_generation_source = nil,
+                   code_gen_version = nil,
+                   success = nil)
+      @id = id
+      @template = template
+      @generated_file = generated_file
+      @generated_on = generated_on
+      @hash_code = hash_code
+      @code_generation_source = code_generation_source
+      @code_gen_version = code_gen_version
+      @success = success
+    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
+      template = hash['template'] ||= Platforms::CS_NET_STANDARD_LIB
+      generated_file = hash.key?('generatedFile') ? hash['generatedFile'] : nil
+      generated_on = if hash.key?('generatedOn')
+                       (DateTimeHelper.from_rfc3339(hash['generatedOn']) if hash['generatedOn'])
+                     end
+      hash_code = hash.key?('hashCode') ? hash['hashCode'] : nil
+      code_generation_source =
+        hash.key?('codeGenerationSource') ? hash['codeGenerationSource'] : nil
+      code_gen_version =
+        hash.key?('codeGenVersion') ? hash['codeGenVersion'] : nil
+      success = hash.key?('success') ? hash['success'] : nil
+
+      # Create object from extracted values.
+      CodeGeneration.new(id,
+                         template,
+                         generated_file,
+                         generated_on,
+                         hash_code,
+                         code_generation_source,
+                         code_gen_version,
+                         success)
+    end
+
+    def to_custom_generated_on
+      DateTimeHelper.to_rfc3339(generated_on)
+    end
+  end
+end

data/lib/apimatic_api/models/docs_validation_summary.rb

@@ -0,0 +1,75 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # DocsValidationSummary Model.
+  class DocsValidationSummary < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :success
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :errors
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :warnings
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :messages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['success'] = 'success'
+      @_hash['errors'] = 'errors'
+      @_hash['warnings'] = 'warnings'
+      @_hash['messages'] = 'messages'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(success = nil,
+                   errors = nil,
+                   warnings = nil,
+                   messages = nil)
+      @success = success
+      @errors = errors
+      @warnings = warnings
+      @messages = messages
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      success = hash.key?('success') ? hash['success'] : nil
+      errors = hash.key?('errors') ? hash['errors'] : nil
+      warnings = hash.key?('warnings') ? hash['warnings'] : nil
+      messages = hash.key?('messages') ? hash['messages'] : nil
+
+      # Create object from extracted values.
+      DocsValidationSummary.new(success,
+                                errors,
+                                warnings,
+                                messages)
+    end
+  end
+end

data/lib/apimatic_api/models/endpoints_group.rb

@@ -0,0 +1,57 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # This structure encapsulates all the attributes of an API Endpoints Group.
+  class EndpointsGroup < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil,
+                   description = nil)
+      @name = name
+      @description = description
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+
+      # Create object from extracted values.
+      EndpointsGroup.new(name,
+                         description)
+    end
+  end
+end

data/lib/apimatic_api/models/environment.rb

@@ -0,0 +1,79 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # An environment consists of a set of servers with base URL values. The
+  # environment can be changed programatically allowing rapid switching between
+  # different environments. For example the user can specify a Production and
+  # Testing Environment and switch between them in the generated SDK.
+  class Environment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique Environment Identifier
+    # @return [String]
+    attr_accessor :id
+
+    # Environment Name
+    # @return [String]
+    attr_accessor :name
+
+    # The user can specify multiple servers within an environment. A server
+    # comprises of a name and a url.
+    # @return [Array[Server]]
+    attr_accessor :servers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['servers'] = 'servers'
+      @_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,
+                   servers = nil)
+      @id = id
+      @name = name
+      @servers = servers
+    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
+      # Parameter is an array, so we need to iterate through it
+      servers = nil
+      unless hash['servers'].nil?
+        servers = []
+        hash['servers'].each do |structure|
+          servers << (Server.from_hash(structure) if structure)
+        end
+      end
+
+      servers = nil unless hash.key?('servers')
+
+      # Create object from extracted values.
+      Environment.new(id,
+                      name,
+                      servers)
+    end
+  end
+end

data/lib/apimatic_api/models/export_formats.rb

@@ -0,0 +1,60 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # The structure contains API specification formats that Transformer can
+  # convert to.
+  class ExportFormats
+    EXPORT_FORMATS = [
+      # TODO: Write general description for APIMATIC
+      APIMATIC = 'APIMATIC'.freeze,
+
+      # TODO: Write general description for WADL2009
+      WADL2009 = 'WADL2009'.freeze,
+
+      # TODO: Write general description for WSDL
+      WSDL = 'WSDL'.freeze,
+
+      # TODO: Write general description for SWAGGER10
+      SWAGGER10 = 'Swagger10'.freeze,
+
+      # TODO: Write general description for SWAGGER20
+      SWAGGER20 = 'Swagger20'.freeze,
+
+      # TODO: Write general description for SWAGGERYAML
+      SWAGGERYAML = 'SwaggerYaml'.freeze,
+
+      # OpenAPI v3.0 (JSON)
+      OAS3 = 'OpenApi3Json'.freeze,
+
+      # TODO: Write general description for OPENAPI3YAML
+      OPENAPI3YAML = 'OpenApi3Yaml'.freeze,
+
+      # TODO: Write general description for APIBLUEPRINT
+      APIBLUEPRINT = 'APIBluePrint'.freeze,
+
+      # TODO: Write general description for RAML
+      RAML = 'RAML'.freeze,
+
+      # TODO: Write general description for RAML10
+      RAML10 = 'RAML10'.freeze,
+
+      # TODO: Write general description for POSTMAN10
+      POSTMAN10 = 'Postman10'.freeze,
+
+      # TODO: Write general description for POSTMAN20
+      POSTMAN20 = 'Postman20'.freeze,
+
+      # TODO: Write general description for GRAPHQLSCHEMA
+      GRAPHQLSCHEMA = 'GraphQlSchema'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EXPORT_FORMATS.include?(value)
+    end
+  end
+end

data/lib/apimatic_api/models/field.rb

@@ -0,0 +1,156 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # This structure encapsulates all details of a parameter.
+  class Field < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # If parameter is optional
+    # @return [TrueClass | FalseClass]
+    attr_accessor :optional
+
+    # Type of Parameter
+    # @return [String]
+    attr_accessor :type
+
+    # IF Parameter is constant
+    # @return [TrueClass | FalseClass]
+    attr_accessor :constant
+
+    # If Param is collected as array
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_array
+
+    # If Param is collected as array
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_stream
+
+    # If Param is collected as array
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_attribute
+
+    # If Param is collected as array
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_map
+
+    # The structure contain attribute details of a parameter type.
+    # @return [Attributes]
+    attr_accessor :attributes
+
+    # If Parameter is nullable
+    # @return [TrueClass | FalseClass]
+    attr_accessor :nullable
+
+    # Unique Parameter identifier
+    # @return [String]
+    attr_accessor :id
+
+    # Parameter Name
+    # @return [String]
+    attr_accessor :name
+
+    # Parameter Description
+    # @return [String]
+    attr_accessor :description
+
+    # Default Values of a Parameter
+    # @return [String]
+    attr_accessor :default_value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['optional'] = 'optional'
+      @_hash['type'] = 'type'
+      @_hash['constant'] = 'constant'
+      @_hash['is_array'] = 'isArray'
+      @_hash['is_stream'] = 'isStream'
+      @_hash['is_attribute'] = 'isAttribute'
+      @_hash['is_map'] = 'isMap'
+      @_hash['attributes'] = 'attributes'
+      @_hash['nullable'] = 'nullable'
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['default_value'] = 'defaultValue'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(optional = nil,
+                   type = nil,
+                   constant = nil,
+                   is_array = nil,
+                   is_stream = nil,
+                   is_attribute = nil,
+                   is_map = nil,
+                   attributes = nil,
+                   nullable = nil,
+                   id = nil,
+                   name = nil,
+                   description = nil,
+                   default_value = nil)
+      @optional = optional
+      @type = type
+      @constant = constant
+      @is_array = is_array
+      @is_stream = is_stream
+      @is_attribute = is_attribute
+      @is_map = is_map
+      @attributes = attributes
+      @nullable = nullable
+      @id = id
+      @name = name
+      @description = description
+      @default_value = default_value
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      optional = hash.key?('optional') ? hash['optional'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      constant = hash.key?('constant') ? hash['constant'] : nil
+      is_array = hash.key?('isArray') ? hash['isArray'] : nil
+      is_stream = hash.key?('isStream') ? hash['isStream'] : nil
+      is_attribute = hash.key?('isAttribute') ? hash['isAttribute'] : nil
+      is_map = hash.key?('isMap') ? hash['isMap'] : nil
+      attributes = Attributes.from_hash(hash['attributes']) if hash['attributes']
+      nullable = hash.key?('nullable') ? hash['nullable'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      default_value = hash.key?('defaultValue') ? hash['defaultValue'] : nil
+
+      # Create object from extracted values.
+      Field.new(optional,
+                type,
+                constant,
+                is_array,
+                is_stream,
+                is_attribute,
+                is_map,
+                attributes,
+                nullable,
+                id,
+                name,
+                description,
+                default_value)
+    end
+  end
+end

data/lib/apimatic_api/models/generate_on_prem_portal_via_build_input_request_body.rb

@@ -0,0 +1,48 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # GenerateOnPremPortalViaBuildInputRequestBody Model.
+  class GenerateOnPremPortalViaBuildInputRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The input file to the Portal Generator. Must contain the build file.
+    # @return [Binary]
+    attr_accessor :file
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['file'] = 'file'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(file = nil)
+      @file = file
+    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
+
+      # Create object from extracted values.
+      GenerateOnPremPortalViaBuildInputRequestBody.new(file)
+    end
+  end
+end

data/lib/apimatic_api/models/generate_sdk_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
+  # GenerateSDKViaFileRequestBody Model.
+  class GenerateSDKViaFileRequestBody < 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 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['file'] = 'file'
+      @_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(file = nil,
+                   template = Platforms::CS_NET_STANDARD_LIB)
+      @file = file
+      @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.
+      file = hash.key?('file') ? hash['file'] : nil
+      template = hash['template'] ||= Platforms::CS_NET_STANDARD_LIB
+
+      # Create object from extracted values.
+      GenerateSDKViaFileRequestBody.new(file,
+                                        template)
+    end
+  end
+end