Class: Conekta::PayoutOrdersApi
- Inherits:
-
Object
- Object
- Conekta::PayoutOrdersApi
- Defined in:
- lib/conekta/api/payout_orders_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#cancel_payout_order_by_id(id, opts = {}) ⇒ PayoutOrderResponse
Cancel Payout Order Cancel a payout Order resource that corresponds to a payout order ID.
-
#cancel_payout_order_by_id_with_http_info(id, opts = {}) ⇒ Array<(PayoutOrderResponse, Integer, Hash)>
Cancel Payout Order Cancel a payout Order resource that corresponds to a payout order ID.
-
#create_payout_order(payout_order, opts = {}) ⇒ PayoutOrderResponse
Create payout order Create a new payout order.
-
#create_payout_order_with_http_info(payout_order, opts = {}) ⇒ Array<(PayoutOrderResponse, Integer, Hash)>
Create payout order Create a new payout order.
-
#get_payout_order_by_id(id, opts = {}) ⇒ PayoutOrderResponse
Get Payout Order Gets a payout Order resource that corresponds to a payout order ID.
-
#get_payout_order_by_id_with_http_info(id, opts = {}) ⇒ Array<(PayoutOrderResponse, Integer, Hash)>
Get Payout Order Gets a payout Order resource that corresponds to a payout order ID.
-
#get_payout_orders(opts = {}) ⇒ PayoutOrdersResponse
Get a list of Payout Orders Get Payout order details in the form of a list.
-
#get_payout_orders_with_http_info(opts = {}) ⇒ Array<(PayoutOrdersResponse, Integer, Hash)>
Get a list of Payout Orders Get Payout order details in the form of a list.
-
#initialize(api_client = ApiClient.default) ⇒ PayoutOrdersApi
constructor
A new instance of PayoutOrdersApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ PayoutOrdersApi
Returns a new instance of PayoutOrdersApi.
19 20 21 |
# File 'lib/conekta/api/payout_orders_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/conekta/api/payout_orders_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#cancel_payout_order_by_id(id, opts = {}) ⇒ PayoutOrderResponse
Cancel Payout Order Cancel a payout Order resource that corresponds to a payout order ID.
28 29 30 31 |
# File 'lib/conekta/api/payout_orders_api.rb', line 28 def cancel_payout_order_by_id(id, opts = {}) data, _status_code, _headers = cancel_payout_order_by_id_with_http_info(id, opts) data end |
#cancel_payout_order_by_id_with_http_info(id, opts = {}) ⇒ Array<(PayoutOrderResponse, Integer, Hash)>
Cancel Payout Order Cancel a payout Order resource that corresponds to a payout order ID.
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/conekta/api/payout_orders_api.rb', line 39 def cancel_payout_order_by_id_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PayoutOrdersApi.cancel_payout_order_by_id ...' 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 PayoutOrdersApi.cancel_payout_order_by_id" 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 = '/payout_orders/{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.2.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] || 'PayoutOrderResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = opts.merge( :operation => :"PayoutOrdersApi.cancel_payout_order_by_id", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: PayoutOrdersApi#cancel_payout_order_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_payout_order(payout_order, opts = {}) ⇒ PayoutOrderResponse
Create payout order Create a new payout order.
98 99 100 101 |
# File 'lib/conekta/api/payout_orders_api.rb', line 98 def create_payout_order(payout_order, opts = {}) data, _status_code, _headers = create_payout_order_with_http_info(payout_order, opts) data end |
#create_payout_order_with_http_info(payout_order, opts = {}) ⇒ Array<(PayoutOrderResponse, Integer, Hash)>
Create payout order Create a new payout order.
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/conekta/api/payout_orders_api.rb', line 109 def create_payout_order_with_http_info(payout_order, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PayoutOrdersApi.create_payout_order ...' end # verify the required parameter 'payout_order' is set if @api_client.config.client_side_validation && payout_order.nil? fail ArgumentError, "Missing the required parameter 'payout_order' when calling PayoutOrdersApi.create_payout_order" 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 = '/payout_orders' # 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.2.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? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(payout_order) # return_type return_type = opts[:debug_return_type] || 'PayoutOrderResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = opts.merge( :operation => :"PayoutOrdersApi.create_payout_order", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: PayoutOrdersApi#create_payout_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_payout_order_by_id(id, opts = {}) ⇒ PayoutOrderResponse
Get Payout Order Gets a payout Order resource that corresponds to a payout order ID.
173 174 175 176 |
# File 'lib/conekta/api/payout_orders_api.rb', line 173 def get_payout_order_by_id(id, opts = {}) data, _status_code, _headers = get_payout_order_by_id_with_http_info(id, opts) data end |
#get_payout_order_by_id_with_http_info(id, opts = {}) ⇒ Array<(PayoutOrderResponse, Integer, Hash)>
Get Payout Order Gets a payout Order resource that corresponds to a payout order ID.
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/conekta/api/payout_orders_api.rb', line 184 def get_payout_order_by_id_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PayoutOrdersApi.get_payout_order_by_id ...' 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 PayoutOrdersApi.get_payout_order_by_id" 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 = '/payout_orders/{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.2.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] || 'PayoutOrderResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = opts.merge( :operation => :"PayoutOrdersApi.get_payout_order_by_id", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: PayoutOrdersApi#get_payout_order_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_payout_orders(opts = {}) ⇒ PayoutOrdersResponse
Get a list of Payout Orders Get Payout order details in the form of a list
246 247 248 249 |
# File 'lib/conekta/api/payout_orders_api.rb', line 246 def get_payout_orders(opts = {}) data, _status_code, _headers = get_payout_orders_with_http_info(opts) data end |
#get_payout_orders_with_http_info(opts = {}) ⇒ Array<(PayoutOrdersResponse, Integer, Hash)>
Get a list of Payout Orders Get Payout order details in the form of a list
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/conekta/api/payout_orders_api.rb', line 260 def get_payout_orders_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PayoutOrdersApi.get_payout_orders ...' 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 PayoutOrdersApi.get_payout_orders, 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 PayoutOrdersApi.get_payout_orders, must be greater than or equal to 1.' end # resource path local_var_path = '/payout_orders' # 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.2.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] || 'PayoutOrdersResponse' # auth_names auth_names = opts[:debug_auth_names] || ['bearerAuth'] = opts.merge( :operation => :"PayoutOrdersApi.get_payout_orders", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: PayoutOrdersApi#get_payout_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |