Class: PhoneComClient::PaymentMethodsApi
- Inherits:
-
Object
- Object
- PhoneComClient::PaymentMethodsApi
- Defined in:
- lib/phone_com_client/api/payment_methods_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_account_payment_method(account_id, data, opts = {}) ⇒ PaymentFull
Create an individual payment method.
-
#create_account_payment_method_with_http_info(account_id, data, opts = {}) ⇒ Array<(PaymentFull, Fixnum, Hash)>
Create an individual payment method.
-
#delete_account_payment_method(account_id, pm_id, opts = {}) ⇒ DeleteEntry
Delete an individual payment method.
-
#delete_account_payment_method_with_http_info(account_id, pm_id, opts = {}) ⇒ Array<(DeleteEntry, Fixnum, Hash)>
Delete an individual payment method.
-
#get_account_payment_method(account_id, pm_id, opts = {}) ⇒ PaymentFull
Show details of an individual payment method.
-
#get_account_payment_method_with_http_info(account_id, pm_id, opts = {}) ⇒ Array<(PaymentFull, Fixnum, Hash)>
Show details of an individual payment method.
-
#initialize(api_client = ApiClient.default) ⇒ PaymentMethodsApi
constructor
A new instance of PaymentMethodsApi.
-
#list_account_payment_methods(account_id, opts = {}) ⇒ ListPaymentMethods
Get a list of payment methods for an account.
-
#list_account_payment_methods_with_http_info(account_id, opts = {}) ⇒ Array<(ListPaymentMethods, Fixnum, Hash)>
Get a list of payment methods for an account.
-
#patch_account_payment_method(account_id, pm_id, opts = {}) ⇒ PaymentFull
Replace the status of an individual payment method.
-
#patch_account_payment_method_with_http_info(account_id, pm_id, opts = {}) ⇒ Array<(PaymentFull, Fixnum, Hash)>
Replace the status of an individual payment method.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ PaymentMethodsApi
Returns a new instance of PaymentMethodsApi.
19 20 21 |
# File 'lib/phone_com_client/api/payment_methods_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/phone_com_client/api/payment_methods_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_account_payment_method(account_id, data, opts = {}) ⇒ PaymentFull
Create an individual payment method. Create an individual payment method. See Account Payment Methods for more info on the properties.
28 29 30 31 |
# File 'lib/phone_com_client/api/payment_methods_api.rb', line 28 def create_account_payment_method(account_id, data, opts = {}) data, _status_code, _headers = create_account_payment_method_with_http_info(account_id, data, opts) data end |
#create_account_payment_method_with_http_info(account_id, data, opts = {}) ⇒ Array<(PaymentFull, Fixnum, Hash)>
Create an individual payment method. Create an individual payment method. See Account Payment Methods for more info on the properties.
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 |
# File 'lib/phone_com_client/api/payment_methods_api.rb', line 39 def create_account_payment_method_with_http_info(account_id, data, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentMethodsApi.create_account_payment_method ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling PaymentMethodsApi.create_account_payment_method" end # verify the required parameter 'data' is set if @api_client.config.client_side_validation && data.nil? fail ArgumentError, "Missing the required parameter 'data' when calling PaymentMethodsApi.create_account_payment_method" end # resource path local_var_path = '/accounts/{account_id}/payment-methods'.sub('{' + 'account_id' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(data) auth_names = ['apiKey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PaymentFull') if @api_client.config.debugging @api_client.config.logger.debug "API called: PaymentMethodsApi#create_account_payment_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_account_payment_method(account_id, pm_id, opts = {}) ⇒ DeleteEntry
Delete an individual payment method. Delete an individual payment method. See Account Payment Methods for more info on the properties.
88 89 90 91 |
# File 'lib/phone_com_client/api/payment_methods_api.rb', line 88 def delete_account_payment_method(account_id, pm_id, opts = {}) data, _status_code, _headers = delete_account_payment_method_with_http_info(account_id, pm_id, opts) data end |
#delete_account_payment_method_with_http_info(account_id, pm_id, opts = {}) ⇒ Array<(DeleteEntry, Fixnum, Hash)>
Delete an individual payment method. Delete an individual payment method. See Account Payment Methods for more info on the properties.
99 100 101 102 103 104 105 106 107 108 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 |
# File 'lib/phone_com_client/api/payment_methods_api.rb', line 99 def delete_account_payment_method_with_http_info(account_id, pm_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentMethodsApi.delete_account_payment_method ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling PaymentMethodsApi.delete_account_payment_method" end # verify the required parameter 'pm_id' is set if @api_client.config.client_side_validation && pm_id.nil? fail ArgumentError, "Missing the required parameter 'pm_id' when calling PaymentMethodsApi.delete_account_payment_method" end # resource path local_var_path = '/accounts/{account_id}/payment-methods/{pm_id}'.sub('{' + 'account_id' + '}', account_id.to_s).sub('{' + 'pm_id' + '}', pm_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['apiKey'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'DeleteEntry') if @api_client.config.debugging @api_client.config.logger.debug "API called: PaymentMethodsApi#delete_account_payment_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_account_payment_method(account_id, pm_id, opts = {}) ⇒ PaymentFull
Show details of an individual payment method. Show details of an individual payment method. See Account Payment Methods for more info on the properties.
148 149 150 151 |
# File 'lib/phone_com_client/api/payment_methods_api.rb', line 148 def get_account_payment_method(account_id, pm_id, opts = {}) data, _status_code, _headers = get_account_payment_method_with_http_info(account_id, pm_id, opts) data end |
#get_account_payment_method_with_http_info(account_id, pm_id, opts = {}) ⇒ Array<(PaymentFull, Fixnum, Hash)>
Show details of an individual payment method. Show details of an individual payment method. See Account Payment Methods for more info on the properties.
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/phone_com_client/api/payment_methods_api.rb', line 159 def get_account_payment_method_with_http_info(account_id, pm_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentMethodsApi.get_account_payment_method ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling PaymentMethodsApi.get_account_payment_method" end # verify the required parameter 'pm_id' is set if @api_client.config.client_side_validation && pm_id.nil? fail ArgumentError, "Missing the required parameter 'pm_id' when calling PaymentMethodsApi.get_account_payment_method" end # resource path local_var_path = '/accounts/{account_id}/payment-methods/{pm_id}'.sub('{' + 'account_id' + '}', account_id.to_s).sub('{' + 'pm_id' + '}', pm_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['apiKey'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PaymentFull') if @api_client.config.debugging @api_client.config.logger.debug "API called: PaymentMethodsApi#get_account_payment_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_account_payment_methods(account_id, opts = {}) ⇒ ListPaymentMethods
Get a list of payment methods for an account. Get a list of payment methods for an account. See Account Payment Methods for more info on the properties.
212 213 214 215 |
# File 'lib/phone_com_client/api/payment_methods_api.rb', line 212 def list_account_payment_methods(account_id, opts = {}) data, _status_code, _headers = list_account_payment_methods_with_http_info(account_id, opts) data end |
#list_account_payment_methods_with_http_info(account_id, opts = {}) ⇒ Array<(ListPaymentMethods, Fixnum, Hash)>
Get a list of payment methods for an account. Get a list of payment methods for an account. See Account Payment Methods for more info on the properties.
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 |
# File 'lib/phone_com_client/api/payment_methods_api.rb', line 227 def list_account_payment_methods_with_http_info(account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentMethodsApi.list_account_payment_methods ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling PaymentMethodsApi.list_account_payment_methods" end if @api_client.config.client_side_validation && !opts[:'sort_id'].nil? && opts[:'sort_id'] !~ Regexp.new(/asc|desc/) fail ArgumentError, "invalid value for 'opts[:\"sort_id\"]' when calling PaymentMethodsApi.list_account_payment_methods, must conform to the pattern /asc|desc/." end # resource path local_var_path = '/accounts/{account_id}/payment-methods'.sub('{' + 'account_id' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'filters[id]'] = @api_client.build_collection_param(opts[:'filters_id'], :multi) if !opts[:'filters_id'].nil? query_params[:'sort[id]'] = opts[:'sort_id'] if !opts[:'sort_id'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['apiKey'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ListPaymentMethods') if @api_client.config.debugging @api_client.config.logger.debug "API called: PaymentMethodsApi#list_account_payment_methods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#patch_account_payment_method(account_id, pm_id, opts = {}) ⇒ PaymentFull
Replace the status of an individual payment method. Replace the status of an individual payment method. See Account Payment Methods for more info on the properties.
282 283 284 285 |
# File 'lib/phone_com_client/api/payment_methods_api.rb', line 282 def patch_account_payment_method(account_id, pm_id, opts = {}) data, _status_code, _headers = patch_account_payment_method_with_http_info(account_id, pm_id, opts) data end |
#patch_account_payment_method_with_http_info(account_id, pm_id, opts = {}) ⇒ Array<(PaymentFull, Fixnum, Hash)>
Replace the status of an individual payment method. Replace the status of an individual payment method. See Account Payment Methods for more info on the properties.
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 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'lib/phone_com_client/api/payment_methods_api.rb', line 294 def patch_account_payment_method_with_http_info(account_id, pm_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentMethodsApi.patch_account_payment_method ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling PaymentMethodsApi.patch_account_payment_method" end # verify the required parameter 'pm_id' is set if @api_client.config.client_side_validation && pm_id.nil? fail ArgumentError, "Missing the required parameter 'pm_id' when calling PaymentMethodsApi.patch_account_payment_method" end # resource path local_var_path = '/accounts/{account_id}/payment-methods/{pm_id}'.sub('{' + 'account_id' + '}', account_id.to_s).sub('{' + 'pm_id' + '}', pm_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'data']) auth_names = ['apiKey'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PaymentFull') if @api_client.config.debugging @api_client.config.logger.debug "API called: PaymentMethodsApi#patch_account_payment_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |