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.
Files changed (92) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +4 -4
  4. data/docs/AnswerMetadata.md +1 -1
  5. data/docs/CreatePromptRequest.md +6 -4
  6. data/docs/Prompt.md +3 -2
  7. data/docs/PromptAnswer.md +1 -1
  8. data/docs/PromptMetadata.md +2 -2
  9. data/lib/approveapi_swagger/api/approve_api.rb +0 -1
  10. data/lib/approveapi_swagger/models/answer_metadata.rb +13 -15
  11. data/lib/approveapi_swagger/models/create_prompt_request.rb +68 -49
  12. data/lib/approveapi_swagger/models/error.rb +0 -2
  13. data/lib/approveapi_swagger/models/prompt.rb +31 -19
  14. data/lib/approveapi_swagger/models/prompt_answer.rb +16 -18
  15. data/lib/approveapi_swagger/models/prompt_metadata.rb +24 -26
  16. data/lib/approveapi_swagger/models/prompt_status.rb +0 -2
  17. data/lib/approveapi_swagger/version.rb +1 -1
  18. data/pkg/approveapi_swagger-1.0.1.gem +0 -0
  19. data/pkg/approveapi_swagger-1.0.6.gem +0 -0
  20. metadata +9 -79
  21. data/doc/ApproveAPISwagger.html +0 -185
  22. data/doc/ApproveAPISwagger/AnswerMetadata.html +0 -789
  23. data/doc/ApproveAPISwagger/ApiClient.html +0 -1032
  24. data/doc/ApproveAPISwagger/ApiError.html +0 -224
  25. data/doc/ApproveAPISwagger/ApproveApi.html +0 -501
  26. data/doc/ApproveAPISwagger/Configuration.html +0 -941
  27. data/doc/ApproveAPISwagger/CreatePromptRequest.html +0 -879
  28. data/doc/ApproveAPISwagger/Error.html +0 -754
  29. data/doc/ApproveAPISwagger/Prompt.html +0 -819
  30. data/doc/ApproveAPISwagger/PromptAnswer.html +0 -799
  31. data/doc/ApproveAPISwagger/PromptMetadata.html +0 -829
  32. data/doc/ApproveAPISwagger/PromptStatus.html +0 -754
  33. data/doc/Gemfile.html +0 -120
  34. data/doc/Gemfile_lock.html +0 -194
  35. data/doc/README_md.html +0 -225
  36. data/doc/Rakefile.html +0 -125
  37. data/doc/approveapi_swagger_gemspec.html +0 -161
  38. data/doc/created.rid +0 -39
  39. data/doc/css/fonts.css +0 -167
  40. data/doc/css/rdoc.css +0 -590
  41. data/doc/docs/AnswerMetadata_md.html +0 -123
  42. data/doc/docs/ApproveApi_md.html +0 -293
  43. data/doc/docs/CreatePromptRequest_md.html +0 -123
  44. data/doc/docs/Error_md.html +0 -123
  45. data/doc/docs/PromptAnswer_md.html +0 -123
  46. data/doc/docs/PromptMetadata_md.html +0 -123
  47. data/doc/docs/PromptStatus_md.html +0 -123
  48. data/doc/docs/Prompt_md.html +0 -123
  49. data/doc/fonts/Lato-Light.ttf +0 -0
  50. data/doc/fonts/Lato-LightItalic.ttf +0 -0
  51. data/doc/fonts/Lato-Regular.ttf +0 -0
  52. data/doc/fonts/Lato-RegularItalic.ttf +0 -0
  53. data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
  54. data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
  55. data/doc/git_push_sh.html +0 -157
  56. data/doc/images/add.png +0 -0
  57. data/doc/images/arrow_up.png +0 -0
  58. data/doc/images/brick.png +0 -0
  59. data/doc/images/brick_link.png +0 -0
  60. data/doc/images/bug.png +0 -0
  61. data/doc/images/bullet_black.png +0 -0
  62. data/doc/images/bullet_toggle_minus.png +0 -0
  63. data/doc/images/bullet_toggle_plus.png +0 -0
  64. data/doc/images/date.png +0 -0
  65. data/doc/images/delete.png +0 -0
  66. data/doc/images/find.png +0 -0
  67. data/doc/images/loadingAnimation.gif +0 -0
  68. data/doc/images/macFFBgHack.png +0 -0
  69. data/doc/images/package.png +0 -0
  70. data/doc/images/page_green.png +0 -0
  71. data/doc/images/page_white_text.png +0 -0
  72. data/doc/images/page_white_width.png +0 -0
  73. data/doc/images/plugin.png +0 -0
  74. data/doc/images/ruby.png +0 -0
  75. data/doc/images/tag_blue.png +0 -0
  76. data/doc/images/tag_green.png +0 -0
  77. data/doc/images/transparent.png +0 -0
  78. data/doc/images/wrench.png +0 -0
  79. data/doc/images/wrench_orange.png +0 -0
  80. data/doc/images/zoom.png +0 -0
  81. data/doc/index.html +0 -141
  82. data/doc/js/darkfish.js +0 -161
  83. data/doc/js/jquery.js +0 -4
  84. data/doc/js/navigation.js +0 -141
  85. data/doc/js/navigation.js.gz +0 -0
  86. data/doc/js/search.js +0 -109
  87. data/doc/js/search_index.js +0 -1
  88. data/doc/js/search_index.js.gz +0 -0
  89. data/doc/js/searcher.js +0 -229
  90. data/doc/js/searcher.js.gz +0 -0
  91. data/doc/table_of_contents.html +0 -1036
  92. data/pkg/approveapi_swagger-1.0.2.gem +0 -0
data/doc/ApproveAPISwagger/ApiError.html DELETED
@@ -1,224 +0,0 @@
1
- <!DOCTYPE html>
2
-
3
- <html>
4
- <head>
5
- <meta charset="UTF-8">
6
-
7
- <title>class ApproveAPISwagger::ApiError - 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">StandardError
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 class="calls-super" ><a href="#method-c-new">::new</a>
76
-
77
- </ul>
78
- </div>
79
-
80
- </div>
81
- </nav>
82
-
83
- <main role="main" aria-labelledby="class-ApproveAPISwagger::ApiError">
84
- <h1 id="class-ApproveAPISwagger::ApiError" class="class">
85
- class ApproveAPISwagger::ApiError
86
- </h1>
87
-
88
- <section class="description">
89
-
90
- </section>
91
-
92
-
93
- <section id="5Buntitled-5D" class="documentation-section">
94
-
95
-
96
-
97
-
98
-
99
-
100
-
101
- <section class="attribute-method-details" class="method-section">
102
- <header>
103
- <h3>Attributes</h3>
104
- </header>
105
-
106
-
107
- <div id="attribute-i-code" class="method-detail">
108
- <div class="method-heading attribute-method-heading">
109
- <span class="method-name">code</span><span
110
- class="attribute-access-type">[R]</span>
111
- </div>
112
-
113
- <div class="method-description">
114
-
115
-
116
-
117
- </div>
118
- </div>
119
-
120
- <div id="attribute-i-response_body" class="method-detail">
121
- <div class="method-heading attribute-method-heading">
122
- <span class="method-name">response_body</span><span
123
- class="attribute-access-type">[R]</span>
124
- </div>
125
-
126
- <div class="method-description">
127
-
128
-
129
-
130
- </div>
131
- </div>
132
-
133
- <div id="attribute-i-response_headers" class="method-detail">
134
- <div class="method-heading attribute-method-heading">
135
- <span class="method-name">response_headers</span><span
136
- class="attribute-access-type">[R]</span>
137
- </div>
138
-
139
- <div class="method-description">
140
-
141
-
142
-
143
- </div>
144
- </div>
145
-
146
- </section>
147
-
148
-
149
-
150
- <section id="public-class-5Buntitled-5D-method-details" class="method-section">
151
- <header>
152
- <h3>Public Class Methods</h3>
153
- </header>
154
-
155
-
156
- <div id="method-c-new" class="method-detail ">
157
-
158
- <div class="method-heading">
159
- <span class="method-name">new</span><span
160
- class="method-args">(arg = nil)</span>
161
-
162
- <span class="method-click-advice">click to toggle source</span>
163
-
164
- </div>
165
-
166
-
167
- <div class="method-description">
168
-
169
- <p>Usage examples:</p>
170
-
171
- <pre class="ruby"><span class="ruby-constant">ApiError</span>.<span class="ruby-identifier">new</span>
172
- <span class="ruby-constant">ApiError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&quot;message&quot;</span>)
173
- <span class="ruby-constant">ApiError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:code</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-value">500</span>, <span class="ruby-value">:response_headers</span> <span class="ruby-operator">=&gt;</span> {}, <span class="ruby-value">:response_body</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-string">&quot;&quot;</span>)
174
- <span class="ruby-constant">ApiError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:code</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-value">404</span>, <span class="ruby-value">:message</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-string">&quot;Not Found&quot;</span>)
175
- </pre>
176
-
177
-
178
- <div class="method-calls-super">
179
- Calls superclass method
180
-
181
- </div>
182
-
183
-
184
-
185
- <div class="method-source-code" id="new-source">
186
- <pre><span class="ruby-comment"># File lib/approveapi_swagger/api_error.rb, line 22</span>
187
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">arg</span> = <span class="ruby-keyword">nil</span>)
188
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Hash</span>
189
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-value">:message</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-string">&#39;message&#39;</span>)
190
- <span class="ruby-keyword">super</span>(<span class="ruby-identifier">arg</span>[<span class="ruby-value">:message</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">arg</span>[<span class="ruby-string">&#39;message&#39;</span>])
191
- <span class="ruby-keyword">else</span>
192
- <span class="ruby-keyword">super</span> <span class="ruby-identifier">arg</span>
193
- <span class="ruby-keyword">end</span>
194
-
195
- <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
196
- <span class="ruby-identifier">instance_variable_set</span> <span class="ruby-node">&quot;@#{k}&quot;</span>, <span class="ruby-identifier">v</span>
197
- <span class="ruby-keyword">end</span>
198
- <span class="ruby-keyword">else</span>
199
- <span class="ruby-keyword">super</span> <span class="ruby-identifier">arg</span>
200
- <span class="ruby-keyword">end</span>
201
- <span class="ruby-keyword">end</span></pre>
202
- </div>
203
-
204
- </div>
205
-
206
-
207
-
208
-
209
- </div>
210
-
211
-
212
- </section>
213
-
214
- </section>
215
-
216
- </main>
217
-
218
-
219
- <footer id="validator-badges" role="contentinfo">
220
- <p><a href="https://validator.w3.org/check/referer">Validate</a>
221
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.1.
222
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
223
- </footer>
224
-
data/doc/ApproveAPISwagger/ApproveApi.html DELETED
@@ -1,501 +0,0 @@
1
- <!DOCTYPE html>
2
-
3
- <html>
4
- <head>
5
- <meta charset="UTF-8">
6
-
7
- <title>class ApproveAPISwagger::ApproveApi - 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-new">::new</a>
76
-
77
- <li ><a href="#method-i-create_prompt">#create_prompt</a>
78
-
79
- <li ><a href="#method-i-create_prompt_with_http_info">#create_prompt_with_http_info</a>
80
-
81
- <li ><a href="#method-i-get_prompt">#get_prompt</a>
82
-
83
- <li ><a href="#method-i-get_prompt_status">#get_prompt_status</a>
84
-
85
- <li ><a href="#method-i-get_prompt_status_with_http_info">#get_prompt_status_with_http_info</a>
86
-
87
- <li ><a href="#method-i-get_prompt_with_http_info">#get_prompt_with_http_info</a>
88
-
89
- </ul>
90
- </div>
91
-
92
- </div>
93
- </nav>
94
-
95
- <main role="main" aria-labelledby="class-ApproveAPISwagger::ApproveApi">
96
- <h1 id="class-ApproveAPISwagger::ApproveApi" class="class">
97
- class ApproveAPISwagger::ApproveApi
98
- </h1>
99
-
100
- <section class="description">
101
-
102
- </section>
103
-
104
-
105
- <section id="5Buntitled-5D" class="documentation-section">
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
- <section class="attribute-method-details" class="method-section">
114
- <header>
115
- <h3>Attributes</h3>
116
- </header>
117
-
118
-
119
- <div id="attribute-i-api_client" class="method-detail">
120
- <div class="method-heading attribute-method-heading">
121
- <span class="method-name">api_client</span><span
122
- class="attribute-access-type">[RW]</span>
123
- </div>
124
-
125
- <div class="method-description">
126
-
127
-
128
-
129
- </div>
130
- </div>
131
-
132
- </section>
133
-
134
-
135
-
136
- <section id="public-class-5Buntitled-5D-method-details" class="method-section">
137
- <header>
138
- <h3>Public Class Methods</h3>
139
- </header>
140
-
141
-
142
- <div id="method-c-new" class="method-detail ">
143
-
144
- <div class="method-heading">
145
- <span class="method-name">new</span><span
146
- class="method-args">(api_client = ApiClient.default)</span>
147
-
148
- <span class="method-click-advice">click to toggle source</span>
149
-
150
- </div>
151
-
152
-
153
- <div class="method-description">
154
-
155
-
156
-
157
-
158
-
159
-
160
- <div class="method-source-code" id="new-source">
161
- <pre><span class="ruby-comment"># File lib/approveapi_swagger/api/approve_api.rb, line 19</span>
162
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">api_client</span> = <span class="ruby-constant">ApiClient</span>.<span class="ruby-identifier">default</span>)
163
- <span class="ruby-ivar">@api_client</span> = <span class="ruby-identifier">api_client</span>
164
- <span class="ruby-keyword">end</span></pre>
165
- </div>
166
-
167
- </div>
168
-
169
-
170
-
171
-
172
- </div>
173
-
174
-
175
- </section>
176
-
177
- <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
178
- <header>
179
- <h3>Public Instance Methods</h3>
180
- </header>
181
-
182
-
183
- <div id="method-i-create_prompt" class="method-detail ">
184
-
185
- <div class="method-heading">
186
- <span class="method-name">create_prompt</span><span
187
- class="method-args">(create_prompt_request, opts = {})</span>
188
-
189
- <span class="method-click-advice">click to toggle source</span>
190
-
191
- </div>
192
-
193
-
194
- <div class="method-description">
195
-
196
- <p>Sending a prompt Creates a prompt and pushes it to the user (sends via email, sms, or other supported protocols). @param create_prompt_request @param [Hash] opts the optional parameters @return [Prompt]</p>
197
-
198
-
199
-
200
-
201
- <div class="method-source-code" id="create_prompt-source">
202
- <pre><span class="ruby-comment"># File lib/approveapi_swagger/api/approve_api.rb, line 27</span>
203
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_prompt</span>(<span class="ruby-identifier">create_prompt_request</span>, <span class="ruby-identifier">opts</span> = {})
204
- <span class="ruby-identifier">data</span>, <span class="ruby-identifier">_status_code</span>, <span class="ruby-identifier">_headers</span> = <span class="ruby-identifier">create_prompt_with_http_info</span>(<span class="ruby-identifier">create_prompt_request</span>, <span class="ruby-identifier">opts</span>)
205
- <span class="ruby-identifier">data</span>
206
- <span class="ruby-keyword">end</span></pre>
207
- </div>
208
-
209
- </div>
210
-
211
-
212
-
213
-
214
- </div>
215
-
216
-
217
- <div id="method-i-create_prompt_with_http_info" class="method-detail ">
218
-
219
- <div class="method-heading">
220
- <span class="method-name">create_prompt_with_http_info</span><span
221
- class="method-args">(create_prompt_request, opts = {})</span>
222
-
223
- <span class="method-click-advice">click to toggle source</span>
224
-
225
- </div>
226
-
227
-
228
- <div class="method-description">
229
-
230
- <p>Sending a prompt Creates a prompt and pushes it to the user (sends via email, sms, or other supported protocols). @param create_prompt_request @param [Hash] opts the optional parameters @return [Array&lt;(Prompt, Fixnum, Hash)&gt;] <a href="Prompt.html"><code>Prompt</code></a> data, response status code and response headers</p>
231
-
232
-
233
-
234
-
235
- <div class="method-source-code" id="create_prompt_with_http_info-source">
236
- <pre><span class="ruby-comment"># File lib/approveapi_swagger/api/approve_api.rb, line 37</span>
237
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_prompt_with_http_info</span>(<span class="ruby-identifier">create_prompt_request</span>, <span class="ruby-identifier">opts</span> = {})
238
- <span class="ruby-keyword">if</span> <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">debugging</span>
239
- <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-string">&#39;Calling API: ApproveApi.create_prompt ...&#39;</span>
240
- <span class="ruby-keyword">end</span>
241
- <span class="ruby-comment"># verify the required parameter &#39;create_prompt_request&#39; is set</span>
242
- <span class="ruby-keyword">if</span> <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">client_side_validation</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">create_prompt_request</span>.<span class="ruby-identifier">nil?</span>
243
- <span class="ruby-identifier">fail</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&quot;Missing the required parameter &#39;create_prompt_request&#39; when calling ApproveApi.create_prompt&quot;</span>
244
- <span class="ruby-keyword">end</span>
245
- <span class="ruby-comment"># resource path</span>
246
- <span class="ruby-identifier">local_var_path</span> = <span class="ruby-string">&#39;/prompt&#39;</span>
247
-
248
- <span class="ruby-comment"># query parameters</span>
249
- <span class="ruby-identifier">query_params</span> = {}
250
-
251
- <span class="ruby-comment"># header parameters</span>
252
- <span class="ruby-identifier">header_params</span> = {}
253
- <span class="ruby-comment"># HTTP header &#39;Accept&#39; (if needed)</span>
254
- <span class="ruby-identifier">header_params</span>[<span class="ruby-string">&#39;Accept&#39;</span>] = <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">select_header_accept</span>([<span class="ruby-string">&#39;application/json&#39;</span>])
255
- <span class="ruby-comment"># HTTP header &#39;Content-Type&#39;</span>
256
- <span class="ruby-identifier">header_params</span>[<span class="ruby-string">&#39;Content-Type&#39;</span>] = <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">select_header_content_type</span>([<span class="ruby-string">&#39;application/json&#39;</span>])
257
-
258
- <span class="ruby-comment"># form parameters</span>
259
- <span class="ruby-identifier">form_params</span> = {}
260
-
261
- <span class="ruby-comment"># http body (model)</span>
262
- <span class="ruby-identifier">post_body</span> = <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">object_to_http_body</span>(<span class="ruby-identifier">create_prompt_request</span>)
263
- <span class="ruby-identifier">auth_names</span> = [<span class="ruby-string">&#39;apiKey&#39;</span>]
264
- <span class="ruby-identifier">data</span>, <span class="ruby-identifier">status_code</span>, <span class="ruby-identifier">headers</span> = <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">call_api</span>(<span class="ruby-value">:POST</span>, <span class="ruby-identifier">local_var_path</span>,
265
- <span class="ruby-value">:header_params</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">header_params</span>,
266
- <span class="ruby-value">:query_params</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">query_params</span>,
267
- <span class="ruby-value">:form_params</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">form_params</span>,
268
- <span class="ruby-value">:body</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">post_body</span>,
269
- <span class="ruby-value">:auth_names</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">auth_names</span>,
270
- <span class="ruby-value">:return_type</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-string">&#39;Prompt&#39;</span>)
271
- <span class="ruby-keyword">if</span> <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">debugging</span>
272
- <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">&quot;API called: ApproveApi#create_prompt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}&quot;</span>
273
- <span class="ruby-keyword">end</span>
274
- <span class="ruby-keyword">return</span> <span class="ruby-identifier">data</span>, <span class="ruby-identifier">status_code</span>, <span class="ruby-identifier">headers</span>
275
- <span class="ruby-keyword">end</span></pre>
276
- </div>
277
-
278
- </div>
279
-
280
-
281
-
282
-
283
- </div>
284
-
285
-
286
- <div id="method-i-get_prompt" class="method-detail ">
287
-
288
- <div class="method-heading">
289
- <span class="method-name">get_prompt</span><span
290
- class="method-args">(id, opts = {})</span>
291
-
292
- <span class="method-click-advice">click to toggle source</span>
293
-
294
- </div>
295
-
296
-
297
- <div class="method-description">
298
-
299
- <p>Retrieve a prompt Retrieve the prompt object with the given ID. @param id The identifier for a pending or completed prompt. This is returned when you create a prompt. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :long_poll If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false. @return [Prompt]</p>
300
-
301
-
302
-
303
-
304
- <div class="method-source-code" id="get_prompt-source">
305
- <pre><span class="ruby-comment"># File lib/approveapi_swagger/api/approve_api.rb, line 83</span>
306
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_prompt</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">opts</span> = {})
307
- <span class="ruby-identifier">data</span>, <span class="ruby-identifier">_status_code</span>, <span class="ruby-identifier">_headers</span> = <span class="ruby-identifier">get_prompt_with_http_info</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">opts</span>)
308
- <span class="ruby-identifier">data</span>
309
- <span class="ruby-keyword">end</span></pre>
310
- </div>
311
-
312
- </div>
313
-
314
-
315
-
316
-
317
- </div>
318
-
319
-
320
- <div id="method-i-get_prompt_status" class="method-detail ">
321
-
322
- <div class="method-heading">
323
- <span class="method-name">get_prompt_status</span><span
324
- class="method-args">(id, opts = {})</span>
325
-
326
- <span class="method-click-advice">click to toggle source</span>
327
-
328
- </div>
329
-
330
-
331
- <div class="method-description">
332
-
333
- <p>Check prompt status Returns whether a prompt has been completed by the user. This request does not require authentication, and so can be used client-side without sharing API credentials. @param id The prompt identifier. @param [Hash] opts the optional parameters @return [PromptStatus]</p>
334
-
335
-
336
-
337
-
338
- <div class="method-source-code" id="get_prompt_status-source">
339
- <pre><span class="ruby-comment"># File lib/approveapi_swagger/api/approve_api.rb, line 138</span>
340
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_prompt_status</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">opts</span> = {})
341
- <span class="ruby-identifier">data</span>, <span class="ruby-identifier">_status_code</span>, <span class="ruby-identifier">_headers</span> = <span class="ruby-identifier">get_prompt_status_with_http_info</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">opts</span>)
342
- <span class="ruby-identifier">data</span>
343
- <span class="ruby-keyword">end</span></pre>
344
- </div>
345
-
346
- </div>
347
-
348
-
349
-
350
-
351
- </div>
352
-
353
-
354
- <div id="method-i-get_prompt_status_with_http_info" class="method-detail ">
355
-
356
- <div class="method-heading">
357
- <span class="method-name">get_prompt_status_with_http_info</span><span
358
- class="method-args">(id, opts = {})</span>
359
-
360
- <span class="method-click-advice">click to toggle source</span>
361
-
362
- </div>
363
-
364
-
365
- <div class="method-description">
366
-
367
- <p>Check prompt status Returns whether a prompt has been completed by the user. This request does not require authentication, and so can be used client-side without sharing API credentials. @param id The prompt identifier. @param [Hash] opts the optional parameters @return [Array&lt;(PromptStatus, Fixnum, Hash)&gt;] <a href="PromptStatus.html"><code>PromptStatus</code></a> data, response status code and response headers</p>
368
-
369
-
370
-
371
-
372
- <div class="method-source-code" id="get_prompt_status_with_http_info-source">
373
- <pre><span class="ruby-comment"># File lib/approveapi_swagger/api/approve_api.rb, line 148</span>
374
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_prompt_status_with_http_info</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">opts</span> = {})
375
- <span class="ruby-keyword">if</span> <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">debugging</span>
376
- <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-string">&#39;Calling API: ApproveApi.get_prompt_status ...&#39;</span>
377
- <span class="ruby-keyword">end</span>
378
- <span class="ruby-comment"># verify the required parameter &#39;id&#39; is set</span>
379
- <span class="ruby-keyword">if</span> <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">client_side_validation</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">id</span>.<span class="ruby-identifier">nil?</span>
380
- <span class="ruby-identifier">fail</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&quot;Missing the required parameter &#39;id&#39; when calling ApproveApi.get_prompt_status&quot;</span>
381
- <span class="ruby-keyword">end</span>
382
- <span class="ruby-comment"># resource path</span>
383
- <span class="ruby-identifier">local_var_path</span> = <span class="ruby-string">&#39;/prompt/{id}/status&#39;</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-string">&#39;{&#39;</span> <span class="ruby-operator">+</span> <span class="ruby-string">&#39;id&#39;</span> <span class="ruby-operator">+</span> <span class="ruby-string">&#39;}&#39;</span>, <span class="ruby-identifier">id</span>.<span class="ruby-identifier">to_s</span>)
384
-
385
- <span class="ruby-comment"># query parameters</span>
386
- <span class="ruby-identifier">query_params</span> = {}
387
-
388
- <span class="ruby-comment"># header parameters</span>
389
- <span class="ruby-identifier">header_params</span> = {}
390
- <span class="ruby-comment"># HTTP header &#39;Accept&#39; (if needed)</span>
391
- <span class="ruby-identifier">header_params</span>[<span class="ruby-string">&#39;Accept&#39;</span>] = <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">select_header_accept</span>([<span class="ruby-string">&#39;application/json&#39;</span>])
392
-
393
- <span class="ruby-comment"># form parameters</span>
394
- <span class="ruby-identifier">form_params</span> = {}
395
-
396
- <span class="ruby-comment"># http body (model)</span>
397
- <span class="ruby-identifier">post_body</span> = <span class="ruby-keyword">nil</span>
398
- <span class="ruby-identifier">auth_names</span> = []
399
- <span class="ruby-identifier">data</span>, <span class="ruby-identifier">status_code</span>, <span class="ruby-identifier">headers</span> = <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">call_api</span>(<span class="ruby-value">:GET</span>, <span class="ruby-identifier">local_var_path</span>,
400
- <span class="ruby-value">:header_params</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">header_params</span>,
401
- <span class="ruby-value">:query_params</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">query_params</span>,
402
- <span class="ruby-value">:form_params</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">form_params</span>,
403
- <span class="ruby-value">:body</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">post_body</span>,
404
- <span class="ruby-value">:auth_names</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">auth_names</span>,
405
- <span class="ruby-value">:return_type</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-string">&#39;PromptStatus&#39;</span>)
406
- <span class="ruby-keyword">if</span> <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">debugging</span>
407
- <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">&quot;API called: ApproveApi#get_prompt_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}&quot;</span>
408
- <span class="ruby-keyword">end</span>
409
- <span class="ruby-keyword">return</span> <span class="ruby-identifier">data</span>, <span class="ruby-identifier">status_code</span>, <span class="ruby-identifier">headers</span>
410
- <span class="ruby-keyword">end</span></pre>
411
- </div>
412
-
413
- </div>
414
-
415
-
416
-
417
-
418
- </div>
419
-
420
-
421
- <div id="method-i-get_prompt_with_http_info" class="method-detail ">
422
-
423
- <div class="method-heading">
424
- <span class="method-name">get_prompt_with_http_info</span><span
425
- class="method-args">(id, opts = {})</span>
426
-
427
- <span class="method-click-advice">click to toggle source</span>
428
-
429
- </div>
430
-
431
-
432
- <div class="method-description">
433
-
434
- <p>Retrieve a prompt Retrieve the prompt object with the given ID. @param id The identifier for a pending or completed prompt. This is returned when you create a prompt. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :long_poll If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false. @return [Array&lt;(Prompt, Fixnum, Hash)&gt;] <a href="Prompt.html"><code>Prompt</code></a> data, response status code and response headers</p>
435
-
436
-
437
-
438
-
439
- <div class="method-source-code" id="get_prompt_with_http_info-source">
440
- <pre><span class="ruby-comment"># File lib/approveapi_swagger/api/approve_api.rb, line 94</span>
441
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_prompt_with_http_info</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">opts</span> = {})
442
- <span class="ruby-keyword">if</span> <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">debugging</span>
443
- <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-string">&#39;Calling API: ApproveApi.get_prompt ...&#39;</span>
444
- <span class="ruby-keyword">end</span>
445
- <span class="ruby-comment"># verify the required parameter &#39;id&#39; is set</span>
446
- <span class="ruby-keyword">if</span> <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">client_side_validation</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">id</span>.<span class="ruby-identifier">nil?</span>
447
- <span class="ruby-identifier">fail</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&quot;Missing the required parameter &#39;id&#39; when calling ApproveApi.get_prompt&quot;</span>
448
- <span class="ruby-keyword">end</span>
449
- <span class="ruby-comment"># resource path</span>
450
- <span class="ruby-identifier">local_var_path</span> = <span class="ruby-string">&#39;/prompt/{id}&#39;</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-string">&#39;{&#39;</span> <span class="ruby-operator">+</span> <span class="ruby-string">&#39;id&#39;</span> <span class="ruby-operator">+</span> <span class="ruby-string">&#39;}&#39;</span>, <span class="ruby-identifier">id</span>.<span class="ruby-identifier">to_s</span>)
451
-
452
- <span class="ruby-comment"># query parameters</span>
453
- <span class="ruby-identifier">query_params</span> = {}
454
- <span class="ruby-identifier">query_params</span>[<span class="ruby-value">:&#39;long_poll&#39;</span>] = <span class="ruby-identifier">opts</span>[<span class="ruby-value">:&#39;long_poll&#39;</span>] <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">opts</span>[<span class="ruby-value">:&#39;long_poll&#39;</span>].<span class="ruby-identifier">nil?</span>
455
-
456
- <span class="ruby-comment"># header parameters</span>
457
- <span class="ruby-identifier">header_params</span> = {}
458
- <span class="ruby-comment"># HTTP header &#39;Accept&#39; (if needed)</span>
459
- <span class="ruby-identifier">header_params</span>[<span class="ruby-string">&#39;Accept&#39;</span>] = <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">select_header_accept</span>([<span class="ruby-string">&#39;application/json&#39;</span>])
460
-
461
- <span class="ruby-comment"># form parameters</span>
462
- <span class="ruby-identifier">form_params</span> = {}
463
-
464
- <span class="ruby-comment"># http body (model)</span>
465
- <span class="ruby-identifier">post_body</span> = <span class="ruby-keyword">nil</span>
466
- <span class="ruby-identifier">auth_names</span> = [<span class="ruby-string">&#39;apiKey&#39;</span>]
467
- <span class="ruby-identifier">data</span>, <span class="ruby-identifier">status_code</span>, <span class="ruby-identifier">headers</span> = <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">call_api</span>(<span class="ruby-value">:GET</span>, <span class="ruby-identifier">local_var_path</span>,
468
- <span class="ruby-value">:header_params</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">header_params</span>,
469
- <span class="ruby-value">:query_params</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">query_params</span>,
470
- <span class="ruby-value">:form_params</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">form_params</span>,
471
- <span class="ruby-value">:body</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">post_body</span>,
472
- <span class="ruby-value">:auth_names</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">auth_names</span>,
473
- <span class="ruby-value">:return_type</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-string">&#39;Prompt&#39;</span>)
474
- <span class="ruby-keyword">if</span> <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">debugging</span>
475
- <span class="ruby-ivar">@api_client</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">&quot;API called: ApproveApi#get_prompt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}&quot;</span>
476
- <span class="ruby-keyword">end</span>
477
- <span class="ruby-keyword">return</span> <span class="ruby-identifier">data</span>, <span class="ruby-identifier">status_code</span>, <span class="ruby-identifier">headers</span>
478
- <span class="ruby-keyword">end</span></pre>
479
- </div>
480
-
481
- </div>
482
-
483
-
484
-
485
-
486
- </div>
487
-
488
-
489
- </section>
490
-
491
- </section>
492
-
493
- </main>
494
-
495
-
496
- <footer id="validator-badges" role="contentinfo">
497
- <p><a href="https://validator.w3.org/check/referer">Validate</a>
498
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.1.
499
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
500
- </footer>
501
-