sdksio-apimatic-sdk 3.0.0

data/test/controllers/test_code_generation_external_apis_controller.rb

@@ -0,0 +1,32 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class CodeGenerationExternalApisControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    setup_class
+    @controller = @client.code_generation_external_apis
+    @response_catcher = @controller.http_call_back
+  end
+
+  # Get a list of all SDK generations performed with external APIs via the Generate SDK endpoints.
+  def test_list_all_code_generations_external
+
+    # Perform the API call through the SDK function
+    result = @controller.list_all_code_generations_external()
+
+    # 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))
+  end
+
+end

data/test/controllers/test_docs_portal_management_controller.rb

@@ -0,0 +1,94 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class DocsPortalManagementControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    setup_class
+    @controller = @client.docs_portal_management
+    @response_catcher = @controller.http_call_back
+  end
+
+  # 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.**__
+  def test_publish_hosted_portal
+    # Parameters for the API call
+    api_entity_id = '5f87f8ab9615d38a2eb990ca'
+
+    # Perform the API call through the SDK function
+    @controller.publish_hosted_portal(api_entity_id)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+  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.**__
+  def test_publish_embedded_portal
+    # Parameters for the API call
+    api_entity_id = '5f87f8ab9615d38a2eb990ca'
+
+    # Perform the API call through the SDK function
+    @controller.publish_embedded_portal(api_entity_id)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+  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.
+  def test_generate_on_prem_portal_via_api_entity
+    # Parameters for the API call
+    api_entity_id = '5f87f8ab9615d38a2eb990ca'
+
+    # Perform the API call through the SDK function
+    @controller.generate_on_prem_portal_via_api_entity(api_entity_id)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+  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.
+  def test_unpublish_portal
+    # Parameters for the API call
+    api_entity_id = '5f87f8ab9615d38a2eb990ca'
+
+    # Perform the API call through the SDK function
+    @controller.unpublish_portal(api_entity_id)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+  end
+
+end

data/test/controllers/test_transformation_controller.rb

@@ -0,0 +1,32 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class TransformationControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    setup_class
+    @controller = @client.transformation
+    @response_catcher = @controller.http_call_back
+  end
+
+  # Get a list of all API transformations performed.
+  def test_list_all_transformations
+
+    # Perform the API call through the SDK function
+    result = @controller.list_all_transformations()
+
+    # 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))
+  end
+
+end

data/test/http_response_catcher.rb

@@ -0,0 +1,19 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+class HttpResponseCatcher < ApimaticApi::HttpCallBack
+  attr_accessor :response
+
+  def on_before_request(request)
+  end
+
+  # Catching the response
+  def on_after_response(response)
+    @response = response
+  end
+end
+
+
+

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: sdksio-apimatic-sdk
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- developer-sdks-io
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: apimatic_core_interfaces
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: apimatic_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: apimatic_faraday_client_adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+- !ruby/object:Gem::Dependency
+  name: minitest-proveit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 'the package contains the SDKS for all the endpoints available on : https://docs.apimatic.io/platform-api/#/http/getting-started'
+email:
+- developer+sdksio@apimatic.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/apimatic_api.rb
+- lib/apimatic_api/api_helper.rb
+- lib/apimatic_api/client.rb
+- lib/apimatic_api/configuration.rb
+- lib/apimatic_api/controllers/api_validation_external_apis_controller.rb
+- lib/apimatic_api/controllers/api_validation_imported_apis_controller.rb
+- lib/apimatic_api/controllers/apis_management_controller.rb
+- lib/apimatic_api/controllers/base_controller.rb
+- lib/apimatic_api/controllers/code_generation_external_apis_controller.rb
+- lib/apimatic_api/controllers/code_generation_imported_apis_controller.rb
+- lib/apimatic_api/controllers/docs_portal_management_controller.rb
+- lib/apimatic_api/controllers/transformation_controller.rb
+- lib/apimatic_api/exceptions/api_exception.rb
+- lib/apimatic_api/http/auth/custom_header_authentication.rb
+- lib/apimatic_api/http/http_call_back.rb
+- lib/apimatic_api/http/http_method_enum.rb
+- lib/apimatic_api/http/http_request.rb
+- lib/apimatic_api/http/http_response.rb
+- lib/apimatic_api/models/api_entity.rb
+- lib/apimatic_api/models/api_entity_code_generation.rb
+- lib/apimatic_api/models/api_entity_identifier.rb
+- lib/apimatic_api/models/api_validation_summary.rb
+- lib/apimatic_api/models/attributes.rb
+- lib/apimatic_api/models/auth_scope.rb
+- lib/apimatic_api/models/authentication.rb
+- lib/apimatic_api/models/base_model.rb
+- lib/apimatic_api/models/code_gen_settings.rb
+- lib/apimatic_api/models/code_generation.rb
+- lib/apimatic_api/models/docs_validation_summary.rb
+- lib/apimatic_api/models/endpoints_group.rb
+- lib/apimatic_api/models/environment.rb
+- lib/apimatic_api/models/export_formats.rb
+- lib/apimatic_api/models/field.rb
+- lib/apimatic_api/models/generate_on_prem_portal_via_build_input_request_body.rb
+- lib/apimatic_api/models/generate_sdk_via_file_request_body.rb
+- lib/apimatic_api/models/generate_sdk_via_url_request.rb
+- lib/apimatic_api/models/import_api_version_via_url_request.rb
+- lib/apimatic_api/models/import_api_via_file_request_body.rb
+- lib/apimatic_api/models/import_api_via_url_request.rb
+- lib/apimatic_api/models/import_new_api_version_via_file_request_body.rb
+- lib/apimatic_api/models/import_validation_summary.rb
+- lib/apimatic_api/models/inplace_api_import_binary_file.rb
+- lib/apimatic_api/models/inplace_import_api_via_url_request.rb
+- lib/apimatic_api/models/meta_data.rb
+- lib/apimatic_api/models/parameter.rb
+- lib/apimatic_api/models/paramter_format_details.rb
+- lib/apimatic_api/models/platforms.rb
+- lib/apimatic_api/models/platforms_template.rb
+- lib/apimatic_api/models/server.rb
+- lib/apimatic_api/models/server_configuration.rb
+- lib/apimatic_api/models/test_gen_settings.rb
+- lib/apimatic_api/models/transform_via_file_request_body.rb
+- lib/apimatic_api/models/transform_via_url_request.rb
+- lib/apimatic_api/models/transformation.rb
+- lib/apimatic_api/models/user_code_generation.rb
+- lib/apimatic_api/models/user_code_generation_requirements.rb
+- lib/apimatic_api/models/validate_api_via_file_request_body.rb
+- lib/apimatic_api/utilities/date_time_helper.rb
+- lib/apimatic_api/utilities/file_wrapper.rb
+- test/controllers/controller_test_base.rb
+- test/controllers/test_api_validation_external_apis_controller.rb
+- test/controllers/test_api_validation_imported_apis_controller.rb
+- test/controllers/test_code_generation_external_apis_controller.rb
+- test/controllers/test_docs_portal_management_controller.rb
+- test/controllers/test_transformation_controller.rb
+- test/http_response_catcher.rb
+homepage: https://app.apimatic.io/
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: SDKS for Apimatic
+test_files: []