=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 PlansApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Create Plan # Create a new plan for an existing order # @param plan_request [PlanRequest] requested field for plan # @param [Hash] opts the optional parameters # @option opts [String] :accept_language Use for knowing which language to use (default to 'es') # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request. # @return [PlanResponse] def create_plan(plan_request, opts = {}) data, _status_code, _headers = create_plan_with_http_info(plan_request, opts) data end # Create Plan # Create a new plan for an existing order # @param plan_request [PlanRequest] requested field for plan # @param [Hash] opts the optional parameters # @option opts [String] :accept_language Use for knowing which language to use (default to 'es') # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request. # @return [Array<(PlanResponse, Integer, Hash)>] PlanResponse data, response status code and response headers def create_plan_with_http_info(plan_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PlansApi.create_plan ...' end # verify the required parameter 'plan_request' is set if @api_client.config.client_side_validation && plan_request.nil? fail ArgumentError, "Missing the required parameter 'plan_request' when calling PlansApi.create_plan" 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 = '/plans' # 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']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil? header_params[:'X-Child-Company-Id'] = opts[:'x_child_company_id'] if !opts[:'x_child_company_id'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(plan_request) # return_type return_type = opts[:debug_return_type] || 'PlanResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] new_options = opts.merge( :operation => :"PlansApi.create_plan", :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(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: PlansApi#create_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Delete Plan # @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 [PlanResponse] def delete_plan(id, opts = {}) data, _status_code, _headers = delete_plan_with_http_info(id, opts) data end # Delete Plan # @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<(PlanResponse, Integer, Hash)>] PlanResponse data, response status code and response headers def delete_plan_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PlansApi.delete_plan ...' 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 PlansApi.delete_plan" 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 = '/plans/{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] || 'PlanResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] new_options = opts.merge( :operation => :"PlansApi.delete_plan", :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(:DELETE, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: PlansApi#delete_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Get Plan # @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') # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request. # @return [PlanResponse] def get_plan(id, opts = {}) data, _status_code, _headers = get_plan_with_http_info(id, opts) data end # Get Plan # @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') # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request. # @return [Array<(PlanResponse, Integer, Hash)>] PlanResponse data, response status code and response headers def get_plan_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PlansApi.get_plan ...' 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 PlansApi.get_plan" 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 = '/plans/{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? header_params[:'X-Child-Company-Id'] = opts[:'x_child_company_id'] if !opts[:'x_child_company_id'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'PlanResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] new_options = opts.merge( :operation => :"PlansApi.get_plan", :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: PlansApi#get_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Get A List of Plans # @param [Hash] opts the optional parameters # @option opts [String] :accept_language Use for knowing which language to use (default to 'es') # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request. # @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 [GetPlansResponse] def get_plans(opts = {}) data, _status_code, _headers = get_plans_with_http_info(opts) data end # Get A List of Plans # @param [Hash] opts the optional parameters # @option opts [String] :accept_language Use for knowing which language to use (default to 'es') # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request. # @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<(GetPlansResponse, Integer, Hash)>] GetPlansResponse data, response status code and response headers def get_plans_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PlansApi.get_plans ...' 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 PlansApi.get_plans, 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 PlansApi.get_plans, must be greater than or equal to 1.' end # resource path local_var_path = '/plans' # 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? header_params[:'X-Child-Company-Id'] = opts[:'x_child_company_id'] if !opts[:'x_child_company_id'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'GetPlansResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] new_options = opts.merge( :operation => :"PlansApi.get_plans", :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: PlansApi#get_plans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Update Plan # @param id [String] Identifier of the resource # @param plan_update_request [PlanUpdateRequest] requested field for plan # @param [Hash] opts the optional parameters # @option opts [String] :accept_language Use for knowing which language to use (default to 'es') # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request. # @return [PlanResponse] def update_plan(id, plan_update_request, opts = {}) data, _status_code, _headers = update_plan_with_http_info(id, plan_update_request, opts) data end # Update Plan # @param id [String] Identifier of the resource # @param plan_update_request [PlanUpdateRequest] requested field for plan # @param [Hash] opts the optional parameters # @option opts [String] :accept_language Use for knowing which language to use (default to 'es') # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request. # @return [Array<(PlanResponse, Integer, Hash)>] PlanResponse data, response status code and response headers def update_plan_with_http_info(id, plan_update_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PlansApi.update_plan ...' 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 PlansApi.update_plan" end # verify the required parameter 'plan_update_request' is set if @api_client.config.client_side_validation && plan_update_request.nil? fail ArgumentError, "Missing the required parameter 'plan_update_request' when calling PlansApi.update_plan" 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 = '/plans/{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']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil? header_params[:'X-Child-Company-Id'] = opts[:'x_child_company_id'] if !opts[:'x_child_company_id'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(plan_update_request) # return_type return_type = opts[:debug_return_type] || 'PlanResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] new_options = opts.merge( :operation => :"PlansApi.update_plan", :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(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: PlansApi#update_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end