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.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/Gemfile.lock +8 -7
- data/docs/BusinessApi.md +2 -2
- data/docs/Payin.md +1 -1
- data/docs/PayinApi.md +2 -2
- data/docs/Payinrefund.md +1 -1
- data/docs/PayinrefundApi.md +4 -4
- data/generate.sh +10 -0
- data/lib/treezor_client/api/balance_api.rb +1 -1
- data/lib/treezor_client/api/bankaccount_api.rb +1 -1
- data/lib/treezor_client/api/beneficiaries_api.rb +1 -1
- data/lib/treezor_client/api/business_api.rb +4 -4
- data/lib/treezor_client/api/card_api.rb +1 -1
- data/lib/treezor_client/api/card_digitalizations_api.rb +1 -1
- data/lib/treezor_client/api/card_reserve_api.rb +1 -1
- data/lib/treezor_client/api/cardtransaction_api.rb +1 -1
- data/lib/treezor_client/api/country_restriction_groups_api.rb +1 -1
- data/lib/treezor_client/api/document_api.rb +1 -1
- data/lib/treezor_client/api/heartbeat_api.rb +1 -1
- data/lib/treezor_client/api/issuer_initiated_digitization_data_api.rb +1 -1
- data/lib/treezor_client/api/mandate_api.rb +1 -1
- data/lib/treezor_client/api/mcc_restriction_groups_api.rb +1 -1
- data/lib/treezor_client/api/merchant_id_restriction_groups_api.rb +1 -1
- data/lib/treezor_client/api/payin_api.rb +3 -3
- data/lib/treezor_client/api/payinrefund_api.rb +3 -3
- data/lib/treezor_client/api/payout_api.rb +1 -1
- data/lib/treezor_client/api/payout_refunds_api.rb +1 -1
- data/lib/treezor_client/api/tax_residence_api.rb +1 -1
- data/lib/treezor_client/api/transaction_api.rb +1 -1
- data/lib/treezor_client/api/transfer_api.rb +1 -1
- data/lib/treezor_client/api/transferrefund_api.rb +1 -1
- data/lib/treezor_client/api/user_api.rb +1 -1
- data/lib/treezor_client/api/virtualibans_api.rb +1 -1
- data/lib/treezor_client/api/wallet_api.rb +1 -1
- data/lib/treezor_client/api_client.rb +6 -4
- data/lib/treezor_client/api_error.rb +1 -1
- data/lib/treezor_client/configuration.rb +3 -3
- data/lib/treezor_client/models/balance.rb +3 -2
- data/lib/treezor_client/models/bankaccount.rb +3 -2
- data/lib/treezor_client/models/beneficiaries_sdd_b2b_whitelist.rb +3 -2
- data/lib/treezor_client/models/beneficiary.rb +3 -2
- data/lib/treezor_client/models/body.rb +3 -2
- data/lib/treezor_client/models/body_1.rb +3 -2
- data/lib/treezor_client/models/body_10.rb +3 -2
- data/lib/treezor_client/models/body_11.rb +3 -2
- data/lib/treezor_client/models/body_2.rb +3 -2
- data/lib/treezor_client/models/body_3.rb +3 -2
- data/lib/treezor_client/models/body_4.rb +3 -2
- data/lib/treezor_client/models/body_5.rb +3 -2
- data/lib/treezor_client/models/body_6.rb +3 -2
- data/lib/treezor_client/models/body_7.rb +3 -2
- data/lib/treezor_client/models/body_8.rb +3 -2
- data/lib/treezor_client/models/body_9.rb +3 -2
- data/lib/treezor_client/models/businesssearchs_businessinformations.rb +3 -2
- data/lib/treezor_client/models/card.rb +3 -2
- data/lib/treezor_client/models/card_digitalization.rb +3 -2
- data/lib/treezor_client/models/country_restriction_group.rb +3 -2
- data/lib/treezor_client/models/document.rb +3 -2
- data/lib/treezor_client/models/error.rb +3 -2
- data/lib/treezor_client/models/inline_response_200.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_1.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_10.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_10_cardtransactions.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_11.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_12.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_13.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_14.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_15.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_16.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_17.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_18.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_19.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_2.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_20.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_21.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_22.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_23.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_24.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_25.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_26.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_27.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_28.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_3.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_4.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_4_businessinformations.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_4_users.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_5.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_6.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_6_cardimages.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_7.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_8.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_9.rb +3 -2
- data/lib/treezor_client/models/inline_response_200_9_cardtransactions.rb +3 -2
- data/lib/treezor_client/models/inline_response_default.rb +3 -2
- data/lib/treezor_client/models/issuer_initiated_digitization_data.rb +3 -2
- data/lib/treezor_client/models/issuer_initiated_digitization_datas_additionnal_data.rb +3 -2
- data/lib/treezor_client/models/mandate.rb +3 -2
- data/lib/treezor_client/models/mcc_restriction_group.rb +3 -2
- data/lib/treezor_client/models/merchant_id_restriction_group.rb +3 -2
- data/lib/treezor_client/models/payin.rb +4 -3
- data/lib/treezor_client/models/payinrefund.rb +4 -3
- data/lib/treezor_client/models/payout.rb +3 -2
- data/lib/treezor_client/models/payout_refund.rb +3 -2
- data/lib/treezor_client/models/tax_residence.rb +3 -2
- data/lib/treezor_client/models/transaction.rb +3 -2
- data/lib/treezor_client/models/transfer.rb +3 -2
- data/lib/treezor_client/models/transferrefund.rb +3 -2
- data/lib/treezor_client/models/user.rb +3 -2
- data/lib/treezor_client/models/virtualiban.rb +3 -2
- data/lib/treezor_client/models/wallet.rb +3 -2
- data/lib/treezor_client/version.rb +2 -2
- data/lib/treezor_client.rb +1 -1
- data/pkg/{treezor_client-1.4.0.gem → treezor_client-1.12.0.gem} +0 -0
- data/pkg/treezor_client-2.0.0.gem +0 -0
- data/treezor_api_spec.yaml +5 -5
- data/treezor_client.gemspec +2 -1
- metadata +28 -156
- data/doc/TreezorClient/ApiClient.html +0 -2600
- data/doc/TreezorClient/ApiError.html +0 -464
- data/doc/TreezorClient/Balance.html +0 -2042
- data/doc/TreezorClient/BalanceApi.html +0 -760
- data/doc/TreezorClient/Bankaccount/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/Bankaccount.html +0 -2560
- data/doc/TreezorClient/BankaccountApi.html +0 -2450
- data/doc/TreezorClient/BeneficiariesApi.html +0 -2387
- data/doc/TreezorClient/BeneficiariesSddB2bWhitelist.html +0 -1816
- data/doc/TreezorClient/Beneficiary.html +0 -2574
- data/doc/TreezorClient/Body/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/Body.html +0 -1826
- data/doc/TreezorClient/Body1.html +0 -2596
- data/doc/TreezorClient/Body10/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/Body10.html +0 -2069
- data/doc/TreezorClient/Body2.html +0 -2492
- data/doc/TreezorClient/Body3.html +0 -1726
- data/doc/TreezorClient/Body4.html +0 -1726
- data/doc/TreezorClient/Body5/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/Body5.html +0 -2001
- data/doc/TreezorClient/Body6/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/Body6.html +0 -2069
- data/doc/TreezorClient/Body7/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/Body7.html +0 -2002
- data/doc/TreezorClient/Body8/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/Body8.html +0 -1981
- data/doc/TreezorClient/Body9/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/Body9.html +0 -2001
- data/doc/TreezorClient/BusinessApi.html +0 -1548
- data/doc/TreezorClient/BusinesssearchsBusinessinformations/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/BusinesssearchsBusinessinformations.html +0 -2822
- data/doc/TreezorClient/Card/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/Card.html +0 -6928
- data/doc/TreezorClient/CardApi.html +0 -9907
- data/doc/TreezorClient/CardDigitalization.html +0 -2126
- data/doc/TreezorClient/CardDigitalizationDetailsFromGPS.html +0 -4343
- data/doc/TreezorClient/CardDigitalizationsApi.html +0 -1542
- data/doc/TreezorClient/CardReserveApi.html +0 -1622
- data/doc/TreezorClient/CardtransactionApi.html +0 -1243
- data/doc/TreezorClient/Configuration.html +0 -2459
- data/doc/TreezorClient/CountryRestrictionGroupsApi.html +0 -2602
- data/doc/TreezorClient/Document/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/Document.html +0 -2812
- data/doc/TreezorClient/DocumentApi.html +0 -2878
- data/doc/TreezorClient/Error.html +0 -1794
- data/doc/TreezorClient/HeartbeatApi.html +0 -702
- data/doc/TreezorClient/InlineResponse200.html +0 -1626
- data/doc/TreezorClient/InlineResponse2001.html +0 -1626
- data/doc/TreezorClient/InlineResponse20010.html +0 -1626
- data/doc/TreezorClient/InlineResponse20010Cardtransactions.html +0 -5844
- data/doc/TreezorClient/InlineResponse20011.html +0 -1626
- data/doc/TreezorClient/InlineResponse20012.html +0 -1626
- data/doc/TreezorClient/InlineResponse20013.html +0 -1626
- data/doc/TreezorClient/InlineResponse20014.html +0 -1626
- data/doc/TreezorClient/InlineResponse20015.html +0 -1626
- data/doc/TreezorClient/InlineResponse20016.html +0 -1626
- data/doc/TreezorClient/InlineResponse20017.html +0 -1626
- data/doc/TreezorClient/InlineResponse20018.html +0 -1626
- data/doc/TreezorClient/InlineResponse20019.html +0 -1626
- data/doc/TreezorClient/InlineResponse2002.html +0 -1626
- data/doc/TreezorClient/InlineResponse20020.html +0 -1626
- data/doc/TreezorClient/InlineResponse20021.html +0 -1626
- data/doc/TreezorClient/InlineResponse20022.html +0 -1626
- data/doc/TreezorClient/InlineResponse20023.html +0 -1626
- data/doc/TreezorClient/InlineResponse20024.html +0 -1626
- data/doc/TreezorClient/InlineResponse20025.html +0 -1626
- data/doc/TreezorClient/InlineResponse2003.html +0 -1626
- data/doc/TreezorClient/InlineResponse2004.html +0 -1626
- data/doc/TreezorClient/InlineResponse2005.html +0 -1626
- data/doc/TreezorClient/InlineResponse2005Businessinformations/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/InlineResponse2005Businessinformations.html +0 -3561
- data/doc/TreezorClient/InlineResponse2005Users/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/InlineResponse2005Users.html +0 -1972
- data/doc/TreezorClient/InlineResponse2006.html +0 -1626
- data/doc/TreezorClient/InlineResponse2007.html +0 -1626
- data/doc/TreezorClient/InlineResponse2007Cardimages.html +0 -1800
- data/doc/TreezorClient/InlineResponse2008.html +0 -1626
- data/doc/TreezorClient/InlineResponse2009.html +0 -1790
- data/doc/TreezorClient/InlineResponseDefault.html +0 -1626
- data/doc/TreezorClient/IssuerInitiatedDigitizationDataApi.html +0 -1371
- data/doc/TreezorClient/IssuerInitiatedDigitizationDatasAdditionnalData.html +0 -1803
- data/doc/TreezorClient/IssuerInitiatedDigitizationDatasAdditionnalDataECCPublicCertificates.html +0 -1804
- data/doc/TreezorClient/Mandate/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/Mandate.html +0 -4584
- data/doc/TreezorClient/MandateApi.html +0 -3787
- data/doc/TreezorClient/MccRestrictionGroup/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/MccRestrictionGroup.html +0 -2144
- data/doc/TreezorClient/MccRestrictionGroupsApi.html +0 -2598
- data/doc/TreezorClient/MerchantIdRestrictionGroup/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/MerchantIdRestrictionGroup.html +0 -2144
- data/doc/TreezorClient/MerchantIdRestrictionGroupsApi.html +0 -2638
- data/doc/TreezorClient/Payin/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/Payin.html +0 -5584
- data/doc/TreezorClient/PayinApi.html +0 -2963
- data/doc/TreezorClient/Payinrefund/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/Payinrefund.html +0 -2476
- data/doc/TreezorClient/PayinrefundApi.html +0 -2449
- data/doc/TreezorClient/Payout/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/Payout.html +0 -3488
- data/doc/TreezorClient/PayoutApi.html +0 -2737
- data/doc/TreezorClient/Tav.html +0 -2130
- data/doc/TreezorClient/Transaction.html +0 -2798
- data/doc/TreezorClient/TransactionApi.html +0 -1491
- data/doc/TreezorClient/Transfer/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/Transfer.html +0 -3158
- data/doc/TreezorClient/TransferApi.html +0 -2725
- data/doc/TreezorClient/Transferrefund/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/Transferrefund.html +0 -2644
- data/doc/TreezorClient/TransferrefundApi.html +0 -2450
- data/doc/TreezorClient/User/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/User.html +0 -5844
- data/doc/TreezorClient/UserApi.html +0 -6647
- data/doc/TreezorClient/Virtualiban.html +0 -2462
- data/doc/TreezorClient/VirtualibansApi.html +0 -2845
- data/doc/TreezorClient/Wallet/EnumAttributeValidator.html +0 -455
- data/doc/TreezorClient/Wallet.html +0 -4076
- data/doc/TreezorClient/WalletApi.html +0 -3944
- data/doc/TreezorClient.html +0 -251
- data/doc/_index.html +0 -1025
- data/doc/class_list.html +0 -51
- data/doc/css/common.css +0 -1
- data/doc/css/full_list.css +0 -58
- data/doc/css/style.css +0 -496
- data/doc/file.README.html +0 -636
- data/doc/file_list.html +0 -56
- data/doc/frames.html +0 -17
- data/doc/index.html +0 -636
- data/doc/js/app.js +0 -292
- data/doc/js/full_list.js +0 -216
- data/doc/js/jquery.js +0 -4
- data/doc/method_list.html +0 -15699
- data/doc/top-level-namespace.html +0 -110
- data/docs/CardDigitalizationDetailsFromGPS.md +0 -40
- data/docs/InlineResponse20011Cardtransactions.md +0 -58
- data/docs/InlineResponse2005Businessinformations.md +0 -26
- data/docs/InlineResponse2005Users.md +0 -12
- data/docs/InlineResponse2007Cardimages.md +0 -10
- data/docs/IssuerInitiatedDigitizationDatasAdditionnalDataECCPublicCertificates.md +0 -10
- data/docs/Tav.md +0 -14
- data/lib/treezor_client/models/card_digitalization_details_from_gps.rb +0 -509
- data/lib/treezor_client/models/inline_response_200_11_cardtransactions.rb +0 -637
- data/lib/treezor_client/models/inline_response_200_5_businessinformations.rb +0 -447
- data/lib/treezor_client/models/inline_response_200_5_users.rb +0 -258
- data/lib/treezor_client/models/inline_response_200_7_cardimages.rb +0 -219
- data/lib/treezor_client/models/issuer_initiated_digitization_datas_additionnal_data_ecc_public_certificates.rb +0 -209
- data/lib/treezor_client/models/tav.rb +0 -241
- data/pkg/treezor_client-1.0.0.gem +0 -0
- data/pkg/treezor_client-1.1.0.gem +0 -0
- data/pkg/treezor_client-1.2.0.gem +0 -0
- data/pkg/treezor_client-1.3.0.gem +0 -0
|
@@ -1,2600 +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::ApiClient
|
|
8
|
-
|
|
9
|
-
— 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::ApiClient";
|
|
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 (A)</a> »
|
|
40
|
-
<span class='title'><span class='object_link'><a href="../TreezorClient.html" title="TreezorClient (module)">TreezorClient</a></span></span>
|
|
41
|
-
»
|
|
42
|
-
<span class="title">ApiClient</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::ApiClient
|
|
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::ApiClient</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_client.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="#config-instance_method" title="#config (instance method)">#<strong>config</strong> ⇒ 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>The Configuration object holding settings to be used in the API client.</p>
|
|
131
|
-
</div></span>
|
|
132
|
-
|
|
133
|
-
</li>
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
<li class="public ">
|
|
137
|
-
<span class="summary_signature">
|
|
138
|
-
|
|
139
|
-
<a href="#default_headers-instance_method" title="#default_headers (instance method)">#<strong>default_headers</strong> ⇒ 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 the headers to be used in HTTP requests of all API calls by
|
|
158
|
-
default.</p>
|
|
159
|
-
</div></span>
|
|
160
|
-
|
|
161
|
-
</li>
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
</ul>
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
<h2>
|
|
171
|
-
Class Method Summary
|
|
172
|
-
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
173
|
-
</h2>
|
|
174
|
-
|
|
175
|
-
<ul class="summary">
|
|
176
|
-
|
|
177
|
-
<li class="public ">
|
|
178
|
-
<span class="summary_signature">
|
|
179
|
-
|
|
180
|
-
<a href="#default-class_method" title="default (class method)">.<strong>default</strong> ⇒ Object </a>
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
</span>
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
|
195
|
-
|
|
196
|
-
</li>
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
</ul>
|
|
200
|
-
|
|
201
|
-
<h2>
|
|
202
|
-
Instance Method Summary
|
|
203
|
-
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
204
|
-
</h2>
|
|
205
|
-
|
|
206
|
-
<ul class="summary">
|
|
207
|
-
|
|
208
|
-
<li class="public ">
|
|
209
|
-
<span class="summary_signature">
|
|
210
|
-
|
|
211
|
-
<a href="#build_collection_param-instance_method" title="#build_collection_param (instance method)">#<strong>build_collection_param</strong>(param, collection_format) ⇒ Object </a>
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
</span>
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
<span class="summary_desc"><div class='inline'>
|
|
226
|
-
<p>Build parameter value according to the given collection format.</p>
|
|
227
|
-
</div></span>
|
|
228
|
-
|
|
229
|
-
</li>
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
<li class="public ">
|
|
233
|
-
<span class="summary_signature">
|
|
234
|
-
|
|
235
|
-
<a href="#build_request-instance_method" title="#build_request (instance method)">#<strong>build_request</strong>(http_method, path, opts = {}) ⇒ Typhoeus::Request </a>
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
</span>
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
<span class="summary_desc"><div class='inline'>
|
|
250
|
-
<p>Builds the HTTP request.</p>
|
|
251
|
-
</div></span>
|
|
252
|
-
|
|
253
|
-
</li>
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
<li class="public ">
|
|
257
|
-
<span class="summary_signature">
|
|
258
|
-
|
|
259
|
-
<a href="#build_request_body-instance_method" title="#build_request_body (instance method)">#<strong>build_request_body</strong>(header_params, form_params, body) ⇒ String </a>
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
</span>
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
<span class="summary_desc"><div class='inline'>
|
|
274
|
-
<p>Builds the HTTP request body.</p>
|
|
275
|
-
</div></span>
|
|
276
|
-
|
|
277
|
-
</li>
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
<li class="public ">
|
|
281
|
-
<span class="summary_signature">
|
|
282
|
-
|
|
283
|
-
<a href="#build_request_url-instance_method" title="#build_request_url (instance method)">#<strong>build_request_url</strong>(path) ⇒ Object </a>
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
</span>
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
|
298
|
-
|
|
299
|
-
</li>
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
<li class="public ">
|
|
303
|
-
<span class="summary_signature">
|
|
304
|
-
|
|
305
|
-
<a href="#call_api-instance_method" title="#call_api (instance method)">#<strong>call_api</strong>(http_method, path, opts = {}) ⇒ Array<(Object, Fixnum, Hash)> </a>
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
</span>
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
<span class="summary_desc"><div class='inline'>
|
|
320
|
-
<p>Call an API with given options.</p>
|
|
321
|
-
</div></span>
|
|
322
|
-
|
|
323
|
-
</li>
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
<li class="public ">
|
|
327
|
-
<span class="summary_signature">
|
|
328
|
-
|
|
329
|
-
<a href="#convert_to_type-instance_method" title="#convert_to_type (instance method)">#<strong>convert_to_type</strong>(data, return_type) ⇒ Mixed </a>
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
</span>
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
<span class="summary_desc"><div class='inline'>
|
|
344
|
-
<p>Convert data to the given return type.</p>
|
|
345
|
-
</div></span>
|
|
346
|
-
|
|
347
|
-
</li>
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
<li class="public ">
|
|
351
|
-
<span class="summary_signature">
|
|
352
|
-
|
|
353
|
-
<a href="#deserialize-instance_method" title="#deserialize (instance method)">#<strong>deserialize</strong>(response, return_type) ⇒ Object </a>
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
</span>
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
<span class="summary_desc"><div class='inline'>
|
|
368
|
-
<p>Deserialize the response to the given return type.</p>
|
|
369
|
-
</div></span>
|
|
370
|
-
|
|
371
|
-
</li>
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
<li class="public ">
|
|
375
|
-
<span class="summary_signature">
|
|
376
|
-
|
|
377
|
-
<a href="#download_file-instance_method" title="#download_file (instance method)">#<strong>download_file</strong>(request) ⇒ Object </a>
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
</span>
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
<span class="summary_desc"><div class='inline'>
|
|
392
|
-
<p>Save response body into a file in (the defined) temporary folder, using the
|
|
393
|
-
filename from the “Content-Disposition” header if provided, otherwise a
|
|
394
|
-
random filename.</p>
|
|
395
|
-
</div></span>
|
|
396
|
-
|
|
397
|
-
</li>
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
<li class="public ">
|
|
401
|
-
<span class="summary_signature">
|
|
402
|
-
|
|
403
|
-
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(config = Configuration.default) ⇒ ApiClient </a>
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
</span>
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
<span class="note title constructor">constructor</span>
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
<span class="summary_desc"><div class='inline'>
|
|
420
|
-
<p>Initializes the ApiClient.</p>
|
|
421
|
-
</div></span>
|
|
422
|
-
|
|
423
|
-
</li>
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
<li class="public ">
|
|
427
|
-
<span class="summary_signature">
|
|
428
|
-
|
|
429
|
-
<a href="#json_mime%3F-instance_method" title="#json_mime? (instance method)">#<strong>json_mime?</strong>(mime) ⇒ Boolean </a>
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
</span>
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
<span class="summary_desc"><div class='inline'>
|
|
444
|
-
<p>Check if the given MIME is a JSON MIME.</p>
|
|
445
|
-
</div></span>
|
|
446
|
-
|
|
447
|
-
</li>
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
<li class="public ">
|
|
451
|
-
<span class="summary_signature">
|
|
452
|
-
|
|
453
|
-
<a href="#object_to_hash-instance_method" title="#object_to_hash (instance method)">#<strong>object_to_hash</strong>(obj) ⇒ String </a>
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
</span>
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
<span class="summary_desc"><div class='inline'>
|
|
468
|
-
<p>Convert object(non-array) to hash.</p>
|
|
469
|
-
</div></span>
|
|
470
|
-
|
|
471
|
-
</li>
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
<li class="public ">
|
|
475
|
-
<span class="summary_signature">
|
|
476
|
-
|
|
477
|
-
<a href="#object_to_http_body-instance_method" title="#object_to_http_body (instance method)">#<strong>object_to_http_body</strong>(model) ⇒ String </a>
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
</span>
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
<span class="summary_desc"><div class='inline'>
|
|
492
|
-
<p>Convert object (array, hash, object, etc) to JSON string.</p>
|
|
493
|
-
</div></span>
|
|
494
|
-
|
|
495
|
-
</li>
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
<li class="public ">
|
|
499
|
-
<span class="summary_signature">
|
|
500
|
-
|
|
501
|
-
<a href="#sanitize_filename-instance_method" title="#sanitize_filename (instance method)">#<strong>sanitize_filename</strong>(filename) ⇒ String </a>
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
</span>
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
<span class="summary_desc"><div class='inline'>
|
|
516
|
-
<p>Sanitize filename by removing path.</p>
|
|
517
|
-
</div></span>
|
|
518
|
-
|
|
519
|
-
</li>
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
<li class="public ">
|
|
523
|
-
<span class="summary_signature">
|
|
524
|
-
|
|
525
|
-
<a href="#select_header_accept-instance_method" title="#select_header_accept (instance method)">#<strong>select_header_accept</strong>(accepts) ⇒ String </a>
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
</span>
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
<span class="summary_desc"><div class='inline'>
|
|
540
|
-
<p>Return Accept header based on an array of accepts provided.</p>
|
|
541
|
-
</div></span>
|
|
542
|
-
|
|
543
|
-
</li>
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
<li class="public ">
|
|
547
|
-
<span class="summary_signature">
|
|
548
|
-
|
|
549
|
-
<a href="#select_header_content_type-instance_method" title="#select_header_content_type (instance method)">#<strong>select_header_content_type</strong>(content_types) ⇒ String </a>
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
</span>
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
<span class="summary_desc"><div class='inline'>
|
|
564
|
-
<p>Return Content-Type header based on an array of content types provided.</p>
|
|
565
|
-
</div></span>
|
|
566
|
-
|
|
567
|
-
</li>
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
<li class="public ">
|
|
571
|
-
<span class="summary_signature">
|
|
572
|
-
|
|
573
|
-
<a href="#update_params_for_auth!-instance_method" title="#update_params_for_auth! (instance method)">#<strong>update_params_for_auth!</strong>(header_params, query_params, auth_names) ⇒ Object </a>
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
</span>
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
<span class="summary_desc"><div class='inline'>
|
|
588
|
-
<p>Update hearder and query params based on authentication settings.</p>
|
|
589
|
-
</div></span>
|
|
590
|
-
|
|
591
|
-
</li>
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
<li class="public ">
|
|
595
|
-
<span class="summary_signature">
|
|
596
|
-
|
|
597
|
-
<a href="#user_agent=-instance_method" title="#user_agent= (instance method)">#<strong>user_agent=</strong>(user_agent) ⇒ Object </a>
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
</span>
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
<span class="summary_desc"><div class='inline'>
|
|
612
|
-
<p>Sets user agent in HTTP header.</p>
|
|
613
|
-
</div></span>
|
|
614
|
-
|
|
615
|
-
</li>
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
</ul>
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
<div id="constructor_details" class="method_details_list">
|
|
622
|
-
<h2>Constructor Details</h2>
|
|
623
|
-
|
|
624
|
-
<div class="method_details first">
|
|
625
|
-
<h3 class="signature first" id="initialize-instance_method">
|
|
626
|
-
|
|
627
|
-
#<strong>initialize</strong>(config = Configuration.default) ⇒ <tt><span class='object_link'><a href="" title="TreezorClient::ApiClient (class)">ApiClient</a></span></tt>
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
</h3><div class="docstring">
|
|
634
|
-
<div class="discussion">
|
|
635
|
-
|
|
636
|
-
<p>Initializes the ApiClient</p>
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
</div>
|
|
640
|
-
</div>
|
|
641
|
-
<div class="tags">
|
|
642
|
-
<p class="tag_title">Parameters:</p>
|
|
643
|
-
<ul class="param">
|
|
644
|
-
|
|
645
|
-
<li>
|
|
646
|
-
|
|
647
|
-
<span class='name'>config</span>
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
<em class="default">(defaults to: <tt>Configuration.default</tt>)</em>
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
—
|
|
657
|
-
<div class='inline'>
|
|
658
|
-
<p>a customizable set of options</p>
|
|
659
|
-
</div>
|
|
660
|
-
|
|
661
|
-
</li>
|
|
662
|
-
|
|
663
|
-
</ul>
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
<p class="tag_title">Options Hash (<tt>config</tt>):</p>
|
|
669
|
-
<ul class="option">
|
|
670
|
-
|
|
671
|
-
<li>
|
|
672
|
-
<span class="name">Configuration</span>
|
|
673
|
-
<span class="type">(<tt><span class='object_link'><a href="Configuration.html" title="TreezorClient::Configuration (class)">Configuration</a></span></tt>)</span>
|
|
674
|
-
<span class="default">
|
|
675
|
-
|
|
676
|
-
</span>
|
|
677
|
-
|
|
678
|
-
— <div class='inline'>
|
|
679
|
-
<p>for initializing the object, default to Configuration.default</p>
|
|
680
|
-
</div>
|
|
681
|
-
|
|
682
|
-
</li>
|
|
683
|
-
|
|
684
|
-
</ul>
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
</div><table class="source_code">
|
|
689
|
-
<tr>
|
|
690
|
-
<td>
|
|
691
|
-
<pre class="lines">
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
32
|
|
695
|
-
33
|
|
696
|
-
34
|
|
697
|
-
35
|
|
698
|
-
36
|
|
699
|
-
37
|
|
700
|
-
38
|
|
701
|
-
39</pre>
|
|
702
|
-
</td>
|
|
703
|
-
<td>
|
|
704
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 32</span>
|
|
705
|
-
|
|
706
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_config'>config</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Configuration.html" title="TreezorClient::Configuration (class)">Configuration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_default'><span class='object_link'><a href="Configuration.html#default-class_method" title="TreezorClient::Configuration.default (method)">default</a></span></span><span class='rparen'>)</span>
|
|
707
|
-
<span class='ivar'>@config</span> <span class='op'>=</span> <span class='id identifier rubyid_config'>config</span>
|
|
708
|
-
<span class='ivar'>@user_agent</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Swagger-Codegen/</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="../TreezorClient.html#VERSION-constant" title="TreezorClient::VERSION (constant)">VERSION</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/ruby</span><span class='tstring_end'>"</span></span>
|
|
709
|
-
<span class='ivar'>@default_headers</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
710
|
-
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>application/json</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
711
|
-
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>User-Agent</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='ivar'>@user_agent</span>
|
|
712
|
-
<span class='rbrace'>}</span>
|
|
713
|
-
<span class='kw'>end</span></pre>
|
|
714
|
-
</td>
|
|
715
|
-
</tr>
|
|
716
|
-
</table>
|
|
717
|
-
</div>
|
|
718
|
-
|
|
719
|
-
</div>
|
|
720
|
-
|
|
721
|
-
<div id="instance_attr_details" class="attr_details">
|
|
722
|
-
<h2>Instance Attribute Details</h2>
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
<span id="config=-instance_method"></span>
|
|
726
|
-
<div class="method_details first">
|
|
727
|
-
<h3 class="signature first" id="config-instance_method">
|
|
728
|
-
|
|
729
|
-
#<strong>config</strong> ⇒ <tt>Object</tt>
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
</h3><div class="docstring">
|
|
736
|
-
<div class="discussion">
|
|
737
|
-
|
|
738
|
-
<p>The Configuration object holding settings to be used in the API client.</p>
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
</div>
|
|
742
|
-
</div>
|
|
743
|
-
<div class="tags">
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
</div><table class="source_code">
|
|
747
|
-
<tr>
|
|
748
|
-
<td>
|
|
749
|
-
<pre class="lines">
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
23
|
|
753
|
-
24
|
|
754
|
-
25</pre>
|
|
755
|
-
</td>
|
|
756
|
-
<td>
|
|
757
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 23</span>
|
|
758
|
-
|
|
759
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_config'>config</span>
|
|
760
|
-
<span class='ivar'>@config</span>
|
|
761
|
-
<span class='kw'>end</span></pre>
|
|
762
|
-
</td>
|
|
763
|
-
</tr>
|
|
764
|
-
</table>
|
|
765
|
-
</div>
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
<span id="default_headers=-instance_method"></span>
|
|
769
|
-
<div class="method_details ">
|
|
770
|
-
<h3 class="signature " id="default_headers-instance_method">
|
|
771
|
-
|
|
772
|
-
#<strong>default_headers</strong> ⇒ <tt>Hash</tt>
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
</h3><div class="docstring">
|
|
779
|
-
<div class="discussion">
|
|
780
|
-
|
|
781
|
-
<p>Defines the headers to be used in HTTP requests of all API calls by
|
|
782
|
-
default.</p>
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
</div>
|
|
786
|
-
</div>
|
|
787
|
-
<div class="tags">
|
|
788
|
-
|
|
789
|
-
<p class="tag_title">Returns:</p>
|
|
790
|
-
<ul class="return">
|
|
791
|
-
|
|
792
|
-
<li>
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
</li>
|
|
800
|
-
|
|
801
|
-
</ul>
|
|
802
|
-
|
|
803
|
-
</div><table class="source_code">
|
|
804
|
-
<tr>
|
|
805
|
-
<td>
|
|
806
|
-
<pre class="lines">
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
28
|
|
810
|
-
29
|
|
811
|
-
30</pre>
|
|
812
|
-
</td>
|
|
813
|
-
<td>
|
|
814
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 28</span>
|
|
815
|
-
|
|
816
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_default_headers'>default_headers</span>
|
|
817
|
-
<span class='ivar'>@default_headers</span>
|
|
818
|
-
<span class='kw'>end</span></pre>
|
|
819
|
-
</td>
|
|
820
|
-
</tr>
|
|
821
|
-
</table>
|
|
822
|
-
</div>
|
|
823
|
-
|
|
824
|
-
</div>
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
<div id="class_method_details" class="method_details_list">
|
|
828
|
-
<h2>Class Method Details</h2>
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
<div class="method_details first">
|
|
832
|
-
<h3 class="signature first" id="default-class_method">
|
|
833
|
-
|
|
834
|
-
.<strong>default</strong> ⇒ <tt>Object</tt>
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
</h3><table class="source_code">
|
|
841
|
-
<tr>
|
|
842
|
-
<td>
|
|
843
|
-
<pre class="lines">
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
41
|
|
847
|
-
42
|
|
848
|
-
43</pre>
|
|
849
|
-
</td>
|
|
850
|
-
<td>
|
|
851
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 41</span>
|
|
852
|
-
|
|
853
|
-
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_default'>default</span>
|
|
854
|
-
<span class='cvar'>@@default</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="" title="TreezorClient::ApiClient (class)">ApiClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="TreezorClient::ApiClient#initialize (method)">new</a></span></span>
|
|
855
|
-
<span class='kw'>end</span></pre>
|
|
856
|
-
</td>
|
|
857
|
-
</tr>
|
|
858
|
-
</table>
|
|
859
|
-
</div>
|
|
860
|
-
|
|
861
|
-
</div>
|
|
862
|
-
|
|
863
|
-
<div id="instance_method_details" class="method_details_list">
|
|
864
|
-
<h2>Instance Method Details</h2>
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
<div class="method_details first">
|
|
868
|
-
<h3 class="signature first" id="build_collection_param-instance_method">
|
|
869
|
-
|
|
870
|
-
#<strong>build_collection_param</strong>(param, collection_format) ⇒ <tt>Object</tt>
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
</h3><div class="docstring">
|
|
877
|
-
<div class="discussion">
|
|
878
|
-
|
|
879
|
-
<p>Build parameter value according to the given collection format.</p>
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
</div>
|
|
883
|
-
</div>
|
|
884
|
-
<div class="tags">
|
|
885
|
-
<p class="tag_title">Parameters:</p>
|
|
886
|
-
<ul class="param">
|
|
887
|
-
|
|
888
|
-
<li>
|
|
889
|
-
|
|
890
|
-
<span class='name'>collection_format</span>
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
—
|
|
898
|
-
<div class='inline'>
|
|
899
|
-
<p>one of :csv, :ssv, :tsv, :pipes and :multi</p>
|
|
900
|
-
</div>
|
|
901
|
-
|
|
902
|
-
</li>
|
|
903
|
-
|
|
904
|
-
</ul>
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
</div><table class="source_code">
|
|
908
|
-
<tr>
|
|
909
|
-
<td>
|
|
910
|
-
<pre class="lines">
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
371
|
|
914
|
-
372
|
|
915
|
-
373
|
|
916
|
-
374
|
|
917
|
-
375
|
|
918
|
-
376
|
|
919
|
-
377
|
|
920
|
-
378
|
|
921
|
-
379
|
|
922
|
-
380
|
|
923
|
-
381
|
|
924
|
-
382
|
|
925
|
-
383
|
|
926
|
-
384
|
|
927
|
-
385
|
|
928
|
-
386
|
|
929
|
-
387</pre>
|
|
930
|
-
</td>
|
|
931
|
-
<td>
|
|
932
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 371</span>
|
|
933
|
-
|
|
934
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_build_collection_param'>build_collection_param</span><span class='lparen'>(</span><span class='id identifier rubyid_param'>param</span><span class='comma'>,</span> <span class='id identifier rubyid_collection_format'>collection_format</span><span class='rparen'>)</span>
|
|
935
|
-
<span class='kw'>case</span> <span class='id identifier rubyid_collection_format'>collection_format</span>
|
|
936
|
-
<span class='kw'>when</span> <span class='symbol'>:csv</span>
|
|
937
|
-
<span class='id identifier rubyid_param'>param</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>,</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
938
|
-
<span class='kw'>when</span> <span class='symbol'>:ssv</span>
|
|
939
|
-
<span class='id identifier rubyid_param'>param</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> </span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
940
|
-
<span class='kw'>when</span> <span class='symbol'>:tsv</span>
|
|
941
|
-
<span class='id identifier rubyid_param'>param</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\t</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
942
|
-
<span class='kw'>when</span> <span class='symbol'>:pipes</span>
|
|
943
|
-
<span class='id identifier rubyid_param'>param</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>|</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
944
|
-
<span class='kw'>when</span> <span class='symbol'>:multi</span>
|
|
945
|
-
<span class='comment'># return the array directly as typhoeus will handle it as expected
|
|
946
|
-
</span> <span class='id identifier rubyid_param'>param</span>
|
|
947
|
-
<span class='kw'>else</span>
|
|
948
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>unknown collection format: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_collection_format'>collection_format</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
949
|
-
<span class='kw'>end</span>
|
|
950
|
-
<span class='kw'>end</span></pre>
|
|
951
|
-
</td>
|
|
952
|
-
</tr>
|
|
953
|
-
</table>
|
|
954
|
-
</div>
|
|
955
|
-
|
|
956
|
-
<div class="method_details ">
|
|
957
|
-
<h3 class="signature " id="build_request-instance_method">
|
|
958
|
-
|
|
959
|
-
#<strong>build_request</strong>(http_method, path, opts = {}) ⇒ <tt>Typhoeus::Request</tt>
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
</h3><div class="docstring">
|
|
966
|
-
<div class="discussion">
|
|
967
|
-
|
|
968
|
-
<p>Builds the HTTP request</p>
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
</div>
|
|
972
|
-
</div>
|
|
973
|
-
<div class="tags">
|
|
974
|
-
<p class="tag_title">Parameters:</p>
|
|
975
|
-
<ul class="param">
|
|
976
|
-
|
|
977
|
-
<li>
|
|
978
|
-
|
|
979
|
-
<span class='name'>http_method</span>
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
—
|
|
987
|
-
<div class='inline'>
|
|
988
|
-
<p>HTTP method/verb (e.g. POST)</p>
|
|
989
|
-
</div>
|
|
990
|
-
|
|
991
|
-
</li>
|
|
992
|
-
|
|
993
|
-
<li>
|
|
994
|
-
|
|
995
|
-
<span class='name'>path</span>
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
—
|
|
1003
|
-
<div class='inline'>
|
|
1004
|
-
<p>URL path (e.g. /account/new)</p>
|
|
1005
|
-
</div>
|
|
1006
|
-
|
|
1007
|
-
</li>
|
|
1008
|
-
|
|
1009
|
-
<li>
|
|
1010
|
-
|
|
1011
|
-
<span class='name'>opts</span>
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
—
|
|
1021
|
-
<div class='inline'>
|
|
1022
|
-
<p>a customizable set of options</p>
|
|
1023
|
-
</div>
|
|
1024
|
-
|
|
1025
|
-
</li>
|
|
1026
|
-
|
|
1027
|
-
</ul>
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
<p class="tag_title">Options Hash (<tt>opts</tt>):</p>
|
|
1037
|
-
<ul class="option">
|
|
1038
|
-
|
|
1039
|
-
<li>
|
|
1040
|
-
<span class="name">:header_params</span>
|
|
1041
|
-
<span class="type">(<tt>Hash</tt>)</span>
|
|
1042
|
-
<span class="default">
|
|
1043
|
-
|
|
1044
|
-
</span>
|
|
1045
|
-
|
|
1046
|
-
— <div class='inline'>
|
|
1047
|
-
<p>Header parameters</p>
|
|
1048
|
-
</div>
|
|
1049
|
-
|
|
1050
|
-
</li>
|
|
1051
|
-
|
|
1052
|
-
<li>
|
|
1053
|
-
<span class="name">:query_params</span>
|
|
1054
|
-
<span class="type">(<tt>Hash</tt>)</span>
|
|
1055
|
-
<span class="default">
|
|
1056
|
-
|
|
1057
|
-
</span>
|
|
1058
|
-
|
|
1059
|
-
— <div class='inline'>
|
|
1060
|
-
<p>Query parameters</p>
|
|
1061
|
-
</div>
|
|
1062
|
-
|
|
1063
|
-
</li>
|
|
1064
|
-
|
|
1065
|
-
<li>
|
|
1066
|
-
<span class="name">:form_params</span>
|
|
1067
|
-
<span class="type">(<tt>Hash</tt>)</span>
|
|
1068
|
-
<span class="default">
|
|
1069
|
-
|
|
1070
|
-
</span>
|
|
1071
|
-
|
|
1072
|
-
— <div class='inline'>
|
|
1073
|
-
<p>Query parameters</p>
|
|
1074
|
-
</div>
|
|
1075
|
-
|
|
1076
|
-
</li>
|
|
1077
|
-
|
|
1078
|
-
<li>
|
|
1079
|
-
<span class="name">:body</span>
|
|
1080
|
-
<span class="type">(<tt>Object</tt>)</span>
|
|
1081
|
-
<span class="default">
|
|
1082
|
-
|
|
1083
|
-
</span>
|
|
1084
|
-
|
|
1085
|
-
— <div class='inline'>
|
|
1086
|
-
<p>HTTP body (JSON/XML)</p>
|
|
1087
|
-
</div>
|
|
1088
|
-
|
|
1089
|
-
</li>
|
|
1090
|
-
|
|
1091
|
-
</ul>
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
<p class="tag_title">Returns:</p>
|
|
1095
|
-
<ul class="return">
|
|
1096
|
-
|
|
1097
|
-
<li>
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
<span class='type'>(<tt>Typhoeus::Request</tt>)</span>
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
—
|
|
1105
|
-
<div class='inline'>
|
|
1106
|
-
<p>A Typhoeus Request</p>
|
|
1107
|
-
</div>
|
|
1108
|
-
|
|
1109
|
-
</li>
|
|
1110
|
-
|
|
1111
|
-
</ul>
|
|
1112
|
-
|
|
1113
|
-
</div><table class="source_code">
|
|
1114
|
-
<tr>
|
|
1115
|
-
<td>
|
|
1116
|
-
<pre class="lines">
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
89
|
|
1120
|
-
90
|
|
1121
|
-
91
|
|
1122
|
-
92
|
|
1123
|
-
93
|
|
1124
|
-
94
|
|
1125
|
-
95
|
|
1126
|
-
96
|
|
1127
|
-
97
|
|
1128
|
-
98
|
|
1129
|
-
99
|
|
1130
|
-
100
|
|
1131
|
-
101
|
|
1132
|
-
102
|
|
1133
|
-
103
|
|
1134
|
-
104
|
|
1135
|
-
105
|
|
1136
|
-
106
|
|
1137
|
-
107
|
|
1138
|
-
108
|
|
1139
|
-
109
|
|
1140
|
-
110
|
|
1141
|
-
111
|
|
1142
|
-
112
|
|
1143
|
-
113
|
|
1144
|
-
114
|
|
1145
|
-
115
|
|
1146
|
-
116
|
|
1147
|
-
117
|
|
1148
|
-
118
|
|
1149
|
-
119
|
|
1150
|
-
120
|
|
1151
|
-
121
|
|
1152
|
-
122
|
|
1153
|
-
123
|
|
1154
|
-
124
|
|
1155
|
-
125
|
|
1156
|
-
126
|
|
1157
|
-
127
|
|
1158
|
-
128
|
|
1159
|
-
129</pre>
|
|
1160
|
-
</td>
|
|
1161
|
-
<td>
|
|
1162
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 89</span>
|
|
1163
|
-
|
|
1164
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_build_request'>build_request</span><span class='lparen'>(</span><span class='id identifier rubyid_http_method'>http_method</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</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>
|
|
1165
|
-
<span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='id identifier rubyid_build_request_url'>build_request_url</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
|
1166
|
-
<span class='id identifier rubyid_http_method'>http_method</span> <span class='op'>=</span> <span class='id identifier rubyid_http_method'>http_method</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span>
|
|
1167
|
-
|
|
1168
|
-
<span class='id identifier rubyid_header_params'>header_params</span> <span class='op'>=</span> <span class='ivar'>@default_headers</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:header_params</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1169
|
-
<span class='id identifier rubyid_query_params'>query_params</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:query_params</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1170
|
-
<span class='id identifier rubyid_form_params'>form_params</span> <span class='op'>=</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:form_params</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1171
|
-
|
|
1172
|
-
<span class='id identifier rubyid_update_params_for_auth!'>update_params_for_auth!</span> <span class='id identifier rubyid_header_params'>header_params</span><span class='comma'>,</span> <span class='id identifier rubyid_query_params'>query_params</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:auth_names</span><span class='rbracket'>]</span>
|
|
1173
|
-
|
|
1174
|
-
<span class='comment'># set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
|
|
1175
|
-
</span> <span class='id identifier rubyid__verify_ssl_host'>_verify_ssl_host</span> <span class='op'>=</span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_verify_ssl_host'>verify_ssl_host</span> <span class='op'>?</span> <span class='int'>2</span> <span class='op'>:</span> <span class='int'>0</span>
|
|
1176
|
-
|
|
1177
|
-
<span class='id identifier rubyid_req_opts'>req_opts</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1178
|
-
<span class='symbol'>:method</span> <span class='op'>=></span> <span class='id identifier rubyid_http_method'>http_method</span><span class='comma'>,</span>
|
|
1179
|
-
<span class='symbol'>:headers</span> <span class='op'>=></span> <span class='id identifier rubyid_header_params'>header_params</span><span class='comma'>,</span>
|
|
1180
|
-
<span class='symbol'>:params</span> <span class='op'>=></span> <span class='id identifier rubyid_query_params'>query_params</span><span class='comma'>,</span>
|
|
1181
|
-
<span class='symbol'>:params_encoding</span> <span class='op'>=></span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_params_encoding'>params_encoding</span><span class='comma'>,</span>
|
|
1182
|
-
<span class='symbol'>:timeout</span> <span class='op'>=></span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_timeout'>timeout</span><span class='comma'>,</span>
|
|
1183
|
-
<span class='symbol'>:ssl_verifypeer</span> <span class='op'>=></span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_verify_ssl'>verify_ssl</span><span class='comma'>,</span>
|
|
1184
|
-
<span class='symbol'>:ssl_verifyhost</span> <span class='op'>=></span> <span class='id identifier rubyid__verify_ssl_host'>_verify_ssl_host</span><span class='comma'>,</span>
|
|
1185
|
-
<span class='symbol'>:sslcert</span> <span class='op'>=></span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_cert_file'>cert_file</span><span class='comma'>,</span>
|
|
1186
|
-
<span class='symbol'>:sslkey</span> <span class='op'>=></span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_key_file'>key_file</span><span class='comma'>,</span>
|
|
1187
|
-
<span class='symbol'>:verbose</span> <span class='op'>=></span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_debugging'>debugging</span>
|
|
1188
|
-
<span class='rbrace'>}</span>
|
|
1189
|
-
|
|
1190
|
-
<span class='comment'># set custom cert, if provided
|
|
1191
|
-
</span> <span class='id identifier rubyid_req_opts'>req_opts</span><span class='lbracket'>[</span><span class='symbol'>:cainfo</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_ssl_ca_cert'>ssl_ca_cert</span> <span class='kw'>if</span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_ssl_ca_cert'>ssl_ca_cert</span>
|
|
1192
|
-
|
|
1193
|
-
<span class='kw'>if</span> <span class='lbracket'>[</span><span class='symbol'>:post</span><span class='comma'>,</span> <span class='symbol'>:patch</span><span class='comma'>,</span> <span class='symbol'>:put</span><span class='comma'>,</span> <span class='symbol'>:delete</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_http_method'>http_method</span><span class='rparen'>)</span>
|
|
1194
|
-
<span class='id identifier rubyid_req_body'>req_body</span> <span class='op'>=</span> <span class='id identifier rubyid_build_request_body'>build_request_body</span><span class='lparen'>(</span><span class='id identifier rubyid_header_params'>header_params</span><span class='comma'>,</span> <span class='id identifier rubyid_form_params'>form_params</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:body</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
1195
|
-
<span class='id identifier rubyid_req_opts'>req_opts</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span> <span class='symbol'>:body</span> <span class='op'>=></span> <span class='id identifier rubyid_req_body'>req_body</span>
|
|
1196
|
-
<span class='kw'>if</span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_debugging'>debugging</span>
|
|
1197
|
-
<span class='ivar'>@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'>"</span><span class='tstring_content'>HTTP request body param ~BEGIN~\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_req_body'>req_body</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n~END~\n</span><span class='tstring_end'>"</span></span>
|
|
1198
|
-
<span class='kw'>end</span>
|
|
1199
|
-
<span class='kw'>end</span>
|
|
1200
|
-
|
|
1201
|
-
<span class='id identifier rubyid_request'>request</span> <span class='op'>=</span> <span class='const'>Typhoeus</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_req_opts'>req_opts</span><span class='rparen'>)</span>
|
|
1202
|
-
<span class='id identifier rubyid_download_file'>download_file</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:return_type</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>File</span><span class='tstring_end'>'</span></span>
|
|
1203
|
-
<span class='id identifier rubyid_request'>request</span>
|
|
1204
|
-
<span class='kw'>end</span></pre>
|
|
1205
|
-
</td>
|
|
1206
|
-
</tr>
|
|
1207
|
-
</table>
|
|
1208
|
-
</div>
|
|
1209
|
-
|
|
1210
|
-
<div class="method_details ">
|
|
1211
|
-
<h3 class="signature " id="build_request_body-instance_method">
|
|
1212
|
-
|
|
1213
|
-
#<strong>build_request_body</strong>(header_params, form_params, body) ⇒ <tt>String</tt>
|
|
1214
|
-
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
</h3><div class="docstring">
|
|
1220
|
-
<div class="discussion">
|
|
1221
|
-
|
|
1222
|
-
<p>Builds the HTTP request body</p>
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
</div>
|
|
1226
|
-
</div>
|
|
1227
|
-
<div class="tags">
|
|
1228
|
-
<p class="tag_title">Parameters:</p>
|
|
1229
|
-
<ul class="param">
|
|
1230
|
-
|
|
1231
|
-
<li>
|
|
1232
|
-
|
|
1233
|
-
<span class='name'>header_params</span>
|
|
1234
|
-
|
|
1235
|
-
|
|
1236
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
—
|
|
1241
|
-
<div class='inline'>
|
|
1242
|
-
<p>Header parameters</p>
|
|
1243
|
-
</div>
|
|
1244
|
-
|
|
1245
|
-
</li>
|
|
1246
|
-
|
|
1247
|
-
<li>
|
|
1248
|
-
|
|
1249
|
-
<span class='name'>form_params</span>
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
—
|
|
1257
|
-
<div class='inline'>
|
|
1258
|
-
<p>Query parameters</p>
|
|
1259
|
-
</div>
|
|
1260
|
-
|
|
1261
|
-
</li>
|
|
1262
|
-
|
|
1263
|
-
<li>
|
|
1264
|
-
|
|
1265
|
-
<span class='name'>body</span>
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
<span class='type'>(<tt>Object</tt>)</span>
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
—
|
|
1273
|
-
<div class='inline'>
|
|
1274
|
-
<p>HTTP body (JSON/XML)</p>
|
|
1275
|
-
</div>
|
|
1276
|
-
|
|
1277
|
-
</li>
|
|
1278
|
-
|
|
1279
|
-
</ul>
|
|
1280
|
-
|
|
1281
|
-
<p class="tag_title">Returns:</p>
|
|
1282
|
-
<ul class="return">
|
|
1283
|
-
|
|
1284
|
-
<li>
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
—
|
|
1292
|
-
<div class='inline'>
|
|
1293
|
-
<p>HTTP body data in the form of string</p>
|
|
1294
|
-
</div>
|
|
1295
|
-
|
|
1296
|
-
</li>
|
|
1297
|
-
|
|
1298
|
-
</ul>
|
|
1299
|
-
|
|
1300
|
-
</div><table class="source_code">
|
|
1301
|
-
<tr>
|
|
1302
|
-
<td>
|
|
1303
|
-
<pre class="lines">
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
276
|
|
1307
|
-
277
|
|
1308
|
-
278
|
|
1309
|
-
279
|
|
1310
|
-
280
|
|
1311
|
-
281
|
|
1312
|
-
282
|
|
1313
|
-
283
|
|
1314
|
-
284
|
|
1315
|
-
285
|
|
1316
|
-
286
|
|
1317
|
-
287
|
|
1318
|
-
288
|
|
1319
|
-
289
|
|
1320
|
-
290
|
|
1321
|
-
291
|
|
1322
|
-
292
|
|
1323
|
-
293
|
|
1324
|
-
294
|
|
1325
|
-
295
|
|
1326
|
-
296</pre>
|
|
1327
|
-
</td>
|
|
1328
|
-
<td>
|
|
1329
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 276</span>
|
|
1330
|
-
|
|
1331
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_build_request_body'>build_request_body</span><span class='lparen'>(</span><span class='id identifier rubyid_header_params'>header_params</span><span class='comma'>,</span> <span class='id identifier rubyid_form_params'>form_params</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
|
1332
|
-
<span class='comment'># http form
|
|
1333
|
-
</span> <span class='kw'>if</span> <span class='id identifier rubyid_header_params'>header_params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/x-www-form-urlencoded</span><span class='tstring_end'>'</span></span> <span class='op'>||</span>
|
|
1334
|
-
<span class='id identifier rubyid_header_params'>header_params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>multipart/form-data</span><span class='tstring_end'>'</span></span>
|
|
1335
|
-
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1336
|
-
<span class='id identifier rubyid_form_params'>form_params</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
|
|
1337
|
-
<span class='kw'>case</span> <span class='id identifier rubyid_value'>value</span>
|
|
1338
|
-
<span class='kw'>when</span> <span class='op'>::</span><span class='const'>File</span><span class='comma'>,</span> <span class='op'>::</span><span class='const'>Array</span><span class='comma'>,</span> <span class='kw'>nil</span>
|
|
1339
|
-
<span class='comment'># let typhoeus handle File, Array and nil parameters
|
|
1340
|
-
</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
|
|
1341
|
-
<span class='kw'>else</span>
|
|
1342
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
1343
|
-
<span class='kw'>end</span>
|
|
1344
|
-
<span class='kw'>end</span>
|
|
1345
|
-
<span class='kw'>elsif</span> <span class='id identifier rubyid_body'>body</span>
|
|
1346
|
-
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_body'>body</span> <span class='op'>:</span> <span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
|
1347
|
-
<span class='kw'>else</span>
|
|
1348
|
-
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1349
|
-
<span class='kw'>end</span>
|
|
1350
|
-
<span class='id identifier rubyid_data'>data</span>
|
|
1351
|
-
<span class='kw'>end</span></pre>
|
|
1352
|
-
</td>
|
|
1353
|
-
</tr>
|
|
1354
|
-
</table>
|
|
1355
|
-
</div>
|
|
1356
|
-
|
|
1357
|
-
<div class="method_details ">
|
|
1358
|
-
<h3 class="signature " id="build_request_url-instance_method">
|
|
1359
|
-
|
|
1360
|
-
#<strong>build_request_url</strong>(path) ⇒ <tt>Object</tt>
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
</h3><table class="source_code">
|
|
1367
|
-
<tr>
|
|
1368
|
-
<td>
|
|
1369
|
-
<pre class="lines">
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
264
|
|
1373
|
-
265
|
|
1374
|
-
266
|
|
1375
|
-
267
|
|
1376
|
-
268</pre>
|
|
1377
|
-
</td>
|
|
1378
|
-
<td>
|
|
1379
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 264</span>
|
|
1380
|
-
|
|
1381
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_build_request_url'>build_request_url</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
|
1382
|
-
<span class='comment'># Add leading and trailing slashes to path
|
|
1383
|
-
</span> <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></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'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
1384
|
-
<span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_base_url'>base_url</span> <span class='op'>+</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
|
|
1385
|
-
<span class='kw'>end</span></pre>
|
|
1386
|
-
</td>
|
|
1387
|
-
</tr>
|
|
1388
|
-
</table>
|
|
1389
|
-
</div>
|
|
1390
|
-
|
|
1391
|
-
<div class="method_details ">
|
|
1392
|
-
<h3 class="signature " id="call_api-instance_method">
|
|
1393
|
-
|
|
1394
|
-
#<strong>call_api</strong>(http_method, path, opts = {}) ⇒ <tt>Array<(Object, Fixnum, Hash)></tt>
|
|
1395
|
-
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
|
|
1399
|
-
|
|
1400
|
-
</h3><div class="docstring">
|
|
1401
|
-
<div class="discussion">
|
|
1402
|
-
|
|
1403
|
-
<p>Call an API with given options.</p>
|
|
1404
|
-
|
|
1405
|
-
|
|
1406
|
-
</div>
|
|
1407
|
-
</div>
|
|
1408
|
-
<div class="tags">
|
|
1409
|
-
|
|
1410
|
-
<p class="tag_title">Returns:</p>
|
|
1411
|
-
<ul class="return">
|
|
1412
|
-
|
|
1413
|
-
<li>
|
|
1414
|
-
|
|
1415
|
-
|
|
1416
|
-
<span class='type'>(<tt>Array<(Object, Fixnum, Hash)></tt>)</span>
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
—
|
|
1421
|
-
<div class='inline'>
|
|
1422
|
-
<p>an array of 3 elements: the data deserialized from response body (could be
|
|
1423
|
-
nil), response status code and response headers.</p>
|
|
1424
|
-
</div>
|
|
1425
|
-
|
|
1426
|
-
</li>
|
|
1427
|
-
|
|
1428
|
-
</ul>
|
|
1429
|
-
|
|
1430
|
-
</div><table class="source_code">
|
|
1431
|
-
<tr>
|
|
1432
|
-
<td>
|
|
1433
|
-
<pre class="lines">
|
|
1434
|
-
|
|
1435
|
-
|
|
1436
|
-
49
|
|
1437
|
-
50
|
|
1438
|
-
51
|
|
1439
|
-
52
|
|
1440
|
-
53
|
|
1441
|
-
54
|
|
1442
|
-
55
|
|
1443
|
-
56
|
|
1444
|
-
57
|
|
1445
|
-
58
|
|
1446
|
-
59
|
|
1447
|
-
60
|
|
1448
|
-
61
|
|
1449
|
-
62
|
|
1450
|
-
63
|
|
1451
|
-
64
|
|
1452
|
-
65
|
|
1453
|
-
66
|
|
1454
|
-
67
|
|
1455
|
-
68
|
|
1456
|
-
69
|
|
1457
|
-
70
|
|
1458
|
-
71
|
|
1459
|
-
72
|
|
1460
|
-
73
|
|
1461
|
-
74
|
|
1462
|
-
75
|
|
1463
|
-
76
|
|
1464
|
-
77
|
|
1465
|
-
78</pre>
|
|
1466
|
-
</td>
|
|
1467
|
-
<td>
|
|
1468
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 49</span>
|
|
1469
|
-
|
|
1470
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='id identifier rubyid_http_method'>http_method</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</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>
|
|
1471
|
-
<span class='id identifier rubyid_request'>request</span> <span class='op'>=</span> <span class='id identifier rubyid_build_request'>build_request</span><span class='lparen'>(</span><span class='id identifier rubyid_http_method'>http_method</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
|
|
1472
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span>
|
|
1473
|
-
|
|
1474
|
-
<span class='kw'>if</span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_debugging'>debugging</span>
|
|
1475
|
-
<span class='ivar'>@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'>"</span><span class='tstring_content'>HTTP response body ~BEGIN~\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n~END~\n</span><span class='tstring_end'>"</span></span>
|
|
1476
|
-
<span class='kw'>end</span>
|
|
1477
|
-
|
|
1478
|
-
<span class='kw'>unless</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span>
|
|
1479
|
-
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_timed_out?'>timed_out?</span>
|
|
1480
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'><span class='object_link'><a href="ApiError.html" title="TreezorClient::ApiError (class)">ApiError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ApiError.html#initialize-instance_method" title="TreezorClient::ApiError#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Connection timed out</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
1481
|
-
<span class='kw'>elsif</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span> <span class='op'>==</span> <span class='int'>0</span>
|
|
1482
|
-
<span class='comment'># Errors from libcurl will be made visible here
|
|
1483
|
-
</span> <span class='id identifier rubyid_fail'>fail</span> <span class='const'><span class='object_link'><a href="ApiError.html" title="TreezorClient::ApiError (class)">ApiError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ApiError.html#initialize-instance_method" title="TreezorClient::ApiError#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='symbol'>:code</span> <span class='op'>=></span> <span class='int'>0</span><span class='comma'>,</span>
|
|
1484
|
-
<span class='symbol'>:message</span> <span class='op'>=></span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_return_message'>return_message</span><span class='rparen'>)</span>
|
|
1485
|
-
<span class='kw'>else</span>
|
|
1486
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'><span class='object_link'><a href="ApiError.html" title="TreezorClient::ApiError (class)">ApiError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ApiError.html#initialize-instance_method" title="TreezorClient::ApiError#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='symbol'>:code</span> <span class='op'>=></span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span><span class='comma'>,</span>
|
|
1487
|
-
<span class='symbol'>:response_headers</span> <span class='op'>=></span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span>
|
|
1488
|
-
<span class='symbol'>:response_body</span> <span class='op'>=></span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
1489
|
-
<span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_status_message'>status_message</span>
|
|
1490
|
-
<span class='kw'>end</span>
|
|
1491
|
-
<span class='kw'>end</span>
|
|
1492
|
-
|
|
1493
|
-
<span class='kw'>if</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:return_type</span><span class='rbracket'>]</span>
|
|
1494
|
-
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_deserialize'>deserialize</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:return_type</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
1495
|
-
<span class='kw'>else</span>
|
|
1496
|
-
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1497
|
-
<span class='kw'>end</span>
|
|
1498
|
-
<span class='kw'>return</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_code'>code</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span>
|
|
1499
|
-
<span class='kw'>end</span></pre>
|
|
1500
|
-
</td>
|
|
1501
|
-
</tr>
|
|
1502
|
-
</table>
|
|
1503
|
-
</div>
|
|
1504
|
-
|
|
1505
|
-
<div class="method_details ">
|
|
1506
|
-
<h3 class="signature " id="convert_to_type-instance_method">
|
|
1507
|
-
|
|
1508
|
-
#<strong>convert_to_type</strong>(data, return_type) ⇒ <tt>Mixed</tt>
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
|
|
1513
|
-
|
|
1514
|
-
</h3><div class="docstring">
|
|
1515
|
-
<div class="discussion">
|
|
1516
|
-
|
|
1517
|
-
<p>Convert data to the given return type.</p>
|
|
1518
|
-
|
|
1519
|
-
|
|
1520
|
-
</div>
|
|
1521
|
-
</div>
|
|
1522
|
-
<div class="tags">
|
|
1523
|
-
<p class="tag_title">Parameters:</p>
|
|
1524
|
-
<ul class="param">
|
|
1525
|
-
|
|
1526
|
-
<li>
|
|
1527
|
-
|
|
1528
|
-
<span class='name'>data</span>
|
|
1529
|
-
|
|
1530
|
-
|
|
1531
|
-
<span class='type'>(<tt>Object</tt>)</span>
|
|
1532
|
-
|
|
1533
|
-
|
|
1534
|
-
|
|
1535
|
-
—
|
|
1536
|
-
<div class='inline'>
|
|
1537
|
-
<p>Data to be converted</p>
|
|
1538
|
-
</div>
|
|
1539
|
-
|
|
1540
|
-
</li>
|
|
1541
|
-
|
|
1542
|
-
<li>
|
|
1543
|
-
|
|
1544
|
-
<span class='name'>return_type</span>
|
|
1545
|
-
|
|
1546
|
-
|
|
1547
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
1548
|
-
|
|
1549
|
-
|
|
1550
|
-
|
|
1551
|
-
—
|
|
1552
|
-
<div class='inline'>
|
|
1553
|
-
<p>Return type</p>
|
|
1554
|
-
</div>
|
|
1555
|
-
|
|
1556
|
-
</li>
|
|
1557
|
-
|
|
1558
|
-
</ul>
|
|
1559
|
-
|
|
1560
|
-
<p class="tag_title">Returns:</p>
|
|
1561
|
-
<ul class="return">
|
|
1562
|
-
|
|
1563
|
-
<li>
|
|
1564
|
-
|
|
1565
|
-
|
|
1566
|
-
<span class='type'>(<tt>Mixed</tt>)</span>
|
|
1567
|
-
|
|
1568
|
-
|
|
1569
|
-
|
|
1570
|
-
—
|
|
1571
|
-
<div class='inline'>
|
|
1572
|
-
<p>Data in a particular type</p>
|
|
1573
|
-
</div>
|
|
1574
|
-
|
|
1575
|
-
</li>
|
|
1576
|
-
|
|
1577
|
-
</ul>
|
|
1578
|
-
|
|
1579
|
-
</div><table class="source_code">
|
|
1580
|
-
<tr>
|
|
1581
|
-
<td>
|
|
1582
|
-
<pre class="lines">
|
|
1583
|
-
|
|
1584
|
-
|
|
1585
|
-
181
|
|
1586
|
-
182
|
|
1587
|
-
183
|
|
1588
|
-
184
|
|
1589
|
-
185
|
|
1590
|
-
186
|
|
1591
|
-
187
|
|
1592
|
-
188
|
|
1593
|
-
189
|
|
1594
|
-
190
|
|
1595
|
-
191
|
|
1596
|
-
192
|
|
1597
|
-
193
|
|
1598
|
-
194
|
|
1599
|
-
195
|
|
1600
|
-
196
|
|
1601
|
-
197
|
|
1602
|
-
198
|
|
1603
|
-
199
|
|
1604
|
-
200
|
|
1605
|
-
201
|
|
1606
|
-
202
|
|
1607
|
-
203
|
|
1608
|
-
204
|
|
1609
|
-
205
|
|
1610
|
-
206
|
|
1611
|
-
207
|
|
1612
|
-
208
|
|
1613
|
-
209
|
|
1614
|
-
210
|
|
1615
|
-
211
|
|
1616
|
-
212
|
|
1617
|
-
213
|
|
1618
|
-
214
|
|
1619
|
-
215
|
|
1620
|
-
216
|
|
1621
|
-
217</pre>
|
|
1622
|
-
</td>
|
|
1623
|
-
<td>
|
|
1624
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 181</span>
|
|
1625
|
-
|
|
1626
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_convert_to_type'>convert_to_type</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_return_type'>return_type</span><span class='rparen'>)</span>
|
|
1627
|
-
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1628
|
-
<span class='kw'>case</span> <span class='id identifier rubyid_return_type'>return_type</span>
|
|
1629
|
-
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>String</span><span class='tstring_end'>'</span></span>
|
|
1630
|
-
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
|
1631
|
-
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Integer</span><span class='tstring_end'>'</span></span>
|
|
1632
|
-
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
|
|
1633
|
-
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Float</span><span class='tstring_end'>'</span></span>
|
|
1634
|
-
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_to_f'>to_f</span>
|
|
1635
|
-
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>BOOLEAN</span><span class='tstring_end'>'</span></span>
|
|
1636
|
-
<span class='id identifier rubyid_data'>data</span> <span class='op'>==</span> <span class='kw'>true</span>
|
|
1637
|
-
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>DateTime</span><span class='tstring_end'>'</span></span>
|
|
1638
|
-
<span class='comment'># parse date time (expecting ISO 8601 format)
|
|
1639
|
-
</span> <span class='const'>DateTime</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span> <span class='id identifier rubyid_data'>data</span>
|
|
1640
|
-
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Date</span><span class='tstring_end'>'</span></span>
|
|
1641
|
-
<span class='comment'># parse date time (expecting ISO 8601 format)
|
|
1642
|
-
</span> <span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span> <span class='id identifier rubyid_data'>data</span>
|
|
1643
|
-
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Object</span><span class='tstring_end'>'</span></span>
|
|
1644
|
-
<span class='comment'># generic object (usually a Hash), return directly
|
|
1645
|
-
</span> <span class='id identifier rubyid_data'>data</span>
|
|
1646
|
-
<span class='kw'>when</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\AArray<(.+)>\z</span><span class='regexp_end'>/</span></span>
|
|
1647
|
-
<span class='comment'># e.g. Array<Pet>
|
|
1648
|
-
</span> <span class='id identifier rubyid_sub_type'>sub_type</span> <span class='op'>=</span> <span class='backref'>$1</span>
|
|
1649
|
-
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_item'>item</span><span class='op'>|</span> <span class='id identifier rubyid_convert_to_type'>convert_to_type</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='comma'>,</span> <span class='id identifier rubyid_sub_type'>sub_type</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
1650
|
-
<span class='kw'>when</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\AHash\<String, (.+)\>\z</span><span class='regexp_end'>/</span></span>
|
|
1651
|
-
<span class='comment'># e.g. Hash<String, Integer>
|
|
1652
|
-
</span> <span class='id identifier rubyid_sub_type'>sub_type</span> <span class='op'>=</span> <span class='backref'>$1</span>
|
|
1653
|
-
<span class='lbrace'>{</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_hash'>hash</span><span class='op'>|</span>
|
|
1654
|
-
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_convert_to_type'>convert_to_type</span><span class='lparen'>(</span><span class='id identifier rubyid_v'>v</span><span class='comma'>,</span> <span class='id identifier rubyid_sub_type'>sub_type</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
1655
|
-
<span class='kw'>end</span>
|
|
1656
|
-
<span class='kw'>else</span>
|
|
1657
|
-
<span class='comment'># models, e.g. Pet
|
|
1658
|
-
</span> <span class='const'><span class='object_link'><a href="../TreezorClient.html" title="TreezorClient (module)">TreezorClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='id identifier rubyid_return_type'>return_type</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_model'>model</span><span class='op'>|</span>
|
|
1659
|
-
<span class='id identifier rubyid_model'>model</span><span class='period'>.</span><span class='id identifier rubyid_build_from_hash'>build_from_hash</span> <span class='id identifier rubyid_data'>data</span>
|
|
1660
|
-
<span class='kw'>end</span>
|
|
1661
|
-
<span class='kw'>end</span>
|
|
1662
|
-
<span class='kw'>end</span></pre>
|
|
1663
|
-
</td>
|
|
1664
|
-
</tr>
|
|
1665
|
-
</table>
|
|
1666
|
-
</div>
|
|
1667
|
-
|
|
1668
|
-
<div class="method_details ">
|
|
1669
|
-
<h3 class="signature " id="deserialize-instance_method">
|
|
1670
|
-
|
|
1671
|
-
#<strong>deserialize</strong>(response, return_type) ⇒ <tt>Object</tt>
|
|
1672
|
-
|
|
1673
|
-
|
|
1674
|
-
|
|
1675
|
-
|
|
1676
|
-
|
|
1677
|
-
</h3><div class="docstring">
|
|
1678
|
-
<div class="discussion">
|
|
1679
|
-
|
|
1680
|
-
<p>Deserialize the response to the given return type.</p>
|
|
1681
|
-
|
|
1682
|
-
|
|
1683
|
-
</div>
|
|
1684
|
-
</div>
|
|
1685
|
-
<div class="tags">
|
|
1686
|
-
<p class="tag_title">Parameters:</p>
|
|
1687
|
-
<ul class="param">
|
|
1688
|
-
|
|
1689
|
-
<li>
|
|
1690
|
-
|
|
1691
|
-
<span class='name'>response</span>
|
|
1692
|
-
|
|
1693
|
-
|
|
1694
|
-
<span class='type'>(<tt>Response</tt>)</span>
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
|
-
—
|
|
1699
|
-
<div class='inline'>
|
|
1700
|
-
<p>HTTP response</p>
|
|
1701
|
-
</div>
|
|
1702
|
-
|
|
1703
|
-
</li>
|
|
1704
|
-
|
|
1705
|
-
<li>
|
|
1706
|
-
|
|
1707
|
-
<span class='name'>return_type</span>
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
—
|
|
1715
|
-
<div class='inline'>
|
|
1716
|
-
<p>some examples: “User”, “<a href="User">Array</a>”, “<a
|
|
1717
|
-
href="String,Integer">Hash</a>”</p>
|
|
1718
|
-
</div>
|
|
1719
|
-
|
|
1720
|
-
</li>
|
|
1721
|
-
|
|
1722
|
-
</ul>
|
|
1723
|
-
|
|
1724
|
-
|
|
1725
|
-
</div><table class="source_code">
|
|
1726
|
-
<tr>
|
|
1727
|
-
<td>
|
|
1728
|
-
<pre class="lines">
|
|
1729
|
-
|
|
1730
|
-
|
|
1731
|
-
147
|
|
1732
|
-
148
|
|
1733
|
-
149
|
|
1734
|
-
150
|
|
1735
|
-
151
|
|
1736
|
-
152
|
|
1737
|
-
153
|
|
1738
|
-
154
|
|
1739
|
-
155
|
|
1740
|
-
156
|
|
1741
|
-
157
|
|
1742
|
-
158
|
|
1743
|
-
159
|
|
1744
|
-
160
|
|
1745
|
-
161
|
|
1746
|
-
162
|
|
1747
|
-
163
|
|
1748
|
-
164
|
|
1749
|
-
165
|
|
1750
|
-
166
|
|
1751
|
-
167
|
|
1752
|
-
168
|
|
1753
|
-
169
|
|
1754
|
-
170
|
|
1755
|
-
171
|
|
1756
|
-
172
|
|
1757
|
-
173
|
|
1758
|
-
174
|
|
1759
|
-
175</pre>
|
|
1760
|
-
</td>
|
|
1761
|
-
<td>
|
|
1762
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 147</span>
|
|
1763
|
-
|
|
1764
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_deserialize'>deserialize</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_return_type'>return_type</span><span class='rparen'>)</span>
|
|
1765
|
-
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
|
|
1766
|
-
|
|
1767
|
-
<span class='comment'># handle file downloading - return the File instance processed in request callbacks
|
|
1768
|
-
</span> <span class='comment'># note that response body is empty when the file is written in chunks in request on_body callback
|
|
1769
|
-
</span> <span class='kw'>return</span> <span class='ivar'>@tempfile</span> <span class='kw'>if</span> <span class='id identifier rubyid_return_type'>return_type</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>File</span><span class='tstring_end'>'</span></span>
|
|
1770
|
-
|
|
1771
|
-
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
|
1772
|
-
|
|
1773
|
-
<span class='comment'># return response body directly for String return type
|
|
1774
|
-
</span> <span class='kw'>return</span> <span class='id identifier rubyid_body'>body</span> <span class='kw'>if</span> <span class='id identifier rubyid_return_type'>return_type</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>String</span><span class='tstring_end'>'</span></span>
|
|
1775
|
-
|
|
1776
|
-
<span class='comment'># ensuring a default content type
|
|
1777
|
-
</span> <span class='id identifier rubyid_content_type'>content_type</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span>
|
|
1778
|
-
|
|
1779
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Content-Type is not supported: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_content_type'>content_type</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_json_mime?'>json_mime?</span><span class='lparen'>(</span><span class='id identifier rubyid_content_type'>content_type</span><span class='rparen'>)</span>
|
|
1780
|
-
|
|
1781
|
-
<span class='kw'>begin</span>
|
|
1782
|
-
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>[</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_body'>body</span><span class='embexpr_end'>}</span><span class='tstring_content'>]</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:symbolize_names</span> <span class='op'>=></span> <span class='kw'>true</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
|
|
1783
|
-
<span class='kw'>rescue</span> <span class='const'>JSON</span><span class='op'>::</span><span class='const'>ParserError</span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span>
|
|
1784
|
-
<span class='kw'>if</span> <span class='qwords_beg'>%w(</span><span class='tstring_content'>String</span><span class='words_sep'> </span><span class='tstring_content'>Date</span><span class='words_sep'> </span><span class='tstring_content'>DateTime</span><span class='tstring_end'>)</span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_return_type'>return_type</span><span class='rparen'>)</span>
|
|
1785
|
-
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_body'>body</span>
|
|
1786
|
-
<span class='kw'>else</span>
|
|
1787
|
-
<span class='id identifier rubyid_raise'>raise</span> <span class='id identifier rubyid_e'>e</span>
|
|
1788
|
-
<span class='kw'>end</span>
|
|
1789
|
-
<span class='kw'>end</span>
|
|
1790
|
-
|
|
1791
|
-
<span class='id identifier rubyid_convert_to_type'>convert_to_type</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_return_type'>return_type</span>
|
|
1792
|
-
<span class='kw'>end</span></pre>
|
|
1793
|
-
</td>
|
|
1794
|
-
</tr>
|
|
1795
|
-
</table>
|
|
1796
|
-
</div>
|
|
1797
|
-
|
|
1798
|
-
<div class="method_details ">
|
|
1799
|
-
<h3 class="signature " id="download_file-instance_method">
|
|
1800
|
-
|
|
1801
|
-
#<strong>download_file</strong>(request) ⇒ <tt>Object</tt>
|
|
1802
|
-
|
|
1803
|
-
|
|
1804
|
-
|
|
1805
|
-
|
|
1806
|
-
|
|
1807
|
-
</h3><div class="docstring">
|
|
1808
|
-
<div class="discussion">
|
|
1809
|
-
|
|
1810
|
-
<p>Save response body into a file in (the defined) temporary folder, using the
|
|
1811
|
-
filename from the “Content-Disposition” header if provided, otherwise a
|
|
1812
|
-
random filename. The response body is written to the file in chunks in
|
|
1813
|
-
order to handle files which size is larger than maximum Ruby String or even
|
|
1814
|
-
larger than the maximum memory a Ruby process can use.</p>
|
|
1815
|
-
|
|
1816
|
-
|
|
1817
|
-
</div>
|
|
1818
|
-
</div>
|
|
1819
|
-
<div class="tags">
|
|
1820
|
-
|
|
1821
|
-
|
|
1822
|
-
<p class="tag_title">See Also:</p>
|
|
1823
|
-
<ul class="see">
|
|
1824
|
-
|
|
1825
|
-
<li><span class='object_link'><a href="Configuration.html#temp_folder_path-instance_method" title="TreezorClient::Configuration#temp_folder_path (method)">Configuration#temp_folder_path</a></span></li>
|
|
1826
|
-
|
|
1827
|
-
</ul>
|
|
1828
|
-
|
|
1829
|
-
</div><table class="source_code">
|
|
1830
|
-
<tr>
|
|
1831
|
-
<td>
|
|
1832
|
-
<pre class="lines">
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
226
|
|
1836
|
-
227
|
|
1837
|
-
228
|
|
1838
|
-
229
|
|
1839
|
-
230
|
|
1840
|
-
231
|
|
1841
|
-
232
|
|
1842
|
-
233
|
|
1843
|
-
234
|
|
1844
|
-
235
|
|
1845
|
-
236
|
|
1846
|
-
237
|
|
1847
|
-
238
|
|
1848
|
-
239
|
|
1849
|
-
240
|
|
1850
|
-
241
|
|
1851
|
-
242
|
|
1852
|
-
243
|
|
1853
|
-
244
|
|
1854
|
-
245
|
|
1855
|
-
246
|
|
1856
|
-
247
|
|
1857
|
-
248
|
|
1858
|
-
249
|
|
1859
|
-
250
|
|
1860
|
-
251
|
|
1861
|
-
252
|
|
1862
|
-
253</pre>
|
|
1863
|
-
</td>
|
|
1864
|
-
<td>
|
|
1865
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 226</span>
|
|
1866
|
-
|
|
1867
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_download_file'>download_file</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
|
|
1868
|
-
<span class='id identifier rubyid_tempfile'>tempfile</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1869
|
-
<span class='id identifier rubyid_encoding'>encoding</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1870
|
-
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_on_headers'>on_headers</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_response'>response</span><span class='op'>|</span>
|
|
1871
|
-
<span class='id identifier rubyid_content_disposition'>content_disposition</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Content-Disposition</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
|
1872
|
-
<span class='kw'>if</span> <span class='id identifier rubyid_content_disposition'>content_disposition</span> <span class='kw'>and</span> <span class='id identifier rubyid_content_disposition'>content_disposition</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>filename=</span><span class='regexp_end'>/i</span></span>
|
|
1873
|
-
<span class='id identifier rubyid_filename'>filename</span> <span class='op'>=</span> <span class='id identifier rubyid_content_disposition'>content_disposition</span><span class='lbracket'>[</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>filename=['"]?([^'"\s]+)['"]?</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='int'>1</span><span class='rbracket'>]</span>
|
|
1874
|
-
<span class='id identifier rubyid_prefix'>prefix</span> <span class='op'>=</span> <span class='id identifier rubyid_sanitize_filename'>sanitize_filename</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='rparen'>)</span>
|
|
1875
|
-
<span class='kw'>else</span>
|
|
1876
|
-
<span class='id identifier rubyid_prefix'>prefix</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>download-</span><span class='tstring_end'>'</span></span>
|
|
1877
|
-
<span class='kw'>end</span>
|
|
1878
|
-
<span class='id identifier rubyid_prefix'>prefix</span> <span class='op'>=</span> <span class='id identifier rubyid_prefix'>prefix</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>-</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_prefix'>prefix</span><span class='period'>.</span><span class='id identifier rubyid_end_with?'>end_with?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>-</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
1879
|
-
<span class='id identifier rubyid_encoding'>encoding</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_encoding'>encoding</span>
|
|
1880
|
-
<span class='id identifier rubyid_tempfile'>tempfile</span> <span class='op'>=</span> <span class='const'>Tempfile</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_prefix'>prefix</span><span class='comma'>,</span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_temp_folder_path'>temp_folder_path</span><span class='comma'>,</span> <span class='label'>encoding:</span> <span class='id identifier rubyid_encoding'>encoding</span><span class='rparen'>)</span>
|
|
1881
|
-
<span class='ivar'>@tempfile</span> <span class='op'>=</span> <span class='id identifier rubyid_tempfile'>tempfile</span>
|
|
1882
|
-
<span class='kw'>end</span>
|
|
1883
|
-
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_on_body'>on_body</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_chunk'>chunk</span><span class='op'>|</span>
|
|
1884
|
-
<span class='id identifier rubyid_chunk'>chunk</span><span class='period'>.</span><span class='id identifier rubyid_force_encoding'>force_encoding</span><span class='lparen'>(</span><span class='id identifier rubyid_encoding'>encoding</span><span class='rparen'>)</span>
|
|
1885
|
-
<span class='id identifier rubyid_tempfile'>tempfile</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_chunk'>chunk</span><span class='rparen'>)</span>
|
|
1886
|
-
<span class='kw'>end</span>
|
|
1887
|
-
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_on_complete'>on_complete</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_response'>response</span><span class='op'>|</span>
|
|
1888
|
-
<span class='id identifier rubyid_tempfile'>tempfile</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
|
|
1889
|
-
<span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_info'>info</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Temp file written to </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_tempfile'>tempfile</span><span class='period'>.</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_content'>, please copy the file to a proper folder </span><span class='tstring_end'>"</span></span>\
|
|
1890
|
-
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file </span><span class='tstring_end'>"</span></span>\
|
|
1891
|
-
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>will be deleted automatically with GC. It's also recommended to delete the temp file </span><span class='tstring_end'>"</span></span>\
|
|
1892
|
-
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>explicitly with `tempfile.delete`</span><span class='tstring_end'>"</span></span>
|
|
1893
|
-
<span class='kw'>end</span>
|
|
1894
|
-
<span class='kw'>end</span></pre>
|
|
1895
|
-
</td>
|
|
1896
|
-
</tr>
|
|
1897
|
-
</table>
|
|
1898
|
-
</div>
|
|
1899
|
-
|
|
1900
|
-
<div class="method_details ">
|
|
1901
|
-
<h3 class="signature " id="json_mime?-instance_method">
|
|
1902
|
-
|
|
1903
|
-
#<strong>json_mime?</strong>(mime) ⇒ <tt>Boolean</tt>
|
|
1904
|
-
|
|
1905
|
-
|
|
1906
|
-
|
|
1907
|
-
|
|
1908
|
-
|
|
1909
|
-
</h3><div class="docstring">
|
|
1910
|
-
<div class="discussion">
|
|
1911
|
-
|
|
1912
|
-
<p>Check if the given MIME is a JSON MIME. JSON MIME examples:</p>
|
|
1913
|
-
|
|
1914
|
-
<pre class="code ruby"><code class="ruby">application/json
|
|
1915
|
-
application/json; charset=UTF8
|
|
1916
|
-
APPLICATION/JSON
|
|
1917
|
-
*/*
|
|
1918
|
-
</code></pre>
|
|
1919
|
-
|
|
1920
|
-
|
|
1921
|
-
</div>
|
|
1922
|
-
</div>
|
|
1923
|
-
<div class="tags">
|
|
1924
|
-
<p class="tag_title">Parameters:</p>
|
|
1925
|
-
<ul class="param">
|
|
1926
|
-
|
|
1927
|
-
<li>
|
|
1928
|
-
|
|
1929
|
-
<span class='name'>mime</span>
|
|
1930
|
-
|
|
1931
|
-
|
|
1932
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
1933
|
-
|
|
1934
|
-
|
|
1935
|
-
|
|
1936
|
-
—
|
|
1937
|
-
<div class='inline'>
|
|
1938
|
-
<p>MIME</p>
|
|
1939
|
-
</div>
|
|
1940
|
-
|
|
1941
|
-
</li>
|
|
1942
|
-
|
|
1943
|
-
</ul>
|
|
1944
|
-
|
|
1945
|
-
<p class="tag_title">Returns:</p>
|
|
1946
|
-
<ul class="return">
|
|
1947
|
-
|
|
1948
|
-
<li>
|
|
1949
|
-
|
|
1950
|
-
|
|
1951
|
-
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1952
|
-
|
|
1953
|
-
|
|
1954
|
-
|
|
1955
|
-
—
|
|
1956
|
-
<div class='inline'>
|
|
1957
|
-
<p>True if the MIME is application/json</p>
|
|
1958
|
-
</div>
|
|
1959
|
-
|
|
1960
|
-
</li>
|
|
1961
|
-
|
|
1962
|
-
</ul>
|
|
1963
|
-
|
|
1964
|
-
</div><table class="source_code">
|
|
1965
|
-
<tr>
|
|
1966
|
-
<td>
|
|
1967
|
-
<pre class="lines">
|
|
1968
|
-
|
|
1969
|
-
|
|
1970
|
-
139
|
|
1971
|
-
140
|
|
1972
|
-
141</pre>
|
|
1973
|
-
</td>
|
|
1974
|
-
<td>
|
|
1975
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 139</span>
|
|
1976
|
-
|
|
1977
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_json_mime?'>json_mime?</span><span class='lparen'>(</span><span class='id identifier rubyid_mime'>mime</span><span class='rparen'>)</span>
|
|
1978
|
-
<span class='lparen'>(</span><span class='id identifier rubyid_mime'>mime</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>*/*</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='op'>||</span> <span class='op'>!</span><span class='lparen'>(</span><span class='id identifier rubyid_mime'>mime</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>Application\/.*json(?!p)(;.*)?</span><span class='regexp_end'>/i</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1979
|
-
<span class='kw'>end</span></pre>
|
|
1980
|
-
</td>
|
|
1981
|
-
</tr>
|
|
1982
|
-
</table>
|
|
1983
|
-
</div>
|
|
1984
|
-
|
|
1985
|
-
<div class="method_details ">
|
|
1986
|
-
<h3 class="signature " id="object_to_hash-instance_method">
|
|
1987
|
-
|
|
1988
|
-
#<strong>object_to_hash</strong>(obj) ⇒ <tt>String</tt>
|
|
1989
|
-
|
|
1990
|
-
|
|
1991
|
-
|
|
1992
|
-
|
|
1993
|
-
|
|
1994
|
-
</h3><div class="docstring">
|
|
1995
|
-
<div class="discussion">
|
|
1996
|
-
|
|
1997
|
-
<p>Convert object(non-array) to hash.</p>
|
|
1998
|
-
|
|
1999
|
-
|
|
2000
|
-
</div>
|
|
2001
|
-
</div>
|
|
2002
|
-
<div class="tags">
|
|
2003
|
-
<p class="tag_title">Parameters:</p>
|
|
2004
|
-
<ul class="param">
|
|
2005
|
-
|
|
2006
|
-
<li>
|
|
2007
|
-
|
|
2008
|
-
<span class='name'>obj</span>
|
|
2009
|
-
|
|
2010
|
-
|
|
2011
|
-
<span class='type'>(<tt>Object</tt>)</span>
|
|
2012
|
-
|
|
2013
|
-
|
|
2014
|
-
|
|
2015
|
-
—
|
|
2016
|
-
<div class='inline'>
|
|
2017
|
-
<p>object to be converted into JSON string</p>
|
|
2018
|
-
</div>
|
|
2019
|
-
|
|
2020
|
-
</li>
|
|
2021
|
-
|
|
2022
|
-
</ul>
|
|
2023
|
-
|
|
2024
|
-
<p class="tag_title">Returns:</p>
|
|
2025
|
-
<ul class="return">
|
|
2026
|
-
|
|
2027
|
-
<li>
|
|
2028
|
-
|
|
2029
|
-
|
|
2030
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
2031
|
-
|
|
2032
|
-
|
|
2033
|
-
|
|
2034
|
-
—
|
|
2035
|
-
<div class='inline'>
|
|
2036
|
-
<p>JSON string representation of the object</p>
|
|
2037
|
-
</div>
|
|
2038
|
-
|
|
2039
|
-
</li>
|
|
2040
|
-
|
|
2041
|
-
</ul>
|
|
2042
|
-
|
|
2043
|
-
</div><table class="source_code">
|
|
2044
|
-
<tr>
|
|
2045
|
-
<td>
|
|
2046
|
-
<pre class="lines">
|
|
2047
|
-
|
|
2048
|
-
|
|
2049
|
-
361
|
|
2050
|
-
362
|
|
2051
|
-
363
|
|
2052
|
-
364
|
|
2053
|
-
365
|
|
2054
|
-
366
|
|
2055
|
-
367</pre>
|
|
2056
|
-
</td>
|
|
2057
|
-
<td>
|
|
2058
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 361</span>
|
|
2059
|
-
|
|
2060
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_object_to_hash'>object_to_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
|
|
2061
|
-
<span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:to_hash</span><span class='rparen'>)</span>
|
|
2062
|
-
<span class='id identifier rubyid_obj'>obj</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span>
|
|
2063
|
-
<span class='kw'>else</span>
|
|
2064
|
-
<span class='id identifier rubyid_obj'>obj</span>
|
|
2065
|
-
<span class='kw'>end</span>
|
|
2066
|
-
<span class='kw'>end</span></pre>
|
|
2067
|
-
</td>
|
|
2068
|
-
</tr>
|
|
2069
|
-
</table>
|
|
2070
|
-
</div>
|
|
2071
|
-
|
|
2072
|
-
<div class="method_details ">
|
|
2073
|
-
<h3 class="signature " id="object_to_http_body-instance_method">
|
|
2074
|
-
|
|
2075
|
-
#<strong>object_to_http_body</strong>(model) ⇒ <tt>String</tt>
|
|
2076
|
-
|
|
2077
|
-
|
|
2078
|
-
|
|
2079
|
-
|
|
2080
|
-
|
|
2081
|
-
</h3><div class="docstring">
|
|
2082
|
-
<div class="discussion">
|
|
2083
|
-
|
|
2084
|
-
<p>Convert object (array, hash, object, etc) to JSON string.</p>
|
|
2085
|
-
|
|
2086
|
-
|
|
2087
|
-
</div>
|
|
2088
|
-
</div>
|
|
2089
|
-
<div class="tags">
|
|
2090
|
-
<p class="tag_title">Parameters:</p>
|
|
2091
|
-
<ul class="param">
|
|
2092
|
-
|
|
2093
|
-
<li>
|
|
2094
|
-
|
|
2095
|
-
<span class='name'>model</span>
|
|
2096
|
-
|
|
2097
|
-
|
|
2098
|
-
<span class='type'>(<tt>Object</tt>)</span>
|
|
2099
|
-
|
|
2100
|
-
|
|
2101
|
-
|
|
2102
|
-
—
|
|
2103
|
-
<div class='inline'>
|
|
2104
|
-
<p>object to be converted into JSON string</p>
|
|
2105
|
-
</div>
|
|
2106
|
-
|
|
2107
|
-
</li>
|
|
2108
|
-
|
|
2109
|
-
</ul>
|
|
2110
|
-
|
|
2111
|
-
<p class="tag_title">Returns:</p>
|
|
2112
|
-
<ul class="return">
|
|
2113
|
-
|
|
2114
|
-
<li>
|
|
2115
|
-
|
|
2116
|
-
|
|
2117
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
2118
|
-
|
|
2119
|
-
|
|
2120
|
-
|
|
2121
|
-
—
|
|
2122
|
-
<div class='inline'>
|
|
2123
|
-
<p>JSON string representation of the object</p>
|
|
2124
|
-
</div>
|
|
2125
|
-
|
|
2126
|
-
</li>
|
|
2127
|
-
|
|
2128
|
-
</ul>
|
|
2129
|
-
|
|
2130
|
-
</div><table class="source_code">
|
|
2131
|
-
<tr>
|
|
2132
|
-
<td>
|
|
2133
|
-
<pre class="lines">
|
|
2134
|
-
|
|
2135
|
-
|
|
2136
|
-
347
|
|
2137
|
-
348
|
|
2138
|
-
349
|
|
2139
|
-
350
|
|
2140
|
-
351
|
|
2141
|
-
352
|
|
2142
|
-
353
|
|
2143
|
-
354
|
|
2144
|
-
355
|
|
2145
|
-
356</pre>
|
|
2146
|
-
</td>
|
|
2147
|
-
<td>
|
|
2148
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 347</span>
|
|
2149
|
-
|
|
2150
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_object_to_http_body'>object_to_http_body</span><span class='lparen'>(</span><span class='id identifier rubyid_model'>model</span><span class='rparen'>)</span>
|
|
2151
|
-
<span class='kw'>return</span> <span class='id identifier rubyid_model'>model</span> <span class='kw'>if</span> <span class='id identifier rubyid_model'>model</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_model'>model</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span>
|
|
2152
|
-
<span class='id identifier rubyid_local_body'>local_body</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
2153
|
-
<span class='kw'>if</span> <span class='id identifier rubyid_model'>model</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span>
|
|
2154
|
-
<span class='id identifier rubyid_local_body'>local_body</span> <span class='op'>=</span> <span class='id identifier rubyid_model'>model</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_m'>m</span><span class='op'>|</span> <span class='id identifier rubyid_object_to_hash'>object_to_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_m'>m</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
2155
|
-
<span class='kw'>else</span>
|
|
2156
|
-
<span class='id identifier rubyid_local_body'>local_body</span> <span class='op'>=</span> <span class='id identifier rubyid_object_to_hash'>object_to_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_model'>model</span><span class='rparen'>)</span>
|
|
2157
|
-
<span class='kw'>end</span>
|
|
2158
|
-
<span class='id identifier rubyid_local_body'>local_body</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
|
|
2159
|
-
<span class='kw'>end</span></pre>
|
|
2160
|
-
</td>
|
|
2161
|
-
</tr>
|
|
2162
|
-
</table>
|
|
2163
|
-
</div>
|
|
2164
|
-
|
|
2165
|
-
<div class="method_details ">
|
|
2166
|
-
<h3 class="signature " id="sanitize_filename-instance_method">
|
|
2167
|
-
|
|
2168
|
-
#<strong>sanitize_filename</strong>(filename) ⇒ <tt>String</tt>
|
|
2169
|
-
|
|
2170
|
-
|
|
2171
|
-
|
|
2172
|
-
|
|
2173
|
-
|
|
2174
|
-
</h3><div class="docstring">
|
|
2175
|
-
<div class="discussion">
|
|
2176
|
-
|
|
2177
|
-
<p>Sanitize filename by removing path. e.g. ../../sun.gif becomes sun.gif</p>
|
|
2178
|
-
|
|
2179
|
-
|
|
2180
|
-
</div>
|
|
2181
|
-
</div>
|
|
2182
|
-
<div class="tags">
|
|
2183
|
-
<p class="tag_title">Parameters:</p>
|
|
2184
|
-
<ul class="param">
|
|
2185
|
-
|
|
2186
|
-
<li>
|
|
2187
|
-
|
|
2188
|
-
<span class='name'>filename</span>
|
|
2189
|
-
|
|
2190
|
-
|
|
2191
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
2192
|
-
|
|
2193
|
-
|
|
2194
|
-
|
|
2195
|
-
—
|
|
2196
|
-
<div class='inline'>
|
|
2197
|
-
<p>the filename to be sanitized</p>
|
|
2198
|
-
</div>
|
|
2199
|
-
|
|
2200
|
-
</li>
|
|
2201
|
-
|
|
2202
|
-
</ul>
|
|
2203
|
-
|
|
2204
|
-
<p class="tag_title">Returns:</p>
|
|
2205
|
-
<ul class="return">
|
|
2206
|
-
|
|
2207
|
-
<li>
|
|
2208
|
-
|
|
2209
|
-
|
|
2210
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
2211
|
-
|
|
2212
|
-
|
|
2213
|
-
|
|
2214
|
-
—
|
|
2215
|
-
<div class='inline'>
|
|
2216
|
-
<p>the sanitized filename</p>
|
|
2217
|
-
</div>
|
|
2218
|
-
|
|
2219
|
-
</li>
|
|
2220
|
-
|
|
2221
|
-
</ul>
|
|
2222
|
-
|
|
2223
|
-
</div><table class="source_code">
|
|
2224
|
-
<tr>
|
|
2225
|
-
<td>
|
|
2226
|
-
<pre class="lines">
|
|
2227
|
-
|
|
2228
|
-
|
|
2229
|
-
260
|
|
2230
|
-
261
|
|
2231
|
-
262</pre>
|
|
2232
|
-
</td>
|
|
2233
|
-
<td>
|
|
2234
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 260</span>
|
|
2235
|
-
|
|
2236
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_sanitize_filename'>sanitize_filename</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='rparen'>)</span>
|
|
2237
|
-
<span class='id identifier rubyid_filename'>filename</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'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
2238
|
-
<span class='kw'>end</span></pre>
|
|
2239
|
-
</td>
|
|
2240
|
-
</tr>
|
|
2241
|
-
</table>
|
|
2242
|
-
</div>
|
|
2243
|
-
|
|
2244
|
-
<div class="method_details ">
|
|
2245
|
-
<h3 class="signature " id="select_header_accept-instance_method">
|
|
2246
|
-
|
|
2247
|
-
#<strong>select_header_accept</strong>(accepts) ⇒ <tt>String</tt>
|
|
2248
|
-
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
|
|
2252
|
-
|
|
2253
|
-
</h3><div class="docstring">
|
|
2254
|
-
<div class="discussion">
|
|
2255
|
-
|
|
2256
|
-
<p>Return Accept header based on an array of accepts provided.</p>
|
|
2257
|
-
|
|
2258
|
-
|
|
2259
|
-
</div>
|
|
2260
|
-
</div>
|
|
2261
|
-
<div class="tags">
|
|
2262
|
-
<p class="tag_title">Parameters:</p>
|
|
2263
|
-
<ul class="param">
|
|
2264
|
-
|
|
2265
|
-
<li>
|
|
2266
|
-
|
|
2267
|
-
<span class='name'>accepts</span>
|
|
2268
|
-
|
|
2269
|
-
|
|
2270
|
-
<span class='type'>(<tt>Array</tt>)</span>
|
|
2271
|
-
|
|
2272
|
-
|
|
2273
|
-
|
|
2274
|
-
—
|
|
2275
|
-
<div class='inline'>
|
|
2276
|
-
<p>array for Accept</p>
|
|
2277
|
-
</div>
|
|
2278
|
-
|
|
2279
|
-
</li>
|
|
2280
|
-
|
|
2281
|
-
</ul>
|
|
2282
|
-
|
|
2283
|
-
<p class="tag_title">Returns:</p>
|
|
2284
|
-
<ul class="return">
|
|
2285
|
-
|
|
2286
|
-
<li>
|
|
2287
|
-
|
|
2288
|
-
|
|
2289
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
2290
|
-
|
|
2291
|
-
|
|
2292
|
-
|
|
2293
|
-
—
|
|
2294
|
-
<div class='inline'>
|
|
2295
|
-
<p>the Accept header (e.g. application/json)</p>
|
|
2296
|
-
</div>
|
|
2297
|
-
|
|
2298
|
-
</li>
|
|
2299
|
-
|
|
2300
|
-
</ul>
|
|
2301
|
-
|
|
2302
|
-
</div><table class="source_code">
|
|
2303
|
-
<tr>
|
|
2304
|
-
<td>
|
|
2305
|
-
<pre class="lines">
|
|
2306
|
-
|
|
2307
|
-
|
|
2308
|
-
326
|
|
2309
|
-
327
|
|
2310
|
-
328
|
|
2311
|
-
329
|
|
2312
|
-
330
|
|
2313
|
-
331</pre>
|
|
2314
|
-
</td>
|
|
2315
|
-
<td>
|
|
2316
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 326</span>
|
|
2317
|
-
|
|
2318
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_select_header_accept'>select_header_accept</span><span class='lparen'>(</span><span class='id identifier rubyid_accepts'>accepts</span><span class='rparen'>)</span>
|
|
2319
|
-
<span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_accepts'>accepts</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_accepts'>accepts</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
|
2320
|
-
<span class='comment'># use JSON when present, otherwise use all of the provided
|
|
2321
|
-
</span> <span class='id identifier rubyid_json_accept'>json_accept</span> <span class='op'>=</span> <span class='id identifier rubyid_accepts'>accepts</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span> <span class='id identifier rubyid_json_mime?'>json_mime?</span><span class='lparen'>(</span><span class='id identifier rubyid_s'>s</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
2322
|
-
<span class='kw'>return</span> <span class='id identifier rubyid_json_accept'>json_accept</span> <span class='op'>||</span> <span class='id identifier rubyid_accepts'>accepts</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>,</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
|
2323
|
-
<span class='kw'>end</span></pre>
|
|
2324
|
-
</td>
|
|
2325
|
-
</tr>
|
|
2326
|
-
</table>
|
|
2327
|
-
</div>
|
|
2328
|
-
|
|
2329
|
-
<div class="method_details ">
|
|
2330
|
-
<h3 class="signature " id="select_header_content_type-instance_method">
|
|
2331
|
-
|
|
2332
|
-
#<strong>select_header_content_type</strong>(content_types) ⇒ <tt>String</tt>
|
|
2333
|
-
|
|
2334
|
-
|
|
2335
|
-
|
|
2336
|
-
|
|
2337
|
-
|
|
2338
|
-
</h3><div class="docstring">
|
|
2339
|
-
<div class="discussion">
|
|
2340
|
-
|
|
2341
|
-
<p>Return Content-Type header based on an array of content types provided.</p>
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
</div>
|
|
2345
|
-
</div>
|
|
2346
|
-
<div class="tags">
|
|
2347
|
-
<p class="tag_title">Parameters:</p>
|
|
2348
|
-
<ul class="param">
|
|
2349
|
-
|
|
2350
|
-
<li>
|
|
2351
|
-
|
|
2352
|
-
<span class='name'>content_types</span>
|
|
2353
|
-
|
|
2354
|
-
|
|
2355
|
-
<span class='type'>(<tt>Array</tt>)</span>
|
|
2356
|
-
|
|
2357
|
-
|
|
2358
|
-
|
|
2359
|
-
—
|
|
2360
|
-
<div class='inline'>
|
|
2361
|
-
<p>array for Content-Type</p>
|
|
2362
|
-
</div>
|
|
2363
|
-
|
|
2364
|
-
</li>
|
|
2365
|
-
|
|
2366
|
-
</ul>
|
|
2367
|
-
|
|
2368
|
-
<p class="tag_title">Returns:</p>
|
|
2369
|
-
<ul class="return">
|
|
2370
|
-
|
|
2371
|
-
<li>
|
|
2372
|
-
|
|
2373
|
-
|
|
2374
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
2375
|
-
|
|
2376
|
-
|
|
2377
|
-
|
|
2378
|
-
—
|
|
2379
|
-
<div class='inline'>
|
|
2380
|
-
<p>the Content-Type header (e.g. application/json)</p>
|
|
2381
|
-
</div>
|
|
2382
|
-
|
|
2383
|
-
</li>
|
|
2384
|
-
|
|
2385
|
-
</ul>
|
|
2386
|
-
|
|
2387
|
-
</div><table class="source_code">
|
|
2388
|
-
<tr>
|
|
2389
|
-
<td>
|
|
2390
|
-
<pre class="lines">
|
|
2391
|
-
|
|
2392
|
-
|
|
2393
|
-
336
|
|
2394
|
-
337
|
|
2395
|
-
338
|
|
2396
|
-
339
|
|
2397
|
-
340
|
|
2398
|
-
341
|
|
2399
|
-
342</pre>
|
|
2400
|
-
</td>
|
|
2401
|
-
<td>
|
|
2402
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 336</span>
|
|
2403
|
-
|
|
2404
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_select_header_content_type'>select_header_content_type</span><span class='lparen'>(</span><span class='id identifier rubyid_content_types'>content_types</span><span class='rparen'>)</span>
|
|
2405
|
-
<span class='comment'># use application/json by default
|
|
2406
|
-
</span> <span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_content_types'>content_types</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_content_types'>content_types</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
|
2407
|
-
<span class='comment'># use JSON when present, otherwise use the first one
|
|
2408
|
-
</span> <span class='id identifier rubyid_json_content_type'>json_content_type</span> <span class='op'>=</span> <span class='id identifier rubyid_content_types'>content_types</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span> <span class='id identifier rubyid_json_mime?'>json_mime?</span><span class='lparen'>(</span><span class='id identifier rubyid_s'>s</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
2409
|
-
<span class='kw'>return</span> <span class='id identifier rubyid_json_content_type'>json_content_type</span> <span class='op'>||</span> <span class='id identifier rubyid_content_types'>content_types</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
|
|
2410
|
-
<span class='kw'>end</span></pre>
|
|
2411
|
-
</td>
|
|
2412
|
-
</tr>
|
|
2413
|
-
</table>
|
|
2414
|
-
</div>
|
|
2415
|
-
|
|
2416
|
-
<div class="method_details ">
|
|
2417
|
-
<h3 class="signature " id="update_params_for_auth!-instance_method">
|
|
2418
|
-
|
|
2419
|
-
#<strong>update_params_for_auth!</strong>(header_params, query_params, auth_names) ⇒ <tt>Object</tt>
|
|
2420
|
-
|
|
2421
|
-
|
|
2422
|
-
|
|
2423
|
-
|
|
2424
|
-
|
|
2425
|
-
</h3><div class="docstring">
|
|
2426
|
-
<div class="discussion">
|
|
2427
|
-
|
|
2428
|
-
<p>Update hearder and query params based on authentication settings.</p>
|
|
2429
|
-
|
|
2430
|
-
|
|
2431
|
-
</div>
|
|
2432
|
-
</div>
|
|
2433
|
-
<div class="tags">
|
|
2434
|
-
<p class="tag_title">Parameters:</p>
|
|
2435
|
-
<ul class="param">
|
|
2436
|
-
|
|
2437
|
-
<li>
|
|
2438
|
-
|
|
2439
|
-
<span class='name'>header_params</span>
|
|
2440
|
-
|
|
2441
|
-
|
|
2442
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
2443
|
-
|
|
2444
|
-
|
|
2445
|
-
|
|
2446
|
-
—
|
|
2447
|
-
<div class='inline'>
|
|
2448
|
-
<p>Header parameters</p>
|
|
2449
|
-
</div>
|
|
2450
|
-
|
|
2451
|
-
</li>
|
|
2452
|
-
|
|
2453
|
-
<li>
|
|
2454
|
-
|
|
2455
|
-
<span class='name'>query_params</span>
|
|
2456
|
-
|
|
2457
|
-
|
|
2458
|
-
<span class='type'>(<tt>Hash</tt>)</span>
|
|
2459
|
-
|
|
2460
|
-
|
|
2461
|
-
|
|
2462
|
-
—
|
|
2463
|
-
<div class='inline'>
|
|
2464
|
-
<p>Query parameters</p>
|
|
2465
|
-
</div>
|
|
2466
|
-
|
|
2467
|
-
</li>
|
|
2468
|
-
|
|
2469
|
-
<li>
|
|
2470
|
-
|
|
2471
|
-
<span class='name'>auth_names</span>
|
|
2472
|
-
|
|
2473
|
-
|
|
2474
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
2475
|
-
|
|
2476
|
-
|
|
2477
|
-
|
|
2478
|
-
—
|
|
2479
|
-
<div class='inline'>
|
|
2480
|
-
<p>Authentication scheme name</p>
|
|
2481
|
-
</div>
|
|
2482
|
-
|
|
2483
|
-
</li>
|
|
2484
|
-
|
|
2485
|
-
</ul>
|
|
2486
|
-
|
|
2487
|
-
|
|
2488
|
-
</div><table class="source_code">
|
|
2489
|
-
<tr>
|
|
2490
|
-
<td>
|
|
2491
|
-
<pre class="lines">
|
|
2492
|
-
|
|
2493
|
-
|
|
2494
|
-
303
|
|
2495
|
-
304
|
|
2496
|
-
305
|
|
2497
|
-
306
|
|
2498
|
-
307
|
|
2499
|
-
308
|
|
2500
|
-
309
|
|
2501
|
-
310
|
|
2502
|
-
311
|
|
2503
|
-
312
|
|
2504
|
-
313</pre>
|
|
2505
|
-
</td>
|
|
2506
|
-
<td>
|
|
2507
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 303</span>
|
|
2508
|
-
|
|
2509
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update_params_for_auth!'>update_params_for_auth!</span><span class='lparen'>(</span><span class='id identifier rubyid_header_params'>header_params</span><span class='comma'>,</span> <span class='id identifier rubyid_query_params'>query_params</span><span class='comma'>,</span> <span class='id identifier rubyid_auth_names'>auth_names</span><span class='rparen'>)</span>
|
|
2510
|
-
<span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_auth_names'>auth_names</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_auth_name'>auth_name</span><span class='op'>|</span>
|
|
2511
|
-
<span class='id identifier rubyid_auth_setting'>auth_setting</span> <span class='op'>=</span> <span class='ivar'>@config</span><span class='period'>.</span><span class='id identifier rubyid_auth_settings'>auth_settings</span><span class='lbracket'>[</span><span class='id identifier rubyid_auth_name'>auth_name</span><span class='rbracket'>]</span>
|
|
2512
|
-
<span class='kw'>next</span> <span class='kw'>unless</span> <span class='id identifier rubyid_auth_setting'>auth_setting</span>
|
|
2513
|
-
<span class='kw'>case</span> <span class='id identifier rubyid_auth_setting'>auth_setting</span><span class='lbracket'>[</span><span class='symbol'>:in</span><span class='rbracket'>]</span>
|
|
2514
|
-
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>header</span><span class='tstring_end'>'</span></span> <span class='kw'>then</span> <span class='id identifier rubyid_header_params'>header_params</span><span class='lbracket'>[</span><span class='id identifier rubyid_auth_setting'>auth_setting</span><span class='lbracket'>[</span><span class='symbol'>:key</span><span class='rbracket'>]</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_auth_setting'>auth_setting</span><span class='lbracket'>[</span><span class='symbol'>:value</span><span class='rbracket'>]</span>
|
|
2515
|
-
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>query</span><span class='tstring_end'>'</span></span> <span class='kw'>then</span> <span class='id identifier rubyid_query_params'>query_params</span><span class='lbracket'>[</span><span class='id identifier rubyid_auth_setting'>auth_setting</span><span class='lbracket'>[</span><span class='symbol'>:key</span><span class='rbracket'>]</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_auth_setting'>auth_setting</span><span class='lbracket'>[</span><span class='symbol'>:value</span><span class='rbracket'>]</span>
|
|
2516
|
-
<span class='kw'>else</span> <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Authentication token must be in `query` of `header`</span><span class='tstring_end'>'</span></span>
|
|
2517
|
-
<span class='kw'>end</span>
|
|
2518
|
-
<span class='kw'>end</span>
|
|
2519
|
-
<span class='kw'>end</span></pre>
|
|
2520
|
-
</td>
|
|
2521
|
-
</tr>
|
|
2522
|
-
</table>
|
|
2523
|
-
</div>
|
|
2524
|
-
|
|
2525
|
-
<div class="method_details ">
|
|
2526
|
-
<h3 class="signature " id="user_agent=-instance_method">
|
|
2527
|
-
|
|
2528
|
-
#<strong>user_agent=</strong>(user_agent) ⇒ <tt>Object</tt>
|
|
2529
|
-
|
|
2530
|
-
|
|
2531
|
-
|
|
2532
|
-
|
|
2533
|
-
|
|
2534
|
-
</h3><div class="docstring">
|
|
2535
|
-
<div class="discussion">
|
|
2536
|
-
|
|
2537
|
-
<p>Sets user agent in HTTP header</p>
|
|
2538
|
-
|
|
2539
|
-
|
|
2540
|
-
</div>
|
|
2541
|
-
</div>
|
|
2542
|
-
<div class="tags">
|
|
2543
|
-
<p class="tag_title">Parameters:</p>
|
|
2544
|
-
<ul class="param">
|
|
2545
|
-
|
|
2546
|
-
<li>
|
|
2547
|
-
|
|
2548
|
-
<span class='name'>user_agent</span>
|
|
2549
|
-
|
|
2550
|
-
|
|
2551
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
2552
|
-
|
|
2553
|
-
|
|
2554
|
-
|
|
2555
|
-
—
|
|
2556
|
-
<div class='inline'>
|
|
2557
|
-
<p>User agent (e.g. swagger-codegen/ruby/1.0.0)</p>
|
|
2558
|
-
</div>
|
|
2559
|
-
|
|
2560
|
-
</li>
|
|
2561
|
-
|
|
2562
|
-
</ul>
|
|
2563
|
-
|
|
2564
|
-
|
|
2565
|
-
</div><table class="source_code">
|
|
2566
|
-
<tr>
|
|
2567
|
-
<td>
|
|
2568
|
-
<pre class="lines">
|
|
2569
|
-
|
|
2570
|
-
|
|
2571
|
-
318
|
|
2572
|
-
319
|
|
2573
|
-
320
|
|
2574
|
-
321</pre>
|
|
2575
|
-
</td>
|
|
2576
|
-
<td>
|
|
2577
|
-
<pre class="code"><span class="info file"># File 'lib/treezor_client/api_client.rb', line 318</span>
|
|
2578
|
-
|
|
2579
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_user_agent='>user_agent=</span><span class='lparen'>(</span><span class='id identifier rubyid_user_agent'>user_agent</span><span class='rparen'>)</span>
|
|
2580
|
-
<span class='ivar'>@user_agent</span> <span class='op'>=</span> <span class='id identifier rubyid_user_agent'>user_agent</span>
|
|
2581
|
-
<span class='ivar'>@default_headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>User-Agent</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@user_agent</span>
|
|
2582
|
-
<span class='kw'>end</span></pre>
|
|
2583
|
-
</td>
|
|
2584
|
-
</tr>
|
|
2585
|
-
</table>
|
|
2586
|
-
</div>
|
|
2587
|
-
|
|
2588
|
-
</div>
|
|
2589
|
-
|
|
2590
|
-
</div>
|
|
2591
|
-
|
|
2592
|
-
<div id="footer">
|
|
2593
|
-
Generated on Wed Aug 8 17:38:59 2018 by
|
|
2594
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2595
|
-
0.9.15 (ruby-2.5.1).
|
|
2596
|
-
</div>
|
|
2597
|
-
|
|
2598
|
-
</div>
|
|
2599
|
-
</body>
|
|
2600
|
-
</html>
|