yapstone-payouts 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (85) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/Gemfile.lock +79 -0
  4. data/README.md +150 -0
  5. data/Rakefile +10 -0
  6. data/docs/AuthenticationApi.md +58 -0
  7. data/docs/CancelDepositRequest.md +17 -0
  8. data/docs/CancelRequest.md +19 -0
  9. data/docs/Deposit.md +31 -0
  10. data/docs/DepositDetail.md +23 -0
  11. data/docs/DepositListResponse.md +19 -0
  12. data/docs/DepositRequest.md +19 -0
  13. data/docs/Disbursement.md +27 -0
  14. data/docs/DisbursementListResponse.md +19 -0
  15. data/docs/DisbursementRequest.md +19 -0
  16. data/docs/FundingPool.md +31 -0
  17. data/docs/InlineResponse200.md +25 -0
  18. data/docs/Meta.md +17 -0
  19. data/docs/Page.md +21 -0
  20. data/docs/PaymentTransactionDetail.md +31 -0
  21. data/docs/PayoutsApi.md +2065 -0
  22. data/docs/PoolListResponse.md +21 -0
  23. data/docs/Reimbursement.md +27 -0
  24. data/docs/ReimbursementListResponse.md +19 -0
  25. data/docs/ReimbursementRequest.md +19 -0
  26. data/docs/ReverseDisbursementRequest.md +19 -0
  27. data/docs/ReverseReimbursementRequest.md +19 -0
  28. data/docs/StatusChanges.md +19 -0
  29. data/git_push.sh +55 -0
  30. data/lib/yapstone-payouts.rb +62 -0
  31. data/lib/yapstone-payouts/api/authentication_api.rb +92 -0
  32. data/lib/yapstone-payouts/api/payouts_api.rb +2462 -0
  33. data/lib/yapstone-payouts/api_client.rb +386 -0
  34. data/lib/yapstone-payouts/api_error.rb +57 -0
  35. data/lib/yapstone-payouts/configuration.rb +249 -0
  36. data/lib/yapstone-payouts/models/cancel_deposit_request.rb +235 -0
  37. data/lib/yapstone-payouts/models/cancel_request.rb +244 -0
  38. data/lib/yapstone-payouts/models/deposit.rb +261 -0
  39. data/lib/yapstone-payouts/models/deposit_detail.rb +233 -0
  40. data/lib/yapstone-payouts/models/deposit_list_response.rb +207 -0
  41. data/lib/yapstone-payouts/models/deposit_request.rb +217 -0
  42. data/lib/yapstone-payouts/models/disbursement.rb +243 -0
  43. data/lib/yapstone-payouts/models/disbursement_list_response.rb +207 -0
  44. data/lib/yapstone-payouts/models/disbursement_request.rb +217 -0
  45. data/lib/yapstone-payouts/models/funding_pool.rb +259 -0
  46. data/lib/yapstone-payouts/models/inline_response200.rb +232 -0
  47. data/lib/yapstone-payouts/models/meta.rb +197 -0
  48. data/lib/yapstone-payouts/models/page.rb +218 -0
  49. data/lib/yapstone-payouts/models/payment_transaction_detail.rb +279 -0
  50. data/lib/yapstone-payouts/models/pool_list_response.rb +216 -0
  51. data/lib/yapstone-payouts/models/reimbursement.rb +243 -0
  52. data/lib/yapstone-payouts/models/reimbursement_list_response.rb +207 -0
  53. data/lib/yapstone-payouts/models/reimbursement_request.rb +217 -0
  54. data/lib/yapstone-payouts/models/reverse_disbursement_request.rb +215 -0
  55. data/lib/yapstone-payouts/models/reverse_reimbursement_request.rb +215 -0
  56. data/lib/yapstone-payouts/models/status_changes.rb +205 -0
  57. data/lib/yapstone-payouts/version.rb +15 -0
  58. data/spec/api/authentication_api_spec.rb +48 -0
  59. data/spec/api/payouts_api_spec.rb +506 -0
  60. data/spec/api_client_spec.rb +226 -0
  61. data/spec/configuration_spec.rb +42 -0
  62. data/spec/models/cancel_deposit_request_spec.rb +45 -0
  63. data/spec/models/cancel_request_spec.rb +51 -0
  64. data/spec/models/deposit_detail_spec.rb +59 -0
  65. data/spec/models/deposit_list_response_spec.rb +47 -0
  66. data/spec/models/deposit_request_spec.rb +47 -0
  67. data/spec/models/deposit_spec.rb +83 -0
  68. data/spec/models/disbursement_list_response_spec.rb +47 -0
  69. data/spec/models/disbursement_request_spec.rb +47 -0
  70. data/spec/models/disbursement_spec.rb +71 -0
  71. data/spec/models/funding_pool_spec.rb +83 -0
  72. data/spec/models/inline_response200_spec.rb +65 -0
  73. data/spec/models/meta_spec.rb +41 -0
  74. data/spec/models/page_spec.rb +53 -0
  75. data/spec/models/payment_transaction_detail_spec.rb +83 -0
  76. data/spec/models/pool_list_response_spec.rb +53 -0
  77. data/spec/models/reimbursement_list_response_spec.rb +47 -0
  78. data/spec/models/reimbursement_request_spec.rb +47 -0
  79. data/spec/models/reimbursement_spec.rb +71 -0
  80. data/spec/models/reverse_disbursement_request_spec.rb +47 -0
  81. data/spec/models/reverse_reimbursement_request_spec.rb +47 -0
  82. data/spec/models/status_changes_spec.rb +47 -0
  83. data/spec/spec_helper.rb +111 -0
  84. data/yapstone-payouts.gemspec +45 -0
  85. metadata +333 -0
@@ -0,0 +1,21 @@
1
+ # Yapstone::PoolListResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **meta** | [**Meta**](Meta.md) | | [optional]
8
+ **get_meta** | [**Meta**](Meta.md) | | [optional]
9
+ **funding_pools** | [**Array<FundingPool>**](FundingPool.md) | | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'Yapstone'
15
+
16
+ instance = Yapstone::PoolListResponse.new(meta: null,
17
+ get_meta: null,
18
+ funding_pools: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,27 @@
1
+ # Yapstone::Reimbursement
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **transaction_id** | **String** | | [optional]
8
+ **currency** | **String** | | [optional]
9
+ **detail** | [**PaymentTransactionDetail**](PaymentTransactionDetail.md) | | [optional]
10
+ **posted_date** | **String** | | [optional]
11
+ **current_status** | **String** | | [optional]
12
+ **history** | [**Array<StatusChanges>**](StatusChanges.md) | | [optional]
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'Yapstone'
18
+
19
+ instance = Yapstone::Reimbursement.new(transaction_id: null,
20
+ currency: null,
21
+ detail: null,
22
+ posted_date: null,
23
+ current_status: null,
24
+ history: null)
25
+ ```
26
+
27
+
@@ -0,0 +1,19 @@
1
+ # Yapstone::ReimbursementListResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **meta** | [**Meta**](Meta.md) | | [optional]
8
+ **reimbursements** | [**Array<Reimbursement>**](Reimbursement.md) | | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Yapstone'
14
+
15
+ instance = Yapstone::ReimbursementListResponse.new(meta: null,
16
+ reimbursements: null)
17
+ ```
18
+
19
+
@@ -0,0 +1,19 @@
1
+ # Yapstone::ReimbursementRequest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **currency** | **String** | |
8
+ **reimbursements** | [**Array<PaymentTransactionDetail>**](PaymentTransactionDetail.md) | |
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Yapstone'
14
+
15
+ instance = Yapstone::ReimbursementRequest.new(currency: null,
16
+ reimbursements: null)
17
+ ```
18
+
19
+
@@ -0,0 +1,19 @@
1
+ # Yapstone::ReverseDisbursementRequest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **reversal_amount** | **Integer** | |
8
+ **reversal_type** | **String** | |
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Yapstone'
14
+
15
+ instance = Yapstone::ReverseDisbursementRequest.new(reversal_amount: null,
16
+ reversal_type: null)
17
+ ```
18
+
19
+
@@ -0,0 +1,19 @@
1
+ # Yapstone::ReverseReimbursementRequest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **reversal_amount** | **Integer** | |
8
+ **reversal_type** | **String** | |
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Yapstone'
14
+
15
+ instance = Yapstone::ReverseReimbursementRequest.new(reversal_amount: null,
16
+ reversal_type: null)
17
+ ```
18
+
19
+
@@ -0,0 +1,19 @@
1
+ # Yapstone::StatusChanges
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **status** | **String** | | [optional]
8
+ **change_date** | **String** | | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Yapstone'
14
+
15
+ instance = Yapstone::StatusChanges.new(status: null,
16
+ change_date: null)
17
+ ```
18
+
19
+
data/git_push.sh ADDED
@@ -0,0 +1,55 @@
1
+ #!/bin/sh
2
+ #
3
+ # Generated by: https://openapi-generator.tech
4
+ #
5
+ # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
6
+ #
7
+ # Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update"
8
+
9
+ git_user_id=$1
10
+ git_repo_id=$2
11
+ release_note=$3
12
+
13
+ if [ "$git_user_id" = "" ]; then
14
+ git_user_id="GIT_USER_ID"
15
+ echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
16
+ fi
17
+
18
+ if [ "$git_repo_id" = "" ]; then
19
+ git_repo_id="GIT_REPO_ID"
20
+ echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
21
+ fi
22
+
23
+ if [ "$release_note" = "" ]; then
24
+ release_note="Minor update"
25
+ echo "[INFO] No command line input provided. Set \$release_note to $release_note"
26
+ fi
27
+
28
+ # Initialize the local directory as a Git repository
29
+ git init
30
+
31
+ # Adds the files in the local repository and stages them for commit.
32
+ git add .
33
+
34
+ # Commits the tracked changes and prepares them to be pushed to a remote repository.
35
+ git commit -m "$release_note"
36
+
37
+ # Sets the new remote
38
+ git_remote=`git remote`
39
+ if [ "$git_remote" = "" ]; then # git remote not defined
40
+
41
+ if [ "$GIT_TOKEN" = "" ]; then
42
+ echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
43
+ git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
44
+ else
45
+ git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
46
+ fi
47
+
48
+ fi
49
+
50
+ git pull origin master
51
+
52
+ # Pushes (Forces) the changes in the local repository up to the remote repository
53
+ echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
54
+ git push origin master 2>&1 | grep -v 'To https'
55
+
@@ -0,0 +1,62 @@
1
+ =begin
2
+ #Payout Orchestrator API
3
+
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
+
6
+ The version of the OpenAPI document: 1.0.3
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.1.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ # Common files
14
+ require 'yapstone-payouts/api_client'
15
+ require 'yapstone-payouts/api_error'
16
+ require 'yapstone-payouts/version'
17
+ require 'yapstone-payouts/configuration'
18
+
19
+ # Models
20
+ require 'yapstone-payouts/models/cancel_deposit_request'
21
+ require 'yapstone-payouts/models/cancel_request'
22
+ require 'yapstone-payouts/models/deposit'
23
+ require 'yapstone-payouts/models/deposit_detail'
24
+ require 'yapstone-payouts/models/deposit_list_response'
25
+ require 'yapstone-payouts/models/deposit_request'
26
+ require 'yapstone-payouts/models/disbursement'
27
+ require 'yapstone-payouts/models/disbursement_list_response'
28
+ require 'yapstone-payouts/models/disbursement_request'
29
+ require 'yapstone-payouts/models/funding_pool'
30
+ require 'yapstone-payouts/models/inline_response200'
31
+ require 'yapstone-payouts/models/meta'
32
+ require 'yapstone-payouts/models/page'
33
+ require 'yapstone-payouts/models/payment_transaction_detail'
34
+ require 'yapstone-payouts/models/pool_list_response'
35
+ require 'yapstone-payouts/models/reimbursement'
36
+ require 'yapstone-payouts/models/reimbursement_list_response'
37
+ require 'yapstone-payouts/models/reimbursement_request'
38
+ require 'yapstone-payouts/models/reverse_disbursement_request'
39
+ require 'yapstone-payouts/models/reverse_reimbursement_request'
40
+ require 'yapstone-payouts/models/status_changes'
41
+
42
+ # APIs
43
+ require 'yapstone-payouts/api/authentication_api'
44
+ require 'yapstone-payouts/api/payouts_api'
45
+
46
+ module Yapstone
47
+ class << self
48
+ # Customize default settings for the SDK using block.
49
+ # Yapstone.configure do |config|
50
+ # config.username = "xxx"
51
+ # config.password = "xxx"
52
+ # end
53
+ # If no block given, return the default Configuration object.
54
+ def configure
55
+ if block_given?
56
+ yield(Configuration.default)
57
+ else
58
+ Configuration.default
59
+ end
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,92 @@
1
+ =begin
2
+ #Payout Orchestrator API
3
+
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
+
6
+ The version of the OpenAPI document: 1.0.3
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.1.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Yapstone
16
+ class AuthenticationApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Authenticate Partner
23
+ # Get an access token. It is OAuth2, and you must use the client credentials grant type. The token will allow you to authenticate with the other internal payments API endpoints.
24
+ # @param grant_type [String] To do OAuth2 authentication, you must indicate the grant type, then adhere to it structurally. Yapstone API endpoints authenticate with OAuth2 and the grant type client credentials. This type of authentication is used to access resources on your own system rather than access a user&#39;s resources.
25
+ # @param authorization [String] Provide client_id:client_secret as base64 encoded basic auth.
26
+ # @param [Hash] opts the optional parameters
27
+ # @return [InlineResponse200]
28
+ def authenticate_partner(grant_type, authorization, opts = {})
29
+ data, _status_code, _headers = authenticate_partner_with_http_info(grant_type, authorization, opts)
30
+ data
31
+ end
32
+
33
+ # Authenticate Partner
34
+ # Get an access token. It is OAuth2, and you must use the client credentials grant type. The token will allow you to authenticate with the other internal payments API endpoints.
35
+ # @param grant_type [String] To do OAuth2 authentication, you must indicate the grant type, then adhere to it structurally. Yapstone API endpoints authenticate with OAuth2 and the grant type client credentials. This type of authentication is used to access resources on your own system rather than access a user&#39;s resources.
36
+ # @param authorization [String] Provide client_id:client_secret as base64 encoded basic auth.
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [Array<(InlineResponse200, Integer, Hash)>] InlineResponse200 data, response status code and response headers
39
+ def authenticate_partner_with_http_info(grant_type, authorization, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: AuthenticationApi.authenticate_partner ...'
42
+ end
43
+ # verify the required parameter 'grant_type' is set
44
+ if @api_client.config.client_side_validation && grant_type.nil?
45
+ fail ArgumentError, "Missing the required parameter 'grant_type' when calling AuthenticationApi.authenticate_partner"
46
+ end
47
+ # verify the required parameter 'authorization' is set
48
+ if @api_client.config.client_side_validation && authorization.nil?
49
+ fail ArgumentError, "Missing the required parameter 'authorization' when calling AuthenticationApi.authenticate_partner"
50
+ end
51
+ # resource path
52
+ local_var_path = '/v1/oauth2/client_credential/accesstoken'
53
+
54
+ # query parameters
55
+ query_params = opts[:query_params] || {}
56
+ query_params[:'grant_type'] = grant_type
57
+
58
+ # header parameters
59
+ header_params = opts[:header_params] || {}
60
+ # HTTP header 'Accept' (if needed)
61
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
62
+ header_params[:'Authorization'] = authorization
63
+
64
+ # form parameters
65
+ form_params = opts[:form_params] || {}
66
+
67
+ # http body (model)
68
+ post_body = opts[:body]
69
+
70
+ # return_type
71
+ return_type = opts[:return_type] || 'InlineResponse200'
72
+
73
+ # auth_names
74
+ auth_names = opts[:auth_names] || []
75
+
76
+ new_options = opts.merge(
77
+ :header_params => header_params,
78
+ :query_params => query_params,
79
+ :form_params => form_params,
80
+ :body => post_body,
81
+ :auth_names => auth_names,
82
+ :return_type => return_type
83
+ )
84
+
85
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
86
+ if @api_client.config.debugging
87
+ @api_client.config.logger.debug "API called: AuthenticationApi#authenticate_partner\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
88
+ end
89
+ return data, status_code, headers
90
+ end
91
+ end
92
+ end
@@ -0,0 +1,2462 @@
1
+ =begin
2
+ #Payout Orchestrator API
3
+
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
+
6
+ The version of the OpenAPI document: 1.0.3
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.1.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Yapstone
16
+ class PayoutsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Cancels the given deposit advice if it has not yet been processed. Note that a deposit advice cannot be cancelled after it has been reconciled via the corresponding bank account activity record.
23
+ # @param deposit_id [String] Primary key for a single deposit record (assigned by YapStone)
24
+ # @param cancel_deposit_request [CancelDepositRequest]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [nil]
27
+ def cancel_deposit(deposit_id, cancel_deposit_request, opts = {})
28
+ cancel_deposit_with_http_info(deposit_id, cancel_deposit_request, opts)
29
+ nil
30
+ end
31
+
32
+ # Cancels the given deposit advice if it has not yet been processed. Note that a deposit advice cannot be cancelled after it has been reconciled via the corresponding bank account activity record.
33
+ # @param deposit_id [String] Primary key for a single deposit record (assigned by YapStone)
34
+ # @param cancel_deposit_request [CancelDepositRequest]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
37
+ def cancel_deposit_with_http_info(deposit_id, cancel_deposit_request, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.cancel_deposit ...'
40
+ end
41
+ # verify the required parameter 'deposit_id' is set
42
+ if @api_client.config.client_side_validation && deposit_id.nil?
43
+ fail ArgumentError, "Missing the required parameter 'deposit_id' when calling PayoutsApi.cancel_deposit"
44
+ end
45
+ # verify the required parameter 'cancel_deposit_request' is set
46
+ if @api_client.config.client_side_validation && cancel_deposit_request.nil?
47
+ fail ArgumentError, "Missing the required parameter 'cancel_deposit_request' when calling PayoutsApi.cancel_deposit"
48
+ end
49
+ # resource path
50
+ local_var_path = '/payouts/v1/deposits/{depositId}'.sub('{' + 'depositId' + '}', CGI.escape(deposit_id.to_s).gsub('%2F', '/'))
51
+
52
+ # query parameters
53
+ query_params = opts[:query_params] || {}
54
+
55
+ # header parameters
56
+ header_params = opts[:header_params] || {}
57
+ # HTTP header 'Content-Type'
58
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
59
+
60
+ # form parameters
61
+ form_params = opts[:form_params] || {}
62
+
63
+ # http body (model)
64
+ post_body = opts[:body] || @api_client.object_to_http_body(cancel_deposit_request)
65
+
66
+ # return_type
67
+ return_type = opts[:return_type]
68
+
69
+ # auth_names
70
+ auth_names = opts[:auth_names] || ['Bearer']
71
+
72
+ new_options = opts.merge(
73
+ :header_params => header_params,
74
+ :query_params => query_params,
75
+ :form_params => form_params,
76
+ :body => post_body,
77
+ :auth_names => auth_names,
78
+ :return_type => return_type
79
+ )
80
+
81
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
82
+ if @api_client.config.debugging
83
+ @api_client.config.logger.debug "API called: PayoutsApi#cancel_deposit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
84
+ end
85
+ return data, status_code, headers
86
+ end
87
+
88
+ # Cancel Disbursement - Cancels the given disbursement if it has not yet been processed. Note that a disbursement cannot be cancelled after it has been submitted for payment to the downstream processor. Reverse Disbursement - Submits a full (or partial) disbursement for funds that were originally retrieved via the given transactionId recapture order. The resulting transactionId represents the linked disbursement.
89
+ # @param transaction_id [String] Primary key for a single disbursement record (assigned by YapStone)
90
+ # @param cancel_request [CancelRequest]
91
+ # @param [Hash] opts the optional parameters
92
+ # @return [nil]
93
+ def cancel_disbursement(transaction_id, cancel_request, opts = {})
94
+ cancel_disbursement_with_http_info(transaction_id, cancel_request, opts)
95
+ nil
96
+ end
97
+
98
+ # Cancel Disbursement - Cancels the given disbursement if it has not yet been processed. Note that a disbursement cannot be cancelled after it has been submitted for payment to the downstream processor. Reverse Disbursement - Submits a full (or partial) disbursement for funds that were originally retrieved via the given transactionId recapture order. The resulting transactionId represents the linked disbursement.
99
+ # @param transaction_id [String] Primary key for a single disbursement record (assigned by YapStone)
100
+ # @param cancel_request [CancelRequest]
101
+ # @param [Hash] opts the optional parameters
102
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
103
+ def cancel_disbursement_with_http_info(transaction_id, cancel_request, opts = {})
104
+ if @api_client.config.debugging
105
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.cancel_disbursement ...'
106
+ end
107
+ # verify the required parameter 'transaction_id' is set
108
+ if @api_client.config.client_side_validation && transaction_id.nil?
109
+ fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PayoutsApi.cancel_disbursement"
110
+ end
111
+ # verify the required parameter 'cancel_request' is set
112
+ if @api_client.config.client_side_validation && cancel_request.nil?
113
+ fail ArgumentError, "Missing the required parameter 'cancel_request' when calling PayoutsApi.cancel_disbursement"
114
+ end
115
+ # resource path
116
+ local_var_path = '/payouts/v1/disbursements/{transactionId}'.sub('{' + 'transactionId' + '}', CGI.escape(transaction_id.to_s).gsub('%2F', '/'))
117
+
118
+ # query parameters
119
+ query_params = opts[:query_params] || {}
120
+
121
+ # header parameters
122
+ header_params = opts[:header_params] || {}
123
+ # HTTP header 'Content-Type'
124
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
125
+
126
+ # form parameters
127
+ form_params = opts[:form_params] || {}
128
+
129
+ # http body (model)
130
+ post_body = opts[:body] || @api_client.object_to_http_body(cancel_request)
131
+
132
+ # return_type
133
+ return_type = opts[:return_type]
134
+
135
+ # auth_names
136
+ auth_names = opts[:auth_names] || ['Bearer']
137
+
138
+ new_options = opts.merge(
139
+ :header_params => header_params,
140
+ :query_params => query_params,
141
+ :form_params => form_params,
142
+ :body => post_body,
143
+ :auth_names => auth_names,
144
+ :return_type => return_type
145
+ )
146
+
147
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
148
+ if @api_client.config.debugging
149
+ @api_client.config.logger.debug "API called: PayoutsApi#cancel_disbursement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
150
+ end
151
+ return data, status_code, headers
152
+ end
153
+
154
+ # Reverse Reimbursement - Submits a full (or partial) disbursement for funds that were originally retrieved via the given transactionId recapture order. The resulting transactionId represents the linked reimbursement.
155
+ # @param transaction_id [String] Primary key for a single reimbursement record (assigned by YapStone)
156
+ # @param cancel_request [CancelRequest]
157
+ # @param [Hash] opts the optional parameters
158
+ # @return [nil]
159
+ def cancel_reimbursement(transaction_id, cancel_request, opts = {})
160
+ cancel_reimbursement_with_http_info(transaction_id, cancel_request, opts)
161
+ nil
162
+ end
163
+
164
+ # Reverse Reimbursement - Submits a full (or partial) disbursement for funds that were originally retrieved via the given transactionId recapture order. The resulting transactionId represents the linked reimbursement.
165
+ # @param transaction_id [String] Primary key for a single reimbursement record (assigned by YapStone)
166
+ # @param cancel_request [CancelRequest]
167
+ # @param [Hash] opts the optional parameters
168
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
169
+ def cancel_reimbursement_with_http_info(transaction_id, cancel_request, opts = {})
170
+ if @api_client.config.debugging
171
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.cancel_reimbursement ...'
172
+ end
173
+ # verify the required parameter 'transaction_id' is set
174
+ if @api_client.config.client_side_validation && transaction_id.nil?
175
+ fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PayoutsApi.cancel_reimbursement"
176
+ end
177
+ # verify the required parameter 'cancel_request' is set
178
+ if @api_client.config.client_side_validation && cancel_request.nil?
179
+ fail ArgumentError, "Missing the required parameter 'cancel_request' when calling PayoutsApi.cancel_reimbursement"
180
+ end
181
+ # resource path
182
+ local_var_path = '/payouts/v1/reimbursements/{transactionId}/cancel'.sub('{' + 'transactionId' + '}', CGI.escape(transaction_id.to_s).gsub('%2F', '/'))
183
+
184
+ # query parameters
185
+ query_params = opts[:query_params] || {}
186
+
187
+ # header parameters
188
+ header_params = opts[:header_params] || {}
189
+ # HTTP header 'Content-Type'
190
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
191
+
192
+ # form parameters
193
+ form_params = opts[:form_params] || {}
194
+
195
+ # http body (model)
196
+ post_body = opts[:body] || @api_client.object_to_http_body(cancel_request)
197
+
198
+ # return_type
199
+ return_type = opts[:return_type]
200
+
201
+ # auth_names
202
+ auth_names = opts[:auth_names] || ['Bearer']
203
+
204
+ new_options = opts.merge(
205
+ :header_params => header_params,
206
+ :query_params => query_params,
207
+ :form_params => form_params,
208
+ :body => post_body,
209
+ :auth_names => auth_names,
210
+ :return_type => return_type
211
+ )
212
+
213
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
214
+ if @api_client.config.debugging
215
+ @api_client.config.logger.debug "API called: PayoutsApi#cancel_reimbursement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
216
+ end
217
+ return data, status_code, headers
218
+ end
219
+
220
+ # Notifies YapStone that a deposit has been initiated by the Marketplace to provide funds for future disbursement requests. This call will create a pending deposit record that will be cleared when the corresponding transaction is confirmed by the acquiring bank (typically 1-3 days). Disbursement requests received against pending funds will be released for processing when the deposit is cleared.
221
+ # @param deposit_request [DepositRequest] Request describes one or more pending deposits for the given currency.
222
+ # @param [Hash] opts the optional parameters
223
+ # @return [nil]
224
+ def create_deposit(deposit_request, opts = {})
225
+ create_deposit_with_http_info(deposit_request, opts)
226
+ nil
227
+ end
228
+
229
+ # Notifies YapStone that a deposit has been initiated by the Marketplace to provide funds for future disbursement requests. This call will create a pending deposit record that will be cleared when the corresponding transaction is confirmed by the acquiring bank (typically 1-3 days). Disbursement requests received against pending funds will be released for processing when the deposit is cleared.
230
+ # @param deposit_request [DepositRequest] Request describes one or more pending deposits for the given currency.
231
+ # @param [Hash] opts the optional parameters
232
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
233
+ def create_deposit_with_http_info(deposit_request, opts = {})
234
+ if @api_client.config.debugging
235
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.create_deposit ...'
236
+ end
237
+ # verify the required parameter 'deposit_request' is set
238
+ if @api_client.config.client_side_validation && deposit_request.nil?
239
+ fail ArgumentError, "Missing the required parameter 'deposit_request' when calling PayoutsApi.create_deposit"
240
+ end
241
+ # resource path
242
+ local_var_path = '/payouts/v1/deposits'
243
+
244
+ # query parameters
245
+ query_params = opts[:query_params] || {}
246
+
247
+ # header parameters
248
+ header_params = opts[:header_params] || {}
249
+ # HTTP header 'Content-Type'
250
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
251
+
252
+ # form parameters
253
+ form_params = opts[:form_params] || {}
254
+
255
+ # http body (model)
256
+ post_body = opts[:body] || @api_client.object_to_http_body(deposit_request)
257
+
258
+ # return_type
259
+ return_type = opts[:return_type]
260
+
261
+ # auth_names
262
+ auth_names = opts[:auth_names] || ['Bearer']
263
+
264
+ new_options = opts.merge(
265
+ :header_params => header_params,
266
+ :query_params => query_params,
267
+ :form_params => form_params,
268
+ :body => post_body,
269
+ :auth_names => auth_names,
270
+ :return_type => return_type
271
+ )
272
+
273
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
274
+ if @api_client.config.debugging
275
+ @api_client.config.logger.debug "API called: PayoutsApi#create_deposit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
276
+ end
277
+ return data, status_code, headers
278
+ end
279
+
280
+ # Retrieves the funding position for the Marketplace for each supported currency. If the optional query parameter is provided, the response will include only the specified currency (EUR, GBP, USD).
281
+ # @param [Hash] opts the optional parameters
282
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the balances. If not passed default marketplace from app token will be used
283
+ # @option opts [String] :currency The currency for the balance inquiry (returns all by default)
284
+ # @return [PoolListResponse]
285
+ def get_balances(opts = {})
286
+ data, _status_code, _headers = get_balances_with_http_info(opts)
287
+ data
288
+ end
289
+
290
+ # Retrieves the funding position for the Marketplace for each supported currency. If the optional query parameter is provided, the response will include only the specified currency (EUR, GBP, USD).
291
+ # @param [Hash] opts the optional parameters
292
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the balances. If not passed default marketplace from app token will be used
293
+ # @option opts [String] :currency The currency for the balance inquiry (returns all by default)
294
+ # @return [Array<(PoolListResponse, Integer, Hash)>] PoolListResponse data, response status code and response headers
295
+ def get_balances_with_http_info(opts = {})
296
+ if @api_client.config.debugging
297
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_balances ...'
298
+ end
299
+ # resource path
300
+ local_var_path = '/payouts/v1/balances'
301
+
302
+ # query parameters
303
+ query_params = opts[:query_params] || {}
304
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
305
+ query_params[:'currency'] = opts[:'currency'] if !opts[:'currency'].nil?
306
+
307
+ # header parameters
308
+ header_params = opts[:header_params] || {}
309
+ # HTTP header 'Accept' (if needed)
310
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
311
+
312
+ # form parameters
313
+ form_params = opts[:form_params] || {}
314
+
315
+ # http body (model)
316
+ post_body = opts[:body]
317
+
318
+ # return_type
319
+ return_type = opts[:return_type] || 'PoolListResponse'
320
+
321
+ # auth_names
322
+ auth_names = opts[:auth_names] || ['Bearer']
323
+
324
+ new_options = opts.merge(
325
+ :header_params => header_params,
326
+ :query_params => query_params,
327
+ :form_params => form_params,
328
+ :body => post_body,
329
+ :auth_names => auth_names,
330
+ :return_type => return_type
331
+ )
332
+
333
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
334
+ if @api_client.config.debugging
335
+ @api_client.config.logger.debug "API called: PayoutsApi#get_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
336
+ end
337
+ return data, status_code, headers
338
+ end
339
+
340
+ # Returns the deposit detail and status history for the given depositId.
341
+ # @param deposit_id [String] Primary key for a single deposit record (assigned by YapStone)
342
+ # @param [Hash] opts the optional parameters
343
+ # @return [Deposit]
344
+ def get_deposit(deposit_id, opts = {})
345
+ data, _status_code, _headers = get_deposit_with_http_info(deposit_id, opts)
346
+ data
347
+ end
348
+
349
+ # Returns the deposit detail and status history for the given depositId.
350
+ # @param deposit_id [String] Primary key for a single deposit record (assigned by YapStone)
351
+ # @param [Hash] opts the optional parameters
352
+ # @return [Array<(Deposit, Integer, Hash)>] Deposit data, response status code and response headers
353
+ def get_deposit_with_http_info(deposit_id, opts = {})
354
+ if @api_client.config.debugging
355
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_deposit ...'
356
+ end
357
+ # verify the required parameter 'deposit_id' is set
358
+ if @api_client.config.client_side_validation && deposit_id.nil?
359
+ fail ArgumentError, "Missing the required parameter 'deposit_id' when calling PayoutsApi.get_deposit"
360
+ end
361
+ # resource path
362
+ local_var_path = '/payouts/v1/deposits/{depositId}'.sub('{' + 'depositId' + '}', CGI.escape(deposit_id.to_s).gsub('%2F', '/'))
363
+
364
+ # query parameters
365
+ query_params = opts[:query_params] || {}
366
+
367
+ # header parameters
368
+ header_params = opts[:header_params] || {}
369
+ # HTTP header 'Accept' (if needed)
370
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
371
+
372
+ # form parameters
373
+ form_params = opts[:form_params] || {}
374
+
375
+ # http body (model)
376
+ post_body = opts[:body]
377
+
378
+ # return_type
379
+ return_type = opts[:return_type] || 'Deposit'
380
+
381
+ # auth_names
382
+ auth_names = opts[:auth_names] || ['Bearer']
383
+
384
+ new_options = opts.merge(
385
+ :header_params => header_params,
386
+ :query_params => query_params,
387
+ :form_params => form_params,
388
+ :body => post_body,
389
+ :auth_names => auth_names,
390
+ :return_type => return_type
391
+ )
392
+
393
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
394
+ if @api_client.config.debugging
395
+ @api_client.config.logger.debug "API called: PayoutsApi#get_deposit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
396
+ end
397
+ return data, status_code, headers
398
+ end
399
+
400
+ # Returns all pool activities matching given bank reference tag.
401
+ # @param bank_reference_tag [String] Partial bank reference identifier for a single deposit record
402
+ # @param [Hash] opts the optional parameters
403
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
404
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
405
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
406
+ # @return [DepositListResponse]
407
+ def get_deposits_by_bank_reference_tag(bank_reference_tag, opts = {})
408
+ data, _status_code, _headers = get_deposits_by_bank_reference_tag_with_http_info(bank_reference_tag, opts)
409
+ data
410
+ end
411
+
412
+ # Returns all pool activities matching given bank reference tag.
413
+ # @param bank_reference_tag [String] Partial bank reference identifier for a single deposit record
414
+ # @param [Hash] opts the optional parameters
415
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
416
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
417
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
418
+ # @return [Array<(DepositListResponse, Integer, Hash)>] DepositListResponse data, response status code and response headers
419
+ def get_deposits_by_bank_reference_tag_with_http_info(bank_reference_tag, opts = {})
420
+ if @api_client.config.debugging
421
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_deposits_by_bank_reference_tag ...'
422
+ end
423
+ # verify the required parameter 'bank_reference_tag' is set
424
+ if @api_client.config.client_side_validation && bank_reference_tag.nil?
425
+ fail ArgumentError, "Missing the required parameter 'bank_reference_tag' when calling PayoutsApi.get_deposits_by_bank_reference_tag"
426
+ end
427
+ # resource path
428
+ local_var_path = '/payouts/v1/deposits/bankReference/{bankReferenceTag}'.sub('{' + 'bankReferenceTag' + '}', CGI.escape(bank_reference_tag.to_s).gsub('%2F', '/'))
429
+
430
+ # query parameters
431
+ query_params = opts[:query_params] || {}
432
+ query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
433
+ query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
434
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
435
+
436
+ # header parameters
437
+ header_params = opts[:header_params] || {}
438
+ # HTTP header 'Accept' (if needed)
439
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
440
+
441
+ # form parameters
442
+ form_params = opts[:form_params] || {}
443
+
444
+ # http body (model)
445
+ post_body = opts[:body]
446
+
447
+ # return_type
448
+ return_type = opts[:return_type] || 'DepositListResponse'
449
+
450
+ # auth_names
451
+ auth_names = opts[:auth_names] || ['Bearer']
452
+
453
+ new_options = opts.merge(
454
+ :header_params => header_params,
455
+ :query_params => query_params,
456
+ :form_params => form_params,
457
+ :body => post_body,
458
+ :auth_names => auth_names,
459
+ :return_type => return_type
460
+ )
461
+
462
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
463
+ if @api_client.config.debugging
464
+ @api_client.config.logger.debug "API called: PayoutsApi#get_deposits_by_bank_reference_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
465
+ end
466
+ return data, status_code, headers
467
+ end
468
+
469
+ # Returns all pool activities matching given client unique transaction id.
470
+ # @param client_unique_txn_id [String] Alternate key for a single deposit record (assigned by Marketplace)
471
+ # @param [Hash] opts the optional parameters
472
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
473
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
474
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
475
+ # @return [DepositListResponse]
476
+ def get_deposits_by_client_unique_txn_id(client_unique_txn_id, opts = {})
477
+ data, _status_code, _headers = get_deposits_by_client_unique_txn_id_with_http_info(client_unique_txn_id, opts)
478
+ data
479
+ end
480
+
481
+ # Returns all pool activities matching given client unique transaction id.
482
+ # @param client_unique_txn_id [String] Alternate key for a single deposit record (assigned by Marketplace)
483
+ # @param [Hash] opts the optional parameters
484
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
485
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
486
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
487
+ # @return [Array<(DepositListResponse, Integer, Hash)>] DepositListResponse data, response status code and response headers
488
+ def get_deposits_by_client_unique_txn_id_with_http_info(client_unique_txn_id, opts = {})
489
+ if @api_client.config.debugging
490
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_deposits_by_client_unique_txn_id ...'
491
+ end
492
+ # verify the required parameter 'client_unique_txn_id' is set
493
+ if @api_client.config.client_side_validation && client_unique_txn_id.nil?
494
+ fail ArgumentError, "Missing the required parameter 'client_unique_txn_id' when calling PayoutsApi.get_deposits_by_client_unique_txn_id"
495
+ end
496
+ # resource path
497
+ local_var_path = '/payouts/v1/deposits/clientId/{clientUniqueTxnId}'.sub('{' + 'clientUniqueTxnId' + '}', CGI.escape(client_unique_txn_id.to_s).gsub('%2F', '/'))
498
+
499
+ # query parameters
500
+ query_params = opts[:query_params] || {}
501
+ query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
502
+ query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
503
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
504
+
505
+ # header parameters
506
+ header_params = opts[:header_params] || {}
507
+ # HTTP header 'Accept' (if needed)
508
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
509
+
510
+ # form parameters
511
+ form_params = opts[:form_params] || {}
512
+
513
+ # http body (model)
514
+ post_body = opts[:body]
515
+
516
+ # return_type
517
+ return_type = opts[:return_type] || 'DepositListResponse'
518
+
519
+ # auth_names
520
+ auth_names = opts[:auth_names] || ['Bearer']
521
+
522
+ new_options = opts.merge(
523
+ :header_params => header_params,
524
+ :query_params => query_params,
525
+ :form_params => form_params,
526
+ :body => post_body,
527
+ :auth_names => auth_names,
528
+ :return_type => return_type
529
+ )
530
+
531
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
532
+ if @api_client.config.debugging
533
+ @api_client.config.logger.debug "API called: PayoutsApi#get_deposits_by_client_unique_txn_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
534
+ end
535
+ return data, status_code, headers
536
+ end
537
+
538
+ # Returns all pool activities matching given client correlation id.
539
+ # @param client_correlation_id [String] Correlation identifier assigned to one or more deposits by the Marketplace
540
+ # @param [Hash] opts the optional parameters
541
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
542
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
543
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
544
+ # @return [DepositListResponse]
545
+ def get_deposits_by_correlation_id(client_correlation_id, opts = {})
546
+ data, _status_code, _headers = get_deposits_by_correlation_id_with_http_info(client_correlation_id, opts)
547
+ data
548
+ end
549
+
550
+ # Returns all pool activities matching given client correlation id.
551
+ # @param client_correlation_id [String] Correlation identifier assigned to one or more deposits by the Marketplace
552
+ # @param [Hash] opts the optional parameters
553
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
554
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
555
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
556
+ # @return [Array<(DepositListResponse, Integer, Hash)>] DepositListResponse data, response status code and response headers
557
+ def get_deposits_by_correlation_id_with_http_info(client_correlation_id, opts = {})
558
+ if @api_client.config.debugging
559
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_deposits_by_correlation_id ...'
560
+ end
561
+ # verify the required parameter 'client_correlation_id' is set
562
+ if @api_client.config.client_side_validation && client_correlation_id.nil?
563
+ fail ArgumentError, "Missing the required parameter 'client_correlation_id' when calling PayoutsApi.get_deposits_by_correlation_id"
564
+ end
565
+ # resource path
566
+ local_var_path = '/payouts/v1/deposits/correlation/{clientCorrelationId}'.sub('{' + 'clientCorrelationId' + '}', CGI.escape(client_correlation_id.to_s).gsub('%2F', '/'))
567
+
568
+ # query parameters
569
+ query_params = opts[:query_params] || {}
570
+ query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
571
+ query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
572
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
573
+
574
+ # header parameters
575
+ header_params = opts[:header_params] || {}
576
+ # HTTP header 'Accept' (if needed)
577
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
578
+
579
+ # form parameters
580
+ form_params = opts[:form_params] || {}
581
+
582
+ # http body (model)
583
+ post_body = opts[:body]
584
+
585
+ # return_type
586
+ return_type = opts[:return_type] || 'DepositListResponse'
587
+
588
+ # auth_names
589
+ auth_names = opts[:auth_names] || ['Bearer']
590
+
591
+ new_options = opts.merge(
592
+ :header_params => header_params,
593
+ :query_params => query_params,
594
+ :form_params => form_params,
595
+ :body => post_body,
596
+ :auth_names => auth_names,
597
+ :return_type => return_type
598
+ )
599
+
600
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
601
+ if @api_client.config.debugging
602
+ @api_client.config.logger.debug "API called: PayoutsApi#get_deposits_by_correlation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
603
+ end
604
+ return data, status_code, headers
605
+ end
606
+
607
+ # Returns all pool activities matching given client correlation id and status.
608
+ # @param client_correlation_id [String] Correlation identifier assigned to one or more deposits by the Marketplace
609
+ # @param current_status [String] Current deposit status of the pool activity
610
+ # @param [Hash] opts the optional parameters
611
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
612
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
613
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
614
+ # @return [DepositListResponse]
615
+ def get_deposits_by_correlation_id_and_status(client_correlation_id, current_status, opts = {})
616
+ data, _status_code, _headers = get_deposits_by_correlation_id_and_status_with_http_info(client_correlation_id, current_status, opts)
617
+ data
618
+ end
619
+
620
+ # Returns all pool activities matching given client correlation id and status.
621
+ # @param client_correlation_id [String] Correlation identifier assigned to one or more deposits by the Marketplace
622
+ # @param current_status [String] Current deposit status of the pool activity
623
+ # @param [Hash] opts the optional parameters
624
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
625
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
626
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
627
+ # @return [Array<(DepositListResponse, Integer, Hash)>] DepositListResponse data, response status code and response headers
628
+ def get_deposits_by_correlation_id_and_status_with_http_info(client_correlation_id, current_status, opts = {})
629
+ if @api_client.config.debugging
630
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_deposits_by_correlation_id_and_status ...'
631
+ end
632
+ # verify the required parameter 'client_correlation_id' is set
633
+ if @api_client.config.client_side_validation && client_correlation_id.nil?
634
+ fail ArgumentError, "Missing the required parameter 'client_correlation_id' when calling PayoutsApi.get_deposits_by_correlation_id_and_status"
635
+ end
636
+ # verify the required parameter 'current_status' is set
637
+ if @api_client.config.client_side_validation && current_status.nil?
638
+ fail ArgumentError, "Missing the required parameter 'current_status' when calling PayoutsApi.get_deposits_by_correlation_id_and_status"
639
+ end
640
+ # resource path
641
+ local_var_path = '/payouts/v1/deposits/correlation/{clientCorrelationId}/status/{currentStatus}'.sub('{' + 'clientCorrelationId' + '}', CGI.escape(client_correlation_id.to_s).gsub('%2F', '/')).sub('{' + 'currentStatus' + '}', CGI.escape(current_status.to_s).gsub('%2F', '/'))
642
+
643
+ # query parameters
644
+ query_params = opts[:query_params] || {}
645
+ query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
646
+ query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
647
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
648
+
649
+ # header parameters
650
+ header_params = opts[:header_params] || {}
651
+ # HTTP header 'Accept' (if needed)
652
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
653
+
654
+ # form parameters
655
+ form_params = opts[:form_params] || {}
656
+
657
+ # http body (model)
658
+ post_body = opts[:body]
659
+
660
+ # return_type
661
+ return_type = opts[:return_type] || 'DepositListResponse'
662
+
663
+ # auth_names
664
+ auth_names = opts[:auth_names] || ['Bearer']
665
+
666
+ new_options = opts.merge(
667
+ :header_params => header_params,
668
+ :query_params => query_params,
669
+ :form_params => form_params,
670
+ :body => post_body,
671
+ :auth_names => auth_names,
672
+ :return_type => return_type
673
+ )
674
+
675
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
676
+ if @api_client.config.debugging
677
+ @api_client.config.logger.debug "API called: PayoutsApi#get_deposits_by_correlation_id_and_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
678
+ end
679
+ return data, status_code, headers
680
+ end
681
+
682
+ # Returns all pool activities matching given currency.
683
+ # @param currency [String] The currency for a set of deposits (EUR, GBP, USD)
684
+ # @param [Hash] opts the optional parameters
685
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
686
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
687
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
688
+ # @return [DepositListResponse]
689
+ def get_deposits_by_currency(currency, opts = {})
690
+ data, _status_code, _headers = get_deposits_by_currency_with_http_info(currency, opts)
691
+ data
692
+ end
693
+
694
+ # Returns all pool activities matching given currency.
695
+ # @param currency [String] The currency for a set of deposits (EUR, GBP, USD)
696
+ # @param [Hash] opts the optional parameters
697
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
698
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
699
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
700
+ # @return [Array<(DepositListResponse, Integer, Hash)>] DepositListResponse data, response status code and response headers
701
+ def get_deposits_by_currency_with_http_info(currency, opts = {})
702
+ if @api_client.config.debugging
703
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_deposits_by_currency ...'
704
+ end
705
+ # verify the required parameter 'currency' is set
706
+ if @api_client.config.client_side_validation && currency.nil?
707
+ fail ArgumentError, "Missing the required parameter 'currency' when calling PayoutsApi.get_deposits_by_currency"
708
+ end
709
+ # resource path
710
+ local_var_path = '/payouts/v1/deposits/currency/{currency}'.sub('{' + 'currency' + '}', CGI.escape(currency.to_s).gsub('%2F', '/'))
711
+
712
+ # query parameters
713
+ query_params = opts[:query_params] || {}
714
+ query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
715
+ query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
716
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
717
+
718
+ # header parameters
719
+ header_params = opts[:header_params] || {}
720
+ # HTTP header 'Accept' (if needed)
721
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
722
+
723
+ # form parameters
724
+ form_params = opts[:form_params] || {}
725
+
726
+ # http body (model)
727
+ post_body = opts[:body]
728
+
729
+ # return_type
730
+ return_type = opts[:return_type] || 'DepositListResponse'
731
+
732
+ # auth_names
733
+ auth_names = opts[:auth_names] || ['Bearer']
734
+
735
+ new_options = opts.merge(
736
+ :header_params => header_params,
737
+ :query_params => query_params,
738
+ :form_params => form_params,
739
+ :body => post_body,
740
+ :auth_names => auth_names,
741
+ :return_type => return_type
742
+ )
743
+
744
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
745
+ if @api_client.config.debugging
746
+ @api_client.config.logger.debug "API called: PayoutsApi#get_deposits_by_currency\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
747
+ end
748
+ return data, status_code, headers
749
+ end
750
+
751
+ # Returns all pool activities matching given current status.
752
+ # @param current_status [String] Current deposit status of the pool activity
753
+ # @param [Hash] opts the optional parameters
754
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
755
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
756
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
757
+ # @return [DepositListResponse]
758
+ def get_deposits_by_status(current_status, opts = {})
759
+ data, _status_code, _headers = get_deposits_by_status_with_http_info(current_status, opts)
760
+ data
761
+ end
762
+
763
+ # Returns all pool activities matching given current status.
764
+ # @param current_status [String] Current deposit status of the pool activity
765
+ # @param [Hash] opts the optional parameters
766
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
767
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
768
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
769
+ # @return [Array<(DepositListResponse, Integer, Hash)>] DepositListResponse data, response status code and response headers
770
+ def get_deposits_by_status_with_http_info(current_status, opts = {})
771
+ if @api_client.config.debugging
772
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_deposits_by_status ...'
773
+ end
774
+ # verify the required parameter 'current_status' is set
775
+ if @api_client.config.client_side_validation && current_status.nil?
776
+ fail ArgumentError, "Missing the required parameter 'current_status' when calling PayoutsApi.get_deposits_by_status"
777
+ end
778
+ # resource path
779
+ local_var_path = '/payouts/v1/deposits/status/{currentStatus}'.sub('{' + 'currentStatus' + '}', CGI.escape(current_status.to_s).gsub('%2F', '/'))
780
+
781
+ # query parameters
782
+ query_params = opts[:query_params] || {}
783
+ query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
784
+ query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
785
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
786
+
787
+ # header parameters
788
+ header_params = opts[:header_params] || {}
789
+ # HTTP header 'Accept' (if needed)
790
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
791
+
792
+ # form parameters
793
+ form_params = opts[:form_params] || {}
794
+
795
+ # http body (model)
796
+ post_body = opts[:body]
797
+
798
+ # return_type
799
+ return_type = opts[:return_type] || 'DepositListResponse'
800
+
801
+ # auth_names
802
+ auth_names = opts[:auth_names] || ['Bearer']
803
+
804
+ new_options = opts.merge(
805
+ :header_params => header_params,
806
+ :query_params => query_params,
807
+ :form_params => form_params,
808
+ :body => post_body,
809
+ :auth_names => auth_names,
810
+ :return_type => return_type
811
+ )
812
+
813
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
814
+ if @api_client.config.debugging
815
+ @api_client.config.logger.debug "API called: PayoutsApi#get_deposits_by_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
816
+ end
817
+ return data, status_code, headers
818
+ end
819
+
820
+ # Returns all disbursement transactions matching given correlation id.
821
+ # @param client_correlation_id [String] Correlation identifier assigned to one or more disbursements by the Marketplace
822
+ # @param [Hash] opts the optional parameters
823
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
824
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
825
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
826
+ # @return [DisbursementListResponse]
827
+ def get_disbursements_by_client_correlation_id(client_correlation_id, opts = {})
828
+ data, _status_code, _headers = get_disbursements_by_client_correlation_id_with_http_info(client_correlation_id, opts)
829
+ data
830
+ end
831
+
832
+ # Returns all disbursement transactions matching given correlation id.
833
+ # @param client_correlation_id [String] Correlation identifier assigned to one or more disbursements by the Marketplace
834
+ # @param [Hash] opts the optional parameters
835
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
836
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
837
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
838
+ # @return [Array<(DisbursementListResponse, Integer, Hash)>] DisbursementListResponse data, response status code and response headers
839
+ def get_disbursements_by_client_correlation_id_with_http_info(client_correlation_id, opts = {})
840
+ if @api_client.config.debugging
841
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_disbursements_by_client_correlation_id ...'
842
+ end
843
+ # verify the required parameter 'client_correlation_id' is set
844
+ if @api_client.config.client_side_validation && client_correlation_id.nil?
845
+ fail ArgumentError, "Missing the required parameter 'client_correlation_id' when calling PayoutsApi.get_disbursements_by_client_correlation_id"
846
+ end
847
+ # resource path
848
+ local_var_path = '/payouts/v1/disbursements/correlation/{clientCorrelationId}'.sub('{' + 'clientCorrelationId' + '}', CGI.escape(client_correlation_id.to_s).gsub('%2F', '/'))
849
+
850
+ # query parameters
851
+ query_params = opts[:query_params] || {}
852
+ query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
853
+ query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
854
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
855
+
856
+ # header parameters
857
+ header_params = opts[:header_params] || {}
858
+ # HTTP header 'Accept' (if needed)
859
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
860
+
861
+ # form parameters
862
+ form_params = opts[:form_params] || {}
863
+
864
+ # http body (model)
865
+ post_body = opts[:body]
866
+
867
+ # return_type
868
+ return_type = opts[:return_type] || 'DisbursementListResponse'
869
+
870
+ # auth_names
871
+ auth_names = opts[:auth_names] || ['Bearer']
872
+
873
+ new_options = opts.merge(
874
+ :header_params => header_params,
875
+ :query_params => query_params,
876
+ :form_params => form_params,
877
+ :body => post_body,
878
+ :auth_names => auth_names,
879
+ :return_type => return_type
880
+ )
881
+
882
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
883
+ if @api_client.config.debugging
884
+ @api_client.config.logger.debug "API called: PayoutsApi#get_disbursements_by_client_correlation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
885
+ end
886
+ return data, status_code, headers
887
+ end
888
+
889
+ # Returns all disbursement transactions matching given unique id.
890
+ # @param client_unique_txn_id [String] Alternate key for a single disbursement record (assigned by Marketplace)
891
+ # @param [Hash] opts the optional parameters
892
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
893
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
894
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
895
+ # @return [DisbursementListResponse]
896
+ def get_disbursements_by_client_unique_txn_id(client_unique_txn_id, opts = {})
897
+ data, _status_code, _headers = get_disbursements_by_client_unique_txn_id_with_http_info(client_unique_txn_id, opts)
898
+ data
899
+ end
900
+
901
+ # Returns all disbursement transactions matching given unique id.
902
+ # @param client_unique_txn_id [String] Alternate key for a single disbursement record (assigned by Marketplace)
903
+ # @param [Hash] opts the optional parameters
904
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
905
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
906
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
907
+ # @return [Array<(DisbursementListResponse, Integer, Hash)>] DisbursementListResponse data, response status code and response headers
908
+ def get_disbursements_by_client_unique_txn_id_with_http_info(client_unique_txn_id, opts = {})
909
+ if @api_client.config.debugging
910
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_disbursements_by_client_unique_txn_id ...'
911
+ end
912
+ # verify the required parameter 'client_unique_txn_id' is set
913
+ if @api_client.config.client_side_validation && client_unique_txn_id.nil?
914
+ fail ArgumentError, "Missing the required parameter 'client_unique_txn_id' when calling PayoutsApi.get_disbursements_by_client_unique_txn_id"
915
+ end
916
+ # resource path
917
+ local_var_path = '/payouts/v1/disbursements/clientId/{clientUniqueTxnId}'.sub('{' + 'clientUniqueTxnId' + '}', CGI.escape(client_unique_txn_id.to_s).gsub('%2F', '/'))
918
+
919
+ # query parameters
920
+ query_params = opts[:query_params] || {}
921
+ query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
922
+ query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
923
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
924
+
925
+ # header parameters
926
+ header_params = opts[:header_params] || {}
927
+ # HTTP header 'Accept' (if needed)
928
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
929
+
930
+ # form parameters
931
+ form_params = opts[:form_params] || {}
932
+
933
+ # http body (model)
934
+ post_body = opts[:body]
935
+
936
+ # return_type
937
+ return_type = opts[:return_type] || 'DisbursementListResponse'
938
+
939
+ # auth_names
940
+ auth_names = opts[:auth_names] || ['Bearer']
941
+
942
+ new_options = opts.merge(
943
+ :header_params => header_params,
944
+ :query_params => query_params,
945
+ :form_params => form_params,
946
+ :body => post_body,
947
+ :auth_names => auth_names,
948
+ :return_type => return_type
949
+ )
950
+
951
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
952
+ if @api_client.config.debugging
953
+ @api_client.config.logger.debug "API called: PayoutsApi#get_disbursements_by_client_unique_txn_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
954
+ end
955
+ return data, status_code, headers
956
+ end
957
+
958
+ # Returns all disbursement transactions matching given contract id.
959
+ # @param contract_id [String] Primary identifier used to designate a payee (assigned by YapStone)
960
+ # @param [Hash] opts the optional parameters
961
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
962
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
963
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
964
+ # @return [DisbursementListResponse]
965
+ def get_disbursements_by_contract_id(contract_id, opts = {})
966
+ data, _status_code, _headers = get_disbursements_by_contract_id_with_http_info(contract_id, opts)
967
+ data
968
+ end
969
+
970
+ # Returns all disbursement transactions matching given contract id.
971
+ # @param contract_id [String] Primary identifier used to designate a payee (assigned by YapStone)
972
+ # @param [Hash] opts the optional parameters
973
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
974
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
975
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
976
+ # @return [Array<(DisbursementListResponse, Integer, Hash)>] DisbursementListResponse data, response status code and response headers
977
+ def get_disbursements_by_contract_id_with_http_info(contract_id, opts = {})
978
+ if @api_client.config.debugging
979
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_disbursements_by_contract_id ...'
980
+ end
981
+ # verify the required parameter 'contract_id' is set
982
+ if @api_client.config.client_side_validation && contract_id.nil?
983
+ fail ArgumentError, "Missing the required parameter 'contract_id' when calling PayoutsApi.get_disbursements_by_contract_id"
984
+ end
985
+ # resource path
986
+ local_var_path = '/payouts/v1/disbursements/contract/{contractId}'.sub('{' + 'contractId' + '}', CGI.escape(contract_id.to_s).gsub('%2F', '/'))
987
+
988
+ # query parameters
989
+ query_params = opts[:query_params] || {}
990
+ query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
991
+ query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
992
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
993
+
994
+ # header parameters
995
+ header_params = opts[:header_params] || {}
996
+ # HTTP header 'Accept' (if needed)
997
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
998
+
999
+ # form parameters
1000
+ form_params = opts[:form_params] || {}
1001
+
1002
+ # http body (model)
1003
+ post_body = opts[:body]
1004
+
1005
+ # return_type
1006
+ return_type = opts[:return_type] || 'DisbursementListResponse'
1007
+
1008
+ # auth_names
1009
+ auth_names = opts[:auth_names] || ['Bearer']
1010
+
1011
+ new_options = opts.merge(
1012
+ :header_params => header_params,
1013
+ :query_params => query_params,
1014
+ :form_params => form_params,
1015
+ :body => post_body,
1016
+ :auth_names => auth_names,
1017
+ :return_type => return_type
1018
+ )
1019
+
1020
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1021
+ if @api_client.config.debugging
1022
+ @api_client.config.logger.debug "API called: PayoutsApi#get_disbursements_by_contract_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1023
+ end
1024
+ return data, status_code, headers
1025
+ end
1026
+
1027
+ # Returns all disbursement transactions matching given correlation id and status.
1028
+ # @param client_correlation_id [String] Correlation identifier assigned to one or more disbursements by the Marketplace
1029
+ # @param current_status [String] Current disbursement status
1030
+ # @param [Hash] opts the optional parameters
1031
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
1032
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
1033
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
1034
+ # @return [DisbursementListResponse]
1035
+ def get_disbursements_by_correlation_id_and_status(client_correlation_id, current_status, opts = {})
1036
+ data, _status_code, _headers = get_disbursements_by_correlation_id_and_status_with_http_info(client_correlation_id, current_status, opts)
1037
+ data
1038
+ end
1039
+
1040
+ # Returns all disbursement transactions matching given correlation id and status.
1041
+ # @param client_correlation_id [String] Correlation identifier assigned to one or more disbursements by the Marketplace
1042
+ # @param current_status [String] Current disbursement status
1043
+ # @param [Hash] opts the optional parameters
1044
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
1045
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
1046
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
1047
+ # @return [Array<(DisbursementListResponse, Integer, Hash)>] DisbursementListResponse data, response status code and response headers
1048
+ def get_disbursements_by_correlation_id_and_status_with_http_info(client_correlation_id, current_status, opts = {})
1049
+ if @api_client.config.debugging
1050
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_disbursements_by_correlation_id_and_status ...'
1051
+ end
1052
+ # verify the required parameter 'client_correlation_id' is set
1053
+ if @api_client.config.client_side_validation && client_correlation_id.nil?
1054
+ fail ArgumentError, "Missing the required parameter 'client_correlation_id' when calling PayoutsApi.get_disbursements_by_correlation_id_and_status"
1055
+ end
1056
+ # verify the required parameter 'current_status' is set
1057
+ if @api_client.config.client_side_validation && current_status.nil?
1058
+ fail ArgumentError, "Missing the required parameter 'current_status' when calling PayoutsApi.get_disbursements_by_correlation_id_and_status"
1059
+ end
1060
+ # resource path
1061
+ local_var_path = '/payouts/v1/disbursements/correlation/{clientCorrelationId}/status/{currentStatus}'.sub('{' + 'clientCorrelationId' + '}', CGI.escape(client_correlation_id.to_s).gsub('%2F', '/')).sub('{' + 'currentStatus' + '}', CGI.escape(current_status.to_s).gsub('%2F', '/'))
1062
+
1063
+ # query parameters
1064
+ query_params = opts[:query_params] || {}
1065
+ query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
1066
+ query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
1067
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
1068
+
1069
+ # header parameters
1070
+ header_params = opts[:header_params] || {}
1071
+ # HTTP header 'Accept' (if needed)
1072
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1073
+
1074
+ # form parameters
1075
+ form_params = opts[:form_params] || {}
1076
+
1077
+ # http body (model)
1078
+ post_body = opts[:body]
1079
+
1080
+ # return_type
1081
+ return_type = opts[:return_type] || 'DisbursementListResponse'
1082
+
1083
+ # auth_names
1084
+ auth_names = opts[:auth_names] || ['Bearer']
1085
+
1086
+ new_options = opts.merge(
1087
+ :header_params => header_params,
1088
+ :query_params => query_params,
1089
+ :form_params => form_params,
1090
+ :body => post_body,
1091
+ :auth_names => auth_names,
1092
+ :return_type => return_type
1093
+ )
1094
+
1095
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1096
+ if @api_client.config.debugging
1097
+ @api_client.config.logger.debug "API called: PayoutsApi#get_disbursements_by_correlation_id_and_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1098
+ end
1099
+ return data, status_code, headers
1100
+ end
1101
+
1102
+ # Returns all disbursement transactions matching given contract id.
1103
+ # @param currency [String] The currency for a set of disbursements (EUR, GBP, USD)
1104
+ # @param [Hash] opts the optional parameters
1105
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
1106
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
1107
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
1108
+ # @return [DisbursementListResponse]
1109
+ def get_disbursements_by_currency(currency, opts = {})
1110
+ data, _status_code, _headers = get_disbursements_by_currency_with_http_info(currency, opts)
1111
+ data
1112
+ end
1113
+
1114
+ # Returns all disbursement transactions matching given contract id.
1115
+ # @param currency [String] The currency for a set of disbursements (EUR, GBP, USD)
1116
+ # @param [Hash] opts the optional parameters
1117
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
1118
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
1119
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
1120
+ # @return [Array<(DisbursementListResponse, Integer, Hash)>] DisbursementListResponse data, response status code and response headers
1121
+ def get_disbursements_by_currency_with_http_info(currency, opts = {})
1122
+ if @api_client.config.debugging
1123
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_disbursements_by_currency ...'
1124
+ end
1125
+ # verify the required parameter 'currency' is set
1126
+ if @api_client.config.client_side_validation && currency.nil?
1127
+ fail ArgumentError, "Missing the required parameter 'currency' when calling PayoutsApi.get_disbursements_by_currency"
1128
+ end
1129
+ # resource path
1130
+ local_var_path = '/payouts/v1/disbursements/currency/{currency}'.sub('{' + 'currency' + '}', CGI.escape(currency.to_s).gsub('%2F', '/'))
1131
+
1132
+ # query parameters
1133
+ query_params = opts[:query_params] || {}
1134
+ query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
1135
+ query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
1136
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
1137
+
1138
+ # header parameters
1139
+ header_params = opts[:header_params] || {}
1140
+ # HTTP header 'Accept' (if needed)
1141
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1142
+
1143
+ # form parameters
1144
+ form_params = opts[:form_params] || {}
1145
+
1146
+ # http body (model)
1147
+ post_body = opts[:body]
1148
+
1149
+ # return_type
1150
+ return_type = opts[:return_type] || 'DisbursementListResponse'
1151
+
1152
+ # auth_names
1153
+ auth_names = opts[:auth_names] || ['Bearer']
1154
+
1155
+ new_options = opts.merge(
1156
+ :header_params => header_params,
1157
+ :query_params => query_params,
1158
+ :form_params => form_params,
1159
+ :body => post_body,
1160
+ :auth_names => auth_names,
1161
+ :return_type => return_type
1162
+ )
1163
+
1164
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1165
+ if @api_client.config.debugging
1166
+ @api_client.config.logger.debug "API called: PayoutsApi#get_disbursements_by_currency\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1167
+ end
1168
+ return data, status_code, headers
1169
+ end
1170
+
1171
+ # Returns all disbursement transactions matching given contract id.
1172
+ # @param payee_instrument_id [String] Primary identifier used to designate a payment instrument (assigned by YapStone)
1173
+ # @param [Hash] opts the optional parameters
1174
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
1175
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
1176
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
1177
+ # @return [DisbursementListResponse]
1178
+ def get_disbursements_by_instrument_id(payee_instrument_id, opts = {})
1179
+ data, _status_code, _headers = get_disbursements_by_instrument_id_with_http_info(payee_instrument_id, opts)
1180
+ data
1181
+ end
1182
+
1183
+ # Returns all disbursement transactions matching given contract id.
1184
+ # @param payee_instrument_id [String] Primary identifier used to designate a payment instrument (assigned by YapStone)
1185
+ # @param [Hash] opts the optional parameters
1186
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
1187
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
1188
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
1189
+ # @return [Array<(DisbursementListResponse, Integer, Hash)>] DisbursementListResponse data, response status code and response headers
1190
+ def get_disbursements_by_instrument_id_with_http_info(payee_instrument_id, opts = {})
1191
+ if @api_client.config.debugging
1192
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_disbursements_by_instrument_id ...'
1193
+ end
1194
+ # verify the required parameter 'payee_instrument_id' is set
1195
+ if @api_client.config.client_side_validation && payee_instrument_id.nil?
1196
+ fail ArgumentError, "Missing the required parameter 'payee_instrument_id' when calling PayoutsApi.get_disbursements_by_instrument_id"
1197
+ end
1198
+ # resource path
1199
+ local_var_path = '/payouts/v1/disbursements/instrument/{payeeInstrumentId}'.sub('{' + 'payeeInstrumentId' + '}', CGI.escape(payee_instrument_id.to_s).gsub('%2F', '/'))
1200
+
1201
+ # query parameters
1202
+ query_params = opts[:query_params] || {}
1203
+ query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
1204
+ query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
1205
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
1206
+
1207
+ # header parameters
1208
+ header_params = opts[:header_params] || {}
1209
+ # HTTP header 'Accept' (if needed)
1210
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1211
+
1212
+ # form parameters
1213
+ form_params = opts[:form_params] || {}
1214
+
1215
+ # http body (model)
1216
+ post_body = opts[:body]
1217
+
1218
+ # return_type
1219
+ return_type = opts[:return_type] || 'DisbursementListResponse'
1220
+
1221
+ # auth_names
1222
+ auth_names = opts[:auth_names] || ['Bearer']
1223
+
1224
+ new_options = opts.merge(
1225
+ :header_params => header_params,
1226
+ :query_params => query_params,
1227
+ :form_params => form_params,
1228
+ :body => post_body,
1229
+ :auth_names => auth_names,
1230
+ :return_type => return_type
1231
+ )
1232
+
1233
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1234
+ if @api_client.config.debugging
1235
+ @api_client.config.logger.debug "API called: PayoutsApi#get_disbursements_by_instrument_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1236
+ end
1237
+ return data, status_code, headers
1238
+ end
1239
+
1240
+ # Returns all disbursement transactions matching given order id.
1241
+ # @param order_id [String] Group identifer for a set of disbursements created via a single API request (assigned by YapStone)
1242
+ # @param [Hash] opts the optional parameters
1243
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
1244
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
1245
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
1246
+ # @return [DisbursementListResponse]
1247
+ def get_disbursements_by_order_id(order_id, opts = {})
1248
+ data, _status_code, _headers = get_disbursements_by_order_id_with_http_info(order_id, opts)
1249
+ data
1250
+ end
1251
+
1252
+ # Returns all disbursement transactions matching given order id.
1253
+ # @param order_id [String] Group identifer for a set of disbursements created via a single API request (assigned by YapStone)
1254
+ # @param [Hash] opts the optional parameters
1255
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
1256
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
1257
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
1258
+ # @return [Array<(DisbursementListResponse, Integer, Hash)>] DisbursementListResponse data, response status code and response headers
1259
+ def get_disbursements_by_order_id_with_http_info(order_id, opts = {})
1260
+ if @api_client.config.debugging
1261
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_disbursements_by_order_id ...'
1262
+ end
1263
+ # verify the required parameter 'order_id' is set
1264
+ if @api_client.config.client_side_validation && order_id.nil?
1265
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling PayoutsApi.get_disbursements_by_order_id"
1266
+ end
1267
+ # resource path
1268
+ local_var_path = '/payouts/v1/disbursements/order/{orderId}'.sub('{' + 'orderId' + '}', CGI.escape(order_id.to_s).gsub('%2F', '/'))
1269
+
1270
+ # query parameters
1271
+ query_params = opts[:query_params] || {}
1272
+ query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
1273
+ query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
1274
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
1275
+
1276
+ # header parameters
1277
+ header_params = opts[:header_params] || {}
1278
+ # HTTP header 'Accept' (if needed)
1279
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1280
+
1281
+ # form parameters
1282
+ form_params = opts[:form_params] || {}
1283
+
1284
+ # http body (model)
1285
+ post_body = opts[:body]
1286
+
1287
+ # return_type
1288
+ return_type = opts[:return_type] || 'DisbursementListResponse'
1289
+
1290
+ # auth_names
1291
+ auth_names = opts[:auth_names] || ['Bearer']
1292
+
1293
+ new_options = opts.merge(
1294
+ :header_params => header_params,
1295
+ :query_params => query_params,
1296
+ :form_params => form_params,
1297
+ :body => post_body,
1298
+ :auth_names => auth_names,
1299
+ :return_type => return_type
1300
+ )
1301
+
1302
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1303
+ if @api_client.config.debugging
1304
+ @api_client.config.logger.debug "API called: PayoutsApi#get_disbursements_by_order_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1305
+ end
1306
+ return data, status_code, headers
1307
+ end
1308
+
1309
+ # Returns all disbursement transactions matching given contract id.
1310
+ # @param payee_party_id [String] Primary identifier used to designate a payment recipient (assigned by YapStone)
1311
+ # @param [Hash] opts the optional parameters
1312
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
1313
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
1314
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
1315
+ # @return [DisbursementListResponse]
1316
+ def get_disbursements_by_party_id(payee_party_id, opts = {})
1317
+ data, _status_code, _headers = get_disbursements_by_party_id_with_http_info(payee_party_id, opts)
1318
+ data
1319
+ end
1320
+
1321
+ # Returns all disbursement transactions matching given contract id.
1322
+ # @param payee_party_id [String] Primary identifier used to designate a payment recipient (assigned by YapStone)
1323
+ # @param [Hash] opts the optional parameters
1324
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
1325
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
1326
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
1327
+ # @return [Array<(DisbursementListResponse, Integer, Hash)>] DisbursementListResponse data, response status code and response headers
1328
+ def get_disbursements_by_party_id_with_http_info(payee_party_id, opts = {})
1329
+ if @api_client.config.debugging
1330
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_disbursements_by_party_id ...'
1331
+ end
1332
+ # verify the required parameter 'payee_party_id' is set
1333
+ if @api_client.config.client_side_validation && payee_party_id.nil?
1334
+ fail ArgumentError, "Missing the required parameter 'payee_party_id' when calling PayoutsApi.get_disbursements_by_party_id"
1335
+ end
1336
+ # resource path
1337
+ local_var_path = '/payouts/v1/disbursements/party/{payeePartyId}'.sub('{' + 'payeePartyId' + '}', CGI.escape(payee_party_id.to_s).gsub('%2F', '/'))
1338
+
1339
+ # query parameters
1340
+ query_params = opts[:query_params] || {}
1341
+ query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
1342
+ query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
1343
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
1344
+
1345
+ # header parameters
1346
+ header_params = opts[:header_params] || {}
1347
+ # HTTP header 'Accept' (if needed)
1348
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1349
+
1350
+ # form parameters
1351
+ form_params = opts[:form_params] || {}
1352
+
1353
+ # http body (model)
1354
+ post_body = opts[:body]
1355
+
1356
+ # return_type
1357
+ return_type = opts[:return_type] || 'DisbursementListResponse'
1358
+
1359
+ # auth_names
1360
+ auth_names = opts[:auth_names] || ['Bearer']
1361
+
1362
+ new_options = opts.merge(
1363
+ :header_params => header_params,
1364
+ :query_params => query_params,
1365
+ :form_params => form_params,
1366
+ :body => post_body,
1367
+ :auth_names => auth_names,
1368
+ :return_type => return_type
1369
+ )
1370
+
1371
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1372
+ if @api_client.config.debugging
1373
+ @api_client.config.logger.debug "API called: PayoutsApi#get_disbursements_by_party_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1374
+ end
1375
+ return data, status_code, headers
1376
+ end
1377
+
1378
+ # Returns all disbursement transactions matching given current status.
1379
+ # @param current_status [String] Current disbursement status
1380
+ # @param [Hash] opts the optional parameters
1381
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
1382
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
1383
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
1384
+ # @return [DisbursementListResponse]
1385
+ def get_disbursements_by_status(current_status, opts = {})
1386
+ data, _status_code, _headers = get_disbursements_by_status_with_http_info(current_status, opts)
1387
+ data
1388
+ end
1389
+
1390
+ # Returns all disbursement transactions matching given current status.
1391
+ # @param current_status [String] Current disbursement status
1392
+ # @param [Hash] opts the optional parameters
1393
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
1394
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
1395
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
1396
+ # @return [Array<(DisbursementListResponse, Integer, Hash)>] DisbursementListResponse data, response status code and response headers
1397
+ def get_disbursements_by_status_with_http_info(current_status, opts = {})
1398
+ if @api_client.config.debugging
1399
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_disbursements_by_status ...'
1400
+ end
1401
+ # verify the required parameter 'current_status' is set
1402
+ if @api_client.config.client_side_validation && current_status.nil?
1403
+ fail ArgumentError, "Missing the required parameter 'current_status' when calling PayoutsApi.get_disbursements_by_status"
1404
+ end
1405
+ # resource path
1406
+ local_var_path = '/payouts/v1/disbursements/status/{currentStatus}'.sub('{' + 'currentStatus' + '}', CGI.escape(current_status.to_s).gsub('%2F', '/'))
1407
+
1408
+ # query parameters
1409
+ query_params = opts[:query_params] || {}
1410
+ query_params[:'fromDate'] = opts[:'from_date'] if !opts[:'from_date'].nil?
1411
+ query_params[:'toDate'] = opts[:'to_date'] if !opts[:'to_date'].nil?
1412
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
1413
+
1414
+ # header parameters
1415
+ header_params = opts[:header_params] || {}
1416
+ # HTTP header 'Accept' (if needed)
1417
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1418
+
1419
+ # form parameters
1420
+ form_params = opts[:form_params] || {}
1421
+
1422
+ # http body (model)
1423
+ post_body = opts[:body]
1424
+
1425
+ # return_type
1426
+ return_type = opts[:return_type] || 'DisbursementListResponse'
1427
+
1428
+ # auth_names
1429
+ auth_names = opts[:auth_names] || ['Bearer']
1430
+
1431
+ new_options = opts.merge(
1432
+ :header_params => header_params,
1433
+ :query_params => query_params,
1434
+ :form_params => form_params,
1435
+ :body => post_body,
1436
+ :auth_names => auth_names,
1437
+ :return_type => return_type
1438
+ )
1439
+
1440
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1441
+ if @api_client.config.debugging
1442
+ @api_client.config.logger.debug "API called: PayoutsApi#get_disbursements_by_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1443
+ end
1444
+ return data, status_code, headers
1445
+ end
1446
+
1447
+ # Returns the disbursement detail and status history for the given transactionId.
1448
+ # @param transaction_id [String] Primary key for a single disbursement record (assigned by YapStone)
1449
+ # @param [Hash] opts the optional parameters
1450
+ # @return [Disbursement]
1451
+ def get_disbursements_by_txn_id(transaction_id, opts = {})
1452
+ data, _status_code, _headers = get_disbursements_by_txn_id_with_http_info(transaction_id, opts)
1453
+ data
1454
+ end
1455
+
1456
+ # Returns the disbursement detail and status history for the given transactionId.
1457
+ # @param transaction_id [String] Primary key for a single disbursement record (assigned by YapStone)
1458
+ # @param [Hash] opts the optional parameters
1459
+ # @return [Array<(Disbursement, Integer, Hash)>] Disbursement data, response status code and response headers
1460
+ def get_disbursements_by_txn_id_with_http_info(transaction_id, opts = {})
1461
+ if @api_client.config.debugging
1462
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_disbursements_by_txn_id ...'
1463
+ end
1464
+ # verify the required parameter 'transaction_id' is set
1465
+ if @api_client.config.client_side_validation && transaction_id.nil?
1466
+ fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PayoutsApi.get_disbursements_by_txn_id"
1467
+ end
1468
+ # resource path
1469
+ local_var_path = '/payouts/v1/disbursements/{transactionId}'.sub('{' + 'transactionId' + '}', CGI.escape(transaction_id.to_s).gsub('%2F', '/'))
1470
+
1471
+ # query parameters
1472
+ query_params = opts[:query_params] || {}
1473
+
1474
+ # header parameters
1475
+ header_params = opts[:header_params] || {}
1476
+ # HTTP header 'Accept' (if needed)
1477
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1478
+
1479
+ # form parameters
1480
+ form_params = opts[:form_params] || {}
1481
+
1482
+ # http body (model)
1483
+ post_body = opts[:body]
1484
+
1485
+ # return_type
1486
+ return_type = opts[:return_type] || 'Disbursement'
1487
+
1488
+ # auth_names
1489
+ auth_names = opts[:auth_names] || ['Bearer']
1490
+
1491
+ new_options = opts.merge(
1492
+ :header_params => header_params,
1493
+ :query_params => query_params,
1494
+ :form_params => form_params,
1495
+ :body => post_body,
1496
+ :auth_names => auth_names,
1497
+ :return_type => return_type
1498
+ )
1499
+
1500
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1501
+ if @api_client.config.debugging
1502
+ @api_client.config.logger.debug "API called: PayoutsApi#get_disbursements_by_txn_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1503
+ end
1504
+ return data, status_code, headers
1505
+ end
1506
+
1507
+ # Returns the disbursement detail and status history for the given transactionId.
1508
+ # @param transaction_id [String] Primary key for a single disbursement record (assigned by YapStone)
1509
+ # @param [Hash] opts the optional parameters
1510
+ # @return [Reimbursement]
1511
+ def get_reimbursement(transaction_id, opts = {})
1512
+ data, _status_code, _headers = get_reimbursement_with_http_info(transaction_id, opts)
1513
+ data
1514
+ end
1515
+
1516
+ # Returns the disbursement detail and status history for the given transactionId.
1517
+ # @param transaction_id [String] Primary key for a single disbursement record (assigned by YapStone)
1518
+ # @param [Hash] opts the optional parameters
1519
+ # @return [Array<(Reimbursement, Integer, Hash)>] Reimbursement data, response status code and response headers
1520
+ def get_reimbursement_with_http_info(transaction_id, opts = {})
1521
+ if @api_client.config.debugging
1522
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_reimbursement ...'
1523
+ end
1524
+ # verify the required parameter 'transaction_id' is set
1525
+ if @api_client.config.client_side_validation && transaction_id.nil?
1526
+ fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PayoutsApi.get_reimbursement"
1527
+ end
1528
+ # resource path
1529
+ local_var_path = '/payouts/v1/reimbursements/{transactionId}'.sub('{' + 'transactionId' + '}', CGI.escape(transaction_id.to_s).gsub('%2F', '/'))
1530
+
1531
+ # query parameters
1532
+ query_params = opts[:query_params] || {}
1533
+
1534
+ # header parameters
1535
+ header_params = opts[:header_params] || {}
1536
+ # HTTP header 'Accept' (if needed)
1537
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1538
+
1539
+ # form parameters
1540
+ form_params = opts[:form_params] || {}
1541
+
1542
+ # http body (model)
1543
+ post_body = opts[:body]
1544
+
1545
+ # return_type
1546
+ return_type = opts[:return_type] || 'Reimbursement'
1547
+
1548
+ # auth_names
1549
+ auth_names = opts[:auth_names] || ['Bearer']
1550
+
1551
+ new_options = opts.merge(
1552
+ :header_params => header_params,
1553
+ :query_params => query_params,
1554
+ :form_params => form_params,
1555
+ :body => post_body,
1556
+ :auth_names => auth_names,
1557
+ :return_type => return_type
1558
+ )
1559
+
1560
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1561
+ if @api_client.config.debugging
1562
+ @api_client.config.logger.debug "API called: PayoutsApi#get_reimbursement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1563
+ end
1564
+ return data, status_code, headers
1565
+ end
1566
+
1567
+ # Returns all reimbursement transactions matching given contract .
1568
+ # @param current_status [String] Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
1569
+ # @param contract_id [String]
1570
+ # @param [Hash] opts the optional parameters
1571
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
1572
+ # @return [ReimbursementListResponse]
1573
+ def get_reimbursements_by_contract_id(current_status, contract_id, opts = {})
1574
+ data, _status_code, _headers = get_reimbursements_by_contract_id_with_http_info(current_status, contract_id, opts)
1575
+ data
1576
+ end
1577
+
1578
+ # Returns all reimbursement transactions matching given contract .
1579
+ # @param current_status [String] Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
1580
+ # @param contract_id [String]
1581
+ # @param [Hash] opts the optional parameters
1582
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
1583
+ # @return [Array<(ReimbursementListResponse, Integer, Hash)>] ReimbursementListResponse data, response status code and response headers
1584
+ def get_reimbursements_by_contract_id_with_http_info(current_status, contract_id, opts = {})
1585
+ if @api_client.config.debugging
1586
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_reimbursements_by_contract_id ...'
1587
+ end
1588
+ # verify the required parameter 'current_status' is set
1589
+ if @api_client.config.client_side_validation && current_status.nil?
1590
+ fail ArgumentError, "Missing the required parameter 'current_status' when calling PayoutsApi.get_reimbursements_by_contract_id"
1591
+ end
1592
+ # verify the required parameter 'contract_id' is set
1593
+ if @api_client.config.client_side_validation && contract_id.nil?
1594
+ fail ArgumentError, "Missing the required parameter 'contract_id' when calling PayoutsApi.get_reimbursements_by_contract_id"
1595
+ end
1596
+ # resource path
1597
+ local_var_path = '/payouts/v1/reimbursements/contract/{contractId}'.sub('{' + 'currentStatus' + '}', CGI.escape(current_status.to_s).gsub('%2F', '/')).sub('{' + 'contractId' + '}', CGI.escape(contract_id.to_s).gsub('%2F', '/'))
1598
+
1599
+ # query parameters
1600
+ query_params = opts[:query_params] || {}
1601
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
1602
+
1603
+ # header parameters
1604
+ header_params = opts[:header_params] || {}
1605
+ # HTTP header 'Accept' (if needed)
1606
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1607
+
1608
+ # form parameters
1609
+ form_params = opts[:form_params] || {}
1610
+
1611
+ # http body (model)
1612
+ post_body = opts[:body]
1613
+
1614
+ # return_type
1615
+ return_type = opts[:return_type] || 'ReimbursementListResponse'
1616
+
1617
+ # auth_names
1618
+ auth_names = opts[:auth_names] || ['Bearer']
1619
+
1620
+ new_options = opts.merge(
1621
+ :header_params => header_params,
1622
+ :query_params => query_params,
1623
+ :form_params => form_params,
1624
+ :body => post_body,
1625
+ :auth_names => auth_names,
1626
+ :return_type => return_type
1627
+ )
1628
+
1629
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1630
+ if @api_client.config.debugging
1631
+ @api_client.config.logger.debug "API called: PayoutsApi#get_reimbursements_by_contract_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1632
+ end
1633
+ return data, status_code, headers
1634
+ end
1635
+
1636
+ # Returns all reimbursement transactions matching given correlation .
1637
+ # @param client_correlation_id [String] Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
1638
+ # @param [Hash] opts the optional parameters
1639
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
1640
+ # @return [ReimbursementListResponse]
1641
+ def get_reimbursements_by_correlation_id(client_correlation_id, opts = {})
1642
+ data, _status_code, _headers = get_reimbursements_by_correlation_id_with_http_info(client_correlation_id, opts)
1643
+ data
1644
+ end
1645
+
1646
+ # Returns all reimbursement transactions matching given correlation .
1647
+ # @param client_correlation_id [String] Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
1648
+ # @param [Hash] opts the optional parameters
1649
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
1650
+ # @return [Array<(ReimbursementListResponse, Integer, Hash)>] ReimbursementListResponse data, response status code and response headers
1651
+ def get_reimbursements_by_correlation_id_with_http_info(client_correlation_id, opts = {})
1652
+ if @api_client.config.debugging
1653
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_reimbursements_by_correlation_id ...'
1654
+ end
1655
+ # verify the required parameter 'client_correlation_id' is set
1656
+ if @api_client.config.client_side_validation && client_correlation_id.nil?
1657
+ fail ArgumentError, "Missing the required parameter 'client_correlation_id' when calling PayoutsApi.get_reimbursements_by_correlation_id"
1658
+ end
1659
+ # resource path
1660
+ local_var_path = '/payouts/v1/reimbursements/correlation/{clientCorrelationId}'.sub('{' + 'clientCorrelationId' + '}', CGI.escape(client_correlation_id.to_s).gsub('%2F', '/'))
1661
+
1662
+ # query parameters
1663
+ query_params = opts[:query_params] || {}
1664
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
1665
+
1666
+ # header parameters
1667
+ header_params = opts[:header_params] || {}
1668
+ # HTTP header 'Accept' (if needed)
1669
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1670
+
1671
+ # form parameters
1672
+ form_params = opts[:form_params] || {}
1673
+
1674
+ # http body (model)
1675
+ post_body = opts[:body]
1676
+
1677
+ # return_type
1678
+ return_type = opts[:return_type] || 'ReimbursementListResponse'
1679
+
1680
+ # auth_names
1681
+ auth_names = opts[:auth_names] || ['Bearer']
1682
+
1683
+ new_options = opts.merge(
1684
+ :header_params => header_params,
1685
+ :query_params => query_params,
1686
+ :form_params => form_params,
1687
+ :body => post_body,
1688
+ :auth_names => auth_names,
1689
+ :return_type => return_type
1690
+ )
1691
+
1692
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1693
+ if @api_client.config.debugging
1694
+ @api_client.config.logger.debug "API called: PayoutsApi#get_reimbursements_by_correlation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1695
+ end
1696
+ return data, status_code, headers
1697
+ end
1698
+
1699
+ # Returns all pool activities matching given client correlation id and status.
1700
+ # @param client_correlation_id [String] Correlation identifier assigned to one or more reimbursements by the Marketplace
1701
+ # @param current_status [String] Current reimbursement status of the pool activity
1702
+ # @param [Hash] opts the optional parameters
1703
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
1704
+ # @return [ReimbursementListResponse]
1705
+ def get_reimbursements_by_correlation_id_and_status(client_correlation_id, current_status, opts = {})
1706
+ data, _status_code, _headers = get_reimbursements_by_correlation_id_and_status_with_http_info(client_correlation_id, current_status, opts)
1707
+ data
1708
+ end
1709
+
1710
+ # Returns all pool activities matching given client correlation id and status.
1711
+ # @param client_correlation_id [String] Correlation identifier assigned to one or more reimbursements by the Marketplace
1712
+ # @param current_status [String] Current reimbursement status of the pool activity
1713
+ # @param [Hash] opts the optional parameters
1714
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
1715
+ # @return [Array<(ReimbursementListResponse, Integer, Hash)>] ReimbursementListResponse data, response status code and response headers
1716
+ def get_reimbursements_by_correlation_id_and_status_with_http_info(client_correlation_id, current_status, opts = {})
1717
+ if @api_client.config.debugging
1718
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_reimbursements_by_correlation_id_and_status ...'
1719
+ end
1720
+ # verify the required parameter 'client_correlation_id' is set
1721
+ if @api_client.config.client_side_validation && client_correlation_id.nil?
1722
+ fail ArgumentError, "Missing the required parameter 'client_correlation_id' when calling PayoutsApi.get_reimbursements_by_correlation_id_and_status"
1723
+ end
1724
+ # verify the required parameter 'current_status' is set
1725
+ if @api_client.config.client_side_validation && current_status.nil?
1726
+ fail ArgumentError, "Missing the required parameter 'current_status' when calling PayoutsApi.get_reimbursements_by_correlation_id_and_status"
1727
+ end
1728
+ # resource path
1729
+ local_var_path = '/payouts/v1/reimbursements/correlation/{clientCorrelationId}/status/{currentStatus}'.sub('{' + 'clientCorrelationId' + '}', CGI.escape(client_correlation_id.to_s).gsub('%2F', '/')).sub('{' + 'currentStatus' + '}', CGI.escape(current_status.to_s).gsub('%2F', '/'))
1730
+
1731
+ # query parameters
1732
+ query_params = opts[:query_params] || {}
1733
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
1734
+
1735
+ # header parameters
1736
+ header_params = opts[:header_params] || {}
1737
+ # HTTP header 'Accept' (if needed)
1738
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1739
+
1740
+ # form parameters
1741
+ form_params = opts[:form_params] || {}
1742
+
1743
+ # http body (model)
1744
+ post_body = opts[:body]
1745
+
1746
+ # return_type
1747
+ return_type = opts[:return_type] || 'ReimbursementListResponse'
1748
+
1749
+ # auth_names
1750
+ auth_names = opts[:auth_names] || ['Bearer']
1751
+
1752
+ new_options = opts.merge(
1753
+ :header_params => header_params,
1754
+ :query_params => query_params,
1755
+ :form_params => form_params,
1756
+ :body => post_body,
1757
+ :auth_names => auth_names,
1758
+ :return_type => return_type
1759
+ )
1760
+
1761
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1762
+ if @api_client.config.debugging
1763
+ @api_client.config.logger.debug "API called: PayoutsApi#get_reimbursements_by_correlation_id_and_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1764
+ end
1765
+ return data, status_code, headers
1766
+ end
1767
+
1768
+ # Returns all reimbursement transactions matching given currency .
1769
+ # @param currency [String] Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
1770
+ # @param [Hash] opts the optional parameters
1771
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
1772
+ # @return [ReimbursementListResponse]
1773
+ def get_reimbursements_by_currency(currency, opts = {})
1774
+ data, _status_code, _headers = get_reimbursements_by_currency_with_http_info(currency, opts)
1775
+ data
1776
+ end
1777
+
1778
+ # Returns all reimbursement transactions matching given currency .
1779
+ # @param currency [String] Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
1780
+ # @param [Hash] opts the optional parameters
1781
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
1782
+ # @return [Array<(ReimbursementListResponse, Integer, Hash)>] ReimbursementListResponse data, response status code and response headers
1783
+ def get_reimbursements_by_currency_with_http_info(currency, opts = {})
1784
+ if @api_client.config.debugging
1785
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_reimbursements_by_currency ...'
1786
+ end
1787
+ # verify the required parameter 'currency' is set
1788
+ if @api_client.config.client_side_validation && currency.nil?
1789
+ fail ArgumentError, "Missing the required parameter 'currency' when calling PayoutsApi.get_reimbursements_by_currency"
1790
+ end
1791
+ # resource path
1792
+ local_var_path = '/payouts/v1/reimbursements/currency/{currency}'.sub('{' + 'currency' + '}', CGI.escape(currency.to_s).gsub('%2F', '/'))
1793
+
1794
+ # query parameters
1795
+ query_params = opts[:query_params] || {}
1796
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
1797
+
1798
+ # header parameters
1799
+ header_params = opts[:header_params] || {}
1800
+ # HTTP header 'Accept' (if needed)
1801
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1802
+
1803
+ # form parameters
1804
+ form_params = opts[:form_params] || {}
1805
+
1806
+ # http body (model)
1807
+ post_body = opts[:body]
1808
+
1809
+ # return_type
1810
+ return_type = opts[:return_type] || 'ReimbursementListResponse'
1811
+
1812
+ # auth_names
1813
+ auth_names = opts[:auth_names] || ['Bearer']
1814
+
1815
+ new_options = opts.merge(
1816
+ :header_params => header_params,
1817
+ :query_params => query_params,
1818
+ :form_params => form_params,
1819
+ :body => post_body,
1820
+ :auth_names => auth_names,
1821
+ :return_type => return_type
1822
+ )
1823
+
1824
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1825
+ if @api_client.config.debugging
1826
+ @api_client.config.logger.debug "API called: PayoutsApi#get_reimbursements_by_currency\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1827
+ end
1828
+ return data, status_code, headers
1829
+ end
1830
+
1831
+ # Returns all reimbursement transactions matching given clientId .
1832
+ # @param client_unique_txn_id [String] Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
1833
+ # @param [Hash] opts the optional parameters
1834
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
1835
+ # @return [ReimbursementListResponse]
1836
+ def get_reimbursements_by_current_status(client_unique_txn_id, opts = {})
1837
+ data, _status_code, _headers = get_reimbursements_by_current_status_with_http_info(client_unique_txn_id, opts)
1838
+ data
1839
+ end
1840
+
1841
+ # Returns all reimbursement transactions matching given clientId .
1842
+ # @param client_unique_txn_id [String] Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
1843
+ # @param [Hash] opts the optional parameters
1844
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
1845
+ # @return [Array<(ReimbursementListResponse, Integer, Hash)>] ReimbursementListResponse data, response status code and response headers
1846
+ def get_reimbursements_by_current_status_with_http_info(client_unique_txn_id, opts = {})
1847
+ if @api_client.config.debugging
1848
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_reimbursements_by_current_status ...'
1849
+ end
1850
+ # verify the required parameter 'client_unique_txn_id' is set
1851
+ if @api_client.config.client_side_validation && client_unique_txn_id.nil?
1852
+ fail ArgumentError, "Missing the required parameter 'client_unique_txn_id' when calling PayoutsApi.get_reimbursements_by_current_status"
1853
+ end
1854
+ # resource path
1855
+ local_var_path = '/payouts/v1/reimbursements/clientId/{clientUniqueTxnId}'.sub('{' + 'clientUniqueTxnId' + '}', CGI.escape(client_unique_txn_id.to_s).gsub('%2F', '/'))
1856
+
1857
+ # query parameters
1858
+ query_params = opts[:query_params] || {}
1859
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
1860
+
1861
+ # header parameters
1862
+ header_params = opts[:header_params] || {}
1863
+ # HTTP header 'Accept' (if needed)
1864
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1865
+
1866
+ # form parameters
1867
+ form_params = opts[:form_params] || {}
1868
+
1869
+ # http body (model)
1870
+ post_body = opts[:body]
1871
+
1872
+ # return_type
1873
+ return_type = opts[:return_type] || 'ReimbursementListResponse'
1874
+
1875
+ # auth_names
1876
+ auth_names = opts[:auth_names] || ['Bearer']
1877
+
1878
+ new_options = opts.merge(
1879
+ :header_params => header_params,
1880
+ :query_params => query_params,
1881
+ :form_params => form_params,
1882
+ :body => post_body,
1883
+ :auth_names => auth_names,
1884
+ :return_type => return_type
1885
+ )
1886
+
1887
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1888
+ if @api_client.config.debugging
1889
+ @api_client.config.logger.debug "API called: PayoutsApi#get_reimbursements_by_current_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1890
+ end
1891
+ return data, status_code, headers
1892
+ end
1893
+
1894
+ # Returns all reimbursement transactions matching given instrument .
1895
+ # @param payee_instrument_id [String] Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
1896
+ # @param [Hash] opts the optional parameters
1897
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
1898
+ # @return [ReimbursementListResponse]
1899
+ def get_reimbursements_by_instrument(payee_instrument_id, opts = {})
1900
+ data, _status_code, _headers = get_reimbursements_by_instrument_with_http_info(payee_instrument_id, opts)
1901
+ data
1902
+ end
1903
+
1904
+ # Returns all reimbursement transactions matching given instrument .
1905
+ # @param payee_instrument_id [String] Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
1906
+ # @param [Hash] opts the optional parameters
1907
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
1908
+ # @return [Array<(ReimbursementListResponse, Integer, Hash)>] ReimbursementListResponse data, response status code and response headers
1909
+ def get_reimbursements_by_instrument_with_http_info(payee_instrument_id, opts = {})
1910
+ if @api_client.config.debugging
1911
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_reimbursements_by_instrument ...'
1912
+ end
1913
+ # verify the required parameter 'payee_instrument_id' is set
1914
+ if @api_client.config.client_side_validation && payee_instrument_id.nil?
1915
+ fail ArgumentError, "Missing the required parameter 'payee_instrument_id' when calling PayoutsApi.get_reimbursements_by_instrument"
1916
+ end
1917
+ # resource path
1918
+ local_var_path = '/payouts/v1/reimbursements/instrument/{payeeInstrumentId}'.sub('{' + 'payeeInstrumentId' + '}', CGI.escape(payee_instrument_id.to_s).gsub('%2F', '/'))
1919
+
1920
+ # query parameters
1921
+ query_params = opts[:query_params] || {}
1922
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
1923
+
1924
+ # header parameters
1925
+ header_params = opts[:header_params] || {}
1926
+ # HTTP header 'Accept' (if needed)
1927
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1928
+
1929
+ # form parameters
1930
+ form_params = opts[:form_params] || {}
1931
+
1932
+ # http body (model)
1933
+ post_body = opts[:body]
1934
+
1935
+ # return_type
1936
+ return_type = opts[:return_type] || 'ReimbursementListResponse'
1937
+
1938
+ # auth_names
1939
+ auth_names = opts[:auth_names] || ['Bearer']
1940
+
1941
+ new_options = opts.merge(
1942
+ :header_params => header_params,
1943
+ :query_params => query_params,
1944
+ :form_params => form_params,
1945
+ :body => post_body,
1946
+ :auth_names => auth_names,
1947
+ :return_type => return_type
1948
+ )
1949
+
1950
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1951
+ if @api_client.config.debugging
1952
+ @api_client.config.logger.debug "API called: PayoutsApi#get_reimbursements_by_instrument\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1953
+ end
1954
+ return data, status_code, headers
1955
+ end
1956
+
1957
+ # Returns all reimbursement transactions matching given order .
1958
+ # @param order_id [String] Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
1959
+ # @param [Hash] opts the optional parameters
1960
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
1961
+ # @return [ReimbursementListResponse]
1962
+ def get_reimbursements_by_order_id(order_id, opts = {})
1963
+ data, _status_code, _headers = get_reimbursements_by_order_id_with_http_info(order_id, opts)
1964
+ data
1965
+ end
1966
+
1967
+ # Returns all reimbursement transactions matching given order .
1968
+ # @param order_id [String] Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
1969
+ # @param [Hash] opts the optional parameters
1970
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
1971
+ # @return [Array<(ReimbursementListResponse, Integer, Hash)>] ReimbursementListResponse data, response status code and response headers
1972
+ def get_reimbursements_by_order_id_with_http_info(order_id, opts = {})
1973
+ if @api_client.config.debugging
1974
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_reimbursements_by_order_id ...'
1975
+ end
1976
+ # verify the required parameter 'order_id' is set
1977
+ if @api_client.config.client_side_validation && order_id.nil?
1978
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling PayoutsApi.get_reimbursements_by_order_id"
1979
+ end
1980
+ # resource path
1981
+ local_var_path = '/payouts/v1/reimbursements/order/{orderId}'.sub('{' + 'orderId' + '}', CGI.escape(order_id.to_s).gsub('%2F', '/'))
1982
+
1983
+ # query parameters
1984
+ query_params = opts[:query_params] || {}
1985
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
1986
+
1987
+ # header parameters
1988
+ header_params = opts[:header_params] || {}
1989
+ # HTTP header 'Accept' (if needed)
1990
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1991
+
1992
+ # form parameters
1993
+ form_params = opts[:form_params] || {}
1994
+
1995
+ # http body (model)
1996
+ post_body = opts[:body]
1997
+
1998
+ # return_type
1999
+ return_type = opts[:return_type] || 'ReimbursementListResponse'
2000
+
2001
+ # auth_names
2002
+ auth_names = opts[:auth_names] || ['Bearer']
2003
+
2004
+ new_options = opts.merge(
2005
+ :header_params => header_params,
2006
+ :query_params => query_params,
2007
+ :form_params => form_params,
2008
+ :body => post_body,
2009
+ :auth_names => auth_names,
2010
+ :return_type => return_type
2011
+ )
2012
+
2013
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2014
+ if @api_client.config.debugging
2015
+ @api_client.config.logger.debug "API called: PayoutsApi#get_reimbursements_by_order_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2016
+ end
2017
+ return data, status_code, headers
2018
+ end
2019
+
2020
+ # Returns all reimbursement transactions matching given party .
2021
+ # @param payee_party_id [String] Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
2022
+ # @param [Hash] opts the optional parameters
2023
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
2024
+ # @return [ReimbursementListResponse]
2025
+ def get_reimbursements_by_party_id(payee_party_id, opts = {})
2026
+ data, _status_code, _headers = get_reimbursements_by_party_id_with_http_info(payee_party_id, opts)
2027
+ data
2028
+ end
2029
+
2030
+ # Returns all reimbursement transactions matching given party .
2031
+ # @param payee_party_id [String] Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
2032
+ # @param [Hash] opts the optional parameters
2033
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
2034
+ # @return [Array<(ReimbursementListResponse, Integer, Hash)>] ReimbursementListResponse data, response status code and response headers
2035
+ def get_reimbursements_by_party_id_with_http_info(payee_party_id, opts = {})
2036
+ if @api_client.config.debugging
2037
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_reimbursements_by_party_id ...'
2038
+ end
2039
+ # verify the required parameter 'payee_party_id' is set
2040
+ if @api_client.config.client_side_validation && payee_party_id.nil?
2041
+ fail ArgumentError, "Missing the required parameter 'payee_party_id' when calling PayoutsApi.get_reimbursements_by_party_id"
2042
+ end
2043
+ # resource path
2044
+ local_var_path = '/payouts/v1/reimbursements/party/{payeePartyId}'.sub('{' + 'payeePartyId' + '}', CGI.escape(payee_party_id.to_s).gsub('%2F', '/'))
2045
+
2046
+ # query parameters
2047
+ query_params = opts[:query_params] || {}
2048
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
2049
+
2050
+ # header parameters
2051
+ header_params = opts[:header_params] || {}
2052
+ # HTTP header 'Accept' (if needed)
2053
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2054
+
2055
+ # form parameters
2056
+ form_params = opts[:form_params] || {}
2057
+
2058
+ # http body (model)
2059
+ post_body = opts[:body]
2060
+
2061
+ # return_type
2062
+ return_type = opts[:return_type] || 'ReimbursementListResponse'
2063
+
2064
+ # auth_names
2065
+ auth_names = opts[:auth_names] || ['Bearer']
2066
+
2067
+ new_options = opts.merge(
2068
+ :header_params => header_params,
2069
+ :query_params => query_params,
2070
+ :form_params => form_params,
2071
+ :body => post_body,
2072
+ :auth_names => auth_names,
2073
+ :return_type => return_type
2074
+ )
2075
+
2076
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2077
+ if @api_client.config.debugging
2078
+ @api_client.config.logger.debug "API called: PayoutsApi#get_reimbursements_by_party_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2079
+ end
2080
+ return data, status_code, headers
2081
+ end
2082
+
2083
+ # Returns all reimbursement transactions matching given status .
2084
+ # @param current_status [String] Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
2085
+ # @param [Hash] opts the optional parameters
2086
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
2087
+ # @return [ReimbursementListResponse]
2088
+ def get_reimbursements_by_status(current_status, opts = {})
2089
+ data, _status_code, _headers = get_reimbursements_by_status_with_http_info(current_status, opts)
2090
+ data
2091
+ end
2092
+
2093
+ # Returns all reimbursement transactions matching given status .
2094
+ # @param current_status [String] Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
2095
+ # @param [Hash] opts the optional parameters
2096
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
2097
+ # @return [Array<(ReimbursementListResponse, Integer, Hash)>] ReimbursementListResponse data, response status code and response headers
2098
+ def get_reimbursements_by_status_with_http_info(current_status, opts = {})
2099
+ if @api_client.config.debugging
2100
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.get_reimbursements_by_status ...'
2101
+ end
2102
+ # verify the required parameter 'current_status' is set
2103
+ if @api_client.config.client_side_validation && current_status.nil?
2104
+ fail ArgumentError, "Missing the required parameter 'current_status' when calling PayoutsApi.get_reimbursements_by_status"
2105
+ end
2106
+ # resource path
2107
+ local_var_path = '/payouts/v1/reimbursements/status/{currentStatus}'.sub('{' + 'currentStatus' + '}', CGI.escape(current_status.to_s).gsub('%2F', '/'))
2108
+
2109
+ # query parameters
2110
+ query_params = opts[:query_params] || {}
2111
+ query_params[:'marketplace'] = opts[:'marketplace'] if !opts[:'marketplace'].nil?
2112
+
2113
+ # header parameters
2114
+ header_params = opts[:header_params] || {}
2115
+ # HTTP header 'Accept' (if needed)
2116
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2117
+
2118
+ # form parameters
2119
+ form_params = opts[:form_params] || {}
2120
+
2121
+ # http body (model)
2122
+ post_body = opts[:body]
2123
+
2124
+ # return_type
2125
+ return_type = opts[:return_type] || 'ReimbursementListResponse'
2126
+
2127
+ # auth_names
2128
+ auth_names = opts[:auth_names] || ['Bearer']
2129
+
2130
+ new_options = opts.merge(
2131
+ :header_params => header_params,
2132
+ :query_params => query_params,
2133
+ :form_params => form_params,
2134
+ :body => post_body,
2135
+ :auth_names => auth_names,
2136
+ :return_type => return_type
2137
+ )
2138
+
2139
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2140
+ if @api_client.config.debugging
2141
+ @api_client.config.logger.debug "API called: PayoutsApi#get_reimbursements_by_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2142
+ end
2143
+ return data, status_code, headers
2144
+ end
2145
+
2146
+ # Reverse Disbursement - Submits a full (or partial) disbursement for funds that were originally retrieved via the given transactionId recapture order. The resulting transactionId represents the linked disbursement.
2147
+ # @param transaction_id [String] Primary key for a single disbursement record (assigned by YapStone)
2148
+ # @param reverse_disbursement_request [ReverseDisbursementRequest]
2149
+ # @param [Hash] opts the optional parameters
2150
+ # @return [nil]
2151
+ def reverse_disbursement(transaction_id, reverse_disbursement_request, opts = {})
2152
+ reverse_disbursement_with_http_info(transaction_id, reverse_disbursement_request, opts)
2153
+ nil
2154
+ end
2155
+
2156
+ # Reverse Disbursement - Submits a full (or partial) disbursement for funds that were originally retrieved via the given transactionId recapture order. The resulting transactionId represents the linked disbursement.
2157
+ # @param transaction_id [String] Primary key for a single disbursement record (assigned by YapStone)
2158
+ # @param reverse_disbursement_request [ReverseDisbursementRequest]
2159
+ # @param [Hash] opts the optional parameters
2160
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2161
+ def reverse_disbursement_with_http_info(transaction_id, reverse_disbursement_request, opts = {})
2162
+ if @api_client.config.debugging
2163
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.reverse_disbursement ...'
2164
+ end
2165
+ # verify the required parameter 'transaction_id' is set
2166
+ if @api_client.config.client_side_validation && transaction_id.nil?
2167
+ fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PayoutsApi.reverse_disbursement"
2168
+ end
2169
+ # verify the required parameter 'reverse_disbursement_request' is set
2170
+ if @api_client.config.client_side_validation && reverse_disbursement_request.nil?
2171
+ fail ArgumentError, "Missing the required parameter 'reverse_disbursement_request' when calling PayoutsApi.reverse_disbursement"
2172
+ end
2173
+ # resource path
2174
+ local_var_path = '/payouts/v1/disbursements/{transactionId}/reverse'.sub('{' + 'transactionId' + '}', CGI.escape(transaction_id.to_s).gsub('%2F', '/'))
2175
+
2176
+ # query parameters
2177
+ query_params = opts[:query_params] || {}
2178
+
2179
+ # header parameters
2180
+ header_params = opts[:header_params] || {}
2181
+ # HTTP header 'Content-Type'
2182
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2183
+
2184
+ # form parameters
2185
+ form_params = opts[:form_params] || {}
2186
+
2187
+ # http body (model)
2188
+ post_body = opts[:body] || @api_client.object_to_http_body(reverse_disbursement_request)
2189
+
2190
+ # return_type
2191
+ return_type = opts[:return_type]
2192
+
2193
+ # auth_names
2194
+ auth_names = opts[:auth_names] || ['Bearer']
2195
+
2196
+ new_options = opts.merge(
2197
+ :header_params => header_params,
2198
+ :query_params => query_params,
2199
+ :form_params => form_params,
2200
+ :body => post_body,
2201
+ :auth_names => auth_names,
2202
+ :return_type => return_type
2203
+ )
2204
+
2205
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
2206
+ if @api_client.config.debugging
2207
+ @api_client.config.logger.debug "API called: PayoutsApi#reverse_disbursement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2208
+ end
2209
+ return data, status_code, headers
2210
+ end
2211
+
2212
+ # Reverse Reimbursement - Submits a full (or partial) disbursement for funds that were originally retrieved via the given transactionId recapture order. The resulting transactionId represents the linked reimbursement.
2213
+ # @param transaction_id [String] Primary key for a single reimbursement record (assigned by YapStone)
2214
+ # @param reverse_reimbursement_request [ReverseReimbursementRequest]
2215
+ # @param [Hash] opts the optional parameters
2216
+ # @return [nil]
2217
+ def reverse_reimbursement(transaction_id, reverse_reimbursement_request, opts = {})
2218
+ reverse_reimbursement_with_http_info(transaction_id, reverse_reimbursement_request, opts)
2219
+ nil
2220
+ end
2221
+
2222
+ # Reverse Reimbursement - Submits a full (or partial) disbursement for funds that were originally retrieved via the given transactionId recapture order. The resulting transactionId represents the linked reimbursement.
2223
+ # @param transaction_id [String] Primary key for a single reimbursement record (assigned by YapStone)
2224
+ # @param reverse_reimbursement_request [ReverseReimbursementRequest]
2225
+ # @param [Hash] opts the optional parameters
2226
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2227
+ def reverse_reimbursement_with_http_info(transaction_id, reverse_reimbursement_request, opts = {})
2228
+ if @api_client.config.debugging
2229
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.reverse_reimbursement ...'
2230
+ end
2231
+ # verify the required parameter 'transaction_id' is set
2232
+ if @api_client.config.client_side_validation && transaction_id.nil?
2233
+ fail ArgumentError, "Missing the required parameter 'transaction_id' when calling PayoutsApi.reverse_reimbursement"
2234
+ end
2235
+ # verify the required parameter 'reverse_reimbursement_request' is set
2236
+ if @api_client.config.client_side_validation && reverse_reimbursement_request.nil?
2237
+ fail ArgumentError, "Missing the required parameter 'reverse_reimbursement_request' when calling PayoutsApi.reverse_reimbursement"
2238
+ end
2239
+ # resource path
2240
+ local_var_path = '/payouts/v1/reimbursements/{transactionId}/reverse'.sub('{' + 'transactionId' + '}', CGI.escape(transaction_id.to_s).gsub('%2F', '/'))
2241
+
2242
+ # query parameters
2243
+ query_params = opts[:query_params] || {}
2244
+
2245
+ # header parameters
2246
+ header_params = opts[:header_params] || {}
2247
+ # HTTP header 'Content-Type'
2248
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2249
+
2250
+ # form parameters
2251
+ form_params = opts[:form_params] || {}
2252
+
2253
+ # http body (model)
2254
+ post_body = opts[:body] || @api_client.object_to_http_body(reverse_reimbursement_request)
2255
+
2256
+ # return_type
2257
+ return_type = opts[:return_type]
2258
+
2259
+ # auth_names
2260
+ auth_names = opts[:auth_names] || ['Bearer']
2261
+
2262
+ new_options = opts.merge(
2263
+ :header_params => header_params,
2264
+ :query_params => query_params,
2265
+ :form_params => form_params,
2266
+ :body => post_body,
2267
+ :auth_names => auth_names,
2268
+ :return_type => return_type
2269
+ )
2270
+
2271
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
2272
+ if @api_client.config.debugging
2273
+ @api_client.config.logger.debug "API called: PayoutsApi#reverse_reimbursement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2274
+ end
2275
+ return data, status_code, headers
2276
+ end
2277
+
2278
+ # Provides instructions from the Marketplace for payments to be distributed to one or more Payees. Disbursement requests are grouped by currency, given that the funding pools are also segregated in this manner. If the corresponding pool was funded in advance, the disbursements will be processed on a same-day basis. Otherwise the disbursement requests will be queued for later processing as funds become available. Response is organized in two collections (accepted and rejected) to distinguish successful and failed items.
2279
+ # @param disbursement_request [DisbursementRequest] Provides instructions from the Marketplace for payments to be distributed to one or more Payees. Disbursement requests are grouped by currency, given that the funding pools are also segregated in this manner. If the corresponding pool was funded in advance, the disbursements will be processed on a same-day basis. Otherwise the disbursement requests will be queued for later processing as funds become available. Response is organized in two collections (&#x60;accepted&#x60; and &#x60;rejected&#x60;) to distinguish successful and failed items.
2280
+ # @param [Hash] opts the optional parameters
2281
+ # @return [nil]
2282
+ def submit_disbursements_for_payees(disbursement_request, opts = {})
2283
+ submit_disbursements_for_payees_with_http_info(disbursement_request, opts)
2284
+ nil
2285
+ end
2286
+
2287
+ # Provides instructions from the Marketplace for payments to be distributed to one or more Payees. Disbursement requests are grouped by currency, given that the funding pools are also segregated in this manner. If the corresponding pool was funded in advance, the disbursements will be processed on a same-day basis. Otherwise the disbursement requests will be queued for later processing as funds become available. Response is organized in two collections (accepted and rejected) to distinguish successful and failed items.
2288
+ # @param disbursement_request [DisbursementRequest] Provides instructions from the Marketplace for payments to be distributed to one or more Payees. Disbursement requests are grouped by currency, given that the funding pools are also segregated in this manner. If the corresponding pool was funded in advance, the disbursements will be processed on a same-day basis. Otherwise the disbursement requests will be queued for later processing as funds become available. Response is organized in two collections (&#x60;accepted&#x60; and &#x60;rejected&#x60;) to distinguish successful and failed items.
2289
+ # @param [Hash] opts the optional parameters
2290
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2291
+ def submit_disbursements_for_payees_with_http_info(disbursement_request, opts = {})
2292
+ if @api_client.config.debugging
2293
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.submit_disbursements_for_payees ...'
2294
+ end
2295
+ # verify the required parameter 'disbursement_request' is set
2296
+ if @api_client.config.client_side_validation && disbursement_request.nil?
2297
+ fail ArgumentError, "Missing the required parameter 'disbursement_request' when calling PayoutsApi.submit_disbursements_for_payees"
2298
+ end
2299
+ # resource path
2300
+ local_var_path = '/payouts/v1/disbursements'
2301
+
2302
+ # query parameters
2303
+ query_params = opts[:query_params] || {}
2304
+
2305
+ # header parameters
2306
+ header_params = opts[:header_params] || {}
2307
+ # HTTP header 'Content-Type'
2308
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2309
+
2310
+ # form parameters
2311
+ form_params = opts[:form_params] || {}
2312
+
2313
+ # http body (model)
2314
+ post_body = opts[:body] || @api_client.object_to_http_body(disbursement_request)
2315
+
2316
+ # return_type
2317
+ return_type = opts[:return_type]
2318
+
2319
+ # auth_names
2320
+ auth_names = opts[:auth_names] || ['Bearer']
2321
+
2322
+ new_options = opts.merge(
2323
+ :header_params => header_params,
2324
+ :query_params => query_params,
2325
+ :form_params => form_params,
2326
+ :body => post_body,
2327
+ :auth_names => auth_names,
2328
+ :return_type => return_type
2329
+ )
2330
+
2331
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2332
+ if @api_client.config.debugging
2333
+ @api_client.config.logger.debug "API called: PayoutsApi#submit_disbursements_for_payees\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2334
+ end
2335
+ return data, status_code, headers
2336
+ end
2337
+
2338
+ # @param reimbursement_request [ReimbursementRequest]
2339
+ # @param [Hash] opts the optional parameters
2340
+ # @return [nil]
2341
+ def submit_reimbursements(reimbursement_request, opts = {})
2342
+ submit_reimbursements_with_http_info(reimbursement_request, opts)
2343
+ nil
2344
+ end
2345
+
2346
+ # @param reimbursement_request [ReimbursementRequest]
2347
+ # @param [Hash] opts the optional parameters
2348
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2349
+ def submit_reimbursements_with_http_info(reimbursement_request, opts = {})
2350
+ if @api_client.config.debugging
2351
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.submit_reimbursements ...'
2352
+ end
2353
+ # verify the required parameter 'reimbursement_request' is set
2354
+ if @api_client.config.client_side_validation && reimbursement_request.nil?
2355
+ fail ArgumentError, "Missing the required parameter 'reimbursement_request' when calling PayoutsApi.submit_reimbursements"
2356
+ end
2357
+ # resource path
2358
+ local_var_path = '/payouts/v1/reimbursements'
2359
+
2360
+ # query parameters
2361
+ query_params = opts[:query_params] || {}
2362
+
2363
+ # header parameters
2364
+ header_params = opts[:header_params] || {}
2365
+ # HTTP header 'Content-Type'
2366
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2367
+
2368
+ # form parameters
2369
+ form_params = opts[:form_params] || {}
2370
+
2371
+ # http body (model)
2372
+ post_body = opts[:body] || @api_client.object_to_http_body(reimbursement_request)
2373
+
2374
+ # return_type
2375
+ return_type = opts[:return_type]
2376
+
2377
+ # auth_names
2378
+ auth_names = opts[:auth_names] || ['Bearer']
2379
+
2380
+ new_options = opts.merge(
2381
+ :header_params => header_params,
2382
+ :query_params => query_params,
2383
+ :form_params => form_params,
2384
+ :body => post_body,
2385
+ :auth_names => auth_names,
2386
+ :return_type => return_type
2387
+ )
2388
+
2389
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2390
+ if @api_client.config.debugging
2391
+ @api_client.config.logger.debug "API called: PayoutsApi#submit_reimbursements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2392
+ end
2393
+ return data, status_code, headers
2394
+ end
2395
+
2396
+ # Allows a Marketplace to update the details for a pending deposit advice to correct these values relative to the original post operation. Note that the new values will overwrite the existing deposit, and all must be provided by the caller (presumably after a corresponding get operation). If the deposit has already been processed then the update request will be rejected (400 Bad request).
2397
+ # @param deposit_id [String] Primary key for a single deposit record (assigned by YapStone)
2398
+ # @param deposit_detail [DepositDetail]
2399
+ # @param [Hash] opts the optional parameters
2400
+ # @return [nil]
2401
+ def update_deposit(deposit_id, deposit_detail, opts = {})
2402
+ update_deposit_with_http_info(deposit_id, deposit_detail, opts)
2403
+ nil
2404
+ end
2405
+
2406
+ # Allows a Marketplace to update the details for a pending deposit advice to correct these values relative to the original post operation. Note that the new values will overwrite the existing deposit, and all must be provided by the caller (presumably after a corresponding get operation). If the deposit has already been processed then the update request will be rejected (400 Bad request).
2407
+ # @param deposit_id [String] Primary key for a single deposit record (assigned by YapStone)
2408
+ # @param deposit_detail [DepositDetail]
2409
+ # @param [Hash] opts the optional parameters
2410
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2411
+ def update_deposit_with_http_info(deposit_id, deposit_detail, opts = {})
2412
+ if @api_client.config.debugging
2413
+ @api_client.config.logger.debug 'Calling API: PayoutsApi.update_deposit ...'
2414
+ end
2415
+ # verify the required parameter 'deposit_id' is set
2416
+ if @api_client.config.client_side_validation && deposit_id.nil?
2417
+ fail ArgumentError, "Missing the required parameter 'deposit_id' when calling PayoutsApi.update_deposit"
2418
+ end
2419
+ # verify the required parameter 'deposit_detail' is set
2420
+ if @api_client.config.client_side_validation && deposit_detail.nil?
2421
+ fail ArgumentError, "Missing the required parameter 'deposit_detail' when calling PayoutsApi.update_deposit"
2422
+ end
2423
+ # resource path
2424
+ local_var_path = '/payouts/v1/deposits/{depositId}'.sub('{' + 'depositId' + '}', CGI.escape(deposit_id.to_s).gsub('%2F', '/'))
2425
+
2426
+ # query parameters
2427
+ query_params = opts[:query_params] || {}
2428
+
2429
+ # header parameters
2430
+ header_params = opts[:header_params] || {}
2431
+ # HTTP header 'Content-Type'
2432
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2433
+
2434
+ # form parameters
2435
+ form_params = opts[:form_params] || {}
2436
+
2437
+ # http body (model)
2438
+ post_body = opts[:body] || @api_client.object_to_http_body(deposit_detail)
2439
+
2440
+ # return_type
2441
+ return_type = opts[:return_type]
2442
+
2443
+ # auth_names
2444
+ auth_names = opts[:auth_names] || ['Bearer']
2445
+
2446
+ new_options = opts.merge(
2447
+ :header_params => header_params,
2448
+ :query_params => query_params,
2449
+ :form_params => form_params,
2450
+ :body => post_body,
2451
+ :auth_names => auth_names,
2452
+ :return_type => return_type
2453
+ )
2454
+
2455
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
2456
+ if @api_client.config.debugging
2457
+ @api_client.config.logger.debug "API called: PayoutsApi#update_deposit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2458
+ end
2459
+ return data, status_code, headers
2460
+ end
2461
+ end
2462
+ end