sdksio-apimatic-sdk 3.0.0

data/lib/apimatic_api/controllers/docs_portal_management_controller.rb

@@ -0,0 +1,198 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # DocsPortalManagementController
+  class DocsPortalManagementController < BaseController
+    # Publish artifacts for a Hosted Portal.
+    # This endpoint regenerates all the artifacts for a hosted portal and
+    # uploads them to APIMatic's cloud storage, from where the Portal fetches
+    # them. These artifacts include:
+    # 1. SDKs
+    # 2. Docs
+    # 3. API Specification files
+    # Call this endpoint to update your Hosted Portal after you update an API
+    # Entity via any of the Import API Endpoints.
+    # __**Note: If you have an embedded portal against the same API Entity,
+    # artifacts for that portal will get updated as well.**__
+    # @param [String] api_entity_id Required parameter: The ID of the API Entity
+    # to update the portal artifacts for.
+    # @return [void] response from the API call
+    def publish_hosted_portal(api_entity_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/api-entities/{api_entity_id}/hosted-portal',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(api_entity_id, key: 'api_entity_id')
+                                    .should_encode(true))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                   .is_response_void(true))
+        .execute
+    end
+
+    # Publish artifacts for an Embedded Portal and get the Portal Embed script.
+    # This endpoint regenerates all the artifacts for an embedded portal and
+    # uploads them to APIMatic's cloud storage, from where the Portal fetches
+    # them. These artifacts include:
+    # 1. SDKs
+    # 2. Docs
+    # 3. API Specification files
+    # Call this endpoint to update your Embedded Portal after you update an API
+    # Entity via any of the Import API Endpoints. This endpoint returns the
+    # Portal Embed script in the response.
+    # __**Note: If you have a hosted portal against the same API Entity,
+    # artifacts for that portal will get updated as well.**__
+    # @param [String] api_entity_id Required parameter: The ID of the API Entity
+    # to update the portal artifacts for.
+    # @return [void] response from the API call
+    def publish_embedded_portal(api_entity_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/api-entities/{api_entity_id}/embedded-portal',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(api_entity_id, key: 'api_entity_id')
+                                    .should_encode(true))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                   .is_response_void(true))
+        .execute
+    end
+
+    # Generate an On-premise Documentation Portal for an API Entity. This
+    # endpoint generates all artifacts for the Portal and packages them together
+    # into a zip file along with the required HTML, CSS and JS files. The
+    # generated artifacts include:
+    # 1. SDKs
+    # 2. Docs
+    # 3. API Specification files
+    # The endpoint returns a zip file that contains a static Site and can be
+    # hosted on any Web Server.
+    # @param [String] api_entity_id Required parameter: The ID of the API Entity
+    # to generate the Portal for.
+    # @return [void] response from the API call
+    def generate_on_prem_portal_via_api_entity(api_entity_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api-entities/{api_entity_id}/on-prem-portal',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(api_entity_id, key: 'api_entity_id')
+                                    .should_encode(true))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                   .is_response_void(true))
+        .execute
+    end
+
+    # Generate an On-premise Documentation Portal by uploading a Portal Build
+    # Input. This endpoint generates all artifacts for the Portal and packages
+    # them together into a zip file along with the required HTML, CSS and JS
+    # files. The generated artifacts include:
+    # 1. SDKs
+    # 2. Docs
+    # 3. API Specification files
+    # The endpoint returns a zip file that contains a static Site and can be
+    # hosted on any Web Server.
+    # @param [File | UploadIO] file Required parameter: The input file to the
+    # Portal Generator. Must contain the build file.
+    # @return [Binary] response from the API call
+    def generate_on_prem_portal_via_build_input(file)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/portal',
+                                     Server::DEFAULT)
+                   .multipart_param(new_parameter(file, key: 'file')
+                                     .default_content_type('application/octet-stream'))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                   .local_error('400',
+                                'Bad Request',
+                                APIException)
+                   .local_error('401',
+                                'Unauthorized',
+                                APIException)
+                   .local_error('402',
+                                'Subscription Issue',
+                                APIException)
+                   .local_error('422',
+                                'Unprocessable Entity',
+                                APIException))
+        .execute
+    end
+
+    # Generate Build Input for a Portal created using the UI workflow.  The
+    # Build Input will correspond to the draft version of the Portal i.e.
+    # unpublished changes will also be included.
+    # This can be used to create a backup of your Portal or to migrate from the
+    # UI workflow to the docs as code workflow.
+    # @param [String] api_group_id Required parameter: Example:
+    # @param [Array[String]] api_entities Optional parameter: Example:
+    # @return [String] response from the API call
+    def generate_build_input_for_unpublished_portal(api_group_id,
+                                                    api_entities: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/portal/build/{apiGroupId}/draft',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(api_group_id, key: 'apiGroupId')
+                                    .should_encode(true))
+                   .query_param(new_parameter(api_entities, key: 'apiEntities'))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:deserialize_primitive_types))
+                   .deserialize_into(proc do |response| response.to_s end)
+                   .is_primitive_response(true))
+        .execute
+    end
+
+    # Generate Build Input for a Portal created using the UI workflow.  The
+    # Build Input will correspond to the published version of the Portal i.e.
+    # unpublished changes will not be inlcuded.
+    # This can be used to create a backup of your Portal or to migrate from the
+    # UI workflow to the docs as code workflow.
+    # @param [String] api_group_id Required parameter: Example:
+    # @param [Array[String]] api_entities Optional parameter: Example:
+    # @return [String] response from the API call
+    def generate_build_input_for_published_portal(api_group_id,
+                                                  api_entities: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/portal/build/{apiGroupId}/published',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(api_group_id, key: 'apiGroupId')
+                                    .should_encode(true))
+                   .query_param(new_parameter(api_entities, key: 'apiEntities'))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:deserialize_primitive_types))
+                   .deserialize_into(proc do |response| response.to_s end)
+                   .is_primitive_response(true))
+        .execute
+    end
+
+    # Unpublish a Hosted or Embedded Portal published for an API Entity. Calling
+    # this endpoint deletes all the published artifacts for a Portal from
+    # APIMatic's cloud storage.
+    # In case of a Hosted Portal, to completely remove the Portal, this endpoint
+    # needs to be called against all API versions that the Portal hosts.
+    # In case of an Embedded Portal, to completely remove the Portal, the user
+    # needs to manually remove the Portal Embed script from the embedding site.
+    # @param [String] api_entity_id Required parameter: The ID of the API Entity
+    # to unpublish the Portal artifacts for.
+    # @return [void] response from the API call
+    def unpublish_portal(api_entity_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/api-entities/{api_entity_id}/portal',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(api_entity_id, key: 'api_entity_id')
+                                    .should_encode(true))
+                   .auth(Single.new('Authorization')))
+        .response(new_response_handler
+                   .is_response_void(true))
+        .execute
+    end
+  end
+end

data/lib/apimatic_api/controllers/transformation_controller.rb

@@ -0,0 +1,174 @@
+# 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

data/lib/apimatic_api/exceptions/api_exception.rb

@@ -0,0 +1,10 @@
+# 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

data/lib/apimatic_api/http/auth/custom_header_authentication.rb

@@ -0,0 +1,42 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # Utility class for custom header authorization.
+  class CustomHeaderAuthentication < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'CustomHeaderAuthentication: authorization is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(custom_header_authentication_credentials)
+      auth_params = {}
+      auth_params['Authorization'] = custom_header_authentication_credentials.authorization unless
+        custom_header_authentication_credentials.nil? || custom_header_authentication_credentials.authorization.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for CustomHeaderAuthenticationCredentials.
+  # Data class for CustomHeaderAuthenticationCredentials.
+  class CustomHeaderAuthenticationCredentials
+    attr_reader :authorization
+
+    def initialize(authorization:)
+      raise ArgumentError, 'authorization cannot be nil' if authorization.nil?
+
+      @authorization = authorization
+    end
+
+    def clone_with(authorization: nil)
+      authorization ||= self.authorization
+
+      CustomHeaderAuthenticationCredentials.new(authorization: authorization)
+    end
+  end
+end

data/lib/apimatic_api/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/apimatic_api/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/apimatic_api/http/http_request.rb

@@ -0,0 +1,10 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/apimatic_api/http/http_response.rb

@@ -0,0 +1,10 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticApi
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end