approveapi_swagger 1.0.1 → 1.0.2

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/doc/ApproveAPISwagger/AnswerMetadata.html +789 -0
  5. data/doc/ApproveAPISwagger/ApiClient.html +1032 -0
  6. data/doc/ApproveAPISwagger/ApiError.html +224 -0
  7. data/doc/ApproveAPISwagger/ApproveApi.html +501 -0
  8. data/doc/ApproveAPISwagger/Configuration.html +941 -0
  9. data/doc/ApproveAPISwagger/CreatePromptRequest.html +879 -0
  10. data/doc/ApproveAPISwagger/Error.html +754 -0
  11. data/doc/ApproveAPISwagger/Prompt.html +819 -0
  12. data/doc/ApproveAPISwagger/PromptAnswer.html +799 -0
  13. data/doc/ApproveAPISwagger/PromptMetadata.html +829 -0
  14. data/doc/ApproveAPISwagger/PromptStatus.html +754 -0
  15. data/doc/ApproveAPISwagger.html +185 -0
  16. data/doc/Gemfile.html +120 -0
  17. data/doc/Gemfile_lock.html +194 -0
  18. data/doc/README_md.html +225 -0
  19. data/doc/Rakefile.html +125 -0
  20. data/doc/approveapi_swagger_gemspec.html +161 -0
  21. data/doc/created.rid +39 -0
  22. data/doc/css/fonts.css +167 -0
  23. data/doc/css/rdoc.css +590 -0
  24. data/doc/docs/AnswerMetadata_md.html +123 -0
  25. data/doc/docs/ApproveApi_md.html +293 -0
  26. data/doc/docs/CreatePromptRequest_md.html +123 -0
  27. data/doc/docs/Error_md.html +123 -0
  28. data/doc/docs/PromptAnswer_md.html +123 -0
  29. data/doc/docs/PromptMetadata_md.html +123 -0
  30. data/doc/docs/PromptStatus_md.html +123 -0
  31. data/doc/docs/Prompt_md.html +123 -0
  32. data/doc/fonts/Lato-Light.ttf +0 -0
  33. data/doc/fonts/Lato-LightItalic.ttf +0 -0
  34. data/doc/fonts/Lato-Regular.ttf +0 -0
  35. data/doc/fonts/Lato-RegularItalic.ttf +0 -0
  36. data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
  37. data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
  38. data/doc/git_push_sh.html +157 -0
  39. data/doc/images/add.png +0 -0
  40. data/doc/images/arrow_up.png +0 -0
  41. data/doc/images/brick.png +0 -0
  42. data/doc/images/brick_link.png +0 -0
  43. data/doc/images/bug.png +0 -0
  44. data/doc/images/bullet_black.png +0 -0
  45. data/doc/images/bullet_toggle_minus.png +0 -0
  46. data/doc/images/bullet_toggle_plus.png +0 -0
  47. data/doc/images/date.png +0 -0
  48. data/doc/images/delete.png +0 -0
  49. data/doc/images/find.png +0 -0
  50. data/doc/images/loadingAnimation.gif +0 -0
  51. data/doc/images/macFFBgHack.png +0 -0
  52. data/doc/images/package.png +0 -0
  53. data/doc/images/page_green.png +0 -0
  54. data/doc/images/page_white_text.png +0 -0
  55. data/doc/images/page_white_width.png +0 -0
  56. data/doc/images/plugin.png +0 -0
  57. data/doc/images/ruby.png +0 -0
  58. data/doc/images/tag_blue.png +0 -0
  59. data/doc/images/tag_green.png +0 -0
  60. data/doc/images/transparent.png +0 -0
  61. data/doc/images/wrench.png +0 -0
  62. data/doc/images/wrench_orange.png +0 -0
  63. data/doc/images/zoom.png +0 -0
  64. data/doc/index.html +141 -0
  65. data/doc/js/darkfish.js +161 -0
  66. data/doc/js/jquery.js +4 -0
  67. data/doc/js/navigation.js +141 -0
  68. data/doc/js/navigation.js.gz +0 -0
  69. data/doc/js/search.js +109 -0
  70. data/doc/js/search_index.js +1 -0
  71. data/doc/js/search_index.js.gz +0 -0
  72. data/doc/js/searcher.js +229 -0
  73. data/doc/js/searcher.js.gz +0 -0
  74. data/doc/table_of_contents.html +1036 -0
  75. data/docs/AnswerMetadata.md +1 -1
  76. data/docs/CreatePromptRequest.md +3 -3
  77. data/docs/Prompt.md +3 -3
  78. data/docs/PromptAnswer.md +1 -1
  79. data/docs/PromptMetadata.md +2 -2
  80. data/docs/PromptStatus.md +1 -0
  81. data/lib/approveapi_swagger/api/approve_api.rb +1 -0
  82. data/lib/approveapi_swagger/models/answer_metadata.rb +15 -13
  83. data/lib/approveapi_swagger/models/create_prompt_request.rb +35 -33
  84. data/lib/approveapi_swagger/models/error.rb +2 -0
  85. data/lib/approveapi_swagger/models/prompt.rb +33 -26
  86. data/lib/approveapi_swagger/models/prompt_answer.rb +18 -16
  87. data/lib/approveapi_swagger/models/prompt_metadata.rb +26 -24
  88. data/lib/approveapi_swagger/models/prompt_status.rb +21 -4
  89. data/lib/approveapi_swagger/version.rb +1 -1
  90. data/pkg/approveapi_swagger-1.0.2.gem +0 -0
  91. metadata +78 -7
  92. data/pkg/approveapi_swagger-1.0.1.gem +0 -0
data/doc/docs/ApproveApi_md.html ADDED
@@ -0,0 +1,293 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>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="file">
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
+ <div class="nav-section">
57
+ <h3>Table of Contents</h3>
58
+
59
+ <ul class="link-list" role="directory">
60
+ <li><a href="#label-ApproveAPISwagger-3A-3AApproveApi">ApproveAPISwagger::ApproveApi</a>
61
+ <li><a href="#label-create_prompt"><strong>create_prompt</strong></a>
62
+ <li><a href="#label-Example">Example</a>
63
+ <li><a href="#label-Parameters">Parameters</a>
64
+ <li><a href="#label-Return+type">Return type</a>
65
+ <li><a href="#label-Authorization">Authorization</a>
66
+ <li><a href="#label-HTTP+request+headers">HTTP request headers</a>
67
+ <li><a href="#label-get_prompt"><strong>get_prompt</strong></a>
68
+ <li><a href="#label-Example">Example</a>
69
+ <li><a href="#label-Parameters">Parameters</a>
70
+ <li><a href="#label-Return+type">Return type</a>
71
+ <li><a href="#label-Authorization">Authorization</a>
72
+ <li><a href="#label-HTTP+request+headers">HTTP request headers</a>
73
+ <li><a href="#label-get_prompt_status"><strong>get_prompt_status</strong></a>
74
+ <li><a href="#label-Example">Example</a>
75
+ <li><a href="#label-Parameters">Parameters</a>
76
+ <li><a href="#label-Return+type">Return type</a>
77
+ <li><a href="#label-Authorization">Authorization</a>
78
+ <li><a href="#label-HTTP+request+headers">HTTP request headers</a>
79
+ </ul>
80
+ </div>
81
+
82
+
83
+ <div id="project-metadata">
84
+ <div id="fileindex-section" class="nav-section">
85
+ <h3>Pages</h3>
86
+
87
+ <ul class="link-list">
88
+
89
+ <li><a href="../Gemfile.html">Gemfile</a>
90
+
91
+ <li><a href="../Gemfile_lock.html">Gemfile.lock</a>
92
+
93
+ <li><a href="../README_md.html">README</a>
94
+
95
+ <li><a href="../Rakefile.html">Rakefile</a>
96
+
97
+ <li><a href="../approveapi_swagger_gemspec.html">approveapi_swagger.gemspec</a>
98
+
99
+ <li><a href="../docs/AnswerMetadata_md.html">AnswerMetadata</a>
100
+
101
+ <li><a href="../docs/ApproveApi_md.html">ApproveApi</a>
102
+
103
+ <li><a href="../docs/CreatePromptRequest_md.html">CreatePromptRequest</a>
104
+
105
+ <li><a href="../docs/Error_md.html">Error</a>
106
+
107
+ <li><a href="../docs/Prompt_md.html">Prompt</a>
108
+
109
+ <li><a href="../docs/PromptAnswer_md.html">PromptAnswer</a>
110
+
111
+ <li><a href="../docs/PromptMetadata_md.html">PromptMetadata</a>
112
+
113
+ <li><a href="../docs/PromptStatus_md.html">PromptStatus</a>
114
+
115
+ <li><a href="../git_push_sh.html">git_push.sh</a>
116
+
117
+ </ul>
118
+ </div>
119
+
120
+ </div>
121
+ </nav>
122
+
123
+ <main role="main" aria-label="Page docs/ApproveApi.md">
124
+
125
+ <h1 id="label-ApproveAPISwagger-3A-3AApproveApi"><a href="../ApproveAPISwagger/ApproveApi.html"><code>ApproveAPISwagger::ApproveApi</code></a><span><a href="#label-ApproveAPISwagger-3A-3AApproveApi">&para;</a> <a href="#top">&uarr;</a></span></h1>
126
+
127
+ <p>All URIs are relative to <em><a href="https://approve.sh">approve.sh</a></em></p>
128
+
129
+ <p>Method | HTTP request | Description ————- | ————- | ————- <a href="ApproveApi.md#create_prompt">create_prompt</a> | <strong>POST</strong> /prompt | Sending a prompt <a href="ApproveApi.md#get_prompt">get_prompt</a> | <strong>GET</strong> /prompt/<a href="ApproveApi.md#get_prompt_status">id} | Retrieve a prompt {get_prompt_status</a> | <strong>GET</strong> /prompt/{id}/status | Check prompt status</p>
130
+
131
+ <h1 id="label-create_prompt"><strong>create_prompt</strong><span><a href="#label-create_prompt">&para;</a> <a href="#top">&uarr;</a></span></h1>
132
+
133
+ <blockquote>
134
+ <p><a href="Prompt_md.html">Prompt</a> create_prompt(create_prompt_request)</p>
135
+ </blockquote>
136
+
137
+ <p>Sending a prompt</p>
138
+
139
+ <p>Creates a prompt and pushes it to the user (sends via email, sms, or other supported protocols).</p>
140
+
141
+ <h3 id="label-Example">Example<span><a href="#label-Example">&para;</a> <a href="#top">&uarr;</a></span></h3>
142
+
143
+ <pre class="ruby"><span class="ruby-comment"># load the gem</span>
144
+ <span class="ruby-identifier">require</span> <span class="ruby-string">&#39;approveapi_swagger&#39;</span>
145
+ <span class="ruby-comment"># setup authorization</span>
146
+ <span class="ruby-constant">ApproveAPISwagger</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">config</span><span class="ruby-operator">|</span>
147
+ <span class="ruby-comment"># Configure HTTP basic authorization: apiKey</span>
148
+ <span class="ruby-identifier">config</span>.<span class="ruby-identifier">username</span> = <span class="ruby-string">&#39;YOUR USERNAME&#39;</span>
149
+ <span class="ruby-identifier">config</span>.<span class="ruby-identifier">password</span> = <span class="ruby-string">&#39;YOUR PASSWORD&#39;</span>
150
+ <span class="ruby-keyword">end</span>
151
+
152
+ <span class="ruby-identifier">api_instance</span> = <span class="ruby-constant">ApproveAPISwagger</span><span class="ruby-operator">::</span><span class="ruby-constant">ApproveApi</span>.<span class="ruby-identifier">new</span>
153
+ <span class="ruby-identifier">create_prompt_request</span> = <span class="ruby-constant">ApproveAPISwagger</span><span class="ruby-operator">::</span><span class="ruby-constant">CreatePromptRequest</span>.<span class="ruby-identifier">new</span> <span class="ruby-comment"># CreatePromptRequest |</span>
154
+
155
+ <span class="ruby-keyword">begin</span>
156
+ <span class="ruby-comment">#Sending a prompt</span>
157
+ <span class="ruby-identifier">result</span> = <span class="ruby-identifier">api_instance</span>.<span class="ruby-identifier">create_prompt</span>(<span class="ruby-identifier">create_prompt_request</span>)
158
+ <span class="ruby-identifier">p</span> <span class="ruby-identifier">result</span>
159
+ <span class="ruby-keyword">rescue</span> <span class="ruby-constant">ApproveAPISwagger</span><span class="ruby-operator">::</span><span class="ruby-constant">ApiError</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">e</span>
160
+ <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Exception when calling ApproveApi-&gt;create_prompt: #{e}&quot;</span>
161
+ <span class="ruby-keyword">end</span>
162
+ </pre>
163
+
164
+ <h3 id="label-Parameters">Parameters<span><a href="#label-Parameters">&para;</a> <a href="#top">&uarr;</a></span></h3>
165
+
166
+ <p>Name | Type | Description | Notes ————- | ————- | ————- | ————- <strong>create_prompt_request</strong> | <a href="CreatePromptRequest.md">CreatePromptRequest</a>| |</p>
167
+
168
+ <h3 id="label-Return+type">Return type<span><a href="#label-Return+type">&para;</a> <a href="#top">&uarr;</a></span></h3>
169
+
170
+ <p><a href="Prompt.md">Prompt</a></p>
171
+
172
+ <h3 id="label-Authorization">Authorization<span><a href="#label-Authorization">&para;</a> <a href="#top">&uarr;</a></span></h3>
173
+
174
+ <p><a href="../README.md#apiKey">apiKey</a></p>
175
+
176
+ <h3 id="label-HTTP+request+headers">HTTP request headers<span><a href="#label-HTTP+request+headers">&para;</a> <a href="#top">&uarr;</a></span></h3>
177
+ <ul><li>
178
+ <p><strong>Content-Type</strong>: application/json</p>
179
+ </li><li>
180
+ <p><strong>Accept</strong>: application/json</p>
181
+ </li></ul>
182
+
183
+ <h1 id="label-get_prompt"><strong>get_prompt</strong><span><a href="#label-get_prompt">&para;</a> <a href="#top">&uarr;</a></span></h1>
184
+
185
+ <blockquote>
186
+ <p><a href="Prompt_md.html">Prompt</a> get_prompt(id, opts)</p>
187
+ </blockquote>
188
+
189
+ <p>Retrieve a prompt</p>
190
+
191
+ <p>Retrieve the prompt object with the given ID.</p>
192
+
193
+ <h3 id="label-Example">Example<span><a href="#label-Example">&para;</a> <a href="#top">&uarr;</a></span></h3>
194
+
195
+ <pre class="ruby"><span class="ruby-comment"># load the gem</span>
196
+ <span class="ruby-identifier">require</span> <span class="ruby-string">&#39;approveapi_swagger&#39;</span>
197
+ <span class="ruby-comment"># setup authorization</span>
198
+ <span class="ruby-constant">ApproveAPISwagger</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">config</span><span class="ruby-operator">|</span>
199
+ <span class="ruby-comment"># Configure HTTP basic authorization: apiKey</span>
200
+ <span class="ruby-identifier">config</span>.<span class="ruby-identifier">username</span> = <span class="ruby-string">&#39;YOUR USERNAME&#39;</span>
201
+ <span class="ruby-identifier">config</span>.<span class="ruby-identifier">password</span> = <span class="ruby-string">&#39;YOUR PASSWORD&#39;</span>
202
+ <span class="ruby-keyword">end</span>
203
+
204
+ <span class="ruby-identifier">api_instance</span> = <span class="ruby-constant">ApproveAPISwagger</span><span class="ruby-operator">::</span><span class="ruby-constant">ApproveApi</span>.<span class="ruby-identifier">new</span>
205
+ <span class="ruby-identifier">id</span> = <span class="ruby-string">&#39;id_example&#39;</span> <span class="ruby-comment"># String | The identifier for a pending or completed prompt. This is returned when you create a prompt.</span>
206
+ <span class="ruby-identifier">opts</span> = {
207
+ <span class="ruby-value">long_poll:</span> <span class="ruby-keyword">true</span> <span class="ruby-comment"># BOOLEAN | If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false.</span>
208
+ }
209
+
210
+ <span class="ruby-keyword">begin</span>
211
+ <span class="ruby-comment">#Retrieve a prompt</span>
212
+ <span class="ruby-identifier">result</span> = <span class="ruby-identifier">api_instance</span>.<span class="ruby-identifier">get_prompt</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">opts</span>)
213
+ <span class="ruby-identifier">p</span> <span class="ruby-identifier">result</span>
214
+ <span class="ruby-keyword">rescue</span> <span class="ruby-constant">ApproveAPISwagger</span><span class="ruby-operator">::</span><span class="ruby-constant">ApiError</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">e</span>
215
+ <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Exception when calling ApproveApi-&gt;get_prompt: #{e}&quot;</span>
216
+ <span class="ruby-keyword">end</span>
217
+ </pre>
218
+
219
+ <h3 id="label-Parameters">Parameters<span><a href="#label-Parameters">&para;</a> <a href="#top">&uarr;</a></span></h3>
220
+
221
+ <p>Name | Type | Description | Notes ————- | ————- | ————- | ————- <strong>id</strong> | <strong>String</strong>| The identifier for a pending or completed prompt. This is returned when you create a prompt. | <strong>long_poll</strong> | <strong>BOOLEAN</strong>| If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false. | [optional]</p>
222
+
223
+ <h3 id="label-Return+type">Return type<span><a href="#label-Return+type">&para;</a> <a href="#top">&uarr;</a></span></h3>
224
+
225
+ <p><a href="Prompt.md">Prompt</a></p>
226
+
227
+ <h3 id="label-Authorization">Authorization<span><a href="#label-Authorization">&para;</a> <a href="#top">&uarr;</a></span></h3>
228
+
229
+ <p><a href="../README.md#apiKey">apiKey</a></p>
230
+
231
+ <h3 id="label-HTTP+request+headers">HTTP request headers<span><a href="#label-HTTP+request+headers">&para;</a> <a href="#top">&uarr;</a></span></h3>
232
+ <ul><li>
233
+ <p><strong>Content-Type</strong>: Not defined</p>
234
+ </li><li>
235
+ <p><strong>Accept</strong>: application/json</p>
236
+ </li></ul>
237
+
238
+ <h1 id="label-get_prompt_status"><strong>get_prompt_status</strong><span><a href="#label-get_prompt_status">&para;</a> <a href="#top">&uarr;</a></span></h1>
239
+
240
+ <blockquote>
241
+ <p><a href="PromptStatus_md.html">PromptStatus</a> get_prompt_status(id)</p>
242
+ </blockquote>
243
+
244
+ <p>Check prompt status</p>
245
+
246
+ <p>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.</p>
247
+
248
+ <h3 id="label-Example">Example<span><a href="#label-Example">&para;</a> <a href="#top">&uarr;</a></span></h3>
249
+
250
+ <pre class="ruby"><span class="ruby-comment"># load the gem</span>
251
+ <span class="ruby-identifier">require</span> <span class="ruby-string">&#39;approveapi_swagger&#39;</span>
252
+
253
+ <span class="ruby-identifier">api_instance</span> = <span class="ruby-constant">ApproveAPISwagger</span><span class="ruby-operator">::</span><span class="ruby-constant">ApproveApi</span>.<span class="ruby-identifier">new</span>
254
+ <span class="ruby-identifier">id</span> = <span class="ruby-string">&#39;id_example&#39;</span> <span class="ruby-comment"># String | The prompt identifier.</span>
255
+
256
+ <span class="ruby-keyword">begin</span>
257
+ <span class="ruby-comment">#Check prompt status</span>
258
+ <span class="ruby-identifier">result</span> = <span class="ruby-identifier">api_instance</span>.<span class="ruby-identifier">get_prompt_status</span>(<span class="ruby-identifier">id</span>)
259
+ <span class="ruby-identifier">p</span> <span class="ruby-identifier">result</span>
260
+ <span class="ruby-keyword">rescue</span> <span class="ruby-constant">ApproveAPISwagger</span><span class="ruby-operator">::</span><span class="ruby-constant">ApiError</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-identifier">e</span>
261
+ <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Exception when calling ApproveApi-&gt;get_prompt_status: #{e}&quot;</span>
262
+ <span class="ruby-keyword">end</span>
263
+ </pre>
264
+
265
+ <h3 id="label-Parameters">Parameters<span><a href="#label-Parameters">&para;</a> <a href="#top">&uarr;</a></span></h3>
266
+
267
+ <p>Name | Type | Description | Notes ————- | ————- | ————- | ————- <strong>id</strong> | <strong>String</strong>| The prompt identifier. |</p>
268
+
269
+ <h3 id="label-Return+type">Return type<span><a href="#label-Return+type">&para;</a> <a href="#top">&uarr;</a></span></h3>
270
+
271
+ <p><a href="PromptStatus.md">PromptStatus</a></p>
272
+
273
+ <h3 id="label-Authorization">Authorization<span><a href="#label-Authorization">&para;</a> <a href="#top">&uarr;</a></span></h3>
274
+
275
+ <p>No authorization required</p>
276
+
277
+ <h3 id="label-HTTP+request+headers">HTTP request headers<span><a href="#label-HTTP+request+headers">&para;</a> <a href="#top">&uarr;</a></span></h3>
278
+ <ul><li>
279
+ <p><strong>Content-Type</strong>: Not defined</p>
280
+ </li><li>
281
+ <p><strong>Accept</strong>: application/json</p>
282
+ </li></ul>
283
+
284
+ </main>
285
+
286
+
287
+
288
+ <footer id="validator-badges" role="contentinfo">
289
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
290
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.1.
291
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
292
+ </footer>
293
+
data/doc/docs/CreatePromptRequest_md.html ADDED
@@ -0,0 +1,123 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>CreatePromptRequest - 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="file">
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
+ <div class="nav-section">
57
+ <h3>Table of Contents</h3>
58
+
59
+ <ul class="link-list" role="directory">
60
+ <li><a href="#label-ApproveAPISwagger-3A-3ACreatePromptRequest">ApproveAPISwagger::CreatePromptRequest</a>
61
+ <li><a href="#label-Properties">Properties</a>
62
+ </ul>
63
+ </div>
64
+
65
+
66
+ <div id="project-metadata">
67
+ <div id="fileindex-section" class="nav-section">
68
+ <h3>Pages</h3>
69
+
70
+ <ul class="link-list">
71
+
72
+ <li><a href="../Gemfile.html">Gemfile</a>
73
+
74
+ <li><a href="../Gemfile_lock.html">Gemfile.lock</a>
75
+
76
+ <li><a href="../README_md.html">README</a>
77
+
78
+ <li><a href="../Rakefile.html">Rakefile</a>
79
+
80
+ <li><a href="../approveapi_swagger_gemspec.html">approveapi_swagger.gemspec</a>
81
+
82
+ <li><a href="../docs/AnswerMetadata_md.html">AnswerMetadata</a>
83
+
84
+ <li><a href="../docs/ApproveApi_md.html">ApproveApi</a>
85
+
86
+ <li><a href="../docs/CreatePromptRequest_md.html">CreatePromptRequest</a>
87
+
88
+ <li><a href="../docs/Error_md.html">Error</a>
89
+
90
+ <li><a href="../docs/Prompt_md.html">Prompt</a>
91
+
92
+ <li><a href="../docs/PromptAnswer_md.html">PromptAnswer</a>
93
+
94
+ <li><a href="../docs/PromptMetadata_md.html">PromptMetadata</a>
95
+
96
+ <li><a href="../docs/PromptStatus_md.html">PromptStatus</a>
97
+
98
+ <li><a href="../git_push_sh.html">git_push.sh</a>
99
+
100
+ </ul>
101
+ </div>
102
+
103
+ </div>
104
+ </nav>
105
+
106
+ <main role="main" aria-label="Page docs/CreatePromptRequest.md">
107
+
108
+ <h1 id="label-ApproveAPISwagger-3A-3ACreatePromptRequest"><a href="../ApproveAPISwagger/CreatePromptRequest.html"><code>ApproveAPISwagger::CreatePromptRequest</code></a><span><a href="#label-ApproveAPISwagger-3A-3ACreatePromptRequest">&para;</a> <a href="#top">&uarr;</a></span></h1>
109
+
110
+ <h2 id="label-Properties">Properties<span><a href="#label-Properties">&para;</a> <a href="#top">&uarr;</a></span></h2>
111
+
112
+ <p>Name | Type | Description | Notes ———— | ————- | ————- | ————- <strong>body</strong> | <strong>String</strong> | The body of the approval request to show the user. | <strong>user</strong> | <strong>String</strong> | The user to send the approval request to. Can be either an email address or a phone number. | <strong>title</strong> | <strong>String</strong> | The title of an approval request. Defaults to an empty string. | [optional] <strong>reject_text</strong> | <strong>String</strong> | The reject action text. Defaults to &#39;Reject&#39;. | [optional] <strong>approve_text</strong> | <strong>String</strong> | The approve action text. Defaults to &#39;Approve&#39;. | [optional] <strong>metadata</strong> | <a href="PromptMetadata.md">PromptMetadata</a> | | [optional] <strong>long_poll</strong> | <strong>BOOLEAN</strong> | If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false. | [optional]</p>
113
+
114
+ </main>
115
+
116
+
117
+
118
+ <footer id="validator-badges" role="contentinfo">
119
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
120
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.1.
121
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
122
+ </footer>
123
+
data/doc/docs/Error_md.html ADDED
@@ -0,0 +1,123 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>Error - 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="file">
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
+ <div class="nav-section">
57
+ <h3>Table of Contents</h3>
58
+
59
+ <ul class="link-list" role="directory">
60
+ <li><a href="#label-ApproveAPISwagger-3A-3AError">ApproveAPISwagger::Error</a>
61
+ <li><a href="#label-Properties">Properties</a>
62
+ </ul>
63
+ </div>
64
+
65
+
66
+ <div id="project-metadata">
67
+ <div id="fileindex-section" class="nav-section">
68
+ <h3>Pages</h3>
69
+
70
+ <ul class="link-list">
71
+
72
+ <li><a href="../Gemfile.html">Gemfile</a>
73
+
74
+ <li><a href="../Gemfile_lock.html">Gemfile.lock</a>
75
+
76
+ <li><a href="../README_md.html">README</a>
77
+
78
+ <li><a href="../Rakefile.html">Rakefile</a>
79
+
80
+ <li><a href="../approveapi_swagger_gemspec.html">approveapi_swagger.gemspec</a>
81
+
82
+ <li><a href="../docs/AnswerMetadata_md.html">AnswerMetadata</a>
83
+
84
+ <li><a href="../docs/ApproveApi_md.html">ApproveApi</a>
85
+
86
+ <li><a href="../docs/CreatePromptRequest_md.html">CreatePromptRequest</a>
87
+
88
+ <li><a href="../docs/Error_md.html">Error</a>
89
+
90
+ <li><a href="../docs/Prompt_md.html">Prompt</a>
91
+
92
+ <li><a href="../docs/PromptAnswer_md.html">PromptAnswer</a>
93
+
94
+ <li><a href="../docs/PromptMetadata_md.html">PromptMetadata</a>
95
+
96
+ <li><a href="../docs/PromptStatus_md.html">PromptStatus</a>
97
+
98
+ <li><a href="../git_push_sh.html">git_push.sh</a>
99
+
100
+ </ul>
101
+ </div>
102
+
103
+ </div>
104
+ </nav>
105
+
106
+ <main role="main" aria-label="Page docs/Error.md">
107
+
108
+ <h1 id="label-ApproveAPISwagger-3A-3AError"><a href="../ApproveAPISwagger/Error.html"><code>ApproveAPISwagger::Error</code></a><span><a href="#label-ApproveAPISwagger-3A-3AError">&para;</a> <a href="#top">&uarr;</a></span></h1>
109
+
110
+ <h2 id="label-Properties">Properties<span><a href="#label-Properties">&para;</a> <a href="#top">&uarr;</a></span></h2>
111
+
112
+ <p>Name | Type | Description | Notes ———— | ————- | ————- | ————- <strong>error</strong> | <strong>String</strong> | A human readable API error message. |</p>
113
+
114
+ </main>
115
+
116
+
117
+
118
+ <footer id="validator-badges" role="contentinfo">
119
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
120
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.1.
121
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
122
+ </footer>
123
+