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,205 @@
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 'date'
14
+
15
+ module Yapstone
16
+ class StatusChanges
17
+ attr_accessor :status
18
+
19
+ attr_accessor :change_date
20
+
21
+ # Attribute mapping from ruby-style variable name to JSON key.
22
+ def self.attribute_map
23
+ {
24
+ :'status' => :'status',
25
+ :'change_date' => :'changeDate'
26
+ }
27
+ end
28
+
29
+ # Attribute type mapping.
30
+ def self.openapi_types
31
+ {
32
+ :'status' => :'String',
33
+ :'change_date' => :'String'
34
+ }
35
+ end
36
+
37
+ # Initializes the object
38
+ # @param [Hash] attributes Model attributes in the form of hash
39
+ def initialize(attributes = {})
40
+ if (!attributes.is_a?(Hash))
41
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Yapstone::StatusChanges` initialize method"
42
+ end
43
+
44
+ # check to see if the attribute exists and convert string to symbol for hash key
45
+ attributes = attributes.each_with_object({}) { |(k, v), h|
46
+ if (!self.class.attribute_map.key?(k.to_sym))
47
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Yapstone::StatusChanges`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
48
+ end
49
+ h[k.to_sym] = v
50
+ }
51
+
52
+ if attributes.key?(:'status')
53
+ self.status = attributes[:'status']
54
+ end
55
+
56
+ if attributes.key?(:'change_date')
57
+ self.change_date = attributes[:'change_date']
58
+ end
59
+ end
60
+
61
+ # Show invalid properties with the reasons. Usually used together with valid?
62
+ # @return Array for valid properties with the reasons
63
+ def list_invalid_properties
64
+ invalid_properties = Array.new
65
+ invalid_properties
66
+ end
67
+
68
+ # Check to see if the all the properties in the model are valid
69
+ # @return true if the model is valid
70
+ def valid?
71
+ true
72
+ end
73
+
74
+ # Checks equality by comparing each attribute.
75
+ # @param [Object] Object to be compared
76
+ def ==(o)
77
+ return true if self.equal?(o)
78
+ self.class == o.class &&
79
+ status == o.status &&
80
+ change_date == o.change_date
81
+ end
82
+
83
+ # @see the `==` method
84
+ # @param [Object] Object to be compared
85
+ def eql?(o)
86
+ self == o
87
+ end
88
+
89
+ # Calculates hash code according to all attributes.
90
+ # @return [Integer] Hash code
91
+ def hash
92
+ [status, change_date].hash
93
+ end
94
+
95
+ # Builds the object from hash
96
+ # @param [Hash] attributes Model attributes in the form of hash
97
+ # @return [Object] Returns the model itself
98
+ def self.build_from_hash(attributes)
99
+ new.build_from_hash(attributes)
100
+ end
101
+
102
+ # Builds the object from hash
103
+ # @param [Hash] attributes Model attributes in the form of hash
104
+ # @return [Object] Returns the model itself
105
+ def build_from_hash(attributes)
106
+ return nil unless attributes.is_a?(Hash)
107
+ self.class.openapi_types.each_pair do |key, type|
108
+ if type =~ /\AArray<(.*)>/i
109
+ # check to ensure the input is an array given that the attribute
110
+ # is documented as an array but the input is not
111
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
112
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
113
+ end
114
+ elsif !attributes[self.class.attribute_map[key]].nil?
115
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
116
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
117
+ end
118
+
119
+ self
120
+ end
121
+
122
+ # Deserializes the data based on type
123
+ # @param string type Data type
124
+ # @param string value Value to be deserialized
125
+ # @return [Object] Deserialized data
126
+ def _deserialize(type, value)
127
+ case type.to_sym
128
+ when :DateTime
129
+ DateTime.parse(value)
130
+ when :Date
131
+ Date.parse(value)
132
+ when :String
133
+ value.to_s
134
+ when :Integer
135
+ value.to_i
136
+ when :Float
137
+ value.to_f
138
+ when :Boolean
139
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
140
+ true
141
+ else
142
+ false
143
+ end
144
+ when :Object
145
+ # generic object (usually a Hash), return directly
146
+ value
147
+ when /\AArray<(?<inner_type>.+)>\z/
148
+ inner_type = Regexp.last_match[:inner_type]
149
+ value.map { |v| _deserialize(inner_type, v) }
150
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
151
+ k_type = Regexp.last_match[:k_type]
152
+ v_type = Regexp.last_match[:v_type]
153
+ {}.tap do |hash|
154
+ value.each do |k, v|
155
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
156
+ end
157
+ end
158
+ else # model
159
+ Yapstone.const_get(type).build_from_hash(value)
160
+ end
161
+ end
162
+
163
+ # Returns the string representation of the object
164
+ # @return [String] String presentation of the object
165
+ def to_s
166
+ to_hash.to_s
167
+ end
168
+
169
+ # to_body is an alias to to_hash (backward compatibility)
170
+ # @return [Hash] Returns the object in the form of hash
171
+ def to_body
172
+ to_hash
173
+ end
174
+
175
+ # Returns the object in the form of hash
176
+ # @return [Hash] Returns the object in the form of hash
177
+ def to_hash
178
+ hash = {}
179
+ self.class.attribute_map.each_pair do |attr, param|
180
+ value = self.send(attr)
181
+ next if value.nil?
182
+ hash[param] = _to_hash(value)
183
+ end
184
+ hash
185
+ end
186
+
187
+ # Outputs non-array value in the form of hash
188
+ # For object, use to_hash. Otherwise, just return the value
189
+ # @param [Object] value Any valid value
190
+ # @return [Hash] Returns the value in the form of hash
191
+ def _to_hash(value)
192
+ if value.is_a?(Array)
193
+ value.compact.map { |v| _to_hash(v) }
194
+ elsif value.is_a?(Hash)
195
+ {}.tap do |hash|
196
+ value.each { |k, v| hash[k] = _to_hash(v) }
197
+ end
198
+ elsif value.respond_to? :to_hash
199
+ value.to_hash
200
+ else
201
+ value
202
+ end
203
+ end
204
+ end
205
+ end
@@ -0,0 +1,15 @@
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
+ module Yapstone
14
+ VERSION = '1.0.0'
15
+ end
@@ -0,0 +1,48 @@
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 'spec_helper'
14
+ require 'json'
15
+
16
+ # Unit tests for Yapstone::AuthenticationApi
17
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
+ # Please update as you see appropriate
19
+ describe 'AuthenticationApi' do
20
+ before do
21
+ # run before each test
22
+ @api_instance = Yapstone::AuthenticationApi.new
23
+ end
24
+
25
+ after do
26
+ # run after each test
27
+ end
28
+
29
+ describe 'test an instance of AuthenticationApi' do
30
+ it 'should create an instance of AuthenticationApi' do
31
+ expect(@api_instance).to be_instance_of(Yapstone::AuthenticationApi)
32
+ end
33
+ end
34
+
35
+ # unit tests for authenticate_partner
36
+ # Authenticate Partner
37
+ # 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.
38
+ # @param grant_type 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.
39
+ # @param authorization Provide client_id:client_secret as base64 encoded basic auth.
40
+ # @param [Hash] opts the optional parameters
41
+ # @return [InlineResponse200]
42
+ describe 'authenticate_partner test' do
43
+ it 'should work' do
44
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
45
+ end
46
+ end
47
+
48
+ end
@@ -0,0 +1,506 @@
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 'spec_helper'
14
+ require 'json'
15
+
16
+ # Unit tests for Yapstone::PayoutsApi
17
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
+ # Please update as you see appropriate
19
+ describe 'PayoutsApi' do
20
+ before do
21
+ # run before each test
22
+ @api_instance = Yapstone::PayoutsApi.new
23
+ end
24
+
25
+ after do
26
+ # run after each test
27
+ end
28
+
29
+ describe 'test an instance of PayoutsApi' do
30
+ it 'should create an instance of PayoutsApi' do
31
+ expect(@api_instance).to be_instance_of(Yapstone::PayoutsApi)
32
+ end
33
+ end
34
+
35
+ # unit tests for cancel_deposit
36
+ # 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.
37
+ # @param deposit_id Primary key for a single deposit record (assigned by YapStone)
38
+ # @param cancel_deposit_request
39
+ # @param [Hash] opts the optional parameters
40
+ # @return [nil]
41
+ describe 'cancel_deposit test' do
42
+ it 'should work' do
43
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
+ end
45
+ end
46
+
47
+ # unit tests for cancel_disbursement
48
+ # 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.
49
+ # @param transaction_id Primary key for a single disbursement record (assigned by YapStone)
50
+ # @param cancel_request
51
+ # @param [Hash] opts the optional parameters
52
+ # @return [nil]
53
+ describe 'cancel_disbursement test' do
54
+ it 'should work' do
55
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
+ end
57
+ end
58
+
59
+ # unit tests for cancel_reimbursement
60
+ # 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.
61
+ # @param transaction_id Primary key for a single reimbursement record (assigned by YapStone)
62
+ # @param cancel_request
63
+ # @param [Hash] opts the optional parameters
64
+ # @return [nil]
65
+ describe 'cancel_reimbursement test' do
66
+ it 'should work' do
67
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
68
+ end
69
+ end
70
+
71
+ # unit tests for create_deposit
72
+ # 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.
73
+ # @param deposit_request Request describes one or more pending deposits for the given currency.
74
+ # @param [Hash] opts the optional parameters
75
+ # @return [nil]
76
+ describe 'create_deposit test' do
77
+ it 'should work' do
78
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
79
+ end
80
+ end
81
+
82
+ # unit tests for get_balances
83
+ # 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).
84
+ # @param [Hash] opts the optional parameters
85
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the balances. If not passed default marketplace from app token will be used
86
+ # @option opts [String] :currency The currency for the balance inquiry (returns all by default)
87
+ # @return [PoolListResponse]
88
+ describe 'get_balances test' do
89
+ it 'should work' do
90
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
91
+ end
92
+ end
93
+
94
+ # unit tests for get_deposit
95
+ # Returns the deposit detail and status history for the given depositId.
96
+ # @param deposit_id Primary key for a single deposit record (assigned by YapStone)
97
+ # @param [Hash] opts the optional parameters
98
+ # @return [Deposit]
99
+ describe 'get_deposit test' do
100
+ it 'should work' do
101
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
102
+ end
103
+ end
104
+
105
+ # unit tests for get_deposits_by_bank_reference_tag
106
+ # Returns all pool activities matching given bank reference tag.
107
+ # @param bank_reference_tag Partial bank reference identifier for a single deposit record
108
+ # @param [Hash] opts the optional parameters
109
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
110
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
111
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
112
+ # @return [DepositListResponse]
113
+ describe 'get_deposits_by_bank_reference_tag test' do
114
+ it 'should work' do
115
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
116
+ end
117
+ end
118
+
119
+ # unit tests for get_deposits_by_client_unique_txn_id
120
+ # Returns all pool activities matching given client unique transaction id.
121
+ # @param client_unique_txn_id Alternate key for a single deposit record (assigned by Marketplace)
122
+ # @param [Hash] opts the optional parameters
123
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
124
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
125
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
126
+ # @return [DepositListResponse]
127
+ describe 'get_deposits_by_client_unique_txn_id test' do
128
+ it 'should work' do
129
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
130
+ end
131
+ end
132
+
133
+ # unit tests for get_deposits_by_correlation_id
134
+ # Returns all pool activities matching given client correlation id.
135
+ # @param client_correlation_id Correlation identifier assigned to one or more deposits by the Marketplace
136
+ # @param [Hash] opts the optional parameters
137
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
138
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
139
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
140
+ # @return [DepositListResponse]
141
+ describe 'get_deposits_by_correlation_id test' do
142
+ it 'should work' do
143
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
144
+ end
145
+ end
146
+
147
+ # unit tests for get_deposits_by_correlation_id_and_status
148
+ # Returns all pool activities matching given client correlation id and status.
149
+ # @param client_correlation_id Correlation identifier assigned to one or more deposits by the Marketplace
150
+ # @param current_status Current deposit status of the pool activity
151
+ # @param [Hash] opts the optional parameters
152
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
153
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
154
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
155
+ # @return [DepositListResponse]
156
+ describe 'get_deposits_by_correlation_id_and_status test' do
157
+ it 'should work' do
158
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
159
+ end
160
+ end
161
+
162
+ # unit tests for get_deposits_by_currency
163
+ # Returns all pool activities matching given currency.
164
+ # @param currency The currency for a set of deposits (EUR, GBP, USD)
165
+ # @param [Hash] opts the optional parameters
166
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
167
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
168
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
169
+ # @return [DepositListResponse]
170
+ describe 'get_deposits_by_currency test' do
171
+ it 'should work' do
172
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
173
+ end
174
+ end
175
+
176
+ # unit tests for get_deposits_by_status
177
+ # Returns all pool activities matching given current status.
178
+ # @param current_status Current deposit status of the pool activity
179
+ # @param [Hash] opts the optional parameters
180
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
181
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
182
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the deposits. If not passed, default marketplace from app token will be used if applicable.
183
+ # @return [DepositListResponse]
184
+ describe 'get_deposits_by_status test' do
185
+ it 'should work' do
186
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
187
+ end
188
+ end
189
+
190
+ # unit tests for get_disbursements_by_client_correlation_id
191
+ # Returns all disbursement transactions matching given correlation id.
192
+ # @param client_correlation_id Correlation identifier assigned to one or more disbursements by the Marketplace
193
+ # @param [Hash] opts the optional parameters
194
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
195
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
196
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
197
+ # @return [DisbursementListResponse]
198
+ describe 'get_disbursements_by_client_correlation_id test' do
199
+ it 'should work' do
200
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
201
+ end
202
+ end
203
+
204
+ # unit tests for get_disbursements_by_client_unique_txn_id
205
+ # Returns all disbursement transactions matching given unique id.
206
+ # @param client_unique_txn_id Alternate key for a single disbursement record (assigned by Marketplace)
207
+ # @param [Hash] opts the optional parameters
208
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
209
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
210
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
211
+ # @return [DisbursementListResponse]
212
+ describe 'get_disbursements_by_client_unique_txn_id test' do
213
+ it 'should work' do
214
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
215
+ end
216
+ end
217
+
218
+ # unit tests for get_disbursements_by_contract_id
219
+ # Returns all disbursement transactions matching given contract id.
220
+ # @param contract_id Primary identifier used to designate a payee (assigned by YapStone)
221
+ # @param [Hash] opts the optional parameters
222
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
223
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
224
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
225
+ # @return [DisbursementListResponse]
226
+ describe 'get_disbursements_by_contract_id test' do
227
+ it 'should work' do
228
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
229
+ end
230
+ end
231
+
232
+ # unit tests for get_disbursements_by_correlation_id_and_status
233
+ # Returns all disbursement transactions matching given correlation id and status.
234
+ # @param client_correlation_id Correlation identifier assigned to one or more disbursements by the Marketplace
235
+ # @param current_status Current disbursement status
236
+ # @param [Hash] opts the optional parameters
237
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
238
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
239
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
240
+ # @return [DisbursementListResponse]
241
+ describe 'get_disbursements_by_correlation_id_and_status test' do
242
+ it 'should work' do
243
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
244
+ end
245
+ end
246
+
247
+ # unit tests for get_disbursements_by_currency
248
+ # Returns all disbursement transactions matching given contract id.
249
+ # @param currency The currency for a set of disbursements (EUR, GBP, USD)
250
+ # @param [Hash] opts the optional parameters
251
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
252
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
253
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
254
+ # @return [DisbursementListResponse]
255
+ describe 'get_disbursements_by_currency test' do
256
+ it 'should work' do
257
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
258
+ end
259
+ end
260
+
261
+ # unit tests for get_disbursements_by_instrument_id
262
+ # Returns all disbursement transactions matching given contract id.
263
+ # @param payee_instrument_id Primary identifier used to designate a payment instrument (assigned by YapStone)
264
+ # @param [Hash] opts the optional parameters
265
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
266
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
267
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
268
+ # @return [DisbursementListResponse]
269
+ describe 'get_disbursements_by_instrument_id test' do
270
+ it 'should work' do
271
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
272
+ end
273
+ end
274
+
275
+ # unit tests for get_disbursements_by_order_id
276
+ # Returns all disbursement transactions matching given order id.
277
+ # @param order_id Group identifer for a set of disbursements created via a single API request (assigned by YapStone)
278
+ # @param [Hash] opts the optional parameters
279
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
280
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
281
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
282
+ # @return [DisbursementListResponse]
283
+ describe 'get_disbursements_by_order_id test' do
284
+ it 'should work' do
285
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
286
+ end
287
+ end
288
+
289
+ # unit tests for get_disbursements_by_party_id
290
+ # Returns all disbursement transactions matching given contract id.
291
+ # @param payee_party_id Primary identifier used to designate a payment recipient (assigned by YapStone)
292
+ # @param [Hash] opts the optional parameters
293
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
294
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
295
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
296
+ # @return [DisbursementListResponse]
297
+ describe 'get_disbursements_by_party_id test' do
298
+ it 'should work' do
299
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
300
+ end
301
+ end
302
+
303
+ # unit tests for get_disbursements_by_status
304
+ # Returns all disbursement transactions matching given current status.
305
+ # @param current_status Current disbursement status
306
+ # @param [Hash] opts the optional parameters
307
+ # @option opts [String] :from_date From date. Format YYYY-MM-DD
308
+ # @option opts [String] :to_date To date. Format YYYY-MM-DD
309
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the disbursements. If not passed, default marketplace from app token will be used if applicable.
310
+ # @return [DisbursementListResponse]
311
+ describe 'get_disbursements_by_status test' do
312
+ it 'should work' do
313
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
314
+ end
315
+ end
316
+
317
+ # unit tests for get_disbursements_by_txn_id
318
+ # Returns the disbursement detail and status history for the given transactionId.
319
+ # @param transaction_id Primary key for a single disbursement record (assigned by YapStone)
320
+ # @param [Hash] opts the optional parameters
321
+ # @return [Disbursement]
322
+ describe 'get_disbursements_by_txn_id test' do
323
+ it 'should work' do
324
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
325
+ end
326
+ end
327
+
328
+ # unit tests for get_reimbursement
329
+ # Returns the disbursement detail and status history for the given transactionId.
330
+ # @param transaction_id Primary key for a single disbursement record (assigned by YapStone)
331
+ # @param [Hash] opts the optional parameters
332
+ # @return [Reimbursement]
333
+ describe 'get_reimbursement test' do
334
+ it 'should work' do
335
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
336
+ end
337
+ end
338
+
339
+ # unit tests for get_reimbursements_by_contract_id
340
+ # Returns all reimbursement transactions matching given contract .
341
+ # @param current_status Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
342
+ # @param contract_id
343
+ # @param [Hash] opts the optional parameters
344
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
345
+ # @return [ReimbursementListResponse]
346
+ describe 'get_reimbursements_by_contract_id test' do
347
+ it 'should work' do
348
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
349
+ end
350
+ end
351
+
352
+ # unit tests for get_reimbursements_by_correlation_id
353
+ # Returns all reimbursement transactions matching given correlation .
354
+ # @param client_correlation_id Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
355
+ # @param [Hash] opts the optional parameters
356
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
357
+ # @return [ReimbursementListResponse]
358
+ describe 'get_reimbursements_by_correlation_id test' do
359
+ it 'should work' do
360
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
361
+ end
362
+ end
363
+
364
+ # unit tests for get_reimbursements_by_correlation_id_and_status
365
+ # Returns all pool activities matching given client correlation id and status.
366
+ # @param client_correlation_id Correlation identifier assigned to one or more reimbursements by the Marketplace
367
+ # @param current_status Current reimbursement status of the pool activity
368
+ # @param [Hash] opts the optional parameters
369
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
370
+ # @return [ReimbursementListResponse]
371
+ describe 'get_reimbursements_by_correlation_id_and_status test' do
372
+ it 'should work' do
373
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
374
+ end
375
+ end
376
+
377
+ # unit tests for get_reimbursements_by_currency
378
+ # Returns all reimbursement transactions matching given currency .
379
+ # @param currency Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
380
+ # @param [Hash] opts the optional parameters
381
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
382
+ # @return [ReimbursementListResponse]
383
+ describe 'get_reimbursements_by_currency test' do
384
+ it 'should work' do
385
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
386
+ end
387
+ end
388
+
389
+ # unit tests for get_reimbursements_by_current_status
390
+ # Returns all reimbursement transactions matching given clientId .
391
+ # @param client_unique_txn_id Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
392
+ # @param [Hash] opts the optional parameters
393
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
394
+ # @return [ReimbursementListResponse]
395
+ describe 'get_reimbursements_by_current_status test' do
396
+ it 'should work' do
397
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
398
+ end
399
+ end
400
+
401
+ # unit tests for get_reimbursements_by_instrument
402
+ # Returns all reimbursement transactions matching given instrument .
403
+ # @param payee_instrument_id Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
404
+ # @param [Hash] opts the optional parameters
405
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
406
+ # @return [ReimbursementListResponse]
407
+ describe 'get_reimbursements_by_instrument test' do
408
+ it 'should work' do
409
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
410
+ end
411
+ end
412
+
413
+ # unit tests for get_reimbursements_by_order_id
414
+ # Returns all reimbursement transactions matching given order .
415
+ # @param order_id Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
416
+ # @param [Hash] opts the optional parameters
417
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
418
+ # @return [ReimbursementListResponse]
419
+ describe 'get_reimbursements_by_order_id test' do
420
+ it 'should work' do
421
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
422
+ end
423
+ end
424
+
425
+ # unit tests for get_reimbursements_by_party_id
426
+ # Returns all reimbursement transactions matching given party .
427
+ # @param payee_party_id Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
428
+ # @param [Hash] opts the optional parameters
429
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
430
+ # @return [ReimbursementListResponse]
431
+ describe 'get_reimbursements_by_party_id test' do
432
+ it 'should work' do
433
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
434
+ end
435
+ end
436
+
437
+ # unit tests for get_reimbursements_by_status
438
+ # Returns all reimbursement transactions matching given status .
439
+ # @param current_status Group identifer for a set of reimbursements created via a single API request (assigned by YapStone)
440
+ # @param [Hash] opts the optional parameters
441
+ # @option opts [String] :marketplace Optional Marketplace Id to filter the reimbursements. If not passed, default marketplace from app token will be used if applicable.
442
+ # @return [ReimbursementListResponse]
443
+ describe 'get_reimbursements_by_status test' do
444
+ it 'should work' do
445
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
446
+ end
447
+ end
448
+
449
+ # unit tests for reverse_disbursement
450
+ # 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.
451
+ # @param transaction_id Primary key for a single disbursement record (assigned by YapStone)
452
+ # @param reverse_disbursement_request
453
+ # @param [Hash] opts the optional parameters
454
+ # @return [nil]
455
+ describe 'reverse_disbursement test' do
456
+ it 'should work' do
457
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
458
+ end
459
+ end
460
+
461
+ # unit tests for reverse_reimbursement
462
+ # 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.
463
+ # @param transaction_id Primary key for a single reimbursement record (assigned by YapStone)
464
+ # @param reverse_reimbursement_request
465
+ # @param [Hash] opts the optional parameters
466
+ # @return [nil]
467
+ describe 'reverse_reimbursement test' do
468
+ it 'should work' do
469
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
470
+ end
471
+ end
472
+
473
+ # unit tests for submit_disbursements_for_payees
474
+ # 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.
475
+ # @param disbursement_request 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.
476
+ # @param [Hash] opts the optional parameters
477
+ # @return [nil]
478
+ describe 'submit_disbursements_for_payees test' do
479
+ it 'should work' do
480
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
481
+ end
482
+ end
483
+
484
+ # unit tests for submit_reimbursements
485
+ # @param reimbursement_request
486
+ # @param [Hash] opts the optional parameters
487
+ # @return [nil]
488
+ describe 'submit_reimbursements test' do
489
+ it 'should work' do
490
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
491
+ end
492
+ end
493
+
494
+ # unit tests for update_deposit
495
+ # 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).
496
+ # @param deposit_id Primary key for a single deposit record (assigned by YapStone)
497
+ # @param deposit_detail
498
+ # @param [Hash] opts the optional parameters
499
+ # @return [nil]
500
+ describe 'update_deposit test' do
501
+ it 'should work' do
502
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
503
+ end
504
+ end
505
+
506
+ end