packageruby 1.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (918) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +28 -0
  3. data/README.md +95 -0
  4. data/lib/form3_public_api/api_helper.rb +10 -0
  5. data/lib/form3_public_api/client.rb +209 -0
  6. data/lib/form3_public_api/configuration.rb +103 -0
  7. data/lib/form3_public_api/controllers/account_identification_controller.rb +156 -0
  8. data/lib/form3_public_api/controllers/account_validation_controller.rb +58 -0
  9. data/lib/form3_public_api/controllers/accounts_controller.rb +169 -0
  10. data/lib/form3_public_api/controllers/ace_controller.rb +113 -0
  11. data/lib/form3_public_api/controllers/audit_controller.rb +70 -0
  12. data/lib/form3_public_api/controllers/base_controller.rb +66 -0
  13. data/lib/form3_public_api/controllers/branch_identification_controller.rb +156 -0
  14. data/lib/form3_public_api/controllers/branches_controller.rb +138 -0
  15. data/lib/form3_public_api/controllers/claims_controller.rb +299 -0
  16. data/lib/form3_public_api/controllers/direct_debits_controller.rb +865 -0
  17. data/lib/form3_public_api/controllers/mandates_controller.rb +372 -0
  18. data/lib/form3_public_api/controllers/metrics_api_controller.rb +193 -0
  19. data/lib/form3_public_api/controllers/name_verification_api_controller.rb +252 -0
  20. data/lib/form3_public_api/controllers/o_auth_authorization_controller.rb +42 -0
  21. data/lib/form3_public_api/controllers/oauth2_controller.rb +29 -0
  22. data/lib/form3_public_api/controllers/organisations_controller.rb +108 -0
  23. data/lib/form3_public_api/controllers/payments_controller.rb +1255 -0
  24. data/lib/form3_public_api/controllers/platformsecurityapi_controller.rb +69 -0
  25. data/lib/form3_public_api/controllers/query_api_controller.rb +402 -0
  26. data/lib/form3_public_api/controllers/reports_controller.rb +139 -0
  27. data/lib/form3_public_api/controllers/roles_controller.rb +100 -0
  28. data/lib/form3_public_api/controllers/scheme_file_api_controller.rb +357 -0
  29. data/lib/form3_public_api/controllers/scheme_messages_controller.rb +123 -0
  30. data/lib/form3_public_api/controllers/subscriptions_controller.rb +150 -0
  31. data/lib/form3_public_api/controllers/transaction_file_api_controller.rb +374 -0
  32. data/lib/form3_public_api/controllers/users_controller.rb +290 -0
  33. data/lib/form3_public_api/exceptions/api_error_exception.rb +37 -0
  34. data/lib/form3_public_api/exceptions/api_exception.rb +10 -0
  35. data/lib/form3_public_api/exceptions/metrics_query_response_error_exception.rb +52 -0
  36. data/lib/form3_public_api/exceptions/o_auth_provider_exception.rb +48 -0
  37. data/lib/form3_public_api/http/auth/basic.rb +50 -0
  38. data/lib/form3_public_api/http/auth/o_auth2.rb +89 -0
  39. data/lib/form3_public_api/http/http_call_back.rb +10 -0
  40. data/lib/form3_public_api/http/http_method_enum.rb +10 -0
  41. data/lib/form3_public_api/http/http_request.rb +10 -0
  42. data/lib/form3_public_api/http/http_response.rb +10 -0
  43. data/lib/form3_public_api/models/acceptance_qualifier_enum.rb +35 -0
  44. data/lib/form3_public_api/models/account.rb +99 -0
  45. data/lib/form3_public_api/models/account_amendment.rb +50 -0
  46. data/lib/form3_public_api/models/account_attributes.rb +404 -0
  47. data/lib/form3_public_api/models/account_attributes_organisation_identification.rb +157 -0
  48. data/lib/form3_public_api/models/account_attributes_organisation_identification_actor.rb +81 -0
  49. data/lib/form3_public_api/models/account_attributes_private_identification.rb +137 -0
  50. data/lib/form3_public_api/models/account_classification1_enum.rb +23 -0
  51. data/lib/form3_public_api/models/account_classification_enum.rb +23 -0
  52. data/lib/form3_public_api/models/account_creation.rb +48 -0
  53. data/lib/form3_public_api/models/account_creation_response.rb +60 -0
  54. data/lib/form3_public_api/models/account_details_list_response.rb +69 -0
  55. data/lib/form3_public_api/models/account_details_response.rb +60 -0
  56. data/lib/form3_public_api/models/account_event.rb +97 -0
  57. data/lib/form3_public_api/models/account_event_attributes.rb +104 -0
  58. data/lib/form3_public_api/models/account_event_details_response.rb +60 -0
  59. data/lib/form3_public_api/models/account_event_list_response.rb +69 -0
  60. data/lib/form3_public_api/models/account_event_relationships.rb +50 -0
  61. data/lib/form3_public_api/models/account_holding_entity.rb +107 -0
  62. data/lib/form3_public_api/models/account_identification.rb +126 -0
  63. data/lib/form3_public_api/models/account_identification_attributes.rb +50 -0
  64. data/lib/form3_public_api/models/account_identification_data.rb +137 -0
  65. data/lib/form3_public_api/models/account_identification_event_data.rb +137 -0
  66. data/lib/form3_public_api/models/account_identification_event_relationships.rb +50 -0
  67. data/lib/form3_public_api/models/account_identification_event_response.rb +50 -0
  68. data/lib/form3_public_api/models/account_identification_list_response.rb +69 -0
  69. data/lib/form3_public_api/models/account_identification_relationships.rb +50 -0
  70. data/lib/form3_public_api/models/account_identification_request.rb +48 -0
  71. data/lib/form3_public_api/models/account_identification_response.rb +50 -0
  72. data/lib/form3_public_api/models/account_number.rb +70 -0
  73. data/lib/form3_public_api/models/account_number_code_enum.rb +23 -0
  74. data/lib/form3_public_api/models/account_number_details_response.rb +60 -0
  75. data/lib/form3_public_api/models/account_relationships.rb +62 -0
  76. data/lib/form3_public_api/models/account_switching_enum.rb +26 -0
  77. data/lib/form3_public_api/models/account_update.rb +98 -0
  78. data/lib/form3_public_api/models/account_with.rb +72 -0
  79. data/lib/form3_public_api/models/account_with_bank_id.rb +60 -0
  80. data/lib/form3_public_api/models/ace.rb +88 -0
  81. data/lib/form3_public_api/models/ace_creation.rb +48 -0
  82. data/lib/form3_public_api/models/ace_creation_response.rb +59 -0
  83. data/lib/form3_public_api/models/ace_details_list_response.rb +68 -0
  84. data/lib/form3_public_api/models/ace_details_response.rb +59 -0
  85. data/lib/form3_public_api/models/advice_creation.rb +50 -0
  86. data/lib/form3_public_api/models/advice_creation_response.rb +60 -0
  87. data/lib/form3_public_api/models/advice_details_response.rb +60 -0
  88. data/lib/form3_public_api/models/advice_submission.rb +137 -0
  89. data/lib/form3_public_api/models/advice_submission_creation.rb +50 -0
  90. data/lib/form3_public_api/models/advice_submission_creation_response.rb +60 -0
  91. data/lib/form3_public_api/models/advice_submission_details_response.rb +60 -0
  92. data/lib/form3_public_api/models/advice_submission_relationships.rb +60 -0
  93. data/lib/form3_public_api/models/advice_submission_status_enum.rb +41 -0
  94. data/lib/form3_public_api/models/agent.rb +103 -0
  95. data/lib/form3_public_api/models/agent_role_enum.rb +43 -0
  96. data/lib/form3_public_api/models/answer_enum.rb +20 -0
  97. data/lib/form3_public_api/models/attributes.rb +406 -0
  98. data/lib/form3_public_api/models/attributes1.rb +82 -0
  99. data/lib/form3_public_api/models/attributes10.rb +60 -0
  100. data/lib/form3_public_api/models/attributes11.rb +249 -0
  101. data/lib/form3_public_api/models/attributes12.rb +90 -0
  102. data/lib/form3_public_api/models/attributes13.rb +59 -0
  103. data/lib/form3_public_api/models/attributes14.rb +88 -0
  104. data/lib/form3_public_api/models/attributes15.rb +80 -0
  105. data/lib/form3_public_api/models/attributes16.rb +262 -0
  106. data/lib/form3_public_api/models/attributes17.rb +80 -0
  107. data/lib/form3_public_api/models/attributes18.rb +121 -0
  108. data/lib/form3_public_api/models/attributes19.rb +93 -0
  109. data/lib/form3_public_api/models/attributes2.rb +80 -0
  110. data/lib/form3_public_api/models/attributes20.rb +49 -0
  111. data/lib/form3_public_api/models/attributes21.rb +79 -0
  112. data/lib/form3_public_api/models/attributes22.rb +90 -0
  113. data/lib/form3_public_api/models/attributes23.rb +358 -0
  114. data/lib/form3_public_api/models/attributes24.rb +105 -0
  115. data/lib/form3_public_api/models/attributes25.rb +72 -0
  116. data/lib/form3_public_api/models/attributes26.rb +90 -0
  117. data/lib/form3_public_api/models/attributes27.rb +101 -0
  118. data/lib/form3_public_api/models/attributes29.rb +91 -0
  119. data/lib/form3_public_api/models/attributes3.rb +61 -0
  120. data/lib/form3_public_api/models/attributes30.rb +101 -0
  121. data/lib/form3_public_api/models/attributes31.rb +155 -0
  122. data/lib/form3_public_api/models/attributes32.rb +117 -0
  123. data/lib/form3_public_api/models/attributes33.rb +60 -0
  124. data/lib/form3_public_api/models/attributes34.rb +147 -0
  125. data/lib/form3_public_api/models/attributes35.rb +110 -0
  126. data/lib/form3_public_api/models/attributes36.rb +87 -0
  127. data/lib/form3_public_api/models/attributes37.rb +137 -0
  128. data/lib/form3_public_api/models/attributes38.rb +150 -0
  129. data/lib/form3_public_api/models/attributes39.rb +99 -0
  130. data/lib/form3_public_api/models/attributes4.rb +100 -0
  131. data/lib/form3_public_api/models/attributes40.rb +98 -0
  132. data/lib/form3_public_api/models/attributes41.rb +98 -0
  133. data/lib/form3_public_api/models/attributes42.rb +122 -0
  134. data/lib/form3_public_api/models/attributes43.rb +101 -0
  135. data/lib/form3_public_api/models/attributes44.rb +120 -0
  136. data/lib/form3_public_api/models/attributes45.rb +105 -0
  137. data/lib/form3_public_api/models/attributes46.rb +60 -0
  138. data/lib/form3_public_api/models/attributes47.rb +100 -0
  139. data/lib/form3_public_api/models/attributes48.rb +144 -0
  140. data/lib/form3_public_api/models/attributes49.rb +122 -0
  141. data/lib/form3_public_api/models/attributes5.rb +154 -0
  142. data/lib/form3_public_api/models/attributes50.rb +50 -0
  143. data/lib/form3_public_api/models/attributes51.rb +63 -0
  144. data/lib/form3_public_api/models/attributes52.rb +111 -0
  145. data/lib/form3_public_api/models/attributes53.rb +60 -0
  146. data/lib/form3_public_api/models/attributes54.rb +60 -0
  147. data/lib/form3_public_api/models/attributes55.rb +70 -0
  148. data/lib/form3_public_api/models/attributes56.rb +91 -0
  149. data/lib/form3_public_api/models/attributes57.rb +135 -0
  150. data/lib/form3_public_api/models/attributes58.rb +91 -0
  151. data/lib/form3_public_api/models/attributes59.rb +61 -0
  152. data/lib/form3_public_api/models/attributes6.rb +60 -0
  153. data/lib/form3_public_api/models/attributes60.rb +92 -0
  154. data/lib/form3_public_api/models/attributes61.rb +73 -0
  155. data/lib/form3_public_api/models/attributes63.rb +67 -0
  156. data/lib/form3_public_api/models/attributes64.rb +60 -0
  157. data/lib/form3_public_api/models/attributes65.rb +145 -0
  158. data/lib/form3_public_api/models/attributes68.rb +129 -0
  159. data/lib/form3_public_api/models/attributes69.rb +80 -0
  160. data/lib/form3_public_api/models/attributes7.rb +90 -0
  161. data/lib/form3_public_api/models/attributes70.rb +92 -0
  162. data/lib/form3_public_api/models/attributes8.rb +74 -0
  163. data/lib/form3_public_api/models/attributes9.rb +152 -0
  164. data/lib/form3_public_api/models/audit_entry.rb +91 -0
  165. data/lib/form3_public_api/models/audit_entry_list_response.rb +69 -0
  166. data/lib/form3_public_api/models/bacs.rb +83 -0
  167. data/lib/form3_public_api/models/bank_id_code1_enum.rb +20 -0
  168. data/lib/form3_public_api/models/bank_id_code_enum.rb +50 -0
  169. data/lib/form3_public_api/models/base_model.rb +62 -0
  170. data/lib/form3_public_api/models/beneficiary.rb +59 -0
  171. data/lib/form3_public_api/models/beneficiary_account.rb +59 -0
  172. data/lib/form3_public_api/models/beneficiary_debtor_account_holding_entity.rb +111 -0
  173. data/lib/form3_public_api/models/beneficiary_debtor_account_proxy.rb +73 -0
  174. data/lib/form3_public_api/models/beneficiary_debtor_organisation_identification.rb +84 -0
  175. data/lib/form3_public_api/models/beneficiary_party.rb +51 -0
  176. data/lib/form3_public_api/models/beneficiary_party1.rb +357 -0
  177. data/lib/form3_public_api/models/beneficiary_party2.rb +58 -0
  178. data/lib/form3_public_api/models/beneficiary_party3.rb +186 -0
  179. data/lib/form3_public_api/models/branch.rb +125 -0
  180. data/lib/form3_public_api/models/branch_amendment.rb +50 -0
  181. data/lib/form3_public_api/models/branch_attributes.rb +110 -0
  182. data/lib/form3_public_api/models/branch_creation.rb +48 -0
  183. data/lib/form3_public_api/models/branch_creation_response.rb +60 -0
  184. data/lib/form3_public_api/models/branch_details_list_response.rb +69 -0
  185. data/lib/form3_public_api/models/branch_details_response.rb +60 -0
  186. data/lib/form3_public_api/models/branch_identification.rb +126 -0
  187. data/lib/form3_public_api/models/branch_identification_attributes.rb +50 -0
  188. data/lib/form3_public_api/models/branch_identification_data.rb +137 -0
  189. data/lib/form3_public_api/models/branch_identification_event_data.rb +137 -0
  190. data/lib/form3_public_api/models/branch_identification_event_relationships.rb +50 -0
  191. data/lib/form3_public_api/models/branch_identification_event_response.rb +50 -0
  192. data/lib/form3_public_api/models/branch_identification_list_response.rb +69 -0
  193. data/lib/form3_public_api/models/branch_identification_relationships.rb +50 -0
  194. data/lib/form3_public_api/models/branch_identification_request.rb +48 -0
  195. data/lib/form3_public_api/models/branch_identification_response.rb +50 -0
  196. data/lib/form3_public_api/models/branch_update.rb +87 -0
  197. data/lib/form3_public_api/models/branch_validation_type_enum.rb +29 -0
  198. data/lib/form3_public_api/models/callback_transport_enum.rb +29 -0
  199. data/lib/form3_public_api/models/callback_uri.rb +58 -0
  200. data/lib/form3_public_api/models/ccc.rb +61 -0
  201. data/lib/form3_public_api/models/chaps.rb +61 -0
  202. data/lib/form3_public_api/models/charges_amount.rb +60 -0
  203. data/lib/form3_public_api/models/charges_information.rb +99 -0
  204. data/lib/form3_public_api/models/claim.rb +135 -0
  205. data/lib/form3_public_api/models/claim1.rb +59 -0
  206. data/lib/form3_public_api/models/claim_attributes.rb +165 -0
  207. data/lib/form3_public_api/models/claim_creation.rb +50 -0
  208. data/lib/form3_public_api/models/claim_details_list_response.rb +69 -0
  209. data/lib/form3_public_api/models/claim_details_response.rb +60 -0
  210. data/lib/form3_public_api/models/claim_relationships.rb +61 -0
  211. data/lib/form3_public_api/models/claim_resource_type_enum.rb +36 -0
  212. data/lib/form3_public_api/models/claim_reversal.rb +136 -0
  213. data/lib/form3_public_api/models/claim_reversal2.rb +59 -0
  214. data/lib/form3_public_api/models/claim_reversal_creation.rb +48 -0
  215. data/lib/form3_public_api/models/claim_reversal_details_response.rb +60 -0
  216. data/lib/form3_public_api/models/claim_reversal_relationships.rb +65 -0
  217. data/lib/form3_public_api/models/claim_reversal_submission.rb +137 -0
  218. data/lib/form3_public_api/models/claim_reversal_submission2.rb +59 -0
  219. data/lib/form3_public_api/models/claim_reversal_submission_creation.rb +48 -0
  220. data/lib/form3_public_api/models/claim_reversal_submission_details_response.rb +60 -0
  221. data/lib/form3_public_api/models/claim_reversal_submission_relationships.rb +60 -0
  222. data/lib/form3_public_api/models/claim_submission.rb +137 -0
  223. data/lib/form3_public_api/models/claim_submission2.rb +59 -0
  224. data/lib/form3_public_api/models/claim_submission_creation.rb +48 -0
  225. data/lib/form3_public_api/models/claim_submission_details_response.rb +60 -0
  226. data/lib/form3_public_api/models/claim_submission_relationships.rb +50 -0
  227. data/lib/form3_public_api/models/claim_submission_status_enum.rb +41 -0
  228. data/lib/form3_public_api/models/clearing_channel_enum.rb +26 -0
  229. data/lib/form3_public_api/models/correction_transaction_information.rb +144 -0
  230. data/lib/form3_public_api/models/credential.rb +50 -0
  231. data/lib/form3_public_api/models/credential_creation_response.rb +59 -0
  232. data/lib/form3_public_api/models/credential_secret.rb +60 -0
  233. data/lib/form3_public_api/models/currency_and_amount.rb +60 -0
  234. data/lib/form3_public_api/models/data.rb +128 -0
  235. data/lib/form3_public_api/models/data1.rb +50 -0
  236. data/lib/form3_public_api/models/data2.rb +60 -0
  237. data/lib/form3_public_api/models/debtor.rb +59 -0
  238. data/lib/form3_public_api/models/debtor_account.rb +59 -0
  239. data/lib/form3_public_api/models/debtor_party.rb +352 -0
  240. data/lib/form3_public_api/models/debtor_party1.rb +67 -0
  241. data/lib/form3_public_api/models/debtor_party2.rb +256 -0
  242. data/lib/form3_public_api/models/debtor_party3.rb +51 -0
  243. data/lib/form3_public_api/models/description_enum.rb +26 -0
  244. data/lib/form3_public_api/models/direct_debit.rb +136 -0
  245. data/lib/form3_public_api/models/direct_debit1.rb +59 -0
  246. data/lib/form3_public_api/models/direct_debit_admission.rb +136 -0
  247. data/lib/form3_public_api/models/direct_debit_admission2.rb +59 -0
  248. data/lib/form3_public_api/models/direct_debit_admission_details_response.rb +60 -0
  249. data/lib/form3_public_api/models/direct_debit_admission_relationships.rb +50 -0
  250. data/lib/form3_public_api/models/direct_debit_admission_status_enum.rb +32 -0
  251. data/lib/form3_public_api/models/direct_debit_admission_status_reason_enum.rb +150 -0
  252. data/lib/form3_public_api/models/direct_debit_creation.rb +50 -0
  253. data/lib/form3_public_api/models/direct_debit_creation_response.rb +60 -0
  254. data/lib/form3_public_api/models/direct_debit_decision.rb +135 -0
  255. data/lib/form3_public_api/models/direct_debit_decision2.rb +59 -0
  256. data/lib/form3_public_api/models/direct_debit_decision_admission.rb +136 -0
  257. data/lib/form3_public_api/models/direct_debit_decision_admission2.rb +59 -0
  258. data/lib/form3_public_api/models/direct_debit_decision_admission_creation.rb +50 -0
  259. data/lib/form3_public_api/models/direct_debit_decision_admission_creation_response.rb +60 -0
  260. data/lib/form3_public_api/models/direct_debit_decision_admission_details_response.rb +60 -0
  261. data/lib/form3_public_api/models/direct_debit_decision_admission_relationships.rb +61 -0
  262. data/lib/form3_public_api/models/direct_debit_decision_admission_status_enum.rb +26 -0
  263. data/lib/form3_public_api/models/direct_debit_decision_admission_status_reason_enum.rb +32 -0
  264. data/lib/form3_public_api/models/direct_debit_decision_creation.rb +50 -0
  265. data/lib/form3_public_api/models/direct_debit_decision_creation_response.rb +60 -0
  266. data/lib/form3_public_api/models/direct_debit_decision_details_response.rb +60 -0
  267. data/lib/form3_public_api/models/direct_debit_decision_submission.rb +137 -0
  268. data/lib/form3_public_api/models/direct_debit_decision_submission2.rb +59 -0
  269. data/lib/form3_public_api/models/direct_debit_decision_submission_creation.rb +50 -0
  270. data/lib/form3_public_api/models/direct_debit_decision_submission_creation_response.rb +60 -0
  271. data/lib/form3_public_api/models/direct_debit_decision_submission_details_response.rb +60 -0
  272. data/lib/form3_public_api/models/direct_debit_decision_submission_status_enum.rb +41 -0
  273. data/lib/form3_public_api/models/direct_debit_details_list_response.rb +69 -0
  274. data/lib/form3_public_api/models/direct_debit_details_response.rb +60 -0
  275. data/lib/form3_public_api/models/direct_debit_mandate.rb +60 -0
  276. data/lib/form3_public_api/models/direct_debit_recall.rb +137 -0
  277. data/lib/form3_public_api/models/direct_debit_recall2.rb +59 -0
  278. data/lib/form3_public_api/models/direct_debit_recall_admission.rb +137 -0
  279. data/lib/form3_public_api/models/direct_debit_recall_admission2.rb +59 -0
  280. data/lib/form3_public_api/models/direct_debit_recall_admission_details_response.rb +60 -0
  281. data/lib/form3_public_api/models/direct_debit_recall_admission_status_enum.rb +24 -0
  282. data/lib/form3_public_api/models/direct_debit_recall_creation.rb +50 -0
  283. data/lib/form3_public_api/models/direct_debit_recall_creation_response.rb +60 -0
  284. data/lib/form3_public_api/models/direct_debit_recall_details_response.rb +60 -0
  285. data/lib/form3_public_api/models/direct_debit_recall_submission.rb +136 -0
  286. data/lib/form3_public_api/models/direct_debit_recall_submission2.rb +59 -0
  287. data/lib/form3_public_api/models/direct_debit_recall_submission_details_response.rb +60 -0
  288. data/lib/form3_public_api/models/direct_debit_recall_submission_status_enum.rb +44 -0
  289. data/lib/form3_public_api/models/direct_debit_relationships.rb +116 -0
  290. data/lib/form3_public_api/models/direct_debit_resource_type_enum.rb +102 -0
  291. data/lib/form3_public_api/models/direct_debit_return.rb +135 -0
  292. data/lib/form3_public_api/models/direct_debit_return2.rb +59 -0
  293. data/lib/form3_public_api/models/direct_debit_return_admission.rb +136 -0
  294. data/lib/form3_public_api/models/direct_debit_return_admission2.rb +59 -0
  295. data/lib/form3_public_api/models/direct_debit_return_admission_details_response.rb +60 -0
  296. data/lib/form3_public_api/models/direct_debit_return_admission_relationships.rb +61 -0
  297. data/lib/form3_public_api/models/direct_debit_return_admission_status_enum.rb +32 -0
  298. data/lib/form3_public_api/models/direct_debit_return_creation.rb +50 -0
  299. data/lib/form3_public_api/models/direct_debit_return_creation_response.rb +60 -0
  300. data/lib/form3_public_api/models/direct_debit_return_details_response.rb +60 -0
  301. data/lib/form3_public_api/models/direct_debit_return_reversal.rb +136 -0
  302. data/lib/form3_public_api/models/direct_debit_return_reversal2.rb +59 -0
  303. data/lib/form3_public_api/models/direct_debit_return_reversal_admission.rb +135 -0
  304. data/lib/form3_public_api/models/direct_debit_return_reversal_admission2.rb +59 -0
  305. data/lib/form3_public_api/models/direct_debit_return_reversal_admission_creation.rb +50 -0
  306. data/lib/form3_public_api/models/direct_debit_return_reversal_admission_creation_response.rb +50 -0
  307. data/lib/form3_public_api/models/direct_debit_return_reversal_admission_details_response.rb +60 -0
  308. data/lib/form3_public_api/models/direct_debit_return_reversal_creation.rb +50 -0
  309. data/lib/form3_public_api/models/direct_debit_return_reversal_creation_response.rb +50 -0
  310. data/lib/form3_public_api/models/direct_debit_return_reversal_details_response.rb +60 -0
  311. data/lib/form3_public_api/models/direct_debit_return_submission.rb +137 -0
  312. data/lib/form3_public_api/models/direct_debit_return_submission2.rb +59 -0
  313. data/lib/form3_public_api/models/direct_debit_return_submission_creation.rb +50 -0
  314. data/lib/form3_public_api/models/direct_debit_return_submission_creation_response.rb +60 -0
  315. data/lib/form3_public_api/models/direct_debit_return_submission_details_response.rb +60 -0
  316. data/lib/form3_public_api/models/direct_debit_return_submission_status_enum.rb +41 -0
  317. data/lib/form3_public_api/models/direct_debit_reversal.rb +136 -0
  318. data/lib/form3_public_api/models/direct_debit_reversal2.rb +59 -0
  319. data/lib/form3_public_api/models/direct_debit_reversal_admission.rb +135 -0
  320. data/lib/form3_public_api/models/direct_debit_reversal_admission2.rb +59 -0
  321. data/lib/form3_public_api/models/direct_debit_reversal_admission_details_response.rb +60 -0
  322. data/lib/form3_public_api/models/direct_debit_reversal_admission_status_enum.rb +23 -0
  323. data/lib/form3_public_api/models/direct_debit_reversal_creation.rb +50 -0
  324. data/lib/form3_public_api/models/direct_debit_reversal_creation_response.rb +60 -0
  325. data/lib/form3_public_api/models/direct_debit_reversal_details_response.rb +60 -0
  326. data/lib/form3_public_api/models/direct_debit_reversal_submission.rb +136 -0
  327. data/lib/form3_public_api/models/direct_debit_reversal_submission2.rb +59 -0
  328. data/lib/form3_public_api/models/direct_debit_reversal_submission_creation.rb +50 -0
  329. data/lib/form3_public_api/models/direct_debit_reversal_submission_creation_response.rb +60 -0
  330. data/lib/form3_public_api/models/direct_debit_reversal_submission_details_response.rb +60 -0
  331. data/lib/form3_public_api/models/direct_debit_reversal_submission_status_enum.rb +50 -0
  332. data/lib/form3_public_api/models/direct_debit_submission.rb +137 -0
  333. data/lib/form3_public_api/models/direct_debit_submission2.rb +59 -0
  334. data/lib/form3_public_api/models/direct_debit_submission_creation.rb +50 -0
  335. data/lib/form3_public_api/models/direct_debit_submission_creation_response.rb +60 -0
  336. data/lib/form3_public_api/models/direct_debit_submission_details_response.rb +60 -0
  337. data/lib/form3_public_api/models/direct_debit_submission_relationships.rb +50 -0
  338. data/lib/form3_public_api/models/direct_debit_submission_status_enum.rb +44 -0
  339. data/lib/form3_public_api/models/direct_debit_with_return.rb +61 -0
  340. data/lib/form3_public_api/models/disputed_transaction.rb +57 -0
  341. data/lib/form3_public_api/models/duplicate_transaction_information.rb +86 -0
  342. data/lib/form3_public_api/models/file_format_enum.rb +23 -0
  343. data/lib/form3_public_api/models/file_type_enum.rb +23 -0
  344. data/lib/form3_public_api/models/filter_not_relationships1_enum.rb +35 -0
  345. data/lib/form3_public_api/models/filter_not_relationships_enum.rb +35 -0
  346. data/lib/form3_public_api/models/filter_relationships1_enum.rb +35 -0
  347. data/lib/form3_public_api/models/filter_relationships_enum.rb +35 -0
  348. data/lib/form3_public_api/models/forwarded_payment.rb +60 -0
  349. data/lib/form3_public_api/models/forwarding_payment.rb +59 -0
  350. data/lib/form3_public_api/models/forwarding_payment1.rb +59 -0
  351. data/lib/form3_public_api/models/fps.rb +83 -0
  352. data/lib/form3_public_api/models/fx.rb +88 -0
  353. data/lib/form3_public_api/models/fx_deal.rb +59 -0
  354. data/lib/form3_public_api/models/header.rb +107 -0
  355. data/lib/form3_public_api/models/identification.rb +80 -0
  356. data/lib/form3_public_api/models/identification1.rb +79 -0
  357. data/lib/form3_public_api/models/intermediary_bank_account_holding_entity.rb +92 -0
  358. data/lib/form3_public_api/models/links.rb +89 -0
  359. data/lib/form3_public_api/models/list_scheme_files_response.rb +68 -0
  360. data/lib/form3_public_api/models/list_transaction_files_response.rb +68 -0
  361. data/lib/form3_public_api/models/mandate.rb +137 -0
  362. data/lib/form3_public_api/models/mandate2.rb +59 -0
  363. data/lib/form3_public_api/models/mandate6.rb +59 -0
  364. data/lib/form3_public_api/models/mandate_admission.rb +139 -0
  365. data/lib/form3_public_api/models/mandate_admission2.rb +59 -0
  366. data/lib/form3_public_api/models/mandate_admission_details_response.rb +60 -0
  367. data/lib/form3_public_api/models/mandate_admission_relationships.rb +50 -0
  368. data/lib/form3_public_api/models/mandate_admission_status_enum.rb +23 -0
  369. data/lib/form3_public_api/models/mandate_admission_status_reason_enum.rb +51 -0
  370. data/lib/form3_public_api/models/mandate_amendment.rb +50 -0
  371. data/lib/form3_public_api/models/mandate_attributes.rb +208 -0
  372. data/lib/form3_public_api/models/mandate_attributes_beneficiary_party.rb +123 -0
  373. data/lib/form3_public_api/models/mandate_attributes_debtor_party.rb +102 -0
  374. data/lib/form3_public_api/models/mandate_creation.rb +50 -0
  375. data/lib/form3_public_api/models/mandate_creation_response.rb +60 -0
  376. data/lib/form3_public_api/models/mandate_details_list_response.rb +69 -0
  377. data/lib/form3_public_api/models/mandate_details_response.rb +60 -0
  378. data/lib/form3_public_api/models/mandate_frequency_enum.rb +38 -0
  379. data/lib/form3_public_api/models/mandate_relationships.rb +83 -0
  380. data/lib/form3_public_api/models/mandate_resource_type_enum.rb +48 -0
  381. data/lib/form3_public_api/models/mandate_return.rb +138 -0
  382. data/lib/form3_public_api/models/mandate_return2.rb +59 -0
  383. data/lib/form3_public_api/models/mandate_return_creation.rb +50 -0
  384. data/lib/form3_public_api/models/mandate_return_creation_response.rb +60 -0
  385. data/lib/form3_public_api/models/mandate_return_details_response.rb +60 -0
  386. data/lib/form3_public_api/models/mandate_return_submission.rb +138 -0
  387. data/lib/form3_public_api/models/mandate_return_submission2.rb +59 -0
  388. data/lib/form3_public_api/models/mandate_return_submission_creation.rb +50 -0
  389. data/lib/form3_public_api/models/mandate_return_submission_creation_response.rb +60 -0
  390. data/lib/form3_public_api/models/mandate_return_submission_details_response.rb +60 -0
  391. data/lib/form3_public_api/models/mandate_return_submission_status_enum.rb +41 -0
  392. data/lib/form3_public_api/models/mandate_status_enum.rb +29 -0
  393. data/lib/form3_public_api/models/mandate_submission.rb +139 -0
  394. data/lib/form3_public_api/models/mandate_submission2.rb +59 -0
  395. data/lib/form3_public_api/models/mandate_submission_creation.rb +50 -0
  396. data/lib/form3_public_api/models/mandate_submission_details_response.rb +60 -0
  397. data/lib/form3_public_api/models/mandate_submission_relationships.rb +50 -0
  398. data/lib/form3_public_api/models/mandate_submission_status_enum.rb +41 -0
  399. data/lib/form3_public_api/models/meta.rb +50 -0
  400. data/lib/form3_public_api/models/method_enum.rb +31 -0
  401. data/lib/form3_public_api/models/metrics_query_response.rb +90 -0
  402. data/lib/form3_public_api/models/most_recent_collection.rb +60 -0
  403. data/lib/form3_public_api/models/most_recent_collection2.rb +50 -0
  404. data/lib/form3_public_api/models/mself.rb +50 -0
  405. data/lib/form3_public_api/models/name_matching_status_enum.rb +31 -0
  406. data/lib/form3_public_api/models/name_verification.rb +136 -0
  407. data/lib/form3_public_api/models/name_verification1.rb +59 -0
  408. data/lib/form3_public_api/models/name_verification_admission.rb +137 -0
  409. data/lib/form3_public_api/models/name_verification_admission2.rb +59 -0
  410. data/lib/form3_public_api/models/name_verification_admission_answer_enum.rb +23 -0
  411. data/lib/form3_public_api/models/name_verification_admission_attributes.rb +99 -0
  412. data/lib/form3_public_api/models/name_verification_admission_details_response.rb +50 -0
  413. data/lib/form3_public_api/models/name_verification_admission_reason_code_enum.rb +53 -0
  414. data/lib/form3_public_api/models/name_verification_admission_relationships.rb +51 -0
  415. data/lib/form3_public_api/models/name_verification_admission_status_enum.rb +23 -0
  416. data/lib/form3_public_api/models/name_verification_attributes.rb +107 -0
  417. data/lib/form3_public_api/models/name_verification_creation.rb +48 -0
  418. data/lib/form3_public_api/models/name_verification_creation_response.rb +50 -0
  419. data/lib/form3_public_api/models/name_verification_details_list_response.rb +69 -0
  420. data/lib/form3_public_api/models/name_verification_details_response.rb +50 -0
  421. data/lib/form3_public_api/models/name_verification_relationships.rb +70 -0
  422. data/lib/form3_public_api/models/name_verification_submission.rb +138 -0
  423. data/lib/form3_public_api/models/name_verification_submission2.rb +59 -0
  424. data/lib/form3_public_api/models/name_verification_submission_answer_enum.rb +23 -0
  425. data/lib/form3_public_api/models/name_verification_submission_attributes.rb +99 -0
  426. data/lib/form3_public_api/models/name_verification_submission_details_response.rb +50 -0
  427. data/lib/form3_public_api/models/name_verification_submission_reason_code_enum.rb +53 -0
  428. data/lib/form3_public_api/models/name_verification_submission_relationships.rb +51 -0
  429. data/lib/form3_public_api/models/name_verification_submission_status_enum.rb +23 -0
  430. data/lib/form3_public_api/models/new_advice_submission.rb +79 -0
  431. data/lib/form3_public_api/models/new_bank_details.rb +82 -0
  432. data/lib/form3_public_api/models/new_bank_details1.rb +72 -0
  433. data/lib/form3_public_api/models/new_payment.rb +136 -0
  434. data/lib/form3_public_api/models/new_payment_relationships.rb +165 -0
  435. data/lib/form3_public_api/models/new_payment_submission.rb +89 -0
  436. data/lib/form3_public_api/models/new_query.rb +85 -0
  437. data/lib/form3_public_api/models/new_query_relationships.rb +104 -0
  438. data/lib/form3_public_api/models/new_query_response.rb +73 -0
  439. data/lib/form3_public_api/models/new_query_response_submission.rb +75 -0
  440. data/lib/form3_public_api/models/new_query_submission.rb +64 -0
  441. data/lib/form3_public_api/models/new_recall.rb +100 -0
  442. data/lib/form3_public_api/models/new_recall_decision_submission.rb +90 -0
  443. data/lib/form3_public_api/models/new_recall_submission.rb +100 -0
  444. data/lib/form3_public_api/models/new_report_relationships.rb +50 -0
  445. data/lib/form3_public_api/models/new_report_request.rb +88 -0
  446. data/lib/form3_public_api/models/new_report_request_attributes.rb +67 -0
  447. data/lib/form3_public_api/models/new_report_request_filter.rb +78 -0
  448. data/lib/form3_public_api/models/new_report_request_report_user.rb +57 -0
  449. data/lib/form3_public_api/models/new_report_request_submission.rb +86 -0
  450. data/lib/form3_public_api/models/new_report_request_submission_attributes.rb +50 -0
  451. data/lib/form3_public_api/models/new_return_submission.rb +90 -0
  452. data/lib/form3_public_api/models/new_reversal_submission.rb +79 -0
  453. data/lib/form3_public_api/models/new_transaction_file.rb +136 -0
  454. data/lib/form3_public_api/models/notification.rb +134 -0
  455. data/lib/form3_public_api/models/o_auth_provider_error_enum.rb +45 -0
  456. data/lib/form3_public_api/models/o_auth_token.rb +100 -0
  457. data/lib/form3_public_api/models/organisation.rb +91 -0
  458. data/lib/form3_public_api/models/organisation_attributes.rb +50 -0
  459. data/lib/form3_public_api/models/organisation_creation.rb +48 -0
  460. data/lib/form3_public_api/models/organisation_creation_response.rb +59 -0
  461. data/lib/form3_public_api/models/organisation_details_list_response.rb +68 -0
  462. data/lib/form3_public_api/models/organisation_details_response.rb +59 -0
  463. data/lib/form3_public_api/models/organisation_identification.rb +73 -0
  464. data/lib/form3_public_api/models/organisation_update.rb +48 -0
  465. data/lib/form3_public_api/models/original_instruction.rb +57 -0
  466. data/lib/form3_public_api/models/payment.rb +136 -0
  467. data/lib/form3_public_api/models/payment_admission.rb +136 -0
  468. data/lib/form3_public_api/models/payment_admission2.rb +59 -0
  469. data/lib/form3_public_api/models/payment_admission_beneficiary_account.rb +70 -0
  470. data/lib/form3_public_api/models/payment_admission_details_response.rb +60 -0
  471. data/lib/form3_public_api/models/payment_admission_resource_type_enum.rb +20 -0
  472. data/lib/form3_public_api/models/payment_admission_status_enum.rb +28 -0
  473. data/lib/form3_public_api/models/payment_admission_status_reason_enum.rb +152 -0
  474. data/lib/form3_public_api/models/payment_admission_task.rb +139 -0
  475. data/lib/form3_public_api/models/payment_admission_task_amendment.rb +50 -0
  476. data/lib/form3_public_api/models/payment_admission_task_assignee_enum.rb +23 -0
  477. data/lib/form3_public_api/models/payment_admission_task_details_response.rb +60 -0
  478. data/lib/form3_public_api/models/payment_admission_task_list_response.rb +69 -0
  479. data/lib/form3_public_api/models/payment_admission_task_relationships.rb +73 -0
  480. data/lib/form3_public_api/models/payment_admission_task_status_enum.rb +29 -0
  481. data/lib/form3_public_api/models/payment_admission_task_update.rb +91 -0
  482. data/lib/form3_public_api/models/payment_admission_update_relationships.rb +59 -0
  483. data/lib/form3_public_api/models/payment_advice.rb +136 -0
  484. data/lib/form3_public_api/models/payment_advice1.rb +59 -0
  485. data/lib/form3_public_api/models/payment_attributes.rb +571 -0
  486. data/lib/form3_public_api/models/payment_creation.rb +50 -0
  487. data/lib/form3_public_api/models/payment_creation_response.rb +60 -0
  488. data/lib/form3_public_api/models/payment_details_list_response.rb +69 -0
  489. data/lib/form3_public_api/models/payment_details_response.rb +60 -0
  490. data/lib/form3_public_api/models/payment_recall.rb +59 -0
  491. data/lib/form3_public_api/models/payment_recall_resource_type_enum.rb +20 -0
  492. data/lib/form3_public_api/models/payment_recall_submission_resource_type_enum.rb +20 -0
  493. data/lib/form3_public_api/models/payment_relationships.rb +176 -0
  494. data/lib/form3_public_api/models/payment_resource_type_enum.rb +20 -0
  495. data/lib/form3_public_api/models/payment_return.rb +59 -0
  496. data/lib/form3_public_api/models/payment_reversal.rb +59 -0
  497. data/lib/form3_public_api/models/payment_scheme2_enum.rb +23 -0
  498. data/lib/form3_public_api/models/payment_scheme_enum.rb +32 -0
  499. data/lib/form3_public_api/models/payment_submission.rb +137 -0
  500. data/lib/form3_public_api/models/payment_submission2.rb +59 -0
  501. data/lib/form3_public_api/models/payment_submission_creation.rb +50 -0
  502. data/lib/form3_public_api/models/payment_submission_creation_response.rb +60 -0
  503. data/lib/form3_public_api/models/payment_submission_details_response.rb +60 -0
  504. data/lib/form3_public_api/models/payment_submission_relationships.rb +72 -0
  505. data/lib/form3_public_api/models/payment_submission_resource_type_enum.rb +20 -0
  506. data/lib/form3_public_api/models/payment_submission_status_enum.rb +49 -0
  507. data/lib/form3_public_api/models/payment_submission_task.rb +139 -0
  508. data/lib/form3_public_api/models/payment_submission_task_amendment.rb +50 -0
  509. data/lib/form3_public_api/models/payment_submission_task_assignee_enum.rb +20 -0
  510. data/lib/form3_public_api/models/payment_submission_task_details_response.rb +60 -0
  511. data/lib/form3_public_api/models/payment_submission_task_relationships.rb +61 -0
  512. data/lib/form3_public_api/models/payment_submission_task_status_enum.rb +29 -0
  513. data/lib/form3_public_api/models/payment_submission_task_update.rb +91 -0
  514. data/lib/form3_public_api/models/payment_type_information.rb +134 -0
  515. data/lib/form3_public_api/models/payment_update.rb +135 -0
  516. data/lib/form3_public_api/models/payment_update_relationships.rb +165 -0
  517. data/lib/form3_public_api/models/position.rb +98 -0
  518. data/lib/form3_public_api/models/position_details_list_response.rb +59 -0
  519. data/lib/form3_public_api/models/private_identification.rb +88 -0
  520. data/lib/form3_public_api/models/private_identification1.rb +84 -0
  521. data/lib/form3_public_api/models/prometheus_metric_data.rb +69 -0
  522. data/lib/form3_public_api/models/prometheus_result_item.rb +60 -0
  523. data/lib/form3_public_api/models/query.rb +130 -0
  524. data/lib/form3_public_api/models/query_account_number_code_enum.rb +23 -0
  525. data/lib/form3_public_api/models/query_admission.rb +131 -0
  526. data/lib/form3_public_api/models/query_admission_attributes.rb +59 -0
  527. data/lib/form3_public_api/models/query_admission_relationships.rb +48 -0
  528. data/lib/form3_public_api/models/query_admission_resource_type_enum.rb +20 -0
  529. data/lib/form3_public_api/models/query_admission_response.rb +59 -0
  530. data/lib/form3_public_api/models/query_admission_status_enum.rb +23 -0
  531. data/lib/form3_public_api/models/query_attributes.rb +191 -0
  532. data/lib/form3_public_api/models/query_beneficiary_debtor_account_proxy.rb +73 -0
  533. data/lib/form3_public_api/models/query_beneficiary_debtor_organisation_identification.rb +84 -0
  534. data/lib/form3_public_api/models/query_beneficiary_debtor_party.rb +313 -0
  535. data/lib/form3_public_api/models/query_creation.rb +48 -0
  536. data/lib/form3_public_api/models/query_fetch_response.rb +59 -0
  537. data/lib/form3_public_api/models/query_list_response.rb +66 -0
  538. data/lib/form3_public_api/models/query_private_identification.rb +88 -0
  539. data/lib/form3_public_api/models/query_reference.rb +58 -0
  540. data/lib/form3_public_api/models/query_relationships.rb +137 -0
  541. data/lib/form3_public_api/models/query_resource_type_enum.rb +20 -0
  542. data/lib/form3_public_api/models/query_response.rb +131 -0
  543. data/lib/form3_public_api/models/query_response_admission.rb +132 -0
  544. data/lib/form3_public_api/models/query_response_admission_attributes.rb +59 -0
  545. data/lib/form3_public_api/models/query_response_admission_relationships.rb +81 -0
  546. data/lib/form3_public_api/models/query_response_admission_resource_type_enum.rb +20 -0
  547. data/lib/form3_public_api/models/query_response_admission_response.rb +59 -0
  548. data/lib/form3_public_api/models/query_response_admission_status_enum.rb +26 -0
  549. data/lib/form3_public_api/models/query_response_answer_enum.rb +47 -0
  550. data/lib/form3_public_api/models/query_response_attributes.rb +111 -0
  551. data/lib/form3_public_api/models/query_response_charges.rb +82 -0
  552. data/lib/form3_public_api/models/query_response_compensation.rb +82 -0
  553. data/lib/form3_public_api/models/query_response_creation.rb +48 -0
  554. data/lib/form3_public_api/models/query_response_information.rb +154 -0
  555. data/lib/form3_public_api/models/query_response_relationships.rb +77 -0
  556. data/lib/form3_public_api/models/query_response_resource_type_enum.rb +20 -0
  557. data/lib/form3_public_api/models/query_response_response.rb +59 -0
  558. data/lib/form3_public_api/models/query_response_status_code_enum.rb +32 -0
  559. data/lib/form3_public_api/models/query_response_submission.rb +132 -0
  560. data/lib/form3_public_api/models/query_response_submission_attributes.rb +70 -0
  561. data/lib/form3_public_api/models/query_response_submission_creation.rb +48 -0
  562. data/lib/form3_public_api/models/query_response_submission_relationships.rb +61 -0
  563. data/lib/form3_public_api/models/query_response_submission_resource_type_enum.rb +20 -0
  564. data/lib/form3_public_api/models/query_response_submission_response.rb +59 -0
  565. data/lib/form3_public_api/models/query_response_submission_status_enum.rb +38 -0
  566. data/lib/form3_public_api/models/query_submission.rb +131 -0
  567. data/lib/form3_public_api/models/query_submission_attributes.rb +60 -0
  568. data/lib/form3_public_api/models/query_submission_creation.rb +48 -0
  569. data/lib/form3_public_api/models/query_submission_relationships.rb +48 -0
  570. data/lib/form3_public_api/models/query_submission_resource_type_enum.rb +20 -0
  571. data/lib/form3_public_api/models/query_submission_response.rb +59 -0
  572. data/lib/form3_public_api/models/query_submission_status_enum.rb +38 -0
  573. data/lib/form3_public_api/models/query_type_enum.rb +29 -0
  574. data/lib/form3_public_api/models/query_ultimate_entity.rb +272 -0
  575. data/lib/form3_public_api/models/recall.rb +137 -0
  576. data/lib/form3_public_api/models/recall_admission.rb +137 -0
  577. data/lib/form3_public_api/models/recall_admission_details_response.rb +60 -0
  578. data/lib/form3_public_api/models/recall_admission_relationships.rb +60 -0
  579. data/lib/form3_public_api/models/recall_admission_status_enum.rb +24 -0
  580. data/lib/form3_public_api/models/recall_creation.rb +50 -0
  581. data/lib/form3_public_api/models/recall_creation_response.rb +60 -0
  582. data/lib/form3_public_api/models/recall_decision.rb +136 -0
  583. data/lib/form3_public_api/models/recall_decision_admission.rb +137 -0
  584. data/lib/form3_public_api/models/recall_decision_admission_details_response.rb +60 -0
  585. data/lib/form3_public_api/models/recall_decision_admission_relationships.rb +71 -0
  586. data/lib/form3_public_api/models/recall_decision_admission_status_enum.rb +24 -0
  587. data/lib/form3_public_api/models/recall_decision_answer_enum.rb +26 -0
  588. data/lib/form3_public_api/models/recall_decision_creation.rb +50 -0
  589. data/lib/form3_public_api/models/recall_decision_creation_response.rb +50 -0
  590. data/lib/form3_public_api/models/recall_decision_details_response.rb +60 -0
  591. data/lib/form3_public_api/models/recall_decision_submission.rb +138 -0
  592. data/lib/form3_public_api/models/recall_decision_submission_attributes.rb +91 -0
  593. data/lib/form3_public_api/models/recall_decision_submission_creation.rb +50 -0
  594. data/lib/form3_public_api/models/recall_decision_submission_creation_response.rb +60 -0
  595. data/lib/form3_public_api/models/recall_decision_submission_details_response.rb +60 -0
  596. data/lib/form3_public_api/models/recall_decision_submission_relationships.rb +71 -0
  597. data/lib/form3_public_api/models/recall_decision_submission_status_enum.rb +48 -0
  598. data/lib/form3_public_api/models/recall_decision_submission_update.rb +89 -0
  599. data/lib/form3_public_api/models/recall_details_response.rb +60 -0
  600. data/lib/form3_public_api/models/recall_relationships.rb +94 -0
  601. data/lib/form3_public_api/models/recall_reversal.rb +136 -0
  602. data/lib/form3_public_api/models/recall_reversal_admission.rb +137 -0
  603. data/lib/form3_public_api/models/recall_reversal_admission_attributes.rb +62 -0
  604. data/lib/form3_public_api/models/recall_reversal_admission_details_response.rb +60 -0
  605. data/lib/form3_public_api/models/recall_reversal_details_response.rb +60 -0
  606. data/lib/form3_public_api/models/recall_status_enum.rb +26 -0
  607. data/lib/form3_public_api/models/recall_submission.rb +137 -0
  608. data/lib/form3_public_api/models/recall_submission_creation.rb +50 -0
  609. data/lib/form3_public_api/models/recall_submission_creation_response.rb +60 -0
  610. data/lib/form3_public_api/models/recall_submission_details_response.rb +60 -0
  611. data/lib/form3_public_api/models/recall_submission_relationships.rb +60 -0
  612. data/lib/form3_public_api/models/recall_submission_status_enum.rb +42 -0
  613. data/lib/form3_public_api/models/recall_submission_update.rb +89 -0
  614. data/lib/form3_public_api/models/receivers_correspondent_account_holding_entity.rb +92 -0
  615. data/lib/form3_public_api/models/reference.rb +57 -0
  616. data/lib/form3_public_api/models/reimbursement_account_holding_entity.rb +92 -0
  617. data/lib/form3_public_api/models/relationship_account.rb +59 -0
  618. data/lib/form3_public_api/models/relationship_advices.rb +59 -0
  619. data/lib/form3_public_api/models/relationship_branch.rb +59 -0
  620. data/lib/form3_public_api/models/relationship_data.rb +60 -0
  621. data/lib/form3_public_api/models/relationship_links.rb +59 -0
  622. data/lib/form3_public_api/models/relationship_payment_admission_beneficiary_account.rb +59 -0
  623. data/lib/form3_public_api/models/relationship_payment_admission_task.rb +59 -0
  624. data/lib/form3_public_api/models/relationship_payment_admission_tasks.rb +59 -0
  625. data/lib/form3_public_api/models/relationship_payment_admissions.rb +59 -0
  626. data/lib/form3_public_api/models/relationship_payment_submission_tasks.rb +59 -0
  627. data/lib/form3_public_api/models/relationship_payment_submissions.rb +59 -0
  628. data/lib/form3_public_api/models/relationship_payments.rb +59 -0
  629. data/lib/form3_public_api/models/relationship_query_response_admission.rb +59 -0
  630. data/lib/form3_public_api/models/relationship_query_response_submission.rb +59 -0
  631. data/lib/form3_public_api/models/relationship_query_submission.rb +59 -0
  632. data/lib/form3_public_api/models/relationship_recall_decisions.rb +59 -0
  633. data/lib/form3_public_api/models/relationship_recall_reversals.rb +59 -0
  634. data/lib/form3_public_api/models/relationship_recalls.rb +59 -0
  635. data/lib/form3_public_api/models/relationship_return_admission_beneficiary_account.rb +59 -0
  636. data/lib/form3_public_api/models/relationship_return_reversals.rb +59 -0
  637. data/lib/form3_public_api/models/relationship_return_submission_tasks.rb +59 -0
  638. data/lib/form3_public_api/models/relationship_return_submissions.rb +59 -0
  639. data/lib/form3_public_api/models/relationship_returns.rb +59 -0
  640. data/lib/form3_public_api/models/relationship_reversal_admission_tasks.rb +59 -0
  641. data/lib/form3_public_api/models/relationship_reversal_admissions.rb +59 -0
  642. data/lib/form3_public_api/models/relationship_reversals.rb +59 -0
  643. data/lib/form3_public_api/models/relationships.rb +50 -0
  644. data/lib/form3_public_api/models/relationships1.rb +61 -0
  645. data/lib/form3_public_api/models/relationships10.rb +97 -0
  646. data/lib/form3_public_api/models/relationships11.rb +77 -0
  647. data/lib/form3_public_api/models/relationships12.rb +76 -0
  648. data/lib/form3_public_api/models/relationships14.rb +82 -0
  649. data/lib/form3_public_api/models/relationships15.rb +61 -0
  650. data/lib/form3_public_api/models/relationships17.rb +65 -0
  651. data/lib/form3_public_api/models/relationships18.rb +60 -0
  652. data/lib/form3_public_api/models/relationships19.rb +50 -0
  653. data/lib/form3_public_api/models/relationships2.rb +74 -0
  654. data/lib/form3_public_api/models/relationships20.rb +82 -0
  655. data/lib/form3_public_api/models/relationships21.rb +71 -0
  656. data/lib/form3_public_api/models/relationships22.rb +71 -0
  657. data/lib/form3_public_api/models/relationships23.rb +75 -0
  658. data/lib/form3_public_api/models/relationships25.rb +51 -0
  659. data/lib/form3_public_api/models/relationships3.rb +72 -0
  660. data/lib/form3_public_api/models/relationships4.rb +72 -0
  661. data/lib/form3_public_api/models/relationships5.rb +82 -0
  662. data/lib/form3_public_api/models/relationships7.rb +82 -0
  663. data/lib/form3_public_api/models/relationships8.rb +61 -0
  664. data/lib/form3_public_api/models/relationships_full_query.rb +59 -0
  665. data/lib/form3_public_api/models/relationships_full_query_response.rb +59 -0
  666. data/lib/form3_public_api/models/relationships_payment.rb +59 -0
  667. data/lib/form3_public_api/models/relationships_payment_admission.rb +59 -0
  668. data/lib/form3_public_api/models/relationships_payment_admission_properties.rb +54 -0
  669. data/lib/form3_public_api/models/relationships_payment_properties.rb +54 -0
  670. data/lib/form3_public_api/models/relationships_payment_recall.rb +59 -0
  671. data/lib/form3_public_api/models/relationships_payment_recall_properties.rb +54 -0
  672. data/lib/form3_public_api/models/relationships_payment_recall_submission.rb +59 -0
  673. data/lib/form3_public_api/models/relationships_payment_recall_submission_properties.rb +54 -0
  674. data/lib/form3_public_api/models/relationships_payment_submission.rb +59 -0
  675. data/lib/form3_public_api/models/relationships_payment_submission_properties.rb +54 -0
  676. data/lib/form3_public_api/models/relationships_query.rb +59 -0
  677. data/lib/form3_public_api/models/relationships_query_admission.rb +59 -0
  678. data/lib/form3_public_api/models/relationships_query_admission_properties.rb +54 -0
  679. data/lib/form3_public_api/models/relationships_query_properties.rb +54 -0
  680. data/lib/form3_public_api/models/relationships_query_response.rb +59 -0
  681. data/lib/form3_public_api/models/relationships_query_response_admission_properties.rb +54 -0
  682. data/lib/form3_public_api/models/relationships_query_response_properties.rb +54 -0
  683. data/lib/form3_public_api/models/relationships_query_submission.rb +59 -0
  684. data/lib/form3_public_api/models/relationships_query_submission_properties.rb +54 -0
  685. data/lib/form3_public_api/models/report.rb +136 -0
  686. data/lib/form3_public_api/models/report1.rb +59 -0
  687. data/lib/form3_public_api/models/report_admission.rb +137 -0
  688. data/lib/form3_public_api/models/report_admission2.rb +59 -0
  689. data/lib/form3_public_api/models/report_admission_attributes.rb +95 -0
  690. data/lib/form3_public_api/models/report_admission_details_response.rb +59 -0
  691. data/lib/form3_public_api/models/report_admission_relationships.rb +50 -0
  692. data/lib/form3_public_api/models/report_admission_status_enum.rb +26 -0
  693. data/lib/form3_public_api/models/report_attributes.rb +130 -0
  694. data/lib/form3_public_api/models/report_details_list_response.rb +68 -0
  695. data/lib/form3_public_api/models/report_details_response.rb +59 -0
  696. data/lib/form3_public_api/models/report_link.rb +59 -0
  697. data/lib/form3_public_api/models/report_links.rb +48 -0
  698. data/lib/form3_public_api/models/report_relationships.rb +72 -0
  699. data/lib/form3_public_api/models/report_request.rb +136 -0
  700. data/lib/form3_public_api/models/report_request1.rb +59 -0
  701. data/lib/form3_public_api/models/report_request3.rb +57 -0
  702. data/lib/form3_public_api/models/report_request4.rb +59 -0
  703. data/lib/form3_public_api/models/report_request_attributes.rb +76 -0
  704. data/lib/form3_public_api/models/report_request_creation.rb +48 -0
  705. data/lib/form3_public_api/models/report_request_details_list_response.rb +68 -0
  706. data/lib/form3_public_api/models/report_request_details_response.rb +59 -0
  707. data/lib/form3_public_api/models/report_request_filter.rb +78 -0
  708. data/lib/form3_public_api/models/report_request_link.rb +59 -0
  709. data/lib/form3_public_api/models/report_request_links.rb +48 -0
  710. data/lib/form3_public_api/models/report_request_relationships.rb +65 -0
  711. data/lib/form3_public_api/models/report_request_status_enum.rb +23 -0
  712. data/lib/form3_public_api/models/report_request_submission.rb +124 -0
  713. data/lib/form3_public_api/models/report_request_submission2.rb +59 -0
  714. data/lib/form3_public_api/models/report_request_submission_attributes.rb +70 -0
  715. data/lib/form3_public_api/models/report_request_submission_details_response.rb +57 -0
  716. data/lib/form3_public_api/models/report_request_submission_relationships.rb +50 -0
  717. data/lib/form3_public_api/models/report_request_submission_status_enum.rb +26 -0
  718. data/lib/form3_public_api/models/report_request_user_id_code_enum.rb +29 -0
  719. data/lib/form3_public_api/models/report_user.rb +60 -0
  720. data/lib/form3_public_api/models/request_for_information_agent.rb +60 -0
  721. data/lib/form3_public_api/models/request_for_information_agent_bank_id.rb +60 -0
  722. data/lib/form3_public_api/models/request_for_information_creator_party.rb +179 -0
  723. data/lib/form3_public_api/models/request_for_information_reference.rb +57 -0
  724. data/lib/form3_public_api/models/request_for_information_requested_information.rb +69 -0
  725. data/lib/form3_public_api/models/resolution_related_information.rb +81 -0
  726. data/lib/form3_public_api/models/resource_type_enum.rb +190 -0
  727. data/lib/form3_public_api/models/return_admission.rb +137 -0
  728. data/lib/form3_public_api/models/return_admission2.rb +59 -0
  729. data/lib/form3_public_api/models/return_admission_beneficiary_account.rb +70 -0
  730. data/lib/form3_public_api/models/return_admission_details_response.rb +60 -0
  731. data/lib/form3_public_api/models/return_admission_fetch.rb +137 -0
  732. data/lib/form3_public_api/models/return_admission_fetch_relationships.rb +83 -0
  733. data/lib/form3_public_api/models/return_admission_fetch_response.rb +60 -0
  734. data/lib/form3_public_api/models/return_admission_relationships.rb +83 -0
  735. data/lib/form3_public_api/models/return_admission_status_enum.rb +24 -0
  736. data/lib/form3_public_api/models/return_creation.rb +50 -0
  737. data/lib/form3_public_api/models/return_creation_response.rb +60 -0
  738. data/lib/form3_public_api/models/return_details_response.rb +60 -0
  739. data/lib/form3_public_api/models/return_initiator_enum.rb +23 -0
  740. data/lib/form3_public_api/models/return_payment.rb +137 -0
  741. data/lib/form3_public_api/models/return_payment_attributes.rb +208 -0
  742. data/lib/form3_public_api/models/return_payment_relationships.rb +83 -0
  743. data/lib/form3_public_api/models/return_reversal.rb +136 -0
  744. data/lib/form3_public_api/models/return_reversal_admission.rb +137 -0
  745. data/lib/form3_public_api/models/return_reversal_admission_details_response.rb +60 -0
  746. data/lib/form3_public_api/models/return_reversal_admission_relationships.rb +73 -0
  747. data/lib/form3_public_api/models/return_reversal_creation.rb +50 -0
  748. data/lib/form3_public_api/models/return_reversal_creation_response.rb +60 -0
  749. data/lib/form3_public_api/models/return_reversal_details_response.rb +60 -0
  750. data/lib/form3_public_api/models/return_submission.rb +137 -0
  751. data/lib/form3_public_api/models/return_submission2.rb +59 -0
  752. data/lib/form3_public_api/models/return_submission_creation.rb +50 -0
  753. data/lib/form3_public_api/models/return_submission_creation_response.rb +60 -0
  754. data/lib/form3_public_api/models/return_submission_details_response.rb +60 -0
  755. data/lib/form3_public_api/models/return_submission_relationships.rb +83 -0
  756. data/lib/form3_public_api/models/return_submission_status_enum.rb +48 -0
  757. data/lib/form3_public_api/models/return_submission_task.rb +139 -0
  758. data/lib/form3_public_api/models/return_submission_task_amendment.rb +50 -0
  759. data/lib/form3_public_api/models/return_submission_task_assignee_enum.rb +23 -0
  760. data/lib/form3_public_api/models/return_submission_task_details_response.rb +60 -0
  761. data/lib/form3_public_api/models/return_submission_task_relationships.rb +72 -0
  762. data/lib/form3_public_api/models/return_submission_task_status_enum.rb +29 -0
  763. data/lib/form3_public_api/models/return_submission_task_update.rb +91 -0
  764. data/lib/form3_public_api/models/return_submission_update.rb +99 -0
  765. data/lib/form3_public_api/models/return_submission_update_relationships.rb +59 -0
  766. data/lib/form3_public_api/models/reversal_admission.rb +136 -0
  767. data/lib/form3_public_api/models/reversal_admission2.rb +59 -0
  768. data/lib/form3_public_api/models/reversal_admission_details_response.rb +60 -0
  769. data/lib/form3_public_api/models/reversal_admission_status_enum.rb +23 -0
  770. data/lib/form3_public_api/models/reversal_admission_task.rb +139 -0
  771. data/lib/form3_public_api/models/reversal_admission_task_assignee_enum.rb +23 -0
  772. data/lib/form3_public_api/models/reversal_admission_task_relationships.rb +71 -0
  773. data/lib/form3_public_api/models/reversal_admission_task_status_enum.rb +29 -0
  774. data/lib/form3_public_api/models/reversal_admission_update.rb +100 -0
  775. data/lib/form3_public_api/models/reversal_admission_update_relationships.rb +59 -0
  776. data/lib/form3_public_api/models/reversal_amount.rb +60 -0
  777. data/lib/form3_public_api/models/reversal_creation.rb +50 -0
  778. data/lib/form3_public_api/models/reversal_creation_response.rb +60 -0
  779. data/lib/form3_public_api/models/reversal_details_response.rb +60 -0
  780. data/lib/form3_public_api/models/reversal_payment.rb +136 -0
  781. data/lib/form3_public_api/models/reversal_payment_update.rb +135 -0
  782. data/lib/form3_public_api/models/reversal_submission.rb +137 -0
  783. data/lib/form3_public_api/models/reversal_submission_creation.rb +50 -0
  784. data/lib/form3_public_api/models/reversal_submission_creation_response.rb +60 -0
  785. data/lib/form3_public_api/models/reversal_submission_details_response.rb +60 -0
  786. data/lib/form3_public_api/models/reversal_submission_relationships.rb +70 -0
  787. data/lib/form3_public_api/models/reversal_submission_status_enum.rb +43 -0
  788. data/lib/form3_public_api/models/role.rb +91 -0
  789. data/lib/form3_public_api/models/role_attributes.rb +61 -0
  790. data/lib/form3_public_api/models/role_creation.rb +48 -0
  791. data/lib/form3_public_api/models/role_creation_response.rb +59 -0
  792. data/lib/form3_public_api/models/role_details_list_response.rb +68 -0
  793. data/lib/form3_public_api/models/role_details_response.rb +59 -0
  794. data/lib/form3_public_api/models/route1_enum.rb +20 -0
  795. data/lib/form3_public_api/models/route_enum.rb +20 -0
  796. data/lib/form3_public_api/models/routing_status_enum.rb +26 -0
  797. data/lib/form3_public_api/models/scheme_file.rb +136 -0
  798. data/lib/form3_public_api/models/scheme_file1.rb +59 -0
  799. data/lib/form3_public_api/models/scheme_file_admission.rb +137 -0
  800. data/lib/form3_public_api/models/scheme_file_admission_creation.rb +48 -0
  801. data/lib/form3_public_api/models/scheme_file_admission_relationships.rb +50 -0
  802. data/lib/form3_public_api/models/scheme_file_admission_response.rb +60 -0
  803. data/lib/form3_public_api/models/scheme_file_admission_status_enum.rb +26 -0
  804. data/lib/form3_public_api/models/scheme_file_admissions.rb +59 -0
  805. data/lib/form3_public_api/models/scheme_file_creation.rb +48 -0
  806. data/lib/form3_public_api/models/scheme_file_link.rb +59 -0
  807. data/lib/form3_public_api/models/scheme_file_links.rb +48 -0
  808. data/lib/form3_public_api/models/scheme_file_relationships.rb +62 -0
  809. data/lib/form3_public_api/models/scheme_file_response.rb +59 -0
  810. data/lib/form3_public_api/models/scheme_file_submission.rb +137 -0
  811. data/lib/form3_public_api/models/scheme_file_submission2.rb +59 -0
  812. data/lib/form3_public_api/models/scheme_file_submission_creation.rb +48 -0
  813. data/lib/form3_public_api/models/scheme_file_submission_relationships.rb +50 -0
  814. data/lib/form3_public_api/models/scheme_file_submission_response.rb +60 -0
  815. data/lib/form3_public_api/models/scheme_file_submission_status_enum.rb +35 -0
  816. data/lib/form3_public_api/models/scheme_files.rb +59 -0
  817. data/lib/form3_public_api/models/scheme_message.rb +99 -0
  818. data/lib/form3_public_api/models/scheme_message1.rb +59 -0
  819. data/lib/form3_public_api/models/scheme_message_admission.rb +101 -0
  820. data/lib/form3_public_api/models/scheme_message_admission2.rb +59 -0
  821. data/lib/form3_public_api/models/scheme_message_admission_attributes.rb +95 -0
  822. data/lib/form3_public_api/models/scheme_message_admission_details_response.rb +59 -0
  823. data/lib/form3_public_api/models/scheme_message_admission_relationships.rb +50 -0
  824. data/lib/form3_public_api/models/scheme_message_admission_status_enum.rb +23 -0
  825. data/lib/form3_public_api/models/scheme_message_attributes.rb +105 -0
  826. data/lib/form3_public_api/models/scheme_message_details_list_response.rb +68 -0
  827. data/lib/form3_public_api/models/scheme_message_details_response.rb +59 -0
  828. data/lib/form3_public_api/models/scheme_message_entry_item.rb +59 -0
  829. data/lib/form3_public_api/models/scheme_message_relationships.rb +52 -0
  830. data/lib/form3_public_api/models/scheme_status_enum.rb +24 -0
  831. data/lib/form3_public_api/models/sender_charge.rb +62 -0
  832. data/lib/form3_public_api/models/senders_correspondent_account_holding_entity.rb +92 -0
  833. data/lib/form3_public_api/models/settlement.rb +95 -0
  834. data/lib/form3_public_api/models/signing_keys_attributes.rb +106 -0
  835. data/lib/form3_public_api/models/signing_keys_list_response.rb +57 -0
  836. data/lib/form3_public_api/models/signing_keys_resource_type_enum.rb +20 -0
  837. data/lib/form3_public_api/models/signing_keys_response.rb +48 -0
  838. data/lib/form3_public_api/models/signing_keys_response_data.rb +120 -0
  839. data/lib/form3_public_api/models/sort_code.rb +70 -0
  840. data/lib/form3_public_api/models/sort_code_details_response.rb +60 -0
  841. data/lib/form3_public_api/models/status2_enum.rb +26 -0
  842. data/lib/form3_public_api/models/status4_enum.rb +20 -0
  843. data/lib/form3_public_api/models/status5_enum.rb +29 -0
  844. data/lib/form3_public_api/models/status_enum.rb +29 -0
  845. data/lib/form3_public_api/models/status_reason_enum.rb +45 -0
  846. data/lib/form3_public_api/models/structured_reference.rb +62 -0
  847. data/lib/form3_public_api/models/subscription.rb +125 -0
  848. data/lib/form3_public_api/models/subscription_amendment.rb +48 -0
  849. data/lib/form3_public_api/models/subscription_attributes.rb +149 -0
  850. data/lib/form3_public_api/models/subscription_creation.rb +48 -0
  851. data/lib/form3_public_api/models/subscription_creation_response.rb +60 -0
  852. data/lib/form3_public_api/models/subscription_delivery_error.rb +138 -0
  853. data/lib/form3_public_api/models/subscription_delivery_error_count_response.rb +60 -0
  854. data/lib/form3_public_api/models/subscription_delivery_error_list_response.rb +69 -0
  855. data/lib/form3_public_api/models/subscription_delivery_error_response.rb +60 -0
  856. data/lib/form3_public_api/models/subscription_delivery_error_type_enum.rb +20 -0
  857. data/lib/form3_public_api/models/subscription_details_list_response.rb +69 -0
  858. data/lib/form3_public_api/models/subscription_details_response.rb +60 -0
  859. data/lib/form3_public_api/models/subscription_relationship.rb +59 -0
  860. data/lib/form3_public_api/models/subscription_update.rb +89 -0
  861. data/lib/form3_public_api/models/subscription_update_attributes.rb +151 -0
  862. data/lib/form3_public_api/models/subscription_user_defined_data.rb +59 -0
  863. data/lib/form3_public_api/models/supported_schemes.rb +80 -0
  864. data/lib/form3_public_api/models/swift.rb +99 -0
  865. data/lib/form3_public_api/models/switched_account_details.rb +88 -0
  866. data/lib/form3_public_api/models/thin_relationship.rb +59 -0
  867. data/lib/form3_public_api/models/token.rb +70 -0
  868. data/lib/form3_public_api/models/token_type_enum.rb +20 -0
  869. data/lib/form3_public_api/models/transaction_file.rb +136 -0
  870. data/lib/form3_public_api/models/transaction_file_admission.rb +137 -0
  871. data/lib/form3_public_api/models/transaction_file_admission_creation.rb +48 -0
  872. data/lib/form3_public_api/models/transaction_file_admission_relationships.rb +51 -0
  873. data/lib/form3_public_api/models/transaction_file_admission_response.rb +60 -0
  874. data/lib/form3_public_api/models/transaction_file_admission_status_enum.rb +26 -0
  875. data/lib/form3_public_api/models/transaction_file_admissions.rb +59 -0
  876. data/lib/form3_public_api/models/transaction_file_creation.rb +48 -0
  877. data/lib/form3_public_api/models/transaction_file_link.rb +59 -0
  878. data/lib/form3_public_api/models/transaction_file_links.rb +48 -0
  879. data/lib/form3_public_api/models/transaction_file_relationships.rb +80 -0
  880. data/lib/form3_public_api/models/transaction_file_response.rb +60 -0
  881. data/lib/form3_public_api/models/transaction_file_submission.rb +137 -0
  882. data/lib/form3_public_api/models/transaction_file_submission_creation.rb +48 -0
  883. data/lib/form3_public_api/models/transaction_file_submission_relationships.rb +51 -0
  884. data/lib/form3_public_api/models/transaction_file_submission_response.rb +60 -0
  885. data/lib/form3_public_api/models/transaction_file_submission_scheme_reference.rb +93 -0
  886. data/lib/form3_public_api/models/transaction_file_submission_status_enum.rb +35 -0
  887. data/lib/form3_public_api/models/transaction_file_submissions.rb +59 -0
  888. data/lib/form3_public_api/models/transaction_files.rb +59 -0
  889. data/lib/form3_public_api/models/transaction_group_code_enum.rb +35 -0
  890. data/lib/form3_public_api/models/type10_enum.rb +20 -0
  891. data/lib/form3_public_api/models/type11_enum.rb +20 -0
  892. data/lib/form3_public_api/models/type13_enum.rb +20 -0
  893. data/lib/form3_public_api/models/type14_enum.rb +20 -0
  894. data/lib/form3_public_api/models/type15_enum.rb +20 -0
  895. data/lib/form3_public_api/models/type16_enum.rb +20 -0
  896. data/lib/form3_public_api/models/type1_enum.rb +20 -0
  897. data/lib/form3_public_api/models/type2_enum.rb +20 -0
  898. data/lib/form3_public_api/models/type3_enum.rb +20 -0
  899. data/lib/form3_public_api/models/type4_enum.rb +20 -0
  900. data/lib/form3_public_api/models/type5_enum.rb +20 -0
  901. data/lib/form3_public_api/models/type6_enum.rb +23 -0
  902. data/lib/form3_public_api/models/type7_enum.rb +20 -0
  903. data/lib/form3_public_api/models/type9_enum.rb +20 -0
  904. data/lib/form3_public_api/models/type_enum.rb +20 -0
  905. data/lib/form3_public_api/models/ultimate_entity.rb +282 -0
  906. data/lib/form3_public_api/models/user.rb +91 -0
  907. data/lib/form3_public_api/models/user_creation.rb +48 -0
  908. data/lib/form3_public_api/models/user_creation_response.rb +59 -0
  909. data/lib/form3_public_api/models/user_credential_list_response.rb +68 -0
  910. data/lib/form3_public_api/models/user_defined_data.rb +57 -0
  911. data/lib/form3_public_api/models/user_details_list_response.rb +68 -0
  912. data/lib/form3_public_api/models/user_details_response.rb +59 -0
  913. data/lib/form3_public_api/models/user_role_list_response.rb +68 -0
  914. data/lib/form3_public_api/models/validation_type_enum.rb +26 -0
  915. data/lib/form3_public_api/utilities/date_time_helper.rb +11 -0
  916. data/lib/form3_public_api/utilities/file_wrapper.rb +16 -0
  917. data/lib/form3_public_api.rb +1056 -0
  918. metadata +1000 -0
@@ -0,0 +1,1255 @@
1
+ # form3_public_api
2
+ #
3
+ # This file was automatically generated by APIMATIC v2.0
4
+ # ( https://apimatic.io ).
5
+
6
+ module Form3PublicApi
7
+ # PaymentsController
8
+ class PaymentsController < BaseController
9
+ # List Positions
10
+ # @return [PositionDetailsListResponse] response from the API call
11
+ def list_positions
12
+ new_api_call_builder
13
+ .request(new_request_builder(HttpMethodEnum::GET,
14
+ '/organisation/positions',
15
+ Server::DEFAULT)
16
+ .header_param(new_parameter('application/json', key: 'accept'))
17
+ .auth(Single.new('OAuth2')))
18
+ .response(new_response_handler
19
+ .deserializer(APIHelper.method(:custom_type_deserializer))
20
+ .deserialize_into(PositionDetailsListResponse.method(:from_hash)))
21
+ .execute
22
+ end
23
+
24
+ # List payments
25
+ # @param [String] page_number Optional parameter: Which page to select
26
+ # @param [Integer] page_size Optional parameter: Number of items to select
27
+ # @param [String] page_before Optional parameter: Cursor for previous page
28
+ # (this is a base64-encoded UUID continuation token returned from the
29
+ # application and should not be manually generated, unless requesting the
30
+ # last page, where the value should be set to "end").
31
+ # @param [String] page_after Optional parameter: Cursor for next page (this
32
+ # is a base64-encoded UUID continuation token returned from the application
33
+ # and should not be manually generated, unless requesting the first page,
34
+ # where the value should be set to "start").
35
+ # @param [Array[UUID | String]] filter_organisation_id Optional parameter:
36
+ # Filter by organisation id
37
+ # @param [String] filter_debtor_party_account_number Optional parameter:
38
+ # Example:
39
+ # @param [String] filter_debtor_party_account_name Optional parameter:
40
+ # Example:
41
+ # @param [String] filter_debtor_party_bank_id Optional parameter: Example:
42
+ # @param [String] filter_beneficiary_party_account_number Optional
43
+ # parameter: Example:
44
+ # @param [String] filter_beneficiary_party_account_name Optional parameter:
45
+ # Example:
46
+ # @param [String] filter_beneficiary_party_bank_id Optional parameter:
47
+ # Example:
48
+ # @param [String] filter_currency Optional parameter: Example:
49
+ # @param [String] filter_end_to_end_reference Optional parameter: Example:
50
+ # @param [String] filter_return_unique_scheme_id Optional parameter:
51
+ # Example:
52
+ # @param [String] filter_scheme_transaction_id Optional parameter:
53
+ # Example:
54
+ # @param [String] filter_payment_scheme Optional parameter: Example:
55
+ # @param [String] filter_payment_type Optional parameter: Example:
56
+ # @param [Date] filter_processing_date_from Optional parameter: Example:
57
+ # @param [Date] filter_processing_date_to Optional parameter: Example:
58
+ # @param [String] filter_unique_scheme_id Optional parameter: Example:
59
+ # @param [String] filter_amount Optional parameter: Example:
60
+ # @param [String] filter_reference Optional parameter: Example:
61
+ # @param [String] filter_route Optional parameter: Example:
62
+ # @param [DateTime] filter_submission_submission_date_from Optional
63
+ # parameter: Example:
64
+ # @param [DateTime] filter_submission_submission_date_to Optional parameter:
65
+ # Example:
66
+ # @param [String] filter_submission_status Optional parameter: Filter by
67
+ # submission status
68
+ # @param [String] filter_submission_scheme_status_code Optional parameter:
69
+ # Filter by submission scheme status code
70
+ # @param [DateTime] filter_return_submission_submission_date_from Optional
71
+ # parameter: Example:
72
+ # @param [DateTime] filter_return_submission_submission_date_to Optional
73
+ # parameter: Example:
74
+ # @param [String] filter_return_submission_status Optional parameter: Filter
75
+ # by return submission status
76
+ # @param [DateTime] filter_admission_admission_date_from Optional parameter:
77
+ # Example:
78
+ # @param [DateTime] filter_admission_admission_date_to Optional parameter:
79
+ # Example:
80
+ # @param [String] filter_admission_status Optional parameter: Filter by
81
+ # admission status
82
+ # @param [String] filter_admission_scheme_status_code Optional parameter:
83
+ # Filter by admission scheme status code
84
+ # @param [Array[FilterRelationships1Enum]] filter_relationships Optional
85
+ # parameter: Filter for payments containing all of the requested
86
+ # relationships
87
+ # @param [Array[FilterNotRelationships1Enum]] filter_not_relationships
88
+ # Optional parameter: Filter for payments containing none of the requested
89
+ # relationships
90
+ # @return [PaymentDetailsListResponse] response from the API call
91
+ def list_payments(page_number: nil,
92
+ page_size: nil,
93
+ page_before: nil,
94
+ page_after: nil,
95
+ filter_organisation_id: nil,
96
+ filter_debtor_party_account_number: nil,
97
+ filter_debtor_party_account_name: nil,
98
+ filter_debtor_party_bank_id: nil,
99
+ filter_beneficiary_party_account_number: nil,
100
+ filter_beneficiary_party_account_name: nil,
101
+ filter_beneficiary_party_bank_id: nil,
102
+ filter_currency: nil,
103
+ filter_end_to_end_reference: nil,
104
+ filter_return_unique_scheme_id: nil,
105
+ filter_scheme_transaction_id: nil,
106
+ filter_payment_scheme: nil,
107
+ filter_payment_type: nil,
108
+ filter_processing_date_from: nil,
109
+ filter_processing_date_to: nil,
110
+ filter_unique_scheme_id: nil,
111
+ filter_amount: nil,
112
+ filter_reference: nil,
113
+ filter_route: nil,
114
+ filter_submission_submission_date_from: nil,
115
+ filter_submission_submission_date_to: nil,
116
+ filter_submission_status: nil,
117
+ filter_submission_scheme_status_code: nil,
118
+ filter_return_submission_submission_date_from: nil,
119
+ filter_return_submission_submission_date_to: nil,
120
+ filter_return_submission_status: nil,
121
+ filter_admission_admission_date_from: nil,
122
+ filter_admission_admission_date_to: nil,
123
+ filter_admission_status: nil,
124
+ filter_admission_scheme_status_code: nil,
125
+ filter_relationships: nil,
126
+ filter_not_relationships: nil)
127
+ new_api_call_builder
128
+ .request(new_request_builder(HttpMethodEnum::GET,
129
+ '/transaction/payments',
130
+ Server::DEFAULT)
131
+ .query_param(new_parameter(page_number, key: 'page[number]'))
132
+ .query_param(new_parameter(page_size, key: 'page[size]'))
133
+ .query_param(new_parameter(page_before, key: 'page[before]'))
134
+ .query_param(new_parameter(page_after, key: 'page[after]'))
135
+ .query_param(new_parameter(filter_organisation_id, key: 'filter[organisation_id]'))
136
+ .query_param(new_parameter(filter_debtor_party_account_number, key: 'filter[debtor_party.account_number]'))
137
+ .query_param(new_parameter(filter_debtor_party_account_name, key: 'filter[debtor_party.account_name]'))
138
+ .query_param(new_parameter(filter_debtor_party_bank_id, key: 'filter[debtor_party.bank_id]'))
139
+ .query_param(new_parameter(filter_beneficiary_party_account_number, key: 'filter[beneficiary_party.account_number]'))
140
+ .query_param(new_parameter(filter_beneficiary_party_account_name, key: 'filter[beneficiary_party.account_name]'))
141
+ .query_param(new_parameter(filter_beneficiary_party_bank_id, key: 'filter[beneficiary_party.bank_id]'))
142
+ .query_param(new_parameter(filter_currency, key: 'filter[currency]'))
143
+ .query_param(new_parameter(filter_end_to_end_reference, key: 'filter[end_to_end_reference]'))
144
+ .query_param(new_parameter(filter_return_unique_scheme_id, key: 'filter[return.unique_scheme_id]'))
145
+ .query_param(new_parameter(filter_scheme_transaction_id, key: 'filter[scheme_transaction_id]'))
146
+ .query_param(new_parameter(filter_payment_scheme, key: 'filter[payment_scheme]'))
147
+ .query_param(new_parameter(filter_payment_type, key: 'filter[payment_type]'))
148
+ .query_param(new_parameter(filter_processing_date_from, key: 'filter[processing_date_from]'))
149
+ .query_param(new_parameter(filter_processing_date_to, key: 'filter[processing_date_to]'))
150
+ .query_param(new_parameter(filter_unique_scheme_id, key: 'filter[unique_scheme_id]'))
151
+ .query_param(new_parameter(filter_amount, key: 'filter[amount]'))
152
+ .query_param(new_parameter(filter_reference, key: 'filter[reference]'))
153
+ .query_param(new_parameter(filter_route, key: 'filter[route]'))
154
+ .query_param(new_parameter(filter_submission_submission_date_from, key: 'filter[submission.submission_date_from]'))
155
+ .query_param(new_parameter(filter_submission_submission_date_to, key: 'filter[submission.submission_date_to]'))
156
+ .query_param(new_parameter(filter_submission_status, key: 'filter[submission.status]'))
157
+ .query_param(new_parameter(filter_submission_scheme_status_code, key: 'filter[submission.scheme_status_code]'))
158
+ .query_param(new_parameter(filter_return_submission_submission_date_from, key: 'filter[return_submission.submission_date_from]'))
159
+ .query_param(new_parameter(filter_return_submission_submission_date_to, key: 'filter[return_submission.submission_date_to]'))
160
+ .query_param(new_parameter(filter_return_submission_status, key: 'filter[return_submission.status]'))
161
+ .query_param(new_parameter(filter_admission_admission_date_from, key: 'filter[admission.admission_date_from]'))
162
+ .query_param(new_parameter(filter_admission_admission_date_to, key: 'filter[admission.admission_date_to]'))
163
+ .query_param(new_parameter(filter_admission_status, key: 'filter[admission.status]'))
164
+ .query_param(new_parameter(filter_admission_scheme_status_code, key: 'filter[admission.scheme_status_code]'))
165
+ .query_param(new_parameter(filter_relationships, key: 'filter[relationships]'))
166
+ .query_param(new_parameter(filter_not_relationships, key: 'filter[not_relationships]'))
167
+ .header_param(new_parameter('application/json', key: 'accept'))
168
+ .auth(Single.new('OAuth2')))
169
+ .response(new_response_handler
170
+ .deserializer(APIHelper.method(:custom_type_deserializer))
171
+ .deserialize_into(PaymentDetailsListResponse.method(:from_hash)))
172
+ .execute
173
+ end
174
+
175
+ # Create payment
176
+ # @param [PaymentCreation] payment_creation_request Optional parameter:
177
+ # Example:
178
+ # @return [PaymentCreationResponse] response from the API call
179
+ def create_payment(payment_creation_request: nil)
180
+ new_api_call_builder
181
+ .request(new_request_builder(HttpMethodEnum::POST,
182
+ '/transaction/payments',
183
+ Server::DEFAULT)
184
+ .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
185
+ .body_param(new_parameter(payment_creation_request))
186
+ .header_param(new_parameter('application/json', key: 'accept'))
187
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
188
+ .auth(Single.new('OAuth2')))
189
+ .response(new_response_handler
190
+ .deserializer(APIHelper.method(:custom_type_deserializer))
191
+ .deserialize_into(PaymentCreationResponse.method(:from_hash))
192
+ .local_error('400',
193
+ 'Payment creation error',
194
+ ApiErrorException))
195
+ .execute
196
+ end
197
+
198
+ # Fetch payment
199
+ # @param [UUID | String] id Required parameter: Payment Id
200
+ # @return [PaymentDetailsResponse] response from the API call
201
+ def fetch_payment(id)
202
+ new_api_call_builder
203
+ .request(new_request_builder(HttpMethodEnum::GET,
204
+ '/transaction/payments/{id}',
205
+ Server::DEFAULT)
206
+ .template_param(new_parameter(id, key: 'id')
207
+ .should_encode(true))
208
+ .header_param(new_parameter('application/json', key: 'accept'))
209
+ .auth(Single.new('OAuth2')))
210
+ .response(new_response_handler
211
+ .deserializer(APIHelper.method(:custom_type_deserializer))
212
+ .deserialize_into(PaymentDetailsResponse.method(:from_hash)))
213
+ .execute
214
+ end
215
+
216
+ # Fetch admission
217
+ # @param [UUID | String] id Required parameter: Payment Id
218
+ # @param [UUID | String] admission_id Required parameter: Admission Id
219
+ # @return [PaymentAdmissionDetailsResponse] response from the API call
220
+ def fetch_admission(id,
221
+ admission_id)
222
+ new_api_call_builder
223
+ .request(new_request_builder(HttpMethodEnum::GET,
224
+ '/transaction/payments/{id}/admissions/{admissionId}',
225
+ Server::DEFAULT)
226
+ .template_param(new_parameter(id, key: 'id')
227
+ .should_encode(true))
228
+ .template_param(new_parameter(admission_id, key: 'admissionId')
229
+ .should_encode(true))
230
+ .header_param(new_parameter('application/json', key: 'accept'))
231
+ .auth(Single.new('OAuth2')))
232
+ .response(new_response_handler
233
+ .deserializer(APIHelper.method(:custom_type_deserializer))
234
+ .deserialize_into(PaymentAdmissionDetailsResponse.method(:from_hash)))
235
+ .execute
236
+ end
237
+
238
+ # List tasks
239
+ # @param [UUID | String] id Required parameter: Payment Id
240
+ # @param [UUID | String] admission_id Required parameter: Admission Id
241
+ # @return [PaymentAdmissionTaskListResponse] response from the API call
242
+ def list_tasks(id,
243
+ admission_id)
244
+ new_api_call_builder
245
+ .request(new_request_builder(HttpMethodEnum::GET,
246
+ '/transaction/payments/{id}/admissions/{admissionId}/tasks',
247
+ Server::DEFAULT)
248
+ .template_param(new_parameter(id, key: 'id')
249
+ .should_encode(true))
250
+ .template_param(new_parameter(admission_id, key: 'admissionId')
251
+ .should_encode(true))
252
+ .header_param(new_parameter('application/json', key: 'accept'))
253
+ .auth(Single.new('OAuth2')))
254
+ .response(new_response_handler
255
+ .deserializer(APIHelper.method(:custom_type_deserializer))
256
+ .deserialize_into(PaymentAdmissionTaskListResponse.method(:from_hash)))
257
+ .execute
258
+ end
259
+
260
+ # Get Payment Admission Task By ID
261
+ # @param [UUID | String] id Required parameter: Payment Id
262
+ # @param [UUID | String] admission_id Required parameter: Admission Id
263
+ # @param [UUID | String] task_id Required parameter: Payment Admission Task
264
+ # Id
265
+ # @return [PaymentAdmissionTaskDetailsResponse] response from the API call
266
+ def get_payment_admission_task_by_id(id,
267
+ admission_id,
268
+ task_id)
269
+ new_api_call_builder
270
+ .request(new_request_builder(HttpMethodEnum::GET,
271
+ '/transaction/payments/{id}/admissions/{admissionId}/tasks/{taskId}',
272
+ Server::DEFAULT)
273
+ .template_param(new_parameter(id, key: 'id')
274
+ .should_encode(true))
275
+ .template_param(new_parameter(admission_id, key: 'admissionId')
276
+ .should_encode(true))
277
+ .template_param(new_parameter(task_id, key: 'taskId')
278
+ .should_encode(true))
279
+ .header_param(new_parameter('application/json', key: 'accept'))
280
+ .auth(Single.new('OAuth2')))
281
+ .response(new_response_handler
282
+ .deserializer(APIHelper.method(:custom_type_deserializer))
283
+ .deserialize_into(PaymentAdmissionTaskDetailsResponse.method(:from_hash)))
284
+ .execute
285
+ end
286
+
287
+ # Patch Payment Admission Task
288
+ # @param [UUID | String] id Required parameter: Payment Id
289
+ # @param [UUID | String] admission_id Required parameter: Admission Id
290
+ # @param [UUID | String] task_id Required parameter: Payment Admission Task
291
+ # Id
292
+ # @param [PaymentAdmissionTaskAmendment]
293
+ # payment_admission_task_patch_request Optional parameter: Example:
294
+ # @return [PaymentAdmissionTaskDetailsResponse] response from the API call
295
+ def patch_payment_admission_task(id,
296
+ admission_id,
297
+ task_id,
298
+ payment_admission_task_patch_request: nil)
299
+ new_api_call_builder
300
+ .request(new_request_builder(HttpMethodEnum::PATCH,
301
+ '/transaction/payments/{id}/admissions/{admissionId}/tasks/{taskId}',
302
+ Server::DEFAULT)
303
+ .template_param(new_parameter(id, key: 'id')
304
+ .should_encode(true))
305
+ .template_param(new_parameter(admission_id, key: 'admissionId')
306
+ .should_encode(true))
307
+ .template_param(new_parameter(task_id, key: 'taskId')
308
+ .should_encode(true))
309
+ .body_param(new_parameter(payment_admission_task_patch_request))
310
+ .header_param(new_parameter('application/json; charset=utf-8', key: 'content-type'))
311
+ .header_param(new_parameter('application/json', key: 'accept'))
312
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
313
+ .auth(Single.new('OAuth2')))
314
+ .response(new_response_handler
315
+ .deserializer(APIHelper.method(:custom_type_deserializer))
316
+ .deserialize_into(PaymentAdmissionTaskDetailsResponse.method(:from_hash))
317
+ .local_error('400',
318
+ 'Error',
319
+ ApiErrorException)
320
+ .local_error('409',
321
+ 'Conflict',
322
+ ApiErrorException))
323
+ .execute
324
+ end
325
+
326
+ # Create advice
327
+ # @param [UUID | String] id Required parameter: Payment Id
328
+ # @param [AdviceCreation] advice_creation_request Optional parameter:
329
+ # Example:
330
+ # @return [AdviceCreationResponse] response from the API call
331
+ def create_advice(id,
332
+ advice_creation_request: nil)
333
+ new_api_call_builder
334
+ .request(new_request_builder(HttpMethodEnum::POST,
335
+ '/transaction/payments/{id}/advices',
336
+ Server::DEFAULT)
337
+ .template_param(new_parameter(id, key: 'id')
338
+ .should_encode(true))
339
+ .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
340
+ .body_param(new_parameter(advice_creation_request))
341
+ .header_param(new_parameter('application/json', key: 'accept'))
342
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
343
+ .auth(Single.new('OAuth2')))
344
+ .response(new_response_handler
345
+ .deserializer(APIHelper.method(:custom_type_deserializer))
346
+ .deserialize_into(AdviceCreationResponse.method(:from_hash))
347
+ .local_error('400',
348
+ 'Advice creation error',
349
+ ApiErrorException))
350
+ .execute
351
+ end
352
+
353
+ # Fetch advice
354
+ # @param [UUID | String] id Required parameter: Payment Id
355
+ # @param [UUID | String] advice_id Required parameter: Advice Id
356
+ # @return [AdviceDetailsResponse] response from the API call
357
+ def fetch_advice(id,
358
+ advice_id)
359
+ new_api_call_builder
360
+ .request(new_request_builder(HttpMethodEnum::GET,
361
+ '/transaction/payments/{id}/advices/{adviceId}',
362
+ Server::DEFAULT)
363
+ .template_param(new_parameter(id, key: 'id')
364
+ .should_encode(true))
365
+ .template_param(new_parameter(advice_id, key: 'adviceId')
366
+ .should_encode(true))
367
+ .header_param(new_parameter('application/json', key: 'accept'))
368
+ .auth(Single.new('OAuth2')))
369
+ .response(new_response_handler
370
+ .deserializer(APIHelper.method(:custom_type_deserializer))
371
+ .deserialize_into(AdviceDetailsResponse.method(:from_hash)))
372
+ .execute
373
+ end
374
+
375
+ # create advice submission
376
+ # @param [UUID | String] id Required parameter: Payment Id
377
+ # @param [UUID | String] advice_id Required parameter: Advice Id
378
+ # @param [AdviceSubmissionCreation] advice_submission_creation_request
379
+ # Optional parameter: Example:
380
+ # @return [AdviceSubmissionCreationResponse] response from the API call
381
+ def create_advice_submission(id,
382
+ advice_id,
383
+ advice_submission_creation_request: nil)
384
+ new_api_call_builder
385
+ .request(new_request_builder(HttpMethodEnum::POST,
386
+ '/transaction/payments/{id}/advices/{adviceId}/submissions',
387
+ Server::DEFAULT)
388
+ .template_param(new_parameter(id, key: 'id')
389
+ .should_encode(true))
390
+ .template_param(new_parameter(advice_id, key: 'adviceId')
391
+ .should_encode(true))
392
+ .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
393
+ .body_param(new_parameter(advice_submission_creation_request))
394
+ .header_param(new_parameter('application/json', key: 'accept'))
395
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
396
+ .auth(Single.new('OAuth2')))
397
+ .response(new_response_handler
398
+ .deserializer(APIHelper.method(:custom_type_deserializer))
399
+ .deserialize_into(AdviceSubmissionCreationResponse.method(:from_hash))
400
+ .local_error('400',
401
+ 'Advice submission creation error',
402
+ ApiErrorException))
403
+ .execute
404
+ end
405
+
406
+ # Fetch advice submission
407
+ # @param [UUID | String] id Required parameter: Payment Id
408
+ # @param [UUID | String] advice_id Required parameter: Advice Id
409
+ # @param [UUID | String] submission_id Required parameter: Submission Id
410
+ # @return [AdviceSubmissionDetailsResponse] response from the API call
411
+ def fetch_advice_submission(id,
412
+ advice_id,
413
+ submission_id)
414
+ new_api_call_builder
415
+ .request(new_request_builder(HttpMethodEnum::GET,
416
+ '/transaction/payments/{id}/advices/{adviceId}/submissions/{submissionId}',
417
+ Server::DEFAULT)
418
+ .template_param(new_parameter(id, key: 'id')
419
+ .should_encode(true))
420
+ .template_param(new_parameter(advice_id, key: 'adviceId')
421
+ .should_encode(true))
422
+ .template_param(new_parameter(submission_id, key: 'submissionId')
423
+ .should_encode(true))
424
+ .header_param(new_parameter('application/json', key: 'accept'))
425
+ .auth(Single.new('OAuth2')))
426
+ .response(new_response_handler
427
+ .deserializer(APIHelper.method(:custom_type_deserializer))
428
+ .deserialize_into(AdviceSubmissionDetailsResponse.method(:from_hash)))
429
+ .execute
430
+ end
431
+
432
+ # Create recall
433
+ # @param [UUID | String] id Required parameter: Payment Id
434
+ # @param [RecallCreation] recall_creation_request Optional parameter:
435
+ # Example:
436
+ # @return [RecallCreationResponse] response from the API call
437
+ def create_recall(id,
438
+ recall_creation_request: nil)
439
+ new_api_call_builder
440
+ .request(new_request_builder(HttpMethodEnum::POST,
441
+ '/transaction/payments/{id}/recalls',
442
+ Server::DEFAULT)
443
+ .template_param(new_parameter(id, key: 'id')
444
+ .should_encode(true))
445
+ .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
446
+ .body_param(new_parameter(recall_creation_request))
447
+ .header_param(new_parameter('application/json', key: 'accept'))
448
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
449
+ .auth(Single.new('OAuth2')))
450
+ .response(new_response_handler
451
+ .deserializer(APIHelper.method(:custom_type_deserializer))
452
+ .deserialize_into(RecallCreationResponse.method(:from_hash))
453
+ .local_error('400',
454
+ 'Recall creation error',
455
+ ApiErrorException))
456
+ .execute
457
+ end
458
+
459
+ # Fetch recall
460
+ # @param [UUID | String] id Required parameter: Payment Id
461
+ # @param [UUID | String] recall_id Required parameter: Recall Id
462
+ # @return [RecallDetailsResponse] response from the API call
463
+ def fetch_recall(id,
464
+ recall_id)
465
+ new_api_call_builder
466
+ .request(new_request_builder(HttpMethodEnum::GET,
467
+ '/transaction/payments/{id}/recalls/{recallId}',
468
+ Server::DEFAULT)
469
+ .template_param(new_parameter(id, key: 'id')
470
+ .should_encode(true))
471
+ .template_param(new_parameter(recall_id, key: 'recallId')
472
+ .should_encode(true))
473
+ .header_param(new_parameter('application/json', key: 'accept'))
474
+ .auth(Single.new('OAuth2')))
475
+ .response(new_response_handler
476
+ .deserializer(APIHelper.method(:custom_type_deserializer))
477
+ .deserialize_into(RecallDetailsResponse.method(:from_hash)))
478
+ .execute
479
+ end
480
+
481
+ # Fetch recall admission
482
+ # @param [UUID | String] id Required parameter: Payment Id
483
+ # @param [UUID | String] recall_id Required parameter: Recall Id
484
+ # @param [UUID | String] admission_id Required parameter: Admission Id
485
+ # @return [RecallAdmissionDetailsResponse] response from the API call
486
+ def fetch_recall_admission(id,
487
+ recall_id,
488
+ admission_id)
489
+ new_api_call_builder
490
+ .request(new_request_builder(HttpMethodEnum::GET,
491
+ '/transaction/payments/{id}/recalls/{recallId}/admissions/{admissionId}',
492
+ Server::DEFAULT)
493
+ .template_param(new_parameter(id, key: 'id')
494
+ .should_encode(true))
495
+ .template_param(new_parameter(recall_id, key: 'recallId')
496
+ .should_encode(true))
497
+ .template_param(new_parameter(admission_id, key: 'admissionId')
498
+ .should_encode(true))
499
+ .header_param(new_parameter('application/json', key: 'accept'))
500
+ .auth(Single.new('OAuth2')))
501
+ .response(new_response_handler
502
+ .deserializer(APIHelper.method(:custom_type_deserializer))
503
+ .deserialize_into(RecallAdmissionDetailsResponse.method(:from_hash)))
504
+ .execute
505
+ end
506
+
507
+ # Create recall decision
508
+ # @param [UUID | String] id Required parameter: Payment Id
509
+ # @param [UUID | String] recall_id Required parameter: Recall Id
510
+ # @param [RecallDecisionCreation] recall_decision_creation_request Optional
511
+ # parameter: Example:
512
+ # @return [RecallDecisionCreationResponse] response from the API call
513
+ def create_recall_decision(id,
514
+ recall_id,
515
+ recall_decision_creation_request: nil)
516
+ new_api_call_builder
517
+ .request(new_request_builder(HttpMethodEnum::POST,
518
+ '/transaction/payments/{id}/recalls/{recallId}/decisions',
519
+ Server::DEFAULT)
520
+ .template_param(new_parameter(id, key: 'id')
521
+ .should_encode(true))
522
+ .template_param(new_parameter(recall_id, key: 'recallId')
523
+ .should_encode(true))
524
+ .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
525
+ .body_param(new_parameter(recall_decision_creation_request))
526
+ .header_param(new_parameter('application/json', key: 'accept'))
527
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
528
+ .auth(Single.new('OAuth2')))
529
+ .response(new_response_handler
530
+ .deserializer(APIHelper.method(:custom_type_deserializer))
531
+ .deserialize_into(RecallDecisionCreationResponse.method(:from_hash))
532
+ .local_error('400',
533
+ 'Recall decision creation error',
534
+ ApiErrorException))
535
+ .execute
536
+ end
537
+
538
+ # Fetch recall decision
539
+ # @param [UUID | String] id Required parameter: Payment Id
540
+ # @param [UUID | String] recall_id Required parameter: Recall Id
541
+ # @param [UUID | String] decision_id Required parameter: Decision Id
542
+ # @return [RecallDecisionDetailsResponse] response from the API call
543
+ def fetch_recall_decision(id,
544
+ recall_id,
545
+ decision_id)
546
+ new_api_call_builder
547
+ .request(new_request_builder(HttpMethodEnum::GET,
548
+ '/transaction/payments/{id}/recalls/{recallId}/decisions/{decisionId}',
549
+ Server::DEFAULT)
550
+ .template_param(new_parameter(id, key: 'id')
551
+ .should_encode(true))
552
+ .template_param(new_parameter(recall_id, key: 'recallId')
553
+ .should_encode(true))
554
+ .template_param(new_parameter(decision_id, key: 'decisionId')
555
+ .should_encode(true))
556
+ .header_param(new_parameter('application/json', key: 'accept'))
557
+ .auth(Single.new('OAuth2')))
558
+ .response(new_response_handler
559
+ .deserializer(APIHelper.method(:custom_type_deserializer))
560
+ .deserialize_into(RecallDecisionDetailsResponse.method(:from_hash)))
561
+ .execute
562
+ end
563
+
564
+ # Fetch recall decision admission
565
+ # @param [UUID | String] id Required parameter: Payment Id
566
+ # @param [UUID | String] recall_id Required parameter: Recall Id
567
+ # @param [UUID | String] decision_id Required parameter: Decision Id
568
+ # @param [UUID | String] admission_id Required parameter: Admission Id
569
+ # @return [RecallDecisionAdmissionDetailsResponse] response from the API call
570
+ def fetch_recall_decision_admission(id,
571
+ recall_id,
572
+ decision_id,
573
+ admission_id)
574
+ new_api_call_builder
575
+ .request(new_request_builder(HttpMethodEnum::GET,
576
+ '/transaction/payments/{id}/recalls/{recallId}/decisions/{decisionId}/admissions/{admissionId}',
577
+ Server::DEFAULT)
578
+ .template_param(new_parameter(id, key: 'id')
579
+ .should_encode(true))
580
+ .template_param(new_parameter(recall_id, key: 'recallId')
581
+ .should_encode(true))
582
+ .template_param(new_parameter(decision_id, key: 'decisionId')
583
+ .should_encode(true))
584
+ .template_param(new_parameter(admission_id, key: 'admissionId')
585
+ .should_encode(true))
586
+ .header_param(new_parameter('application/json', key: 'accept'))
587
+ .auth(Single.new('OAuth2')))
588
+ .response(new_response_handler
589
+ .deserializer(APIHelper.method(:custom_type_deserializer))
590
+ .deserialize_into(RecallDecisionAdmissionDetailsResponse.method(:from_hash)))
591
+ .execute
592
+ end
593
+
594
+ # create recall decision submission
595
+ # @param [UUID | String] id Required parameter: Payment Id
596
+ # @param [UUID | String] recall_id Required parameter: Recall Id
597
+ # @param [UUID | String] decision_id Required parameter: Decision Id
598
+ # @param [RecallDecisionSubmissionCreation]
599
+ # recall_decision_submission_creation_request Optional parameter: Example:
600
+ # @return [RecallDecisionSubmissionCreationResponse] response from the API call
601
+ def create_recall_decision_submission(id,
602
+ recall_id,
603
+ decision_id,
604
+ recall_decision_submission_creation_request: nil)
605
+ new_api_call_builder
606
+ .request(new_request_builder(HttpMethodEnum::POST,
607
+ '/transaction/payments/{id}/recalls/{recallId}/decisions/{decisionId}/submissions',
608
+ Server::DEFAULT)
609
+ .template_param(new_parameter(id, key: 'id')
610
+ .should_encode(true))
611
+ .template_param(new_parameter(recall_id, key: 'recallId')
612
+ .should_encode(true))
613
+ .template_param(new_parameter(decision_id, key: 'decisionId')
614
+ .should_encode(true))
615
+ .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
616
+ .body_param(new_parameter(recall_decision_submission_creation_request))
617
+ .header_param(new_parameter('application/json', key: 'accept'))
618
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
619
+ .auth(Single.new('OAuth2')))
620
+ .response(new_response_handler
621
+ .deserializer(APIHelper.method(:custom_type_deserializer))
622
+ .deserialize_into(RecallDecisionSubmissionCreationResponse.method(:from_hash))
623
+ .local_error('400',
624
+ 'Recall decision submission creation error',
625
+ ApiErrorException))
626
+ .execute
627
+ end
628
+
629
+ # Fetch recall decision submission
630
+ # @param [UUID | String] id Required parameter: Payment Id
631
+ # @param [UUID | String] recall_id Required parameter: Recall Id
632
+ # @param [UUID | String] decision_id Required parameter: Decision Id
633
+ # @param [UUID | String] submission_id Required parameter: Submission Id
634
+ # @return [RecallDecisionSubmissionDetailsResponse] response from the API call
635
+ def fetch_recall_decision_submission(id,
636
+ recall_id,
637
+ decision_id,
638
+ submission_id)
639
+ new_api_call_builder
640
+ .request(new_request_builder(HttpMethodEnum::GET,
641
+ '/transaction/payments/{id}/recalls/{recallId}/decisions/{decisionId}/submissions/{submissionId}',
642
+ Server::DEFAULT)
643
+ .template_param(new_parameter(id, key: 'id')
644
+ .should_encode(true))
645
+ .template_param(new_parameter(recall_id, key: 'recallId')
646
+ .should_encode(true))
647
+ .template_param(new_parameter(decision_id, key: 'decisionId')
648
+ .should_encode(true))
649
+ .template_param(new_parameter(submission_id, key: 'submissionId')
650
+ .should_encode(true))
651
+ .header_param(new_parameter('application/json', key: 'accept'))
652
+ .auth(Single.new('OAuth2')))
653
+ .response(new_response_handler
654
+ .deserializer(APIHelper.method(:custom_type_deserializer))
655
+ .deserialize_into(RecallDecisionSubmissionDetailsResponse.method(:from_hash)))
656
+ .execute
657
+ end
658
+
659
+ # Fetch recall reversal
660
+ # @param [UUID | String] id Required parameter: Payment Id
661
+ # @param [UUID | String] recall_id Required parameter: Recall Id
662
+ # @param [UUID | String] reversal_id Required parameter: Reversal Id
663
+ # @return [RecallReversalDetailsResponse] response from the API call
664
+ def fetch_recall_reversal(id,
665
+ recall_id,
666
+ reversal_id)
667
+ new_api_call_builder
668
+ .request(new_request_builder(HttpMethodEnum::GET,
669
+ '/transaction/payments/{id}/recalls/{recallId}/reversals/{reversalId}',
670
+ Server::DEFAULT)
671
+ .template_param(new_parameter(id, key: 'id')
672
+ .should_encode(true))
673
+ .template_param(new_parameter(recall_id, key: 'recallId')
674
+ .should_encode(true))
675
+ .template_param(new_parameter(reversal_id, key: 'reversalId')
676
+ .should_encode(true))
677
+ .header_param(new_parameter('application/json', key: 'accept'))
678
+ .auth(Single.new('OAuth2')))
679
+ .response(new_response_handler
680
+ .deserializer(APIHelper.method(:custom_type_deserializer))
681
+ .deserialize_into(RecallReversalDetailsResponse.method(:from_hash)))
682
+ .execute
683
+ end
684
+
685
+ # Fetch recall reversal admission
686
+ # @param [UUID | String] id Required parameter: Payment Id
687
+ # @param [UUID | String] recall_id Required parameter: Recall Id
688
+ # @param [UUID | String] reversal_id Required parameter: Reversal Id
689
+ # @param [UUID | String] admission_id Required parameter: Admission Id
690
+ # @return [RecallReversalAdmissionDetailsResponse] response from the API call
691
+ def fetch_recall_reversal_admission(id,
692
+ recall_id,
693
+ reversal_id,
694
+ admission_id)
695
+ new_api_call_builder
696
+ .request(new_request_builder(HttpMethodEnum::GET,
697
+ '/transaction/payments/{id}/recalls/{recallId}/reversals/{reversalId}/admissions/{admissionId}',
698
+ Server::DEFAULT)
699
+ .template_param(new_parameter(id, key: 'id')
700
+ .should_encode(true))
701
+ .template_param(new_parameter(recall_id, key: 'recallId')
702
+ .should_encode(true))
703
+ .template_param(new_parameter(reversal_id, key: 'reversalId')
704
+ .should_encode(true))
705
+ .template_param(new_parameter(admission_id, key: 'admissionId')
706
+ .should_encode(true))
707
+ .header_param(new_parameter('application/json', key: 'accept'))
708
+ .auth(Single.new('OAuth2')))
709
+ .response(new_response_handler
710
+ .deserializer(APIHelper.method(:custom_type_deserializer))
711
+ .deserialize_into(RecallReversalAdmissionDetailsResponse.method(:from_hash)))
712
+ .execute
713
+ end
714
+
715
+ # create recall submission
716
+ # @param [UUID | String] id Required parameter: Payment Id
717
+ # @param [UUID | String] recall_id Required parameter: Recall Id
718
+ # @param [RecallSubmissionCreation] recall_submission_creation_request
719
+ # Optional parameter: Example:
720
+ # @return [RecallSubmissionCreationResponse] response from the API call
721
+ def create_recall_submission(id,
722
+ recall_id,
723
+ recall_submission_creation_request: nil)
724
+ new_api_call_builder
725
+ .request(new_request_builder(HttpMethodEnum::POST,
726
+ '/transaction/payments/{id}/recalls/{recallId}/submissions',
727
+ Server::DEFAULT)
728
+ .template_param(new_parameter(id, key: 'id')
729
+ .should_encode(true))
730
+ .template_param(new_parameter(recall_id, key: 'recallId')
731
+ .should_encode(true))
732
+ .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
733
+ .body_param(new_parameter(recall_submission_creation_request))
734
+ .header_param(new_parameter('application/json', key: 'accept'))
735
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
736
+ .auth(Single.new('OAuth2')))
737
+ .response(new_response_handler
738
+ .deserializer(APIHelper.method(:custom_type_deserializer))
739
+ .deserialize_into(RecallSubmissionCreationResponse.method(:from_hash))
740
+ .local_error('400',
741
+ 'Recall submission creation error',
742
+ ApiErrorException))
743
+ .execute
744
+ end
745
+
746
+ # Fetch recall submission
747
+ # @param [UUID | String] id Required parameter: Payment Id
748
+ # @param [UUID | String] recall_id Required parameter: Recall Id
749
+ # @param [UUID | String] submission_id Required parameter: Submission Id
750
+ # @return [RecallSubmissionDetailsResponse] response from the API call
751
+ def fetch_recall_submission(id,
752
+ recall_id,
753
+ submission_id)
754
+ new_api_call_builder
755
+ .request(new_request_builder(HttpMethodEnum::GET,
756
+ '/transaction/payments/{id}/recalls/{recallId}/submissions/{submissionId}',
757
+ Server::DEFAULT)
758
+ .template_param(new_parameter(id, key: 'id')
759
+ .should_encode(true))
760
+ .template_param(new_parameter(recall_id, key: 'recallId')
761
+ .should_encode(true))
762
+ .template_param(new_parameter(submission_id, key: 'submissionId')
763
+ .should_encode(true))
764
+ .header_param(new_parameter('application/json', key: 'accept'))
765
+ .auth(Single.new('OAuth2')))
766
+ .response(new_response_handler
767
+ .deserializer(APIHelper.method(:custom_type_deserializer))
768
+ .deserialize_into(RecallSubmissionDetailsResponse.method(:from_hash)))
769
+ .execute
770
+ end
771
+
772
+ # Create return
773
+ # @param [UUID | String] id Required parameter: Payment Id
774
+ # @param [ReturnCreation] return_creation_request Optional parameter:
775
+ # Example:
776
+ # @return [ReturnCreationResponse] response from the API call
777
+ def create_return(id,
778
+ return_creation_request: nil)
779
+ new_api_call_builder
780
+ .request(new_request_builder(HttpMethodEnum::POST,
781
+ '/transaction/payments/{id}/returns',
782
+ Server::DEFAULT)
783
+ .template_param(new_parameter(id, key: 'id')
784
+ .should_encode(true))
785
+ .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
786
+ .body_param(new_parameter(return_creation_request))
787
+ .header_param(new_parameter('application/json', key: 'accept'))
788
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
789
+ .auth(Single.new('OAuth2')))
790
+ .response(new_response_handler
791
+ .deserializer(APIHelper.method(:custom_type_deserializer))
792
+ .deserialize_into(ReturnCreationResponse.method(:from_hash))
793
+ .local_error('400',
794
+ 'Return creation error',
795
+ ApiErrorException))
796
+ .execute
797
+ end
798
+
799
+ # Fetch return
800
+ # @param [UUID | String] id Required parameter: Payment Id
801
+ # @param [UUID | String] return_id Required parameter: Return Id
802
+ # @return [ReturnDetailsResponse] response from the API call
803
+ def fetch_return(id,
804
+ return_id)
805
+ new_api_call_builder
806
+ .request(new_request_builder(HttpMethodEnum::GET,
807
+ '/transaction/payments/{id}/returns/{returnId}',
808
+ Server::DEFAULT)
809
+ .template_param(new_parameter(id, key: 'id')
810
+ .should_encode(true))
811
+ .template_param(new_parameter(return_id, key: 'returnId')
812
+ .should_encode(true))
813
+ .header_param(new_parameter('application/json', key: 'accept'))
814
+ .auth(Single.new('OAuth2')))
815
+ .response(new_response_handler
816
+ .deserializer(APIHelper.method(:custom_type_deserializer))
817
+ .deserialize_into(ReturnDetailsResponse.method(:from_hash)))
818
+ .execute
819
+ end
820
+
821
+ # Fetch return admission
822
+ # @param [UUID | String] id Required parameter: Payment Id
823
+ # @param [UUID | String] return_id Required parameter: Return Id
824
+ # @param [UUID | String] admission_id Required parameter: Admission Id
825
+ # @return [ReturnAdmissionFetchResponse] response from the API call
826
+ def fetch_return_admission(id,
827
+ return_id,
828
+ admission_id)
829
+ new_api_call_builder
830
+ .request(new_request_builder(HttpMethodEnum::GET,
831
+ '/transaction/payments/{id}/returns/{returnId}/admissions/{admissionId}',
832
+ Server::DEFAULT)
833
+ .template_param(new_parameter(id, key: 'id')
834
+ .should_encode(true))
835
+ .template_param(new_parameter(return_id, key: 'returnId')
836
+ .should_encode(true))
837
+ .template_param(new_parameter(admission_id, key: 'admissionId')
838
+ .should_encode(true))
839
+ .header_param(new_parameter('application/json', key: 'accept'))
840
+ .auth(Single.new('OAuth2')))
841
+ .response(new_response_handler
842
+ .deserializer(APIHelper.method(:custom_type_deserializer))
843
+ .deserialize_into(ReturnAdmissionFetchResponse.method(:from_hash)))
844
+ .execute
845
+ end
846
+
847
+ # Create return reversal
848
+ # @param [UUID | String] id Required parameter: Payment Id
849
+ # @param [UUID | String] return_id Required parameter: Return Id
850
+ # @param [ReturnReversalCreation] return_reversal_creation_request Optional
851
+ # parameter: Example:
852
+ # @return [ReturnReversalCreationResponse] response from the API call
853
+ def create_return_reversal(id,
854
+ return_id,
855
+ return_reversal_creation_request: nil)
856
+ new_api_call_builder
857
+ .request(new_request_builder(HttpMethodEnum::POST,
858
+ '/transaction/payments/{id}/returns/{returnId}/reversals',
859
+ Server::DEFAULT)
860
+ .template_param(new_parameter(id, key: 'id')
861
+ .should_encode(true))
862
+ .template_param(new_parameter(return_id, key: 'returnId')
863
+ .should_encode(true))
864
+ .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
865
+ .body_param(new_parameter(return_reversal_creation_request))
866
+ .header_param(new_parameter('application/json', key: 'accept'))
867
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
868
+ .auth(Single.new('OAuth2')))
869
+ .response(new_response_handler
870
+ .deserializer(APIHelper.method(:custom_type_deserializer))
871
+ .deserialize_into(ReturnReversalCreationResponse.method(:from_hash))
872
+ .local_error('400',
873
+ 'Reversal creation error',
874
+ ApiErrorException))
875
+ .execute
876
+ end
877
+
878
+ # Fetch return reversal
879
+ # @param [UUID | String] id Required parameter: Payment Id
880
+ # @param [UUID | String] return_id Required parameter: Return Id
881
+ # @param [UUID | String] reversal_id Required parameter: Reversal Id
882
+ # @return [ReturnReversalDetailsResponse] response from the API call
883
+ def fetch_return_reversal(id,
884
+ return_id,
885
+ reversal_id)
886
+ new_api_call_builder
887
+ .request(new_request_builder(HttpMethodEnum::GET,
888
+ '/transaction/payments/{id}/returns/{returnId}/reversals/{reversalId}',
889
+ Server::DEFAULT)
890
+ .template_param(new_parameter(id, key: 'id')
891
+ .should_encode(true))
892
+ .template_param(new_parameter(return_id, key: 'returnId')
893
+ .should_encode(true))
894
+ .template_param(new_parameter(reversal_id, key: 'reversalId')
895
+ .should_encode(true))
896
+ .header_param(new_parameter('application/json', key: 'accept'))
897
+ .auth(Single.new('OAuth2')))
898
+ .response(new_response_handler
899
+ .deserializer(APIHelper.method(:custom_type_deserializer))
900
+ .deserialize_into(ReturnReversalDetailsResponse.method(:from_hash)))
901
+ .execute
902
+ end
903
+
904
+ # Fetch return reversal admission
905
+ # @param [UUID | String] id Required parameter: Payment Id
906
+ # @param [UUID | String] return_id Required parameter: Return Id
907
+ # @param [UUID | String] reversal_id Required parameter: Reversal Id
908
+ # @param [UUID | String] admission_id Required parameter: Admission Id
909
+ # @return [ReturnReversalAdmissionDetailsResponse] response from the API call
910
+ def fetch_return_reversal_admission(id,
911
+ return_id,
912
+ reversal_id,
913
+ admission_id)
914
+ new_api_call_builder
915
+ .request(new_request_builder(HttpMethodEnum::GET,
916
+ '/transaction/payments/{id}/returns/{returnId}/reversals/{reversalId}/admissions/{admissionId}',
917
+ Server::DEFAULT)
918
+ .template_param(new_parameter(id, key: 'id')
919
+ .should_encode(true))
920
+ .template_param(new_parameter(return_id, key: 'returnId')
921
+ .should_encode(true))
922
+ .template_param(new_parameter(reversal_id, key: 'reversalId')
923
+ .should_encode(true))
924
+ .template_param(new_parameter(admission_id, key: 'admissionId')
925
+ .should_encode(true))
926
+ .header_param(new_parameter('application/json', key: 'accept'))
927
+ .auth(Single.new('OAuth2')))
928
+ .response(new_response_handler
929
+ .deserializer(APIHelper.method(:custom_type_deserializer))
930
+ .deserialize_into(ReturnReversalAdmissionDetailsResponse.method(:from_hash)))
931
+ .execute
932
+ end
933
+
934
+ # create return submission
935
+ # @param [UUID | String] id Required parameter: Payment Id
936
+ # @param [UUID | String] return_id Required parameter: Return Id
937
+ # @param [ReturnSubmissionCreation] return_submission_creation_request
938
+ # Optional parameter: Example:
939
+ # @return [ReturnSubmissionCreationResponse] response from the API call
940
+ def create_return_submission(id,
941
+ return_id,
942
+ return_submission_creation_request: nil)
943
+ new_api_call_builder
944
+ .request(new_request_builder(HttpMethodEnum::POST,
945
+ '/transaction/payments/{id}/returns/{returnId}/submissions',
946
+ Server::DEFAULT)
947
+ .template_param(new_parameter(id, key: 'id')
948
+ .should_encode(true))
949
+ .template_param(new_parameter(return_id, key: 'returnId')
950
+ .should_encode(true))
951
+ .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
952
+ .body_param(new_parameter(return_submission_creation_request))
953
+ .header_param(new_parameter('application/json', key: 'accept'))
954
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
955
+ .auth(Single.new('OAuth2')))
956
+ .response(new_response_handler
957
+ .deserializer(APIHelper.method(:custom_type_deserializer))
958
+ .deserialize_into(ReturnSubmissionCreationResponse.method(:from_hash))
959
+ .local_error('400',
960
+ 'Return submission creation error',
961
+ ApiErrorException))
962
+ .execute
963
+ end
964
+
965
+ # Fetch return submission
966
+ # @param [UUID | String] id Required parameter: Payment Id
967
+ # @param [UUID | String] return_id Required parameter: Return Id
968
+ # @param [UUID | String] submission_id Required parameter: Submission Id
969
+ # @return [ReturnSubmissionDetailsResponse] response from the API call
970
+ def fetch_return_submission(id,
971
+ return_id,
972
+ submission_id)
973
+ new_api_call_builder
974
+ .request(new_request_builder(HttpMethodEnum::GET,
975
+ '/transaction/payments/{id}/returns/{returnId}/submissions/{submissionId}',
976
+ Server::DEFAULT)
977
+ .template_param(new_parameter(id, key: 'id')
978
+ .should_encode(true))
979
+ .template_param(new_parameter(return_id, key: 'returnId')
980
+ .should_encode(true))
981
+ .template_param(new_parameter(submission_id, key: 'submissionId')
982
+ .should_encode(true))
983
+ .header_param(new_parameter('application/json', key: 'accept'))
984
+ .auth(Single.new('OAuth2')))
985
+ .response(new_response_handler
986
+ .deserializer(APIHelper.method(:custom_type_deserializer))
987
+ .deserialize_into(ReturnSubmissionDetailsResponse.method(:from_hash)))
988
+ .execute
989
+ end
990
+
991
+ # Create reversal
992
+ # @param [UUID | String] id Required parameter: Payment Id
993
+ # @param [ReversalCreation] reversal_creation_request Optional parameter:
994
+ # Example:
995
+ # @return [ReversalCreationResponse] response from the API call
996
+ def create_reversal(id,
997
+ reversal_creation_request: nil)
998
+ new_api_call_builder
999
+ .request(new_request_builder(HttpMethodEnum::POST,
1000
+ '/transaction/payments/{id}/reversals',
1001
+ Server::DEFAULT)
1002
+ .template_param(new_parameter(id, key: 'id')
1003
+ .should_encode(true))
1004
+ .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
1005
+ .body_param(new_parameter(reversal_creation_request))
1006
+ .header_param(new_parameter('application/json', key: 'accept'))
1007
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
1008
+ .auth(Single.new('OAuth2')))
1009
+ .response(new_response_handler
1010
+ .deserializer(APIHelper.method(:custom_type_deserializer))
1011
+ .deserialize_into(ReversalCreationResponse.method(:from_hash))
1012
+ .local_error('400',
1013
+ 'Reversal creation error',
1014
+ ApiErrorException))
1015
+ .execute
1016
+ end
1017
+
1018
+ # Fetch reversal
1019
+ # @param [UUID | String] id Required parameter: Payment Id
1020
+ # @param [UUID | String] reversal_id Required parameter: Reversal Id
1021
+ # @return [ReversalDetailsResponse] response from the API call
1022
+ def fetch_reversal(id,
1023
+ reversal_id)
1024
+ new_api_call_builder
1025
+ .request(new_request_builder(HttpMethodEnum::GET,
1026
+ '/transaction/payments/{id}/reversals/{reversalId}',
1027
+ Server::DEFAULT)
1028
+ .template_param(new_parameter(id, key: 'id')
1029
+ .should_encode(true))
1030
+ .template_param(new_parameter(reversal_id, key: 'reversalId')
1031
+ .should_encode(true))
1032
+ .header_param(new_parameter('application/json', key: 'accept'))
1033
+ .auth(Single.new('OAuth2')))
1034
+ .response(new_response_handler
1035
+ .deserializer(APIHelper.method(:custom_type_deserializer))
1036
+ .deserialize_into(ReversalDetailsResponse.method(:from_hash)))
1037
+ .execute
1038
+ end
1039
+
1040
+ # Fetch reversal admission
1041
+ # @param [UUID | String] id Required parameter: Payment Id
1042
+ # @param [UUID | String] reversal_id Required parameter: Reversal Id
1043
+ # @param [UUID | String] admission_id Required parameter: Admission Id
1044
+ # @return [ReversalAdmissionDetailsResponse] response from the API call
1045
+ def fetch_reversal_admission(id,
1046
+ reversal_id,
1047
+ admission_id)
1048
+ new_api_call_builder
1049
+ .request(new_request_builder(HttpMethodEnum::GET,
1050
+ '/transaction/payments/{id}/reversals/{reversalId}/admissions/{admissionId}',
1051
+ Server::DEFAULT)
1052
+ .template_param(new_parameter(id, key: 'id')
1053
+ .should_encode(true))
1054
+ .template_param(new_parameter(reversal_id, key: 'reversalId')
1055
+ .should_encode(true))
1056
+ .template_param(new_parameter(admission_id, key: 'admissionId')
1057
+ .should_encode(true))
1058
+ .header_param(new_parameter('application/json', key: 'accept'))
1059
+ .auth(Single.new('OAuth2')))
1060
+ .response(new_response_handler
1061
+ .deserializer(APIHelper.method(:custom_type_deserializer))
1062
+ .deserialize_into(ReversalAdmissionDetailsResponse.method(:from_hash)))
1063
+ .execute
1064
+ end
1065
+
1066
+ # Create reversal submission
1067
+ # @param [UUID | String] id Required parameter: Payment Id
1068
+ # @param [UUID | String] reversal_id Required parameter: Reversal Id
1069
+ # @param [ReversalSubmissionCreation] reversal_submission_creation_request
1070
+ # Optional parameter: Example:
1071
+ # @return [ReversalSubmissionCreationResponse] response from the API call
1072
+ def create_reversal_submission(id,
1073
+ reversal_id,
1074
+ reversal_submission_creation_request: nil)
1075
+ new_api_call_builder
1076
+ .request(new_request_builder(HttpMethodEnum::POST,
1077
+ '/transaction/payments/{id}/reversals/{reversalId}/submissions',
1078
+ Server::DEFAULT)
1079
+ .template_param(new_parameter(id, key: 'id')
1080
+ .should_encode(true))
1081
+ .template_param(new_parameter(reversal_id, key: 'reversalId')
1082
+ .should_encode(true))
1083
+ .header_param(new_parameter('application/vnc.api+json', key: 'Content-Type'))
1084
+ .body_param(new_parameter(reversal_submission_creation_request))
1085
+ .header_param(new_parameter('application/json', key: 'accept'))
1086
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
1087
+ .auth(Single.new('OAuth2')))
1088
+ .response(new_response_handler
1089
+ .deserializer(APIHelper.method(:custom_type_deserializer))
1090
+ .deserialize_into(ReversalSubmissionCreationResponse.method(:from_hash))
1091
+ .local_error('400',
1092
+ 'Reversal submission creation error',
1093
+ ApiErrorException))
1094
+ .execute
1095
+ end
1096
+
1097
+ # Fetch reversal submission
1098
+ # @param [UUID | String] id Required parameter: Payment Id
1099
+ # @param [UUID | String] reversal_id Required parameter: Reversal Id
1100
+ # @param [UUID | String] submission_id Required parameter: Submission Id
1101
+ # @return [ReversalSubmissionDetailsResponse] response from the API call
1102
+ def fetch_reversal_submission(id,
1103
+ reversal_id,
1104
+ submission_id)
1105
+ new_api_call_builder
1106
+ .request(new_request_builder(HttpMethodEnum::GET,
1107
+ '/transaction/payments/{id}/reversals/{reversalId}/submissions/{submissionId}',
1108
+ Server::DEFAULT)
1109
+ .template_param(new_parameter(id, key: 'id')
1110
+ .should_encode(true))
1111
+ .template_param(new_parameter(reversal_id, key: 'reversalId')
1112
+ .should_encode(true))
1113
+ .template_param(new_parameter(submission_id, key: 'submissionId')
1114
+ .should_encode(true))
1115
+ .header_param(new_parameter('application/json', key: 'accept'))
1116
+ .auth(Single.new('OAuth2')))
1117
+ .response(new_response_handler
1118
+ .deserializer(APIHelper.method(:custom_type_deserializer))
1119
+ .deserialize_into(ReversalSubmissionDetailsResponse.method(:from_hash)))
1120
+ .execute
1121
+ end
1122
+
1123
+ # create submission
1124
+ # @param [UUID | String] id Required parameter: Payment Id
1125
+ # @param [PaymentSubmissionCreation] submission_creation_request Optional
1126
+ # parameter: Example:
1127
+ # @return [PaymentSubmissionCreationResponse] response from the API call
1128
+ def create_submission(id,
1129
+ submission_creation_request: nil)
1130
+ new_api_call_builder
1131
+ .request(new_request_builder(HttpMethodEnum::POST,
1132
+ '/transaction/payments/{id}/submissions',
1133
+ Server::DEFAULT)
1134
+ .template_param(new_parameter(id, key: 'id')
1135
+ .should_encode(true))
1136
+ .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
1137
+ .body_param(new_parameter(submission_creation_request))
1138
+ .header_param(new_parameter('application/json', key: 'accept'))
1139
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
1140
+ .auth(Single.new('OAuth2')))
1141
+ .response(new_response_handler
1142
+ .deserializer(APIHelper.method(:custom_type_deserializer))
1143
+ .deserialize_into(PaymentSubmissionCreationResponse.method(:from_hash))
1144
+ .local_error('400',
1145
+ 'Submission creation error',
1146
+ ApiErrorException))
1147
+ .execute
1148
+ end
1149
+
1150
+ # Fetch submission
1151
+ # @param [UUID | String] id Required parameter: Payment Id
1152
+ # @param [UUID | String] submission_id Required parameter: Submission Id
1153
+ # @return [PaymentSubmissionDetailsResponse] response from the API call
1154
+ def fetch_submission(id,
1155
+ submission_id)
1156
+ new_api_call_builder
1157
+ .request(new_request_builder(HttpMethodEnum::GET,
1158
+ '/transaction/payments/{id}/submissions/{submissionId}',
1159
+ Server::DEFAULT)
1160
+ .template_param(new_parameter(id, key: 'id')
1161
+ .should_encode(true))
1162
+ .template_param(new_parameter(submission_id, key: 'submissionId')
1163
+ .should_encode(true))
1164
+ .header_param(new_parameter('application/json', key: 'accept'))
1165
+ .auth(Single.new('OAuth2')))
1166
+ .response(new_response_handler
1167
+ .deserializer(APIHelper.method(:custom_type_deserializer))
1168
+ .deserialize_into(PaymentSubmissionDetailsResponse.method(:from_hash)))
1169
+ .execute
1170
+ end
1171
+
1172
+ # Patch Payment Submission Task
1173
+ # @param [UUID | String] id Required parameter: Payment Id
1174
+ # @param [UUID | String] submission_id Required parameter: Submission Id
1175
+ # @param [UUID | String] task_id Required parameter: Payment Submission Task
1176
+ # Id
1177
+ # @param [PaymentSubmissionTaskAmendment]
1178
+ # payment_submission_task_patch_request Optional parameter: Example:
1179
+ # @return [PaymentSubmissionTaskDetailsResponse] response from the API call
1180
+ def patch_payment_submission_task(id,
1181
+ submission_id,
1182
+ task_id,
1183
+ payment_submission_task_patch_request: nil)
1184
+ new_api_call_builder
1185
+ .request(new_request_builder(HttpMethodEnum::PATCH,
1186
+ '/transaction/payments/{id}/submissions/{submissionId}/tasks/{taskId}',
1187
+ Server::DEFAULT)
1188
+ .template_param(new_parameter(id, key: 'id')
1189
+ .should_encode(true))
1190
+ .template_param(new_parameter(submission_id, key: 'submissionId')
1191
+ .should_encode(true))
1192
+ .template_param(new_parameter(task_id, key: 'taskId')
1193
+ .should_encode(true))
1194
+ .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
1195
+ .body_param(new_parameter(payment_submission_task_patch_request))
1196
+ .header_param(new_parameter('application/json', key: 'accept'))
1197
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
1198
+ .auth(Single.new('OAuth2')))
1199
+ .response(new_response_handler
1200
+ .deserializer(APIHelper.method(:custom_type_deserializer))
1201
+ .deserialize_into(PaymentSubmissionTaskDetailsResponse.method(:from_hash))
1202
+ .local_error('400',
1203
+ 'Error',
1204
+ ApiErrorException)
1205
+ .local_error('409',
1206
+ 'Conflict',
1207
+ ApiErrorException))
1208
+ .execute
1209
+ end
1210
+
1211
+ # Patch Return Submission Task
1212
+ # @param [UUID | String] payment_id Required parameter: Payment ID
1213
+ # @param [UUID | String] return_id Required parameter: Return ID
1214
+ # @param [UUID | String] return_submission_id Required parameter: Return
1215
+ # Submission ID
1216
+ # @param [UUID | String] task_id Required parameter: Return Submission Task
1217
+ # Id
1218
+ # @param [ReturnSubmissionTaskAmendment]
1219
+ # return_submission_task_patch_request Optional parameter: Example:
1220
+ # @return [ReturnSubmissionTaskDetailsResponse] response from the API call
1221
+ def patch_return_submission_task(payment_id,
1222
+ return_id,
1223
+ return_submission_id,
1224
+ task_id,
1225
+ return_submission_task_patch_request: nil)
1226
+ new_api_call_builder
1227
+ .request(new_request_builder(HttpMethodEnum::PATCH,
1228
+ '/transaction/payments/{paymentId}/returns/{returnId}/submissions/{returnSubmissionId}/tasks/{taskId}',
1229
+ Server::DEFAULT)
1230
+ .template_param(new_parameter(payment_id, key: 'paymentId')
1231
+ .should_encode(true))
1232
+ .template_param(new_parameter(return_id, key: 'returnId')
1233
+ .should_encode(true))
1234
+ .template_param(new_parameter(return_submission_id, key: 'returnSubmissionId')
1235
+ .should_encode(true))
1236
+ .template_param(new_parameter(task_id, key: 'taskId')
1237
+ .should_encode(true))
1238
+ .header_param(new_parameter('application/vnd.api+json', key: 'Content-Type'))
1239
+ .body_param(new_parameter(return_submission_task_patch_request))
1240
+ .header_param(new_parameter('application/json', key: 'accept'))
1241
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
1242
+ .auth(Single.new('OAuth2')))
1243
+ .response(new_response_handler
1244
+ .deserializer(APIHelper.method(:custom_type_deserializer))
1245
+ .deserialize_into(ReturnSubmissionTaskDetailsResponse.method(:from_hash))
1246
+ .local_error('400',
1247
+ 'Error',
1248
+ ApiErrorException)
1249
+ .local_error('409',
1250
+ 'Conflict',
1251
+ ApiErrorException))
1252
+ .execute
1253
+ end
1254
+ end
1255
+ end