Class: Yapstone::PayoutInstrumentsApi
- Inherits:
-
Object
- Object
- Yapstone::PayoutInstrumentsApi
- Defined in:
- lib/yapstone-so/api/payout_instruments_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_payout_instrument(payout_instrument_request, opts = {}) ⇒ PayoutInstrumentResource
Creates an Payout Instrument Resource in the system.
-
#create_payout_instrument_with_http_info(payout_instrument_request, opts = {}) ⇒ Array<(PayoutInstrumentResource, Integer, Hash)>
Creates an Payout Instrument Resource in the system.
-
#deactivate_payout_instrument(payout_instrument_id, opts = {}) ⇒ DeactivateResponse
Deactivates the Payout Instrument Resource in the system.
-
#deactivate_payout_instrument_with_http_info(payout_instrument_id, opts = {}) ⇒ Array<(DeactivateResponse, Integer, Hash)>
Deactivates the Payout Instrument Resource in the system.
-
#get_payout_instrument(payout_instrument_id, opts = {}) ⇒ PayoutInstrumentResource
Retrieves an Payout Instrument Resource from the system for the given payoutInstrumentId.
-
#get_payout_instrument_with_http_info(payout_instrument_id, opts = {}) ⇒ Array<(PayoutInstrumentResource, Integer, Hash)>
Retrieves an Payout Instrument Resource from the system for the given payoutInstrumentId.
-
#get_payout_instruments(opts = {}) ⇒ PayoutInstrumentsResource
Get all Payout Instrument Resources the actor has access to in the system.
-
#get_payout_instruments_with_http_info(opts = {}) ⇒ Array<(PayoutInstrumentsResource, Integer, Hash)>
Get all Payout Instrument Resources the actor has access to in the system.
-
#initialize(api_client = ApiClient.default) ⇒ PayoutInstrumentsApi
constructor
A new instance of PayoutInstrumentsApi.
-
#update_payout_instrument(payout_instrument_id, payout_instrument_update_request, opts = {}) ⇒ PayoutInstrumentResource
Updates the PayoutInstrument Resource.
-
#update_payout_instrument_with_http_info(payout_instrument_id, payout_instrument_update_request, opts = {}) ⇒ Array<(PayoutInstrumentResource, Integer, Hash)>
Updates the PayoutInstrument Resource.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ PayoutInstrumentsApi
Returns a new instance of PayoutInstrumentsApi.
19 20 21 |
# File 'lib/yapstone-so/api/payout_instruments_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/yapstone-so/api/payout_instruments_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_payout_instrument(payout_instrument_request, opts = {}) ⇒ PayoutInstrumentResource
Creates an Payout Instrument Resource in the system.
26 27 28 29 |
# File 'lib/yapstone-so/api/payout_instruments_api.rb', line 26 def create_payout_instrument(payout_instrument_request, opts = {}) data, _status_code, _headers = create_payout_instrument_with_http_info(payout_instrument_request, opts) data end |
#create_payout_instrument_with_http_info(payout_instrument_request, opts = {}) ⇒ Array<(PayoutInstrumentResource, Integer, Hash)>
Creates an Payout Instrument Resource in the system.
35 36 37 38 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 |
# File 'lib/yapstone-so/api/payout_instruments_api.rb', line 35 def create_payout_instrument_with_http_info(payout_instrument_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PayoutInstrumentsApi.create_payout_instrument ...' end # verify the required parameter 'payout_instrument_request' is set if @api_client.config.client_side_validation && payout_instrument_request.nil? fail ArgumentError, "Missing the required parameter 'payout_instrument_request' when calling PayoutInstrumentsApi.create_payout_instrument" end # resource path local_var_path = '/payout-instruments' # 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/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(payout_instrument_request) # return_type return_type = opts[:return_type] || 'PayoutInstrumentResource' # auth_names auth_names = opts[:auth_names] || ['Bearer'] = opts.merge( :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: PayoutInstrumentsApi#create_payout_instrument\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#deactivate_payout_instrument(payout_instrument_id, opts = {}) ⇒ DeactivateResponse
Deactivates the Payout Instrument Resource in the system.
88 89 90 91 |
# File 'lib/yapstone-so/api/payout_instruments_api.rb', line 88 def deactivate_payout_instrument(payout_instrument_id, opts = {}) data, _status_code, _headers = deactivate_payout_instrument_with_http_info(payout_instrument_id, opts) data end |
#deactivate_payout_instrument_with_http_info(payout_instrument_id, opts = {}) ⇒ Array<(DeactivateResponse, Integer, Hash)>
Deactivates the Payout Instrument Resource in the system.
97 98 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 142 |
# File 'lib/yapstone-so/api/payout_instruments_api.rb', line 97 def deactivate_payout_instrument_with_http_info(payout_instrument_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PayoutInstrumentsApi.deactivate_payout_instrument ...' end # verify the required parameter 'payout_instrument_id' is set if @api_client.config.client_side_validation && payout_instrument_id.nil? fail ArgumentError, "Missing the required parameter 'payout_instrument_id' when calling PayoutInstrumentsApi.deactivate_payout_instrument" end # resource path local_var_path = '/payout-instruments/{payoutInstrumentId}'.sub('{' + 'payoutInstrumentId' + '}', CGI.escape(payout_instrument_id.to_s).gsub('%2F', '/')) # 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/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'DeactivateResponse' # auth_names auth_names = opts[:auth_names] || ['Bearer'] = opts.merge( :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: PayoutInstrumentsApi#deactivate_payout_instrument\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_payout_instrument(payout_instrument_id, opts = {}) ⇒ PayoutInstrumentResource
Retrieves an Payout Instrument Resource from the system for the given payoutInstrumentId.
148 149 150 151 |
# File 'lib/yapstone-so/api/payout_instruments_api.rb', line 148 def get_payout_instrument(payout_instrument_id, opts = {}) data, _status_code, _headers = get_payout_instrument_with_http_info(payout_instrument_id, opts) data end |
#get_payout_instrument_with_http_info(payout_instrument_id, opts = {}) ⇒ Array<(PayoutInstrumentResource, Integer, Hash)>
Retrieves an Payout Instrument Resource from the system for the given payoutInstrumentId.
157 158 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 202 |
# File 'lib/yapstone-so/api/payout_instruments_api.rb', line 157 def get_payout_instrument_with_http_info(payout_instrument_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PayoutInstrumentsApi.get_payout_instrument ...' end # verify the required parameter 'payout_instrument_id' is set if @api_client.config.client_side_validation && payout_instrument_id.nil? fail ArgumentError, "Missing the required parameter 'payout_instrument_id' when calling PayoutInstrumentsApi.get_payout_instrument" end # resource path local_var_path = '/payout-instruments/{payoutInstrumentId}'.sub('{' + 'payoutInstrumentId' + '}', CGI.escape(payout_instrument_id.to_s).gsub('%2F', '/')) # 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/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PayoutInstrumentResource' # auth_names auth_names = opts[:auth_names] || ['Bearer'] = opts.merge( :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: PayoutInstrumentsApi#get_payout_instrument\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_payout_instruments(opts = {}) ⇒ PayoutInstrumentsResource
Get all Payout Instrument Resources the actor has access to in the system.
209 210 211 212 |
# File 'lib/yapstone-so/api/payout_instruments_api.rb', line 209 def get_payout_instruments(opts = {}) data, _status_code, _headers = get_payout_instruments_with_http_info(opts) data end |
#get_payout_instruments_with_http_info(opts = {}) ⇒ Array<(PayoutInstrumentsResource, Integer, Hash)>
Get all Payout Instrument Resources the actor has access to in the system.
219 220 221 222 223 224 225 226 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 |
# File 'lib/yapstone-so/api/payout_instruments_api.rb', line 219 def get_payout_instruments_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PayoutInstrumentsApi.get_payout_instruments ...' end # resource path local_var_path = '/payout-instruments' # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PayoutInstrumentsResource' # auth_names auth_names = opts[:auth_names] || ['Bearer'] = opts.merge( :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: PayoutInstrumentsApi#get_payout_instruments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_payout_instrument(payout_instrument_id, payout_instrument_update_request, opts = {}) ⇒ PayoutInstrumentResource
Updates the PayoutInstrument Resource.
269 270 271 272 |
# File 'lib/yapstone-so/api/payout_instruments_api.rb', line 269 def update_payout_instrument(payout_instrument_id, payout_instrument_update_request, opts = {}) data, _status_code, _headers = update_payout_instrument_with_http_info(payout_instrument_id, payout_instrument_update_request, opts) data end |
#update_payout_instrument_with_http_info(payout_instrument_id, payout_instrument_update_request, opts = {}) ⇒ Array<(PayoutInstrumentResource, Integer, Hash)>
Updates the PayoutInstrument Resource.
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 320 321 322 323 324 325 326 327 328 329 330 |
# File 'lib/yapstone-so/api/payout_instruments_api.rb', line 279 def update_payout_instrument_with_http_info(payout_instrument_id, payout_instrument_update_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PayoutInstrumentsApi.update_payout_instrument ...' end # verify the required parameter 'payout_instrument_id' is set if @api_client.config.client_side_validation && payout_instrument_id.nil? fail ArgumentError, "Missing the required parameter 'payout_instrument_id' when calling PayoutInstrumentsApi.update_payout_instrument" end # verify the required parameter 'payout_instrument_update_request' is set if @api_client.config.client_side_validation && payout_instrument_update_request.nil? fail ArgumentError, "Missing the required parameter 'payout_instrument_update_request' when calling PayoutInstrumentsApi.update_payout_instrument" end # resource path local_var_path = '/payout-instruments/{payoutInstrumentId}'.sub('{' + 'payoutInstrumentId' + '}', CGI.escape(payout_instrument_id.to_s).gsub('%2F', '/')) # 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/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(payout_instrument_update_request) # return_type return_type = opts[:return_type] || 'PayoutInstrumentResource' # auth_names auth_names = opts[:auth_names] || ['Bearer'] = opts.merge( :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: PayoutInstrumentsApi#update_payout_instrument\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |