=begin #Conekta API #Conekta sdk The version of the OpenAPI document: 2.1.0 Contact: engineering@conekta.com Generated by: https://openapi-generator.tech Generator version: 7.5.0 =end require 'cgi' module Conekta class PaymentLinkApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Cancel Payment Link # @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 [CheckoutResponse] def cancel_checkout(id, opts = {}) data, _status_code, _headers = cancel_checkout_with_http_info(id, opts) data end # Cancel Payment Link # @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<(CheckoutResponse, Integer, Hash)>] CheckoutResponse data, response status code and response headers def cancel_checkout_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentLinkApi.cancel_checkout ...' 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 PaymentLinkApi.cancel_checkout" 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 = '/checkouts/{id}/cancel'.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] || 'CheckoutResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] new_options = opts.merge( :operation => :"PaymentLinkApi.cancel_checkout", :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: PaymentLinkApi#cancel_checkout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Create Unique Payment Link # @param checkout [Checkout] requested field for checkout # @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 [CheckoutResponse] def create_checkout(checkout, opts = {}) data, _status_code, _headers = create_checkout_with_http_info(checkout, opts) data end # Create Unique Payment Link # @param checkout [Checkout] requested field for checkout # @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<(CheckoutResponse, Integer, Hash)>] CheckoutResponse data, response status code and response headers def create_checkout_with_http_info(checkout, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentLinkApi.create_checkout ...' end # verify the required parameter 'checkout' is set if @api_client.config.client_side_validation && checkout.nil? fail ArgumentError, "Missing the required parameter 'checkout' when calling PaymentLinkApi.create_checkout" 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 = '/checkouts' # 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(checkout) # return_type return_type = opts[:debug_return_type] || 'CheckoutResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] new_options = opts.merge( :operation => :"PaymentLinkApi.create_checkout", :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: PaymentLinkApi#create_checkout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Send an email # @param id [String] Identifier of the resource # @param email_checkout_request [EmailCheckoutRequest] requested field for sms checkout # @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 [CheckoutResponse] def email_checkout(id, email_checkout_request, opts = {}) data, _status_code, _headers = email_checkout_with_http_info(id, email_checkout_request, opts) data end # Send an email # @param id [String] Identifier of the resource # @param email_checkout_request [EmailCheckoutRequest] requested field for sms checkout # @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<(CheckoutResponse, Integer, Hash)>] CheckoutResponse data, response status code and response headers def email_checkout_with_http_info(id, email_checkout_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentLinkApi.email_checkout ...' 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 PaymentLinkApi.email_checkout" end # verify the required parameter 'email_checkout_request' is set if @api_client.config.client_side_validation && email_checkout_request.nil? fail ArgumentError, "Missing the required parameter 'email_checkout_request' when calling PaymentLinkApi.email_checkout" 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 = '/checkouts/{id}/email'.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(email_checkout_request) # return_type return_type = opts[:debug_return_type] || 'CheckoutResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] new_options = opts.merge( :operation => :"PaymentLinkApi.email_checkout", :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: PaymentLinkApi#email_checkout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Get a payment link by ID # @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 [CheckoutResponse] def get_checkout(id, opts = {}) data, _status_code, _headers = get_checkout_with_http_info(id, opts) data end # Get a payment link by ID # @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<(CheckoutResponse, Integer, Hash)>] CheckoutResponse data, response status code and response headers def get_checkout_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentLinkApi.get_checkout ...' 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 PaymentLinkApi.get_checkout" 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 = '/checkouts/{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] || 'CheckoutResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] new_options = opts.merge( :operation => :"PaymentLinkApi.get_checkout", :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: PaymentLinkApi#get_checkout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Get a list of payment links # Returns a list of links generated by the merchant # @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 [CheckoutsResponse] def get_checkouts(opts = {}) data, _status_code, _headers = get_checkouts_with_http_info(opts) data end # Get a list of payment links # Returns a list of links generated by the merchant # @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<(CheckoutsResponse, Integer, Hash)>] CheckoutsResponse data, response status code and response headers def get_checkouts_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentLinkApi.get_checkouts ...' 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 PaymentLinkApi.get_checkouts, 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 PaymentLinkApi.get_checkouts, must be greater than or equal to 1.' end # resource path local_var_path = '/checkouts' # 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] || 'CheckoutsResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] new_options = opts.merge( :operation => :"PaymentLinkApi.get_checkouts", :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: PaymentLinkApi#get_checkouts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Send an sms # @param id [String] Identifier of the resource # @param sms_checkout_request [SmsCheckoutRequest] requested field for sms checkout # @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 [CheckoutResponse] def sms_checkout(id, sms_checkout_request, opts = {}) data, _status_code, _headers = sms_checkout_with_http_info(id, sms_checkout_request, opts) data end # Send an sms # @param id [String] Identifier of the resource # @param sms_checkout_request [SmsCheckoutRequest] requested field for sms checkout # @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<(CheckoutResponse, Integer, Hash)>] CheckoutResponse data, response status code and response headers def sms_checkout_with_http_info(id, sms_checkout_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentLinkApi.sms_checkout ...' 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 PaymentLinkApi.sms_checkout" end # verify the required parameter 'sms_checkout_request' is set if @api_client.config.client_side_validation && sms_checkout_request.nil? fail ArgumentError, "Missing the required parameter 'sms_checkout_request' when calling PaymentLinkApi.sms_checkout" 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 = '/checkouts/{id}/sms'.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(sms_checkout_request) # return_type return_type = opts[:debug_return_type] || 'CheckoutResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] new_options = opts.merge( :operation => :"PaymentLinkApi.sms_checkout", :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: PaymentLinkApi#sms_checkout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end