conekta 2.5.0 → 6.0.0

data/lib/conekta/api/companies_api.rb

@@ -0,0 +1,174 @@
+=begin
+#Conekta API
+
+#Conekta sdk
+
+The version of the OpenAPI document: 2.1.0
+Contact: engineering@conekta.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
+
+=end
+
+require 'cgi'
+
+module Conekta
+  class CompaniesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get List of Companies
+    # Consume the list of child companies.  This is used for holding companies with several child entities.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
+    # @option opts [Integer] :limit The numbers of items to return, the maximum value is 250 (default to 20)
+    # @option opts [String] :search General order search, e.g. by mail, reference etc.
+    # @option opts [String] :_next next page
+    # @option opts [String] :previous previous page
+    # @return [GetCompaniesResponse]
+    def get_companies(opts = {})
+      data, _status_code, _headers = get_companies_with_http_info(opts)
+      data
+    end
+
+    # Get List of Companies
+    # Consume the list of child companies.  This is used for holding companies with several child entities.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
+    # @option opts [Integer] :limit The numbers of items to return, the maximum value is 250 (default to 20)
+    # @option opts [String] :search General order search, e.g. by mail, reference etc.
+    # @option opts [String] :_next next page
+    # @option opts [String] :previous previous page
+    # @return [Array<(GetCompaniesResponse, Integer, Hash)>] GetCompaniesResponse data, response status code and response headers
+    def get_companies_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompaniesApi.get_companies ...'
+      end
+      allowable_values = ["es", "en"]
+      if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
+        fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CompaniesApi.get_companies, must be smaller than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CompaniesApi.get_companies, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/companies'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
+      query_params[:'next'] = opts[:'_next'] if !opts[:'_next'].nil?
+      query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.conekta-v2.1.0+json'])
+      header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetCompaniesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CompaniesApi.get_companies",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompaniesApi#get_companies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Company
+    # @param id [String] Identifier of the resource
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
+    # @return [CompanyResponse]
+    def get_company(id, opts = {})
+      data, _status_code, _headers = get_company_with_http_info(id, opts)
+      data
+    end
+
+    # Get Company
+    # @param id [String] Identifier of the resource
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
+    # @return [Array<(CompanyResponse, Integer, Hash)>] CompanyResponse data, response status code and response headers
+    def get_company_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompaniesApi.get_company ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling CompaniesApi.get_company"
+      end
+      allowable_values = ["es", "en"]
+      if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
+        fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/companies/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.conekta-v2.1.0+json'])
+      header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CompanyResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CompaniesApi.get_company",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompaniesApi#get_company\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end