sdksio-apimatic-sdk 3.0.0 → 3.0.1

data/lib/apimatic_api/controllers/transformation_controller.rb

@@ -1,174 +1,180 @@
-# apimatic_api
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module ApimaticApi
-  # TransformationController
-  class TransformationController < BaseController
-    # Transform an API into any of the supported API specification formats by
-    # uploading the API specification file. This endpoint transforms and then
-    # uploads the transformed API specification to APIMatic's cloud storage. An
-    # ID for the transformation performed is returned as part of the response.
-    # @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).
-    # @param [ExportFormats] export_format Required parameter: The structure
-    # contains API specification formats that Transformer can convert to.
-    # @return [Transformation] response from the API call
-    def transform_via_file(file,
-                           export_format)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/transformations/transform-via-file',
-                                     Server::DEFAULT)
-                   .multipart_param(new_parameter(file, key: 'file')
-                                     .default_content_type('application/octet-stream'))
-                   .form_param(new_parameter(export_format, key: 'export_format'))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('Authorization')))
-        .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(Transformation.method(:from_hash)))
-        .execute
-    end
-
-    # Transform an API into any of the supported API specification formats by
-    # providing the URL of the API specification file.
-    # This endpoint transforms and then uploads the transformed API
-    # specification to APIMatic's cloud storage. An ID for the transformation
-    # performed is returned as part of the response.
-    # @param [TransformViaUrlRequest] body Required parameter: Request Body
-    # @return [Transformation] response from the API call
-    def transform_via_url(body)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/transformations/transform-via-url',
-                                     Server::DEFAULT)
-                   .header_param(new_parameter('application/vnd.apimatic.urlTransformDto.v1+json', key: 'Content-Type'))
-                   .body_param(new_parameter(body))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
-                   .auth(Single.new('Authorization')))
-        .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(Transformation.method(:from_hash)))
-        .execute
-    end
-
-    # Download the transformed API specification file transformed via the
-    # Transformation endpoints.
-    # @param [String] transformation_id Required parameter: The ID of
-    # transformation received in the response of the [Transform Via File
-    # ](https://www.apimatic.io/api-docs-preview/dashboard/60eea3b7a73395c3052d9
-    # 61b/v/3_0#/http/api-endpoints/transformation/transform-via-file) or
-    # [Transform Via URL
-    # ](https://www.apimatic.io/api-docs-preview/dashboard/60eea3b7a73395c3052d9
-    # 61b/v/3_0#/http/api-endpoints/transformation/transform-via-url) calls.
-    # @return [Binary] response from the API call
-    def download_transformed_file(transformation_id)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/transformations/{transformation_id}/converted-file',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(transformation_id, key: 'transformation_id')
-                                    .should_encode(true))
-                   .auth(Single.new('Authorization')))
-        .response(new_response_handler)
-        .execute
-    end
-
-    # Download the API Specification file used as input for a particular
-    # Transformation performed via the Transformation endpoints.
-    # @param [String] transformation_id Required parameter: The ID of the
-    # transformation to download the API specification for. The transformation
-    # ID is received in the response of the [Transform Via File
-    # ](https://www.apimatic.io/api-docs-preview/dashboard/60eea3b7a73395c3052d9
-    # 61b/v/3_0#/http/api-endpoints/transformation/transform-via-file) or
-    # [Transform Via
-    # URL](https://www.apimatic.io/api-docs-preview/dashboard/60eea3b7a73395c305
-    # 2d961b/v/3_0#/http/api-endpoints/transformation/transform-via-url)
-    # calls.
-    # @return [Binary] response from the API call
-    def download_input_file_transformation(transformation_id)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/transformations/{transformation_id}/input-file',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(transformation_id, key: 'transformation_id')
-                                    .should_encode(true))
-                   .auth(Single.new('Authorization')))
-        .response(new_response_handler)
-        .execute
-    end
-
-    # Get a list of all API transformations performed.
-    # @return [Array[Transformation]] response from the API call
-    def list_all_transformations
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/transformations',
-                                     Server::DEFAULT)
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('Authorization')))
-        .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(Transformation.method(:from_hash))
-                   .is_response_array(true))
-        .execute
-    end
-
-    # Get details on a particular Transformation performed via the
-    # Transformation endpoints.
-    # @param [String] transformation_id Required parameter: The ID of the
-    # transformation to fetch. The transformation ID is received in the response
-    # of the [Transform Via File
-    # ](https://www.apimatic.io/api-docs-preview/dashboard/60eea3b7a73395c3052d9
-    # 61b/v/3_0#/http/api-endpoints/transformation/transform-via-file) or
-    # [Transform Via URL
-    # ](https://www.apimatic.io/api-docs-preview/dashboard/60eea3b7a73395c3052d9
-    # 61b/v/3_0#/http/api-endpoints/transformation/transform-via-url) calls.
-    # @return [Transformation] response from the API call
-    def get_a_transformation(transformation_id)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/transformations/{transformation_id}',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(transformation_id, key: 'transformation_id')
-                                    .should_encode(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(Transformation.method(:from_hash)))
-        .execute
-    end
-
-    # Delete a particular Transformation performed for an API via the
-    # Transformation endpoints.
-    # @param [String] transformation_id Required parameter: The ID of the
-    # transformation to delete. The transformation ID is received in the
-    # response of the [Transform Via File
-    # ](https://www.apimatic.io/api-docs-preview/dashboard/60eea3b7a73395c3052d9
-    # 61b/v/3_0#/http/api-endpoints/transformation/transform-via-file) or
-    # [Transform Via
-    # URL](https://www.apimatic.io/api-docs-preview/dashboard/60eea3b7a73395c305
-    # 2d961b/v/3_0#/http/api-endpoints/transformation/transform-via-url)
-    # calls.
-    # @return [void] response from the API call
-    def delete_transformation(transformation_id)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::DELETE,
-                                     '/transformations/{transformation_id}',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(transformation_id, key: 'transformation_id')
-                                    .should_encode(true))
-                   .auth(Single.new('Authorization')))
-        .response(new_response_handler
-                   .is_response_void(true))
-        .execute
-    end
-  end
-end
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApimaticApi
+  # TransformationController
+  class TransformationController < BaseController
+    # Transform an API into any of the supported API specification formats by
+    # uploading the API specification file.
+    # This endpoint transforms and then uploads the transformed API
+    # specification to APIMatic's cloud storage. An ID for the transformation
+    # performed is returned as part of the response.
+    # @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).
+    # @param [ExportFormats] export_format Required parameter: The structure
+    # contains API specification formats that Transformer can convert to.
+    # @param [Hash] _query_parameters Additional optional query parameters are
+    # supported by this endpoint.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def transform_via_file(content_type,
+                           file,
+                           export_format,
+                           _query_parameters: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/transformations/transform-via-file',
+                                     Server::DEFAULT)
+                   .multipart_param(new_parameter(file, key: 'file')
+                                     .is_required(true)
+                                     .default_content_type('application/octet-stream'))
+                   .form_param(new_parameter(export_format, key: 'export_format')
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .additional_query_params(_query_parameters)
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Transformation.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Transform an API into any of the supported API specification formats by
+    # providing the URL of the API specification file.
+    # This endpoint transforms and then uploads the transformed API
+    # specification to APIMatic's cloud storage. An ID for the transformation
+    # performed is returned as part of the response.
+    # @param [TransformViaUrlRequest] body Required parameter: Request Body
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def transform_via_url(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/transformations/transform-via-url',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/vnd.apimatic.urlTransformDto.v1+json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Transformation.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Download the transformed API specification file transformed via the
+    # Transformation endpoints.
+    # @param [String] transformation_id Required parameter: The ID of
+    # transformation received in the response of the [Transform Via File
+    # ]($e/Transformation/Transform%20via%20File) or [Transform Via URL
+    # ]($e/Transformation/Transform%20via%20URL) calls.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def download_transformed_file(transformation_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/transformations/{transformation_id}/converted-file',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transformation_id, key: 'transformation_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Download the API Specification file used as input for a particular
+    # Transformation performed via the Transformation endpoints.
+    # @param [String] transformation_id Required parameter: The ID of the
+    # transformation to download the API specification for. The transformation
+    # ID is received in the response of the [Transform Via File
+    # ]($e/Transformation/Transform%20via%20File) or [Transform Via
+    # URL]($e/Transformation/Transform%20via%20URL) calls.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def download_input_file(transformation_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/transformations/{transformation_id}/input-file',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transformation_id, key: 'transformation_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Get a list of all API transformations performed.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_all_transformations
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/transformations',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Transformation.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true))
+        .execute
+    end
+
+    # Get details on a particular Transformation performed via the
+    # Transformation endpoints.
+    # @param [String] transformation_id Required parameter: The ID of the
+    # transformation to fetch. The transformation ID is received in the response
+    # of the [Transform Via File ]($e/Transformation/Transform%20via%20File) or
+    # [Transform Via URL  ]($e/Transformation/Transform%20via%20URL) calls.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_a_transformation(transformation_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/transformations/{transformation_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transformation_id, key: 'transformation_id')
+                                    .is_required(true)
+                                    .should_encode(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(Transformation.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Delete a particular Transformation performed for an API via the
+    # Transformation endpoints.
+    # @param [String] transformation_id Required parameter: The ID of the
+    # transformation to delete. The transformation ID is received in the
+    # response of the [Transform Via File
+    # ]($e/Transformation/Transform%20via%20File) or [Transform Via
+    # URL]($e/Transformation/Transform%20via%20URL) calls.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_transformation(transformation_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/transformations/{transformation_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transformation_id, key: 'transformation_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/apimatic_api/exceptions/api_exception.rb

@@ -1,10 +1,21 @@
-# apimatic_api
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module ApimaticApi
-  # Class for exceptions when there is a network error, status code error, etc.
-  class APIException < CoreLibrary::ApiException
-  end
-end
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApimaticApi
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/apimatic_api/exceptions/bad_request_response_sdk_exception.rb

@@ -0,0 +1,46 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApimaticApi
+  # Standard JSON error response for bad requests
+  class BadRequestResponseSdkException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error message describing the bad request
+    # @return [String]
+    attr_accessor :message
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @message = hash.key?('message') ? hash['message'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message.inspect}>"
+    end
+  end
+end

data/lib/apimatic_api/exceptions/internal_server_error_response_exception.rb

@@ -0,0 +1,46 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApimaticApi
+  # InternalServerErrorResponse class.
+  class InternalServerErrorResponseException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @message = hash.key?('message') ? hash['message'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message.inspect}>"
+    end
+  end
+end

data/lib/apimatic_api/exceptions/problem_details_exception.rb

@@ -0,0 +1,74 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApimaticApi
+  # ProblemDetails class.
+  class ProblemDetailsException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :detail
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :instance
+
+    # TODO: Write general description for this method
+    # @return [Hash[String, Object]]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @type = hash.key?('type') ? hash['type'] : SKIP
+      @title = hash.key?('title') ? hash['title'] : SKIP
+      @status = hash.key?('status') ? hash['status'] : SKIP
+      @detail = hash.key?('detail') ? hash['detail'] : SKIP
+      @instance = hash.key?('instance') ? hash['instance'] : SKIP
+      @errors = hash.key?('errors') ? hash['errors'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, title: #{@title}, status: #{@status}, detail: #{@detail},"\
+      " instance: #{@instance}, errors: #{@errors}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, title: #{@title.inspect}, status:"\
+      " #{@status.inspect}, detail: #{@detail.inspect}, instance: #{@instance.inspect}, errors:"\
+      " #{@errors.inspect}>"
+    end
+  end
+end

data/lib/apimatic_api/exceptions/unauthorized_response_exception.rb

@@ -0,0 +1,46 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApimaticApi
+  # UnauthorizedResponse class.
+  class UnauthorizedResponseException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @message = hash.key?('message') ? hash['message'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message.inspect}>"
+    end
+  end
+end

data/lib/apimatic_api/http/api_response.rb

@@ -0,0 +1,19 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApimaticApi
+  # Http response received.
+  class ApiResponse < CoreLibrary::ApiResponse
+    # The constructor
+    # @param [HttpResponse] http_response The original, raw response from the api.
+    # @param [Object] data The data field specified for the response.
+    # @param [Array<String>] errors Any errors returned by the server.
+    def initialize(http_response,
+                   data: nil,
+                   errors: nil)
+      super
+    end
+  end
+end