treezor_client 1.12.0 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (268) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/Gemfile.lock +8 -7
  4. data/docs/BusinessApi.md +2 -2
  5. data/docs/Payin.md +1 -1
  6. data/docs/PayinApi.md +2 -2
  7. data/docs/Payinrefund.md +1 -1
  8. data/docs/PayinrefundApi.md +4 -4
  9. data/generate.sh +10 -0
  10. data/lib/treezor_client/api/balance_api.rb +1 -1
  11. data/lib/treezor_client/api/bankaccount_api.rb +1 -1
  12. data/lib/treezor_client/api/beneficiaries_api.rb +1 -1
  13. data/lib/treezor_client/api/business_api.rb +4 -4
  14. data/lib/treezor_client/api/card_api.rb +1 -1
  15. data/lib/treezor_client/api/card_digitalizations_api.rb +1 -1
  16. data/lib/treezor_client/api/card_reserve_api.rb +1 -1
  17. data/lib/treezor_client/api/cardtransaction_api.rb +1 -1
  18. data/lib/treezor_client/api/country_restriction_groups_api.rb +1 -1
  19. data/lib/treezor_client/api/document_api.rb +1 -1
  20. data/lib/treezor_client/api/heartbeat_api.rb +1 -1
  21. data/lib/treezor_client/api/issuer_initiated_digitization_data_api.rb +1 -1
  22. data/lib/treezor_client/api/mandate_api.rb +1 -1
  23. data/lib/treezor_client/api/mcc_restriction_groups_api.rb +1 -1
  24. data/lib/treezor_client/api/merchant_id_restriction_groups_api.rb +1 -1
  25. data/lib/treezor_client/api/payin_api.rb +3 -3
  26. data/lib/treezor_client/api/payinrefund_api.rb +3 -3
  27. data/lib/treezor_client/api/payout_api.rb +1 -1
  28. data/lib/treezor_client/api/payout_refunds_api.rb +1 -1
  29. data/lib/treezor_client/api/tax_residence_api.rb +1 -1
  30. data/lib/treezor_client/api/transaction_api.rb +1 -1
  31. data/lib/treezor_client/api/transfer_api.rb +1 -1
  32. data/lib/treezor_client/api/transferrefund_api.rb +1 -1
  33. data/lib/treezor_client/api/user_api.rb +1 -1
  34. data/lib/treezor_client/api/virtualibans_api.rb +1 -1
  35. data/lib/treezor_client/api/wallet_api.rb +1 -1
  36. data/lib/treezor_client/api_client.rb +6 -4
  37. data/lib/treezor_client/api_error.rb +1 -1
  38. data/lib/treezor_client/configuration.rb +3 -3
  39. data/lib/treezor_client/models/balance.rb +3 -2
  40. data/lib/treezor_client/models/bankaccount.rb +3 -2
  41. data/lib/treezor_client/models/beneficiaries_sdd_b2b_whitelist.rb +3 -2
  42. data/lib/treezor_client/models/beneficiary.rb +3 -2
  43. data/lib/treezor_client/models/body.rb +3 -2
  44. data/lib/treezor_client/models/body_1.rb +3 -2
  45. data/lib/treezor_client/models/body_10.rb +3 -2
  46. data/lib/treezor_client/models/body_11.rb +3 -2
  47. data/lib/treezor_client/models/body_2.rb +3 -2
  48. data/lib/treezor_client/models/body_3.rb +3 -2
  49. data/lib/treezor_client/models/body_4.rb +3 -2
  50. data/lib/treezor_client/models/body_5.rb +3 -2
  51. data/lib/treezor_client/models/body_6.rb +3 -2
  52. data/lib/treezor_client/models/body_7.rb +3 -2
  53. data/lib/treezor_client/models/body_8.rb +3 -2
  54. data/lib/treezor_client/models/body_9.rb +3 -2
  55. data/lib/treezor_client/models/businesssearchs_businessinformations.rb +3 -2
  56. data/lib/treezor_client/models/card.rb +3 -2
  57. data/lib/treezor_client/models/card_digitalization.rb +3 -2
  58. data/lib/treezor_client/models/country_restriction_group.rb +3 -2
  59. data/lib/treezor_client/models/document.rb +3 -2
  60. data/lib/treezor_client/models/error.rb +3 -2
  61. data/lib/treezor_client/models/inline_response_200.rb +3 -2
  62. data/lib/treezor_client/models/inline_response_200_1.rb +3 -2
  63. data/lib/treezor_client/models/inline_response_200_10.rb +3 -2
  64. data/lib/treezor_client/models/inline_response_200_10_cardtransactions.rb +3 -2
  65. data/lib/treezor_client/models/inline_response_200_11.rb +3 -2
  66. data/lib/treezor_client/models/inline_response_200_12.rb +3 -2
  67. data/lib/treezor_client/models/inline_response_200_13.rb +3 -2
  68. data/lib/treezor_client/models/inline_response_200_14.rb +3 -2
  69. data/lib/treezor_client/models/inline_response_200_15.rb +3 -2
  70. data/lib/treezor_client/models/inline_response_200_16.rb +3 -2
  71. data/lib/treezor_client/models/inline_response_200_17.rb +3 -2
  72. data/lib/treezor_client/models/inline_response_200_18.rb +3 -2
  73. data/lib/treezor_client/models/inline_response_200_19.rb +3 -2
  74. data/lib/treezor_client/models/inline_response_200_2.rb +3 -2
  75. data/lib/treezor_client/models/inline_response_200_20.rb +3 -2
  76. data/lib/treezor_client/models/inline_response_200_21.rb +3 -2
  77. data/lib/treezor_client/models/inline_response_200_22.rb +3 -2
  78. data/lib/treezor_client/models/inline_response_200_23.rb +3 -2
  79. data/lib/treezor_client/models/inline_response_200_24.rb +3 -2
  80. data/lib/treezor_client/models/inline_response_200_25.rb +3 -2
  81. data/lib/treezor_client/models/inline_response_200_26.rb +3 -2
  82. data/lib/treezor_client/models/inline_response_200_27.rb +3 -2
  83. data/lib/treezor_client/models/inline_response_200_28.rb +3 -2
  84. data/lib/treezor_client/models/inline_response_200_3.rb +3 -2
  85. data/lib/treezor_client/models/inline_response_200_4.rb +3 -2
  86. data/lib/treezor_client/models/inline_response_200_4_businessinformations.rb +3 -2
  87. data/lib/treezor_client/models/inline_response_200_4_users.rb +3 -2
  88. data/lib/treezor_client/models/inline_response_200_5.rb +3 -2
  89. data/lib/treezor_client/models/inline_response_200_6.rb +3 -2
  90. data/lib/treezor_client/models/inline_response_200_6_cardimages.rb +3 -2
  91. data/lib/treezor_client/models/inline_response_200_7.rb +3 -2
  92. data/lib/treezor_client/models/inline_response_200_8.rb +3 -2
  93. data/lib/treezor_client/models/inline_response_200_9.rb +3 -2
  94. data/lib/treezor_client/models/inline_response_200_9_cardtransactions.rb +3 -2
  95. data/lib/treezor_client/models/inline_response_default.rb +3 -2
  96. data/lib/treezor_client/models/issuer_initiated_digitization_data.rb +3 -2
  97. data/lib/treezor_client/models/issuer_initiated_digitization_datas_additionnal_data.rb +3 -2
  98. data/lib/treezor_client/models/mandate.rb +3 -2
  99. data/lib/treezor_client/models/mcc_restriction_group.rb +3 -2
  100. data/lib/treezor_client/models/merchant_id_restriction_group.rb +3 -2
  101. data/lib/treezor_client/models/payin.rb +4 -3
  102. data/lib/treezor_client/models/payinrefund.rb +4 -3
  103. data/lib/treezor_client/models/payout.rb +3 -2
  104. data/lib/treezor_client/models/payout_refund.rb +3 -2
  105. data/lib/treezor_client/models/tax_residence.rb +3 -2
  106. data/lib/treezor_client/models/transaction.rb +3 -2
  107. data/lib/treezor_client/models/transfer.rb +3 -2
  108. data/lib/treezor_client/models/transferrefund.rb +3 -2
  109. data/lib/treezor_client/models/user.rb +3 -2
  110. data/lib/treezor_client/models/virtualiban.rb +3 -2
  111. data/lib/treezor_client/models/wallet.rb +3 -2
  112. data/lib/treezor_client/version.rb +2 -2
  113. data/lib/treezor_client.rb +1 -1
  114. data/pkg/{treezor_client-1.4.0.gem → treezor_client-1.12.0.gem} +0 -0
  115. data/pkg/treezor_client-2.0.0.gem +0 -0
  116. data/treezor_api_spec.yaml +5 -5
  117. data/treezor_client.gemspec +2 -1
  118. metadata +28 -156
  119. data/doc/TreezorClient/ApiClient.html +0 -2600
  120. data/doc/TreezorClient/ApiError.html +0 -464
  121. data/doc/TreezorClient/Balance.html +0 -2042
  122. data/doc/TreezorClient/BalanceApi.html +0 -760
  123. data/doc/TreezorClient/Bankaccount/EnumAttributeValidator.html +0 -455
  124. data/doc/TreezorClient/Bankaccount.html +0 -2560
  125. data/doc/TreezorClient/BankaccountApi.html +0 -2450
  126. data/doc/TreezorClient/BeneficiariesApi.html +0 -2387
  127. data/doc/TreezorClient/BeneficiariesSddB2bWhitelist.html +0 -1816
  128. data/doc/TreezorClient/Beneficiary.html +0 -2574
  129. data/doc/TreezorClient/Body/EnumAttributeValidator.html +0 -455
  130. data/doc/TreezorClient/Body.html +0 -1826
  131. data/doc/TreezorClient/Body1.html +0 -2596
  132. data/doc/TreezorClient/Body10/EnumAttributeValidator.html +0 -455
  133. data/doc/TreezorClient/Body10.html +0 -2069
  134. data/doc/TreezorClient/Body2.html +0 -2492
  135. data/doc/TreezorClient/Body3.html +0 -1726
  136. data/doc/TreezorClient/Body4.html +0 -1726
  137. data/doc/TreezorClient/Body5/EnumAttributeValidator.html +0 -455
  138. data/doc/TreezorClient/Body5.html +0 -2001
  139. data/doc/TreezorClient/Body6/EnumAttributeValidator.html +0 -455
  140. data/doc/TreezorClient/Body6.html +0 -2069
  141. data/doc/TreezorClient/Body7/EnumAttributeValidator.html +0 -455
  142. data/doc/TreezorClient/Body7.html +0 -2002
  143. data/doc/TreezorClient/Body8/EnumAttributeValidator.html +0 -455
  144. data/doc/TreezorClient/Body8.html +0 -1981
  145. data/doc/TreezorClient/Body9/EnumAttributeValidator.html +0 -455
  146. data/doc/TreezorClient/Body9.html +0 -2001
  147. data/doc/TreezorClient/BusinessApi.html +0 -1548
  148. data/doc/TreezorClient/BusinesssearchsBusinessinformations/EnumAttributeValidator.html +0 -455
  149. data/doc/TreezorClient/BusinesssearchsBusinessinformations.html +0 -2822
  150. data/doc/TreezorClient/Card/EnumAttributeValidator.html +0 -455
  151. data/doc/TreezorClient/Card.html +0 -6928
  152. data/doc/TreezorClient/CardApi.html +0 -9907
  153. data/doc/TreezorClient/CardDigitalization.html +0 -2126
  154. data/doc/TreezorClient/CardDigitalizationDetailsFromGPS.html +0 -4343
  155. data/doc/TreezorClient/CardDigitalizationsApi.html +0 -1542
  156. data/doc/TreezorClient/CardReserveApi.html +0 -1622
  157. data/doc/TreezorClient/CardtransactionApi.html +0 -1243
  158. data/doc/TreezorClient/Configuration.html +0 -2459
  159. data/doc/TreezorClient/CountryRestrictionGroupsApi.html +0 -2602
  160. data/doc/TreezorClient/Document/EnumAttributeValidator.html +0 -455
  161. data/doc/TreezorClient/Document.html +0 -2812
  162. data/doc/TreezorClient/DocumentApi.html +0 -2878
  163. data/doc/TreezorClient/Error.html +0 -1794
  164. data/doc/TreezorClient/HeartbeatApi.html +0 -702
  165. data/doc/TreezorClient/InlineResponse200.html +0 -1626
  166. data/doc/TreezorClient/InlineResponse2001.html +0 -1626
  167. data/doc/TreezorClient/InlineResponse20010.html +0 -1626
  168. data/doc/TreezorClient/InlineResponse20010Cardtransactions.html +0 -5844
  169. data/doc/TreezorClient/InlineResponse20011.html +0 -1626
  170. data/doc/TreezorClient/InlineResponse20012.html +0 -1626
  171. data/doc/TreezorClient/InlineResponse20013.html +0 -1626
  172. data/doc/TreezorClient/InlineResponse20014.html +0 -1626
  173. data/doc/TreezorClient/InlineResponse20015.html +0 -1626
  174. data/doc/TreezorClient/InlineResponse20016.html +0 -1626
  175. data/doc/TreezorClient/InlineResponse20017.html +0 -1626
  176. data/doc/TreezorClient/InlineResponse20018.html +0 -1626
  177. data/doc/TreezorClient/InlineResponse20019.html +0 -1626
  178. data/doc/TreezorClient/InlineResponse2002.html +0 -1626
  179. data/doc/TreezorClient/InlineResponse20020.html +0 -1626
  180. data/doc/TreezorClient/InlineResponse20021.html +0 -1626
  181. data/doc/TreezorClient/InlineResponse20022.html +0 -1626
  182. data/doc/TreezorClient/InlineResponse20023.html +0 -1626
  183. data/doc/TreezorClient/InlineResponse20024.html +0 -1626
  184. data/doc/TreezorClient/InlineResponse20025.html +0 -1626
  185. data/doc/TreezorClient/InlineResponse2003.html +0 -1626
  186. data/doc/TreezorClient/InlineResponse2004.html +0 -1626
  187. data/doc/TreezorClient/InlineResponse2005.html +0 -1626
  188. data/doc/TreezorClient/InlineResponse2005Businessinformations/EnumAttributeValidator.html +0 -455
  189. data/doc/TreezorClient/InlineResponse2005Businessinformations.html +0 -3561
  190. data/doc/TreezorClient/InlineResponse2005Users/EnumAttributeValidator.html +0 -455
  191. data/doc/TreezorClient/InlineResponse2005Users.html +0 -1972
  192. data/doc/TreezorClient/InlineResponse2006.html +0 -1626
  193. data/doc/TreezorClient/InlineResponse2007.html +0 -1626
  194. data/doc/TreezorClient/InlineResponse2007Cardimages.html +0 -1800
  195. data/doc/TreezorClient/InlineResponse2008.html +0 -1626
  196. data/doc/TreezorClient/InlineResponse2009.html +0 -1790
  197. data/doc/TreezorClient/InlineResponseDefault.html +0 -1626
  198. data/doc/TreezorClient/IssuerInitiatedDigitizationDataApi.html +0 -1371
  199. data/doc/TreezorClient/IssuerInitiatedDigitizationDatasAdditionnalData.html +0 -1803
  200. data/doc/TreezorClient/IssuerInitiatedDigitizationDatasAdditionnalDataECCPublicCertificates.html +0 -1804
  201. data/doc/TreezorClient/Mandate/EnumAttributeValidator.html +0 -455
  202. data/doc/TreezorClient/Mandate.html +0 -4584
  203. data/doc/TreezorClient/MandateApi.html +0 -3787
  204. data/doc/TreezorClient/MccRestrictionGroup/EnumAttributeValidator.html +0 -455
  205. data/doc/TreezorClient/MccRestrictionGroup.html +0 -2144
  206. data/doc/TreezorClient/MccRestrictionGroupsApi.html +0 -2598
  207. data/doc/TreezorClient/MerchantIdRestrictionGroup/EnumAttributeValidator.html +0 -455
  208. data/doc/TreezorClient/MerchantIdRestrictionGroup.html +0 -2144
  209. data/doc/TreezorClient/MerchantIdRestrictionGroupsApi.html +0 -2638
  210. data/doc/TreezorClient/Payin/EnumAttributeValidator.html +0 -455
  211. data/doc/TreezorClient/Payin.html +0 -5584
  212. data/doc/TreezorClient/PayinApi.html +0 -2963
  213. data/doc/TreezorClient/Payinrefund/EnumAttributeValidator.html +0 -455
  214. data/doc/TreezorClient/Payinrefund.html +0 -2476
  215. data/doc/TreezorClient/PayinrefundApi.html +0 -2449
  216. data/doc/TreezorClient/Payout/EnumAttributeValidator.html +0 -455
  217. data/doc/TreezorClient/Payout.html +0 -3488
  218. data/doc/TreezorClient/PayoutApi.html +0 -2737
  219. data/doc/TreezorClient/Tav.html +0 -2130
  220. data/doc/TreezorClient/Transaction.html +0 -2798
  221. data/doc/TreezorClient/TransactionApi.html +0 -1491
  222. data/doc/TreezorClient/Transfer/EnumAttributeValidator.html +0 -455
  223. data/doc/TreezorClient/Transfer.html +0 -3158
  224. data/doc/TreezorClient/TransferApi.html +0 -2725
  225. data/doc/TreezorClient/Transferrefund/EnumAttributeValidator.html +0 -455
  226. data/doc/TreezorClient/Transferrefund.html +0 -2644
  227. data/doc/TreezorClient/TransferrefundApi.html +0 -2450
  228. data/doc/TreezorClient/User/EnumAttributeValidator.html +0 -455
  229. data/doc/TreezorClient/User.html +0 -5844
  230. data/doc/TreezorClient/UserApi.html +0 -6647
  231. data/doc/TreezorClient/Virtualiban.html +0 -2462
  232. data/doc/TreezorClient/VirtualibansApi.html +0 -2845
  233. data/doc/TreezorClient/Wallet/EnumAttributeValidator.html +0 -455
  234. data/doc/TreezorClient/Wallet.html +0 -4076
  235. data/doc/TreezorClient/WalletApi.html +0 -3944
  236. data/doc/TreezorClient.html +0 -251
  237. data/doc/_index.html +0 -1025
  238. data/doc/class_list.html +0 -51
  239. data/doc/css/common.css +0 -1
  240. data/doc/css/full_list.css +0 -58
  241. data/doc/css/style.css +0 -496
  242. data/doc/file.README.html +0 -636
  243. data/doc/file_list.html +0 -56
  244. data/doc/frames.html +0 -17
  245. data/doc/index.html +0 -636
  246. data/doc/js/app.js +0 -292
  247. data/doc/js/full_list.js +0 -216
  248. data/doc/js/jquery.js +0 -4
  249. data/doc/method_list.html +0 -15699
  250. data/doc/top-level-namespace.html +0 -110
  251. data/docs/CardDigitalizationDetailsFromGPS.md +0 -40
  252. data/docs/InlineResponse20011Cardtransactions.md +0 -58
  253. data/docs/InlineResponse2005Businessinformations.md +0 -26
  254. data/docs/InlineResponse2005Users.md +0 -12
  255. data/docs/InlineResponse2007Cardimages.md +0 -10
  256. data/docs/IssuerInitiatedDigitizationDatasAdditionnalDataECCPublicCertificates.md +0 -10
  257. data/docs/Tav.md +0 -14
  258. data/lib/treezor_client/models/card_digitalization_details_from_gps.rb +0 -509
  259. data/lib/treezor_client/models/inline_response_200_11_cardtransactions.rb +0 -637
  260. data/lib/treezor_client/models/inline_response_200_5_businessinformations.rb +0 -447
  261. data/lib/treezor_client/models/inline_response_200_5_users.rb +0 -258
  262. data/lib/treezor_client/models/inline_response_200_7_cardimages.rb +0 -219
  263. data/lib/treezor_client/models/issuer_initiated_digitization_datas_additionnal_data_ecc_public_certificates.rb +0 -209
  264. data/lib/treezor_client/models/tav.rb +0 -241
  265. data/pkg/treezor_client-1.0.0.gem +0 -0
  266. data/pkg/treezor_client-1.1.0.gem +0 -0
  267. data/pkg/treezor_client-1.2.0.gem +0 -0
  268. data/pkg/treezor_client-1.3.0.gem +0 -0
@@ -1,3787 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <title>
7
- Class: TreezorClient::MandateApi
8
-
9
- &mdash; Documentation by YARD 0.9.15
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
-
15
- <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
-
17
- <script type="text/javascript" charset="utf-8">
18
- pathId = "TreezorClient::MandateApi";
19
- relpath = '../';
20
- </script>
21
-
22
-
23
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
-
25
- <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div class="nav_wrap">
31
- <iframe id="nav" src="../class_list.html?1"></iframe>
32
- <div id="resizer"></div>
33
- </div>
34
-
35
- <div id="main" tabindex="-1">
36
- <div id="header">
37
- <div id="menu">
38
-
39
- <a href="../_index.html">Index (M)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../TreezorClient.html" title="TreezorClient (module)">TreezorClient</a></span></span>
41
- &raquo;
42
- <span class="title">MandateApi</span>
43
-
44
- </div>
45
-
46
- <div id="search">
47
-
48
- <a class="full_list_link" id="class_list_link"
49
- href="../class_list.html">
50
-
51
- <svg width="24" height="24">
52
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
- </svg>
56
- </a>
57
-
58
- </div>
59
- <div class="clear"></div>
60
- </div>
61
-
62
- <div id="content"><h1>Class: TreezorClient::MandateApi
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
- <dl>
70
- <dt>Inherits:</dt>
71
- <dd>
72
- <span class="inheritName">Object</span>
73
-
74
- <ul class="fullTree">
75
- <li>Object</li>
76
-
77
- <li class="next">TreezorClient::MandateApi</li>
78
-
79
- </ul>
80
- <a href="#" class="inheritanceTree">show all</a>
81
-
82
- </dd>
83
- </dl>
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
- <dl>
96
- <dt>Defined in:</dt>
97
- <dd>lib/treezor_client/api/mandate_api.rb</dd>
98
- </dl>
99
-
100
- </div>
101
-
102
-
103
-
104
-
105
-
106
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
107
- <ul class="summary">
108
-
109
- <li class="public ">
110
- <span class="summary_signature">
111
-
112
- <a href="#api_client-instance_method" title="#api_client (instance method)">#<strong>api_client</strong> &#x21d2; Object </a>
113
-
114
-
115
-
116
- </span>
117
-
118
-
119
-
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
-
128
-
129
- <span class="summary_desc"><div class='inline'>
130
- <p>Returns the value of attribute api_client.</p>
131
- </div></span>
132
-
133
- </li>
134
-
135
-
136
- </ul>
137
-
138
-
139
-
140
-
141
-
142
- <h2>
143
- Instance Method Summary
144
- <small><a href="#" class="summary_toggle">collapse</a></small>
145
- </h2>
146
-
147
- <ul class="summary">
148
-
149
- <li class="public ">
150
- <span class="summary_signature">
151
-
152
- <a href="#delete_mandate-instance_method" title="#delete_mandate (instance method)">#<strong>delete_mandate</strong>(id, origin, opts = {}) &#x21d2; InlineResponse20012 </a>
153
-
154
-
155
-
156
- </span>
157
-
158
-
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
- <span class="summary_desc"><div class='inline'>
167
- <p>revoke a mandate Change mandate&#39;s status to canceled.</p>
168
- </div></span>
169
-
170
- </li>
171
-
172
-
173
- <li class="public ">
174
- <span class="summary_signature">
175
-
176
- <a href="#delete_mandate_with_http_info-instance_method" title="#delete_mandate_with_http_info (instance method)">#<strong>delete_mandate_with_http_info</strong>(id, origin, opts = {}) &#x21d2; Array&lt;(InlineResponse20012, Fixnum, Hash)&gt; </a>
177
-
178
-
179
-
180
- </span>
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
-
189
-
190
- <span class="summary_desc"><div class='inline'>
191
- <p>revoke a mandate Change mandate&amp;#39;s status to canceled.</p>
192
- </div></span>
193
-
194
- </li>
195
-
196
-
197
- <li class="public ">
198
- <span class="summary_signature">
199
-
200
- <a href="#get_mandate-instance_method" title="#get_mandate (instance method)">#<strong>get_mandate</strong>(id, opts = {}) &#x21d2; InlineResponse20012 </a>
201
-
202
-
203
-
204
- </span>
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
-
213
-
214
- <span class="summary_desc"><div class='inline'>
215
- <p>get mandate Get a mandate from the system.</p>
216
- </div></span>
217
-
218
- </li>
219
-
220
-
221
- <li class="public ">
222
- <span class="summary_signature">
223
-
224
- <a href="#get_mandate_with_http_info-instance_method" title="#get_mandate_with_http_info (instance method)">#<strong>get_mandate_with_http_info</strong>(id, opts = {}) &#x21d2; Array&lt;(InlineResponse20012, Fixnum, Hash)&gt; </a>
225
-
226
-
227
-
228
- </span>
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
-
237
-
238
- <span class="summary_desc"><div class='inline'>
239
- <p>get mandate Get a mandate from the system.</p>
240
- </div></span>
241
-
242
- </li>
243
-
244
-
245
- <li class="public ">
246
- <span class="summary_signature">
247
-
248
- <a href="#get_mandates-instance_method" title="#get_mandates (instance method)">#<strong>get_mandates</strong>(opts = {}) &#x21d2; InlineResponse20012 </a>
249
-
250
-
251
-
252
- </span>
253
-
254
-
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
- <span class="summary_desc"><div class='inline'>
263
- <p>search mandates Get mandates that match search criteria.</p>
264
- </div></span>
265
-
266
- </li>
267
-
268
-
269
- <li class="public ">
270
- <span class="summary_signature">
271
-
272
- <a href="#get_mandates_with_http_info-instance_method" title="#get_mandates_with_http_info (instance method)">#<strong>get_mandates_with_http_info</strong>(opts = {}) &#x21d2; Array&lt;(InlineResponse20012, Fixnum, Hash)&gt; </a>
273
-
274
-
275
-
276
- </span>
277
-
278
-
279
-
280
-
281
-
282
-
283
-
284
-
285
-
286
- <span class="summary_desc"><div class='inline'>
287
- <p>search mandates Get mandates that match search criteria.</p>
288
- </div></span>
289
-
290
- </li>
291
-
292
-
293
- <li class="public ">
294
- <span class="summary_signature">
295
-
296
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(api_client = ApiClient.default) &#x21d2; MandateApi </a>
297
-
298
-
299
-
300
- </span>
301
-
302
-
303
- <span class="note title constructor">constructor</span>
304
-
305
-
306
-
307
-
308
-
309
-
310
-
311
-
312
- <span class="summary_desc"><div class='inline'>
313
- <p>A new instance of MandateApi.</p>
314
- </div></span>
315
-
316
- </li>
317
-
318
-
319
- <li class="public ">
320
- <span class="summary_signature">
321
-
322
- <a href="#mandates_id_resend_otp_put-instance_method" title="#mandates_id_resend_otp_put (instance method)">#<strong>mandates_id_resend_otp_put</strong>(id, access_token, access_signature, user_id, opts = {}) &#x21d2; InlineResponse20012 </a>
323
-
324
-
325
-
326
- </span>
327
-
328
-
329
-
330
-
331
-
332
-
333
-
334
-
335
-
336
- <span class="summary_desc"><div class='inline'>
337
- <p>send an OTP Send an OTP to sign a specific mandate.</p>
338
- </div></span>
339
-
340
- </li>
341
-
342
-
343
- <li class="public ">
344
- <span class="summary_signature">
345
-
346
- <a href="#mandates_id_resend_otp_put_with_http_info-instance_method" title="#mandates_id_resend_otp_put_with_http_info (instance method)">#<strong>mandates_id_resend_otp_put_with_http_info</strong>(id, access_token, access_signature, user_id, opts = {}) &#x21d2; Array&lt;(InlineResponse20012, Fixnum, Hash)&gt; </a>
347
-
348
-
349
-
350
- </span>
351
-
352
-
353
-
354
-
355
-
356
-
357
-
358
-
359
-
360
- <span class="summary_desc"><div class='inline'>
361
- <p>send an OTP Send an OTP to sign a specific mandate.</p>
362
- </div></span>
363
-
364
- </li>
365
-
366
-
367
- <li class="public ">
368
- <span class="summary_signature">
369
-
370
- <a href="#mandates_id_sign_put-instance_method" title="#mandates_id_sign_put (instance method)">#<strong>mandates_id_sign_put</strong>(id, access_token, access_signature, user_id, otp, opts = {}) &#x21d2; InlineResponse20012 </a>
371
-
372
-
373
-
374
- </span>
375
-
376
-
377
-
378
-
379
-
380
-
381
-
382
-
383
-
384
- <span class="summary_desc"><div class='inline'>
385
- <p>sign a mandate Sign a mandate with the received OTP.</p>
386
- </div></span>
387
-
388
- </li>
389
-
390
-
391
- <li class="public ">
392
- <span class="summary_signature">
393
-
394
- <a href="#mandates_id_sign_put_with_http_info-instance_method" title="#mandates_id_sign_put_with_http_info (instance method)">#<strong>mandates_id_sign_put_with_http_info</strong>(id, access_token, access_signature, user_id, otp, opts = {}) &#x21d2; Array&lt;(InlineResponse20012, Fixnum, Hash)&gt; </a>
395
-
396
-
397
-
398
- </span>
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
- <span class="summary_desc"><div class='inline'>
409
- <p>sign a mandate Sign a mandate with the received OTP.</p>
410
- </div></span>
411
-
412
- </li>
413
-
414
-
415
- <li class="public ">
416
- <span class="summary_signature">
417
-
418
- <a href="#post_mandates-instance_method" title="#post_mandates (instance method)">#<strong>post_mandates</strong>(sdd_type, is_paper, user_id, debtor_name, debtor_address, debtor_city, debtor_zip_code, debtor_country, debtor_iban, sequence_type, created_ip, opts = {}) &#x21d2; InlineResponse20012 </a>
419
-
420
-
421
-
422
- </span>
423
-
424
-
425
-
426
-
427
-
428
-
429
-
430
-
431
-
432
- <span class="summary_desc"><div class='inline'>
433
- <p>create a mandate Create a new mandate in the system.</p>
434
- </div></span>
435
-
436
- </li>
437
-
438
-
439
- <li class="public ">
440
- <span class="summary_signature">
441
-
442
- <a href="#post_mandates_with_http_info-instance_method" title="#post_mandates_with_http_info (instance method)">#<strong>post_mandates_with_http_info</strong>(sdd_type, is_paper, user_id, debtor_name, debtor_address, debtor_city, debtor_zip_code, debtor_country, debtor_iban, sequence_type, created_ip, opts = {}) &#x21d2; Array&lt;(InlineResponse20012, Fixnum, Hash)&gt; </a>
443
-
444
-
445
-
446
- </span>
447
-
448
-
449
-
450
-
451
-
452
-
453
-
454
-
455
-
456
- <span class="summary_desc"><div class='inline'>
457
- <p>create a mandate Create a new mandate in the system.</p>
458
- </div></span>
459
-
460
- </li>
461
-
462
-
463
- </ul>
464
-
465
-
466
- <div id="constructor_details" class="method_details_list">
467
- <h2>Constructor Details</h2>
468
-
469
- <div class="method_details first">
470
- <h3 class="signature first" id="initialize-instance_method">
471
-
472
- #<strong>initialize</strong>(api_client = ApiClient.default) &#x21d2; <tt><span class='object_link'><a href="" title="TreezorClient::MandateApi (class)">MandateApi</a></span></tt>
473
-
474
-
475
-
476
-
477
-
478
- </h3><div class="docstring">
479
- <div class="discussion">
480
-
481
- <p>Returns a new instance of MandateApi</p>
482
-
483
-
484
- </div>
485
- </div>
486
- <div class="tags">
487
-
488
-
489
- </div><table class="source_code">
490
- <tr>
491
- <td>
492
- <pre class="lines">
493
-
494
-
495
- 19
496
- 20
497
- 21</pre>
498
- </td>
499
- <td>
500
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/mandate_api.rb', line 19</span>
501
-
502
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_api_client'>api_client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="ApiClient.html" title="TreezorClient::ApiClient (class)">ApiClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_default'><span class='object_link'><a href="ApiClient.html#default-class_method" title="TreezorClient::ApiClient.default (method)">default</a></span></span><span class='rparen'>)</span>
503
- <span class='ivar'>@api_client</span> <span class='op'>=</span> <span class='id identifier rubyid_api_client'>api_client</span>
504
- <span class='kw'>end</span></pre>
505
- </td>
506
- </tr>
507
- </table>
508
- </div>
509
-
510
- </div>
511
-
512
- <div id="instance_attr_details" class="attr_details">
513
- <h2>Instance Attribute Details</h2>
514
-
515
-
516
- <span id="api_client=-instance_method"></span>
517
- <div class="method_details first">
518
- <h3 class="signature first" id="api_client-instance_method">
519
-
520
- #<strong>api_client</strong> &#x21d2; <tt>Object</tt>
521
-
522
-
523
-
524
-
525
-
526
- </h3><div class="docstring">
527
- <div class="discussion">
528
-
529
- <p>Returns the value of attribute api_client</p>
530
-
531
-
532
- </div>
533
- </div>
534
- <div class="tags">
535
-
536
-
537
- </div><table class="source_code">
538
- <tr>
539
- <td>
540
- <pre class="lines">
541
-
542
-
543
- 17
544
- 18
545
- 19</pre>
546
- </td>
547
- <td>
548
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/mandate_api.rb', line 17</span>
549
-
550
- <span class='kw'>def</span> <span class='id identifier rubyid_api_client'>api_client</span>
551
- <span class='ivar'>@api_client</span>
552
- <span class='kw'>end</span></pre>
553
- </td>
554
- </tr>
555
- </table>
556
- </div>
557
-
558
- </div>
559
-
560
-
561
- <div id="instance_method_details" class="method_details_list">
562
- <h2>Instance Method Details</h2>
563
-
564
-
565
- <div class="method_details first">
566
- <h3 class="signature first" id="delete_mandate-instance_method">
567
-
568
- #<strong>delete_mandate</strong>(id, origin, opts = {}) &#x21d2; <tt><span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span></tt>
569
-
570
-
571
-
572
-
573
-
574
- </h3><div class="docstring">
575
- <div class="discussion">
576
-
577
- <p>revoke a mandate Change mandate&#39;s status to canceled.</p>
578
-
579
-
580
- </div>
581
- </div>
582
- <div class="tags">
583
- <p class="tag_title">Parameters:</p>
584
- <ul class="param">
585
-
586
- <li>
587
-
588
- <span class='name'>id</span>
589
-
590
-
591
- <span class='type'></span>
592
-
593
-
594
-
595
- &mdash;
596
- <div class='inline'>
597
- <p>Mandate&amp;#39;s internal id.</p>
598
- </div>
599
-
600
- </li>
601
-
602
- <li>
603
-
604
- <span class='name'>origin</span>
605
-
606
-
607
- <span class='type'></span>
608
-
609
-
610
-
611
- &mdash;
612
- <div class='inline'>
613
- <p>The origin of the request for revocation</p>
614
- </div>
615
-
616
- </li>
617
-
618
- <li>
619
-
620
- <span class='name'>opts</span>
621
-
622
-
623
- <span class='type'>(<tt>Hash</tt>)</span>
624
-
625
-
626
- <em class="default">(defaults to: <tt>{}</tt>)</em>
627
-
628
-
629
- &mdash;
630
- <div class='inline'>
631
- <p>the optional parameters</p>
632
- </div>
633
-
634
- </li>
635
-
636
- </ul>
637
-
638
- <p class="tag_title">Returns:</p>
639
- <ul class="return">
640
-
641
- <li>
642
-
643
-
644
- <span class='type'>(<tt><span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span></tt>)</span>
645
-
646
-
647
-
648
- </li>
649
-
650
- </ul>
651
-
652
- </div><table class="source_code">
653
- <tr>
654
- <td>
655
- <pre class="lines">
656
-
657
-
658
- 29
659
- 30
660
- 31
661
- 32</pre>
662
- </td>
663
- <td>
664
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/mandate_api.rb', line 29</span>
665
-
666
- <span class='kw'>def</span> <span class='id identifier rubyid_delete_mandate'>delete_mandate</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_origin'>origin</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
667
- <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid__status_code'>_status_code</span><span class='comma'>,</span> <span class='id identifier rubyid__headers'>_headers</span> <span class='op'>=</span> <span class='id identifier rubyid_delete_mandate_with_http_info'>delete_mandate_with_http_info</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_origin'>origin</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
668
- <span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span>
669
- <span class='kw'>end</span></pre>
670
- </td>
671
- </tr>
672
- </table>
673
- </div>
674
-
675
- <div class="method_details ">
676
- <h3 class="signature " id="delete_mandate_with_http_info-instance_method">
677
-
678
- #<strong>delete_mandate_with_http_info</strong>(id, origin, opts = {}) &#x21d2; <tt>Array&lt;(<span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span>, Fixnum, Hash)&gt;</tt>
679
-
680
-
681
-
682
-
683
-
684
- </h3><div class="docstring">
685
- <div class="discussion">
686
-
687
- <p>revoke a mandate Change mandate&amp;#39;s status to canceled.</p>
688
-
689
-
690
- </div>
691
- </div>
692
- <div class="tags">
693
- <p class="tag_title">Parameters:</p>
694
- <ul class="param">
695
-
696
- <li>
697
-
698
- <span class='name'>id</span>
699
-
700
-
701
- <span class='type'></span>
702
-
703
-
704
-
705
- &mdash;
706
- <div class='inline'>
707
- <p>Mandate&amp;#39;s internal id.</p>
708
- </div>
709
-
710
- </li>
711
-
712
- <li>
713
-
714
- <span class='name'>origin</span>
715
-
716
-
717
- <span class='type'></span>
718
-
719
-
720
-
721
- &mdash;
722
- <div class='inline'>
723
- <p>The origin of the request for revocation</p>
724
- </div>
725
-
726
- </li>
727
-
728
- <li>
729
-
730
- <span class='name'>opts</span>
731
-
732
-
733
- <span class='type'>(<tt>Hash</tt>)</span>
734
-
735
-
736
- <em class="default">(defaults to: <tt>{}</tt>)</em>
737
-
738
-
739
- &mdash;
740
- <div class='inline'>
741
- <p>the optional parameters</p>
742
- </div>
743
-
744
- </li>
745
-
746
- </ul>
747
-
748
- <p class="tag_title">Returns:</p>
749
- <ul class="return">
750
-
751
- <li>
752
-
753
-
754
- <span class='type'>(<tt>Array&lt;(<span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span>, Fixnum, Hash)&gt;</tt>)</span>
755
-
756
-
757
-
758
- &mdash;
759
- <div class='inline'>
760
- <p>InlineResponse20012 data, response status code and response headers</p>
761
- </div>
762
-
763
- </li>
764
-
765
- </ul>
766
-
767
- </div><table class="source_code">
768
- <tr>
769
- <td>
770
- <pre class="lines">
771
-
772
-
773
- 40
774
- 41
775
- 42
776
- 43
777
- 44
778
- 45
779
- 46
780
- 47
781
- 48
782
- 49
783
- 50
784
- 51
785
- 52
786
- 53
787
- 54
788
- 55
789
- 56
790
- 57
791
- 58
792
- 59
793
- 60
794
- 61
795
- 62
796
- 63
797
- 64
798
- 65
799
- 66
800
- 67
801
- 68
802
- 69
803
- 70
804
- 71
805
- 72
806
- 73
807
- 74
808
- 75
809
- 76
810
- 77
811
- 78
812
- 79
813
- 80
814
- 81
815
- 82
816
- 83
817
- 84
818
- 85
819
- 86
820
- 87</pre>
821
- </td>
822
- <td>
823
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/mandate_api.rb', line 40</span>
824
-
825
- <span class='kw'>def</span> <span class='id identifier rubyid_delete_mandate_with_http_info'>delete_mandate_with_http_info</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_origin'>origin</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
826
- <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_debugging'>debugging</span>
827
- <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Calling API: MandateApi.delete_mandate ...</span><span class='tstring_end'>&quot;</span></span>
828
- <span class='kw'>end</span>
829
- <span class='comment'># verify the required parameter &#39;id&#39; is set
830
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
831
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;id&#39; when calling MandateApi.delete_mandate</span><span class='tstring_end'>&quot;</span></span>
832
- <span class='kw'>end</span>
833
- <span class='comment'># verify the required parameter &#39;origin&#39; is set
834
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_origin'>origin</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
835
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;origin&#39; when calling MandateApi.delete_mandate</span><span class='tstring_end'>&quot;</span></span>
836
- <span class='kw'>end</span>
837
- <span class='comment'># verify enum value
838
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>CREDITOR</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DEBITOR</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_origin'>origin</span><span class='rparen'>)</span>
839
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>invalid value for &#39;origin&#39;, must be one of CREDITOR, DEBITOR</span><span class='tstring_end'>&quot;</span></span>
840
- <span class='kw'>end</span>
841
- <span class='comment'># resource path
842
- </span> <span class='id identifier rubyid_local_var_path'>local_var_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/mandates/{id}</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_sub'>sub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{</span><span class='tstring_end'>&#39;</span></span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>}</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
843
-
844
- <span class='comment'># query parameters
845
- </span> <span class='id identifier rubyid_query_params'>query_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
846
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;origin&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_origin'>origin</span>
847
-
848
- <span class='comment'># header parameters
849
- </span> <span class='id identifier rubyid_header_params'>header_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
850
- <span class='comment'># HTTP header &#39;Accept&#39; (if needed)
851
- </span> <span class='id identifier rubyid_header_params'>header_params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Accept</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_select_header_accept'>select_header_accept</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
852
- <span class='comment'># HTTP header &#39;Content-Type&#39;
853
- </span> <span class='id identifier rubyid_header_params'>header_params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_select_header_content_type'>select_header_content_type</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
854
-
855
- <span class='comment'># form parameters
856
- </span> <span class='id identifier rubyid_form_params'>form_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
857
-
858
- <span class='comment'># http body (model)
859
- </span> <span class='id identifier rubyid_post_body'>post_body</span> <span class='op'>=</span> <span class='kw'>nil</span>
860
- <span class='id identifier rubyid_auth_names'>auth_names</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>api_key</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
861
- <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_status_code'>status_code</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='symbol'>:DELETE</span><span class='comma'>,</span> <span class='id identifier rubyid_local_var_path'>local_var_path</span><span class='comma'>,</span>
862
- <span class='symbol'>:header_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_header_params'>header_params</span><span class='comma'>,</span>
863
- <span class='symbol'>:query_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_query_params'>query_params</span><span class='comma'>,</span>
864
- <span class='symbol'>:form_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_form_params'>form_params</span><span class='comma'>,</span>
865
- <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_post_body'>post_body</span><span class='comma'>,</span>
866
- <span class='symbol'>:auth_names</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_auth_names'>auth_names</span><span class='comma'>,</span>
867
- <span class='symbol'>:return_type</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>InlineResponse20012</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
868
- <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_debugging'>debugging</span>
869
- <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>API called: MandateApi#delete_mandate\nData: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>\nStatus code: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_status_code'>status_code</span><span class='embexpr_end'>}</span><span class='tstring_content'>\nHeaders: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_headers'>headers</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
870
- <span class='kw'>end</span>
871
- <span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_status_code'>status_code</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span>
872
- <span class='kw'>end</span></pre>
873
- </td>
874
- </tr>
875
- </table>
876
- </div>
877
-
878
- <div class="method_details ">
879
- <h3 class="signature " id="get_mandate-instance_method">
880
-
881
- #<strong>get_mandate</strong>(id, opts = {}) &#x21d2; <tt><span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span></tt>
882
-
883
-
884
-
885
-
886
-
887
- </h3><div class="docstring">
888
- <div class="discussion">
889
-
890
- <p>get mandate Get a mandate from the system.</p>
891
-
892
-
893
- </div>
894
- </div>
895
- <div class="tags">
896
- <p class="tag_title">Parameters:</p>
897
- <ul class="param">
898
-
899
- <li>
900
-
901
- <span class='name'>id</span>
902
-
903
-
904
- <span class='type'></span>
905
-
906
-
907
-
908
- &mdash;
909
- <div class='inline'>
910
- <p>Mandate&amp;#39;s internal id.</p>
911
- </div>
912
-
913
- </li>
914
-
915
- <li>
916
-
917
- <span class='name'>opts</span>
918
-
919
-
920
- <span class='type'>(<tt>Hash</tt>)</span>
921
-
922
-
923
- <em class="default">(defaults to: <tt>{}</tt>)</em>
924
-
925
-
926
- &mdash;
927
- <div class='inline'>
928
- <p>the optional parameters</p>
929
- </div>
930
-
931
- </li>
932
-
933
- </ul>
934
-
935
- <p class="tag_title">Returns:</p>
936
- <ul class="return">
937
-
938
- <li>
939
-
940
-
941
- <span class='type'>(<tt><span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span></tt>)</span>
942
-
943
-
944
-
945
- </li>
946
-
947
- </ul>
948
-
949
- </div><table class="source_code">
950
- <tr>
951
- <td>
952
- <pre class="lines">
953
-
954
-
955
- 94
956
- 95
957
- 96
958
- 97</pre>
959
- </td>
960
- <td>
961
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/mandate_api.rb', line 94</span>
962
-
963
- <span class='kw'>def</span> <span class='id identifier rubyid_get_mandate'>get_mandate</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
964
- <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid__status_code'>_status_code</span><span class='comma'>,</span> <span class='id identifier rubyid__headers'>_headers</span> <span class='op'>=</span> <span class='id identifier rubyid_get_mandate_with_http_info'>get_mandate_with_http_info</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
965
- <span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span>
966
- <span class='kw'>end</span></pre>
967
- </td>
968
- </tr>
969
- </table>
970
- </div>
971
-
972
- <div class="method_details ">
973
- <h3 class="signature " id="get_mandate_with_http_info-instance_method">
974
-
975
- #<strong>get_mandate_with_http_info</strong>(id, opts = {}) &#x21d2; <tt>Array&lt;(<span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span>, Fixnum, Hash)&gt;</tt>
976
-
977
-
978
-
979
-
980
-
981
- </h3><div class="docstring">
982
- <div class="discussion">
983
-
984
- <p>get mandate Get a mandate from the system.</p>
985
-
986
-
987
- </div>
988
- </div>
989
- <div class="tags">
990
- <p class="tag_title">Parameters:</p>
991
- <ul class="param">
992
-
993
- <li>
994
-
995
- <span class='name'>id</span>
996
-
997
-
998
- <span class='type'></span>
999
-
1000
-
1001
-
1002
- &mdash;
1003
- <div class='inline'>
1004
- <p>Mandate&amp;#39;s internal id.</p>
1005
- </div>
1006
-
1007
- </li>
1008
-
1009
- <li>
1010
-
1011
- <span class='name'>opts</span>
1012
-
1013
-
1014
- <span class='type'>(<tt>Hash</tt>)</span>
1015
-
1016
-
1017
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1018
-
1019
-
1020
- &mdash;
1021
- <div class='inline'>
1022
- <p>the optional parameters</p>
1023
- </div>
1024
-
1025
- </li>
1026
-
1027
- </ul>
1028
-
1029
- <p class="tag_title">Returns:</p>
1030
- <ul class="return">
1031
-
1032
- <li>
1033
-
1034
-
1035
- <span class='type'>(<tt>Array&lt;(<span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span>, Fixnum, Hash)&gt;</tt>)</span>
1036
-
1037
-
1038
-
1039
- &mdash;
1040
- <div class='inline'>
1041
- <p>InlineResponse20012 data, response status code and response headers</p>
1042
- </div>
1043
-
1044
- </li>
1045
-
1046
- </ul>
1047
-
1048
- </div><table class="source_code">
1049
- <tr>
1050
- <td>
1051
- <pre class="lines">
1052
-
1053
-
1054
- 104
1055
- 105
1056
- 106
1057
- 107
1058
- 108
1059
- 109
1060
- 110
1061
- 111
1062
- 112
1063
- 113
1064
- 114
1065
- 115
1066
- 116
1067
- 117
1068
- 118
1069
- 119
1070
- 120
1071
- 121
1072
- 122
1073
- 123
1074
- 124
1075
- 125
1076
- 126
1077
- 127
1078
- 128
1079
- 129
1080
- 130
1081
- 131
1082
- 132
1083
- 133
1084
- 134
1085
- 135
1086
- 136
1087
- 137
1088
- 138
1089
- 139
1090
- 140
1091
- 141
1092
- 142</pre>
1093
- </td>
1094
- <td>
1095
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/mandate_api.rb', line 104</span>
1096
-
1097
- <span class='kw'>def</span> <span class='id identifier rubyid_get_mandate_with_http_info'>get_mandate_with_http_info</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1098
- <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_debugging'>debugging</span>
1099
- <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Calling API: MandateApi.get_mandate ...</span><span class='tstring_end'>&quot;</span></span>
1100
- <span class='kw'>end</span>
1101
- <span class='comment'># verify the required parameter &#39;id&#39; is set
1102
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1103
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;id&#39; when calling MandateApi.get_mandate</span><span class='tstring_end'>&quot;</span></span>
1104
- <span class='kw'>end</span>
1105
- <span class='comment'># resource path
1106
- </span> <span class='id identifier rubyid_local_var_path'>local_var_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/mandates/{id}</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_sub'>sub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{</span><span class='tstring_end'>&#39;</span></span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>}</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
1107
-
1108
- <span class='comment'># query parameters
1109
- </span> <span class='id identifier rubyid_query_params'>query_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1110
-
1111
- <span class='comment'># header parameters
1112
- </span> <span class='id identifier rubyid_header_params'>header_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1113
- <span class='comment'># HTTP header &#39;Accept&#39; (if needed)
1114
- </span> <span class='id identifier rubyid_header_params'>header_params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Accept</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_select_header_accept'>select_header_accept</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
1115
- <span class='comment'># HTTP header &#39;Content-Type&#39;
1116
- </span> <span class='id identifier rubyid_header_params'>header_params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_select_header_content_type'>select_header_content_type</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
1117
-
1118
- <span class='comment'># form parameters
1119
- </span> <span class='id identifier rubyid_form_params'>form_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1120
-
1121
- <span class='comment'># http body (model)
1122
- </span> <span class='id identifier rubyid_post_body'>post_body</span> <span class='op'>=</span> <span class='kw'>nil</span>
1123
- <span class='id identifier rubyid_auth_names'>auth_names</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>api_key</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
1124
- <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_status_code'>status_code</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='symbol'>:GET</span><span class='comma'>,</span> <span class='id identifier rubyid_local_var_path'>local_var_path</span><span class='comma'>,</span>
1125
- <span class='symbol'>:header_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_header_params'>header_params</span><span class='comma'>,</span>
1126
- <span class='symbol'>:query_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_query_params'>query_params</span><span class='comma'>,</span>
1127
- <span class='symbol'>:form_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_form_params'>form_params</span><span class='comma'>,</span>
1128
- <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_post_body'>post_body</span><span class='comma'>,</span>
1129
- <span class='symbol'>:auth_names</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_auth_names'>auth_names</span><span class='comma'>,</span>
1130
- <span class='symbol'>:return_type</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>InlineResponse20012</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1131
- <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_debugging'>debugging</span>
1132
- <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>API called: MandateApi#get_mandate\nData: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>\nStatus code: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_status_code'>status_code</span><span class='embexpr_end'>}</span><span class='tstring_content'>\nHeaders: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_headers'>headers</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
1133
- <span class='kw'>end</span>
1134
- <span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_status_code'>status_code</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span>
1135
- <span class='kw'>end</span></pre>
1136
- </td>
1137
- </tr>
1138
- </table>
1139
- </div>
1140
-
1141
- <div class="method_details ">
1142
- <h3 class="signature " id="get_mandates-instance_method">
1143
-
1144
- #<strong>get_mandates</strong>(opts = {}) &#x21d2; <tt><span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span></tt>
1145
-
1146
-
1147
-
1148
-
1149
-
1150
- </h3><div class="docstring">
1151
- <div class="discussion">
1152
-
1153
- <p>search mandates Get mandates that match search criteria.</p>
1154
-
1155
-
1156
- </div>
1157
- </div>
1158
- <div class="tags">
1159
- <p class="tag_title">Parameters:</p>
1160
- <ul class="param">
1161
-
1162
- <li>
1163
-
1164
- <span class='name'>opts</span>
1165
-
1166
-
1167
- <span class='type'>(<tt>Hash</tt>)</span>
1168
-
1169
-
1170
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1171
-
1172
-
1173
- &mdash;
1174
- <div class='inline'>
1175
- <p>the optional parameters</p>
1176
- </div>
1177
-
1178
- </li>
1179
-
1180
- </ul>
1181
-
1182
-
1183
-
1184
-
1185
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
1186
- <ul class="option">
1187
-
1188
- <li>
1189
- <span class="name">:access_signature</span>
1190
- <span class="type">(<tt>String</tt>)</span>
1191
- <span class="default">
1192
-
1193
- </span>
1194
-
1195
- &mdash; <div class='inline'>
1196
- <p>Access signature can be mandatory for specific context. Treezor will
1197
- contact you if so. More info [here](<a
1198
- href="https://agent.treezor.com/security-authentication">agent.treezor.com/security-authentication</a>).</p>
1199
- </div>
1200
-
1201
- </li>
1202
-
1203
- <li>
1204
- <span class="name">:access_tag</span>
1205
- <span class="type">(<tt>String</tt>)</span>
1206
- <span class="default">
1207
-
1208
- </span>
1209
-
1210
- &mdash; <div class='inline'>
1211
- <p>Access tag is used for idem potency query. More info [here](<a
1212
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
1213
- </div>
1214
-
1215
- </li>
1216
-
1217
- <li>
1218
- <span class="name">:access_user_id</span>
1219
- <span class="type">(<tt>Integer</tt>)</span>
1220
- <span class="default">
1221
-
1222
- </span>
1223
-
1224
- &mdash; <div class='inline'>
1225
- <p>Access user&amp;#39;s id is used for user&amp;#39;s action restriction.
1226
- More info [here](<a
1227
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
1228
- </div>
1229
-
1230
- </li>
1231
-
1232
- <li>
1233
- <span class="name">:access_user_ip</span>
1234
- <span class="type">(<tt>String</tt>)</span>
1235
- <span class="default">
1236
-
1237
- </span>
1238
-
1239
- &mdash; <div class='inline'>
1240
- <p>Access user&amp;#39;s ip is used for user&amp;#39;s action restriction.
1241
- More info [here](<a
1242
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
1243
- </div>
1244
-
1245
- </li>
1246
-
1247
- <li>
1248
- <span class="name">:mandate_id</span>
1249
- <span class="type">(<tt>Integer</tt>)</span>
1250
- <span class="default">
1251
-
1252
- </span>
1253
-
1254
- &mdash; <div class='inline'>
1255
- <p>Mandate&amp;#39;s Id</p>
1256
- </div>
1257
-
1258
- </li>
1259
-
1260
- <li>
1261
- <span class="name">:user_id</span>
1262
- <span class="type">(<tt>Integer</tt>)</span>
1263
- <span class="default">
1264
-
1265
- </span>
1266
-
1267
- &mdash; <div class='inline'>
1268
- <p>User&amp;#39;s id who initiates the mandate request.</p>
1269
- </div>
1270
-
1271
- </li>
1272
-
1273
- <li>
1274
- <span class="name">:unique_mandate_reference</span>
1275
- <span class="type">(<tt>String</tt>)</span>
1276
- <span class="default">
1277
-
1278
- </span>
1279
-
1280
- &mdash; <div class='inline'>
1281
- <p>Unique Mandate Reference (UMR) of the searched mandate. It is a sequence of
1282
- characters that ensures the mandate traceability. UMR coupled with SCI
1283
- allows to uniquely identify a creditor and a contract for any mandate. It
1284
- is provided at the mandate creation.</p>
1285
- </div>
1286
-
1287
- </li>
1288
-
1289
- <li>
1290
- <span class="name">:mandate_status</span>
1291
- <span class="type">(<tt>String</tt>)</span>
1292
- <span class="default">
1293
-
1294
- </span>
1295
-
1296
- &mdash; <div class='inline'>
1297
- <p>Mandate&amp;#39;s status. Possible values: * CANCELED * PENDING * VALIDATED</p>
1298
- </div>
1299
-
1300
- </li>
1301
-
1302
- <li>
1303
- <span class="name">:filter</span>
1304
- <span class="type">(<tt>String</tt>)</span>
1305
- <span class="default">
1306
-
1307
- </span>
1308
-
1309
- &mdash; <div class='inline'>
1310
- <p>You can filter the API response by using filter(s). Filters should be
1311
- separated by a &amp;quot;;&amp;quot;. Example for 3 filters :
1312
- FILTER1;FILTER2;FILTER3. A single filter has the following syntax :
1313
- &amp;quot;fieldName criterion expression&amp;quot;. Where : - fieldName :
1314
- the name of a filterable field of this object. - expression : the values
1315
- to be included or excluded (see the table below for more information) -
1316
- criterion : a filter criterion. Here are the possible values for criterion
1317
- : | Criteria | Description | Type
1318
- | Expression Example | |———-|————————|——————————————|——————–| |
1319
- &amp;gt; | greater than | alphanumeric string
1320
- | 100 | | &amp;gt;&amp;#x3D; | greater or equal than
1321
- | alphanumeric string | 100 | |
1322
- &amp;lt; | less than | alphanumeric string
1323
- | 100 | | &amp;lt;&amp;#x3D; | less or equal than
1324
- | alphanumeric string | 100 | |
1325
- !&amp;#x3D; | not equal to | alphanumeric string
1326
- | 100 | | like | like |
1327
- alphanumeric string | 100 | | in |
1328
- in | alphanumeric strings separated by commas | 100,30,25
1329
- | | &amp;#x3D;&amp;#x3D; | equals |
1330
- alphanumeric string | 100 |</p>
1331
- </div>
1332
-
1333
- </li>
1334
-
1335
- </ul>
1336
-
1337
-
1338
- <p class="tag_title">Returns:</p>
1339
- <ul class="return">
1340
-
1341
- <li>
1342
-
1343
-
1344
- <span class='type'>(<tt><span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span></tt>)</span>
1345
-
1346
-
1347
-
1348
- </li>
1349
-
1350
- </ul>
1351
-
1352
- </div><table class="source_code">
1353
- <tr>
1354
- <td>
1355
- <pre class="lines">
1356
-
1357
-
1358
- 157
1359
- 158
1360
- 159
1361
- 160</pre>
1362
- </td>
1363
- <td>
1364
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/mandate_api.rb', line 157</span>
1365
-
1366
- <span class='kw'>def</span> <span class='id identifier rubyid_get_mandates'>get_mandates</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1367
- <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid__status_code'>_status_code</span><span class='comma'>,</span> <span class='id identifier rubyid__headers'>_headers</span> <span class='op'>=</span> <span class='id identifier rubyid_get_mandates_with_http_info'>get_mandates_with_http_info</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
1368
- <span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span>
1369
- <span class='kw'>end</span></pre>
1370
- </td>
1371
- </tr>
1372
- </table>
1373
- </div>
1374
-
1375
- <div class="method_details ">
1376
- <h3 class="signature " id="get_mandates_with_http_info-instance_method">
1377
-
1378
- #<strong>get_mandates_with_http_info</strong>(opts = {}) &#x21d2; <tt>Array&lt;(<span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span>, Fixnum, Hash)&gt;</tt>
1379
-
1380
-
1381
-
1382
-
1383
-
1384
- </h3><div class="docstring">
1385
- <div class="discussion">
1386
-
1387
- <p>search mandates Get mandates that match search criteria.</p>
1388
-
1389
-
1390
- </div>
1391
- </div>
1392
- <div class="tags">
1393
- <p class="tag_title">Parameters:</p>
1394
- <ul class="param">
1395
-
1396
- <li>
1397
-
1398
- <span class='name'>opts</span>
1399
-
1400
-
1401
- <span class='type'>(<tt>Hash</tt>)</span>
1402
-
1403
-
1404
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1405
-
1406
-
1407
- &mdash;
1408
- <div class='inline'>
1409
- <p>the optional parameters</p>
1410
- </div>
1411
-
1412
- </li>
1413
-
1414
- </ul>
1415
-
1416
-
1417
-
1418
-
1419
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
1420
- <ul class="option">
1421
-
1422
- <li>
1423
- <span class="name">:access_signature</span>
1424
- <span class="type">(<tt>String</tt>)</span>
1425
- <span class="default">
1426
-
1427
- </span>
1428
-
1429
- &mdash; <div class='inline'>
1430
- <p>Access signature can be mandatory for specific context. Treezor will
1431
- contact you if so. More info [here](<a
1432
- href="https://agent.treezor.com/security-authentication">agent.treezor.com/security-authentication</a>).</p>
1433
- </div>
1434
-
1435
- </li>
1436
-
1437
- <li>
1438
- <span class="name">:access_tag</span>
1439
- <span class="type">(<tt>String</tt>)</span>
1440
- <span class="default">
1441
-
1442
- </span>
1443
-
1444
- &mdash; <div class='inline'>
1445
- <p>Access tag is used for idem potency query. More info [here](<a
1446
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
1447
- </div>
1448
-
1449
- </li>
1450
-
1451
- <li>
1452
- <span class="name">:access_user_id</span>
1453
- <span class="type">(<tt>Integer</tt>)</span>
1454
- <span class="default">
1455
-
1456
- </span>
1457
-
1458
- &mdash; <div class='inline'>
1459
- <p>Access user&amp;#39;s id is used for user&amp;#39;s action restriction.
1460
- More info [here](<a
1461
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
1462
- </div>
1463
-
1464
- </li>
1465
-
1466
- <li>
1467
- <span class="name">:access_user_ip</span>
1468
- <span class="type">(<tt>String</tt>)</span>
1469
- <span class="default">
1470
-
1471
- </span>
1472
-
1473
- &mdash; <div class='inline'>
1474
- <p>Access user&amp;#39;s ip is used for user&amp;#39;s action restriction.
1475
- More info [here](<a
1476
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
1477
- </div>
1478
-
1479
- </li>
1480
-
1481
- <li>
1482
- <span class="name">:mandate_id</span>
1483
- <span class="type">(<tt>Integer</tt>)</span>
1484
- <span class="default">
1485
-
1486
- </span>
1487
-
1488
- &mdash; <div class='inline'>
1489
- <p>Mandate&amp;#39;s Id</p>
1490
- </div>
1491
-
1492
- </li>
1493
-
1494
- <li>
1495
- <span class="name">:user_id</span>
1496
- <span class="type">(<tt>Integer</tt>)</span>
1497
- <span class="default">
1498
-
1499
- </span>
1500
-
1501
- &mdash; <div class='inline'>
1502
- <p>User&amp;#39;s id who initiates the mandate request.</p>
1503
- </div>
1504
-
1505
- </li>
1506
-
1507
- <li>
1508
- <span class="name">:unique_mandate_reference</span>
1509
- <span class="type">(<tt>String</tt>)</span>
1510
- <span class="default">
1511
-
1512
- </span>
1513
-
1514
- &mdash; <div class='inline'>
1515
- <p>Unique Mandate Reference (UMR) of the searched mandate. It is a sequence of
1516
- characters that ensures the mandate traceability. UMR coupled with SCI
1517
- allows to uniquely identify a creditor and a contract for any mandate. It
1518
- is provided at the mandate creation.</p>
1519
- </div>
1520
-
1521
- </li>
1522
-
1523
- <li>
1524
- <span class="name">:mandate_status</span>
1525
- <span class="type">(<tt>String</tt>)</span>
1526
- <span class="default">
1527
-
1528
- </span>
1529
-
1530
- &mdash; <div class='inline'>
1531
- <p>Mandate&amp;#39;s status. Possible values: * CANCELED * PENDING * VALIDATED</p>
1532
- </div>
1533
-
1534
- </li>
1535
-
1536
- <li>
1537
- <span class="name">:filter</span>
1538
- <span class="type">(<tt>String</tt>)</span>
1539
- <span class="default">
1540
-
1541
- </span>
1542
-
1543
- &mdash; <div class='inline'>
1544
- <p>You can filter the API response by using filter(s). Filters should be
1545
- separated by a &amp;quot;;&amp;quot;. Example for 3 filters :
1546
- FILTER1;FILTER2;FILTER3. A single filter has the following syntax :
1547
- &amp;quot;fieldName criterion expression&amp;quot;. Where : - fieldName :
1548
- the name of a filterable field of this object. - expression : the values
1549
- to be included or excluded (see the table below for more information) -
1550
- criterion : a filter criterion. Here are the possible values for criterion
1551
- : | Criteria | Description | Type
1552
- | Expression Example | |———-|————————|——————————————|——————–| |
1553
- &amp;gt; | greater than | alphanumeric string
1554
- | 100 | | &amp;gt;&amp;#x3D; | greater or equal than
1555
- | alphanumeric string | 100 | |
1556
- &amp;lt; | less than | alphanumeric string
1557
- | 100 | | &amp;lt;&amp;#x3D; | less or equal than
1558
- | alphanumeric string | 100 | |
1559
- !&amp;#x3D; | not equal to | alphanumeric string
1560
- | 100 | | like | like |
1561
- alphanumeric string | 100 | | in |
1562
- in | alphanumeric strings separated by commas | 100,30,25
1563
- | | &amp;#x3D;&amp;#x3D; | equals |
1564
- alphanumeric string | 100 |</p>
1565
- </div>
1566
-
1567
- </li>
1568
-
1569
- </ul>
1570
-
1571
-
1572
- <p class="tag_title">Returns:</p>
1573
- <ul class="return">
1574
-
1575
- <li>
1576
-
1577
-
1578
- <span class='type'>(<tt>Array&lt;(<span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span>, Fixnum, Hash)&gt;</tt>)</span>
1579
-
1580
-
1581
-
1582
- &mdash;
1583
- <div class='inline'>
1584
- <p>InlineResponse20012 data, response status code and response headers</p>
1585
- </div>
1586
-
1587
- </li>
1588
-
1589
- </ul>
1590
-
1591
- </div><table class="source_code">
1592
- <tr>
1593
- <td>
1594
- <pre class="lines">
1595
-
1596
-
1597
- 175
1598
- 176
1599
- 177
1600
- 178
1601
- 179
1602
- 180
1603
- 181
1604
- 182
1605
- 183
1606
- 184
1607
- 185
1608
- 186
1609
- 187
1610
- 188
1611
- 189
1612
- 190
1613
- 191
1614
- 192
1615
- 193
1616
- 194
1617
- 195
1618
- 196
1619
- 197
1620
- 198
1621
- 199
1622
- 200
1623
- 201
1624
- 202
1625
- 203
1626
- 204
1627
- 205
1628
- 206
1629
- 207
1630
- 208
1631
- 209
1632
- 210
1633
- 211
1634
- 212
1635
- 213
1636
- 214
1637
- 215
1638
- 216
1639
- 217
1640
- 218</pre>
1641
- </td>
1642
- <td>
1643
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/mandate_api.rb', line 175</span>
1644
-
1645
- <span class='kw'>def</span> <span class='id identifier rubyid_get_mandates_with_http_info'>get_mandates_with_http_info</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1646
- <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_debugging'>debugging</span>
1647
- <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Calling API: MandateApi.get_mandates ...</span><span class='tstring_end'>&quot;</span></span>
1648
- <span class='kw'>end</span>
1649
- <span class='comment'># resource path
1650
- </span> <span class='id identifier rubyid_local_var_path'>local_var_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/mandates</span><span class='tstring_end'>&quot;</span></span>
1651
-
1652
- <span class='comment'># query parameters
1653
- </span> <span class='id identifier rubyid_query_params'>query_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1654
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessSignature&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_signature&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_signature&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1655
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessTag&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_tag&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_tag&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1656
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessUserId&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_user_id&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_user_id&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1657
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessUserIp&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_user_ip&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_user_ip&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1658
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;mandateId&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;mandate_id&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;mandate_id&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1659
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;userId&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;user_id&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;user_id&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1660
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;uniqueMandateReference&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;unique_mandate_reference&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;unique_mandate_reference&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1661
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;mandateStatus&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;mandate_status&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;mandate_status&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1662
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;filter&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;filter&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;filter&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1663
-
1664
- <span class='comment'># header parameters
1665
- </span> <span class='id identifier rubyid_header_params'>header_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1666
- <span class='comment'># HTTP header &#39;Accept&#39; (if needed)
1667
- </span> <span class='id identifier rubyid_header_params'>header_params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Accept</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_select_header_accept'>select_header_accept</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
1668
- <span class='comment'># HTTP header &#39;Content-Type&#39;
1669
- </span> <span class='id identifier rubyid_header_params'>header_params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_select_header_content_type'>select_header_content_type</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
1670
-
1671
- <span class='comment'># form parameters
1672
- </span> <span class='id identifier rubyid_form_params'>form_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1673
-
1674
- <span class='comment'># http body (model)
1675
- </span> <span class='id identifier rubyid_post_body'>post_body</span> <span class='op'>=</span> <span class='kw'>nil</span>
1676
- <span class='id identifier rubyid_auth_names'>auth_names</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>api_key</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
1677
- <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_status_code'>status_code</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='symbol'>:GET</span><span class='comma'>,</span> <span class='id identifier rubyid_local_var_path'>local_var_path</span><span class='comma'>,</span>
1678
- <span class='symbol'>:header_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_header_params'>header_params</span><span class='comma'>,</span>
1679
- <span class='symbol'>:query_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_query_params'>query_params</span><span class='comma'>,</span>
1680
- <span class='symbol'>:form_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_form_params'>form_params</span><span class='comma'>,</span>
1681
- <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_post_body'>post_body</span><span class='comma'>,</span>
1682
- <span class='symbol'>:auth_names</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_auth_names'>auth_names</span><span class='comma'>,</span>
1683
- <span class='symbol'>:return_type</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>InlineResponse20012</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1684
- <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_debugging'>debugging</span>
1685
- <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>API called: MandateApi#get_mandates\nData: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>\nStatus code: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_status_code'>status_code</span><span class='embexpr_end'>}</span><span class='tstring_content'>\nHeaders: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_headers'>headers</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
1686
- <span class='kw'>end</span>
1687
- <span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_status_code'>status_code</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span>
1688
- <span class='kw'>end</span></pre>
1689
- </td>
1690
- </tr>
1691
- </table>
1692
- </div>
1693
-
1694
- <div class="method_details ">
1695
- <h3 class="signature " id="mandates_id_resend_otp_put-instance_method">
1696
-
1697
- #<strong>mandates_id_resend_otp_put</strong>(id, access_token, access_signature, user_id, opts = {}) &#x21d2; <tt><span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span></tt>
1698
-
1699
-
1700
-
1701
-
1702
-
1703
- </h3><div class="docstring">
1704
- <div class="discussion">
1705
-
1706
- <p>send an OTP Send an OTP to sign a specific mandate. The OTP will be sent to
1707
- the user&#39;s mobile phone OR to a specific mobile phone number in the
1708
- request.</p>
1709
-
1710
-
1711
- </div>
1712
- </div>
1713
- <div class="tags">
1714
- <p class="tag_title">Parameters:</p>
1715
- <ul class="param">
1716
-
1717
- <li>
1718
-
1719
- <span class='name'>id</span>
1720
-
1721
-
1722
- <span class='type'></span>
1723
-
1724
-
1725
-
1726
- &mdash;
1727
- <div class='inline'>
1728
- <p>Mandate&amp;#39;s id.</p>
1729
- </div>
1730
-
1731
- </li>
1732
-
1733
- <li>
1734
-
1735
- <span class='name'>access_token</span>
1736
-
1737
-
1738
- <span class='type'></span>
1739
-
1740
-
1741
-
1742
- &mdash;
1743
- <div class='inline'>
1744
- <p>Access token must be defined here or in Authorization HTTP header. More
1745
- info [here](<a
1746
- href="https://agent.treezor.com/security-authentication">agent.treezor.com/security-authentication</a>).</p>
1747
- </div>
1748
-
1749
- </li>
1750
-
1751
- <li>
1752
-
1753
- <span class='name'>access_signature</span>
1754
-
1755
-
1756
- <span class='type'></span>
1757
-
1758
-
1759
-
1760
- &mdash;
1761
- <div class='inline'>
1762
- <p>Access signature can be mandatory for specific context. Treezor will
1763
- contact you if so. More info [here](<a
1764
- href="https://agent.treezor.com/security-authentication">agent.treezor.com/security-authentication</a>).</p>
1765
- </div>
1766
-
1767
- </li>
1768
-
1769
- <li>
1770
-
1771
- <span class='name'>user_id</span>
1772
-
1773
-
1774
- <span class='type'></span>
1775
-
1776
-
1777
-
1778
- &mdash;
1779
- <div class='inline'>
1780
- <p>User&amp;#39;s id who initiates the mandate request.</p>
1781
- </div>
1782
-
1783
- </li>
1784
-
1785
- <li>
1786
-
1787
- <span class='name'>opts</span>
1788
-
1789
-
1790
- <span class='type'>(<tt>Hash</tt>)</span>
1791
-
1792
-
1793
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1794
-
1795
-
1796
- &mdash;
1797
- <div class='inline'>
1798
- <p>the optional parameters</p>
1799
- </div>
1800
-
1801
- </li>
1802
-
1803
- </ul>
1804
-
1805
-
1806
-
1807
-
1808
-
1809
-
1810
-
1811
-
1812
-
1813
-
1814
-
1815
-
1816
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
1817
- <ul class="option">
1818
-
1819
- <li>
1820
- <span class="name">:access_tag</span>
1821
- <span class="type">(<tt>String</tt>)</span>
1822
- <span class="default">
1823
-
1824
- </span>
1825
-
1826
- &mdash; <div class='inline'>
1827
- <p>Access tag is used for idem potency query. More info [here](<a
1828
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
1829
- </div>
1830
-
1831
- </li>
1832
-
1833
- <li>
1834
- <span class="name">:access_user_id</span>
1835
- <span class="type">(<tt>Integer</tt>)</span>
1836
- <span class="default">
1837
-
1838
- </span>
1839
-
1840
- &mdash; <div class='inline'>
1841
- <p>Access user&amp;#39;s id is used for user&amp;#39;s action restriction.
1842
- More info [here](<a
1843
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
1844
- </div>
1845
-
1846
- </li>
1847
-
1848
- <li>
1849
- <span class="name">:access_user_ip</span>
1850
- <span class="type">(<tt>String</tt>)</span>
1851
- <span class="default">
1852
-
1853
- </span>
1854
-
1855
- &mdash; <div class='inline'>
1856
- <p>Access user&amp;#39;s ip is used for user&amp;#39;s action restriction.
1857
- More info [here](<a
1858
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
1859
- </div>
1860
-
1861
- </li>
1862
-
1863
- <li>
1864
- <span class="name">:debtor_mobile</span>
1865
- <span class="type">(<tt>String</tt>)</span>
1866
- <span class="default">
1867
-
1868
- </span>
1869
-
1870
- &mdash; <div class='inline'>
1871
- <p>Debtor&amp;#39;s mobile phone number. Used to send the OTP for signature</p>
1872
- </div>
1873
-
1874
- </li>
1875
-
1876
- </ul>
1877
-
1878
-
1879
- <p class="tag_title">Returns:</p>
1880
- <ul class="return">
1881
-
1882
- <li>
1883
-
1884
-
1885
- <span class='type'>(<tt><span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span></tt>)</span>
1886
-
1887
-
1888
-
1889
- </li>
1890
-
1891
- </ul>
1892
-
1893
- </div><table class="source_code">
1894
- <tr>
1895
- <td>
1896
- <pre class="lines">
1897
-
1898
-
1899
- 232
1900
- 233
1901
- 234
1902
- 235</pre>
1903
- </td>
1904
- <td>
1905
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/mandate_api.rb', line 232</span>
1906
-
1907
- <span class='kw'>def</span> <span class='id identifier rubyid_mandates_id_resend_otp_put'>mandates_id_resend_otp_put</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='comma'>,</span> <span class='id identifier rubyid_access_signature'>access_signature</span><span class='comma'>,</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1908
- <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid__status_code'>_status_code</span><span class='comma'>,</span> <span class='id identifier rubyid__headers'>_headers</span> <span class='op'>=</span> <span class='id identifier rubyid_mandates_id_resend_otp_put_with_http_info'>mandates_id_resend_otp_put_with_http_info</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='comma'>,</span> <span class='id identifier rubyid_access_signature'>access_signature</span><span class='comma'>,</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
1909
- <span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span>
1910
- <span class='kw'>end</span></pre>
1911
- </td>
1912
- </tr>
1913
- </table>
1914
- </div>
1915
-
1916
- <div class="method_details ">
1917
- <h3 class="signature " id="mandates_id_resend_otp_put_with_http_info-instance_method">
1918
-
1919
- #<strong>mandates_id_resend_otp_put_with_http_info</strong>(id, access_token, access_signature, user_id, opts = {}) &#x21d2; <tt>Array&lt;(<span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span>, Fixnum, Hash)&gt;</tt>
1920
-
1921
-
1922
-
1923
-
1924
-
1925
- </h3><div class="docstring">
1926
- <div class="discussion">
1927
-
1928
- <p>send an OTP Send an OTP to sign a specific mandate. The OTP will be sent to
1929
- the user&amp;#39;s mobile phone OR to a specific mobile phone number in the
1930
- request.</p>
1931
-
1932
-
1933
- </div>
1934
- </div>
1935
- <div class="tags">
1936
- <p class="tag_title">Parameters:</p>
1937
- <ul class="param">
1938
-
1939
- <li>
1940
-
1941
- <span class='name'>id</span>
1942
-
1943
-
1944
- <span class='type'></span>
1945
-
1946
-
1947
-
1948
- &mdash;
1949
- <div class='inline'>
1950
- <p>Mandate&amp;#39;s id.</p>
1951
- </div>
1952
-
1953
- </li>
1954
-
1955
- <li>
1956
-
1957
- <span class='name'>access_token</span>
1958
-
1959
-
1960
- <span class='type'></span>
1961
-
1962
-
1963
-
1964
- &mdash;
1965
- <div class='inline'>
1966
- <p>Access token must be defined here or in Authorization HTTP header. More
1967
- info [here](<a
1968
- href="https://agent.treezor.com/security-authentication">agent.treezor.com/security-authentication</a>).</p>
1969
- </div>
1970
-
1971
- </li>
1972
-
1973
- <li>
1974
-
1975
- <span class='name'>access_signature</span>
1976
-
1977
-
1978
- <span class='type'></span>
1979
-
1980
-
1981
-
1982
- &mdash;
1983
- <div class='inline'>
1984
- <p>Access signature can be mandatory for specific context. Treezor will
1985
- contact you if so. More info [here](<a
1986
- href="https://agent.treezor.com/security-authentication">agent.treezor.com/security-authentication</a>).</p>
1987
- </div>
1988
-
1989
- </li>
1990
-
1991
- <li>
1992
-
1993
- <span class='name'>user_id</span>
1994
-
1995
-
1996
- <span class='type'></span>
1997
-
1998
-
1999
-
2000
- &mdash;
2001
- <div class='inline'>
2002
- <p>User&amp;#39;s id who initiates the mandate request.</p>
2003
- </div>
2004
-
2005
- </li>
2006
-
2007
- <li>
2008
-
2009
- <span class='name'>opts</span>
2010
-
2011
-
2012
- <span class='type'>(<tt>Hash</tt>)</span>
2013
-
2014
-
2015
- <em class="default">(defaults to: <tt>{}</tt>)</em>
2016
-
2017
-
2018
- &mdash;
2019
- <div class='inline'>
2020
- <p>the optional parameters</p>
2021
- </div>
2022
-
2023
- </li>
2024
-
2025
- </ul>
2026
-
2027
-
2028
-
2029
-
2030
-
2031
-
2032
-
2033
-
2034
-
2035
-
2036
-
2037
-
2038
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
2039
- <ul class="option">
2040
-
2041
- <li>
2042
- <span class="name">:access_tag</span>
2043
- <span class="type">(<tt>String</tt>)</span>
2044
- <span class="default">
2045
-
2046
- </span>
2047
-
2048
- &mdash; <div class='inline'>
2049
- <p>Access tag is used for idem potency query. More info [here](<a
2050
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
2051
- </div>
2052
-
2053
- </li>
2054
-
2055
- <li>
2056
- <span class="name">:access_user_id</span>
2057
- <span class="type">(<tt>Integer</tt>)</span>
2058
- <span class="default">
2059
-
2060
- </span>
2061
-
2062
- &mdash; <div class='inline'>
2063
- <p>Access user&amp;#39;s id is used for user&amp;#39;s action restriction.
2064
- More info [here](<a
2065
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
2066
- </div>
2067
-
2068
- </li>
2069
-
2070
- <li>
2071
- <span class="name">:access_user_ip</span>
2072
- <span class="type">(<tt>String</tt>)</span>
2073
- <span class="default">
2074
-
2075
- </span>
2076
-
2077
- &mdash; <div class='inline'>
2078
- <p>Access user&amp;#39;s ip is used for user&amp;#39;s action restriction.
2079
- More info [here](<a
2080
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
2081
- </div>
2082
-
2083
- </li>
2084
-
2085
- <li>
2086
- <span class="name">:debtor_mobile</span>
2087
- <span class="type">(<tt>String</tt>)</span>
2088
- <span class="default">
2089
-
2090
- </span>
2091
-
2092
- &mdash; <div class='inline'>
2093
- <p>Debtor&amp;#39;s mobile phone number. Used to send the OTP for signature</p>
2094
- </div>
2095
-
2096
- </li>
2097
-
2098
- </ul>
2099
-
2100
-
2101
- <p class="tag_title">Returns:</p>
2102
- <ul class="return">
2103
-
2104
- <li>
2105
-
2106
-
2107
- <span class='type'>(<tt>Array&lt;(<span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span>, Fixnum, Hash)&gt;</tt>)</span>
2108
-
2109
-
2110
-
2111
- &mdash;
2112
- <div class='inline'>
2113
- <p>InlineResponse20012 data, response status code and response headers</p>
2114
- </div>
2115
-
2116
- </li>
2117
-
2118
- </ul>
2119
-
2120
- </div><table class="source_code">
2121
- <tr>
2122
- <td>
2123
- <pre class="lines">
2124
-
2125
-
2126
- 249
2127
- 250
2128
- 251
2129
- 252
2130
- 253
2131
- 254
2132
- 255
2133
- 256
2134
- 257
2135
- 258
2136
- 259
2137
- 260
2138
- 261
2139
- 262
2140
- 263
2141
- 264
2142
- 265
2143
- 266
2144
- 267
2145
- 268
2146
- 269
2147
- 270
2148
- 271
2149
- 272
2150
- 273
2151
- 274
2152
- 275
2153
- 276
2154
- 277
2155
- 278
2156
- 279
2157
- 280
2158
- 281
2159
- 282
2160
- 283
2161
- 284
2162
- 285
2163
- 286
2164
- 287
2165
- 288
2166
- 289
2167
- 290
2168
- 291
2169
- 292
2170
- 293
2171
- 294
2172
- 295
2173
- 296
2174
- 297
2175
- 298
2176
- 299
2177
- 300
2178
- 301
2179
- 302</pre>
2180
- </td>
2181
- <td>
2182
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/mandate_api.rb', line 249</span>
2183
-
2184
- <span class='kw'>def</span> <span class='id identifier rubyid_mandates_id_resend_otp_put_with_http_info'>mandates_id_resend_otp_put_with_http_info</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='comma'>,</span> <span class='id identifier rubyid_access_signature'>access_signature</span><span class='comma'>,</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
2185
- <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_debugging'>debugging</span>
2186
- <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Calling API: MandateApi.mandates_id_resend_otp_put ...</span><span class='tstring_end'>&quot;</span></span>
2187
- <span class='kw'>end</span>
2188
- <span class='comment'># verify the required parameter &#39;id&#39; is set
2189
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2190
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;id&#39; when calling MandateApi.mandates_id_resend_otp_put</span><span class='tstring_end'>&quot;</span></span>
2191
- <span class='kw'>end</span>
2192
- <span class='comment'># verify the required parameter &#39;access_token&#39; is set
2193
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2194
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;access_token&#39; when calling MandateApi.mandates_id_resend_otp_put</span><span class='tstring_end'>&quot;</span></span>
2195
- <span class='kw'>end</span>
2196
- <span class='comment'># verify the required parameter &#39;access_signature&#39; is set
2197
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_access_signature'>access_signature</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2198
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;access_signature&#39; when calling MandateApi.mandates_id_resend_otp_put</span><span class='tstring_end'>&quot;</span></span>
2199
- <span class='kw'>end</span>
2200
- <span class='comment'># verify the required parameter &#39;user_id&#39; is set
2201
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2202
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;user_id&#39; when calling MandateApi.mandates_id_resend_otp_put</span><span class='tstring_end'>&quot;</span></span>
2203
- <span class='kw'>end</span>
2204
- <span class='comment'># resource path
2205
- </span> <span class='id identifier rubyid_local_var_path'>local_var_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/mandates/{id}/ResendOtp/</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_sub'>sub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{</span><span class='tstring_end'>&#39;</span></span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>}</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
2206
-
2207
- <span class='comment'># query parameters
2208
- </span> <span class='id identifier rubyid_query_params'>query_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
2209
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessToken&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_access_token'>access_token</span>
2210
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessSignature&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_access_signature'>access_signature</span>
2211
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;userId&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_user_id'>user_id</span>
2212
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessTag&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_tag&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_tag&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2213
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessUserId&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_user_id&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_user_id&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2214
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessUserIp&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_user_ip&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_user_ip&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2215
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;debtorMobile&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;debtor_mobile&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;debtor_mobile&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2216
-
2217
- <span class='comment'># header parameters
2218
- </span> <span class='id identifier rubyid_header_params'>header_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
2219
-
2220
- <span class='comment'># form parameters
2221
- </span> <span class='id identifier rubyid_form_params'>form_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
2222
-
2223
- <span class='comment'># http body (model)
2224
- </span> <span class='id identifier rubyid_post_body'>post_body</span> <span class='op'>=</span> <span class='kw'>nil</span>
2225
- <span class='id identifier rubyid_auth_names'>auth_names</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>api_key</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
2226
- <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_status_code'>status_code</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='symbol'>:PUT</span><span class='comma'>,</span> <span class='id identifier rubyid_local_var_path'>local_var_path</span><span class='comma'>,</span>
2227
- <span class='symbol'>:header_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_header_params'>header_params</span><span class='comma'>,</span>
2228
- <span class='symbol'>:query_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_query_params'>query_params</span><span class='comma'>,</span>
2229
- <span class='symbol'>:form_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_form_params'>form_params</span><span class='comma'>,</span>
2230
- <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_post_body'>post_body</span><span class='comma'>,</span>
2231
- <span class='symbol'>:auth_names</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_auth_names'>auth_names</span><span class='comma'>,</span>
2232
- <span class='symbol'>:return_type</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>InlineResponse20012</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
2233
- <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_debugging'>debugging</span>
2234
- <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>API called: MandateApi#mandates_id_resend_otp_put\nData: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>\nStatus code: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_status_code'>status_code</span><span class='embexpr_end'>}</span><span class='tstring_content'>\nHeaders: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_headers'>headers</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
2235
- <span class='kw'>end</span>
2236
- <span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_status_code'>status_code</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span>
2237
- <span class='kw'>end</span></pre>
2238
- </td>
2239
- </tr>
2240
- </table>
2241
- </div>
2242
-
2243
- <div class="method_details ">
2244
- <h3 class="signature " id="mandates_id_sign_put-instance_method">
2245
-
2246
- #<strong>mandates_id_sign_put</strong>(id, access_token, access_signature, user_id, otp, opts = {}) &#x21d2; <tt><span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span></tt>
2247
-
2248
-
2249
-
2250
-
2251
-
2252
- </h3><div class="docstring">
2253
- <div class="discussion">
2254
-
2255
- <p>sign a mandate Sign a mandate with the received OTP.</p>
2256
-
2257
-
2258
- </div>
2259
- </div>
2260
- <div class="tags">
2261
- <p class="tag_title">Parameters:</p>
2262
- <ul class="param">
2263
-
2264
- <li>
2265
-
2266
- <span class='name'>id</span>
2267
-
2268
-
2269
- <span class='type'></span>
2270
-
2271
-
2272
-
2273
- &mdash;
2274
- <div class='inline'>
2275
- <p>Mandate&amp;#39;s id.</p>
2276
- </div>
2277
-
2278
- </li>
2279
-
2280
- <li>
2281
-
2282
- <span class='name'>access_token</span>
2283
-
2284
-
2285
- <span class='type'></span>
2286
-
2287
-
2288
-
2289
- &mdash;
2290
- <div class='inline'>
2291
- <p>Access token must be defined here or in Authorization HTTP header. More
2292
- info [here](<a
2293
- href="https://agent.treezor.com/security-authentication">agent.treezor.com/security-authentication</a>).</p>
2294
- </div>
2295
-
2296
- </li>
2297
-
2298
- <li>
2299
-
2300
- <span class='name'>access_signature</span>
2301
-
2302
-
2303
- <span class='type'></span>
2304
-
2305
-
2306
-
2307
- &mdash;
2308
- <div class='inline'>
2309
- <p>Access signature can be mandatory for specific context. Treezor will
2310
- contact you if so. More info [here](<a
2311
- href="https://agent.treezor.com/security-authentication">agent.treezor.com/security-authentication</a>).</p>
2312
- </div>
2313
-
2314
- </li>
2315
-
2316
- <li>
2317
-
2318
- <span class='name'>user_id</span>
2319
-
2320
-
2321
- <span class='type'></span>
2322
-
2323
-
2324
-
2325
- &mdash;
2326
- <div class='inline'>
2327
- <p>User&amp;#39;s is who initiates the mandate request.</p>
2328
- </div>
2329
-
2330
- </li>
2331
-
2332
- <li>
2333
-
2334
- <span class='name'>otp</span>
2335
-
2336
-
2337
- <span class='type'></span>
2338
-
2339
-
2340
-
2341
- &mdash;
2342
- <div class='inline'>
2343
- <p>The One-time password that the user got once mandate created.</p>
2344
- </div>
2345
-
2346
- </li>
2347
-
2348
- <li>
2349
-
2350
- <span class='name'>opts</span>
2351
-
2352
-
2353
- <span class='type'>(<tt>Hash</tt>)</span>
2354
-
2355
-
2356
- <em class="default">(defaults to: <tt>{}</tt>)</em>
2357
-
2358
-
2359
- &mdash;
2360
- <div class='inline'>
2361
- <p>the optional parameters</p>
2362
- </div>
2363
-
2364
- </li>
2365
-
2366
- </ul>
2367
-
2368
-
2369
-
2370
-
2371
-
2372
-
2373
-
2374
-
2375
-
2376
-
2377
-
2378
-
2379
-
2380
-
2381
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
2382
- <ul class="option">
2383
-
2384
- <li>
2385
- <span class="name">:access_tag</span>
2386
- <span class="type">(<tt>String</tt>)</span>
2387
- <span class="default">
2388
-
2389
- </span>
2390
-
2391
- &mdash; <div class='inline'>
2392
- <p>Access tag is used for idem potency query. More info [here](<a
2393
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
2394
- </div>
2395
-
2396
- </li>
2397
-
2398
- <li>
2399
- <span class="name">:access_user_id</span>
2400
- <span class="type">(<tt>Integer</tt>)</span>
2401
- <span class="default">
2402
-
2403
- </span>
2404
-
2405
- &mdash; <div class='inline'>
2406
- <p>Access user&amp;#39;s id is used for user&amp;#39;s action restriction.
2407
- More info [here](<a
2408
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
2409
- </div>
2410
-
2411
- </li>
2412
-
2413
- <li>
2414
- <span class="name">:access_user_ip</span>
2415
- <span class="type">(<tt>String</tt>)</span>
2416
- <span class="default">
2417
-
2418
- </span>
2419
-
2420
- &mdash; <div class='inline'>
2421
- <p>Access user&amp;#39;s ip is used for user&amp;#39;s action restriction.
2422
- More info [here](<a
2423
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
2424
- </div>
2425
-
2426
- </li>
2427
-
2428
- <li>
2429
- <span class="name">:debtor_signature_ip</span>
2430
- <span class="type">(<tt>String</tt>)</span>
2431
- <span class="default">
2432
-
2433
- </span>
2434
-
2435
- &mdash; <div class='inline'>
2436
- <p>IP address from which the mandate will be signed.</p>
2437
- </div>
2438
-
2439
- </li>
2440
-
2441
- </ul>
2442
-
2443
-
2444
- <p class="tag_title">Returns:</p>
2445
- <ul class="return">
2446
-
2447
- <li>
2448
-
2449
-
2450
- <span class='type'>(<tt><span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span></tt>)</span>
2451
-
2452
-
2453
-
2454
- </li>
2455
-
2456
- </ul>
2457
-
2458
- </div><table class="source_code">
2459
- <tr>
2460
- <td>
2461
- <pre class="lines">
2462
-
2463
-
2464
- 317
2465
- 318
2466
- 319
2467
- 320</pre>
2468
- </td>
2469
- <td>
2470
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/mandate_api.rb', line 317</span>
2471
-
2472
- <span class='kw'>def</span> <span class='id identifier rubyid_mandates_id_sign_put'>mandates_id_sign_put</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='comma'>,</span> <span class='id identifier rubyid_access_signature'>access_signature</span><span class='comma'>,</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_otp'>otp</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
2473
- <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid__status_code'>_status_code</span><span class='comma'>,</span> <span class='id identifier rubyid__headers'>_headers</span> <span class='op'>=</span> <span class='id identifier rubyid_mandates_id_sign_put_with_http_info'>mandates_id_sign_put_with_http_info</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='comma'>,</span> <span class='id identifier rubyid_access_signature'>access_signature</span><span class='comma'>,</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_otp'>otp</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
2474
- <span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span>
2475
- <span class='kw'>end</span></pre>
2476
- </td>
2477
- </tr>
2478
- </table>
2479
- </div>
2480
-
2481
- <div class="method_details ">
2482
- <h3 class="signature " id="mandates_id_sign_put_with_http_info-instance_method">
2483
-
2484
- #<strong>mandates_id_sign_put_with_http_info</strong>(id, access_token, access_signature, user_id, otp, opts = {}) &#x21d2; <tt>Array&lt;(<span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span>, Fixnum, Hash)&gt;</tt>
2485
-
2486
-
2487
-
2488
-
2489
-
2490
- </h3><div class="docstring">
2491
- <div class="discussion">
2492
-
2493
- <p>sign a mandate Sign a mandate with the received OTP.</p>
2494
-
2495
-
2496
- </div>
2497
- </div>
2498
- <div class="tags">
2499
- <p class="tag_title">Parameters:</p>
2500
- <ul class="param">
2501
-
2502
- <li>
2503
-
2504
- <span class='name'>id</span>
2505
-
2506
-
2507
- <span class='type'></span>
2508
-
2509
-
2510
-
2511
- &mdash;
2512
- <div class='inline'>
2513
- <p>Mandate&amp;#39;s id.</p>
2514
- </div>
2515
-
2516
- </li>
2517
-
2518
- <li>
2519
-
2520
- <span class='name'>access_token</span>
2521
-
2522
-
2523
- <span class='type'></span>
2524
-
2525
-
2526
-
2527
- &mdash;
2528
- <div class='inline'>
2529
- <p>Access token must be defined here or in Authorization HTTP header. More
2530
- info [here](<a
2531
- href="https://agent.treezor.com/security-authentication">agent.treezor.com/security-authentication</a>).</p>
2532
- </div>
2533
-
2534
- </li>
2535
-
2536
- <li>
2537
-
2538
- <span class='name'>access_signature</span>
2539
-
2540
-
2541
- <span class='type'></span>
2542
-
2543
-
2544
-
2545
- &mdash;
2546
- <div class='inline'>
2547
- <p>Access signature can be mandatory for specific context. Treezor will
2548
- contact you if so. More info [here](<a
2549
- href="https://agent.treezor.com/security-authentication">agent.treezor.com/security-authentication</a>).</p>
2550
- </div>
2551
-
2552
- </li>
2553
-
2554
- <li>
2555
-
2556
- <span class='name'>user_id</span>
2557
-
2558
-
2559
- <span class='type'></span>
2560
-
2561
-
2562
-
2563
- &mdash;
2564
- <div class='inline'>
2565
- <p>User&amp;#39;s is who initiates the mandate request.</p>
2566
- </div>
2567
-
2568
- </li>
2569
-
2570
- <li>
2571
-
2572
- <span class='name'>otp</span>
2573
-
2574
-
2575
- <span class='type'></span>
2576
-
2577
-
2578
-
2579
- &mdash;
2580
- <div class='inline'>
2581
- <p>The One-time password that the user got once mandate created.</p>
2582
- </div>
2583
-
2584
- </li>
2585
-
2586
- <li>
2587
-
2588
- <span class='name'>opts</span>
2589
-
2590
-
2591
- <span class='type'>(<tt>Hash</tt>)</span>
2592
-
2593
-
2594
- <em class="default">(defaults to: <tt>{}</tt>)</em>
2595
-
2596
-
2597
- &mdash;
2598
- <div class='inline'>
2599
- <p>the optional parameters</p>
2600
- </div>
2601
-
2602
- </li>
2603
-
2604
- </ul>
2605
-
2606
-
2607
-
2608
-
2609
-
2610
-
2611
-
2612
-
2613
-
2614
-
2615
-
2616
-
2617
-
2618
-
2619
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
2620
- <ul class="option">
2621
-
2622
- <li>
2623
- <span class="name">:access_tag</span>
2624
- <span class="type">(<tt>String</tt>)</span>
2625
- <span class="default">
2626
-
2627
- </span>
2628
-
2629
- &mdash; <div class='inline'>
2630
- <p>Access tag is used for idem potency query. More info [here](<a
2631
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
2632
- </div>
2633
-
2634
- </li>
2635
-
2636
- <li>
2637
- <span class="name">:access_user_id</span>
2638
- <span class="type">(<tt>Integer</tt>)</span>
2639
- <span class="default">
2640
-
2641
- </span>
2642
-
2643
- &mdash; <div class='inline'>
2644
- <p>Access user&amp;#39;s id is used for user&amp;#39;s action restriction.
2645
- More info [here](<a
2646
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
2647
- </div>
2648
-
2649
- </li>
2650
-
2651
- <li>
2652
- <span class="name">:access_user_ip</span>
2653
- <span class="type">(<tt>String</tt>)</span>
2654
- <span class="default">
2655
-
2656
- </span>
2657
-
2658
- &mdash; <div class='inline'>
2659
- <p>Access user&amp;#39;s ip is used for user&amp;#39;s action restriction.
2660
- More info [here](<a
2661
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
2662
- </div>
2663
-
2664
- </li>
2665
-
2666
- <li>
2667
- <span class="name">:debtor_signature_ip</span>
2668
- <span class="type">(<tt>String</tt>)</span>
2669
- <span class="default">
2670
-
2671
- </span>
2672
-
2673
- &mdash; <div class='inline'>
2674
- <p>IP address from which the mandate will be signed.</p>
2675
- </div>
2676
-
2677
- </li>
2678
-
2679
- </ul>
2680
-
2681
-
2682
- <p class="tag_title">Returns:</p>
2683
- <ul class="return">
2684
-
2685
- <li>
2686
-
2687
-
2688
- <span class='type'>(<tt>Array&lt;(<span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span>, Fixnum, Hash)&gt;</tt>)</span>
2689
-
2690
-
2691
-
2692
- &mdash;
2693
- <div class='inline'>
2694
- <p>InlineResponse20012 data, response status code and response headers</p>
2695
- </div>
2696
-
2697
- </li>
2698
-
2699
- </ul>
2700
-
2701
- </div><table class="source_code">
2702
- <tr>
2703
- <td>
2704
- <pre class="lines">
2705
-
2706
-
2707
- 335
2708
- 336
2709
- 337
2710
- 338
2711
- 339
2712
- 340
2713
- 341
2714
- 342
2715
- 343
2716
- 344
2717
- 345
2718
- 346
2719
- 347
2720
- 348
2721
- 349
2722
- 350
2723
- 351
2724
- 352
2725
- 353
2726
- 354
2727
- 355
2728
- 356
2729
- 357
2730
- 358
2731
- 359
2732
- 360
2733
- 361
2734
- 362
2735
- 363
2736
- 364
2737
- 365
2738
- 366
2739
- 367
2740
- 368
2741
- 369
2742
- 370
2743
- 371
2744
- 372
2745
- 373
2746
- 374
2747
- 375
2748
- 376
2749
- 377
2750
- 378
2751
- 379
2752
- 380
2753
- 381
2754
- 382
2755
- 383
2756
- 384
2757
- 385
2758
- 386
2759
- 387
2760
- 388
2761
- 389
2762
- 390
2763
- 391
2764
- 392
2765
- 393</pre>
2766
- </td>
2767
- <td>
2768
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/mandate_api.rb', line 335</span>
2769
-
2770
- <span class='kw'>def</span> <span class='id identifier rubyid_mandates_id_sign_put_with_http_info'>mandates_id_sign_put_with_http_info</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='comma'>,</span> <span class='id identifier rubyid_access_signature'>access_signature</span><span class='comma'>,</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_otp'>otp</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
2771
- <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_debugging'>debugging</span>
2772
- <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Calling API: MandateApi.mandates_id_sign_put ...</span><span class='tstring_end'>&quot;</span></span>
2773
- <span class='kw'>end</span>
2774
- <span class='comment'># verify the required parameter &#39;id&#39; is set
2775
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2776
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;id&#39; when calling MandateApi.mandates_id_sign_put</span><span class='tstring_end'>&quot;</span></span>
2777
- <span class='kw'>end</span>
2778
- <span class='comment'># verify the required parameter &#39;access_token&#39; is set
2779
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2780
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;access_token&#39; when calling MandateApi.mandates_id_sign_put</span><span class='tstring_end'>&quot;</span></span>
2781
- <span class='kw'>end</span>
2782
- <span class='comment'># verify the required parameter &#39;access_signature&#39; is set
2783
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_access_signature'>access_signature</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2784
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;access_signature&#39; when calling MandateApi.mandates_id_sign_put</span><span class='tstring_end'>&quot;</span></span>
2785
- <span class='kw'>end</span>
2786
- <span class='comment'># verify the required parameter &#39;user_id&#39; is set
2787
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2788
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;user_id&#39; when calling MandateApi.mandates_id_sign_put</span><span class='tstring_end'>&quot;</span></span>
2789
- <span class='kw'>end</span>
2790
- <span class='comment'># verify the required parameter &#39;otp&#39; is set
2791
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_otp'>otp</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2792
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;otp&#39; when calling MandateApi.mandates_id_sign_put</span><span class='tstring_end'>&quot;</span></span>
2793
- <span class='kw'>end</span>
2794
- <span class='comment'># resource path
2795
- </span> <span class='id identifier rubyid_local_var_path'>local_var_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/mandates/{id}/Sign/</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_sub'>sub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>{</span><span class='tstring_end'>&#39;</span></span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>}</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
2796
-
2797
- <span class='comment'># query parameters
2798
- </span> <span class='id identifier rubyid_query_params'>query_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
2799
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessToken&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_access_token'>access_token</span>
2800
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessSignature&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_access_signature'>access_signature</span>
2801
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;userId&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_user_id'>user_id</span>
2802
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;otp&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_otp'>otp</span>
2803
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessTag&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_tag&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_tag&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2804
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessUserId&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_user_id&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_user_id&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2805
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessUserIp&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_user_ip&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_user_ip&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2806
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;debtorSignatureIp&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;debtor_signature_ip&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;debtor_signature_ip&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2807
-
2808
- <span class='comment'># header parameters
2809
- </span> <span class='id identifier rubyid_header_params'>header_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
2810
-
2811
- <span class='comment'># form parameters
2812
- </span> <span class='id identifier rubyid_form_params'>form_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
2813
-
2814
- <span class='comment'># http body (model)
2815
- </span> <span class='id identifier rubyid_post_body'>post_body</span> <span class='op'>=</span> <span class='kw'>nil</span>
2816
- <span class='id identifier rubyid_auth_names'>auth_names</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>api_key</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
2817
- <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_status_code'>status_code</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='symbol'>:PUT</span><span class='comma'>,</span> <span class='id identifier rubyid_local_var_path'>local_var_path</span><span class='comma'>,</span>
2818
- <span class='symbol'>:header_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_header_params'>header_params</span><span class='comma'>,</span>
2819
- <span class='symbol'>:query_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_query_params'>query_params</span><span class='comma'>,</span>
2820
- <span class='symbol'>:form_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_form_params'>form_params</span><span class='comma'>,</span>
2821
- <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_post_body'>post_body</span><span class='comma'>,</span>
2822
- <span class='symbol'>:auth_names</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_auth_names'>auth_names</span><span class='comma'>,</span>
2823
- <span class='symbol'>:return_type</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>InlineResponse20012</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
2824
- <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_debugging'>debugging</span>
2825
- <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>API called: MandateApi#mandates_id_sign_put\nData: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>\nStatus code: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_status_code'>status_code</span><span class='embexpr_end'>}</span><span class='tstring_content'>\nHeaders: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_headers'>headers</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
2826
- <span class='kw'>end</span>
2827
- <span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_status_code'>status_code</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span>
2828
- <span class='kw'>end</span></pre>
2829
- </td>
2830
- </tr>
2831
- </table>
2832
- </div>
2833
-
2834
- <div class="method_details ">
2835
- <h3 class="signature " id="post_mandates-instance_method">
2836
-
2837
- #<strong>post_mandates</strong>(sdd_type, is_paper, user_id, debtor_name, debtor_address, debtor_city, debtor_zip_code, debtor_country, debtor_iban, sequence_type, created_ip, opts = {}) &#x21d2; <tt><span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span></tt>
2838
-
2839
-
2840
-
2841
-
2842
-
2843
- </h3><div class="docstring">
2844
- <div class="discussion">
2845
-
2846
- <p>create a mandate Create a new mandate in the system.</p>
2847
-
2848
-
2849
- </div>
2850
- </div>
2851
- <div class="tags">
2852
- <p class="tag_title">Parameters:</p>
2853
- <ul class="param">
2854
-
2855
- <li>
2856
-
2857
- <span class='name'>sdd_type</span>
2858
-
2859
-
2860
- <span class='type'></span>
2861
-
2862
-
2863
-
2864
- &mdash;
2865
- <div class='inline'>
2866
- <p>Type of mandate. | Type | Description | | —- | ———– | | core | Sepa Direct
2867
- Debit Core | | b2b | Sepa Direct Debit Business 2 Business |</p>
2868
- </div>
2869
-
2870
- </li>
2871
-
2872
- <li>
2873
-
2874
- <span class='name'>is_paper</span>
2875
-
2876
-
2877
- <span class='type'></span>
2878
-
2879
-
2880
-
2881
- &mdash;
2882
- <div class='inline'>
2883
- <p>Indicate if it&amp;#39;s a paper mandate or not</p>
2884
- </div>
2885
-
2886
- </li>
2887
-
2888
- <li>
2889
-
2890
- <span class='name'>user_id</span>
2891
-
2892
-
2893
- <span class='type'></span>
2894
-
2895
-
2896
-
2897
- &mdash;
2898
- <div class='inline'>
2899
- <p>User&amp;#39;s id who initiates the mandate request. The creditor.</p>
2900
- </div>
2901
-
2902
- </li>
2903
-
2904
- <li>
2905
-
2906
- <span class='name'>debtor_name</span>
2907
-
2908
-
2909
- <span class='type'></span>
2910
-
2911
-
2912
-
2913
- &mdash;
2914
- <div class='inline'>
2915
- <p>Debtor&amp;#39;s full name</p>
2916
- </div>
2917
-
2918
- </li>
2919
-
2920
- <li>
2921
-
2922
- <span class='name'>debtor_address</span>
2923
-
2924
-
2925
- <span class='type'></span>
2926
-
2927
-
2928
-
2929
- &mdash;
2930
- <div class='inline'>
2931
- <p>Debtor&amp;#39;s address.</p>
2932
- </div>
2933
-
2934
- </li>
2935
-
2936
- <li>
2937
-
2938
- <span class='name'>debtor_city</span>
2939
-
2940
-
2941
- <span class='type'></span>
2942
-
2943
-
2944
-
2945
- &mdash;
2946
- <div class='inline'>
2947
- <p>Debtor&amp;#39;s city.</p>
2948
- </div>
2949
-
2950
- </li>
2951
-
2952
- <li>
2953
-
2954
- <span class='name'>debtor_zip_code</span>
2955
-
2956
-
2957
- <span class='type'></span>
2958
-
2959
-
2960
-
2961
- &mdash;
2962
- <div class='inline'>
2963
- <p>Debtor&amp;#39;s zip code</p>
2964
- </div>
2965
-
2966
- </li>
2967
-
2968
- <li>
2969
-
2970
- <span class='name'>debtor_country</span>
2971
-
2972
-
2973
- <span class='type'></span>
2974
-
2975
-
2976
-
2977
- &mdash;
2978
- <div class='inline'>
2979
- <p>Debtor&amp;#39;s country</p>
2980
- </div>
2981
-
2982
- </li>
2983
-
2984
- <li>
2985
-
2986
- <span class='name'>debtor_iban</span>
2987
-
2988
-
2989
- <span class='type'></span>
2990
-
2991
-
2992
-
2993
- &mdash;
2994
- <div class='inline'>
2995
- <p>Debtor&amp;#39;s IBAN</p>
2996
- </div>
2997
-
2998
- </li>
2999
-
3000
- <li>
3001
-
3002
- <span class='name'>sequence_type</span>
3003
-
3004
-
3005
- <span class='type'></span>
3006
-
3007
-
3008
-
3009
- &mdash;
3010
- <div class='inline'>
3011
- <p>Type of mandate. | Type | Description | | —- | ———– | | one-off | One-off
3012
- payment | | recurrent | Recurrent payment | Default value: one-off.</p>
3013
- </div>
3014
-
3015
- </li>
3016
-
3017
- <li>
3018
-
3019
- <span class='name'>created_ip</span>
3020
-
3021
-
3022
- <span class='type'></span>
3023
-
3024
-
3025
-
3026
- &mdash;
3027
- <div class='inline'>
3028
- <p>IP address of the system that created mandate.</p>
3029
- </div>
3030
-
3031
- </li>
3032
-
3033
- <li>
3034
-
3035
- <span class='name'>opts</span>
3036
-
3037
-
3038
- <span class='type'>(<tt>Hash</tt>)</span>
3039
-
3040
-
3041
- <em class="default">(defaults to: <tt>{}</tt>)</em>
3042
-
3043
-
3044
- &mdash;
3045
- <div class='inline'>
3046
- <p>the optional parameters</p>
3047
- </div>
3048
-
3049
- </li>
3050
-
3051
- </ul>
3052
-
3053
-
3054
-
3055
-
3056
-
3057
-
3058
-
3059
-
3060
-
3061
-
3062
-
3063
-
3064
-
3065
-
3066
-
3067
-
3068
-
3069
-
3070
-
3071
-
3072
-
3073
-
3074
-
3075
-
3076
-
3077
-
3078
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
3079
- <ul class="option">
3080
-
3081
- <li>
3082
- <span class="name">:access_signature</span>
3083
- <span class="type">(<tt>String</tt>)</span>
3084
- <span class="default">
3085
-
3086
- </span>
3087
-
3088
- &mdash; <div class='inline'>
3089
- <p>Access signature can be mandatory for specific context. Treezor will
3090
- contact you if so. More info [here](<a
3091
- href="https://agent.treezor.com/security-authentication">agent.treezor.com/security-authentication</a>).</p>
3092
- </div>
3093
-
3094
- </li>
3095
-
3096
- <li>
3097
- <span class="name">:access_tag</span>
3098
- <span class="type">(<tt>String</tt>)</span>
3099
- <span class="default">
3100
-
3101
- </span>
3102
-
3103
- &mdash; <div class='inline'>
3104
- <p>Access tag is used for idem potency query. More info [here](<a
3105
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
3106
- </div>
3107
-
3108
- </li>
3109
-
3110
- <li>
3111
- <span class="name">:access_user_id</span>
3112
- <span class="type">(<tt>Integer</tt>)</span>
3113
- <span class="default">
3114
-
3115
- </span>
3116
-
3117
- &mdash; <div class='inline'>
3118
- <p>Access user&amp;#39;s id is used for user&amp;#39;s action restriction.
3119
- More info [here](<a
3120
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
3121
- </div>
3122
-
3123
- </li>
3124
-
3125
- <li>
3126
- <span class="name">:access_user_ip</span>
3127
- <span class="type">(<tt>String</tt>)</span>
3128
- <span class="default">
3129
-
3130
- </span>
3131
-
3132
- &mdash; <div class='inline'>
3133
- <p>Access user&amp;#39;s ip is used for user&amp;#39;s action restriction.
3134
- More info [here](<a
3135
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
3136
- </div>
3137
-
3138
- </li>
3139
-
3140
- <li>
3141
- <span class="name">:debtor_bic</span>
3142
- <span class="type">(<tt>String</tt>)</span>
3143
- <span class="default">
3144
-
3145
- </span>
3146
-
3147
- &mdash; <div class='inline'>
3148
- <p>Debtor&amp;#39;s BIC (or SWIFT)</p>
3149
- </div>
3150
-
3151
- </li>
3152
-
3153
- <li>
3154
- <span class="name">:signature_date</span>
3155
- <span class="type">(<tt>String</tt>)</span>
3156
- <span class="default">
3157
-
3158
- </span>
3159
-
3160
- &mdash; <div class='inline'>
3161
- <p>Signature date of the mandate. Required if is paper.</p>
3162
- </div>
3163
-
3164
- </li>
3165
-
3166
- </ul>
3167
-
3168
-
3169
- <p class="tag_title">Returns:</p>
3170
- <ul class="return">
3171
-
3172
- <li>
3173
-
3174
-
3175
- <span class='type'>(<tt><span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span></tt>)</span>
3176
-
3177
-
3178
-
3179
- </li>
3180
-
3181
- </ul>
3182
-
3183
- </div><table class="source_code">
3184
- <tr>
3185
- <td>
3186
- <pre class="lines">
3187
-
3188
-
3189
- 416
3190
- 417
3191
- 418
3192
- 419</pre>
3193
- </td>
3194
- <td>
3195
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/mandate_api.rb', line 416</span>
3196
-
3197
- <span class='kw'>def</span> <span class='id identifier rubyid_post_mandates'>post_mandates</span><span class='lparen'>(</span><span class='id identifier rubyid_sdd_type'>sdd_type</span><span class='comma'>,</span> <span class='id identifier rubyid_is_paper'>is_paper</span><span class='comma'>,</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_name'>debtor_name</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_address'>debtor_address</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_city'>debtor_city</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_zip_code'>debtor_zip_code</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_country'>debtor_country</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_iban'>debtor_iban</span><span class='comma'>,</span> <span class='id identifier rubyid_sequence_type'>sequence_type</span><span class='comma'>,</span> <span class='id identifier rubyid_created_ip'>created_ip</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
3198
- <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid__status_code'>_status_code</span><span class='comma'>,</span> <span class='id identifier rubyid__headers'>_headers</span> <span class='op'>=</span> <span class='id identifier rubyid_post_mandates_with_http_info'>post_mandates_with_http_info</span><span class='lparen'>(</span><span class='id identifier rubyid_sdd_type'>sdd_type</span><span class='comma'>,</span> <span class='id identifier rubyid_is_paper'>is_paper</span><span class='comma'>,</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_name'>debtor_name</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_address'>debtor_address</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_city'>debtor_city</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_zip_code'>debtor_zip_code</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_country'>debtor_country</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_iban'>debtor_iban</span><span class='comma'>,</span> <span class='id identifier rubyid_sequence_type'>sequence_type</span><span class='comma'>,</span> <span class='id identifier rubyid_created_ip'>created_ip</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
3199
- <span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span>
3200
- <span class='kw'>end</span></pre>
3201
- </td>
3202
- </tr>
3203
- </table>
3204
- </div>
3205
-
3206
- <div class="method_details ">
3207
- <h3 class="signature " id="post_mandates_with_http_info-instance_method">
3208
-
3209
- #<strong>post_mandates_with_http_info</strong>(sdd_type, is_paper, user_id, debtor_name, debtor_address, debtor_city, debtor_zip_code, debtor_country, debtor_iban, sequence_type, created_ip, opts = {}) &#x21d2; <tt>Array&lt;(<span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span>, Fixnum, Hash)&gt;</tt>
3210
-
3211
-
3212
-
3213
-
3214
-
3215
- </h3><div class="docstring">
3216
- <div class="discussion">
3217
-
3218
- <p>create a mandate Create a new mandate in the system.</p>
3219
-
3220
-
3221
- </div>
3222
- </div>
3223
- <div class="tags">
3224
- <p class="tag_title">Parameters:</p>
3225
- <ul class="param">
3226
-
3227
- <li>
3228
-
3229
- <span class='name'>sdd_type</span>
3230
-
3231
-
3232
- <span class='type'></span>
3233
-
3234
-
3235
-
3236
- &mdash;
3237
- <div class='inline'>
3238
- <p>Type of mandate. | Type | Description | | —- | ———– | | core | Sepa Direct
3239
- Debit Core | | b2b | Sepa Direct Debit Business 2 Business |</p>
3240
- </div>
3241
-
3242
- </li>
3243
-
3244
- <li>
3245
-
3246
- <span class='name'>is_paper</span>
3247
-
3248
-
3249
- <span class='type'></span>
3250
-
3251
-
3252
-
3253
- &mdash;
3254
- <div class='inline'>
3255
- <p>Indicate if it&amp;#39;s a paper mandate or not</p>
3256
- </div>
3257
-
3258
- </li>
3259
-
3260
- <li>
3261
-
3262
- <span class='name'>user_id</span>
3263
-
3264
-
3265
- <span class='type'></span>
3266
-
3267
-
3268
-
3269
- &mdash;
3270
- <div class='inline'>
3271
- <p>User&amp;#39;s id who initiates the mandate request. The creditor.</p>
3272
- </div>
3273
-
3274
- </li>
3275
-
3276
- <li>
3277
-
3278
- <span class='name'>debtor_name</span>
3279
-
3280
-
3281
- <span class='type'></span>
3282
-
3283
-
3284
-
3285
- &mdash;
3286
- <div class='inline'>
3287
- <p>Debtor&amp;#39;s full name</p>
3288
- </div>
3289
-
3290
- </li>
3291
-
3292
- <li>
3293
-
3294
- <span class='name'>debtor_address</span>
3295
-
3296
-
3297
- <span class='type'></span>
3298
-
3299
-
3300
-
3301
- &mdash;
3302
- <div class='inline'>
3303
- <p>Debtor&amp;#39;s address.</p>
3304
- </div>
3305
-
3306
- </li>
3307
-
3308
- <li>
3309
-
3310
- <span class='name'>debtor_city</span>
3311
-
3312
-
3313
- <span class='type'></span>
3314
-
3315
-
3316
-
3317
- &mdash;
3318
- <div class='inline'>
3319
- <p>Debtor&amp;#39;s city.</p>
3320
- </div>
3321
-
3322
- </li>
3323
-
3324
- <li>
3325
-
3326
- <span class='name'>debtor_zip_code</span>
3327
-
3328
-
3329
- <span class='type'></span>
3330
-
3331
-
3332
-
3333
- &mdash;
3334
- <div class='inline'>
3335
- <p>Debtor&amp;#39;s zip code</p>
3336
- </div>
3337
-
3338
- </li>
3339
-
3340
- <li>
3341
-
3342
- <span class='name'>debtor_country</span>
3343
-
3344
-
3345
- <span class='type'></span>
3346
-
3347
-
3348
-
3349
- &mdash;
3350
- <div class='inline'>
3351
- <p>Debtor&amp;#39;s country</p>
3352
- </div>
3353
-
3354
- </li>
3355
-
3356
- <li>
3357
-
3358
- <span class='name'>debtor_iban</span>
3359
-
3360
-
3361
- <span class='type'></span>
3362
-
3363
-
3364
-
3365
- &mdash;
3366
- <div class='inline'>
3367
- <p>Debtor&amp;#39;s IBAN</p>
3368
- </div>
3369
-
3370
- </li>
3371
-
3372
- <li>
3373
-
3374
- <span class='name'>sequence_type</span>
3375
-
3376
-
3377
- <span class='type'></span>
3378
-
3379
-
3380
-
3381
- &mdash;
3382
- <div class='inline'>
3383
- <p>Type of mandate. | Type | Description | | —- | ———– | | one-off | One-off
3384
- payment | | recurrent | Recurrent payment | Default value: one-off.</p>
3385
- </div>
3386
-
3387
- </li>
3388
-
3389
- <li>
3390
-
3391
- <span class='name'>created_ip</span>
3392
-
3393
-
3394
- <span class='type'></span>
3395
-
3396
-
3397
-
3398
- &mdash;
3399
- <div class='inline'>
3400
- <p>IP address of the system that created mandate.</p>
3401
- </div>
3402
-
3403
- </li>
3404
-
3405
- <li>
3406
-
3407
- <span class='name'>opts</span>
3408
-
3409
-
3410
- <span class='type'>(<tt>Hash</tt>)</span>
3411
-
3412
-
3413
- <em class="default">(defaults to: <tt>{}</tt>)</em>
3414
-
3415
-
3416
- &mdash;
3417
- <div class='inline'>
3418
- <p>the optional parameters</p>
3419
- </div>
3420
-
3421
- </li>
3422
-
3423
- </ul>
3424
-
3425
-
3426
-
3427
-
3428
-
3429
-
3430
-
3431
-
3432
-
3433
-
3434
-
3435
-
3436
-
3437
-
3438
-
3439
-
3440
-
3441
-
3442
-
3443
-
3444
-
3445
-
3446
-
3447
-
3448
-
3449
-
3450
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
3451
- <ul class="option">
3452
-
3453
- <li>
3454
- <span class="name">:access_signature</span>
3455
- <span class="type">(<tt>String</tt>)</span>
3456
- <span class="default">
3457
-
3458
- </span>
3459
-
3460
- &mdash; <div class='inline'>
3461
- <p>Access signature can be mandatory for specific context. Treezor will
3462
- contact you if so. More info [here](<a
3463
- href="https://agent.treezor.com/security-authentication">agent.treezor.com/security-authentication</a>).</p>
3464
- </div>
3465
-
3466
- </li>
3467
-
3468
- <li>
3469
- <span class="name">:access_tag</span>
3470
- <span class="type">(<tt>String</tt>)</span>
3471
- <span class="default">
3472
-
3473
- </span>
3474
-
3475
- &mdash; <div class='inline'>
3476
- <p>Access tag is used for idem potency query. More info [here](<a
3477
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
3478
- </div>
3479
-
3480
- </li>
3481
-
3482
- <li>
3483
- <span class="name">:access_user_id</span>
3484
- <span class="type">(<tt>Integer</tt>)</span>
3485
- <span class="default">
3486
-
3487
- </span>
3488
-
3489
- &mdash; <div class='inline'>
3490
- <p>Access user&amp;#39;s id is used for user&amp;#39;s action restriction.
3491
- More info [here](<a
3492
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
3493
- </div>
3494
-
3495
- </li>
3496
-
3497
- <li>
3498
- <span class="name">:access_user_ip</span>
3499
- <span class="type">(<tt>String</tt>)</span>
3500
- <span class="default">
3501
-
3502
- </span>
3503
-
3504
- &mdash; <div class='inline'>
3505
- <p>Access user&amp;#39;s ip is used for user&amp;#39;s action restriction.
3506
- More info [here](<a
3507
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
3508
- </div>
3509
-
3510
- </li>
3511
-
3512
- <li>
3513
- <span class="name">:debtor_bic</span>
3514
- <span class="type">(<tt>String</tt>)</span>
3515
- <span class="default">
3516
-
3517
- </span>
3518
-
3519
- &mdash; <div class='inline'>
3520
- <p>Debtor&amp;#39;s BIC (or SWIFT)</p>
3521
- </div>
3522
-
3523
- </li>
3524
-
3525
- <li>
3526
- <span class="name">:signature_date</span>
3527
- <span class="type">(<tt>String</tt>)</span>
3528
- <span class="default">
3529
-
3530
- </span>
3531
-
3532
- &mdash; <div class='inline'>
3533
- <p>Signature date of the mandate. Required if is paper.</p>
3534
- </div>
3535
-
3536
- </li>
3537
-
3538
- </ul>
3539
-
3540
-
3541
- <p class="tag_title">Returns:</p>
3542
- <ul class="return">
3543
-
3544
- <li>
3545
-
3546
-
3547
- <span class='type'>(<tt>Array&lt;(<span class='object_link'><a href="InlineResponse20012.html" title="TreezorClient::InlineResponse20012 (class)">InlineResponse20012</a></span>, Fixnum, Hash)&gt;</tt>)</span>
3548
-
3549
-
3550
-
3551
- &mdash;
3552
- <div class='inline'>
3553
- <p>InlineResponse20012 data, response status code and response headers</p>
3554
- </div>
3555
-
3556
- </li>
3557
-
3558
- </ul>
3559
-
3560
- </div><table class="source_code">
3561
- <tr>
3562
- <td>
3563
- <pre class="lines">
3564
-
3565
-
3566
- 442
3567
- 443
3568
- 444
3569
- 445
3570
- 446
3571
- 447
3572
- 448
3573
- 449
3574
- 450
3575
- 451
3576
- 452
3577
- 453
3578
- 454
3579
- 455
3580
- 456
3581
- 457
3582
- 458
3583
- 459
3584
- 460
3585
- 461
3586
- 462
3587
- 463
3588
- 464
3589
- 465
3590
- 466
3591
- 467
3592
- 468
3593
- 469
3594
- 470
3595
- 471
3596
- 472
3597
- 473
3598
- 474
3599
- 475
3600
- 476
3601
- 477
3602
- 478
3603
- 479
3604
- 480
3605
- 481
3606
- 482
3607
- 483
3608
- 484
3609
- 485
3610
- 486
3611
- 487
3612
- 488
3613
- 489
3614
- 490
3615
- 491
3616
- 492
3617
- 493
3618
- 494
3619
- 495
3620
- 496
3621
- 497
3622
- 498
3623
- 499
3624
- 500
3625
- 501
3626
- 502
3627
- 503
3628
- 504
3629
- 505
3630
- 506
3631
- 507
3632
- 508
3633
- 509
3634
- 510
3635
- 511
3636
- 512
3637
- 513
3638
- 514
3639
- 515
3640
- 516
3641
- 517
3642
- 518
3643
- 519
3644
- 520
3645
- 521
3646
- 522
3647
- 523
3648
- 524
3649
- 525
3650
- 526
3651
- 527
3652
- 528
3653
- 529
3654
- 530
3655
- 531
3656
- 532
3657
- 533
3658
- 534
3659
- 535
3660
- 536
3661
- 537
3662
- 538
3663
- 539
3664
- 540
3665
- 541</pre>
3666
- </td>
3667
- <td>
3668
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/mandate_api.rb', line 442</span>
3669
-
3670
- <span class='kw'>def</span> <span class='id identifier rubyid_post_mandates_with_http_info'>post_mandates_with_http_info</span><span class='lparen'>(</span><span class='id identifier rubyid_sdd_type'>sdd_type</span><span class='comma'>,</span> <span class='id identifier rubyid_is_paper'>is_paper</span><span class='comma'>,</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_name'>debtor_name</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_address'>debtor_address</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_city'>debtor_city</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_zip_code'>debtor_zip_code</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_country'>debtor_country</span><span class='comma'>,</span> <span class='id identifier rubyid_debtor_iban'>debtor_iban</span><span class='comma'>,</span> <span class='id identifier rubyid_sequence_type'>sequence_type</span><span class='comma'>,</span> <span class='id identifier rubyid_created_ip'>created_ip</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
3671
- <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_debugging'>debugging</span>
3672
- <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Calling API: MandateApi.post_mandates ...</span><span class='tstring_end'>&quot;</span></span>
3673
- <span class='kw'>end</span>
3674
- <span class='comment'># verify the required parameter &#39;sdd_type&#39; is set
3675
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_sdd_type'>sdd_type</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3676
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;sdd_type&#39; when calling MandateApi.post_mandates</span><span class='tstring_end'>&quot;</span></span>
3677
- <span class='kw'>end</span>
3678
- <span class='comment'># verify enum value
3679
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>core</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>b2b</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_sdd_type'>sdd_type</span><span class='rparen'>)</span>
3680
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>invalid value for &#39;sdd_type&#39;, must be one of core, b2b</span><span class='tstring_end'>&quot;</span></span>
3681
- <span class='kw'>end</span>
3682
- <span class='comment'># verify the required parameter &#39;is_paper&#39; is set
3683
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_is_paper'>is_paper</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3684
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;is_paper&#39; when calling MandateApi.post_mandates</span><span class='tstring_end'>&quot;</span></span>
3685
- <span class='kw'>end</span>
3686
- <span class='comment'># verify the required parameter &#39;user_id&#39; is set
3687
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_user_id'>user_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3688
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;user_id&#39; when calling MandateApi.post_mandates</span><span class='tstring_end'>&quot;</span></span>
3689
- <span class='kw'>end</span>
3690
- <span class='comment'># verify the required parameter &#39;debtor_name&#39; is set
3691
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_debtor_name'>debtor_name</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3692
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;debtor_name&#39; when calling MandateApi.post_mandates</span><span class='tstring_end'>&quot;</span></span>
3693
- <span class='kw'>end</span>
3694
- <span class='comment'># verify the required parameter &#39;debtor_address&#39; is set
3695
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_debtor_address'>debtor_address</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3696
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;debtor_address&#39; when calling MandateApi.post_mandates</span><span class='tstring_end'>&quot;</span></span>
3697
- <span class='kw'>end</span>
3698
- <span class='comment'># verify the required parameter &#39;debtor_city&#39; is set
3699
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_debtor_city'>debtor_city</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3700
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;debtor_city&#39; when calling MandateApi.post_mandates</span><span class='tstring_end'>&quot;</span></span>
3701
- <span class='kw'>end</span>
3702
- <span class='comment'># verify the required parameter &#39;debtor_zip_code&#39; is set
3703
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_debtor_zip_code'>debtor_zip_code</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3704
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;debtor_zip_code&#39; when calling MandateApi.post_mandates</span><span class='tstring_end'>&quot;</span></span>
3705
- <span class='kw'>end</span>
3706
- <span class='comment'># verify the required parameter &#39;debtor_country&#39; is set
3707
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_debtor_country'>debtor_country</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3708
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;debtor_country&#39; when calling MandateApi.post_mandates</span><span class='tstring_end'>&quot;</span></span>
3709
- <span class='kw'>end</span>
3710
- <span class='comment'># verify the required parameter &#39;debtor_iban&#39; is set
3711
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_debtor_iban'>debtor_iban</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3712
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;debtor_iban&#39; when calling MandateApi.post_mandates</span><span class='tstring_end'>&quot;</span></span>
3713
- <span class='kw'>end</span>
3714
- <span class='comment'># verify the required parameter &#39;sequence_type&#39; is set
3715
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_sequence_type'>sequence_type</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3716
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;sequence_type&#39; when calling MandateApi.post_mandates</span><span class='tstring_end'>&quot;</span></span>
3717
- <span class='kw'>end</span>
3718
- <span class='comment'># verify the required parameter &#39;created_ip&#39; is set
3719
- </span> <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_client_side_validation'>client_side_validation</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_created_ip'>created_ip</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3720
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing the required parameter &#39;created_ip&#39; when calling MandateApi.post_mandates</span><span class='tstring_end'>&quot;</span></span>
3721
- <span class='kw'>end</span>
3722
- <span class='comment'># resource path
3723
- </span> <span class='id identifier rubyid_local_var_path'>local_var_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/mandates</span><span class='tstring_end'>&quot;</span></span>
3724
-
3725
- <span class='comment'># query parameters
3726
- </span> <span class='id identifier rubyid_query_params'>query_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
3727
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;sddType&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_sdd_type'>sdd_type</span>
3728
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;isPaper&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_is_paper'>is_paper</span>
3729
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;userId&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_user_id'>user_id</span>
3730
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;debtorName&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_debtor_name'>debtor_name</span>
3731
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;debtorAddress&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_debtor_address'>debtor_address</span>
3732
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;debtorCity&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_debtor_city'>debtor_city</span>
3733
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;debtorZipCode&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_debtor_zip_code'>debtor_zip_code</span>
3734
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;debtorCountry&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_debtor_country'>debtor_country</span>
3735
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;debtorIban&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_debtor_iban'>debtor_iban</span>
3736
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;sequenceType&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_sequence_type'>sequence_type</span>
3737
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;createdIp&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_created_ip'>created_ip</span>
3738
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessSignature&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_signature&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_signature&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3739
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessTag&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_tag&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_tag&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3740
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessUserId&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_user_id&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_user_id&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3741
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;accessUserIp&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_user_ip&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;access_user_ip&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3742
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;debtorBic&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;debtor_bic&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;debtor_bic&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3743
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;signatureDate&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;signature_date&#39;</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;signature_date&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
3744
-
3745
- <span class='comment'># header parameters
3746
- </span> <span class='id identifier rubyid_header_params'>header_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
3747
- <span class='comment'># HTTP header &#39;Accept&#39; (if needed)
3748
- </span> <span class='id identifier rubyid_header_params'>header_params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Accept</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_select_header_accept'>select_header_accept</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
3749
- <span class='comment'># HTTP header &#39;Content-Type&#39;
3750
- </span> <span class='id identifier rubyid_header_params'>header_params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_select_header_content_type'>select_header_content_type</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
3751
-
3752
- <span class='comment'># form parameters
3753
- </span> <span class='id identifier rubyid_form_params'>form_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
3754
-
3755
- <span class='comment'># http body (model)
3756
- </span> <span class='id identifier rubyid_post_body'>post_body</span> <span class='op'>=</span> <span class='kw'>nil</span>
3757
- <span class='id identifier rubyid_auth_names'>auth_names</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>api_key</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
3758
- <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_status_code'>status_code</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='symbol'>:POST</span><span class='comma'>,</span> <span class='id identifier rubyid_local_var_path'>local_var_path</span><span class='comma'>,</span>
3759
- <span class='symbol'>:header_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_header_params'>header_params</span><span class='comma'>,</span>
3760
- <span class='symbol'>:query_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_query_params'>query_params</span><span class='comma'>,</span>
3761
- <span class='symbol'>:form_params</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_form_params'>form_params</span><span class='comma'>,</span>
3762
- <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_post_body'>post_body</span><span class='comma'>,</span>
3763
- <span class='symbol'>:auth_names</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_auth_names'>auth_names</span><span class='comma'>,</span>
3764
- <span class='symbol'>:return_type</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>InlineResponse20012</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
3765
- <span class='kw'>if</span> <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_debugging'>debugging</span>
3766
- <span class='ivar'>@api_client</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>API called: MandateApi#post_mandates\nData: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>\nStatus code: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_status_code'>status_code</span><span class='embexpr_end'>}</span><span class='tstring_content'>\nHeaders: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_headers'>headers</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
3767
- <span class='kw'>end</span>
3768
- <span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_status_code'>status_code</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span>
3769
- <span class='kw'>end</span></pre>
3770
- </td>
3771
- </tr>
3772
- </table>
3773
- </div>
3774
-
3775
- </div>
3776
-
3777
- </div>
3778
-
3779
- <div id="footer">
3780
- Generated on Wed Aug 8 17:39:08 2018 by
3781
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
3782
- 0.9.15 (ruby-2.5.1).
3783
- </div>
3784
-
3785
- </div>
3786
- </body>
3787
- </html>