packageruby 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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,571 @@
1
+ # form3_public_api
2
+ #
3
+ # This file was automatically generated by APIMATIC v2.0
4
+ # ( https://apimatic.io ).
5
+
6
+ require 'date'
7
+ module Form3PublicApi
8
+ # PaymentAttributes Model.
9
+ class PaymentAttributes < BaseModel
10
+ SKIP = Object.new
11
+ private_constant :SKIP
12
+
13
+ # Block to represent a Financial Institution/agent in the payment chain
14
+ # @return [Array[Agent]]
15
+ attr_accessor :agents
16
+
17
+ # Amount of money moved between the instructing agent and instructed agent
18
+ # @return [String]
19
+ attr_accessor :amount
20
+
21
+ # Amount of money moved between the instructing agent and instructed agent
22
+ # @return [String]
23
+ attr_accessor :batch_booking_indicator
24
+
25
+ # Amount of money moved between the instructing agent and instructed agent
26
+ # @return [String]
27
+ attr_accessor :batch_id
28
+
29
+ # Amount of money moved between the instructing agent and instructed agent
30
+ # @return [String]
31
+ attr_accessor :batch_type
32
+
33
+ # Amount of money moved between the instructing agent and instructed agent
34
+ # @return [BeneficiaryParty1]
35
+ attr_accessor :beneficiary_party
36
+
37
+ # Category purpose in proprietary form. Specifies the high level purpose of
38
+ # the instruction. Cannot be used at the same time as
39
+ # `category_purpose_coded`.
40
+ # @return [String]
41
+ attr_accessor :category_purpose
42
+
43
+ # Category purpose in a coded form. Specifies the high level purpose of the
44
+ # instruction. Cannot be used at the same time as `category_purpose`.
45
+ # @return [String]
46
+ attr_accessor :category_purpose_coded
47
+
48
+ # Category purpose in a coded form. Specifies the high level purpose of the
49
+ # instruction. Cannot be used at the same time as `category_purpose`.
50
+ # @return [ChargesInformation]
51
+ attr_accessor :charges_information
52
+
53
+ # Unique identifier for organisations collecting payments
54
+ # @return [String]
55
+ attr_accessor :clearing_id
56
+
57
+ # Currency of the transaction amount. Currency code as defined in [ISO
58
+ # 4217](http://www.iso.org/iso/home/standards/currency_codes.htm)
59
+ # @return [String]
60
+ attr_accessor :currency
61
+
62
+ # Currency of the transaction amount. Currency code as defined in [ISO
63
+ # 4217](http://www.iso.org/iso/home/standards/currency_codes.htm)
64
+ # @return [DebtorParty]
65
+ attr_accessor :debtor_party
66
+
67
+ # Unique identification, as assigned by the initiating party, to
68
+ # unambiguously identify the transaction. This identification is passed on,
69
+ # unchanged, throughout the entire end-to-end chain.
70
+ # @return [String]
71
+ attr_accessor :end_to_end_reference
72
+
73
+ # Unique identification, as assigned by the initiating party, to
74
+ # unambiguously identify the transaction. This identification is passed on,
75
+ # unchanged, throughout the entire end-to-end chain.
76
+ # @return [String]
77
+ attr_accessor :file_number
78
+
79
+ # Unique identification, as assigned by the initiating party, to
80
+ # unambiguously identify the transaction. This identification is passed on,
81
+ # unchanged, throughout the entire end-to-end chain.
82
+ # @return [Fx]
83
+ attr_accessor :fx
84
+
85
+ # Unique identification, as assigned by the initiating party to
86
+ # unambiguously identify the transaction. This identification is an
87
+ # point-to-point reference and is passed on, unchanged, throughout the
88
+ # entire chain. Cannot include leading, trailing or internal spaces.
89
+ # @return [String]
90
+ attr_accessor :instruction_id
91
+
92
+ # Unique identification, as assigned by the initiating party to
93
+ # unambiguously identify the transaction. This identification is an
94
+ # point-to-point reference and is passed on, unchanged, throughout the
95
+ # entire chain. Cannot include leading, trailing or internal spaces.
96
+ # @return [IntermediaryBankAccountHoldingEntity]
97
+ attr_accessor :intermediary_bank
98
+
99
+ # Numeric reference field, see scheme specific descriptions for usage
100
+ # @return [String]
101
+ attr_accessor :numeric_reference
102
+
103
+ # Timestamp of when the payment instruction meets the set processing
104
+ # conditions. Format: YYYY-MM-DDThh:mm:ss:mmm+hh:mm
105
+ # @return [DateTime]
106
+ attr_accessor :payment_acceptance_datetime
107
+
108
+ # Purpose of the payment in a proprietary form
109
+ # @return [String]
110
+ attr_accessor :payment_purpose
111
+
112
+ # Purpose of the payment in a coded form
113
+ # @return [String]
114
+ attr_accessor :payment_purpose_coded
115
+
116
+ # Clearing infrastructure through which the payment instruction is to be
117
+ # processed. Default for given organisation ID is used if left empty. Has to
118
+ # be a valid [scheme
119
+ # identifier](http://draft-api-docs.form3.tech/api.html#enumerations-schemes
120
+ # ).
121
+ # @return [String]
122
+ attr_accessor :payment_scheme
123
+
124
+ # Clearing infrastructure through which the payment instruction is to be
125
+ # processed. Default for given organisation ID is used if left empty. Has to
126
+ # be a valid [scheme
127
+ # identifier](http://draft-api-docs.form3.tech/api.html#enumerations-schemes
128
+ # ).
129
+ # @return [String]
130
+ attr_accessor :payment_type
131
+
132
+ # Date on which the payment is to be debited from the debtor account.
133
+ # Formatted according to ISO 8601 format: YYYY-MM-DD.
134
+ # @return [Date]
135
+ attr_accessor :processing_date
136
+
137
+ # Date on which the payment is to be debited from the debtor account.
138
+ # Formatted according to ISO 8601 format: YYYY-MM-DD.
139
+ # @return [ReceiversCorrespondentAccountHoldingEntity]
140
+ attr_accessor :receivers_correspondent
141
+
142
+ # Payment reference for beneficiary use
143
+ # @return [String]
144
+ attr_accessor :reference
145
+
146
+ # Block to represent a list of references
147
+ # @return [Array[Reference]]
148
+ attr_accessor :references
149
+
150
+ # Regulatory reporting information
151
+ # @return [String]
152
+ attr_accessor :regulatory_reporting
153
+
154
+ # Regulatory reporting information
155
+ # @return [ReimbursementAccountHoldingEntity]
156
+ attr_accessor :reimbursement
157
+
158
+ # Information supplied to enable the matching of an entry with the items
159
+ # that the transfer is intended to settle, such as commercial invoices in an
160
+ # accounts receivable system provided by the debtor for the beneficiary.
161
+ # @return [String]
162
+ attr_accessor :remittance_information
163
+
164
+ # The scheme specific payment [sub
165
+ # type](http://api-docs.form3.tech/api.html#enumerations-scheme-specific-pay
166
+ # ment-sub-types)
167
+ # @return [String]
168
+ attr_accessor :scheme_payment_sub_type
169
+
170
+ # The [scheme-specific payment type](#enumerations-scheme-payment-types)
171
+ # @return [String]
172
+ attr_accessor :scheme_payment_type
173
+
174
+ # Date on which the payment is processed by the scheme. Only used if
175
+ # different from `processing_date`.
176
+ # @return [Date]
177
+ attr_accessor :scheme_processing_date
178
+
179
+ # Unique identification, as assigned by the first instructing agent, to
180
+ # unambiguously identify the transaction that is passed on, unchanged,
181
+ # throughout the entire interbank chain.
182
+ # @return [String]
183
+ attr_accessor :scheme_transaction_id
184
+
185
+ # Unique identification, as assigned by the first instructing agent, to
186
+ # unambiguously identify the transaction that is passed on, unchanged,
187
+ # throughout the entire interbank chain.
188
+ # @return [SendersCorrespondentAccountHoldingEntity]
189
+ attr_accessor :senders_correspondent
190
+
191
+ # Specifies the details on how the settlement of the transaction between the
192
+ # instructing agent and the instructed agent is completed
193
+ # @return [Settlement]
194
+ attr_accessor :settlement
195
+
196
+ # Specifies the details on how the settlement of the transaction between the
197
+ # instructing agent and the instructed agent is completed
198
+ # @return [StructuredReference]
199
+ attr_accessor :structured_reference
200
+
201
+ # Specifies the details on how the settlement of the transaction between the
202
+ # instructing agent and the instructed agent is completed
203
+ # @return [Swift]
204
+ attr_accessor :swift
205
+
206
+ # Specifies the details on how the settlement of the transaction between the
207
+ # instructing agent and the instructed agent is completed
208
+ # @return [UltimateEntity]
209
+ attr_accessor :ultimate_beneficiary
210
+
211
+ # Specifies the details on how the settlement of the transaction between the
212
+ # instructing agent and the instructed agent is completed
213
+ # @return [UltimateEntity]
214
+ attr_accessor :ultimate_debtor
215
+
216
+ # The scheme-specific unique transaction ID. Populated by the scheme.
217
+ # @return [String]
218
+ attr_accessor :unique_scheme_id
219
+
220
+ # All purpose list of key-value pairs specific data stored on the payment.
221
+ # @return [Array[UserDefinedData]]
222
+ attr_accessor :user_defined_data
223
+
224
+ # A mapping from model property names to API property names.
225
+ def self.names
226
+ @_hash = {} if @_hash.nil?
227
+ @_hash['agents'] = 'agents'
228
+ @_hash['amount'] = 'amount'
229
+ @_hash['batch_booking_indicator'] = 'batch_booking_indicator'
230
+ @_hash['batch_id'] = 'batch_id'
231
+ @_hash['batch_type'] = 'batch_type'
232
+ @_hash['beneficiary_party'] = 'beneficiary_party'
233
+ @_hash['category_purpose'] = 'category_purpose'
234
+ @_hash['category_purpose_coded'] = 'category_purpose_coded'
235
+ @_hash['charges_information'] = 'charges_information'
236
+ @_hash['clearing_id'] = 'clearing_id'
237
+ @_hash['currency'] = 'currency'
238
+ @_hash['debtor_party'] = 'debtor_party'
239
+ @_hash['end_to_end_reference'] = 'end_to_end_reference'
240
+ @_hash['file_number'] = 'file_number'
241
+ @_hash['fx'] = 'fx'
242
+ @_hash['instruction_id'] = 'instruction_id'
243
+ @_hash['intermediary_bank'] = 'intermediary_bank'
244
+ @_hash['numeric_reference'] = 'numeric_reference'
245
+ @_hash['payment_acceptance_datetime'] = 'payment_acceptance_datetime'
246
+ @_hash['payment_purpose'] = 'payment_purpose'
247
+ @_hash['payment_purpose_coded'] = 'payment_purpose_coded'
248
+ @_hash['payment_scheme'] = 'payment_scheme'
249
+ @_hash['payment_type'] = 'payment_type'
250
+ @_hash['processing_date'] = 'processing_date'
251
+ @_hash['receivers_correspondent'] = 'receivers_correspondent'
252
+ @_hash['reference'] = 'reference'
253
+ @_hash['references'] = 'references'
254
+ @_hash['regulatory_reporting'] = 'regulatory_reporting'
255
+ @_hash['reimbursement'] = 'reimbursement'
256
+ @_hash['remittance_information'] = 'remittance_information'
257
+ @_hash['scheme_payment_sub_type'] = 'scheme_payment_sub_type'
258
+ @_hash['scheme_payment_type'] = 'scheme_payment_type'
259
+ @_hash['scheme_processing_date'] = 'scheme_processing_date'
260
+ @_hash['scheme_transaction_id'] = 'scheme_transaction_id'
261
+ @_hash['senders_correspondent'] = 'senders_correspondent'
262
+ @_hash['settlement'] = 'settlement'
263
+ @_hash['structured_reference'] = 'structured_reference'
264
+ @_hash['swift'] = 'swift'
265
+ @_hash['ultimate_beneficiary'] = 'ultimate_beneficiary'
266
+ @_hash['ultimate_debtor'] = 'ultimate_debtor'
267
+ @_hash['unique_scheme_id'] = 'unique_scheme_id'
268
+ @_hash['user_defined_data'] = 'user_defined_data'
269
+ @_hash
270
+ end
271
+
272
+ # An array for optional fields
273
+ def self.optionals
274
+ %w[
275
+ agents
276
+ amount
277
+ batch_booking_indicator
278
+ batch_id
279
+ batch_type
280
+ beneficiary_party
281
+ category_purpose
282
+ category_purpose_coded
283
+ charges_information
284
+ clearing_id
285
+ currency
286
+ debtor_party
287
+ end_to_end_reference
288
+ file_number
289
+ fx
290
+ instruction_id
291
+ intermediary_bank
292
+ numeric_reference
293
+ payment_acceptance_datetime
294
+ payment_purpose
295
+ payment_purpose_coded
296
+ payment_scheme
297
+ payment_type
298
+ processing_date
299
+ receivers_correspondent
300
+ reference
301
+ references
302
+ regulatory_reporting
303
+ reimbursement
304
+ remittance_information
305
+ scheme_payment_sub_type
306
+ scheme_payment_type
307
+ scheme_processing_date
308
+ scheme_transaction_id
309
+ senders_correspondent
310
+ settlement
311
+ structured_reference
312
+ swift
313
+ ultimate_beneficiary
314
+ ultimate_debtor
315
+ unique_scheme_id
316
+ user_defined_data
317
+ ]
318
+ end
319
+
320
+ # An array for nullable fields
321
+ def self.nullables
322
+ []
323
+ end
324
+
325
+ def initialize(agents = SKIP,
326
+ amount = SKIP,
327
+ batch_booking_indicator = SKIP,
328
+ batch_id = SKIP,
329
+ batch_type = SKIP,
330
+ beneficiary_party = SKIP,
331
+ category_purpose = SKIP,
332
+ category_purpose_coded = SKIP,
333
+ charges_information = SKIP,
334
+ clearing_id = SKIP,
335
+ currency = SKIP,
336
+ debtor_party = SKIP,
337
+ end_to_end_reference = SKIP,
338
+ file_number = SKIP,
339
+ fx = SKIP,
340
+ instruction_id = SKIP,
341
+ intermediary_bank = SKIP,
342
+ numeric_reference = SKIP,
343
+ payment_acceptance_datetime = SKIP,
344
+ payment_purpose = SKIP,
345
+ payment_purpose_coded = SKIP,
346
+ payment_scheme = SKIP,
347
+ payment_type = SKIP,
348
+ processing_date = SKIP,
349
+ receivers_correspondent = SKIP,
350
+ reference = SKIP,
351
+ references = SKIP,
352
+ regulatory_reporting = SKIP,
353
+ reimbursement = SKIP,
354
+ remittance_information = SKIP,
355
+ scheme_payment_sub_type = SKIP,
356
+ scheme_payment_type = SKIP,
357
+ scheme_processing_date = SKIP,
358
+ scheme_transaction_id = SKIP,
359
+ senders_correspondent = SKIP,
360
+ settlement = SKIP,
361
+ structured_reference = SKIP,
362
+ swift = SKIP,
363
+ ultimate_beneficiary = SKIP,
364
+ ultimate_debtor = SKIP,
365
+ unique_scheme_id = SKIP,
366
+ user_defined_data = SKIP)
367
+ @agents = agents unless agents == SKIP
368
+ @amount = amount unless amount == SKIP
369
+ @batch_booking_indicator = batch_booking_indicator unless batch_booking_indicator == SKIP
370
+ @batch_id = batch_id unless batch_id == SKIP
371
+ @batch_type = batch_type unless batch_type == SKIP
372
+ @beneficiary_party = beneficiary_party unless beneficiary_party == SKIP
373
+ @category_purpose = category_purpose unless category_purpose == SKIP
374
+ @category_purpose_coded = category_purpose_coded unless category_purpose_coded == SKIP
375
+ @charges_information = charges_information unless charges_information == SKIP
376
+ @clearing_id = clearing_id unless clearing_id == SKIP
377
+ @currency = currency unless currency == SKIP
378
+ @debtor_party = debtor_party unless debtor_party == SKIP
379
+ @end_to_end_reference = end_to_end_reference unless end_to_end_reference == SKIP
380
+ @file_number = file_number unless file_number == SKIP
381
+ @fx = fx unless fx == SKIP
382
+ @instruction_id = instruction_id unless instruction_id == SKIP
383
+ @intermediary_bank = intermediary_bank unless intermediary_bank == SKIP
384
+ @numeric_reference = numeric_reference unless numeric_reference == SKIP
385
+ unless payment_acceptance_datetime == SKIP
386
+ @payment_acceptance_datetime =
387
+ payment_acceptance_datetime
388
+ end
389
+ @payment_purpose = payment_purpose unless payment_purpose == SKIP
390
+ @payment_purpose_coded = payment_purpose_coded unless payment_purpose_coded == SKIP
391
+ @payment_scheme = payment_scheme unless payment_scheme == SKIP
392
+ @payment_type = payment_type unless payment_type == SKIP
393
+ @processing_date = processing_date unless processing_date == SKIP
394
+ @receivers_correspondent = receivers_correspondent unless receivers_correspondent == SKIP
395
+ @reference = reference unless reference == SKIP
396
+ @references = references unless references == SKIP
397
+ @regulatory_reporting = regulatory_reporting unless regulatory_reporting == SKIP
398
+ @reimbursement = reimbursement unless reimbursement == SKIP
399
+ @remittance_information = remittance_information unless remittance_information == SKIP
400
+ @scheme_payment_sub_type = scheme_payment_sub_type unless scheme_payment_sub_type == SKIP
401
+ @scheme_payment_type = scheme_payment_type unless scheme_payment_type == SKIP
402
+ @scheme_processing_date = scheme_processing_date unless scheme_processing_date == SKIP
403
+ @scheme_transaction_id = scheme_transaction_id unless scheme_transaction_id == SKIP
404
+ @senders_correspondent = senders_correspondent unless senders_correspondent == SKIP
405
+ @settlement = settlement unless settlement == SKIP
406
+ @structured_reference = structured_reference unless structured_reference == SKIP
407
+ @swift = swift unless swift == SKIP
408
+ @ultimate_beneficiary = ultimate_beneficiary unless ultimate_beneficiary == SKIP
409
+ @ultimate_debtor = ultimate_debtor unless ultimate_debtor == SKIP
410
+ @unique_scheme_id = unique_scheme_id unless unique_scheme_id == SKIP
411
+ @user_defined_data = user_defined_data unless user_defined_data == SKIP
412
+ end
413
+
414
+ # Creates an instance of the object from a hash.
415
+ def self.from_hash(hash)
416
+ return nil unless hash
417
+
418
+ # Extract variables from the hash.
419
+ # Parameter is an array, so we need to iterate through it
420
+ agents = nil
421
+ unless hash['agents'].nil?
422
+ agents = []
423
+ hash['agents'].each do |structure|
424
+ agents << (Agent.from_hash(structure) if structure)
425
+ end
426
+ end
427
+
428
+ agents = SKIP unless hash.key?('agents')
429
+ amount = hash.key?('amount') ? hash['amount'] : SKIP
430
+ batch_booking_indicator =
431
+ hash.key?('batch_booking_indicator') ? hash['batch_booking_indicator'] : SKIP
432
+ batch_id = hash.key?('batch_id') ? hash['batch_id'] : SKIP
433
+ batch_type = hash.key?('batch_type') ? hash['batch_type'] : SKIP
434
+ beneficiary_party = BeneficiaryParty1.from_hash(hash['beneficiary_party']) if
435
+ hash['beneficiary_party']
436
+ category_purpose =
437
+ hash.key?('category_purpose') ? hash['category_purpose'] : SKIP
438
+ category_purpose_coded =
439
+ hash.key?('category_purpose_coded') ? hash['category_purpose_coded'] : SKIP
440
+ charges_information = ChargesInformation.from_hash(hash['charges_information']) if
441
+ hash['charges_information']
442
+ clearing_id = hash.key?('clearing_id') ? hash['clearing_id'] : SKIP
443
+ currency = hash.key?('currency') ? hash['currency'] : SKIP
444
+ debtor_party = DebtorParty.from_hash(hash['debtor_party']) if hash['debtor_party']
445
+ end_to_end_reference =
446
+ hash.key?('end_to_end_reference') ? hash['end_to_end_reference'] : SKIP
447
+ file_number = hash.key?('file_number') ? hash['file_number'] : SKIP
448
+ fx = Fx.from_hash(hash['fx']) if hash['fx']
449
+ instruction_id =
450
+ hash.key?('instruction_id') ? hash['instruction_id'] : SKIP
451
+ if hash['intermediary_bank']
452
+ intermediary_bank = IntermediaryBankAccountHoldingEntity.from_hash(hash['intermediary_bank'])
453
+ end
454
+ numeric_reference =
455
+ hash.key?('numeric_reference') ? hash['numeric_reference'] : SKIP
456
+ payment_acceptance_datetime = if hash.key?('payment_acceptance_datetime')
457
+ (DateTimeHelper.from_rfc3339(hash['payment_acceptance_datetime']) if hash['payment_acceptance_datetime'])
458
+ else
459
+ SKIP
460
+ end
461
+ payment_purpose =
462
+ hash.key?('payment_purpose') ? hash['payment_purpose'] : SKIP
463
+ payment_purpose_coded =
464
+ hash.key?('payment_purpose_coded') ? hash['payment_purpose_coded'] : SKIP
465
+ payment_scheme =
466
+ hash.key?('payment_scheme') ? hash['payment_scheme'] : SKIP
467
+ payment_type = hash.key?('payment_type') ? hash['payment_type'] : SKIP
468
+ processing_date =
469
+ hash.key?('processing_date') ? hash['processing_date'] : SKIP
470
+ if hash['receivers_correspondent']
471
+ receivers_correspondent = ReceiversCorrespondentAccountHoldingEntity.from_hash(hash['receivers_correspondent'])
472
+ end
473
+ reference = hash.key?('reference') ? hash['reference'] : SKIP
474
+ # Parameter is an array, so we need to iterate through it
475
+ references = nil
476
+ unless hash['references'].nil?
477
+ references = []
478
+ hash['references'].each do |structure|
479
+ references << (Reference.from_hash(structure) if structure)
480
+ end
481
+ end
482
+
483
+ references = SKIP unless hash.key?('references')
484
+ regulatory_reporting =
485
+ hash.key?('regulatory_reporting') ? hash['regulatory_reporting'] : SKIP
486
+ reimbursement = ReimbursementAccountHoldingEntity.from_hash(hash['reimbursement']) if
487
+ hash['reimbursement']
488
+ remittance_information =
489
+ hash.key?('remittance_information') ? hash['remittance_information'] : SKIP
490
+ scheme_payment_sub_type =
491
+ hash.key?('scheme_payment_sub_type') ? hash['scheme_payment_sub_type'] : SKIP
492
+ scheme_payment_type =
493
+ hash.key?('scheme_payment_type') ? hash['scheme_payment_type'] : SKIP
494
+ scheme_processing_date =
495
+ hash.key?('scheme_processing_date') ? hash['scheme_processing_date'] : SKIP
496
+ scheme_transaction_id =
497
+ hash.key?('scheme_transaction_id') ? hash['scheme_transaction_id'] : SKIP
498
+ if hash['senders_correspondent']
499
+ senders_correspondent = SendersCorrespondentAccountHoldingEntity.from_hash(hash['senders_correspondent'])
500
+ end
501
+ settlement = Settlement.from_hash(hash['settlement']) if hash['settlement']
502
+ structured_reference = StructuredReference.from_hash(hash['structured_reference']) if
503
+ hash['structured_reference']
504
+ swift = Swift.from_hash(hash['swift']) if hash['swift']
505
+ ultimate_beneficiary = UltimateEntity.from_hash(hash['ultimate_beneficiary']) if
506
+ hash['ultimate_beneficiary']
507
+ ultimate_debtor = UltimateEntity.from_hash(hash['ultimate_debtor']) if
508
+ hash['ultimate_debtor']
509
+ unique_scheme_id =
510
+ hash.key?('unique_scheme_id') ? hash['unique_scheme_id'] : SKIP
511
+ # Parameter is an array, so we need to iterate through it
512
+ user_defined_data = nil
513
+ unless hash['user_defined_data'].nil?
514
+ user_defined_data = []
515
+ hash['user_defined_data'].each do |structure|
516
+ user_defined_data << (UserDefinedData.from_hash(structure) if structure)
517
+ end
518
+ end
519
+
520
+ user_defined_data = SKIP unless hash.key?('user_defined_data')
521
+
522
+ # Create object from extracted values.
523
+ PaymentAttributes.new(agents,
524
+ amount,
525
+ batch_booking_indicator,
526
+ batch_id,
527
+ batch_type,
528
+ beneficiary_party,
529
+ category_purpose,
530
+ category_purpose_coded,
531
+ charges_information,
532
+ clearing_id,
533
+ currency,
534
+ debtor_party,
535
+ end_to_end_reference,
536
+ file_number,
537
+ fx,
538
+ instruction_id,
539
+ intermediary_bank,
540
+ numeric_reference,
541
+ payment_acceptance_datetime,
542
+ payment_purpose,
543
+ payment_purpose_coded,
544
+ payment_scheme,
545
+ payment_type,
546
+ processing_date,
547
+ receivers_correspondent,
548
+ reference,
549
+ references,
550
+ regulatory_reporting,
551
+ reimbursement,
552
+ remittance_information,
553
+ scheme_payment_sub_type,
554
+ scheme_payment_type,
555
+ scheme_processing_date,
556
+ scheme_transaction_id,
557
+ senders_correspondent,
558
+ settlement,
559
+ structured_reference,
560
+ swift,
561
+ ultimate_beneficiary,
562
+ ultimate_debtor,
563
+ unique_scheme_id,
564
+ user_defined_data)
565
+ end
566
+
567
+ def to_custom_payment_acceptance_datetime
568
+ DateTimeHelper.to_rfc3339(payment_acceptance_datetime)
569
+ end
570
+ end
571
+ end
@@ -0,0 +1,50 @@
1
+ # form3_public_api
2
+ #
3
+ # This file was automatically generated by APIMATIC v2.0
4
+ # ( https://apimatic.io ).
5
+
6
+ module Form3PublicApi
7
+ # PaymentCreation Model.
8
+ class PaymentCreation < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # TODO: Write general description for this method
13
+ # @return [NewPayment]
14
+ attr_accessor :data
15
+
16
+ # A mapping from model property names to API property names.
17
+ def self.names
18
+ @_hash = {} if @_hash.nil?
19
+ @_hash['data'] = 'data'
20
+ @_hash
21
+ end
22
+
23
+ # An array for optional fields
24
+ def self.optionals
25
+ %w[
26
+ data
27
+ ]
28
+ end
29
+
30
+ # An array for nullable fields
31
+ def self.nullables
32
+ []
33
+ end
34
+
35
+ def initialize(data = SKIP)
36
+ @data = data unless data == SKIP
37
+ end
38
+
39
+ # Creates an instance of the object from a hash.
40
+ def self.from_hash(hash)
41
+ return nil unless hash
42
+
43
+ # Extract variables from the hash.
44
+ data = NewPayment.from_hash(hash['data']) if hash['data']
45
+
46
+ # Create object from extracted values.
47
+ PaymentCreation.new(data)
48
+ end
49
+ end
50
+ end
@@ -0,0 +1,60 @@
1
+ # form3_public_api
2
+ #
3
+ # This file was automatically generated by APIMATIC v2.0
4
+ # ( https://apimatic.io ).
5
+
6
+ module Form3PublicApi
7
+ # PaymentCreationResponse Model.
8
+ class PaymentCreationResponse < BaseModel
9
+ SKIP = Object.new
10
+ private_constant :SKIP
11
+
12
+ # TODO: Write general description for this method
13
+ # @return [Payment]
14
+ attr_accessor :data
15
+
16
+ # TODO: Write general description for this method
17
+ # @return [Links]
18
+ attr_accessor :links
19
+
20
+ # A mapping from model property names to API property names.
21
+ def self.names
22
+ @_hash = {} if @_hash.nil?
23
+ @_hash['data'] = 'data'
24
+ @_hash['links'] = 'links'
25
+ @_hash
26
+ end
27
+
28
+ # An array for optional fields
29
+ def self.optionals
30
+ %w[
31
+ data
32
+ links
33
+ ]
34
+ end
35
+
36
+ # An array for nullable fields
37
+ def self.nullables
38
+ []
39
+ end
40
+
41
+ def initialize(data = SKIP,
42
+ links = SKIP)
43
+ @data = data unless data == SKIP
44
+ @links = links unless links == SKIP
45
+ end
46
+
47
+ # Creates an instance of the object from a hash.
48
+ def self.from_hash(hash)
49
+ return nil unless hash
50
+
51
+ # Extract variables from the hash.
52
+ data = Payment.from_hash(hash['data']) if hash['data']
53
+ links = Links.from_hash(hash['links']) if hash['links']
54
+
55
+ # Create object from extracted values.
56
+ PaymentCreationResponse.new(data,
57
+ links)
58
+ end
59
+ end
60
+ end