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,2878 +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::DocumentApi
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::DocumentApi";
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 (D)</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">DocumentApi</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::DocumentApi
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::DocumentApi</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/document_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="#create_documents-instance_method" title="#create_documents (instance method)">#<strong>create_documents</strong>(user_id, document_type_id, name, file_content_base64, opts = {}) &#x21d2; InlineResponse20011 </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>create a document Search for documents.</p>
168
- </div></span>
169
-
170
- </li>
171
-
172
-
173
- <li class="public ">
174
- <span class="summary_signature">
175
-
176
- <a href="#create_documents_with_http_info-instance_method" title="#create_documents_with_http_info (instance method)">#<strong>create_documents_with_http_info</strong>(user_id, document_type_id, name, file_content_base64, opts = {}) &#x21d2; Array&lt;(InlineResponse20011, 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>create a document Search for documents.</p>
192
- </div></span>
193
-
194
- </li>
195
-
196
-
197
- <li class="public ">
198
- <span class="summary_signature">
199
-
200
- <a href="#delete_document-instance_method" title="#delete_document (instance method)">#<strong>delete_document</strong>(id, opts = {}) &#x21d2; InlineResponse20011 </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>delete document Remove a document 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="#delete_document_with_http_info-instance_method" title="#delete_document_with_http_info (instance method)">#<strong>delete_document_with_http_info</strong>(id, opts = {}) &#x21d2; Array&lt;(InlineResponse20011, 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>delete document Remove a document 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_document-instance_method" title="#get_document (instance method)">#<strong>get_document</strong>(id, opts = {}) &#x21d2; InlineResponse20011 </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>get a document get a document.</p>
264
- </div></span>
265
-
266
- </li>
267
-
268
-
269
- <li class="public ">
270
- <span class="summary_signature">
271
-
272
- <a href="#get_document_with_http_info-instance_method" title="#get_document_with_http_info (instance method)">#<strong>get_document_with_http_info</strong>(id, opts = {}) &#x21d2; Array&lt;(InlineResponse20011, 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>get a document get a document.</p>
288
- </div></span>
289
-
290
- </li>
291
-
292
-
293
- <li class="public ">
294
- <span class="summary_signature">
295
-
296
- <a href="#get_documents-instance_method" title="#get_documents (instance method)">#<strong>get_documents</strong>(opts = {}) &#x21d2; InlineResponse20011 </a>
297
-
298
-
299
-
300
- </span>
301
-
302
-
303
-
304
-
305
-
306
-
307
-
308
-
309
-
310
- <span class="summary_desc"><div class='inline'>
311
- <p>search documents Search for documents.</p>
312
- </div></span>
313
-
314
- </li>
315
-
316
-
317
- <li class="public ">
318
- <span class="summary_signature">
319
-
320
- <a href="#get_documents_with_http_info-instance_method" title="#get_documents_with_http_info (instance method)">#<strong>get_documents_with_http_info</strong>(opts = {}) &#x21d2; Array&lt;(InlineResponse20011, Fixnum, Hash)&gt; </a>
321
-
322
-
323
-
324
- </span>
325
-
326
-
327
-
328
-
329
-
330
-
331
-
332
-
333
-
334
- <span class="summary_desc"><div class='inline'>
335
- <p>search documents Search for documents.</p>
336
- </div></span>
337
-
338
- </li>
339
-
340
-
341
- <li class="public ">
342
- <span class="summary_signature">
343
-
344
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(api_client = ApiClient.default) &#x21d2; DocumentApi </a>
345
-
346
-
347
-
348
- </span>
349
-
350
-
351
- <span class="note title constructor">constructor</span>
352
-
353
-
354
-
355
-
356
-
357
-
358
-
359
-
360
- <span class="summary_desc"><div class='inline'>
361
- <p>A new instance of DocumentApi.</p>
362
- </div></span>
363
-
364
- </li>
365
-
366
-
367
- <li class="public ">
368
- <span class="summary_signature">
369
-
370
- <a href="#put_document-instance_method" title="#put_document (instance method)">#<strong>put_document</strong>(id, opts = {}) &#x21d2; InlineResponse20011 </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>update a document Update a document.</p>
386
- </div></span>
387
-
388
- </li>
389
-
390
-
391
- <li class="public ">
392
- <span class="summary_signature">
393
-
394
- <a href="#put_document_with_http_info-instance_method" title="#put_document_with_http_info (instance method)">#<strong>put_document_with_http_info</strong>(id, opts = {}) &#x21d2; Array&lt;(InlineResponse20011, 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>update a document Update a document.</p>
410
- </div></span>
411
-
412
- </li>
413
-
414
-
415
- </ul>
416
-
417
-
418
- <div id="constructor_details" class="method_details_list">
419
- <h2>Constructor Details</h2>
420
-
421
- <div class="method_details first">
422
- <h3 class="signature first" id="initialize-instance_method">
423
-
424
- #<strong>initialize</strong>(api_client = ApiClient.default) &#x21d2; <tt><span class='object_link'><a href="" title="TreezorClient::DocumentApi (class)">DocumentApi</a></span></tt>
425
-
426
-
427
-
428
-
429
-
430
- </h3><div class="docstring">
431
- <div class="discussion">
432
-
433
- <p>Returns a new instance of DocumentApi</p>
434
-
435
-
436
- </div>
437
- </div>
438
- <div class="tags">
439
-
440
-
441
- </div><table class="source_code">
442
- <tr>
443
- <td>
444
- <pre class="lines">
445
-
446
-
447
- 19
448
- 20
449
- 21</pre>
450
- </td>
451
- <td>
452
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/document_api.rb', line 19</span>
453
-
454
- <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>
455
- <span class='ivar'>@api_client</span> <span class='op'>=</span> <span class='id identifier rubyid_api_client'>api_client</span>
456
- <span class='kw'>end</span></pre>
457
- </td>
458
- </tr>
459
- </table>
460
- </div>
461
-
462
- </div>
463
-
464
- <div id="instance_attr_details" class="attr_details">
465
- <h2>Instance Attribute Details</h2>
466
-
467
-
468
- <span id="api_client=-instance_method"></span>
469
- <div class="method_details first">
470
- <h3 class="signature first" id="api_client-instance_method">
471
-
472
- #<strong>api_client</strong> &#x21d2; <tt>Object</tt>
473
-
474
-
475
-
476
-
477
-
478
- </h3><div class="docstring">
479
- <div class="discussion">
480
-
481
- <p>Returns the value of attribute api_client</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
- 17
496
- 18
497
- 19</pre>
498
- </td>
499
- <td>
500
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/document_api.rb', line 17</span>
501
-
502
- <span class='kw'>def</span> <span class='id identifier rubyid_api_client'>api_client</span>
503
- <span class='ivar'>@api_client</span>
504
- <span class='kw'>end</span></pre>
505
- </td>
506
- </tr>
507
- </table>
508
- </div>
509
-
510
- </div>
511
-
512
-
513
- <div id="instance_method_details" class="method_details_list">
514
- <h2>Instance Method Details</h2>
515
-
516
-
517
- <div class="method_details first">
518
- <h3 class="signature first" id="create_documents-instance_method">
519
-
520
- #<strong>create_documents</strong>(user_id, document_type_id, name, file_content_base64, opts = {}) &#x21d2; <tt><span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span></tt>
521
-
522
-
523
-
524
-
525
-
526
- </h3><div class="docstring">
527
- <div class="discussion">
528
-
529
- <p>create a document Search for documents.</p>
530
-
531
-
532
- </div>
533
- </div>
534
- <div class="tags">
535
- <p class="tag_title">Parameters:</p>
536
- <ul class="param">
537
-
538
- <li>
539
-
540
- <span class='name'>user_id</span>
541
-
542
-
543
- <span class='type'></span>
544
-
545
-
546
-
547
- &mdash;
548
- <div class='inline'>
549
- <p>Document user&amp;#39;s id.</p>
550
- </div>
551
-
552
- </li>
553
-
554
- <li>
555
-
556
- <span class='name'>document_type_id</span>
557
-
558
-
559
- <span class='type'></span>
560
-
561
-
562
-
563
- &mdash;
564
- <div class='inline'>
565
- <p>Type of document. | documentTypeId | Description | | — | — | | 2 | Police
566
- record | | 4 | Company Registration | | 6 | CV | | 7 | Sworn statement | |
567
- 8 | Turnover | | 9 | Identity card | | 11 | Bank Identity Statement | | 12
568
- | Proof of address| | 13 | Mobile phone invoice| | 14 | Invoice, other than
569
- Mobile phone invoice| | 15 | A residence permit| | 16 | A driving licence|
570
- | 17 | A passport| | 18 | A proxy granting an employee| | 19 | A company
571
- registration official paper| | 20 | Official tax certificate| | 21 |
572
- Employee payment notice| | 22 | User bank statement| | 23 | Business legal
573
- status|</p>
574
- </div>
575
-
576
- </li>
577
-
578
- <li>
579
-
580
- <span class='name'>name</span>
581
-
582
-
583
- <span class='type'></span>
584
-
585
-
586
-
587
- &mdash;
588
- <div class='inline'>
589
- <p>Document&amp;#39;s name.</p>
590
- </div>
591
-
592
- </li>
593
-
594
- <li>
595
-
596
- <span class='name'>file_content_base64</span>
597
-
598
-
599
- <span class='type'></span>
600
-
601
-
602
-
603
- &mdash;
604
- <div class='inline'>
605
- <p>Document file content. base64 encoded.</p>
606
- </div>
607
-
608
- </li>
609
-
610
- <li>
611
-
612
- <span class='name'>opts</span>
613
-
614
-
615
- <span class='type'>(<tt>Hash</tt>)</span>
616
-
617
-
618
- <em class="default">(defaults to: <tt>{}</tt>)</em>
619
-
620
-
621
- &mdash;
622
- <div class='inline'>
623
- <p>the optional parameters</p>
624
- </div>
625
-
626
- </li>
627
-
628
- </ul>
629
-
630
-
631
-
632
-
633
-
634
-
635
-
636
-
637
-
638
-
639
-
640
-
641
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
642
- <ul class="option">
643
-
644
- <li>
645
- <span class="name">:access_signature</span>
646
- <span class="type">(<tt>String</tt>)</span>
647
- <span class="default">
648
-
649
- </span>
650
-
651
- &mdash; <div class='inline'>
652
- <p>Access signature can be mandatory for specific context. Treezor will
653
- contact you if so. More info [here](<a
654
- href="https://agent.treezor.com/security-authentication">agent.treezor.com/security-authentication</a>).</p>
655
- </div>
656
-
657
- </li>
658
-
659
- <li>
660
- <span class="name">:access_tag</span>
661
- <span class="type">(<tt>String</tt>)</span>
662
- <span class="default">
663
-
664
- </span>
665
-
666
- &mdash; <div class='inline'>
667
- <p>Access tag is used for idem potency query. More info [here](<a
668
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
669
- </div>
670
-
671
- </li>
672
-
673
- <li>
674
- <span class="name">:access_user_id</span>
675
- <span class="type">(<tt>Integer</tt>)</span>
676
- <span class="default">
677
-
678
- </span>
679
-
680
- &mdash; <div class='inline'>
681
- <p>Access user&amp;#39;s id is used for user&amp;#39;s action restriction.
682
- More info [here](<a
683
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
684
- </div>
685
-
686
- </li>
687
-
688
- <li>
689
- <span class="name">:access_user_ip</span>
690
- <span class="type">(<tt>String</tt>)</span>
691
- <span class="default">
692
-
693
- </span>
694
-
695
- &mdash; <div class='inline'>
696
- <p>Access user&amp;#39;s ip is used for user&amp;#39;s action restriction.
697
- More info [here](<a
698
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
699
- </div>
700
-
701
- </li>
702
-
703
- <li>
704
- <span class="name">:document_tag</span>
705
- <span class="type">(<tt>Integer</tt>)</span>
706
- <span class="default">
707
-
708
- </span>
709
-
710
- &mdash; <div class='inline'>
711
- <p>Custom data.</p>
712
- </div>
713
-
714
- </li>
715
-
716
- </ul>
717
-
718
-
719
- <p class="tag_title">Returns:</p>
720
- <ul class="return">
721
-
722
- <li>
723
-
724
-
725
- <span class='type'>(<tt><span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span></tt>)</span>
726
-
727
-
728
-
729
- </li>
730
-
731
- </ul>
732
-
733
- </div><table class="source_code">
734
- <tr>
735
- <td>
736
- <pre class="lines">
737
-
738
-
739
- 36
740
- 37
741
- 38
742
- 39</pre>
743
- </td>
744
- <td>
745
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/document_api.rb', line 36</span>
746
-
747
- <span class='kw'>def</span> <span class='id identifier rubyid_create_documents'>create_documents</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_document_type_id'>document_type_id</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_file_content_base64'>file_content_base64</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>
748
- <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_create_documents_with_http_info'>create_documents_with_http_info</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_document_type_id'>document_type_id</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_file_content_base64'>file_content_base64</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
749
- <span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span>
750
- <span class='kw'>end</span></pre>
751
- </td>
752
- </tr>
753
- </table>
754
- </div>
755
-
756
- <div class="method_details ">
757
- <h3 class="signature " id="create_documents_with_http_info-instance_method">
758
-
759
- #<strong>create_documents_with_http_info</strong>(user_id, document_type_id, name, file_content_base64, opts = {}) &#x21d2; <tt>Array&lt;(<span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span>, Fixnum, Hash)&gt;</tt>
760
-
761
-
762
-
763
-
764
-
765
- </h3><div class="docstring">
766
- <div class="discussion">
767
-
768
- <p>create a document Search for documents.</p>
769
-
770
-
771
- </div>
772
- </div>
773
- <div class="tags">
774
- <p class="tag_title">Parameters:</p>
775
- <ul class="param">
776
-
777
- <li>
778
-
779
- <span class='name'>user_id</span>
780
-
781
-
782
- <span class='type'></span>
783
-
784
-
785
-
786
- &mdash;
787
- <div class='inline'>
788
- <p>Document user&amp;#39;s id.</p>
789
- </div>
790
-
791
- </li>
792
-
793
- <li>
794
-
795
- <span class='name'>document_type_id</span>
796
-
797
-
798
- <span class='type'></span>
799
-
800
-
801
-
802
- &mdash;
803
- <div class='inline'>
804
- <p>Type of document. | documentTypeId | Description | | — | — | | 2 | Police
805
- record | | 4 | Company Registration | | 6 | CV | | 7 | Sworn statement | |
806
- 8 | Turnover | | 9 | Identity card | | 11 | Bank Identity Statement | | 12
807
- | Proof of address| | 13 | Mobile phone invoice| | 14 | Invoice, other than
808
- Mobile phone invoice| | 15 | A residence permit| | 16 | A driving licence|
809
- | 17 | A passport| | 18 | A proxy granting an employee| | 19 | A company
810
- registration official paper| | 20 | Official tax certificate| | 21 |
811
- Employee payment notice| | 22 | User bank statement| | 23 | Business legal
812
- status|</p>
813
- </div>
814
-
815
- </li>
816
-
817
- <li>
818
-
819
- <span class='name'>name</span>
820
-
821
-
822
- <span class='type'></span>
823
-
824
-
825
-
826
- &mdash;
827
- <div class='inline'>
828
- <p>Document&amp;#39;s name.</p>
829
- </div>
830
-
831
- </li>
832
-
833
- <li>
834
-
835
- <span class='name'>file_content_base64</span>
836
-
837
-
838
- <span class='type'></span>
839
-
840
-
841
-
842
- &mdash;
843
- <div class='inline'>
844
- <p>Document file content. base64 encoded.</p>
845
- </div>
846
-
847
- </li>
848
-
849
- <li>
850
-
851
- <span class='name'>opts</span>
852
-
853
-
854
- <span class='type'>(<tt>Hash</tt>)</span>
855
-
856
-
857
- <em class="default">(defaults to: <tt>{}</tt>)</em>
858
-
859
-
860
- &mdash;
861
- <div class='inline'>
862
- <p>the optional parameters</p>
863
- </div>
864
-
865
- </li>
866
-
867
- </ul>
868
-
869
-
870
-
871
-
872
-
873
-
874
-
875
-
876
-
877
-
878
-
879
-
880
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
881
- <ul class="option">
882
-
883
- <li>
884
- <span class="name">:access_signature</span>
885
- <span class="type">(<tt>String</tt>)</span>
886
- <span class="default">
887
-
888
- </span>
889
-
890
- &mdash; <div class='inline'>
891
- <p>Access signature can be mandatory for specific context. Treezor will
892
- contact you if so. More info [here](<a
893
- href="https://agent.treezor.com/security-authentication">agent.treezor.com/security-authentication</a>).</p>
894
- </div>
895
-
896
- </li>
897
-
898
- <li>
899
- <span class="name">:access_tag</span>
900
- <span class="type">(<tt>String</tt>)</span>
901
- <span class="default">
902
-
903
- </span>
904
-
905
- &mdash; <div class='inline'>
906
- <p>Access tag is used for idem potency query. More info [here](<a
907
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
908
- </div>
909
-
910
- </li>
911
-
912
- <li>
913
- <span class="name">:access_user_id</span>
914
- <span class="type">(<tt>Integer</tt>)</span>
915
- <span class="default">
916
-
917
- </span>
918
-
919
- &mdash; <div class='inline'>
920
- <p>Access user&amp;#39;s id is used for user&amp;#39;s action restriction.
921
- More info [here](<a
922
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
923
- </div>
924
-
925
- </li>
926
-
927
- <li>
928
- <span class="name">:access_user_ip</span>
929
- <span class="type">(<tt>String</tt>)</span>
930
- <span class="default">
931
-
932
- </span>
933
-
934
- &mdash; <div class='inline'>
935
- <p>Access user&amp;#39;s ip is used for user&amp;#39;s action restriction.
936
- More info [here](<a
937
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
938
- </div>
939
-
940
- </li>
941
-
942
- <li>
943
- <span class="name">:document_tag</span>
944
- <span class="type">(<tt>Integer</tt>)</span>
945
- <span class="default">
946
-
947
- </span>
948
-
949
- &mdash; <div class='inline'>
950
- <p>Custom data.</p>
951
- </div>
952
-
953
- </li>
954
-
955
- </ul>
956
-
957
-
958
- <p class="tag_title">Returns:</p>
959
- <ul class="return">
960
-
961
- <li>
962
-
963
-
964
- <span class='type'>(<tt>Array&lt;(<span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span>, Fixnum, Hash)&gt;</tt>)</span>
965
-
966
-
967
-
968
- &mdash;
969
- <div class='inline'>
970
- <p>InlineResponse20011 data, response status code and response headers</p>
971
- </div>
972
-
973
- </li>
974
-
975
- </ul>
976
-
977
- </div><table class="source_code">
978
- <tr>
979
- <td>
980
- <pre class="lines">
981
-
982
-
983
- 54
984
- 55
985
- 56
986
- 57
987
- 58
988
- 59
989
- 60
990
- 61
991
- 62
992
- 63
993
- 64
994
- 65
995
- 66
996
- 67
997
- 68
998
- 69
999
- 70
1000
- 71
1001
- 72
1002
- 73
1003
- 74
1004
- 75
1005
- 76
1006
- 77
1007
- 78
1008
- 79
1009
- 80
1010
- 81
1011
- 82
1012
- 83
1013
- 84
1014
- 85
1015
- 86
1016
- 87
1017
- 88
1018
- 89
1019
- 90
1020
- 91
1021
- 92
1022
- 93
1023
- 94
1024
- 95
1025
- 96
1026
- 97
1027
- 98
1028
- 99
1029
- 100
1030
- 101
1031
- 102
1032
- 103
1033
- 104
1034
- 105
1035
- 106
1036
- 107
1037
- 108
1038
- 109
1039
- 110
1040
- 111
1041
- 112
1042
- 113</pre>
1043
- </td>
1044
- <td>
1045
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/document_api.rb', line 54</span>
1046
-
1047
- <span class='kw'>def</span> <span class='id identifier rubyid_create_documents_with_http_info'>create_documents_with_http_info</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='comma'>,</span> <span class='id identifier rubyid_document_type_id'>document_type_id</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_file_content_base64'>file_content_base64</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>
1048
- <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>
1049
- <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: DocumentApi.create_documents ...</span><span class='tstring_end'>&quot;</span></span>
1050
- <span class='kw'>end</span>
1051
- <span class='comment'># verify the required parameter &#39;user_id&#39; is set
1052
- </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>
1053
- <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 DocumentApi.create_documents</span><span class='tstring_end'>&quot;</span></span>
1054
- <span class='kw'>end</span>
1055
- <span class='comment'># verify the required parameter &#39;document_type_id&#39; is set
1056
- </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_document_type_id'>document_type_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1057
- <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;document_type_id&#39; when calling DocumentApi.create_documents</span><span class='tstring_end'>&quot;</span></span>
1058
- <span class='kw'>end</span>
1059
- <span class='comment'># verify the required parameter &#39;name&#39; is set
1060
- </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_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1061
- <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;name&#39; when calling DocumentApi.create_documents</span><span class='tstring_end'>&quot;</span></span>
1062
- <span class='kw'>end</span>
1063
- <span class='comment'># verify the required parameter &#39;file_content_base64&#39; is set
1064
- </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_file_content_base64'>file_content_base64</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1065
- <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;file_content_base64&#39; when calling DocumentApi.create_documents</span><span class='tstring_end'>&quot;</span></span>
1066
- <span class='kw'>end</span>
1067
- <span class='comment'># resource path
1068
- </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'>/documents</span><span class='tstring_end'>&quot;</span></span>
1069
-
1070
- <span class='comment'># query parameters
1071
- </span> <span class='id identifier rubyid_query_params'>query_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1072
- <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>
1073
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;documentTypeId&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_document_type_id'>document_type_id</span>
1074
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;name&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
1075
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;fileContentBase64&#39;</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_file_content_base64'>file_content_base64</span>
1076
- <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>
1077
- <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>
1078
- <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>
1079
- <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>
1080
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;documentTag&#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;document_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;document_tag&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
1081
-
1082
- <span class='comment'># header parameters
1083
- </span> <span class='id identifier rubyid_header_params'>header_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1084
- <span class='comment'># HTTP header &#39;Accept&#39; (if needed)
1085
- </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>
1086
- <span class='comment'># HTTP header &#39;Content-Type&#39;
1087
- </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>
1088
-
1089
- <span class='comment'># form parameters
1090
- </span> <span class='id identifier rubyid_form_params'>form_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1091
-
1092
- <span class='comment'># http body (model)
1093
- </span> <span class='id identifier rubyid_post_body'>post_body</span> <span class='op'>=</span> <span class='kw'>nil</span>
1094
- <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>
1095
- <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>
1096
- <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>
1097
- <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>
1098
- <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>
1099
- <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_post_body'>post_body</span><span class='comma'>,</span>
1100
- <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>
1101
- <span class='symbol'>:return_type</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>InlineResponse20011</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1102
- <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>
1103
- <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: DocumentApi#create_documents\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>
1104
- <span class='kw'>end</span>
1105
- <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>
1106
- <span class='kw'>end</span></pre>
1107
- </td>
1108
- </tr>
1109
- </table>
1110
- </div>
1111
-
1112
- <div class="method_details ">
1113
- <h3 class="signature " id="delete_document-instance_method">
1114
-
1115
- #<strong>delete_document</strong>(id, opts = {}) &#x21d2; <tt><span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span></tt>
1116
-
1117
-
1118
-
1119
-
1120
-
1121
- </h3><div class="docstring">
1122
- <div class="discussion">
1123
-
1124
- <p>delete document Remove a document from the system.</p>
1125
-
1126
-
1127
- </div>
1128
- </div>
1129
- <div class="tags">
1130
- <p class="tag_title">Parameters:</p>
1131
- <ul class="param">
1132
-
1133
- <li>
1134
-
1135
- <span class='name'>id</span>
1136
-
1137
-
1138
- <span class='type'></span>
1139
-
1140
-
1141
-
1142
- &mdash;
1143
- <div class='inline'>
1144
- <p>Document&amp;#39;s internal id.</p>
1145
- </div>
1146
-
1147
- </li>
1148
-
1149
- <li>
1150
-
1151
- <span class='name'>opts</span>
1152
-
1153
-
1154
- <span class='type'>(<tt>Hash</tt>)</span>
1155
-
1156
-
1157
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1158
-
1159
-
1160
- &mdash;
1161
- <div class='inline'>
1162
- <p>the optional parameters</p>
1163
- </div>
1164
-
1165
- </li>
1166
-
1167
- </ul>
1168
-
1169
- <p class="tag_title">Returns:</p>
1170
- <ul class="return">
1171
-
1172
- <li>
1173
-
1174
-
1175
- <span class='type'>(<tt><span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span></tt>)</span>
1176
-
1177
-
1178
-
1179
- </li>
1180
-
1181
- </ul>
1182
-
1183
- </div><table class="source_code">
1184
- <tr>
1185
- <td>
1186
- <pre class="lines">
1187
-
1188
-
1189
- 120
1190
- 121
1191
- 122
1192
- 123</pre>
1193
- </td>
1194
- <td>
1195
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/document_api.rb', line 120</span>
1196
-
1197
- <span class='kw'>def</span> <span class='id identifier rubyid_delete_document'>delete_document</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>
1198
- <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_document_with_http_info'>delete_document_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>
1199
- <span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span>
1200
- <span class='kw'>end</span></pre>
1201
- </td>
1202
- </tr>
1203
- </table>
1204
- </div>
1205
-
1206
- <div class="method_details ">
1207
- <h3 class="signature " id="delete_document_with_http_info-instance_method">
1208
-
1209
- #<strong>delete_document_with_http_info</strong>(id, opts = {}) &#x21d2; <tt>Array&lt;(<span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span>, Fixnum, Hash)&gt;</tt>
1210
-
1211
-
1212
-
1213
-
1214
-
1215
- </h3><div class="docstring">
1216
- <div class="discussion">
1217
-
1218
- <p>delete document Remove a document from the system.</p>
1219
-
1220
-
1221
- </div>
1222
- </div>
1223
- <div class="tags">
1224
- <p class="tag_title">Parameters:</p>
1225
- <ul class="param">
1226
-
1227
- <li>
1228
-
1229
- <span class='name'>id</span>
1230
-
1231
-
1232
- <span class='type'></span>
1233
-
1234
-
1235
-
1236
- &mdash;
1237
- <div class='inline'>
1238
- <p>Document&amp;#39;s internal id.</p>
1239
- </div>
1240
-
1241
- </li>
1242
-
1243
- <li>
1244
-
1245
- <span class='name'>opts</span>
1246
-
1247
-
1248
- <span class='type'>(<tt>Hash</tt>)</span>
1249
-
1250
-
1251
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1252
-
1253
-
1254
- &mdash;
1255
- <div class='inline'>
1256
- <p>the optional parameters</p>
1257
- </div>
1258
-
1259
- </li>
1260
-
1261
- </ul>
1262
-
1263
- <p class="tag_title">Returns:</p>
1264
- <ul class="return">
1265
-
1266
- <li>
1267
-
1268
-
1269
- <span class='type'>(<tt>Array&lt;(<span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span>, Fixnum, Hash)&gt;</tt>)</span>
1270
-
1271
-
1272
-
1273
- &mdash;
1274
- <div class='inline'>
1275
- <p>InlineResponse20011 data, response status code and response headers</p>
1276
- </div>
1277
-
1278
- </li>
1279
-
1280
- </ul>
1281
-
1282
- </div><table class="source_code">
1283
- <tr>
1284
- <td>
1285
- <pre class="lines">
1286
-
1287
-
1288
- 130
1289
- 131
1290
- 132
1291
- 133
1292
- 134
1293
- 135
1294
- 136
1295
- 137
1296
- 138
1297
- 139
1298
- 140
1299
- 141
1300
- 142
1301
- 143
1302
- 144
1303
- 145
1304
- 146
1305
- 147
1306
- 148
1307
- 149
1308
- 150
1309
- 151
1310
- 152
1311
- 153
1312
- 154
1313
- 155
1314
- 156
1315
- 157
1316
- 158
1317
- 159
1318
- 160
1319
- 161
1320
- 162
1321
- 163
1322
- 164
1323
- 165
1324
- 166
1325
- 167
1326
- 168</pre>
1327
- </td>
1328
- <td>
1329
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/document_api.rb', line 130</span>
1330
-
1331
- <span class='kw'>def</span> <span class='id identifier rubyid_delete_document_with_http_info'>delete_document_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>
1332
- <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>
1333
- <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: DocumentApi.delete_document ...</span><span class='tstring_end'>&quot;</span></span>
1334
- <span class='kw'>end</span>
1335
- <span class='comment'># verify the required parameter &#39;id&#39; is set
1336
- </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>
1337
- <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 DocumentApi.delete_document</span><span class='tstring_end'>&quot;</span></span>
1338
- <span class='kw'>end</span>
1339
- <span class='comment'># resource path
1340
- </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'>/documents/{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>
1341
-
1342
- <span class='comment'># query parameters
1343
- </span> <span class='id identifier rubyid_query_params'>query_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1344
-
1345
- <span class='comment'># header parameters
1346
- </span> <span class='id identifier rubyid_header_params'>header_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1347
- <span class='comment'># HTTP header &#39;Accept&#39; (if needed)
1348
- </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>
1349
- <span class='comment'># HTTP header &#39;Content-Type&#39;
1350
- </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>
1351
-
1352
- <span class='comment'># form parameters
1353
- </span> <span class='id identifier rubyid_form_params'>form_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1354
-
1355
- <span class='comment'># http body (model)
1356
- </span> <span class='id identifier rubyid_post_body'>post_body</span> <span class='op'>=</span> <span class='kw'>nil</span>
1357
- <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>
1358
- <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>
1359
- <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>
1360
- <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>
1361
- <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>
1362
- <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_post_body'>post_body</span><span class='comma'>,</span>
1363
- <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>
1364
- <span class='symbol'>:return_type</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>InlineResponse20011</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1365
- <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>
1366
- <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: DocumentApi#delete_document\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>
1367
- <span class='kw'>end</span>
1368
- <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>
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_document-instance_method">
1377
-
1378
- #<strong>get_document</strong>(id, opts = {}) &#x21d2; <tt><span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span></tt>
1379
-
1380
-
1381
-
1382
-
1383
-
1384
- </h3><div class="docstring">
1385
- <div class="discussion">
1386
-
1387
- <p>get a document get a document</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'>id</span>
1399
-
1400
-
1401
- <span class='type'></span>
1402
-
1403
-
1404
-
1405
- &mdash;
1406
- <div class='inline'>
1407
- <p>Document&amp;#39;s internal id.</p>
1408
- </div>
1409
-
1410
- </li>
1411
-
1412
- <li>
1413
-
1414
- <span class='name'>opts</span>
1415
-
1416
-
1417
- <span class='type'>(<tt>Hash</tt>)</span>
1418
-
1419
-
1420
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1421
-
1422
-
1423
- &mdash;
1424
- <div class='inline'>
1425
- <p>the optional parameters</p>
1426
- </div>
1427
-
1428
- </li>
1429
-
1430
- </ul>
1431
-
1432
- <p class="tag_title">Returns:</p>
1433
- <ul class="return">
1434
-
1435
- <li>
1436
-
1437
-
1438
- <span class='type'>(<tt><span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span></tt>)</span>
1439
-
1440
-
1441
-
1442
- </li>
1443
-
1444
- </ul>
1445
-
1446
- </div><table class="source_code">
1447
- <tr>
1448
- <td>
1449
- <pre class="lines">
1450
-
1451
-
1452
- 175
1453
- 176
1454
- 177
1455
- 178</pre>
1456
- </td>
1457
- <td>
1458
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/document_api.rb', line 175</span>
1459
-
1460
- <span class='kw'>def</span> <span class='id identifier rubyid_get_document'>get_document</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>
1461
- <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_document_with_http_info'>get_document_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>
1462
- <span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span>
1463
- <span class='kw'>end</span></pre>
1464
- </td>
1465
- </tr>
1466
- </table>
1467
- </div>
1468
-
1469
- <div class="method_details ">
1470
- <h3 class="signature " id="get_document_with_http_info-instance_method">
1471
-
1472
- #<strong>get_document_with_http_info</strong>(id, opts = {}) &#x21d2; <tt>Array&lt;(<span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span>, Fixnum, Hash)&gt;</tt>
1473
-
1474
-
1475
-
1476
-
1477
-
1478
- </h3><div class="docstring">
1479
- <div class="discussion">
1480
-
1481
- <p>get a document get a document</p>
1482
-
1483
-
1484
- </div>
1485
- </div>
1486
- <div class="tags">
1487
- <p class="tag_title">Parameters:</p>
1488
- <ul class="param">
1489
-
1490
- <li>
1491
-
1492
- <span class='name'>id</span>
1493
-
1494
-
1495
- <span class='type'></span>
1496
-
1497
-
1498
-
1499
- &mdash;
1500
- <div class='inline'>
1501
- <p>Document&amp;#39;s internal id.</p>
1502
- </div>
1503
-
1504
- </li>
1505
-
1506
- <li>
1507
-
1508
- <span class='name'>opts</span>
1509
-
1510
-
1511
- <span class='type'>(<tt>Hash</tt>)</span>
1512
-
1513
-
1514
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1515
-
1516
-
1517
- &mdash;
1518
- <div class='inline'>
1519
- <p>the optional parameters</p>
1520
- </div>
1521
-
1522
- </li>
1523
-
1524
- </ul>
1525
-
1526
- <p class="tag_title">Returns:</p>
1527
- <ul class="return">
1528
-
1529
- <li>
1530
-
1531
-
1532
- <span class='type'>(<tt>Array&lt;(<span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span>, Fixnum, Hash)&gt;</tt>)</span>
1533
-
1534
-
1535
-
1536
- &mdash;
1537
- <div class='inline'>
1538
- <p>InlineResponse20011 data, response status code and response headers</p>
1539
- </div>
1540
-
1541
- </li>
1542
-
1543
- </ul>
1544
-
1545
- </div><table class="source_code">
1546
- <tr>
1547
- <td>
1548
- <pre class="lines">
1549
-
1550
-
1551
- 185
1552
- 186
1553
- 187
1554
- 188
1555
- 189
1556
- 190
1557
- 191
1558
- 192
1559
- 193
1560
- 194
1561
- 195
1562
- 196
1563
- 197
1564
- 198
1565
- 199
1566
- 200
1567
- 201
1568
- 202
1569
- 203
1570
- 204
1571
- 205
1572
- 206
1573
- 207
1574
- 208
1575
- 209
1576
- 210
1577
- 211
1578
- 212
1579
- 213
1580
- 214
1581
- 215
1582
- 216
1583
- 217
1584
- 218
1585
- 219
1586
- 220
1587
- 221
1588
- 222
1589
- 223</pre>
1590
- </td>
1591
- <td>
1592
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/document_api.rb', line 185</span>
1593
-
1594
- <span class='kw'>def</span> <span class='id identifier rubyid_get_document_with_http_info'>get_document_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>
1595
- <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>
1596
- <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: DocumentApi.get_document ...</span><span class='tstring_end'>&quot;</span></span>
1597
- <span class='kw'>end</span>
1598
- <span class='comment'># verify the required parameter &#39;id&#39; is set
1599
- </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>
1600
- <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 DocumentApi.get_document</span><span class='tstring_end'>&quot;</span></span>
1601
- <span class='kw'>end</span>
1602
- <span class='comment'># resource path
1603
- </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'>/documents/{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>
1604
-
1605
- <span class='comment'># query parameters
1606
- </span> <span class='id identifier rubyid_query_params'>query_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1607
-
1608
- <span class='comment'># header parameters
1609
- </span> <span class='id identifier rubyid_header_params'>header_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1610
- <span class='comment'># HTTP header &#39;Accept&#39; (if needed)
1611
- </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>
1612
- <span class='comment'># HTTP header &#39;Content-Type&#39;
1613
- </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>
1614
-
1615
- <span class='comment'># form parameters
1616
- </span> <span class='id identifier rubyid_form_params'>form_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1617
-
1618
- <span class='comment'># http body (model)
1619
- </span> <span class='id identifier rubyid_post_body'>post_body</span> <span class='op'>=</span> <span class='kw'>nil</span>
1620
- <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>
1621
- <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>
1622
- <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>
1623
- <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>
1624
- <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>
1625
- <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_post_body'>post_body</span><span class='comma'>,</span>
1626
- <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>
1627
- <span class='symbol'>:return_type</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>InlineResponse20011</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
1628
- <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>
1629
- <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: DocumentApi#get_document\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>
1630
- <span class='kw'>end</span>
1631
- <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>
1632
- <span class='kw'>end</span></pre>
1633
- </td>
1634
- </tr>
1635
- </table>
1636
- </div>
1637
-
1638
- <div class="method_details ">
1639
- <h3 class="signature " id="get_documents-instance_method">
1640
-
1641
- #<strong>get_documents</strong>(opts = {}) &#x21d2; <tt><span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span></tt>
1642
-
1643
-
1644
-
1645
-
1646
-
1647
- </h3><div class="docstring">
1648
- <div class="discussion">
1649
-
1650
- <p>search documents Search for documents.</p>
1651
-
1652
-
1653
- </div>
1654
- </div>
1655
- <div class="tags">
1656
- <p class="tag_title">Parameters:</p>
1657
- <ul class="param">
1658
-
1659
- <li>
1660
-
1661
- <span class='name'>opts</span>
1662
-
1663
-
1664
- <span class='type'>(<tt>Hash</tt>)</span>
1665
-
1666
-
1667
- <em class="default">(defaults to: <tt>{}</tt>)</em>
1668
-
1669
-
1670
- &mdash;
1671
- <div class='inline'>
1672
- <p>the optional parameters</p>
1673
- </div>
1674
-
1675
- </li>
1676
-
1677
- </ul>
1678
-
1679
-
1680
-
1681
-
1682
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
1683
- <ul class="option">
1684
-
1685
- <li>
1686
- <span class="name">:access_signature</span>
1687
- <span class="type">(<tt>String</tt>)</span>
1688
- <span class="default">
1689
-
1690
- </span>
1691
-
1692
- &mdash; <div class='inline'>
1693
- <p>Access signature can be mandatory for specific context. Treezor will
1694
- contact you if so. More info [here](<a
1695
- href="https://agent.treezor.com/security-authentication">agent.treezor.com/security-authentication</a>).</p>
1696
- </div>
1697
-
1698
- </li>
1699
-
1700
- <li>
1701
- <span class="name">:access_tag</span>
1702
- <span class="type">(<tt>String</tt>)</span>
1703
- <span class="default">
1704
-
1705
- </span>
1706
-
1707
- &mdash; <div class='inline'>
1708
- <p>Access tag is used for idem potency query. More info [here](<a
1709
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
1710
- </div>
1711
-
1712
- </li>
1713
-
1714
- <li>
1715
- <span class="name">:access_user_id</span>
1716
- <span class="type">(<tt>Integer</tt>)</span>
1717
- <span class="default">
1718
-
1719
- </span>
1720
-
1721
- &mdash; <div class='inline'>
1722
- <p>Access user&amp;#39;s id is used for user&amp;#39;s action restriction.
1723
- More info [here](<a
1724
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
1725
- </div>
1726
-
1727
- </li>
1728
-
1729
- <li>
1730
- <span class="name">:access_user_ip</span>
1731
- <span class="type">(<tt>String</tt>)</span>
1732
- <span class="default">
1733
-
1734
- </span>
1735
-
1736
- &mdash; <div class='inline'>
1737
- <p>Access user&amp;#39;s ip is used for user&amp;#39;s action restriction.
1738
- More info [here](<a
1739
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
1740
- </div>
1741
-
1742
- </li>
1743
-
1744
- <li>
1745
- <span class="name">:document_id</span>
1746
- <span class="type">(<tt>Integer</tt>)</span>
1747
- <span class="default">
1748
-
1749
- </span>
1750
-
1751
- &mdash; <div class='inline'>
1752
- <p>Document&amp;#39;s unique id.</p>
1753
- </div>
1754
-
1755
- </li>
1756
-
1757
- <li>
1758
- <span class="name">:document_tag</span>
1759
- <span class="type">(<tt>String</tt>)</span>
1760
- <span class="default">
1761
-
1762
- </span>
1763
-
1764
- &mdash; <div class='inline'>
1765
- <p>Custom data.</p>
1766
- </div>
1767
-
1768
- </li>
1769
-
1770
- <li>
1771
- <span class="name">:document_status</span>
1772
- <span class="type">(<tt>String</tt>)</span>
1773
- <span class="default">
1774
-
1775
- </span>
1776
-
1777
- &mdash; <div class='inline'>
1778
- <p>The status of the document. Possible values: * PENDING * CANCELED *
1779
- VALIDATED</p>
1780
- </div>
1781
-
1782
- </li>
1783
-
1784
- <li>
1785
- <span class="name">:document_type_id</span>
1786
- <span class="type">(<tt>Integer</tt>)</span>
1787
- <span class="default">
1788
-
1789
- </span>
1790
-
1791
- &mdash; <div class='inline'>
1792
- <p>Document type id.</p>
1793
- </div>
1794
-
1795
- </li>
1796
-
1797
- <li>
1798
- <span class="name">:document_type</span>
1799
- <span class="type">(<tt>String</tt>)</span>
1800
- <span class="default">
1801
-
1802
- </span>
1803
-
1804
- &mdash; <div class='inline'>
1805
- <p>Document&amp;#39;s type.</p>
1806
- </div>
1807
-
1808
- </li>
1809
-
1810
- <li>
1811
- <span class="name">:user_id</span>
1812
- <span class="type">(<tt>Integer</tt>)</span>
1813
- <span class="default">
1814
-
1815
- </span>
1816
-
1817
- &mdash; <div class='inline'>
1818
- <p>Document user&amp;#39;s id.</p>
1819
- </div>
1820
-
1821
- </li>
1822
-
1823
- <li>
1824
- <span class="name">:user_name</span>
1825
- <span class="type">(<tt>String</tt>)</span>
1826
- <span class="default">
1827
-
1828
- </span>
1829
-
1830
- &mdash; <div class='inline'>
1831
- <p>Document user&amp;#39;s name.</p>
1832
- </div>
1833
-
1834
- </li>
1835
-
1836
- <li>
1837
- <span class="name">:user_email</span>
1838
- <span class="type">(<tt>String</tt>)</span>
1839
- <span class="default">
1840
-
1841
- </span>
1842
-
1843
- &mdash; <div class='inline'>
1844
- <p>Document user&amp;#39;s email.</p>
1845
- </div>
1846
-
1847
- </li>
1848
-
1849
- <li>
1850
- <span class="name">:file_name</span>
1851
- <span class="type">(<tt>String</tt>)</span>
1852
- <span class="default">
1853
-
1854
- </span>
1855
-
1856
- &mdash; <div class='inline'>
1857
- <p>Document&amp;#39;s name.</p>
1858
- </div>
1859
-
1860
- </li>
1861
-
1862
- <li>
1863
- <span class="name">:file_size</span>
1864
- <span class="type">(<tt>Integer</tt>)</span>
1865
- <span class="default">
1866
-
1867
- </span>
1868
-
1869
- &mdash; <div class='inline'>
1870
- <p>Document&amp;#39;s size.</p>
1871
- </div>
1872
-
1873
- </li>
1874
-
1875
- <li>
1876
- <span class="name">:file_type</span>
1877
- <span class="type">(<tt>Integer</tt>)</span>
1878
- <span class="default">
1879
-
1880
- </span>
1881
-
1882
- &mdash; <div class='inline'>
1883
- <p>Document&amp;#39;s type.</p>
1884
- </div>
1885
-
1886
- </li>
1887
-
1888
- <li>
1889
- <span class="name">:is_agent</span>
1890
- <span class="type">(<tt>String</tt>)</span>
1891
- <span class="default">
1892
-
1893
- </span>
1894
-
1895
- &mdash; <div class='inline'>
1896
- <p>is agent field.</p>
1897
- </div>
1898
-
1899
- </li>
1900
-
1901
- <li>
1902
- <span class="name">:page_number</span>
1903
- <span class="type">(<tt>Integer</tt>)</span>
1904
- <span class="default">
1905
-
1906
- </span>
1907
-
1908
- &mdash; <div class='inline'>
1909
- <p>Pagination page number. More info [here](<a
1910
- href="https://agent.treezor.com/lists">agent.treezor.com/lists</a>).</p>
1911
- </div>
1912
-
1913
- </li>
1914
-
1915
- <li>
1916
- <span class="name">:page_count</span>
1917
- <span class="type">(<tt>Integer</tt>)</span>
1918
- <span class="default">
1919
-
1920
- </span>
1921
-
1922
- &mdash; <div class='inline'>
1923
- <p>The number of items per page. More info [here](<a
1924
- href="https://agent.treezor.com/lists">agent.treezor.com/lists</a>).</p>
1925
- </div>
1926
-
1927
- </li>
1928
-
1929
- <li>
1930
- <span class="name">:sort_by</span>
1931
- <span class="type">(<tt>String</tt>)</span>
1932
- <span class="default">
1933
-
1934
- </span>
1935
-
1936
- &mdash; <div class='inline'>
1937
- <p>The transaction element you want to sort the list with. Default value :
1938
- <em>createdDate</em>. More info [here](<a
1939
- href="https://agent.treezor.com/lists">agent.treezor.com/lists</a>).</p>
1940
- </div>
1941
-
1942
- </li>
1943
-
1944
- <li>
1945
- <span class="name">:sort_order</span>
1946
- <span class="type">(<tt>String</tt>)</span>
1947
- <span class="default">
1948
-
1949
- </span>
1950
-
1951
- &mdash; <div class='inline'>
1952
- <p>The order you want to sort the list. * *<strong>DESC</strong>* for a
1953
- descending sort * *<strong>ASC</strong>* for a ascending sort. Default
1954
- value : DESC. More info [here](<a
1955
- href="https://agent.treezor.com/lists">agent.treezor.com/lists</a>).</p>
1956
- </div>
1957
-
1958
- </li>
1959
-
1960
- <li>
1961
- <span class="name">:created_date_from</span>
1962
- <span class="type">(<tt>DateTime</tt>)</span>
1963
- <span class="default">
1964
-
1965
- </span>
1966
-
1967
- &mdash; <div class='inline'>
1968
- <p>The creation date from which you want to filter the request result. Format
1969
- YYYY-MM-DD HH:MM:SS. More info [here](<a
1970
- href="https://agent.treezor.com/lists">agent.treezor.com/lists</a>)</p>
1971
- </div>
1972
-
1973
- </li>
1974
-
1975
- <li>
1976
- <span class="name">:created_date_to</span>
1977
- <span class="type">(<tt>DateTime</tt>)</span>
1978
- <span class="default">
1979
-
1980
- </span>
1981
-
1982
- &mdash; <div class='inline'>
1983
- <p>The creation date up to which you want to filter the request result. Format
1984
- YYYY-MM-DD HH:MM:SS. More info [here](<a
1985
- href="https://agent.treezor.com/lists">agent.treezor.com/lists</a>)</p>
1986
- </div>
1987
-
1988
- </li>
1989
-
1990
- <li>
1991
- <span class="name">:updated_date_from</span>
1992
- <span class="type">(<tt>DateTime</tt>)</span>
1993
- <span class="default">
1994
-
1995
- </span>
1996
-
1997
- &mdash; <div class='inline'>
1998
- <p>The modification date from which you want to filter the request result.
1999
- Format YYYY-MM-DD HH:MM:SS. More info [here](<a
2000
- href="https://agent.treezor.com/lists">agent.treezor.com/lists</a>)</p>
2001
- </div>
2002
-
2003
- </li>
2004
-
2005
- <li>
2006
- <span class="name">:updated_date_to</span>
2007
- <span class="type">(<tt>DateTime</tt>)</span>
2008
- <span class="default">
2009
-
2010
- </span>
2011
-
2012
- &mdash; <div class='inline'>
2013
- <p>The modification date up to which you want to filter the request result.
2014
- Format YYYY-MM-DD HH:MM:SS. More info [here](<a
2015
- href="https://agent.treezor.com/lists">agent.treezor.com/lists</a>)</p>
2016
- </div>
2017
-
2018
- </li>
2019
-
2020
- </ul>
2021
-
2022
-
2023
- <p class="tag_title">Returns:</p>
2024
- <ul class="return">
2025
-
2026
- <li>
2027
-
2028
-
2029
- <span class='type'>(<tt><span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span></tt>)</span>
2030
-
2031
-
2032
-
2033
- </li>
2034
-
2035
- </ul>
2036
-
2037
- </div><table class="source_code">
2038
- <tr>
2039
- <td>
2040
- <pre class="lines">
2041
-
2042
-
2043
- 253
2044
- 254
2045
- 255
2046
- 256</pre>
2047
- </td>
2048
- <td>
2049
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/document_api.rb', line 253</span>
2050
-
2051
- <span class='kw'>def</span> <span class='id identifier rubyid_get_documents'>get_documents</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>
2052
- <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_documents_with_http_info'>get_documents_with_http_info</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
2053
- <span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span>
2054
- <span class='kw'>end</span></pre>
2055
- </td>
2056
- </tr>
2057
- </table>
2058
- </div>
2059
-
2060
- <div class="method_details ">
2061
- <h3 class="signature " id="get_documents_with_http_info-instance_method">
2062
-
2063
- #<strong>get_documents_with_http_info</strong>(opts = {}) &#x21d2; <tt>Array&lt;(<span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span>, Fixnum, Hash)&gt;</tt>
2064
-
2065
-
2066
-
2067
-
2068
-
2069
- </h3><div class="docstring">
2070
- <div class="discussion">
2071
-
2072
- <p>search documents Search for documents.</p>
2073
-
2074
-
2075
- </div>
2076
- </div>
2077
- <div class="tags">
2078
- <p class="tag_title">Parameters:</p>
2079
- <ul class="param">
2080
-
2081
- <li>
2082
-
2083
- <span class='name'>opts</span>
2084
-
2085
-
2086
- <span class='type'>(<tt>Hash</tt>)</span>
2087
-
2088
-
2089
- <em class="default">(defaults to: <tt>{}</tt>)</em>
2090
-
2091
-
2092
- &mdash;
2093
- <div class='inline'>
2094
- <p>the optional parameters</p>
2095
- </div>
2096
-
2097
- </li>
2098
-
2099
- </ul>
2100
-
2101
-
2102
-
2103
-
2104
- <p class="tag_title">Options Hash (<tt>opts</tt>):</p>
2105
- <ul class="option">
2106
-
2107
- <li>
2108
- <span class="name">:access_signature</span>
2109
- <span class="type">(<tt>String</tt>)</span>
2110
- <span class="default">
2111
-
2112
- </span>
2113
-
2114
- &mdash; <div class='inline'>
2115
- <p>Access signature can be mandatory for specific context. Treezor will
2116
- contact you if so. More info [here](<a
2117
- href="https://agent.treezor.com/security-authentication">agent.treezor.com/security-authentication</a>).</p>
2118
- </div>
2119
-
2120
- </li>
2121
-
2122
- <li>
2123
- <span class="name">:access_tag</span>
2124
- <span class="type">(<tt>String</tt>)</span>
2125
- <span class="default">
2126
-
2127
- </span>
2128
-
2129
- &mdash; <div class='inline'>
2130
- <p>Access tag is used for idem potency query. More info [here](<a
2131
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
2132
- </div>
2133
-
2134
- </li>
2135
-
2136
- <li>
2137
- <span class="name">:access_user_id</span>
2138
- <span class="type">(<tt>Integer</tt>)</span>
2139
- <span class="default">
2140
-
2141
- </span>
2142
-
2143
- &mdash; <div class='inline'>
2144
- <p>Access user&amp;#39;s id is used for user&amp;#39;s action restriction.
2145
- More info [here](<a
2146
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
2147
- </div>
2148
-
2149
- </li>
2150
-
2151
- <li>
2152
- <span class="name">:access_user_ip</span>
2153
- <span class="type">(<tt>String</tt>)</span>
2154
- <span class="default">
2155
-
2156
- </span>
2157
-
2158
- &mdash; <div class='inline'>
2159
- <p>Access user&amp;#39;s ip is used for user&amp;#39;s action restriction.
2160
- More info [here](<a
2161
- href="https://agent.treezor.com/basics">agent.treezor.com/basics</a>).</p>
2162
- </div>
2163
-
2164
- </li>
2165
-
2166
- <li>
2167
- <span class="name">:document_id</span>
2168
- <span class="type">(<tt>Integer</tt>)</span>
2169
- <span class="default">
2170
-
2171
- </span>
2172
-
2173
- &mdash; <div class='inline'>
2174
- <p>Document&amp;#39;s unique id.</p>
2175
- </div>
2176
-
2177
- </li>
2178
-
2179
- <li>
2180
- <span class="name">:document_tag</span>
2181
- <span class="type">(<tt>String</tt>)</span>
2182
- <span class="default">
2183
-
2184
- </span>
2185
-
2186
- &mdash; <div class='inline'>
2187
- <p>Custom data.</p>
2188
- </div>
2189
-
2190
- </li>
2191
-
2192
- <li>
2193
- <span class="name">:document_status</span>
2194
- <span class="type">(<tt>String</tt>)</span>
2195
- <span class="default">
2196
-
2197
- </span>
2198
-
2199
- &mdash; <div class='inline'>
2200
- <p>The status of the document. Possible values: * PENDING * CANCELED *
2201
- VALIDATED</p>
2202
- </div>
2203
-
2204
- </li>
2205
-
2206
- <li>
2207
- <span class="name">:document_type_id</span>
2208
- <span class="type">(<tt>Integer</tt>)</span>
2209
- <span class="default">
2210
-
2211
- </span>
2212
-
2213
- &mdash; <div class='inline'>
2214
- <p>Document type id.</p>
2215
- </div>
2216
-
2217
- </li>
2218
-
2219
- <li>
2220
- <span class="name">:document_type</span>
2221
- <span class="type">(<tt>String</tt>)</span>
2222
- <span class="default">
2223
-
2224
- </span>
2225
-
2226
- &mdash; <div class='inline'>
2227
- <p>Document&amp;#39;s type.</p>
2228
- </div>
2229
-
2230
- </li>
2231
-
2232
- <li>
2233
- <span class="name">:user_id</span>
2234
- <span class="type">(<tt>Integer</tt>)</span>
2235
- <span class="default">
2236
-
2237
- </span>
2238
-
2239
- &mdash; <div class='inline'>
2240
- <p>Document user&amp;#39;s id.</p>
2241
- </div>
2242
-
2243
- </li>
2244
-
2245
- <li>
2246
- <span class="name">:user_name</span>
2247
- <span class="type">(<tt>String</tt>)</span>
2248
- <span class="default">
2249
-
2250
- </span>
2251
-
2252
- &mdash; <div class='inline'>
2253
- <p>Document user&amp;#39;s name.</p>
2254
- </div>
2255
-
2256
- </li>
2257
-
2258
- <li>
2259
- <span class="name">:user_email</span>
2260
- <span class="type">(<tt>String</tt>)</span>
2261
- <span class="default">
2262
-
2263
- </span>
2264
-
2265
- &mdash; <div class='inline'>
2266
- <p>Document user&amp;#39;s email.</p>
2267
- </div>
2268
-
2269
- </li>
2270
-
2271
- <li>
2272
- <span class="name">:file_name</span>
2273
- <span class="type">(<tt>String</tt>)</span>
2274
- <span class="default">
2275
-
2276
- </span>
2277
-
2278
- &mdash; <div class='inline'>
2279
- <p>Document&amp;#39;s name.</p>
2280
- </div>
2281
-
2282
- </li>
2283
-
2284
- <li>
2285
- <span class="name">:file_size</span>
2286
- <span class="type">(<tt>Integer</tt>)</span>
2287
- <span class="default">
2288
-
2289
- </span>
2290
-
2291
- &mdash; <div class='inline'>
2292
- <p>Document&amp;#39;s size.</p>
2293
- </div>
2294
-
2295
- </li>
2296
-
2297
- <li>
2298
- <span class="name">:file_type</span>
2299
- <span class="type">(<tt>Integer</tt>)</span>
2300
- <span class="default">
2301
-
2302
- </span>
2303
-
2304
- &mdash; <div class='inline'>
2305
- <p>Document&amp;#39;s type.</p>
2306
- </div>
2307
-
2308
- </li>
2309
-
2310
- <li>
2311
- <span class="name">:is_agent</span>
2312
- <span class="type">(<tt>String</tt>)</span>
2313
- <span class="default">
2314
-
2315
- </span>
2316
-
2317
- &mdash; <div class='inline'>
2318
- <p>is agent field.</p>
2319
- </div>
2320
-
2321
- </li>
2322
-
2323
- <li>
2324
- <span class="name">:page_number</span>
2325
- <span class="type">(<tt>Integer</tt>)</span>
2326
- <span class="default">
2327
-
2328
- </span>
2329
-
2330
- &mdash; <div class='inline'>
2331
- <p>Pagination page number. More info [here](<a
2332
- href="https://agent.treezor.com/lists">agent.treezor.com/lists</a>).</p>
2333
- </div>
2334
-
2335
- </li>
2336
-
2337
- <li>
2338
- <span class="name">:page_count</span>
2339
- <span class="type">(<tt>Integer</tt>)</span>
2340
- <span class="default">
2341
-
2342
- </span>
2343
-
2344
- &mdash; <div class='inline'>
2345
- <p>The number of items per page. More info [here](<a
2346
- href="https://agent.treezor.com/lists">agent.treezor.com/lists</a>).</p>
2347
- </div>
2348
-
2349
- </li>
2350
-
2351
- <li>
2352
- <span class="name">:sort_by</span>
2353
- <span class="type">(<tt>String</tt>)</span>
2354
- <span class="default">
2355
-
2356
- </span>
2357
-
2358
- &mdash; <div class='inline'>
2359
- <p>The transaction element you want to sort the list with. Default value :
2360
- <em>createdDate</em>. More info [here](<a
2361
- href="https://agent.treezor.com/lists">agent.treezor.com/lists</a>).</p>
2362
- </div>
2363
-
2364
- </li>
2365
-
2366
- <li>
2367
- <span class="name">:sort_order</span>
2368
- <span class="type">(<tt>String</tt>)</span>
2369
- <span class="default">
2370
-
2371
- </span>
2372
-
2373
- &mdash; <div class='inline'>
2374
- <p>The order you want to sort the list. * *<strong>DESC</strong>* for a
2375
- descending sort * *<strong>ASC</strong>* for a ascending sort. Default
2376
- value : DESC. More info [here](<a
2377
- href="https://agent.treezor.com/lists">agent.treezor.com/lists</a>).</p>
2378
- </div>
2379
-
2380
- </li>
2381
-
2382
- <li>
2383
- <span class="name">:created_date_from</span>
2384
- <span class="type">(<tt>DateTime</tt>)</span>
2385
- <span class="default">
2386
-
2387
- </span>
2388
-
2389
- &mdash; <div class='inline'>
2390
- <p>The creation date from which you want to filter the request result. Format
2391
- YYYY-MM-DD HH:MM:SS. More info [here](<a
2392
- href="https://agent.treezor.com/lists">agent.treezor.com/lists</a>)</p>
2393
- </div>
2394
-
2395
- </li>
2396
-
2397
- <li>
2398
- <span class="name">:created_date_to</span>
2399
- <span class="type">(<tt>DateTime</tt>)</span>
2400
- <span class="default">
2401
-
2402
- </span>
2403
-
2404
- &mdash; <div class='inline'>
2405
- <p>The creation date up to which you want to filter the request result. Format
2406
- YYYY-MM-DD HH:MM:SS. More info [here](<a
2407
- href="https://agent.treezor.com/lists">agent.treezor.com/lists</a>)</p>
2408
- </div>
2409
-
2410
- </li>
2411
-
2412
- <li>
2413
- <span class="name">:updated_date_from</span>
2414
- <span class="type">(<tt>DateTime</tt>)</span>
2415
- <span class="default">
2416
-
2417
- </span>
2418
-
2419
- &mdash; <div class='inline'>
2420
- <p>The modification date from which you want to filter the request result.
2421
- Format YYYY-MM-DD HH:MM:SS. More info [here](<a
2422
- href="https://agent.treezor.com/lists">agent.treezor.com/lists</a>)</p>
2423
- </div>
2424
-
2425
- </li>
2426
-
2427
- <li>
2428
- <span class="name">:updated_date_to</span>
2429
- <span class="type">(<tt>DateTime</tt>)</span>
2430
- <span class="default">
2431
-
2432
- </span>
2433
-
2434
- &mdash; <div class='inline'>
2435
- <p>The modification date up to which you want to filter the request result.
2436
- Format YYYY-MM-DD HH:MM:SS. More info [here](<a
2437
- href="https://agent.treezor.com/lists">agent.treezor.com/lists</a>)</p>
2438
- </div>
2439
-
2440
- </li>
2441
-
2442
- </ul>
2443
-
2444
-
2445
- <p class="tag_title">Returns:</p>
2446
- <ul class="return">
2447
-
2448
- <li>
2449
-
2450
-
2451
- <span class='type'>(<tt>Array&lt;(<span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span>, Fixnum, Hash)&gt;</tt>)</span>
2452
-
2453
-
2454
-
2455
- &mdash;
2456
- <div class='inline'>
2457
- <p>InlineResponse20011 data, response status code and response headers</p>
2458
- </div>
2459
-
2460
- </li>
2461
-
2462
- </ul>
2463
-
2464
- </div><table class="source_code">
2465
- <tr>
2466
- <td>
2467
- <pre class="lines">
2468
-
2469
-
2470
- 286
2471
- 287
2472
- 288
2473
- 289
2474
- 290
2475
- 291
2476
- 292
2477
- 293
2478
- 294
2479
- 295
2480
- 296
2481
- 297
2482
- 298
2483
- 299
2484
- 300
2485
- 301
2486
- 302
2487
- 303
2488
- 304
2489
- 305
2490
- 306
2491
- 307
2492
- 308
2493
- 309
2494
- 310
2495
- 311
2496
- 312
2497
- 313
2498
- 314
2499
- 315
2500
- 316
2501
- 317
2502
- 318
2503
- 319
2504
- 320
2505
- 321
2506
- 322
2507
- 323
2508
- 324
2509
- 325
2510
- 326
2511
- 327
2512
- 328
2513
- 329
2514
- 330
2515
- 331
2516
- 332
2517
- 333
2518
- 334
2519
- 335
2520
- 336
2521
- 337
2522
- 338
2523
- 339
2524
- 340
2525
- 341
2526
- 342
2527
- 343
2528
- 344
2529
- 345
2530
- 346
2531
- 347</pre>
2532
- </td>
2533
- <td>
2534
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/document_api.rb', line 286</span>
2535
-
2536
- <span class='kw'>def</span> <span class='id identifier rubyid_get_documents_with_http_info'>get_documents_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>
2537
- <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>
2538
- <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: DocumentApi.get_documents ...</span><span class='tstring_end'>&quot;</span></span>
2539
- <span class='kw'>end</span>
2540
- <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_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;document_status&#39;</span><span class='rbracket'>]</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'>PENDING</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'>CANCELED</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'>VALIDATED</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_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:&#39;document_status&#39;</span><span class='rbracket'>]</span><span class='rparen'>)</span>
2541
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>invalid value for &quot;document_status&quot;, must be one of PENDING, CANCELED, VALIDATED</span><span class='tstring_end'>&#39;</span></span>
2542
- <span class='kw'>end</span>
2543
- <span class='comment'># resource path
2544
- </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'>/documents</span><span class='tstring_end'>&quot;</span></span>
2545
-
2546
- <span class='comment'># query parameters
2547
- </span> <span class='id identifier rubyid_query_params'>query_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
2548
- <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>
2549
- <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>
2550
- <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>
2551
- <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>
2552
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;documentId&#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;document_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;document_id&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2553
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;documentTag&#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;document_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;document_tag&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2554
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;documentStatus&#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;document_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;document_status&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2555
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;documentTypeId&#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;document_type_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;document_type_id&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2556
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;documentType&#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;document_type&#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;document_type&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2557
- <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>
2558
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;userName&#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_name&#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_name&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2559
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;userEmail&#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_email&#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_email&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2560
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;fileName&#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;file_name&#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;file_name&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2561
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;fileSize&#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;file_size&#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;file_size&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2562
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;fileType&#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;file_type&#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;file_type&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2563
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;isAgent&#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;is_agent&#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;is_agent&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2564
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;pageNumber&#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;page_number&#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;page_number&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2565
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;pageCount&#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;page_count&#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;page_count&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2566
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;sortBy&#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;sort_by&#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;sort_by&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2567
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;sortOrder&#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;sort_order&#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;sort_order&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2568
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;createdDateFrom&#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;created_date_from&#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;created_date_from&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2569
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;createdDateTo&#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;created_date_to&#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;created_date_to&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2570
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;updatedDateFrom&#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;updated_date_from&#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;updated_date_from&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2571
- <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='symbol'>:&#39;updatedDateTo&#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;updated_date_to&#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;updated_date_to&#39;</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
2572
-
2573
- <span class='comment'># header parameters
2574
- </span> <span class='id identifier rubyid_header_params'>header_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
2575
- <span class='comment'># HTTP header &#39;Accept&#39; (if needed)
2576
- </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>
2577
- <span class='comment'># HTTP header &#39;Content-Type&#39;
2578
- </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>
2579
-
2580
- <span class='comment'># form parameters
2581
- </span> <span class='id identifier rubyid_form_params'>form_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
2582
-
2583
- <span class='comment'># http body (model)
2584
- </span> <span class='id identifier rubyid_post_body'>post_body</span> <span class='op'>=</span> <span class='kw'>nil</span>
2585
- <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>
2586
- <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>
2587
- <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>
2588
- <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>
2589
- <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>
2590
- <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_post_body'>post_body</span><span class='comma'>,</span>
2591
- <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>
2592
- <span class='symbol'>:return_type</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>InlineResponse20011</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
2593
- <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>
2594
- <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: DocumentApi#get_documents\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>
2595
- <span class='kw'>end</span>
2596
- <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>
2597
- <span class='kw'>end</span></pre>
2598
- </td>
2599
- </tr>
2600
- </table>
2601
- </div>
2602
-
2603
- <div class="method_details ">
2604
- <h3 class="signature " id="put_document-instance_method">
2605
-
2606
- #<strong>put_document</strong>(id, opts = {}) &#x21d2; <tt><span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span></tt>
2607
-
2608
-
2609
-
2610
-
2611
-
2612
- </h3><div class="docstring">
2613
- <div class="discussion">
2614
-
2615
- <p>update a document Update a document.</p>
2616
-
2617
-
2618
- </div>
2619
- </div>
2620
- <div class="tags">
2621
- <p class="tag_title">Parameters:</p>
2622
- <ul class="param">
2623
-
2624
- <li>
2625
-
2626
- <span class='name'>id</span>
2627
-
2628
-
2629
- <span class='type'></span>
2630
-
2631
-
2632
-
2633
- &mdash;
2634
- <div class='inline'>
2635
- <p>Document&amp;#39;s internal id.</p>
2636
- </div>
2637
-
2638
- </li>
2639
-
2640
- <li>
2641
-
2642
- <span class='name'>opts</span>
2643
-
2644
-
2645
- <span class='type'>(<tt>Hash</tt>)</span>
2646
-
2647
-
2648
- <em class="default">(defaults to: <tt>{}</tt>)</em>
2649
-
2650
-
2651
- &mdash;
2652
- <div class='inline'>
2653
- <p>the optional parameters</p>
2654
- </div>
2655
-
2656
- </li>
2657
-
2658
- </ul>
2659
-
2660
- <p class="tag_title">Returns:</p>
2661
- <ul class="return">
2662
-
2663
- <li>
2664
-
2665
-
2666
- <span class='type'>(<tt><span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span></tt>)</span>
2667
-
2668
-
2669
-
2670
- </li>
2671
-
2672
- </ul>
2673
-
2674
- </div><table class="source_code">
2675
- <tr>
2676
- <td>
2677
- <pre class="lines">
2678
-
2679
-
2680
- 354
2681
- 355
2682
- 356
2683
- 357</pre>
2684
- </td>
2685
- <td>
2686
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/document_api.rb', line 354</span>
2687
-
2688
- <span class='kw'>def</span> <span class='id identifier rubyid_put_document'>put_document</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>
2689
- <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_put_document_with_http_info'>put_document_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>
2690
- <span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span>
2691
- <span class='kw'>end</span></pre>
2692
- </td>
2693
- </tr>
2694
- </table>
2695
- </div>
2696
-
2697
- <div class="method_details ">
2698
- <h3 class="signature " id="put_document_with_http_info-instance_method">
2699
-
2700
- #<strong>put_document_with_http_info</strong>(id, opts = {}) &#x21d2; <tt>Array&lt;(<span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span>, Fixnum, Hash)&gt;</tt>
2701
-
2702
-
2703
-
2704
-
2705
-
2706
- </h3><div class="docstring">
2707
- <div class="discussion">
2708
-
2709
- <p>update a document Update a document.</p>
2710
-
2711
-
2712
- </div>
2713
- </div>
2714
- <div class="tags">
2715
- <p class="tag_title">Parameters:</p>
2716
- <ul class="param">
2717
-
2718
- <li>
2719
-
2720
- <span class='name'>id</span>
2721
-
2722
-
2723
- <span class='type'></span>
2724
-
2725
-
2726
-
2727
- &mdash;
2728
- <div class='inline'>
2729
- <p>Document&amp;#39;s internal id.</p>
2730
- </div>
2731
-
2732
- </li>
2733
-
2734
- <li>
2735
-
2736
- <span class='name'>opts</span>
2737
-
2738
-
2739
- <span class='type'>(<tt>Hash</tt>)</span>
2740
-
2741
-
2742
- <em class="default">(defaults to: <tt>{}</tt>)</em>
2743
-
2744
-
2745
- &mdash;
2746
- <div class='inline'>
2747
- <p>the optional parameters</p>
2748
- </div>
2749
-
2750
- </li>
2751
-
2752
- </ul>
2753
-
2754
- <p class="tag_title">Returns:</p>
2755
- <ul class="return">
2756
-
2757
- <li>
2758
-
2759
-
2760
- <span class='type'>(<tt>Array&lt;(<span class='object_link'><a href="InlineResponse20011.html" title="TreezorClient::InlineResponse20011 (class)">InlineResponse20011</a></span>, Fixnum, Hash)&gt;</tt>)</span>
2761
-
2762
-
2763
-
2764
- &mdash;
2765
- <div class='inline'>
2766
- <p>InlineResponse20011 data, response status code and response headers</p>
2767
- </div>
2768
-
2769
- </li>
2770
-
2771
- </ul>
2772
-
2773
- </div><table class="source_code">
2774
- <tr>
2775
- <td>
2776
- <pre class="lines">
2777
-
2778
-
2779
- 364
2780
- 365
2781
- 366
2782
- 367
2783
- 368
2784
- 369
2785
- 370
2786
- 371
2787
- 372
2788
- 373
2789
- 374
2790
- 375
2791
- 376
2792
- 377
2793
- 378
2794
- 379
2795
- 380
2796
- 381
2797
- 382
2798
- 383
2799
- 384
2800
- 385
2801
- 386
2802
- 387
2803
- 388
2804
- 389
2805
- 390
2806
- 391
2807
- 392
2808
- 393
2809
- 394
2810
- 395
2811
- 396
2812
- 397
2813
- 398
2814
- 399
2815
- 400
2816
- 401
2817
- 402</pre>
2818
- </td>
2819
- <td>
2820
- <pre class="code"><span class="info file"># File 'lib/treezor_client/api/document_api.rb', line 364</span>
2821
-
2822
- <span class='kw'>def</span> <span class='id identifier rubyid_put_document_with_http_info'>put_document_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>
2823
- <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>
2824
- <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: DocumentApi.put_document ...</span><span class='tstring_end'>&quot;</span></span>
2825
- <span class='kw'>end</span>
2826
- <span class='comment'># verify the required parameter &#39;id&#39; is set
2827
- </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>
2828
- <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 DocumentApi.put_document</span><span class='tstring_end'>&quot;</span></span>
2829
- <span class='kw'>end</span>
2830
- <span class='comment'># resource path
2831
- </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'>/documents/{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>
2832
-
2833
- <span class='comment'># query parameters
2834
- </span> <span class='id identifier rubyid_query_params'>query_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
2835
-
2836
- <span class='comment'># header parameters
2837
- </span> <span class='id identifier rubyid_header_params'>header_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
2838
- <span class='comment'># HTTP header &#39;Accept&#39; (if needed)
2839
- </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>
2840
- <span class='comment'># HTTP header &#39;Content-Type&#39;
2841
- </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>
2842
-
2843
- <span class='comment'># form parameters
2844
- </span> <span class='id identifier rubyid_form_params'>form_params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
2845
-
2846
- <span class='comment'># http body (model)
2847
- </span> <span class='id identifier rubyid_post_body'>post_body</span> <span class='op'>=</span> <span class='kw'>nil</span>
2848
- <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>
2849
- <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>
2850
- <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>
2851
- <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>
2852
- <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>
2853
- <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_post_body'>post_body</span><span class='comma'>,</span>
2854
- <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>
2855
- <span class='symbol'>:return_type</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>InlineResponse20011</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
2856
- <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>
2857
- <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: DocumentApi#put_document\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>
2858
- <span class='kw'>end</span>
2859
- <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>
2860
- <span class='kw'>end</span></pre>
2861
- </td>
2862
- </tr>
2863
- </table>
2864
- </div>
2865
-
2866
- </div>
2867
-
2868
- </div>
2869
-
2870
- <div id="footer">
2871
- Generated on Wed Aug 8 17:39:09 2018 by
2872
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2873
- 0.9.15 (ruby-2.5.1).
2874
- </div>
2875
-
2876
- </div>
2877
- </body>
2878
- </html>