sdksio-apimatic-sdk 3.0.0

data/lib/apimatic_api/models/api_entity.rb

@@ -0,0 +1,220 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # The API Entity Structure encapsulates all the details of an API Entity. An
+  # API entity is a unique API Version.
+  class ApiEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique API Entity identifier
+    # @return [String]
+    attr_accessor :id
+
+    # Enrcypted API Entity Id
+    # @return [String]
+    attr_accessor :encrypted_id
+
+    # API Integration Key. Obtain from API Card on Dashboard.
+    # @return [String]
+    attr_accessor :api_key
+
+    # Unique API Group Identifier
+    # @return [String]
+    attr_accessor :api_group_id
+
+    # Cover Image
+    # @return [String]
+    attr_accessor :image_uri
+
+    # Entity creation date
+    # @return [String]
+    attr_accessor :creation_date
+
+    # API Status (Deprecated)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :public
+
+    # API Entity  Name
+    # @return [String]
+    attr_accessor :name
+
+    # Description of the API
+    # @return [String]
+    attr_accessor :description
+
+    # Entity Version Number
+    # @return [String]
+    attr_accessor :version
+
+    # Header Content
+    # @return [Array[String]]
+    attr_accessor :additional_headers
+
+    # This Structure encapsulates all details of API authentication.
+    # @return [Authentication]
+    attr_accessor :authentication
+
+    # APIMatic’s code generation engine has various code generation
+    # configurations to customise the behaviour and outlook across the generated
+    # SDKS. This structure encapsulates all settings for CodeGeneration.
+    # @return [CodeGenSettings]
+    attr_accessor :code_gen_settings
+
+    # This structure helps specify additional test configurations which affects
+    # how test cases are generated.
+    # @return [TestGenSettings]
+    attr_accessor :test_gen_settings
+
+    # API Errors
+    # @return [Array[String]]
+    attr_accessor :errors
+
+    # Server configurations can be used to create multiple environments,
+    # multiple servers that can be used with specific endpoints and server URLs
+    # with template paramters.
+    # @return [ServerConfiguration]
+    attr_accessor :server_configuration
+
+    # API Endpoint Groups
+    # @return [Array[EndpointsGroup]]
+    attr_accessor :endpoints_group
+
+    # API Endpoint Groups
+    # @return [MetaData]
+    attr_accessor :meta_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['encrypted_id'] = 'encryptedId'
+      @_hash['api_key'] = 'apiKey'
+      @_hash['api_group_id'] = 'apiGroupId'
+      @_hash['image_uri'] = 'imageUri'
+      @_hash['creation_date'] = 'creationDate'
+      @_hash['public'] = 'public'
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['version'] = 'version'
+      @_hash['additional_headers'] = 'additionalHeaders'
+      @_hash['authentication'] = 'authentication'
+      @_hash['code_gen_settings'] = 'codeGenSettings'
+      @_hash['test_gen_settings'] = 'testGenSettings'
+      @_hash['errors'] = 'errors'
+      @_hash['server_configuration'] = 'serverConfiguration'
+      @_hash['endpoints_group'] = 'endpointsGroup'
+      @_hash['meta_data'] = 'metaData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   encrypted_id = nil,
+                   api_key = nil,
+                   api_group_id = nil,
+                   image_uri = nil,
+                   creation_date = nil,
+                   public = nil,
+                   name = nil,
+                   description = nil,
+                   version = nil,
+                   additional_headers = nil,
+                   authentication = nil,
+                   code_gen_settings = nil,
+                   test_gen_settings = nil,
+                   errors = nil,
+                   server_configuration = nil,
+                   endpoints_group = nil,
+                   meta_data = nil)
+      @id = id
+      @encrypted_id = encrypted_id
+      @api_key = api_key
+      @api_group_id = api_group_id
+      @image_uri = image_uri
+      @creation_date = creation_date
+      @public = public
+      @name = name
+      @description = description
+      @version = version
+      @additional_headers = additional_headers
+      @authentication = authentication
+      @code_gen_settings = code_gen_settings
+      @test_gen_settings = test_gen_settings
+      @errors = errors
+      @server_configuration = server_configuration
+      @endpoints_group = endpoints_group
+      @meta_data = meta_data
+    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
+      encrypted_id = hash.key?('encryptedId') ? hash['encryptedId'] : nil
+      api_key = hash.key?('apiKey') ? hash['apiKey'] : nil
+      api_group_id = hash.key?('apiGroupId') ? hash['apiGroupId'] : nil
+      image_uri = hash.key?('imageUri') ? hash['imageUri'] : nil
+      creation_date = hash.key?('creationDate') ? hash['creationDate'] : nil
+      public = hash.key?('public') ? hash['public'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      version = hash.key?('version') ? hash['version'] : nil
+      additional_headers =
+        hash.key?('additionalHeaders') ? hash['additionalHeaders'] : nil
+      authentication = Authentication.from_hash(hash['authentication']) if hash['authentication']
+      code_gen_settings = CodeGenSettings.from_hash(hash['codeGenSettings']) if
+        hash['codeGenSettings']
+      test_gen_settings = TestGenSettings.from_hash(hash['testGenSettings']) if
+        hash['testGenSettings']
+      errors = hash.key?('errors') ? hash['errors'] : nil
+      server_configuration = ServerConfiguration.from_hash(hash['serverConfiguration']) if
+        hash['serverConfiguration']
+      # Parameter is an array, so we need to iterate through it
+      endpoints_group = nil
+      unless hash['endpointsGroup'].nil?
+        endpoints_group = []
+        hash['endpointsGroup'].each do |structure|
+          endpoints_group << (EndpointsGroup.from_hash(structure) if structure)
+        end
+      end
+
+      endpoints_group = nil unless hash.key?('endpointsGroup')
+      meta_data = MetaData.from_hash(hash['metaData']) if hash['metaData']
+
+      # Create object from extracted values.
+      ApiEntity.new(id,
+                    encrypted_id,
+                    api_key,
+                    api_group_id,
+                    image_uri,
+                    creation_date,
+                    public,
+                    name,
+                    description,
+                    version,
+                    additional_headers,
+                    authentication,
+                    code_gen_settings,
+                    test_gen_settings,
+                    errors,
+                    server_configuration,
+                    endpoints_group,
+                    meta_data)
+    end
+  end
+end

data/lib/apimatic_api/models/api_entity_code_generation.rb

@@ -0,0 +1,131 @@
+# 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 APIEntityCodeGeneration < 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
+
+    # Unique API Entity Identifier
+    # @return [String]
+    attr_accessor :api_entity_id
+
+    # 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['api_entity_id'] = 'apiEntityId'
+      @_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,
+                   api_entity_id = 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
+      @api_entity_id = api_entity_id
+    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
+      api_entity_id = hash.key?('apiEntityId') ? hash['apiEntityId'] : nil
+
+      # Create object from extracted values.
+      APIEntityCodeGeneration.new(id,
+                                  template,
+                                  generated_file,
+                                  generated_on,
+                                  hash_code,
+                                  code_generation_source,
+                                  code_gen_version,
+                                  success,
+                                  api_entity_id)
+    end
+
+    def to_custom_generated_on
+      DateTimeHelper.to_rfc3339(generated_on)
+    end
+  end
+end

data/lib/apimatic_api/models/api_entity_identifier.rb

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

data/lib/apimatic_api/models/api_validation_summary.rb

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

data/lib/apimatic_api/models/attributes.rb

@@ -0,0 +1,48 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # The structure contain attribute details of a parameter type.
+  class Attributes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique Attribute Identifier
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil)
+      @id = id
+    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
+
+      # Create object from extracted values.
+      Attributes.new(id)
+    end
+  end
+end

data/lib/apimatic_api/models/auth_scope.rb

@@ -0,0 +1,75 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # AuthScope Model.
+  class AuthScope < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Scope Id
+    # @return [String]
+    attr_accessor :id
+
+    # Scope Name
+    # @return [String]
+    attr_accessor :name
+
+    # Scope Value
+    # @return [String]
+    attr_accessor :value
+
+    # Scope Description
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['value'] = 'value'
+      @_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(id = nil,
+                   name = nil,
+                   value = nil,
+                   description = nil)
+      @id = id
+      @name = name
+      @value = value
+      @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.
+      id = hash.key?('id') ? hash['id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      value = hash.key?('value') ? hash['value'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+
+      # Create object from extracted values.
+      AuthScope.new(id,
+                    name,
+                    value,
+                    description)
+    end
+  end
+end

data/lib/apimatic_api/models/authentication.rb

@@ -0,0 +1,112 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # This Structure encapsulates all details of API authentication.
+  class Authentication < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Auth Id
+    # @return [String]
+    attr_accessor :id
+
+    # Auth Type
+    # @return [String]
+    attr_accessor :auth_type
+
+    # Scope
+    # @return [Array[AuthScope]]
+    attr_accessor :scopes
+
+    # Auth Params
+    # @return [Array[String]]
+    attr_accessor :parameters
+
+    # Auth Scopes
+    # @return [Array[String]]
+    attr_accessor :auth_scopes
+
+    # Auth Grant Types
+    # @return [Array[String]]
+    attr_accessor :auth_grant_types
+
+    # Paramater Formats
+    # @return [Object]
+    attr_accessor :param_formats
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['auth_type'] = 'authType'
+      @_hash['scopes'] = 'scopes'
+      @_hash['parameters'] = 'parameters'
+      @_hash['auth_scopes'] = 'authScopes'
+      @_hash['auth_grant_types'] = 'authGrantTypes'
+      @_hash['param_formats'] = 'paramFormats'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   auth_type = nil,
+                   scopes = nil,
+                   parameters = nil,
+                   auth_scopes = nil,
+                   auth_grant_types = nil,
+                   param_formats = nil)
+      @id = id
+      @auth_type = auth_type
+      @scopes = scopes
+      @parameters = parameters
+      @auth_scopes = auth_scopes
+      @auth_grant_types = auth_grant_types
+      @param_formats = param_formats
+    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
+      auth_type = hash.key?('authType') ? hash['authType'] : nil
+      # Parameter is an array, so we need to iterate through it
+      scopes = nil
+      unless hash['scopes'].nil?
+        scopes = []
+        hash['scopes'].each do |structure|
+          scopes << (AuthScope.from_hash(structure) if structure)
+        end
+      end
+
+      scopes = nil unless hash.key?('scopes')
+      parameters = hash.key?('parameters') ? hash['parameters'] : nil
+      auth_scopes = hash.key?('authScopes') ? hash['authScopes'] : nil
+      auth_grant_types =
+        hash.key?('authGrantTypes') ? hash['authGrantTypes'] : nil
+      param_formats = hash.key?('paramFormats') ? hash['paramFormats'] : nil
+
+      # Create object from extracted values.
+      Authentication.new(id,
+                         auth_type,
+                         scopes,
+                         parameters,
+                         auth_scopes,
+                         auth_grant_types,
+                         param_formats)
+    end
+  end
+end