sdksio-apimatic-sdk 3.0.0 → 3.0.1

data/lib/apimatic_api/controllers/code_generation_imported_apis_controller.rb

@@ -1,136 +0,0 @@
-# apimatic_api
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module ApimaticApi
-  # CodeGenerationImportedApisController
-  class CodeGenerationImportedApisController < BaseController
-    # Generate an SDK for an API Version.
-    # This endpoint generates and then uploads the generated SDK to APIMatic's
-    # cloud storage. An ID for the generation performed is returned as part of
-    # the response.
-    # @param [String] api_entity_id Required parameter: The ID of the API Entity
-    # to generate the SDK for.
-    # @param [Platforms] template Required parameter: The structure contains
-    # platforms that APIMatic CodeGen can generate SDKs and Docs in.
-    # @return [APIEntityCodeGeneration] response from the API call
-    def generate_sdk(api_entity_id,
-                     template)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/api-entities/{api_entity_id}/code-generations/generate',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(api_entity_id, key: 'api_entity_id')
-                                    .should_encode(true))
-                   .form_param(new_parameter(template, key: 'template'))
-                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
-                   .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('Authorization')))
-        .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(APIEntityCodeGeneration.method(:from_hash)))
-        .execute
-    end
-
-    # Download the SDK generated via the Generate SDK endpoint.
-    # @param [String] api_entity_id Required parameter: The ID of the API Entity
-    # for which the SDK was generated.
-    # @param [String] codegen_id Required parameter: The ID of code generation
-    # received in the response of the [SDK generation
-    # call](https://www.apimatic.io/api-docs-preview/dashboard/60eea3b7a73395c30
-    # 52d961b/v/3_0#/http/api-endpoints/code-generation-imported-apis/generate-s
-    # dk).
-    # @return [Binary] response from the API call
-    def download_sdk(api_entity_id,
-                     codegen_id)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/api-entities/{api_entity_id}/code-generations/{codegen_id}/generated-sdk',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(api_entity_id, key: 'api_entity_id')
-                                    .should_encode(true))
-                   .template_param(new_parameter(codegen_id, key: 'codegen_id')
-                                    .should_encode(true))
-                   .auth(Single.new('Authorization')))
-        .response(new_response_handler)
-        .execute
-    end
-
-    # Get a list of all SDK generations done against an API Version via the
-    # Generate SDK endpoint.
-    # @param [String] api_entity_id Required parameter: The ID of the API Entity
-    # for which to list code generations.
-    # @return [Array[APIEntityCodeGeneration]] response from the API call
-    def list_all_code_generations_imported(api_entity_id)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/api-entities/{api_entity_id}/code-generations',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(api_entity_id, key: 'api_entity_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(APIEntityCodeGeneration.method(:from_hash))
-                   .is_response_array(true))
-        .execute
-    end
-
-    # Get details on an SDK generation performed via the Generate SDK endpoint.
-    # @param [String] api_entity_id Required parameter: The ID of the API Entity
-    # to fetch the code generation for.
-    # @param [String] codegen_id Required parameter: The ID of the code
-    # generation to fetch. The code generation ID is received in the response of
-    # the [SDK generation
-    # call](https://www.apimatic.io/api-docs-preview/dashboard/60eea3b7a73395c30
-    # 52d961b/v/3_0#/http/api-endpoints/code-generation-imported-apis/generate-s
-    # dk).
-    # @return [APIEntityCodeGeneration] response from the API call
-    def get_a_code_generation_imported(api_entity_id,
-                                       codegen_id)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/api-entities/{api_entity_id}/code-generations/{codegen_id}',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(api_entity_id, key: 'api_entity_id')
-                                    .should_encode(true))
-                   .template_param(new_parameter(codegen_id, key: 'codegen_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(APIEntityCodeGeneration.method(:from_hash)))
-        .execute
-    end
-
-    # Delete an SDK generation performed for an API Version via the Generate SDK
-    # endpoint.
-    # @param [String] api_entity_id Required parameter: The ID of the API Entity
-    # to delete the code generation for.
-    # @param [String] codegen_id Required parameter: The ID of the code
-    # generation to delete. The code generation ID is received in the response
-    # of the [SDK generation
-    # call](https://www.apimatic.io/api-docs-preview/dashboard/60eea3b7a73395c30
-    # 52d961b/v/3_0#/http/api-endpoints/code-generation-imported-apis/generate-s
-    # dk).
-    # @return [void] response from the API call
-    def delete_code_generation(api_entity_id,
-                               codegen_id)
-      new_api_call_builder
-        .request(new_request_builder(HttpMethodEnum::DELETE,
-                                     '/api-entities/{api_entity_id}/code-generations/{codegen_id}',
-                                     Server::DEFAULT)
-                   .template_param(new_parameter(api_entity_id, key: 'api_entity_id')
-                                    .should_encode(true))
-                   .template_param(new_parameter(codegen_id, key: 'codegen_id')
-                                    .should_encode(true))
-                   .auth(Single.new('Authorization')))
-        .response(new_response_handler
-                   .is_response_void(true))
-        .execute
-    end
-  end
-end

data/lib/apimatic_api/models/api_entity.rb

@@ -1,220 +0,0 @@
-# apimatic_api
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module ApimaticApi
-  # The API Entity Structure encapsulates all the details of an API Entity. An
-  # API entity is a unique API Version.
-  class ApiEntity < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # Unique API Entity identifier
-    # @return [String]
-    attr_accessor :id
-
-    # Enrcypted API Entity Id
-    # @return [String]
-    attr_accessor :encrypted_id
-
-    # API Integration Key. Obtain from API Card on Dashboard.
-    # @return [String]
-    attr_accessor :api_key
-
-    # Unique API Group Identifier
-    # @return [String]
-    attr_accessor :api_group_id
-
-    # Cover Image
-    # @return [String]
-    attr_accessor :image_uri
-
-    # Entity creation date
-    # @return [String]
-    attr_accessor :creation_date
-
-    # API Status (Deprecated)
-    # @return [TrueClass | FalseClass]
-    attr_accessor :public
-
-    # API Entity  Name
-    # @return [String]
-    attr_accessor :name
-
-    # Description of the API
-    # @return [String]
-    attr_accessor :description
-
-    # Entity Version Number
-    # @return [String]
-    attr_accessor :version
-
-    # Header Content
-    # @return [Array[String]]
-    attr_accessor :additional_headers
-
-    # This Structure encapsulates all details of API authentication.
-    # @return [Authentication]
-    attr_accessor :authentication
-
-    # APIMatic’s code generation engine has various code generation
-    # configurations to customise the behaviour and outlook across the generated
-    # SDKS. This structure encapsulates all settings for CodeGeneration.
-    # @return [CodeGenSettings]
-    attr_accessor :code_gen_settings
-
-    # This structure helps specify additional test configurations which affects
-    # how test cases are generated.
-    # @return [TestGenSettings]
-    attr_accessor :test_gen_settings
-
-    # API Errors
-    # @return [Array[String]]
-    attr_accessor :errors
-
-    # Server configurations can be used to create multiple environments,
-    # multiple servers that can be used with specific endpoints and server URLs
-    # with template paramters.
-    # @return [ServerConfiguration]
-    attr_accessor :server_configuration
-
-    # API Endpoint Groups
-    # @return [Array[EndpointsGroup]]
-    attr_accessor :endpoints_group
-
-    # API Endpoint Groups
-    # @return [MetaData]
-    attr_accessor :meta_data
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['id'] = 'id'
-      @_hash['encrypted_id'] = 'encryptedId'
-      @_hash['api_key'] = 'apiKey'
-      @_hash['api_group_id'] = 'apiGroupId'
-      @_hash['image_uri'] = 'imageUri'
-      @_hash['creation_date'] = 'creationDate'
-      @_hash['public'] = 'public'
-      @_hash['name'] = 'name'
-      @_hash['description'] = 'description'
-      @_hash['version'] = 'version'
-      @_hash['additional_headers'] = 'additionalHeaders'
-      @_hash['authentication'] = 'authentication'
-      @_hash['code_gen_settings'] = 'codeGenSettings'
-      @_hash['test_gen_settings'] = 'testGenSettings'
-      @_hash['errors'] = 'errors'
-      @_hash['server_configuration'] = 'serverConfiguration'
-      @_hash['endpoints_group'] = 'endpointsGroup'
-      @_hash['meta_data'] = 'metaData'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      []
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(id = nil,
-                   encrypted_id = nil,
-                   api_key = nil,
-                   api_group_id = nil,
-                   image_uri = nil,
-                   creation_date = nil,
-                   public = nil,
-                   name = nil,
-                   description = nil,
-                   version = nil,
-                   additional_headers = nil,
-                   authentication = nil,
-                   code_gen_settings = nil,
-                   test_gen_settings = nil,
-                   errors = nil,
-                   server_configuration = nil,
-                   endpoints_group = nil,
-                   meta_data = nil)
-      @id = id
-      @encrypted_id = encrypted_id
-      @api_key = api_key
-      @api_group_id = api_group_id
-      @image_uri = image_uri
-      @creation_date = creation_date
-      @public = public
-      @name = name
-      @description = description
-      @version = version
-      @additional_headers = additional_headers
-      @authentication = authentication
-      @code_gen_settings = code_gen_settings
-      @test_gen_settings = test_gen_settings
-      @errors = errors
-      @server_configuration = server_configuration
-      @endpoints_group = endpoints_group
-      @meta_data = meta_data
-    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
-      encrypted_id = hash.key?('encryptedId') ? hash['encryptedId'] : nil
-      api_key = hash.key?('apiKey') ? hash['apiKey'] : nil
-      api_group_id = hash.key?('apiGroupId') ? hash['apiGroupId'] : nil
-      image_uri = hash.key?('imageUri') ? hash['imageUri'] : nil
-      creation_date = hash.key?('creationDate') ? hash['creationDate'] : nil
-      public = hash.key?('public') ? hash['public'] : nil
-      name = hash.key?('name') ? hash['name'] : nil
-      description = hash.key?('description') ? hash['description'] : nil
-      version = hash.key?('version') ? hash['version'] : nil
-      additional_headers =
-        hash.key?('additionalHeaders') ? hash['additionalHeaders'] : nil
-      authentication = Authentication.from_hash(hash['authentication']) if hash['authentication']
-      code_gen_settings = CodeGenSettings.from_hash(hash['codeGenSettings']) if
-        hash['codeGenSettings']
-      test_gen_settings = TestGenSettings.from_hash(hash['testGenSettings']) if
-        hash['testGenSettings']
-      errors = hash.key?('errors') ? hash['errors'] : nil
-      server_configuration = ServerConfiguration.from_hash(hash['serverConfiguration']) if
-        hash['serverConfiguration']
-      # Parameter is an array, so we need to iterate through it
-      endpoints_group = nil
-      unless hash['endpointsGroup'].nil?
-        endpoints_group = []
-        hash['endpointsGroup'].each do |structure|
-          endpoints_group << (EndpointsGroup.from_hash(structure) if structure)
-        end
-      end
-
-      endpoints_group = nil unless hash.key?('endpointsGroup')
-      meta_data = MetaData.from_hash(hash['metaData']) if hash['metaData']
-
-      # Create object from extracted values.
-      ApiEntity.new(id,
-                    encrypted_id,
-                    api_key,
-                    api_group_id,
-                    image_uri,
-                    creation_date,
-                    public,
-                    name,
-                    description,
-                    version,
-                    additional_headers,
-                    authentication,
-                    code_gen_settings,
-                    test_gen_settings,
-                    errors,
-                    server_configuration,
-                    endpoints_group,
-                    meta_data)
-    end
-  end
-end

data/lib/apimatic_api/models/api_entity_code_generation.rb

@@ -1,131 +0,0 @@
-# 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 against an API Entity
-  class APIEntityCodeGeneration < 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 API Entity Identifier
-    # @return [String]
-    attr_accessor :api_entity_id
-
-    # 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['api_entity_id'] = 'apiEntityId'
-      @_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,
-                   api_entity_id = 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
-      @api_entity_id = api_entity_id
-    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
-      api_entity_id = hash.key?('apiEntityId') ? hash['apiEntityId'] : nil
-
-      # Create object from extracted values.
-      APIEntityCodeGeneration.new(id,
-                                  template,
-                                  generated_file,
-                                  generated_on,
-                                  hash_code,
-                                  code_generation_source,
-                                  code_gen_version,
-                                  success,
-                                  api_entity_id)
-    end
-
-    def to_custom_generated_on
-      DateTimeHelper.to_rfc3339(generated_on)
-    end
-  end
-end

data/lib/apimatic_api/models/api_entity_identifier.rb

@@ -1,48 +0,0 @@
-# apimatic_api
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module ApimaticApi
-  # APIEntityIdentifier Model.
-  class APIEntityIdentifier < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # Unique API Entity Identifier
-    # @return [String]
-    attr_accessor :api_entity_id
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['api_entity_id'] = 'apiEntityId'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      []
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(api_entity_id = nil)
-      @api_entity_id = api_entity_id
-    end
-
-    # Creates an instance of the object from a hash.
-    def self.from_hash(hash)
-      return nil unless hash
-
-      # Extract variables from the hash.
-      api_entity_id = hash.key?('apiEntityId') ? hash['apiEntityId'] : nil
-
-      # Create object from extracted values.
-      APIEntityIdentifier.new(api_entity_id)
-    end
-  end
-end

data/lib/apimatic_api/models/attributes.rb

@@ -1,48 +0,0 @@
-# apimatic_api
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module ApimaticApi
-  # The structure contain attribute details of a parameter type.
-  class Attributes < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # Unique Attribute Identifier
-    # @return [String]
-    attr_accessor :id
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['id'] = 'id'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      []
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(id = nil)
-      @id = id
-    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
-
-      # Create object from extracted values.
-      Attributes.new(id)
-    end
-  end
-end

data/lib/apimatic_api/models/auth_scope.rb

@@ -1,75 +0,0 @@
-# apimatic_api
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module ApimaticApi
-  # AuthScope Model.
-  class AuthScope < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # Scope Id
-    # @return [String]
-    attr_accessor :id
-
-    # Scope Name
-    # @return [String]
-    attr_accessor :name
-
-    # Scope Value
-    # @return [String]
-    attr_accessor :value
-
-    # Scope Description
-    # @return [String]
-    attr_accessor :description
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['id'] = 'id'
-      @_hash['name'] = 'name'
-      @_hash['value'] = 'value'
-      @_hash['description'] = 'description'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      []
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(id = nil,
-                   name = nil,
-                   value = nil,
-                   description = nil)
-      @id = id
-      @name = name
-      @value = value
-      @description = description
-    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
-      name = hash.key?('name') ? hash['name'] : nil
-      value = hash.key?('value') ? hash['value'] : nil
-      description = hash.key?('description') ? hash['description'] : nil
-
-      # Create object from extracted values.
-      AuthScope.new(id,
-                    name,
-                    value,
-                    description)
-    end
-  end
-end