sdksio-apimatic-sdk 3.0.0 → 3.0.1

data/lib/apimatic_api/configuration.rb

@@ -1,125 +1,198 @@
-# apimatic_api
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module ApimaticApi
-  # An enum for SDK environments.
-  class Environment
-    ENVIRONMENT = [
-      PRODUCTION = 'production'.freeze
-    ].freeze
-  end
-
-  # An enum for API servers.
-  class Server
-    SERVER = [
-      DEFAULT = 'default'.freeze
-    ].freeze
-  end
-
-  # All configuration including auth info and base URI for the API access
-  # are configured in this class.
-  class Configuration < CoreLibrary::HttpClientConfiguration
-    def authorization
-      @custom_header_authentication_credentials.authorization
-    end
-
-    # The attribute readers for properties.
-    attr_reader :environment, :custom_header_authentication_credentials
-
-    class << self
-      attr_reader :environments
-    end
-
-    def initialize(
-      connection: nil, adapter: :net_http_persistent, timeout: 60,
-      max_retries: 0, retry_interval: 1, backoff_factor: 2,
-      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
-      retry_methods: %i[get put get put], http_callback: nil,
-      environment: Environment::PRODUCTION, authorization: nil,
-      custom_header_authentication_credentials: nil
-    )
-
-      super connection: connection, adapter: adapter, timeout: timeout,
-            max_retries: max_retries, retry_interval: retry_interval,
-            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
-            retry_methods: retry_methods, http_callback: http_callback
-
-      # Current API environment
-      @environment = String(environment)
-
-      # Auth Header. Provide your Auth key in the format `X-Auth-Key {auth-key}`.
-      @authorization = authorization
-
-      # Initializing Custom Header Signature credentials with the provided auth parameters
-      @custom_header_authentication_credentials = create_auth_credentials_object(
-        authorization, custom_header_authentication_credentials
-      )
-
-      # The Http Client to use for making requests.
-      set_http_client CoreLibrary::FaradayClient.new(self)
-    end
-
-    def clone_with(connection: nil, adapter: nil, timeout: nil,
-                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
-                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
-                   environment: nil, authorization: nil,
-                   custom_header_authentication_credentials: nil)
-      connection ||= self.connection
-      adapter ||= self.adapter
-      timeout ||= self.timeout
-      max_retries ||= self.max_retries
-      retry_interval ||= self.retry_interval
-      backoff_factor ||= self.backoff_factor
-      retry_statuses ||= self.retry_statuses
-      retry_methods ||= self.retry_methods
-      http_callback ||= self.http_callback
-      environment ||= self.environment
-      custom_header_authentication_credentials = create_auth_credentials_object(
-        authorization,
-        custom_header_authentication_credentials || self.custom_header_authentication_credentials
-      )
-
-      Configuration.new(
-        connection: connection, adapter: adapter, timeout: timeout,
-        max_retries: max_retries, retry_interval: retry_interval,
-        backoff_factor: backoff_factor, retry_statuses: retry_statuses,
-        retry_methods: retry_methods, http_callback: http_callback,
-        environment: environment,
-        custom_header_authentication_credentials: custom_header_authentication_credentials
-      )
-    end
-
-    def create_auth_credentials_object(authorization,
-                                       custom_header_authentication_credentials)
-      return custom_header_authentication_credentials if authorization.nil?
-
-      warn('The \'authorization\' params are deprecated. Use \'custom_header_a'\
-           'uthentication_credentials\' param instead.')
-
-      unless custom_header_authentication_credentials.nil?
-        return custom_header_authentication_credentials.clone_with(
-          authorization: authorization
-        )
-      end
-
-      CustomHeaderAuthenticationCredentials.new(authorization: authorization)
-    end
-
-    # All the environments the SDK can run in.
-    ENVIRONMENTS = {
-      Environment::PRODUCTION => {
-        Server::DEFAULT => 'https://api.apimatic.io'
-      }
-    }.freeze
-
-    # Generates the appropriate base URI for the environment and the server.
-    # @param [Configuration::Server] server The server enum for which the base URI is
-    # required.
-    # @return [String] The base URI.
-    def get_base_uri(server = Server::DEFAULT)
-      ENVIRONMENTS[environment][server].clone
-    end
-  end
-end
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApimaticApi
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze,
+      TESTING = 'testing'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Environment constant.
+    def self.from_value(value, default_value = PRODUCTION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'production' then PRODUCTION
+      when 'testing' then TESTING
+
+      else
+        warn "[Environment] Unknown environment '#{value}', falling back to #{default_value} "
+        default_value
+      end
+    end
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = DEFAULT)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment, :custom_url,
+                :custom_header_authentication_credentials, :user_agent
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      custom_url: 'https://localhost:44301/api',
+      custom_header_authentication_credentials: nil,
+      user_agent: 'TODO: Replace'
+    )
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback,
+            proxy_settings: proxy_settings,
+            logging_configuration: logging_configuration
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The testing domain for the API
+      @custom_url = custom_url
+
+      # The object holding Custom Header Signature credentials
+      @custom_header_authentication_credentials = custom_header_authentication_credentials
+
+      # TODO: Replace
+      @user_agent = user_agent
+
+      # Initializing Custom Header Signature credentials with the provided auth parameters
+      @custom_header_authentication_credentials = custom_header_authentication_credentials
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   proxy_settings: nil, logging_configuration: nil,
+                   environment: nil, custom_url: nil,
+                   custom_header_authentication_credentials: nil,
+                   user_agent: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
+      logging_configuration ||= self.logging_configuration
+      environment ||= self.environment
+      custom_url ||= self.custom_url
+      user_agent ||= self.user_agent
+      custom_header_authentication_credentials ||= self.custom_header_authentication_credentials
+
+      Configuration.new(
+        connection: connection, adapter: adapter, timeout: timeout,
+        max_retries: max_retries, retry_interval: retry_interval,
+        backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+        retry_methods: retry_methods, http_callback: http_callback,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration, environment: environment,
+        custom_url: custom_url, user_agent: user_agent,
+        custom_header_authentication_credentials: custom_header_authentication_credentials
+      )
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://api.apimatic.io'
+      },
+      Environment::TESTING => {
+        Server::DEFAULT => '{customUrl}'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      parameters = {
+        'customUrl' => { 'value' => custom_url, 'encode' => false }
+      }
+      APIHelper.append_url_with_template_parameters(
+        ENVIRONMENTS[environment][server], parameters
+      )
+    end
+
+    # Builds a Configuration instance using environment variables.
+    def self.build_default_config_from_env
+      # === Core environment ===
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'production'))
+      custom_url = ENV.fetch('CUSTOM_URL', 'https://localhost:44301/api')
+      user_agent = ENV.fetch('USER_AGENT', 'TODO: Replace')
+      timeout = (ENV['TIMEOUT'] || 30).to_f
+      max_retries = (ENV['MAX_RETRIES'] || 0).to_i
+      retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
+      backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
+      retry_statuses = ENV.fetch('RETRY_STATUSES',
+                                 '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+      retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+
+      # === Authentication credentials ===
+      custom_header_authentication_credentials = CustomHeaderAuthenticationCredentials.from_env
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+      # === Logging Configuration ===
+      logging_configuration = LoggingConfiguration.from_env if LoggingConfiguration.any_logging_configured?
+
+      Configuration.new(
+        environment: environment,
+        custom_url: custom_url,
+        user_agent: user_agent,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        custom_header_authentication_credentials: custom_header_authentication_credentials,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration
+      )
+    end
+  end
+end

data/lib/apimatic_api/controllers/api_validation_external_apis_controller.rb

@@ -1,84 +1,90 @@
-# apimatic_api
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module ApimaticApi
-  # APIValidationExternalApisController
-  class APIValidationExternalApisController < BaseController
-    # Validate an API by uploading 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
-    # uploaded file will be a zip file containing the API specification file and
-    # the `APIMATIC-META` json file.
-    # @param [File | UploadIO] file Required parameter: 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 [ApiValidationSummary] response from the API call
-    def validate_api_via_file(file)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/validation/validate-via-file',
-                                     Server::DEFAULT)
-                   .multipart_param(new_parameter(file, key: 'file')
-                                     .default_content_type('application/octet-stream'))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('Authorization')))
-        .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(ApiValidationSummary.method(:from_hash))
-                   .local_error('400',
-                                'Bad Request',
-                                APIException)
-                   .local_error('401',
-                                'Unauthenticated',
-                                APIException)
-                   .local_error('403',
-                                'Forbidden',
-                                APIException)
-                   .local_error('500',
-                                'Internal Server Error',
-                                APIException))
-        .execute
-    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.
-    # @param [String] description_url Required parameter: The URL for the API
-    # specification file.<br><br>**Note:** This URL should be publicly
-    # accessible.
-    # @return [ApiValidationSummary] response from the API call
-    def validate_api_via_url(description_url)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/validation/validate-via-url',
-                                     Server::DEFAULT)
-                   .query_param(new_parameter(description_url, key: 'descriptionUrl'))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('Authorization')))
-        .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(ApiValidationSummary.method(:from_hash))
-                   .local_error('400',
-                                'Bad Request',
-                                APIException)
-                   .local_error('401',
-                                'Unauthenticated',
-                                APIException)
-                   .local_error('403',
-                                'Forbidden',
-                                APIException)
-                   .local_error('500',
-                                'Internal Server Error',
-                                APIException))
-        .execute
-    end
-  end
-end
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApimaticApi
+  # ApiValidationExternalApisController
+  class ApiValidationExternalApisController < BaseController
+    # Validate an API by uploading 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
+    # uploaded file will be a zip file containing the API specification file and
+    # the `APIMATIC-META` json file.
+    # @param [ContentType] content_type Required parameter: Example:
+    # @param [File | UploadIO] file Required parameter: 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 [ApiResponse] Complete http response with raw body and status code.
+    def validate_api_via_file(content_type,
+                              file)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/validation/validate-via-file',
+                                     Server::DEFAULT)
+                   .multipart_param(new_parameter(file, key: 'file')
+                                     .is_required(true)
+                                     .default_content_type('application/octet-stream'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ApiValidationSummary.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthenticated',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 APIException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 APIException))
+        .execute
+    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.
+    # @param [String] description_url Required parameter: The URL for the API
+    # specification file.<br><br>**Note:** This URL should be publicly
+    # accessible.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def validate_api_via_url(description_url)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/validation/validate-via-url',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(description_url, key: 'descriptionUrl')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ApiValidationSummary.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthenticated',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 APIException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 APIException))
+        .execute
+    end
+  end
+end

data/lib/apimatic_api/controllers/api_validation_v2_external_apis_controller.rb

@@ -0,0 +1,89 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApimaticApi
+  # ApiValidationV2ExternalApisController
+  class ApiValidationV2ExternalApisController < BaseController
+    # Validate an API by uploading 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
+    # uploaded file will be a zip file containing the API specification file and
+    # the `APIMATIC-META` json file.
+    # @param [ContentType] content_type Required parameter: Example:
+    # @param [File | UploadIO] file Required parameter: 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 [ApiResponse] Complete http response with raw body and status code.
+    def validate_api_via_file_v2(content_type,
+                                 file)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/validation/v2/validate-via-file',
+                                     Server::DEFAULT)
+                   .multipart_param(new_parameter(file, key: 'file')
+                                     .is_required(true)
+                                     .default_content_type('application/octet-stream'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ValidateApiResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ProblemDetailsException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 UnauthorizedResponseException)
+                    .local_error('403',
+                                 'Subscription Issue',
+                                 ProblemDetailsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 InternalServerErrorResponseException))
+        .execute
+    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.
+    # @param [String] url Required parameter: The URL for the API specification
+    # file.<br><br>**Note:** This URL should be publicly accessible.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def validate_api_via_url_v2(url)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/validation/v2/validate-via-url',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(url, key: 'url')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ValidateApiResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 ProblemDetailsException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 UnauthorizedResponseException)
+                    .local_error('403',
+                                 'Subscription Issue',
+                                 ProblemDetailsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 InternalServerErrorResponseException))
+        .execute
+    end
+  end
+end