sdksio-apimatic-sdk 3.0.0

data/lib/apimatic_api/models/generate_sdk_via_url_request.rb

@@ -0,0 +1,59 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # GenerateSdkViaUrlRequest Model.
+  class GenerateSdkViaUrlRequest < 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 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['url'] = 'url'
+      @_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(url = nil,
+                   template = Platforms::CS_NET_STANDARD_LIB)
+      @url = url
+      @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.
+      url = hash.key?('url') ? hash['url'] : nil
+      template = hash['template'] ||= Platforms::CS_NET_STANDARD_LIB
+
+      # Create object from extracted values.
+      GenerateSdkViaUrlRequest.new(url,
+                                   template)
+    end
+  end
+end

data/lib/apimatic_api/models/import_api_version_via_url_request.rb

@@ -0,0 +1,64 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # This structure contains details of importing a new API Version
+  class ImportApiVersionViaUrlRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The version number with which the new API version will be imported. This
+    # version number will override the version specified in the API
+    # specification file.<br>APIMatic recommends versioning the API with the
+    # [versioning
+    # scheme](https://docs.apimatic.io/define-apis/basic-settings/#version)
+    # documented in the docs.
+    # @return [String]
+    attr_accessor :version_override
+
+    # The URL for the API specification file.<br><br>**Note:** This URL should
+    # be publicly accessible.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['version_override'] = 'version_override'
+      @_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(version_override = nil,
+                   url = nil)
+      @version_override = version_override
+      @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.
+      version_override =
+        hash.key?('version_override') ? hash['version_override'] : nil
+      url = hash.key?('url') ? hash['url'] : nil
+
+      # Create object from extracted values.
+      ImportApiVersionViaUrlRequest.new(version_override,
+                                        url)
+    end
+  end
+end

data/lib/apimatic_api/models/import_api_via_file_request_body.rb

@@ -0,0 +1,51 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # ImportAPIViaFileRequestBody Model.
+  class ImportAPIViaFileRequestBody < 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
+
+    # 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.
+      ImportAPIViaFileRequestBody.new(file)
+    end
+  end
+end

data/lib/apimatic_api/models/import_api_via_url_request.rb

@@ -0,0 +1,49 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # Contains a url field to allow Apis to be imported via url
+  class ImportApiViaUrlRequest < 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_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(url = nil)
+      @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.
+      url = hash.key?('url') ? hash['url'] : nil
+
+      # Create object from extracted values.
+      ImportApiViaUrlRequest.new(url)
+    end
+  end
+end

data/lib/apimatic_api/models/import_new_api_version_via_file_request_body.rb

@@ -0,0 +1,66 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # ImportNewAPIVersionViaFileRequestBody Model.
+  class ImportNewAPIVersionViaFileRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The version number with which the new API version will be imported. This
+    # version number will override the version specified in the API
+    # specification file.<br>APIMatic recommends versioning the API with the
+    # [versioning
+    # scheme](https://docs.apimatic.io/define-apis/basic-settings/#version)
+    # documented in the docs.
+    # @return [String]
+    attr_accessor :version_override
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['version_override'] = 'version_override'
+      @_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(version_override = nil,
+                   file = nil)
+      @version_override = version_override
+      @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.
+      version_override =
+        hash.key?('version_override') ? hash['version_override'] : nil
+      file = hash.key?('file') ? hash['file'] : nil
+
+      # Create object from extracted values.
+      ImportNewAPIVersionViaFileRequestBody.new(version_override,
+                                                file)
+    end
+  end
+end

data/lib/apimatic_api/models/import_validation_summary.rb

@@ -0,0 +1,75 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # ImportValidationSummary Model.
+  class ImportValidationSummary < 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.
+      ImportValidationSummary.new(success,
+                                  errors,
+                                  warnings,
+                                  messages)
+    end
+  end
+end

data/lib/apimatic_api/models/inplace_api_import_binary_file.rb

@@ -0,0 +1,51 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # InplaceApiImportBinaryFile Model.
+  class InplaceApiImportBinaryFile < 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
+
+    # 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.
+      InplaceApiImportBinaryFile.new(file)
+    end
+  end
+end

data/lib/apimatic_api/models/inplace_import_api_via_url_request.rb

@@ -0,0 +1,49 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # Contains a url field to allow Apis to be imported via url
+  class InplaceImportApiViaUrlRequest < 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_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(url = nil)
+      @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.
+      url = hash.key?('url') ? hash['url'] : nil
+
+      # Create object from extracted values.
+      InplaceImportApiViaUrlRequest.new(url)
+    end
+  end
+end

data/lib/apimatic_api/models/meta_data.rb

@@ -0,0 +1,70 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # MetaData Model.
+  class MetaData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ImportValidationSummary]
+    attr_accessor :import_validation_summary
+
+    # TODO: Write general description for this method
+    # @return [ApiValidationSummary]
+    attr_accessor :api_validation_summary
+
+    # TODO: Write general description for this method
+    # @return [DocsValidationSummary]
+    attr_accessor :docs_validation_summary
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['import_validation_summary'] = 'importValidationSummary'
+      @_hash['api_validation_summary'] = 'apiValidationSummary'
+      @_hash['docs_validation_summary'] = 'docsValidationSummary'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(import_validation_summary = nil,
+                   api_validation_summary = nil,
+                   docs_validation_summary = nil)
+      @import_validation_summary = import_validation_summary
+      @api_validation_summary = api_validation_summary
+      @docs_validation_summary = docs_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.
+      if hash['importValidationSummary']
+        import_validation_summary = ImportValidationSummary.from_hash(hash['importValidationSummary'])
+      end
+      api_validation_summary = ApiValidationSummary.from_hash(hash['apiValidationSummary']) if
+        hash['apiValidationSummary']
+      docs_validation_summary = DocsValidationSummary.from_hash(hash['docsValidationSummary']) if
+        hash['docsValidationSummary']
+
+      # Create object from extracted values.
+      MetaData.new(import_validation_summary,
+                   api_validation_summary,
+                   docs_validation_summary)
+    end
+  end
+end

data/lib/apimatic_api/models/parameter.rb

@@ -0,0 +1,165 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # Parameters are options passed with the endpoint
+  class Parameter < 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
+
+    # 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['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['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(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,
+                   param_format = 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
+      @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.
+      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
+      param_format = hash.key?('ParamFormat') ? hash['ParamFormat'] : nil
+
+      # Create object from extracted values.
+      Parameter.new(optional,
+                    type,
+                    constant,
+                    is_array,
+                    is_stream,
+                    is_attribute,
+                    is_map,
+                    attributes,
+                    nullable,
+                    id,
+                    name,
+                    description,
+                    default_value,
+                    param_format)
+    end
+  end
+end