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,2459 +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::Configuration
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::Configuration";
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 (C)</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">Configuration</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::Configuration
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::Configuration</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/configuration.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="#access_token-instance_method" title="#access_token (instance method)">#<strong>access_token</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>Defines the access token (Bearer) used with OAuth2.</p>
131
- </div></span>
132
-
133
- </li>
134
-
135
-
136
- <li class="public ">
137
- <span class="summary_signature">
138
-
139
- <a href="#api_key-instance_method" title="#api_key (instance method)">#<strong>api_key</strong> &#x21d2; Hash </a>
140
-
141
-
142
-
143
- </span>
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
- <span class="summary_desc"><div class='inline'>
157
- <p>Defines API keys used with API Key authentications.</p>
158
- </div></span>
159
-
160
- </li>
161
-
162
-
163
- <li class="public ">
164
- <span class="summary_signature">
165
-
166
- <a href="#api_key_prefix-instance_method" title="#api_key_prefix (instance method)">#<strong>api_key_prefix</strong> &#x21d2; Hash </a>
167
-
168
-
169
-
170
- </span>
171
-
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
-
182
-
183
- <span class="summary_desc"><div class='inline'>
184
- <p>Defines API key prefixes used with API Key authentications.</p>
185
- </div></span>
186
-
187
- </li>
188
-
189
-
190
- <li class="public ">
191
- <span class="summary_signature">
192
-
193
- <a href="#base_path-instance_method" title="#base_path (instance method)">#<strong>base_path</strong> &#x21d2; Object </a>
194
-
195
-
196
-
197
- </span>
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
-
210
- <span class="summary_desc"><div class='inline'>
211
- <p>Defines url base path.</p>
212
- </div></span>
213
-
214
- </li>
215
-
216
-
217
- <li class="public ">
218
- <span class="summary_signature">
219
-
220
- <a href="#cert_file-instance_method" title="#cert_file (instance method)">#<strong>cert_file</strong> &#x21d2; Object </a>
221
-
222
-
223
-
224
- </span>
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
-
237
- <span class="summary_desc"><div class='inline'>
238
- <p>TLS/SSL setting Client certificate file (for client certificate).</p>
239
- </div></span>
240
-
241
- </li>
242
-
243
-
244
- <li class="public ">
245
- <span class="summary_signature">
246
-
247
- <a href="#client_side_validation-instance_method" title="#client_side_validation (instance method)">#<strong>client_side_validation</strong> &#x21d2; true, false </a>
248
-
249
-
250
-
251
- </span>
252
-
253
-
254
-
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
- <span class="summary_desc"><div class='inline'>
265
- <p>Set this to false to skip client side validation in the operation.</p>
266
- </div></span>
267
-
268
- </li>
269
-
270
-
271
- <li class="public ">
272
- <span class="summary_signature">
273
-
274
- <a href="#debugging-instance_method" title="#debugging (instance method)">#<strong>debugging</strong> &#x21d2; true, false </a>
275
-
276
-
277
-
278
- </span>
279
-
280
-
281
-
282
-
283
-
284
-
285
-
286
-
287
-
288
-
289
-
290
-
291
- <span class="summary_desc"><div class='inline'>
292
- <p>Set this to enable/disable debugging.</p>
293
- </div></span>
294
-
295
- </li>
296
-
297
-
298
- <li class="public ">
299
- <span class="summary_signature">
300
-
301
- <a href="#force_ending_format-instance_method" title="#force_ending_format (instance method)">#<strong>force_ending_format</strong> &#x21d2; Object </a>
302
-
303
-
304
-
305
- </span>
306
-
307
-
308
-
309
-
310
-
311
-
312
-
313
-
314
-
315
-
316
-
317
-
318
- <span class="summary_desc"><div class='inline'>
319
- <p>Returns the value of attribute force_ending_format.</p>
320
- </div></span>
321
-
322
- </li>
323
-
324
-
325
- <li class="public ">
326
- <span class="summary_signature">
327
-
328
- <a href="#host-instance_method" title="#host (instance method)">#<strong>host</strong> &#x21d2; Object </a>
329
-
330
-
331
-
332
- </span>
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
-
343
-
344
-
345
- <span class="summary_desc"><div class='inline'>
346
- <p>Defines url host.</p>
347
- </div></span>
348
-
349
- </li>
350
-
351
-
352
- <li class="public ">
353
- <span class="summary_signature">
354
-
355
- <a href="#inject_format-instance_method" title="#inject_format (instance method)">#<strong>inject_format</strong> &#x21d2; Object </a>
356
-
357
-
358
-
359
- </span>
360
-
361
-
362
-
363
-
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
- <span class="summary_desc"><div class='inline'>
373
- <p>Returns the value of attribute inject_format.</p>
374
- </div></span>
375
-
376
- </li>
377
-
378
-
379
- <li class="public ">
380
- <span class="summary_signature">
381
-
382
- <a href="#key_file-instance_method" title="#key_file (instance method)">#<strong>key_file</strong> &#x21d2; Object </a>
383
-
384
-
385
-
386
- </span>
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
- <span class="summary_desc"><div class='inline'>
400
- <p>TLS/SSL setting Client private key file (for client certificate).</p>
401
- </div></span>
402
-
403
- </li>
404
-
405
-
406
- <li class="public ">
407
- <span class="summary_signature">
408
-
409
- <a href="#logger-instance_method" title="#logger (instance method)">#<strong>logger</strong> &#x21d2; #debug </a>
410
-
411
-
412
-
413
- </span>
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
-
425
-
426
- <span class="summary_desc"><div class='inline'>
427
- <p>Defines the logger used for debugging.</p>
428
- </div></span>
429
-
430
- </li>
431
-
432
-
433
- <li class="public ">
434
- <span class="summary_signature">
435
-
436
- <a href="#params_encoding-instance_method" title="#params_encoding (instance method)">#<strong>params_encoding</strong> &#x21d2; Object </a>
437
-
438
-
439
-
440
- </span>
441
-
442
-
443
-
444
-
445
-
446
-
447
-
448
-
449
-
450
-
451
-
452
-
453
- <span class="summary_desc"><div class='inline'>
454
- <p>Set this to customize parameters encoding of array parameter with multi
455
- collectionFormat.</p>
456
- </div></span>
457
-
458
- </li>
459
-
460
-
461
- <li class="public ">
462
- <span class="summary_signature">
463
-
464
- <a href="#password-instance_method" title="#password (instance method)">#<strong>password</strong> &#x21d2; String </a>
465
-
466
-
467
-
468
- </span>
469
-
470
-
471
-
472
-
473
-
474
-
475
-
476
-
477
-
478
-
479
-
480
-
481
- <span class="summary_desc"><div class='inline'>
482
- <p>Defines the password used with HTTP basic authentication.</p>
483
- </div></span>
484
-
485
- </li>
486
-
487
-
488
- <li class="public ">
489
- <span class="summary_signature">
490
-
491
- <a href="#scheme-instance_method" title="#scheme (instance method)">#<strong>scheme</strong> &#x21d2; Object </a>
492
-
493
-
494
-
495
- </span>
496
-
497
-
498
-
499
-
500
-
501
-
502
-
503
-
504
-
505
-
506
-
507
-
508
- <span class="summary_desc"><div class='inline'>
509
- <p>Defines url scheme.</p>
510
- </div></span>
511
-
512
- </li>
513
-
514
-
515
- <li class="public ">
516
- <span class="summary_signature">
517
-
518
- <a href="#ssl_ca_cert-instance_method" title="#ssl_ca_cert (instance method)">#<strong>ssl_ca_cert</strong> &#x21d2; String </a>
519
-
520
-
521
-
522
- </span>
523
-
524
-
525
-
526
-
527
-
528
-
529
-
530
-
531
-
532
-
533
-
534
-
535
- <span class="summary_desc"><div class='inline'>
536
- <p>TLS/SSL setting Set this to customize the certificate file to verify the
537
- peer.</p>
538
- </div></span>
539
-
540
- </li>
541
-
542
-
543
- <li class="public ">
544
- <span class="summary_signature">
545
-
546
- <a href="#temp_folder_path-instance_method" title="#temp_folder_path (instance method)">#<strong>temp_folder_path</strong> &#x21d2; String </a>
547
-
548
-
549
-
550
- </span>
551
-
552
-
553
-
554
-
555
-
556
-
557
-
558
-
559
-
560
-
561
-
562
-
563
- <span class="summary_desc"><div class='inline'>
564
- <p>Defines the temporary folder to store downloaded files (for API endpoints
565
- that have file response).</p>
566
- </div></span>
567
-
568
- </li>
569
-
570
-
571
- <li class="public ">
572
- <span class="summary_signature">
573
-
574
- <a href="#timeout-instance_method" title="#timeout (instance method)">#<strong>timeout</strong> &#x21d2; Object </a>
575
-
576
-
577
-
578
- </span>
579
-
580
-
581
-
582
-
583
-
584
-
585
-
586
-
587
-
588
-
589
-
590
-
591
- <span class="summary_desc"><div class='inline'>
592
- <p>The time limit for HTTP request in seconds.</p>
593
- </div></span>
594
-
595
- </li>
596
-
597
-
598
- <li class="public ">
599
- <span class="summary_signature">
600
-
601
- <a href="#username-instance_method" title="#username (instance method)">#<strong>username</strong> &#x21d2; String </a>
602
-
603
-
604
-
605
- </span>
606
-
607
-
608
-
609
-
610
-
611
-
612
-
613
-
614
-
615
-
616
-
617
-
618
- <span class="summary_desc"><div class='inline'>
619
- <p>Defines the username used with HTTP basic authentication.</p>
620
- </div></span>
621
-
622
- </li>
623
-
624
-
625
- <li class="public ">
626
- <span class="summary_signature">
627
-
628
- <a href="#verify_ssl-instance_method" title="#verify_ssl (instance method)">#<strong>verify_ssl</strong> &#x21d2; true, false </a>
629
-
630
-
631
-
632
- </span>
633
-
634
-
635
-
636
-
637
-
638
-
639
-
640
-
641
-
642
-
643
-
644
-
645
- <span class="summary_desc"><div class='inline'>
646
- <p>TLS/SSL setting Set this to false to skip verifying SSL certificate when
647
- calling API from https server.</p>
648
- </div></span>
649
-
650
- </li>
651
-
652
-
653
- <li class="public ">
654
- <span class="summary_signature">
655
-
656
- <a href="#verify_ssl_host-instance_method" title="#verify_ssl_host (instance method)">#<strong>verify_ssl_host</strong> &#x21d2; true, false </a>
657
-
658
-
659
-
660
- </span>
661
-
662
-
663
-
664
-
665
-
666
-
667
-
668
-
669
-
670
-
671
-
672
-
673
- <span class="summary_desc"><div class='inline'>
674
- <p>TLS/SSL setting Set this to false to skip verifying SSL host name Default
675
- to true.</p>
676
- </div></span>
677
-
678
- </li>
679
-
680
-
681
- </ul>
682
-
683
-
684
-
685
-
686
-
687
- <h2>
688
- Class Method Summary
689
- <small><a href="#" class="summary_toggle">collapse</a></small>
690
- </h2>
691
-
692
- <ul class="summary">
693
-
694
- <li class="public ">
695
- <span class="summary_signature">
696
-
697
- <a href="#default-class_method" title="default (class method)">.<strong>default</strong> &#x21d2; Object </a>
698
-
699
-
700
-
701
- </span>
702
-
703
-
704
-
705
-
706
-
707
-
708
-
709
-
710
-
711
- <span class="summary_desc"><div class='inline'>
712
- <p>The default Configuration object.</p>
713
- </div></span>
714
-
715
- </li>
716
-
717
-
718
- </ul>
719
-
720
- <h2>
721
- Instance Method Summary
722
- <small><a href="#" class="summary_toggle">collapse</a></small>
723
- </h2>
724
-
725
- <ul class="summary">
726
-
727
- <li class="public ">
728
- <span class="summary_signature">
729
-
730
- <a href="#api_key_with_prefix-instance_method" title="#api_key_with_prefix (instance method)">#<strong>api_key_with_prefix</strong>(param_name) &#x21d2; Object </a>
731
-
732
-
733
-
734
- </span>
735
-
736
-
737
-
738
-
739
-
740
-
741
-
742
-
743
-
744
- <span class="summary_desc"><div class='inline'>
745
- <p>Gets API key (with prefix if set).</p>
746
- </div></span>
747
-
748
- </li>
749
-
750
-
751
- <li class="public ">
752
- <span class="summary_signature">
753
-
754
- <a href="#auth_settings-instance_method" title="#auth_settings (instance method)">#<strong>auth_settings</strong> &#x21d2; Object </a>
755
-
756
-
757
-
758
- </span>
759
-
760
-
761
-
762
-
763
-
764
-
765
-
766
-
767
-
768
- <span class="summary_desc"><div class='inline'>
769
- <p>Returns Auth Settings hash for api client.</p>
770
- </div></span>
771
-
772
- </li>
773
-
774
-
775
- <li class="public ">
776
- <span class="summary_signature">
777
-
778
- <a href="#base_url-instance_method" title="#base_url (instance method)">#<strong>base_url</strong> &#x21d2; Object </a>
779
-
780
-
781
-
782
- </span>
783
-
784
-
785
-
786
-
787
-
788
-
789
-
790
-
791
-
792
- <span class="summary_desc"><div class='inline'></div></span>
793
-
794
- </li>
795
-
796
-
797
- <li class="public ">
798
- <span class="summary_signature">
799
-
800
- <a href="#basic_auth_token-instance_method" title="#basic_auth_token (instance method)">#<strong>basic_auth_token</strong> &#x21d2; Object </a>
801
-
802
-
803
-
804
- </span>
805
-
806
-
807
-
808
-
809
-
810
-
811
-
812
-
813
-
814
- <span class="summary_desc"><div class='inline'>
815
- <p>Gets Basic Auth token string.</p>
816
- </div></span>
817
-
818
- </li>
819
-
820
-
821
- <li class="public ">
822
- <span class="summary_signature">
823
-
824
- <a href="#configure-instance_method" title="#configure (instance method)">#<strong>configure</strong> {|_self| ... } &#x21d2; Object </a>
825
-
826
-
827
-
828
- </span>
829
-
830
-
831
-
832
-
833
-
834
-
835
-
836
-
837
-
838
- <span class="summary_desc"><div class='inline'></div></span>
839
-
840
- </li>
841
-
842
-
843
- <li class="public ">
844
- <span class="summary_signature">
845
-
846
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> {|_self| ... } &#x21d2; Configuration </a>
847
-
848
-
849
-
850
- </span>
851
-
852
-
853
- <span class="note title constructor">constructor</span>
854
-
855
-
856
-
857
-
858
-
859
-
860
-
861
-
862
- <span class="summary_desc"><div class='inline'>
863
- <p>A new instance of Configuration.</p>
864
- </div></span>
865
-
866
- </li>
867
-
868
-
869
- </ul>
870
-
871
-
872
- <div id="constructor_details" class="method_details_list">
873
- <h2>Constructor Details</h2>
874
-
875
- <div class="method_details first">
876
- <h3 class="signature first" id="initialize-instance_method">
877
-
878
- #<strong>initialize</strong> {|_self| ... } &#x21d2; <tt><span class='object_link'><a href="" title="TreezorClient::Configuration (class)">Configuration</a></span></tt>
879
-
880
-
881
-
882
-
883
-
884
- </h3><div class="docstring">
885
- <div class="discussion">
886
-
887
- <p>Returns a new instance of Configuration</p>
888
-
889
-
890
- </div>
891
- </div>
892
- <div class="tags">
893
-
894
- <p class="tag_title">Yields:</p>
895
- <ul class="yield">
896
-
897
- <li>
898
-
899
-
900
- <span class='type'>(<tt>_self</tt>)</span>
901
-
902
-
903
-
904
- </li>
905
-
906
- </ul>
907
- <p class="tag_title">Yield Parameters:</p>
908
- <ul class="yieldparam">
909
-
910
- <li>
911
-
912
- <span class='name'>_self</span>
913
-
914
-
915
- <span class='type'>(<tt><span class='object_link'><a href="" title="TreezorClient::Configuration (class)">TreezorClient::Configuration</a></span></tt>)</span>
916
-
917
-
918
-
919
- &mdash;
920
- <div class='inline'>
921
- <p>the object that the method was called on</p>
922
- </div>
923
-
924
- </li>
925
-
926
- </ul>
927
-
928
- </div><table class="source_code">
929
- <tr>
930
- <td>
931
- <pre class="lines">
932
-
933
-
934
- 130
935
- 131
936
- 132
937
- 133
938
- 134
939
- 135
940
- 136
941
- 137
942
- 138
943
- 139
944
- 140
945
- 141
946
- 142
947
- 143
948
- 144
949
- 145
950
- 146
951
- 147
952
- 148
953
- 149</pre>
954
- </td>
955
- <td>
956
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 130</span>
957
-
958
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
959
- <span class='ivar'>@scheme</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https</span><span class='tstring_end'>&#39;</span></span>
960
- <span class='ivar'>@host</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>sandbox.treezor.com</span><span class='tstring_end'>&#39;</span></span>
961
- <span class='ivar'>@base_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/v1/index.php</span><span class='tstring_end'>&#39;</span></span>
962
- <span class='ivar'>@api_key</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
963
- <span class='ivar'>@api_key_prefix</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
964
- <span class='ivar'>@timeout</span> <span class='op'>=</span> <span class='int'>0</span>
965
- <span class='ivar'>@client_side_validation</span> <span class='op'>=</span> <span class='kw'>true</span>
966
- <span class='ivar'>@verify_ssl</span> <span class='op'>=</span> <span class='kw'>true</span>
967
- <span class='ivar'>@verify_ssl_host</span> <span class='op'>=</span> <span class='kw'>true</span>
968
- <span class='ivar'>@params_encoding</span> <span class='op'>=</span> <span class='kw'>nil</span>
969
- <span class='ivar'>@cert_file</span> <span class='op'>=</span> <span class='kw'>nil</span>
970
- <span class='ivar'>@key_file</span> <span class='op'>=</span> <span class='kw'>nil</span>
971
- <span class='ivar'>@debugging</span> <span class='op'>=</span> <span class='kw'>false</span>
972
- <span class='ivar'>@inject_format</span> <span class='op'>=</span> <span class='kw'>false</span>
973
- <span class='ivar'>@force_ending_format</span> <span class='op'>=</span> <span class='kw'>false</span>
974
- <span class='ivar'>@logger</span> <span class='op'>=</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='const'>Rails</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='const'>Rails</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span> <span class='op'>:</span> <span class='const'>Logger</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>STDOUT</span><span class='rparen'>)</span>
975
-
976
- <span class='kw'>yield</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
977
- <span class='kw'>end</span></pre>
978
- </td>
979
- </tr>
980
- </table>
981
- </div>
982
-
983
- </div>
984
-
985
- <div id="instance_attr_details" class="attr_details">
986
- <h2>Instance Attribute Details</h2>
987
-
988
-
989
- <span id="access_token=-instance_method"></span>
990
- <div class="method_details first">
991
- <h3 class="signature first" id="access_token-instance_method">
992
-
993
- #<strong>access_token</strong> &#x21d2; <tt>Object</tt>
994
-
995
-
996
-
997
-
998
-
999
- </h3><div class="docstring">
1000
- <div class="discussion">
1001
-
1002
- <p>Defines the access token (Bearer) used with OAuth2.</p>
1003
-
1004
-
1005
- </div>
1006
- </div>
1007
- <div class="tags">
1008
-
1009
-
1010
- </div><table class="source_code">
1011
- <tr>
1012
- <td>
1013
- <pre class="lines">
1014
-
1015
-
1016
- 53
1017
- 54
1018
- 55</pre>
1019
- </td>
1020
- <td>
1021
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 53</span>
1022
-
1023
- <span class='kw'>def</span> <span class='id identifier rubyid_access_token'>access_token</span>
1024
- <span class='ivar'>@access_token</span>
1025
- <span class='kw'>end</span></pre>
1026
- </td>
1027
- </tr>
1028
- </table>
1029
- </div>
1030
-
1031
-
1032
- <span id="api_key=-instance_method"></span>
1033
- <div class="method_details ">
1034
- <h3 class="signature " id="api_key-instance_method">
1035
-
1036
- #<strong>api_key</strong> &#x21d2; <tt>Hash</tt>
1037
-
1038
-
1039
-
1040
-
1041
-
1042
- </h3><div class="docstring">
1043
- <div class="discussion">
1044
-
1045
- <p>Defines API keys used with API Key authentications.</p>
1046
-
1047
-
1048
- </div>
1049
- </div>
1050
- <div class="tags">
1051
-
1052
- <div class="examples">
1053
- <p class="tag_title">Examples:</p>
1054
-
1055
-
1056
- <p class="example_title"><div class='inline'>
1057
- <p>parameter name is “api_key”, API key is “xxx” (e.g. “api_key=xxx” in query
1058
- string)</p>
1059
- </div></p>
1060
-
1061
- <pre class="example code"><code><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_api_key'>api_key</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> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>xxx</span><span class='tstring_end'>&#39;</span></span></code></pre>
1062
-
1063
- </div>
1064
-
1065
- <p class="tag_title">Returns:</p>
1066
- <ul class="return">
1067
-
1068
- <li>
1069
-
1070
-
1071
- <span class='type'>(<tt>Hash</tt>)</span>
1072
-
1073
-
1074
-
1075
- &mdash;
1076
- <div class='inline'>
1077
- <p>key: parameter name, value: parameter value (API key)</p>
1078
- </div>
1079
-
1080
- </li>
1081
-
1082
- </ul>
1083
-
1084
- </div><table class="source_code">
1085
- <tr>
1086
- <td>
1087
- <pre class="lines">
1088
-
1089
-
1090
- 32
1091
- 33
1092
- 34</pre>
1093
- </td>
1094
- <td>
1095
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 32</span>
1096
-
1097
- <span class='kw'>def</span> <span class='id identifier rubyid_api_key'>api_key</span>
1098
- <span class='ivar'>@api_key</span>
1099
- <span class='kw'>end</span></pre>
1100
- </td>
1101
- </tr>
1102
- </table>
1103
- </div>
1104
-
1105
-
1106
- <span id="api_key_prefix=-instance_method"></span>
1107
- <div class="method_details ">
1108
- <h3 class="signature " id="api_key_prefix-instance_method">
1109
-
1110
- #<strong>api_key_prefix</strong> &#x21d2; <tt>Hash</tt>
1111
-
1112
-
1113
-
1114
-
1115
-
1116
- </h3><div class="docstring">
1117
- <div class="discussion">
1118
-
1119
- <p>Defines API key prefixes used with API Key authentications.</p>
1120
-
1121
-
1122
- </div>
1123
- </div>
1124
- <div class="tags">
1125
-
1126
- <div class="examples">
1127
- <p class="tag_title">Examples:</p>
1128
-
1129
-
1130
- <p class="example_title"><div class='inline'>
1131
- <p>parameter name is “Authorization”, API key prefix is “Token” (e.g.
1132
- “Authorization: Token xxx” in headers)</p>
1133
- </div></p>
1134
-
1135
- <pre class="example code"><code><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_api_key_prefix'>api_key_prefix</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> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Token</span><span class='tstring_end'>&#39;</span></span></code></pre>
1136
-
1137
- </div>
1138
-
1139
- <p class="tag_title">Returns:</p>
1140
- <ul class="return">
1141
-
1142
- <li>
1143
-
1144
-
1145
- <span class='type'>(<tt>Hash</tt>)</span>
1146
-
1147
-
1148
-
1149
- &mdash;
1150
- <div class='inline'>
1151
- <p>key: parameter name, value: API key prefix</p>
1152
- </div>
1153
-
1154
- </li>
1155
-
1156
- </ul>
1157
-
1158
- </div><table class="source_code">
1159
- <tr>
1160
- <td>
1161
- <pre class="lines">
1162
-
1163
-
1164
- 40
1165
- 41
1166
- 42</pre>
1167
- </td>
1168
- <td>
1169
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 40</span>
1170
-
1171
- <span class='kw'>def</span> <span class='id identifier rubyid_api_key_prefix'>api_key_prefix</span>
1172
- <span class='ivar'>@api_key_prefix</span>
1173
- <span class='kw'>end</span></pre>
1174
- </td>
1175
- </tr>
1176
- </table>
1177
- </div>
1178
-
1179
-
1180
- <span id="base_path=-instance_method"></span>
1181
- <div class="method_details ">
1182
- <h3 class="signature " id="base_path-instance_method">
1183
-
1184
- #<strong>base_path</strong> &#x21d2; <tt>Object</tt>
1185
-
1186
-
1187
-
1188
-
1189
-
1190
- </h3><div class="docstring">
1191
- <div class="discussion">
1192
-
1193
- <p>Defines url base path</p>
1194
-
1195
-
1196
- </div>
1197
- </div>
1198
- <div class="tags">
1199
-
1200
-
1201
- </div><table class="source_code">
1202
- <tr>
1203
- <td>
1204
- <pre class="lines">
1205
-
1206
-
1207
- 24
1208
- 25
1209
- 26</pre>
1210
- </td>
1211
- <td>
1212
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 24</span>
1213
-
1214
- <span class='kw'>def</span> <span class='id identifier rubyid_base_path'>base_path</span>
1215
- <span class='ivar'>@base_path</span>
1216
- <span class='kw'>end</span></pre>
1217
- </td>
1218
- </tr>
1219
- </table>
1220
- </div>
1221
-
1222
-
1223
- <span id="cert_file=-instance_method"></span>
1224
- <div class="method_details ">
1225
- <h3 class="signature " id="cert_file-instance_method">
1226
-
1227
- #<strong>cert_file</strong> &#x21d2; <tt>Object</tt>
1228
-
1229
-
1230
-
1231
-
1232
-
1233
- </h3><div class="docstring">
1234
- <div class="discussion">
1235
-
1236
- <p>TLS/SSL setting Client certificate file (for client certificate)</p>
1237
-
1238
-
1239
- </div>
1240
- </div>
1241
- <div class="tags">
1242
-
1243
-
1244
- </div><table class="source_code">
1245
- <tr>
1246
- <td>
1247
- <pre class="lines">
1248
-
1249
-
1250
- 113
1251
- 114
1252
- 115</pre>
1253
- </td>
1254
- <td>
1255
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 113</span>
1256
-
1257
- <span class='kw'>def</span> <span class='id identifier rubyid_cert_file'>cert_file</span>
1258
- <span class='ivar'>@cert_file</span>
1259
- <span class='kw'>end</span></pre>
1260
- </td>
1261
- </tr>
1262
- </table>
1263
- </div>
1264
-
1265
-
1266
- <span id="client_side_validation=-instance_method"></span>
1267
- <div class="method_details ">
1268
- <h3 class="signature " id="client_side_validation-instance_method">
1269
-
1270
- #<strong>client_side_validation</strong> &#x21d2; <tt>true</tt>, <tt>false</tt>
1271
-
1272
-
1273
-
1274
-
1275
-
1276
- </h3><div class="docstring">
1277
- <div class="discussion">
1278
-
1279
- <p>Set this to false to skip client side validation in the operation. Default
1280
- to true.</p>
1281
-
1282
-
1283
- </div>
1284
- </div>
1285
- <div class="tags">
1286
-
1287
- <p class="tag_title">Returns:</p>
1288
- <ul class="return">
1289
-
1290
- <li>
1291
-
1292
-
1293
- <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
1294
-
1295
-
1296
-
1297
- </li>
1298
-
1299
- </ul>
1300
-
1301
- </div><table class="source_code">
1302
- <tr>
1303
- <td>
1304
- <pre class="lines">
1305
-
1306
-
1307
- 82
1308
- 83
1309
- 84</pre>
1310
- </td>
1311
- <td>
1312
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 82</span>
1313
-
1314
- <span class='kw'>def</span> <span class='id identifier rubyid_client_side_validation'>client_side_validation</span>
1315
- <span class='ivar'>@client_side_validation</span>
1316
- <span class='kw'>end</span></pre>
1317
- </td>
1318
- </tr>
1319
- </table>
1320
- </div>
1321
-
1322
-
1323
- <span id="debugging=-instance_method"></span>
1324
- <div class="method_details ">
1325
- <h3 class="signature " id="debugging-instance_method">
1326
-
1327
- #<strong>debugging</strong> &#x21d2; <tt>true</tt>, <tt>false</tt>
1328
-
1329
-
1330
-
1331
-
1332
-
1333
- </h3><div class="docstring">
1334
- <div class="discussion">
1335
-
1336
- <p>Set this to enable/disable debugging. When enabled (set to true), HTTP
1337
- request/response details will be logged with `logger.debug` (see the
1338
- `logger` attribute). Default to false.</p>
1339
-
1340
-
1341
- </div>
1342
- </div>
1343
- <div class="tags">
1344
-
1345
- <p class="tag_title">Returns:</p>
1346
- <ul class="return">
1347
-
1348
- <li>
1349
-
1350
-
1351
- <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
1352
-
1353
-
1354
-
1355
- </li>
1356
-
1357
- </ul>
1358
-
1359
- </div><table class="source_code">
1360
- <tr>
1361
- <td>
1362
- <pre class="lines">
1363
-
1364
-
1365
- 60
1366
- 61
1367
- 62</pre>
1368
- </td>
1369
- <td>
1370
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 60</span>
1371
-
1372
- <span class='kw'>def</span> <span class='id identifier rubyid_debugging'>debugging</span>
1373
- <span class='ivar'>@debugging</span>
1374
- <span class='kw'>end</span></pre>
1375
- </td>
1376
- </tr>
1377
- </table>
1378
- </div>
1379
-
1380
-
1381
- <span id="force_ending_format=-instance_method"></span>
1382
- <div class="method_details ">
1383
- <h3 class="signature " id="force_ending_format-instance_method">
1384
-
1385
- #<strong>force_ending_format</strong> &#x21d2; <tt>Object</tt>
1386
-
1387
-
1388
-
1389
-
1390
-
1391
- </h3><div class="docstring">
1392
- <div class="discussion">
1393
-
1394
- <p>Returns the value of attribute force_ending_format</p>
1395
-
1396
-
1397
- </div>
1398
- </div>
1399
- <div class="tags">
1400
-
1401
-
1402
- </div><table class="source_code">
1403
- <tr>
1404
- <td>
1405
- <pre class="lines">
1406
-
1407
-
1408
- 128
1409
- 129
1410
- 130</pre>
1411
- </td>
1412
- <td>
1413
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 128</span>
1414
-
1415
- <span class='kw'>def</span> <span class='id identifier rubyid_force_ending_format'>force_ending_format</span>
1416
- <span class='ivar'>@force_ending_format</span>
1417
- <span class='kw'>end</span></pre>
1418
- </td>
1419
- </tr>
1420
- </table>
1421
- </div>
1422
-
1423
-
1424
- <span id="host=-instance_method"></span>
1425
- <div class="method_details ">
1426
- <h3 class="signature " id="host-instance_method">
1427
-
1428
- #<strong>host</strong> &#x21d2; <tt>Object</tt>
1429
-
1430
-
1431
-
1432
-
1433
-
1434
- </h3><div class="docstring">
1435
- <div class="discussion">
1436
-
1437
- <p>Defines url host</p>
1438
-
1439
-
1440
- </div>
1441
- </div>
1442
- <div class="tags">
1443
-
1444
-
1445
- </div><table class="source_code">
1446
- <tr>
1447
- <td>
1448
- <pre class="lines">
1449
-
1450
-
1451
- 21
1452
- 22
1453
- 23</pre>
1454
- </td>
1455
- <td>
1456
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 21</span>
1457
-
1458
- <span class='kw'>def</span> <span class='id identifier rubyid_host'>host</span>
1459
- <span class='ivar'>@host</span>
1460
- <span class='kw'>end</span></pre>
1461
- </td>
1462
- </tr>
1463
- </table>
1464
- </div>
1465
-
1466
-
1467
- <span id="inject_format=-instance_method"></span>
1468
- <div class="method_details ">
1469
- <h3 class="signature " id="inject_format-instance_method">
1470
-
1471
- #<strong>inject_format</strong> &#x21d2; <tt>Object</tt>
1472
-
1473
-
1474
-
1475
-
1476
-
1477
- </h3><div class="docstring">
1478
- <div class="discussion">
1479
-
1480
- <p>Returns the value of attribute inject_format</p>
1481
-
1482
-
1483
- </div>
1484
- </div>
1485
- <div class="tags">
1486
-
1487
-
1488
- </div><table class="source_code">
1489
- <tr>
1490
- <td>
1491
- <pre class="lines">
1492
-
1493
-
1494
- 126
1495
- 127
1496
- 128</pre>
1497
- </td>
1498
- <td>
1499
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 126</span>
1500
-
1501
- <span class='kw'>def</span> <span class='id identifier rubyid_inject_format'>inject_format</span>
1502
- <span class='ivar'>@inject_format</span>
1503
- <span class='kw'>end</span></pre>
1504
- </td>
1505
- </tr>
1506
- </table>
1507
- </div>
1508
-
1509
-
1510
- <span id="key_file=-instance_method"></span>
1511
- <div class="method_details ">
1512
- <h3 class="signature " id="key_file-instance_method">
1513
-
1514
- #<strong>key_file</strong> &#x21d2; <tt>Object</tt>
1515
-
1516
-
1517
-
1518
-
1519
-
1520
- </h3><div class="docstring">
1521
- <div class="discussion">
1522
-
1523
- <p>TLS/SSL setting Client private key file (for client certificate)</p>
1524
-
1525
-
1526
- </div>
1527
- </div>
1528
- <div class="tags">
1529
-
1530
-
1531
- </div><table class="source_code">
1532
- <tr>
1533
- <td>
1534
- <pre class="lines">
1535
-
1536
-
1537
- 117
1538
- 118
1539
- 119</pre>
1540
- </td>
1541
- <td>
1542
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 117</span>
1543
-
1544
- <span class='kw'>def</span> <span class='id identifier rubyid_key_file'>key_file</span>
1545
- <span class='ivar'>@key_file</span>
1546
- <span class='kw'>end</span></pre>
1547
- </td>
1548
- </tr>
1549
- </table>
1550
- </div>
1551
-
1552
-
1553
- <span id="logger=-instance_method"></span>
1554
- <div class="method_details ">
1555
- <h3 class="signature " id="logger-instance_method">
1556
-
1557
- #<strong>logger</strong> &#x21d2; <tt>#debug</tt>
1558
-
1559
-
1560
-
1561
-
1562
-
1563
- </h3><div class="docstring">
1564
- <div class="discussion">
1565
-
1566
- <p>Defines the logger used for debugging. Default to `Rails.logger` (when in
1567
- Rails) or logging to STDOUT.</p>
1568
-
1569
-
1570
- </div>
1571
- </div>
1572
- <div class="tags">
1573
-
1574
- <p class="tag_title">Returns:</p>
1575
- <ul class="return">
1576
-
1577
- <li>
1578
-
1579
-
1580
- <span class='type'>(<tt>#debug</tt>)</span>
1581
-
1582
-
1583
-
1584
- </li>
1585
-
1586
- </ul>
1587
-
1588
- </div><table class="source_code">
1589
- <tr>
1590
- <td>
1591
- <pre class="lines">
1592
-
1593
-
1594
- 66
1595
- 67
1596
- 68</pre>
1597
- </td>
1598
- <td>
1599
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 66</span>
1600
-
1601
- <span class='kw'>def</span> <span class='id identifier rubyid_logger'>logger</span>
1602
- <span class='ivar'>@logger</span>
1603
- <span class='kw'>end</span></pre>
1604
- </td>
1605
- </tr>
1606
- </table>
1607
- </div>
1608
-
1609
-
1610
- <span id="params_encoding=-instance_method"></span>
1611
- <div class="method_details ">
1612
- <h3 class="signature " id="params_encoding-instance_method">
1613
-
1614
- #<strong>params_encoding</strong> &#x21d2; <tt>Object</tt>
1615
-
1616
-
1617
-
1618
-
1619
-
1620
- </h3><div class="docstring">
1621
- <div class="discussion">
1622
-
1623
- <p>Set this to customize parameters encoding of array parameter with multi
1624
- collectionFormat. Default to nil.</p>
1625
-
1626
- <p><a
1627
- href="https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96">github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96</a></p>
1628
-
1629
-
1630
- </div>
1631
- </div>
1632
- <div class="tags">
1633
-
1634
-
1635
- <p class="tag_title">See Also:</p>
1636
- <ul class="see">
1637
-
1638
- <li>params_encoding option of Ethon. Related source code:</li>
1639
-
1640
- </ul>
1641
-
1642
- </div><table class="source_code">
1643
- <tr>
1644
- <td>
1645
- <pre class="lines">
1646
-
1647
-
1648
- 124
1649
- 125
1650
- 126</pre>
1651
- </td>
1652
- <td>
1653
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 124</span>
1654
-
1655
- <span class='kw'>def</span> <span class='id identifier rubyid_params_encoding'>params_encoding</span>
1656
- <span class='ivar'>@params_encoding</span>
1657
- <span class='kw'>end</span></pre>
1658
- </td>
1659
- </tr>
1660
- </table>
1661
- </div>
1662
-
1663
-
1664
- <span id="password=-instance_method"></span>
1665
- <div class="method_details ">
1666
- <h3 class="signature " id="password-instance_method">
1667
-
1668
- #<strong>password</strong> &#x21d2; <tt>String</tt>
1669
-
1670
-
1671
-
1672
-
1673
-
1674
- </h3><div class="docstring">
1675
- <div class="discussion">
1676
-
1677
- <p>Defines the password used with HTTP basic authentication.</p>
1678
-
1679
-
1680
- </div>
1681
- </div>
1682
- <div class="tags">
1683
-
1684
- <p class="tag_title">Returns:</p>
1685
- <ul class="return">
1686
-
1687
- <li>
1688
-
1689
-
1690
- <span class='type'>(<tt>String</tt>)</span>
1691
-
1692
-
1693
-
1694
- </li>
1695
-
1696
- </ul>
1697
-
1698
- </div><table class="source_code">
1699
- <tr>
1700
- <td>
1701
- <pre class="lines">
1702
-
1703
-
1704
- 50
1705
- 51
1706
- 52</pre>
1707
- </td>
1708
- <td>
1709
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 50</span>
1710
-
1711
- <span class='kw'>def</span> <span class='id identifier rubyid_password'>password</span>
1712
- <span class='ivar'>@password</span>
1713
- <span class='kw'>end</span></pre>
1714
- </td>
1715
- </tr>
1716
- </table>
1717
- </div>
1718
-
1719
-
1720
- <span id="scheme=-instance_method"></span>
1721
- <div class="method_details ">
1722
- <h3 class="signature " id="scheme-instance_method">
1723
-
1724
- #<strong>scheme</strong> &#x21d2; <tt>Object</tt>
1725
-
1726
-
1727
-
1728
-
1729
-
1730
- </h3><div class="docstring">
1731
- <div class="discussion">
1732
-
1733
- <p>Defines url scheme</p>
1734
-
1735
-
1736
- </div>
1737
- </div>
1738
- <div class="tags">
1739
-
1740
-
1741
- </div><table class="source_code">
1742
- <tr>
1743
- <td>
1744
- <pre class="lines">
1745
-
1746
-
1747
- 18
1748
- 19
1749
- 20</pre>
1750
- </td>
1751
- <td>
1752
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 18</span>
1753
-
1754
- <span class='kw'>def</span> <span class='id identifier rubyid_scheme'>scheme</span>
1755
- <span class='ivar'>@scheme</span>
1756
- <span class='kw'>end</span></pre>
1757
- </td>
1758
- </tr>
1759
- </table>
1760
- </div>
1761
-
1762
-
1763
- <span id="ssl_ca_cert=-instance_method"></span>
1764
- <div class="method_details ">
1765
- <h3 class="signature " id="ssl_ca_cert-instance_method">
1766
-
1767
- #<strong>ssl_ca_cert</strong> &#x21d2; <tt>String</tt>
1768
-
1769
-
1770
-
1771
-
1772
-
1773
- </h3><div class="docstring">
1774
- <div class="discussion">
1775
-
1776
- <p>TLS/SSL setting Set this to customize the certificate file to verify the
1777
- peer.</p>
1778
-
1779
- <p><a
1780
- href="https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145">github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145</a></p>
1781
-
1782
-
1783
- </div>
1784
- </div>
1785
- <div class="tags">
1786
-
1787
- <p class="tag_title">Returns:</p>
1788
- <ul class="return">
1789
-
1790
- <li>
1791
-
1792
-
1793
- <span class='type'>(<tt>String</tt>)</span>
1794
-
1795
-
1796
-
1797
- &mdash;
1798
- <div class='inline'>
1799
- <p>the path to the certificate file</p>
1800
- </div>
1801
-
1802
- </li>
1803
-
1804
- </ul>
1805
-
1806
- <p class="tag_title">See Also:</p>
1807
- <ul class="see">
1808
-
1809
- <li>`cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:</li>
1810
-
1811
- </ul>
1812
-
1813
- </div><table class="source_code">
1814
- <tr>
1815
- <td>
1816
- <pre class="lines">
1817
-
1818
-
1819
- 109
1820
- 110
1821
- 111</pre>
1822
- </td>
1823
- <td>
1824
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 109</span>
1825
-
1826
- <span class='kw'>def</span> <span class='id identifier rubyid_ssl_ca_cert'>ssl_ca_cert</span>
1827
- <span class='ivar'>@ssl_ca_cert</span>
1828
- <span class='kw'>end</span></pre>
1829
- </td>
1830
- </tr>
1831
- </table>
1832
- </div>
1833
-
1834
-
1835
- <span id="temp_folder_path=-instance_method"></span>
1836
- <div class="method_details ">
1837
- <h3 class="signature " id="temp_folder_path-instance_method">
1838
-
1839
- #<strong>temp_folder_path</strong> &#x21d2; <tt>String</tt>
1840
-
1841
-
1842
-
1843
-
1844
-
1845
- </h3><div class="docstring">
1846
- <div class="discussion">
1847
-
1848
- <p>Defines the temporary folder to store downloaded files (for API endpoints
1849
- that have file response). Default to use `Tempfile`.</p>
1850
-
1851
-
1852
- </div>
1853
- </div>
1854
- <div class="tags">
1855
-
1856
- <p class="tag_title">Returns:</p>
1857
- <ul class="return">
1858
-
1859
- <li>
1860
-
1861
-
1862
- <span class='type'>(<tt>String</tt>)</span>
1863
-
1864
-
1865
-
1866
- </li>
1867
-
1868
- </ul>
1869
-
1870
- </div><table class="source_code">
1871
- <tr>
1872
- <td>
1873
- <pre class="lines">
1874
-
1875
-
1876
- 73
1877
- 74
1878
- 75</pre>
1879
- </td>
1880
- <td>
1881
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 73</span>
1882
-
1883
- <span class='kw'>def</span> <span class='id identifier rubyid_temp_folder_path'>temp_folder_path</span>
1884
- <span class='ivar'>@temp_folder_path</span>
1885
- <span class='kw'>end</span></pre>
1886
- </td>
1887
- </tr>
1888
- </table>
1889
- </div>
1890
-
1891
-
1892
- <span id="timeout=-instance_method"></span>
1893
- <div class="method_details ">
1894
- <h3 class="signature " id="timeout-instance_method">
1895
-
1896
- #<strong>timeout</strong> &#x21d2; <tt>Object</tt>
1897
-
1898
-
1899
-
1900
-
1901
-
1902
- </h3><div class="docstring">
1903
- <div class="discussion">
1904
-
1905
- <p>The time limit for HTTP request in seconds. Default to 0 (never times out).</p>
1906
-
1907
-
1908
- </div>
1909
- </div>
1910
- <div class="tags">
1911
-
1912
-
1913
- </div><table class="source_code">
1914
- <tr>
1915
- <td>
1916
- <pre class="lines">
1917
-
1918
-
1919
- 77
1920
- 78
1921
- 79</pre>
1922
- </td>
1923
- <td>
1924
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 77</span>
1925
-
1926
- <span class='kw'>def</span> <span class='id identifier rubyid_timeout'>timeout</span>
1927
- <span class='ivar'>@timeout</span>
1928
- <span class='kw'>end</span></pre>
1929
- </td>
1930
- </tr>
1931
- </table>
1932
- </div>
1933
-
1934
-
1935
- <span id="username=-instance_method"></span>
1936
- <div class="method_details ">
1937
- <h3 class="signature " id="username-instance_method">
1938
-
1939
- #<strong>username</strong> &#x21d2; <tt>String</tt>
1940
-
1941
-
1942
-
1943
-
1944
-
1945
- </h3><div class="docstring">
1946
- <div class="discussion">
1947
-
1948
- <p>Defines the username used with HTTP basic authentication.</p>
1949
-
1950
-
1951
- </div>
1952
- </div>
1953
- <div class="tags">
1954
-
1955
- <p class="tag_title">Returns:</p>
1956
- <ul class="return">
1957
-
1958
- <li>
1959
-
1960
-
1961
- <span class='type'>(<tt>String</tt>)</span>
1962
-
1963
-
1964
-
1965
- </li>
1966
-
1967
- </ul>
1968
-
1969
- </div><table class="source_code">
1970
- <tr>
1971
- <td>
1972
- <pre class="lines">
1973
-
1974
-
1975
- 45
1976
- 46
1977
- 47</pre>
1978
- </td>
1979
- <td>
1980
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 45</span>
1981
-
1982
- <span class='kw'>def</span> <span class='id identifier rubyid_username'>username</span>
1983
- <span class='ivar'>@username</span>
1984
- <span class='kw'>end</span></pre>
1985
- </td>
1986
- </tr>
1987
- </table>
1988
- </div>
1989
-
1990
-
1991
- <span id="verify_ssl=-instance_method"></span>
1992
- <div class="method_details ">
1993
- <h3 class="signature " id="verify_ssl-instance_method">
1994
-
1995
- #<strong>verify_ssl</strong> &#x21d2; <tt>true</tt>, <tt>false</tt>
1996
-
1997
-
1998
-
1999
-
2000
-
2001
- </h3><div class="docstring">
2002
- <div class="discussion">
2003
-
2004
- <div class="note notetag">
2005
- <strong>Note:</strong>
2006
- <div class='inline'>
2007
- <p>Do NOT set it to false in production code, otherwise you would face
2008
- multiple types of cryptographic attacks.</p>
2009
- </div>
2010
- </div>
2011
-
2012
-
2013
- <p>TLS/SSL setting Set this to false to skip verifying SSL certificate when
2014
- calling API from https server. Default to true.</p>
2015
-
2016
-
2017
- </div>
2018
- </div>
2019
- <div class="tags">
2020
-
2021
- <p class="tag_title">Returns:</p>
2022
- <ul class="return">
2023
-
2024
- <li>
2025
-
2026
-
2027
- <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
2028
-
2029
-
2030
-
2031
- </li>
2032
-
2033
- </ul>
2034
-
2035
- </div><table class="source_code">
2036
- <tr>
2037
- <td>
2038
- <pre class="lines">
2039
-
2040
-
2041
- 91
2042
- 92
2043
- 93</pre>
2044
- </td>
2045
- <td>
2046
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 91</span>
2047
-
2048
- <span class='kw'>def</span> <span class='id identifier rubyid_verify_ssl'>verify_ssl</span>
2049
- <span class='ivar'>@verify_ssl</span>
2050
- <span class='kw'>end</span></pre>
2051
- </td>
2052
- </tr>
2053
- </table>
2054
- </div>
2055
-
2056
-
2057
- <span id="verify_ssl_host=-instance_method"></span>
2058
- <div class="method_details ">
2059
- <h3 class="signature " id="verify_ssl_host-instance_method">
2060
-
2061
- #<strong>verify_ssl_host</strong> &#x21d2; <tt>true</tt>, <tt>false</tt>
2062
-
2063
-
2064
-
2065
-
2066
-
2067
- </h3><div class="docstring">
2068
- <div class="discussion">
2069
-
2070
- <div class="note notetag">
2071
- <strong>Note:</strong>
2072
- <div class='inline'>
2073
- <p>Do NOT set it to false in production code, otherwise you would face
2074
- multiple types of cryptographic attacks.</p>
2075
- </div>
2076
- </div>
2077
-
2078
-
2079
- <p>TLS/SSL setting Set this to false to skip verifying SSL host name Default
2080
- to true.</p>
2081
-
2082
-
2083
- </div>
2084
- </div>
2085
- <div class="tags">
2086
-
2087
- <p class="tag_title">Returns:</p>
2088
- <ul class="return">
2089
-
2090
- <li>
2091
-
2092
-
2093
- <span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
2094
-
2095
-
2096
-
2097
- </li>
2098
-
2099
- </ul>
2100
-
2101
- </div><table class="source_code">
2102
- <tr>
2103
- <td>
2104
- <pre class="lines">
2105
-
2106
-
2107
- 100
2108
- 101
2109
- 102</pre>
2110
- </td>
2111
- <td>
2112
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 100</span>
2113
-
2114
- <span class='kw'>def</span> <span class='id identifier rubyid_verify_ssl_host'>verify_ssl_host</span>
2115
- <span class='ivar'>@verify_ssl_host</span>
2116
- <span class='kw'>end</span></pre>
2117
- </td>
2118
- </tr>
2119
- </table>
2120
- </div>
2121
-
2122
- </div>
2123
-
2124
-
2125
- <div id="class_method_details" class="method_details_list">
2126
- <h2>Class Method Details</h2>
2127
-
2128
-
2129
- <div class="method_details first">
2130
- <h3 class="signature first" id="default-class_method">
2131
-
2132
- .<strong>default</strong> &#x21d2; <tt>Object</tt>
2133
-
2134
-
2135
-
2136
-
2137
-
2138
- </h3><div class="docstring">
2139
- <div class="discussion">
2140
-
2141
- <p>The default Configuration object.</p>
2142
-
2143
-
2144
- </div>
2145
- </div>
2146
- <div class="tags">
2147
-
2148
-
2149
- </div><table class="source_code">
2150
- <tr>
2151
- <td>
2152
- <pre class="lines">
2153
-
2154
-
2155
- 152
2156
- 153
2157
- 154</pre>
2158
- </td>
2159
- <td>
2160
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 152</span>
2161
-
2162
- <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_default'>default</span>
2163
- <span class='cvar'>@@default</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="" title="TreezorClient::Configuration (class)">Configuration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="TreezorClient::Configuration#initialize (method)">new</a></span></span>
2164
- <span class='kw'>end</span></pre>
2165
- </td>
2166
- </tr>
2167
- </table>
2168
- </div>
2169
-
2170
- </div>
2171
-
2172
- <div id="instance_method_details" class="method_details_list">
2173
- <h2>Instance Method Details</h2>
2174
-
2175
-
2176
- <div class="method_details first">
2177
- <h3 class="signature first" id="api_key_with_prefix-instance_method">
2178
-
2179
- #<strong>api_key_with_prefix</strong>(param_name) &#x21d2; <tt>Object</tt>
2180
-
2181
-
2182
-
2183
-
2184
-
2185
- </h3><div class="docstring">
2186
- <div class="discussion">
2187
-
2188
- <p>Gets API key (with prefix if set).</p>
2189
-
2190
-
2191
- </div>
2192
- </div>
2193
- <div class="tags">
2194
- <p class="tag_title">Parameters:</p>
2195
- <ul class="param">
2196
-
2197
- <li>
2198
-
2199
- <span class='name'>param_name</span>
2200
-
2201
-
2202
- <span class='type'>(<tt>String</tt>)</span>
2203
-
2204
-
2205
-
2206
- &mdash;
2207
- <div class='inline'>
2208
- <p>the parameter name of API key auth</p>
2209
- </div>
2210
-
2211
- </li>
2212
-
2213
- </ul>
2214
-
2215
-
2216
- </div><table class="source_code">
2217
- <tr>
2218
- <td>
2219
- <pre class="lines">
2220
-
2221
-
2222
- 183
2223
- 184
2224
- 185
2225
- 186
2226
- 187
2227
- 188
2228
- 189</pre>
2229
- </td>
2230
- <td>
2231
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 183</span>
2232
-
2233
- <span class='kw'>def</span> <span class='id identifier rubyid_api_key_with_prefix'>api_key_with_prefix</span><span class='lparen'>(</span><span class='id identifier rubyid_param_name'>param_name</span><span class='rparen'>)</span>
2234
- <span class='kw'>if</span> <span class='ivar'>@api_key_prefix</span><span class='lbracket'>[</span><span class='id identifier rubyid_param_name'>param_name</span><span class='rbracket'>]</span>
2235
- <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@api_key_prefix</span><span class='lbracket'>[</span><span class='id identifier rubyid_param_name'>param_name</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='ivar'>@api_key</span><span class='lbracket'>[</span><span class='id identifier rubyid_param_name'>param_name</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
2236
- <span class='kw'>else</span>
2237
- <span class='ivar'>@api_key</span><span class='lbracket'>[</span><span class='id identifier rubyid_param_name'>param_name</span><span class='rbracket'>]</span>
2238
- <span class='kw'>end</span>
2239
- <span class='kw'>end</span></pre>
2240
- </td>
2241
- </tr>
2242
- </table>
2243
- </div>
2244
-
2245
- <div class="method_details ">
2246
- <h3 class="signature " id="auth_settings-instance_method">
2247
-
2248
- #<strong>auth_settings</strong> &#x21d2; <tt>Object</tt>
2249
-
2250
-
2251
-
2252
-
2253
-
2254
- </h3><div class="docstring">
2255
- <div class="discussion">
2256
-
2257
- <p>Returns Auth Settings hash for api client.</p>
2258
-
2259
-
2260
- </div>
2261
- </div>
2262
- <div class="tags">
2263
-
2264
-
2265
- </div><table class="source_code">
2266
- <tr>
2267
- <td>
2268
- <pre class="lines">
2269
-
2270
-
2271
- 197
2272
- 198
2273
- 199
2274
- 200
2275
- 201
2276
- 202
2277
- 203
2278
- 204
2279
- 205
2280
- 206
2281
- 207</pre>
2282
- </td>
2283
- <td>
2284
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 197</span>
2285
-
2286
- <span class='kw'>def</span> <span class='id identifier rubyid_auth_settings'>auth_settings</span>
2287
- <span class='lbrace'>{</span>
2288
- <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='op'>=&gt;</span>
2289
- <span class='lbrace'>{</span>
2290
- <span class='label'>type:</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='comma'>,</span>
2291
- <span class='label'>in:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>header</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
2292
- <span class='label'>key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Authorization</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
2293
- <span class='label'>value:</span> <span class='id identifier rubyid_api_key_with_prefix'>api_key_with_prefix</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Authorization</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
2294
- <span class='rbrace'>}</span><span class='comma'>,</span>
2295
- <span class='rbrace'>}</span>
2296
- <span class='kw'>end</span></pre>
2297
- </td>
2298
- </tr>
2299
- </table>
2300
- </div>
2301
-
2302
- <div class="method_details ">
2303
- <h3 class="signature " id="base_url-instance_method">
2304
-
2305
- #<strong>base_url</strong> &#x21d2; <tt>Object</tt>
2306
-
2307
-
2308
-
2309
-
2310
-
2311
- </h3><table class="source_code">
2312
- <tr>
2313
- <td>
2314
- <pre class="lines">
2315
-
2316
-
2317
- 176
2318
- 177
2319
- 178
2320
- 179</pre>
2321
- </td>
2322
- <td>
2323
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 176</span>
2324
-
2325
- <span class='kw'>def</span> <span class='id identifier rubyid_base_url'>base_url</span>
2326
- <span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_scheme'>scheme</span><span class='embexpr_end'>}</span><span class='tstring_content'>://</span><span class='embexpr_beg'>#{</span><span class='lbracket'>[</span><span class='id identifier rubyid_host'>host</span><span class='comma'>,</span> <span class='id identifier rubyid_base_path'>base_path</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</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='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\/+</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</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='regexp_beg'>/</span><span class='tstring_content'>\/+\z</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
2327
- <span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
2328
- <span class='kw'>end</span></pre>
2329
- </td>
2330
- </tr>
2331
- </table>
2332
- </div>
2333
-
2334
- <div class="method_details ">
2335
- <h3 class="signature " id="basic_auth_token-instance_method">
2336
-
2337
- #<strong>basic_auth_token</strong> &#x21d2; <tt>Object</tt>
2338
-
2339
-
2340
-
2341
-
2342
-
2343
- </h3><div class="docstring">
2344
- <div class="discussion">
2345
-
2346
- <p>Gets Basic Auth token string</p>
2347
-
2348
-
2349
- </div>
2350
- </div>
2351
- <div class="tags">
2352
-
2353
-
2354
- </div><table class="source_code">
2355
- <tr>
2356
- <td>
2357
- <pre class="lines">
2358
-
2359
-
2360
- 192
2361
- 193
2362
- 194</pre>
2363
- </td>
2364
- <td>
2365
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 192</span>
2366
-
2367
- <span class='kw'>def</span> <span class='id identifier rubyid_basic_auth_token'>basic_auth_token</span>
2368
- <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Basic </span><span class='tstring_end'>&#39;</span></span> <span class='op'>+</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_username'>username</span><span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_password'>password</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_pack'>pack</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>m</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\r\n</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
2369
- <span class='kw'>end</span></pre>
2370
- </td>
2371
- </tr>
2372
- </table>
2373
- </div>
2374
-
2375
- <div class="method_details ">
2376
- <h3 class="signature " id="configure-instance_method">
2377
-
2378
- #<strong>configure</strong> {|_self| ... } &#x21d2; <tt>Object</tt>
2379
-
2380
-
2381
-
2382
-
2383
-
2384
- </h3><div class="docstring">
2385
- <div class="discussion">
2386
-
2387
-
2388
- </div>
2389
- </div>
2390
- <div class="tags">
2391
-
2392
- <p class="tag_title">Yields:</p>
2393
- <ul class="yield">
2394
-
2395
- <li>
2396
-
2397
-
2398
- <span class='type'>(<tt>_self</tt>)</span>
2399
-
2400
-
2401
-
2402
- </li>
2403
-
2404
- </ul>
2405
- <p class="tag_title">Yield Parameters:</p>
2406
- <ul class="yieldparam">
2407
-
2408
- <li>
2409
-
2410
- <span class='name'>_self</span>
2411
-
2412
-
2413
- <span class='type'>(<tt><span class='object_link'><a href="" title="TreezorClient::Configuration (class)">TreezorClient::Configuration</a></span></tt>)</span>
2414
-
2415
-
2416
-
2417
- &mdash;
2418
- <div class='inline'>
2419
- <p>the object that the method was called on</p>
2420
- </div>
2421
-
2422
- </li>
2423
-
2424
- </ul>
2425
-
2426
- </div><table class="source_code">
2427
- <tr>
2428
- <td>
2429
- <pre class="lines">
2430
-
2431
-
2432
- 156
2433
- 157
2434
- 158</pre>
2435
- </td>
2436
- <td>
2437
- <pre class="code"><span class="info file"># File 'lib/treezor_client/configuration.rb', line 156</span>
2438
-
2439
- <span class='kw'>def</span> <span class='id identifier rubyid_configure'>configure</span>
2440
- <span class='kw'>yield</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
2441
- <span class='kw'>end</span></pre>
2442
- </td>
2443
- </tr>
2444
- </table>
2445
- </div>
2446
-
2447
- </div>
2448
-
2449
- </div>
2450
-
2451
- <div id="footer">
2452
- Generated on Wed Aug 8 17:39:04 2018 by
2453
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2454
- 0.9.15 (ruby-2.5.1).
2455
- </div>
2456
-
2457
- </div>
2458
- </body>
2459
- </html>