sdksio-apimatic-sdk 3.0.0

data/lib/apimatic_api/models/user_code_generation.rb

@@ -0,0 +1,140 @@
+# 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 by a user.
+  class UserCodeGeneration < 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 User Identifier
+    # @return [String]
+    attr_accessor :user_id
+
+    # API Specification file in a supported format
+    # @return [String]
+    attr_accessor :input_file
+
+    # 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['user_id'] = 'userId'
+      @_hash['input_file'] = 'inputFile'
+      @_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,
+                   user_id = nil,
+                   input_file = 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
+      @user_id = user_id
+      @input_file = input_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.
+      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
+      user_id = hash.key?('userId') ? hash['userId'] : nil
+      input_file = hash.key?('inputFile') ? hash['inputFile'] : nil
+
+      # Create object from extracted values.
+      UserCodeGeneration.new(id,
+                             template,
+                             generated_file,
+                             generated_on,
+                             hash_code,
+                             code_generation_source,
+                             code_gen_version,
+                             success,
+                             user_id,
+                             input_file)
+    end
+
+    def to_custom_generated_on
+      DateTimeHelper.to_rfc3339(generated_on)
+    end
+  end
+end

data/lib/apimatic_api/models/user_code_generation_requirements.rb

@@ -0,0 +1,57 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # UserCodeGenerationRequirements Model.
+  class UserCodeGenerationRequirements < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique User Identifier
+    # @return [String]
+    attr_accessor :user_id
+
+    # API Specification file in a supported format
+    # @return [String]
+    attr_accessor :input_file
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['user_id'] = 'userId'
+      @_hash['input_file'] = 'inputFile'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(user_id = nil,
+                   input_file = nil)
+      @user_id = user_id
+      @input_file = input_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.
+      user_id = hash.key?('userId') ? hash['userId'] : nil
+      input_file = hash.key?('inputFile') ? hash['inputFile'] : nil
+
+      # Create object from extracted values.
+      UserCodeGenerationRequirements.new(user_id,
+                                         input_file)
+    end
+  end
+end

data/lib/apimatic_api/models/validate_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
+  # ValidateAPIViaFileRequestBody Model.
+  class ValidateAPIViaFileRequestBody < 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.
+      ValidateAPIViaFileRequestBody.new(file)
+    end
+  end
+end

data/lib/apimatic_api/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module ApimaticApi
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/apimatic_api/utilities/file_wrapper.rb

@@ -0,0 +1,16 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+  end
+end

data/lib/apimatic_api.rb

@@ -0,0 +1,86 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+require 'json'
+require 'apimatic_core_interfaces'
+require 'apimatic_core'
+require 'apimatic_faraday_client_adapter'
+
+require_relative 'apimatic_api/api_helper'
+require_relative 'apimatic_api/client'
+
+# Utilities
+require_relative 'apimatic_api/utilities/file_wrapper'
+require_relative 'apimatic_api/utilities/date_time_helper'
+
+# Http
+require_relative 'apimatic_api/http/http_call_back'
+require_relative 'apimatic_api/http/http_method_enum'
+require_relative 'apimatic_api/http/http_request'
+require_relative 'apimatic_api/http/http_response'
+require_relative 'apimatic_api/http/auth/custom_header_authentication'
+
+# Models
+require_relative 'apimatic_api/models/base_model'
+require_relative 'apimatic_api/models/api_entity'
+require_relative 'apimatic_api/models/auth_scope'
+require_relative 'apimatic_api/models/authentication'
+require_relative 'apimatic_api/models/endpoints_group'
+require_relative 'apimatic_api/models/api_entity_code_generation'
+require_relative 'apimatic_api/models/server_configuration'
+require_relative 'apimatic_api/models/field'
+require_relative 'apimatic_api/models/server'
+require_relative 'apimatic_api/models/user_code_generation'
+require_relative 'apimatic_api/models/test_gen_settings'
+require_relative 'apimatic_api/models/attributes'
+require_relative 'apimatic_api/models/transformation'
+require_relative 'apimatic_api/models/code_generation'
+require_relative 'apimatic_api/models/environment'
+require_relative 'apimatic_api/models/code_gen_settings'
+require_relative 'apimatic_api/models/meta_data'
+require_relative 'apimatic_api/models/parameter'
+require_relative 'apimatic_api/models/api_validation_summary'
+require_relative 'apimatic_api/models/docs_validation_summary'
+require_relative 'apimatic_api/models/import_validation_summary'
+require_relative 'apimatic_api/models/import_api_version_via_url_request'
+require_relative 'apimatic_api/models/inplace_import_api_via_url_request'
+require_relative 'apimatic_api/models/generate_sdk_via_url_request'
+require_relative 'apimatic_api/models/import_api_via_url_request'
+require_relative 'apimatic_api/models/transform_via_url_request'
+require_relative 'apimatic_api/models/import_api_via_file_request_body'
+require_relative 'apimatic_api/models/' \
+                 'import_new_api_version_via_file_request_body'
+require_relative 'apimatic_api/models/inplace_api_import_binary_file'
+require_relative 'apimatic_api/models/platforms_template'
+require_relative 'apimatic_api/models/generate_sdk_via_file_request_body'
+require_relative 'apimatic_api/models/transform_via_file_request_body'
+require_relative 'apimatic_api/models/' \
+                 'generate_on_prem_portal_via_build_input_request_body'
+require_relative 'apimatic_api/models/validate_api_via_file_request_body'
+require_relative 'apimatic_api/models/api_entity_identifier'
+require_relative 'apimatic_api/models/user_code_generation_requirements'
+require_relative 'apimatic_api/models/paramter_format_details'
+require_relative 'apimatic_api/models/export_formats'
+require_relative 'apimatic_api/models/platforms'
+
+# Exceptions
+require_relative 'apimatic_api/exceptions/api_exception'
+
+require_relative 'apimatic_api/configuration'
+
+# Controllers
+require_relative 'apimatic_api/controllers/base_controller'
+require_relative 'apimatic_api/controllers/apis_management_controller'
+require_relative 'apimatic_api/controllers/' \
+                 'code_generation_imported_apis_controller'
+require_relative 'apimatic_api/controllers/' \
+                 'code_generation_external_apis_controller'
+require_relative 'apimatic_api/controllers/transformation_controller'
+require_relative 'apimatic_api/controllers/docs_portal_management_controller'
+require_relative 'apimatic_api/controllers/' \
+                 'api_validation_imported_apis_controller'
+require_relative 'apimatic_api/controllers/' \
+                 'api_validation_external_apis_controller'

data/test/controllers/controller_test_base.rb

@@ -0,0 +1,29 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'json'
+require 'minitest/autorun'
+require 'minitest/hell'
+require 'minitest/pride'
+require 'minitest/proveit'
+require 'apimatic_api'
+require_relative '../http_response_catcher'
+
+class ControllerTestBase < Minitest::Test
+  parallelize_me!
+  include ApimaticApi
+  include CoreLibrary
+
+  # Create configuration and set any test parameters
+  def create_configuration
+    Configuration.new(http_callback: HttpResponseCatcher.new)
+  end
+
+  # Initializes the base test controller
+  def setup_class
+    _config = create_configuration
+    @client = Client.new(config: _config)
+  end
+end

data/test/controllers/test_api_validation_external_apis_controller.rb

@@ -0,0 +1,144 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class APIValidationExternalApisControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    setup_class
+    @controller = @client.api_validation_external_apis
+    @response_catcher = @controller.http_call_back
+  end
+
+  # Validate an API by providing the URL of the API specification file.
+  #
+  #You can also specify [API Metadata](https://docs.apimatic.io/manage-apis/apimatic-metadata) while validating the API using this endpoint. When specifying Metadata, the URL provided will be that of a zip file containing the API specification file and the `APIMATIC-META` json file.
+  def test_validate_api_via_url
+    # Parameters for the API call
+    description_url = 'https://petstore.swagger.io/v2/swagger.json'
+
+    # Perform the API call through the SDK function
+    result = @controller.validate_api_via_url(description_url)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = 'application/json'
+
+    assert(ComparisonHelper.match_headers(expected_headers, @response_catcher.response.headers))
+
+    # Test whether the captured response is as we expected
+    refute_nil(result)
+    expected_body = JSON.parse(
+      '{"success":true,"errors":[],"warnings":["Media type <i><code>applicatio'\
+      'n/json; charset=utf-8</code></i> content definition of response code <i'\
+      '><code>429</code></i> in endpoint <i><code>getRealTimeData</code></i> o'\
+      'f group <i><code>data</code></i> contains an example value with followi'\
+      'ng undeclared fields: <i><code>detail</i></code>.","Endpoint <i><code>g'\
+      'etRealTimeData</code></i> has an example specified for error code <i><c'\
+      'ode>429</code></i> which contains following undeclared fields: <i><code'\
+      '>detail</i></code>.","Media type <i><code>application/json; charset=utf'\
+      '-8</code></i> content definition of response code <i><code>429</code></'\
+      'i> in endpoint <i><code>getDataPerCategory</code></i> of group <i><code'\
+      '>data</code></i> contains an example value with following undeclared fi'\
+      'elds: <i><code>detail</i></code>.","Endpoint <i><code>getDataPerCategor'\
+      'y</code></i> has an example specified for error code <i><code>429</code'\
+      '></i> which contains following undeclared fields: <i><code>detail</i></'\
+      'code>.","Media type <i><code>application/json; charset=utf-8</code></i>'\
+      ' content definition of response code <i><code>429</code></i> in endpoin'\
+      't <i><code>getData</code></i> of group <i><code>data</code></i> contain'\
+      's an example value with following undeclared fields: <i><code>detail</i'\
+      '></code>.","Endpoint <i><code>getData</code></i> has an example specifi'\
+      'ed for error code <i><code>429</code></i> which contains following unde'\
+      'clared fields: <i><code>detail</i></code>.","Media type <i><code>applic'\
+      'ation/json; charset=utf-8</code></i> content definition of response cod'\
+      'e <i><code>429</code></i> in endpoint <i><code>getActiveStatuses</code>'\
+      '</i> of group <i><code>statuses</code></i> contains an example value wi'\
+      'th following undeclared fields: <i><code>detail</i></code>.","Endpoint '\
+      '<i><code>getActiveStatuses</code></i> has an example specified for erro'\
+      'r code <i><code>429</code></i> which contains following undeclared fiel'\
+      'ds: <i><code>detail</i></code>.","Media type <i><code>application/json;'\
+      ' charset=utf-8</code></i> content definition of response code <i><code>'\
+      '200</code></i> in endpoint <i><code>getDevices</code></i> of group <i><'\
+      'code>assets</code></i> contains an example value with following undecla'\
+      'red fields: <i><code>deviceModelId</code></i>, <i><code>manufacturer</c'\
+      'ode></i>, <i><code>model</i></code>.","Media type <i><code>application/'\
+      'json; charset=utf-8</code></i> content definition of response code <i><'\
+      'code>429</code></i> in endpoint <i><code>getDevices</code></i> of group'\
+      ' <i><code>assets</code></i> contains an example value with following un'\
+      'declared fields: <i><code>detail</i></code>.","Endpoint <i><code>getDev'\
+      'ices</code></i> has an example specified for error code <i><code>429</c'\
+      'ode></i> which contains following undeclared fields: <i><code>detail</i'\
+      '></code>.","Media type <i><code>application/json; charset=utf-8</code><'\
+      '/i> content definition of response code <i><code>429</code></i> in endp'\
+      'oint <i><code>getAlarms</code></i> of group <i><code>alerts</code></i> '\
+      'contains an example value with following undeclared fields: <i><code>de'\
+      'tail</i></code>.","Endpoint <i><code>getAlarms</code></i> has an exampl'\
+      'e specified for error code <i><code>429</code></i> which contains follo'\
+      'wing undeclared fields: <i><code>detail</i></code>.","Media type <i><co'\
+      'de>application/json; charset=utf-8</code></i> content definition of res'\
+      'ponse code <i><code>429</code></i> in endpoint <i><code>getActiveAlerts'\
+      '</code></i> of group <i><code>alerts</code></i> contains an example val'\
+      'ue with following undeclared fields: <i><code>detail</i></code>.","Endp'\
+      'oint <i><code>getActiveAlerts</code></i> has an example specified for e'\
+      'rror code <i><code>429</code></i> which contains following undeclared f'\
+      'ields: <i><code>detail</i></code>.","Media type <i><code>application/js'\
+      'on; charset=utf-8</code></i> content definition of response code <i><co'\
+      'de>429</code></i> in endpoint <i><code>getAlerts</code></i> of group <i'\
+      '><code>alerts</code></i> contains an example value with following undec'\
+      'lared fields: <i><code>detail</i></code>.","Endpoint <i><code>getAlerts'\
+      '</code></i> has an example specified for error code <i><code>429</code>'\
+      '</i> which contains following undeclared fields: <i><code>detail</i></c'\
+      'ode>.","Media type <i><code>application/json; charset=utf-8</code></i> '\
+      'content definition of response code <i><code>429</code></i> in endpoint'\
+      ' <i><code>getConfiguration</code></i> of group <i><code>configuration d'\
+      'ata</code></i> contains an example value with following undeclared fiel'\
+      'ds: <i><code>detail</i></code>.","Endpoint <i><code>getConfiguration</c'\
+      'ode></i> has an example specified for error code <i><code>429</code></i'\
+      '> which contains following undeclared fields: <i><code>detail</i></code'\
+      '>.","Media type <i><code>application/json; charset=utf-8</code></i> con'\
+      'tent definition of response code <i><code>429</code></i> in endpoint <i'\
+      '><code>getActiveAlarms</code></i> of group <i><code>alerts</code></i> c'\
+      'ontains an example value with following undeclared fields: <i><code>det'\
+      'ail</i></code>.","Endpoint <i><code>getActiveAlarms</code></i> has an e'\
+      'xample specified for error code <i><code>429</code></i> which contains '\
+      'following undeclared fields: <i><code>detail</i></code>.","Media type <'\
+      'i><code>application/json; charset=utf-8</code></i> content definition o'\
+      'f response code <i><code>429</code></i> in endpoint <i><code>getPowerCu'\
+      'rves</code></i> of group <i><code>assets</code></i> contains an example'\
+      ' value with following undeclared fields: <i><code>detail</i></code>.","'\
+      'Endpoint <i><code>getPowerCurves</code></i> has an example specified fo'\
+      'r error code <i><code>429</code></i> which contains following undeclare'\
+      'd fields: <i><code>detail</i></code>.","Media type <i><code>application'\
+      '/json; charset=utf-8</code></i> content definition of response code <i>'\
+      '<code>429</code></i> in endpoint <i><code>getDataSignals</code></i> of '\
+      'group <i><code>data</code></i> contains an example value with following'\
+      ' undeclared fields: <i><code>detail</i></code>.","Endpoint <i><code>get'\
+      'DataSignals</code></i> has an example specified for error code <i><code'\
+      '>429</code></i> which contains following undeclared fields: <i><code>de'\
+      'tail</i></code>.","Media type <i><code>application/json; charset=utf-8<'\
+      '/code></i> content definition of response code <i><code>429</code></i> '\
+      'in endpoint <i><code>getStatuses</code></i> of group <i><code>statuses<'\
+      '/code></i> contains an example value with following undeclared fields: '\
+      '<i><code>detail</i></code>.","Endpoint <i><code>getStatuses</code></i> '\
+      'has an example specified for error code <i><code>429</code></i> which c'\
+      'ontains following undeclared fields: <i><code>detail</i></code>.","Medi'\
+      'a type <i><code>application/json; charset=utf-8</code></i> content defi'\
+      'nition of response code <i><code>429</code></i> in endpoint <i><code>ge'\
+      'tSites</code></i> of group <i><code>assets</code></i> contains an examp'\
+      'le value with following undeclared fields: <i><code>detail</i></code>."'\
+      ',"Endpoint <i><code>getSites</code></i> has an example specified for er'\
+      'ror code <i><code>429</code></i> which contains following undeclared fi'\
+      'elds: <i><code>detail</i></code>."],"messages":["One or more elements i'\
+      'n the API specification has a missing description field."]}'
+    )
+    received_body = JSON.parse(@response_catcher.response.raw_body)
+    assert(ComparisonHelper.match_body(expected_body, received_body))
+  end
+
+end