approveapi_swagger 1.0.3 → 1.0.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +4 -4
- data/docs/AnswerMetadata.md +1 -1
- data/docs/CreatePromptRequest.md +6 -4
- data/docs/Prompt.md +3 -2
- data/docs/PromptAnswer.md +1 -1
- data/docs/PromptMetadata.md +2 -2
- data/lib/approveapi_swagger/api/approve_api.rb +0 -1
- data/lib/approveapi_swagger/models/answer_metadata.rb +13 -15
- data/lib/approveapi_swagger/models/create_prompt_request.rb +68 -49
- data/lib/approveapi_swagger/models/error.rb +0 -2
- data/lib/approveapi_swagger/models/prompt.rb +31 -19
- data/lib/approveapi_swagger/models/prompt_answer.rb +16 -18
- data/lib/approveapi_swagger/models/prompt_metadata.rb +24 -26
- data/lib/approveapi_swagger/models/prompt_status.rb +0 -2
- data/lib/approveapi_swagger/version.rb +1 -1
- data/pkg/approveapi_swagger-1.0.1.gem +0 -0
- data/pkg/approveapi_swagger-1.0.6.gem +0 -0
- metadata +9 -79
- data/doc/ApproveAPISwagger.html +0 -185
- data/doc/ApproveAPISwagger/AnswerMetadata.html +0 -789
- data/doc/ApproveAPISwagger/ApiClient.html +0 -1032
- data/doc/ApproveAPISwagger/ApiError.html +0 -224
- data/doc/ApproveAPISwagger/ApproveApi.html +0 -501
- data/doc/ApproveAPISwagger/Configuration.html +0 -941
- data/doc/ApproveAPISwagger/CreatePromptRequest.html +0 -879
- data/doc/ApproveAPISwagger/Error.html +0 -754
- data/doc/ApproveAPISwagger/Prompt.html +0 -819
- data/doc/ApproveAPISwagger/PromptAnswer.html +0 -799
- data/doc/ApproveAPISwagger/PromptMetadata.html +0 -829
- data/doc/ApproveAPISwagger/PromptStatus.html +0 -754
- data/doc/Gemfile.html +0 -120
- data/doc/Gemfile_lock.html +0 -194
- data/doc/README_md.html +0 -225
- data/doc/Rakefile.html +0 -125
- data/doc/approveapi_swagger_gemspec.html +0 -161
- data/doc/created.rid +0 -39
- data/doc/css/fonts.css +0 -167
- data/doc/css/rdoc.css +0 -590
- data/doc/docs/AnswerMetadata_md.html +0 -123
- data/doc/docs/ApproveApi_md.html +0 -293
- data/doc/docs/CreatePromptRequest_md.html +0 -123
- data/doc/docs/Error_md.html +0 -123
- data/doc/docs/PromptAnswer_md.html +0 -123
- data/doc/docs/PromptMetadata_md.html +0 -123
- data/doc/docs/PromptStatus_md.html +0 -123
- data/doc/docs/Prompt_md.html +0 -123
- data/doc/fonts/Lato-Light.ttf +0 -0
- data/doc/fonts/Lato-LightItalic.ttf +0 -0
- data/doc/fonts/Lato-Regular.ttf +0 -0
- data/doc/fonts/Lato-RegularItalic.ttf +0 -0
- data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
- data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
- data/doc/git_push_sh.html +0 -157
- data/doc/images/add.png +0 -0
- data/doc/images/arrow_up.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/loadingAnimation.gif +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/index.html +0 -141
- data/doc/js/darkfish.js +0 -161
- data/doc/js/jquery.js +0 -4
- data/doc/js/navigation.js +0 -141
- data/doc/js/navigation.js.gz +0 -0
- data/doc/js/search.js +0 -109
- data/doc/js/search_index.js +0 -1
- data/doc/js/search_index.js.gz +0 -0
- data/doc/js/searcher.js +0 -229
- data/doc/js/searcher.js.gz +0 -0
- data/doc/table_of_contents.html +0 -1036
- data/pkg/approveapi_swagger-1.0.2.gem +0 -0
|
@@ -1,1032 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
|
|
3
|
-
<html>
|
|
4
|
-
<head>
|
|
5
|
-
<meta charset="UTF-8">
|
|
6
|
-
|
|
7
|
-
<title>class ApproveAPISwagger::ApiClient - RDoc Documentation</title>
|
|
8
|
-
|
|
9
|
-
<script type="text/javascript">
|
|
10
|
-
var rdoc_rel_prefix = "../";
|
|
11
|
-
var index_rel_prefix = "../";
|
|
12
|
-
</script>
|
|
13
|
-
|
|
14
|
-
<script src="../js/jquery.js"></script>
|
|
15
|
-
<script src="../js/darkfish.js"></script>
|
|
16
|
-
|
|
17
|
-
<link href="../css/fonts.css" rel="stylesheet">
|
|
18
|
-
<link href="../css/rdoc.css" rel="stylesheet">
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
<body id="top" role="document" class="class">
|
|
24
|
-
<nav role="navigation">
|
|
25
|
-
<div id="project-navigation">
|
|
26
|
-
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
27
|
-
<h2>
|
|
28
|
-
<a href="../index.html" rel="home">Home</a>
|
|
29
|
-
</h2>
|
|
30
|
-
|
|
31
|
-
<div id="table-of-contents-navigation">
|
|
32
|
-
<a href="../table_of_contents.html#pages">Pages</a>
|
|
33
|
-
<a href="../table_of_contents.html#classes">Classes</a>
|
|
34
|
-
<a href="../table_of_contents.html#methods">Methods</a>
|
|
35
|
-
</div>
|
|
36
|
-
</div>
|
|
37
|
-
|
|
38
|
-
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
39
|
-
<form action="#" method="get" accept-charset="utf-8">
|
|
40
|
-
<div id="search-field-wrapper">
|
|
41
|
-
<input id="search-field" role="combobox" aria-label="Search"
|
|
42
|
-
aria-autocomplete="list" aria-controls="search-results"
|
|
43
|
-
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
44
|
-
title="Type to search, Up and Down to navigate, Enter to load">
|
|
45
|
-
</div>
|
|
46
|
-
|
|
47
|
-
<ul id="search-results" aria-label="Search Results"
|
|
48
|
-
aria-busy="false" aria-expanded="false"
|
|
49
|
-
aria-atomic="false" class="initially-hidden"></ul>
|
|
50
|
-
</form>
|
|
51
|
-
</div>
|
|
52
|
-
|
|
53
|
-
</div>
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
<div id="class-metadata">
|
|
58
|
-
|
|
59
|
-
<div id="parent-class-section" class="nav-section">
|
|
60
|
-
<h3>Parent</h3>
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
<p class="link">Object
|
|
64
|
-
|
|
65
|
-
</div>
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
<!-- Method Quickref -->
|
|
70
|
-
<div id="method-list-section" class="nav-section">
|
|
71
|
-
<h3>Methods</h3>
|
|
72
|
-
|
|
73
|
-
<ul class="link-list" role="directory">
|
|
74
|
-
|
|
75
|
-
<li ><a href="#method-c-default">::default</a>
|
|
76
|
-
|
|
77
|
-
<li ><a href="#method-c-new">::new</a>
|
|
78
|
-
|
|
79
|
-
<li ><a href="#method-i-build_collection_param">#build_collection_param</a>
|
|
80
|
-
|
|
81
|
-
<li ><a href="#method-i-build_request">#build_request</a>
|
|
82
|
-
|
|
83
|
-
<li ><a href="#method-i-build_request_body">#build_request_body</a>
|
|
84
|
-
|
|
85
|
-
<li ><a href="#method-i-build_request_url">#build_request_url</a>
|
|
86
|
-
|
|
87
|
-
<li ><a href="#method-i-call_api">#call_api</a>
|
|
88
|
-
|
|
89
|
-
<li ><a href="#method-i-convert_to_type">#convert_to_type</a>
|
|
90
|
-
|
|
91
|
-
<li ><a href="#method-i-deserialize">#deserialize</a>
|
|
92
|
-
|
|
93
|
-
<li ><a href="#method-i-download_file">#download_file</a>
|
|
94
|
-
|
|
95
|
-
<li ><a href="#method-i-json_mime-3F">#json_mime?</a>
|
|
96
|
-
|
|
97
|
-
<li ><a href="#method-i-object_to_hash">#object_to_hash</a>
|
|
98
|
-
|
|
99
|
-
<li ><a href="#method-i-object_to_http_body">#object_to_http_body</a>
|
|
100
|
-
|
|
101
|
-
<li ><a href="#method-i-sanitize_filename">#sanitize_filename</a>
|
|
102
|
-
|
|
103
|
-
<li ><a href="#method-i-select_header_accept">#select_header_accept</a>
|
|
104
|
-
|
|
105
|
-
<li ><a href="#method-i-select_header_content_type">#select_header_content_type</a>
|
|
106
|
-
|
|
107
|
-
<li ><a href="#method-i-update_params_for_auth-21">#update_params_for_auth!</a>
|
|
108
|
-
|
|
109
|
-
<li ><a href="#method-i-user_agent-3D">#user_agent=</a>
|
|
110
|
-
|
|
111
|
-
</ul>
|
|
112
|
-
</div>
|
|
113
|
-
|
|
114
|
-
</div>
|
|
115
|
-
</nav>
|
|
116
|
-
|
|
117
|
-
<main role="main" aria-labelledby="class-ApproveAPISwagger::ApiClient">
|
|
118
|
-
<h1 id="class-ApproveAPISwagger::ApiClient" class="class">
|
|
119
|
-
class ApproveAPISwagger::ApiClient
|
|
120
|
-
</h1>
|
|
121
|
-
|
|
122
|
-
<section class="description">
|
|
123
|
-
|
|
124
|
-
</section>
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
<section id="5Buntitled-5D" class="documentation-section">
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
<section class="attribute-method-details" class="method-section">
|
|
136
|
-
<header>
|
|
137
|
-
<h3>Attributes</h3>
|
|
138
|
-
</header>
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
<div id="attribute-i-config" class="method-detail">
|
|
142
|
-
<div class="method-heading attribute-method-heading">
|
|
143
|
-
<span class="method-name">config</span><span
|
|
144
|
-
class="attribute-access-type">[RW]</span>
|
|
145
|
-
</div>
|
|
146
|
-
|
|
147
|
-
<div class="method-description">
|
|
148
|
-
|
|
149
|
-
<p>The <a href="Configuration.html"><code>Configuration</code></a> object holding settings to be used in the API client.</p>
|
|
150
|
-
|
|
151
|
-
</div>
|
|
152
|
-
</div>
|
|
153
|
-
|
|
154
|
-
<div id="attribute-i-default_headers" class="method-detail">
|
|
155
|
-
<div class="method-heading attribute-method-heading">
|
|
156
|
-
<span class="method-name">default_headers</span><span
|
|
157
|
-
class="attribute-access-type">[RW]</span>
|
|
158
|
-
</div>
|
|
159
|
-
|
|
160
|
-
<div class="method-description">
|
|
161
|
-
|
|
162
|
-
<p>Defines the headers to be used in HTTP requests of all API calls by default.</p>
|
|
163
|
-
|
|
164
|
-
<p>@return [Hash]</p>
|
|
165
|
-
|
|
166
|
-
</div>
|
|
167
|
-
</div>
|
|
168
|
-
|
|
169
|
-
</section>
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
174
|
-
<header>
|
|
175
|
-
<h3>Public Class Methods</h3>
|
|
176
|
-
</header>
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
<div id="method-c-default" class="method-detail ">
|
|
180
|
-
|
|
181
|
-
<div class="method-heading">
|
|
182
|
-
<span class="method-name">default</span><span
|
|
183
|
-
class="method-args">()</span>
|
|
184
|
-
|
|
185
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
186
|
-
|
|
187
|
-
</div>
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
<div class="method-description">
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
<div class="method-source-code" id="default-source">
|
|
198
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 41</span>
|
|
199
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">default</span>
|
|
200
|
-
<span class="ruby-identifier">@@default</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">ApiClient</span>.<span class="ruby-identifier">new</span>
|
|
201
|
-
<span class="ruby-keyword">end</span></pre>
|
|
202
|
-
</div>
|
|
203
|
-
|
|
204
|
-
</div>
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
</div>
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
<div id="method-c-new" class="method-detail ">
|
|
213
|
-
|
|
214
|
-
<div class="method-heading">
|
|
215
|
-
<span class="method-name">new</span><span
|
|
216
|
-
class="method-args">(config = Configuration.default)</span>
|
|
217
|
-
|
|
218
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
219
|
-
|
|
220
|
-
</div>
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
<div class="method-description">
|
|
224
|
-
|
|
225
|
-
<p>Initializes the <a href="ApiClient.html"><code>ApiClient</code></a> @option config [Configuration] <a href="Configuration.html"><code>Configuration</code></a> for initializing the object, default to <a href="Configuration.html#method-c-default"><code>Configuration.default</code></a></p>
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
<div class="method-source-code" id="new-source">
|
|
231
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 32</span>
|
|
232
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">config</span> = <span class="ruby-constant">Configuration</span>.<span class="ruby-identifier">default</span>)
|
|
233
|
-
<span class="ruby-ivar">@config</span> = <span class="ruby-identifier">config</span>
|
|
234
|
-
<span class="ruby-ivar">@user_agent</span> = <span class="ruby-node">"OpenAPI-Generator/#{VERSION}/ruby"</span>
|
|
235
|
-
<span class="ruby-ivar">@default_headers</span> = {
|
|
236
|
-
<span class="ruby-string">'Content-Type'</span> <span class="ruby-operator">=></span> <span class="ruby-string">'application/json'</span>,
|
|
237
|
-
<span class="ruby-string">'User-Agent'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@user_agent</span>
|
|
238
|
-
}
|
|
239
|
-
<span class="ruby-keyword">end</span></pre>
|
|
240
|
-
</div>
|
|
241
|
-
|
|
242
|
-
</div>
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
</div>
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
</section>
|
|
251
|
-
|
|
252
|
-
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
253
|
-
<header>
|
|
254
|
-
<h3>Public Instance Methods</h3>
|
|
255
|
-
</header>
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
<div id="method-i-build_collection_param" class="method-detail ">
|
|
259
|
-
|
|
260
|
-
<div class="method-heading">
|
|
261
|
-
<span class="method-name">build_collection_param</span><span
|
|
262
|
-
class="method-args">(param, collection_format)</span>
|
|
263
|
-
|
|
264
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
265
|
-
|
|
266
|
-
</div>
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
<div class="method-description">
|
|
270
|
-
|
|
271
|
-
<p>Build parameter value according to the given collection format. @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi</p>
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
<div class="method-source-code" id="build_collection_param-source">
|
|
277
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 369</span>
|
|
278
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_collection_param</span>(<span class="ruby-identifier">param</span>, <span class="ruby-identifier">collection_format</span>)
|
|
279
|
-
<span class="ruby-keyword">case</span> <span class="ruby-identifier">collection_format</span>
|
|
280
|
-
<span class="ruby-keyword">when</span> <span class="ruby-value">:csv</span>
|
|
281
|
-
<span class="ruby-identifier">param</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">','</span>)
|
|
282
|
-
<span class="ruby-keyword">when</span> <span class="ruby-value">:ssv</span>
|
|
283
|
-
<span class="ruby-identifier">param</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">' '</span>)
|
|
284
|
-
<span class="ruby-keyword">when</span> <span class="ruby-value">:tsv</span>
|
|
285
|
-
<span class="ruby-identifier">param</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"\t"</span>)
|
|
286
|
-
<span class="ruby-keyword">when</span> <span class="ruby-value">:pipes</span>
|
|
287
|
-
<span class="ruby-identifier">param</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">'|'</span>)
|
|
288
|
-
<span class="ruby-keyword">when</span> <span class="ruby-value">:multi</span>
|
|
289
|
-
<span class="ruby-comment"># return the array directly as typhoeus will handle it as expected</span>
|
|
290
|
-
<span class="ruby-identifier">param</span>
|
|
291
|
-
<span class="ruby-keyword">else</span>
|
|
292
|
-
<span class="ruby-identifier">fail</span> <span class="ruby-node">"unknown collection format: #{collection_format.inspect}"</span>
|
|
293
|
-
<span class="ruby-keyword">end</span>
|
|
294
|
-
<span class="ruby-keyword">end</span></pre>
|
|
295
|
-
</div>
|
|
296
|
-
|
|
297
|
-
</div>
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
</div>
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
<div id="method-i-build_request" class="method-detail ">
|
|
306
|
-
|
|
307
|
-
<div class="method-heading">
|
|
308
|
-
<span class="method-name">build_request</span><span
|
|
309
|
-
class="method-args">(http_method, path, opts = {})</span>
|
|
310
|
-
|
|
311
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
312
|
-
|
|
313
|
-
</div>
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
<div class="method-description">
|
|
317
|
-
|
|
318
|
-
<p>Builds the HTTP request</p>
|
|
319
|
-
|
|
320
|
-
<p>@param [String] http_method HTTP method/verb (e.g. POST) @param [String] path URL path (e.g. /account/new) @option opts [Hash] :header_params Header parameters @option opts [Hash] :query_params Query parameters @option opts [Hash] :form_params Query parameters @option opts [Object] :body HTTP body (JSON/XML) @return [Typhoeus::Request] A Typhoeus Request</p>
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
<div class="method-source-code" id="build_request-source">
|
|
326
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 89</span>
|
|
327
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_request</span>(<span class="ruby-identifier">http_method</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">opts</span> = {})
|
|
328
|
-
<span class="ruby-identifier">url</span> = <span class="ruby-identifier">build_request_url</span>(<span class="ruby-identifier">path</span>)
|
|
329
|
-
<span class="ruby-identifier">http_method</span> = <span class="ruby-identifier">http_method</span>.<span class="ruby-identifier">to_sym</span>.<span class="ruby-identifier">downcase</span>
|
|
330
|
-
|
|
331
|
-
<span class="ruby-identifier">header_params</span> = <span class="ruby-ivar">@default_headers</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">opts</span>[<span class="ruby-value">:header_params</span>] <span class="ruby-operator">||</span> {})
|
|
332
|
-
<span class="ruby-identifier">query_params</span> = <span class="ruby-identifier">opts</span>[<span class="ruby-value">:query_params</span>] <span class="ruby-operator">||</span> {}
|
|
333
|
-
<span class="ruby-identifier">form_params</span> = <span class="ruby-identifier">opts</span>[<span class="ruby-value">:form_params</span>] <span class="ruby-operator">||</span> {}
|
|
334
|
-
|
|
335
|
-
<span class="ruby-identifier">update_params_for_auth!</span> <span class="ruby-identifier">header_params</span>, <span class="ruby-identifier">query_params</span>, <span class="ruby-identifier">opts</span>[<span class="ruby-value">:auth_names</span>]
|
|
336
|
-
|
|
337
|
-
<span class="ruby-comment"># set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)</span>
|
|
338
|
-
<span class="ruby-identifier">_verify_ssl_host</span> = <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">verify_ssl_host</span> <span class="ruby-operator">?</span> <span class="ruby-value">2</span> <span class="ruby-operator">:</span> <span class="ruby-value">0</span>
|
|
339
|
-
|
|
340
|
-
<span class="ruby-identifier">req_opts</span> = {
|
|
341
|
-
<span class="ruby-value">:method</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">http_method</span>,
|
|
342
|
-
<span class="ruby-value">:headers</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">header_params</span>,
|
|
343
|
-
<span class="ruby-value">:params</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">query_params</span>,
|
|
344
|
-
<span class="ruby-value">:params_encoding</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">params_encoding</span>,
|
|
345
|
-
<span class="ruby-value">:timeout</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">timeout</span>,
|
|
346
|
-
<span class="ruby-value">:ssl_verifypeer</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">verify_ssl</span>,
|
|
347
|
-
<span class="ruby-value">:ssl_verifyhost</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">_verify_ssl_host</span>,
|
|
348
|
-
<span class="ruby-value">:sslcert</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">cert_file</span>,
|
|
349
|
-
<span class="ruby-value">:sslkey</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">key_file</span>,
|
|
350
|
-
<span class="ruby-value">:verbose</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">debugging</span>
|
|
351
|
-
}
|
|
352
|
-
|
|
353
|
-
<span class="ruby-comment"># set custom cert, if provided</span>
|
|
354
|
-
<span class="ruby-identifier">req_opts</span>[<span class="ruby-value">:cainfo</span>] = <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">ssl_ca_cert</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">ssl_ca_cert</span>
|
|
355
|
-
|
|
356
|
-
<span class="ruby-keyword">if</span> [<span class="ruby-value">:post</span>, <span class="ruby-value">:patch</span>, <span class="ruby-value">:put</span>, <span class="ruby-value">:delete</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">http_method</span>)
|
|
357
|
-
<span class="ruby-identifier">req_body</span> = <span class="ruby-identifier">build_request_body</span>(<span class="ruby-identifier">header_params</span>, <span class="ruby-identifier">form_params</span>, <span class="ruby-identifier">opts</span>[<span class="ruby-value">:body</span>])
|
|
358
|
-
<span class="ruby-identifier">req_opts</span>.<span class="ruby-identifier">update</span> <span class="ruby-value">:body</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">req_body</span>
|
|
359
|
-
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">debugging</span>
|
|
360
|
-
<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"</span>
|
|
361
|
-
<span class="ruby-keyword">end</span>
|
|
362
|
-
<span class="ruby-keyword">end</span>
|
|
363
|
-
|
|
364
|
-
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Typhoeus</span><span class="ruby-operator">::</span><span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">req_opts</span>)
|
|
365
|
-
<span class="ruby-identifier">download_file</span>(<span class="ruby-identifier">request</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:return_type</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'File'</span>
|
|
366
|
-
<span class="ruby-identifier">request</span>
|
|
367
|
-
<span class="ruby-keyword">end</span></pre>
|
|
368
|
-
</div>
|
|
369
|
-
|
|
370
|
-
</div>
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
</div>
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
<div id="method-i-build_request_body" class="method-detail ">
|
|
379
|
-
|
|
380
|
-
<div class="method-heading">
|
|
381
|
-
<span class="method-name">build_request_body</span><span
|
|
382
|
-
class="method-args">(header_params, form_params, body)</span>
|
|
383
|
-
|
|
384
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
385
|
-
|
|
386
|
-
</div>
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
<div class="method-description">
|
|
390
|
-
|
|
391
|
-
<p>Builds the HTTP request body</p>
|
|
392
|
-
|
|
393
|
-
<p>@param [Hash] header_params Header parameters @param [Hash] form_params Query parameters @param [Object] body HTTP body (JSON/XML) @return [String] HTTP body data in the form of string</p>
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
<div class="method-source-code" id="build_request_body-source">
|
|
399
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 274</span>
|
|
400
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_request_body</span>(<span class="ruby-identifier">header_params</span>, <span class="ruby-identifier">form_params</span>, <span class="ruby-identifier">body</span>)
|
|
401
|
-
<span class="ruby-comment"># http form</span>
|
|
402
|
-
<span class="ruby-keyword">if</span> <span class="ruby-identifier">header_params</span>[<span class="ruby-string">'Content-Type'</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'application/x-www-form-urlencoded'</span> <span class="ruby-operator">||</span>
|
|
403
|
-
<span class="ruby-identifier">header_params</span>[<span class="ruby-string">'Content-Type'</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'multipart/form-data'</span>
|
|
404
|
-
<span class="ruby-identifier">data</span> = {}
|
|
405
|
-
<span class="ruby-identifier">form_params</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
|
406
|
-
<span class="ruby-keyword">case</span> <span class="ruby-identifier">value</span>
|
|
407
|
-
<span class="ruby-keyword">when</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Array</span>, <span class="ruby-keyword">nil</span>
|
|
408
|
-
<span class="ruby-comment"># let typhoeus handle File, Array and nil parameters</span>
|
|
409
|
-
<span class="ruby-identifier">data</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span>
|
|
410
|
-
<span class="ruby-keyword">else</span>
|
|
411
|
-
<span class="ruby-identifier">data</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span>.<span class="ruby-identifier">to_s</span>
|
|
412
|
-
<span class="ruby-keyword">end</span>
|
|
413
|
-
<span class="ruby-keyword">end</span>
|
|
414
|
-
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">body</span>
|
|
415
|
-
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">body</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">body</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">body</span>.<span class="ruby-identifier">to_json</span>
|
|
416
|
-
<span class="ruby-keyword">else</span>
|
|
417
|
-
<span class="ruby-identifier">data</span> = <span class="ruby-keyword">nil</span>
|
|
418
|
-
<span class="ruby-keyword">end</span>
|
|
419
|
-
<span class="ruby-identifier">data</span>
|
|
420
|
-
<span class="ruby-keyword">end</span></pre>
|
|
421
|
-
</div>
|
|
422
|
-
|
|
423
|
-
</div>
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
</div>
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
<div id="method-i-build_request_url" class="method-detail ">
|
|
432
|
-
|
|
433
|
-
<div class="method-heading">
|
|
434
|
-
<span class="method-name">build_request_url</span><span
|
|
435
|
-
class="method-args">(path)</span>
|
|
436
|
-
|
|
437
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
438
|
-
|
|
439
|
-
</div>
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
<div class="method-description">
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
<div class="method-source-code" id="build_request_url-source">
|
|
450
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 262</span>
|
|
451
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_request_url</span>(<span class="ruby-identifier">path</span>)
|
|
452
|
-
<span class="ruby-comment"># Add leading and trailing slashes to path</span>
|
|
453
|
-
<span class="ruby-identifier">path</span> = <span class="ruby-node">"/#{path}"</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/\/+/</span>, <span class="ruby-string">'/'</span>)
|
|
454
|
-
<span class="ruby-constant">URI</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">base_url</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">path</span>)
|
|
455
|
-
<span class="ruby-keyword">end</span></pre>
|
|
456
|
-
</div>
|
|
457
|
-
|
|
458
|
-
</div>
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
</div>
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
<div id="method-i-call_api" class="method-detail ">
|
|
467
|
-
|
|
468
|
-
<div class="method-heading">
|
|
469
|
-
<span class="method-name">call_api</span><span
|
|
470
|
-
class="method-args">(http_method, path, opts = {})</span>
|
|
471
|
-
|
|
472
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
473
|
-
|
|
474
|
-
</div>
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
<div class="method-description">
|
|
478
|
-
|
|
479
|
-
<p>Call an API with given options.</p>
|
|
480
|
-
|
|
481
|
-
<p>@return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:</p>
|
|
482
|
-
|
|
483
|
-
<pre>the data deserialized from response body (could be nil), response status code and response headers.</pre>
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
<div class="method-source-code" id="call_api-source">
|
|
489
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 49</span>
|
|
490
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">call_api</span>(<span class="ruby-identifier">http_method</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">opts</span> = {})
|
|
491
|
-
<span class="ruby-identifier">request</span> = <span class="ruby-identifier">build_request</span>(<span class="ruby-identifier">http_method</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">opts</span>)
|
|
492
|
-
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">request</span>.<span class="ruby-identifier">run</span>
|
|
493
|
-
|
|
494
|
-
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">debugging</span>
|
|
495
|
-
<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"</span>
|
|
496
|
-
<span class="ruby-keyword">end</span>
|
|
497
|
-
|
|
498
|
-
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">success?</span>
|
|
499
|
-
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">timed_out?</span>
|
|
500
|
-
<span class="ruby-identifier">fail</span> <span class="ruby-constant">ApiError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'Connection timed out'</span>)
|
|
501
|
-
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
|
|
502
|
-
<span class="ruby-comment"># Errors from libcurl will be made visible here</span>
|
|
503
|
-
<span class="ruby-identifier">fail</span> <span class="ruby-constant">ApiError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:code</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>,
|
|
504
|
-
<span class="ruby-value">:message</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">return_message</span>)
|
|
505
|
-
<span class="ruby-keyword">else</span>
|
|
506
|
-
<span class="ruby-identifier">fail</span> <span class="ruby-constant">ApiError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:code</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span>,
|
|
507
|
-
<span class="ruby-value">:response_headers</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">headers</span>,
|
|
508
|
-
<span class="ruby-value">:response_body</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>),
|
|
509
|
-
<span class="ruby-identifier">response</span>.<span class="ruby-identifier">status_message</span>
|
|
510
|
-
<span class="ruby-keyword">end</span>
|
|
511
|
-
<span class="ruby-keyword">end</span>
|
|
512
|
-
|
|
513
|
-
<span class="ruby-keyword">if</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:return_type</span>]
|
|
514
|
-
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">deserialize</span>(<span class="ruby-identifier">response</span>, <span class="ruby-identifier">opts</span>[<span class="ruby-value">:return_type</span>])
|
|
515
|
-
<span class="ruby-keyword">else</span>
|
|
516
|
-
<span class="ruby-identifier">data</span> = <span class="ruby-keyword">nil</span>
|
|
517
|
-
<span class="ruby-keyword">end</span>
|
|
518
|
-
<span class="ruby-keyword">return</span> <span class="ruby-identifier">data</span>, <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span>, <span class="ruby-identifier">response</span>.<span class="ruby-identifier">headers</span>
|
|
519
|
-
<span class="ruby-keyword">end</span></pre>
|
|
520
|
-
</div>
|
|
521
|
-
|
|
522
|
-
</div>
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
</div>
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
<div id="method-i-convert_to_type" class="method-detail ">
|
|
531
|
-
|
|
532
|
-
<div class="method-heading">
|
|
533
|
-
<span class="method-name">convert_to_type</span><span
|
|
534
|
-
class="method-args">(data, return_type)</span>
|
|
535
|
-
|
|
536
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
537
|
-
|
|
538
|
-
</div>
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
<div class="method-description">
|
|
542
|
-
|
|
543
|
-
<p>Convert data to the given return type. @param [Object] data Data to be converted @param [String] return_type Return type @return [Mixed] Data in a particular type</p>
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
<div class="method-source-code" id="convert_to_type-source">
|
|
549
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 181</span>
|
|
550
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">convert_to_type</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">return_type</span>)
|
|
551
|
-
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">nil?</span>
|
|
552
|
-
<span class="ruby-keyword">case</span> <span class="ruby-identifier">return_type</span>
|
|
553
|
-
<span class="ruby-keyword">when</span> <span class="ruby-string">'String'</span>
|
|
554
|
-
<span class="ruby-identifier">data</span>.<span class="ruby-identifier">to_s</span>
|
|
555
|
-
<span class="ruby-keyword">when</span> <span class="ruby-string">'Integer'</span>
|
|
556
|
-
<span class="ruby-identifier">data</span>.<span class="ruby-identifier">to_i</span>
|
|
557
|
-
<span class="ruby-keyword">when</span> <span class="ruby-string">'Float'</span>
|
|
558
|
-
<span class="ruby-identifier">data</span>.<span class="ruby-identifier">to_f</span>
|
|
559
|
-
<span class="ruby-keyword">when</span> <span class="ruby-string">'BOOLEAN'</span>
|
|
560
|
-
<span class="ruby-identifier">data</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
|
561
|
-
<span class="ruby-keyword">when</span> <span class="ruby-string">'DateTime'</span>
|
|
562
|
-
<span class="ruby-comment"># parse date time (expecting ISO 8601 format)</span>
|
|
563
|
-
<span class="ruby-constant">DateTime</span>.<span class="ruby-identifier">parse</span> <span class="ruby-identifier">data</span>
|
|
564
|
-
<span class="ruby-keyword">when</span> <span class="ruby-string">'Date'</span>
|
|
565
|
-
<span class="ruby-comment"># parse date time (expecting ISO 8601 format)</span>
|
|
566
|
-
<span class="ruby-constant">Date</span>.<span class="ruby-identifier">parse</span> <span class="ruby-identifier">data</span>
|
|
567
|
-
<span class="ruby-keyword">when</span> <span class="ruby-string">'Object'</span>
|
|
568
|
-
<span class="ruby-comment"># generic object (usually a Hash), return directly</span>
|
|
569
|
-
<span class="ruby-identifier">data</span>
|
|
570
|
-
<span class="ruby-keyword">when</span> <span class="ruby-regexp">/\AArray<(.+)>\z/</span>
|
|
571
|
-
<span class="ruby-comment"># e.g. Array<Pet></span>
|
|
572
|
-
<span class="ruby-identifier">sub_type</span> = <span class="ruby-node">$1</span>
|
|
573
|
-
<span class="ruby-identifier">data</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">item</span><span class="ruby-operator">|</span> <span class="ruby-identifier">convert_to_type</span>(<span class="ruby-identifier">item</span>, <span class="ruby-identifier">sub_type</span>) }
|
|
574
|
-
<span class="ruby-keyword">when</span> <span class="ruby-regexp">/\AHash\<String, (.+)\>\z/</span>
|
|
575
|
-
<span class="ruby-comment"># e.g. Hash<String, Integer></span>
|
|
576
|
-
<span class="ruby-identifier">sub_type</span> = <span class="ruby-node">$1</span>
|
|
577
|
-
{}.<span class="ruby-identifier">tap</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">hash</span><span class="ruby-operator">|</span>
|
|
578
|
-
<span class="ruby-identifier">data</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">hash</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">convert_to_type</span>(<span class="ruby-identifier">v</span>, <span class="ruby-identifier">sub_type</span>) }
|
|
579
|
-
<span class="ruby-keyword">end</span>
|
|
580
|
-
<span class="ruby-keyword">else</span>
|
|
581
|
-
<span class="ruby-comment"># models, e.g. Pet</span>
|
|
582
|
-
<span class="ruby-constant">ApproveAPISwagger</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">return_type</span>).<span class="ruby-identifier">build_from_hash</span>(<span class="ruby-identifier">data</span>)
|
|
583
|
-
<span class="ruby-keyword">end</span>
|
|
584
|
-
<span class="ruby-keyword">end</span></pre>
|
|
585
|
-
</div>
|
|
586
|
-
|
|
587
|
-
</div>
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
</div>
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
<div id="method-i-deserialize" class="method-detail ">
|
|
596
|
-
|
|
597
|
-
<div class="method-heading">
|
|
598
|
-
<span class="method-name">deserialize</span><span
|
|
599
|
-
class="method-args">(response, return_type)</span>
|
|
600
|
-
|
|
601
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
602
|
-
|
|
603
|
-
</div>
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
<div class="method-description">
|
|
607
|
-
|
|
608
|
-
<p>Deserialize the response to the given return type.</p>
|
|
609
|
-
|
|
610
|
-
<p>@param [Response] response HTTP response @param [String] return_type some examples: “User”, “Array<User>”, “Hash<String, Integer>”</p>
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
<div class="method-source-code" id="deserialize-source">
|
|
616
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 147</span>
|
|
617
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">deserialize</span>(<span class="ruby-identifier">response</span>, <span class="ruby-identifier">return_type</span>)
|
|
618
|
-
<span class="ruby-identifier">body</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>
|
|
619
|
-
|
|
620
|
-
<span class="ruby-comment"># handle file downloading - return the File instance processed in request callbacks</span>
|
|
621
|
-
<span class="ruby-comment"># note that response body is empty when the file is written in chunks in request on_body callback</span>
|
|
622
|
-
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@tempfile</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">return_type</span> <span class="ruby-operator">==</span> <span class="ruby-string">'File'</span>
|
|
623
|
-
|
|
624
|
-
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">body</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">body</span>.<span class="ruby-identifier">empty?</span>
|
|
625
|
-
|
|
626
|
-
<span class="ruby-comment"># return response body directly for String return type</span>
|
|
627
|
-
<span class="ruby-keyword">return</span> <span class="ruby-identifier">body</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">return_type</span> <span class="ruby-operator">==</span> <span class="ruby-string">'String'</span>
|
|
628
|
-
|
|
629
|
-
<span class="ruby-comment"># ensuring a default content type</span>
|
|
630
|
-
<span class="ruby-identifier">content_type</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">headers</span>[<span class="ruby-string">'Content-Type'</span>] <span class="ruby-operator">||</span> <span class="ruby-string">'application/json'</span>
|
|
631
|
-
|
|
632
|
-
<span class="ruby-identifier">fail</span> <span class="ruby-node">"Content-Type is not supported: #{content_type}"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">json_mime?</span>(<span class="ruby-identifier">content_type</span>)
|
|
633
|
-
|
|
634
|
-
<span class="ruby-keyword">begin</span>
|
|
635
|
-
<span class="ruby-identifier">data</span> = <span class="ruby-constant">JSON</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-node">"[#{body}]"</span>, <span class="ruby-value">:symbolize_names</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>)[<span class="ruby-value">0</span>]
|
|
636
|
-
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">JSON</span><span class="ruby-operator">::</span><span class="ruby-constant">ParserError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
|
|
637
|
-
<span class="ruby-keyword">if</span> <span class="ruby-node">%w(String Date DateTime)</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">return_type</span>)
|
|
638
|
-
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">body</span>
|
|
639
|
-
<span class="ruby-keyword">else</span>
|
|
640
|
-
<span class="ruby-identifier">raise</span> <span class="ruby-identifier">e</span>
|
|
641
|
-
<span class="ruby-keyword">end</span>
|
|
642
|
-
<span class="ruby-keyword">end</span>
|
|
643
|
-
|
|
644
|
-
<span class="ruby-identifier">convert_to_type</span> <span class="ruby-identifier">data</span>, <span class="ruby-identifier">return_type</span>
|
|
645
|
-
<span class="ruby-keyword">end</span></pre>
|
|
646
|
-
</div>
|
|
647
|
-
|
|
648
|
-
</div>
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
</div>
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
<div id="method-i-download_file" class="method-detail ">
|
|
657
|
-
|
|
658
|
-
<div class="method-heading">
|
|
659
|
-
<span class="method-name">download_file</span><span
|
|
660
|
-
class="method-args">(request)</span>
|
|
661
|
-
|
|
662
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
663
|
-
|
|
664
|
-
</div>
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
<div class="method-description">
|
|
668
|
-
|
|
669
|
-
<p>Save response body into a file in (the defined) temporary folder, using the filename from the “Content-Disposition” header if provided, otherwise a random filename. The response body is written to the file in chunks in order to handle files which size is larger than maximum Ruby String or even larger than the maximum memory a Ruby process can use.</p>
|
|
670
|
-
|
|
671
|
-
<p>@see <a href="Configuration.html#attribute-i-temp_folder_path"><code>Configuration#temp_folder_path</code></a></p>
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
<div class="method-source-code" id="download_file-source">
|
|
677
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 224</span>
|
|
678
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">download_file</span>(<span class="ruby-identifier">request</span>)
|
|
679
|
-
<span class="ruby-identifier">tempfile</span> = <span class="ruby-keyword">nil</span>
|
|
680
|
-
<span class="ruby-identifier">encoding</span> = <span class="ruby-keyword">nil</span>
|
|
681
|
-
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">on_headers</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">response</span><span class="ruby-operator">|</span>
|
|
682
|
-
<span class="ruby-identifier">content_disposition</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">headers</span>[<span class="ruby-string">'Content-Disposition'</span>]
|
|
683
|
-
<span class="ruby-keyword">if</span> <span class="ruby-identifier">content_disposition</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">content_disposition</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/filename=/i</span>
|
|
684
|
-
<span class="ruby-identifier">filename</span> = <span class="ruby-identifier">content_disposition</span>[<span class="ruby-regexp">/filename=['"]?([^'"\s]+)['"]?/</span>, <span class="ruby-value">1</span>]
|
|
685
|
-
<span class="ruby-identifier">prefix</span> = <span class="ruby-identifier">sanitize_filename</span>(<span class="ruby-identifier">filename</span>)
|
|
686
|
-
<span class="ruby-keyword">else</span>
|
|
687
|
-
<span class="ruby-identifier">prefix</span> = <span class="ruby-string">'download-'</span>
|
|
688
|
-
<span class="ruby-keyword">end</span>
|
|
689
|
-
<span class="ruby-identifier">prefix</span> = <span class="ruby-identifier">prefix</span> <span class="ruby-operator">+</span> <span class="ruby-string">'-'</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">prefix</span>.<span class="ruby-identifier">end_with?</span>(<span class="ruby-string">'-'</span>)
|
|
690
|
-
<span class="ruby-identifier">encoding</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">encoding</span>
|
|
691
|
-
<span class="ruby-identifier">tempfile</span> = <span class="ruby-constant">Tempfile</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">prefix</span>, <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">temp_folder_path</span>, <span class="ruby-value">encoding:</span> <span class="ruby-identifier">encoding</span>)
|
|
692
|
-
<span class="ruby-ivar">@tempfile</span> = <span class="ruby-identifier">tempfile</span>
|
|
693
|
-
<span class="ruby-keyword">end</span>
|
|
694
|
-
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">on_body</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">chunk</span><span class="ruby-operator">|</span>
|
|
695
|
-
<span class="ruby-identifier">chunk</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-identifier">encoding</span>)
|
|
696
|
-
<span class="ruby-identifier">tempfile</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">chunk</span>)
|
|
697
|
-
<span class="ruby-keyword">end</span>
|
|
698
|
-
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">on_complete</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">response</span><span class="ruby-operator">|</span>
|
|
699
|
-
<span class="ruby-identifier">tempfile</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">tempfile</span>
|
|
700
|
-
<span class="ruby-ivar">@config</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">info</span> <span class="ruby-node">"Temp file written to #{tempfile.path}, please copy the file to a proper folder "</span>\
|
|
701
|
-
<span class="ruby-string">"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "</span>\
|
|
702
|
-
<span class="ruby-string">"will be deleted automatically with GC. It's also recommended to delete the temp file "</span>\
|
|
703
|
-
<span class="ruby-string">"explicitly with `tempfile.delete`"</span>
|
|
704
|
-
<span class="ruby-keyword">end</span>
|
|
705
|
-
<span class="ruby-keyword">end</span></pre>
|
|
706
|
-
</div>
|
|
707
|
-
|
|
708
|
-
</div>
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
</div>
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
<div id="method-i-json_mime-3F" class="method-detail ">
|
|
717
|
-
|
|
718
|
-
<div class="method-heading">
|
|
719
|
-
<span class="method-name">json_mime?</span><span
|
|
720
|
-
class="method-args">(mime)</span>
|
|
721
|
-
|
|
722
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
723
|
-
|
|
724
|
-
</div>
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
<div class="method-description">
|
|
728
|
-
|
|
729
|
-
<p>Check if the given MIME is a JSON MIME. JSON MIME examples:</p>
|
|
730
|
-
|
|
731
|
-
<pre>application/json
|
|
732
|
-
application/json; charset=UTF8
|
|
733
|
-
APPLICATION/JSON
|
|
734
|
-
*/*</pre>
|
|
735
|
-
|
|
736
|
-
<p>@param [String] mime MIME @return [Boolean] True if the MIME is application/json</p>
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
<div class="method-source-code" id="json_mime-3F-source">
|
|
742
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 139</span>
|
|
743
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">json_mime?</span>(<span class="ruby-identifier">mime</span>)
|
|
744
|
-
(<span class="ruby-identifier">mime</span> <span class="ruby-operator">==</span> <span class="ruby-string">'*/*'</span>) <span class="ruby-operator">||</span> <span class="ruby-operator">!</span>(<span class="ruby-identifier">mime</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/Application\/.*json(?!p)(;.*)?/i</span>).<span class="ruby-identifier">nil?</span>
|
|
745
|
-
<span class="ruby-keyword">end</span></pre>
|
|
746
|
-
</div>
|
|
747
|
-
|
|
748
|
-
</div>
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
</div>
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
<div id="method-i-object_to_hash" class="method-detail ">
|
|
757
|
-
|
|
758
|
-
<div class="method-heading">
|
|
759
|
-
<span class="method-name">object_to_hash</span><span
|
|
760
|
-
class="method-args">(obj)</span>
|
|
761
|
-
|
|
762
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
763
|
-
|
|
764
|
-
</div>
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
<div class="method-description">
|
|
768
|
-
|
|
769
|
-
<p>Convert object(non-array) to hash. @param [Object] obj object to be converted into JSON string @return [String] JSON string representation of the object</p>
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
<div class="method-source-code" id="object_to_hash-source">
|
|
775
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 359</span>
|
|
776
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">object_to_hash</span>(<span class="ruby-identifier">obj</span>)
|
|
777
|
-
<span class="ruby-keyword">if</span> <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:to_hash</span>)
|
|
778
|
-
<span class="ruby-identifier">obj</span>.<span class="ruby-identifier">to_hash</span>
|
|
779
|
-
<span class="ruby-keyword">else</span>
|
|
780
|
-
<span class="ruby-identifier">obj</span>
|
|
781
|
-
<span class="ruby-keyword">end</span>
|
|
782
|
-
<span class="ruby-keyword">end</span></pre>
|
|
783
|
-
</div>
|
|
784
|
-
|
|
785
|
-
</div>
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
</div>
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
<div id="method-i-object_to_http_body" class="method-detail ">
|
|
794
|
-
|
|
795
|
-
<div class="method-heading">
|
|
796
|
-
<span class="method-name">object_to_http_body</span><span
|
|
797
|
-
class="method-args">(model)</span>
|
|
798
|
-
|
|
799
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
800
|
-
|
|
801
|
-
</div>
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
<div class="method-description">
|
|
805
|
-
|
|
806
|
-
<p>Convert object (array, hash, object, etc) to JSON string. @param [Object] model object to be converted into JSON string @return [String] JSON string representation of the object</p>
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
<div class="method-source-code" id="object_to_http_body-source">
|
|
812
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 345</span>
|
|
813
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">object_to_http_body</span>(<span class="ruby-identifier">model</span>)
|
|
814
|
-
<span class="ruby-keyword">return</span> <span class="ruby-identifier">model</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
|
|
815
|
-
<span class="ruby-identifier">local_body</span> = <span class="ruby-keyword">nil</span>
|
|
816
|
-
<span class="ruby-keyword">if</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
|
|
817
|
-
<span class="ruby-identifier">local_body</span> = <span class="ruby-identifier">model</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">m</span><span class="ruby-operator">|</span> <span class="ruby-identifier">object_to_hash</span>(<span class="ruby-identifier">m</span>) }
|
|
818
|
-
<span class="ruby-keyword">else</span>
|
|
819
|
-
<span class="ruby-identifier">local_body</span> = <span class="ruby-identifier">object_to_hash</span>(<span class="ruby-identifier">model</span>)
|
|
820
|
-
<span class="ruby-keyword">end</span>
|
|
821
|
-
<span class="ruby-identifier">local_body</span>.<span class="ruby-identifier">to_json</span>
|
|
822
|
-
<span class="ruby-keyword">end</span></pre>
|
|
823
|
-
</div>
|
|
824
|
-
|
|
825
|
-
</div>
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
</div>
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
<div id="method-i-sanitize_filename" class="method-detail ">
|
|
834
|
-
|
|
835
|
-
<div class="method-heading">
|
|
836
|
-
<span class="method-name">sanitize_filename</span><span
|
|
837
|
-
class="method-args">(filename)</span>
|
|
838
|
-
|
|
839
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
840
|
-
|
|
841
|
-
</div>
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
<div class="method-description">
|
|
845
|
-
|
|
846
|
-
<p>Sanitize filename by removing path. e.g. ../../sun.gif becomes sun.gif</p>
|
|
847
|
-
|
|
848
|
-
<p>@param [String] filename the filename to be sanitized @return [String] the sanitized filename</p>
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
<div class="method-source-code" id="sanitize_filename-source">
|
|
854
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 258</span>
|
|
855
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sanitize_filename</span>(<span class="ruby-identifier">filename</span>)
|
|
856
|
-
<span class="ruby-identifier">filename</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/.*[\/\\]/</span>, <span class="ruby-string">''</span>)
|
|
857
|
-
<span class="ruby-keyword">end</span></pre>
|
|
858
|
-
</div>
|
|
859
|
-
|
|
860
|
-
</div>
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
</div>
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
<div id="method-i-select_header_accept" class="method-detail ">
|
|
869
|
-
|
|
870
|
-
<div class="method-heading">
|
|
871
|
-
<span class="method-name">select_header_accept</span><span
|
|
872
|
-
class="method-args">(accepts)</span>
|
|
873
|
-
|
|
874
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
875
|
-
|
|
876
|
-
</div>
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
<div class="method-description">
|
|
880
|
-
|
|
881
|
-
<p>Return Accept header based on an array of accepts provided. @param [Array] accepts array for Accept @return [String] the Accept header (e.g. application/json)</p>
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
<div class="method-source-code" id="select_header_accept-source">
|
|
887
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 324</span>
|
|
888
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">select_header_accept</span>(<span class="ruby-identifier">accepts</span>)
|
|
889
|
-
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">accepts</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">accepts</span>.<span class="ruby-identifier">empty?</span>
|
|
890
|
-
<span class="ruby-comment"># use JSON when present, otherwise use all of the provided</span>
|
|
891
|
-
<span class="ruby-identifier">json_accept</span> = <span class="ruby-identifier">accepts</span>.<span class="ruby-identifier">find</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">json_mime?</span>(<span class="ruby-identifier">s</span>) }
|
|
892
|
-
<span class="ruby-identifier">json_accept</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">accepts</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">','</span>)
|
|
893
|
-
<span class="ruby-keyword">end</span></pre>
|
|
894
|
-
</div>
|
|
895
|
-
|
|
896
|
-
</div>
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
</div>
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
<div id="method-i-select_header_content_type" class="method-detail ">
|
|
905
|
-
|
|
906
|
-
<div class="method-heading">
|
|
907
|
-
<span class="method-name">select_header_content_type</span><span
|
|
908
|
-
class="method-args">(content_types)</span>
|
|
909
|
-
|
|
910
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
911
|
-
|
|
912
|
-
</div>
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
<div class="method-description">
|
|
916
|
-
|
|
917
|
-
<p>Return Content-Type header based on an array of content types provided. @param [Array] content_types array for Content-Type @return [String] the Content-Type header (e.g. application/json)</p>
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
<div class="method-source-code" id="select_header_content_type-source">
|
|
923
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 334</span>
|
|
924
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">select_header_content_type</span>(<span class="ruby-identifier">content_types</span>)
|
|
925
|
-
<span class="ruby-comment"># use application/json by default</span>
|
|
926
|
-
<span class="ruby-keyword">return</span> <span class="ruby-string">'application/json'</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">content_types</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">content_types</span>.<span class="ruby-identifier">empty?</span>
|
|
927
|
-
<span class="ruby-comment"># use JSON when present, otherwise use the first one</span>
|
|
928
|
-
<span class="ruby-identifier">json_content_type</span> = <span class="ruby-identifier">content_types</span>.<span class="ruby-identifier">find</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">json_mime?</span>(<span class="ruby-identifier">s</span>) }
|
|
929
|
-
<span class="ruby-identifier">json_content_type</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">content_types</span>.<span class="ruby-identifier">first</span>
|
|
930
|
-
<span class="ruby-keyword">end</span></pre>
|
|
931
|
-
</div>
|
|
932
|
-
|
|
933
|
-
</div>
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
</div>
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
<div id="method-i-update_params_for_auth-21" class="method-detail ">
|
|
942
|
-
|
|
943
|
-
<div class="method-heading">
|
|
944
|
-
<span class="method-name">update_params_for_auth!</span><span
|
|
945
|
-
class="method-args">(header_params, query_params, auth_names)</span>
|
|
946
|
-
|
|
947
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
948
|
-
|
|
949
|
-
</div>
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
<div class="method-description">
|
|
953
|
-
|
|
954
|
-
<p>Update hearder and query params based on authentication settings.</p>
|
|
955
|
-
|
|
956
|
-
<p>@param [Hash] header_params Header parameters @param [Hash] query_params Query parameters @param [String] auth_names Authentication scheme name</p>
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
<div class="method-source-code" id="update_params_for_auth-21-source">
|
|
962
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 301</span>
|
|
963
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">update_params_for_auth!</span>(<span class="ruby-identifier">header_params</span>, <span class="ruby-identifier">query_params</span>, <span class="ruby-identifier">auth_names</span>)
|
|
964
|
-
<span class="ruby-constant">Array</span>(<span class="ruby-identifier">auth_names</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">auth_name</span><span class="ruby-operator">|</span>
|
|
965
|
-
<span class="ruby-identifier">auth_setting</span> = <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">auth_settings</span>[<span class="ruby-identifier">auth_name</span>]
|
|
966
|
-
<span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">auth_setting</span>
|
|
967
|
-
<span class="ruby-keyword">case</span> <span class="ruby-identifier">auth_setting</span>[<span class="ruby-value">:in</span>]
|
|
968
|
-
<span class="ruby-keyword">when</span> <span class="ruby-string">'header'</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">header_params</span>[<span class="ruby-identifier">auth_setting</span>[<span class="ruby-value">:key</span>]] = <span class="ruby-identifier">auth_setting</span>[<span class="ruby-value">:value</span>]
|
|
969
|
-
<span class="ruby-keyword">when</span> <span class="ruby-string">'query'</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">query_params</span>[<span class="ruby-identifier">auth_setting</span>[<span class="ruby-value">:key</span>]] = <span class="ruby-identifier">auth_setting</span>[<span class="ruby-value">:value</span>]
|
|
970
|
-
<span class="ruby-keyword">else</span> <span class="ruby-identifier">fail</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">'Authentication token must be in `query` of `header`'</span>
|
|
971
|
-
<span class="ruby-keyword">end</span>
|
|
972
|
-
<span class="ruby-keyword">end</span>
|
|
973
|
-
<span class="ruby-keyword">end</span></pre>
|
|
974
|
-
</div>
|
|
975
|
-
|
|
976
|
-
</div>
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
</div>
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
<div id="method-i-user_agent-3D" class="method-detail ">
|
|
985
|
-
|
|
986
|
-
<div class="method-heading">
|
|
987
|
-
<span class="method-name">user_agent=</span><span
|
|
988
|
-
class="method-args">(user_agent)</span>
|
|
989
|
-
|
|
990
|
-
<span class="method-click-advice">click to toggle source</span>
|
|
991
|
-
|
|
992
|
-
</div>
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
<div class="method-description">
|
|
996
|
-
|
|
997
|
-
<p>Sets user agent in HTTP header</p>
|
|
998
|
-
|
|
999
|
-
<p>@param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)</p>
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
<div class="method-source-code" id="user_agent-3D-source">
|
|
1005
|
-
<pre><span class="ruby-comment"># File lib/approveapi_swagger/api_client.rb, line 316</span>
|
|
1006
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">user_agent=</span>(<span class="ruby-identifier">user_agent</span>)
|
|
1007
|
-
<span class="ruby-ivar">@user_agent</span> = <span class="ruby-identifier">user_agent</span>
|
|
1008
|
-
<span class="ruby-ivar">@default_headers</span>[<span class="ruby-string">'User-Agent'</span>] = <span class="ruby-ivar">@user_agent</span>
|
|
1009
|
-
<span class="ruby-keyword">end</span></pre>
|
|
1010
|
-
</div>
|
|
1011
|
-
|
|
1012
|
-
</div>
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
</div>
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
</section>
|
|
1021
|
-
|
|
1022
|
-
</section>
|
|
1023
|
-
|
|
1024
|
-
</main>
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
<footer id="validator-badges" role="contentinfo">
|
|
1028
|
-
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
1029
|
-
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.1.
|
|
1030
|
-
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
1031
|
-
</footer>
|
|
1032
|
-
|