Skip to content

Commit 1f09aa0

Browse files
Justintime50Justintime50
committed
deploy: c260b00 
1 parent 92a931f commit 1f09aa0

File tree

5 files changed

+329
-112
lines changed

5 files changed

+329
-112
lines changed

‎EasyPost/Services/ApiKey.html‎

Lines changed: 196 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,14 @@ <h3>Instance Methods</h3>
9595

9696
<li ><a href="#method-i-all">all</a></li>
9797

98+
<li ><a href="#method-i-create">create</a></li>
99+
100+
<li ><a href="#method-i-delete">delete</a></li>
101+
102+
<li ><a href="#method-i-disable">disable</a></li>
103+
104+
<li ><a href="#method-i-enable">enable</a></li>
105+
98106
<li ><a href="#method-i-retrieve_api_keys_for_user">retrieve_api_keys_for_user</a></li>
99107

100108
</ul>
@@ -185,11 +193,11 @@ <h3>Public Instance Methods</h3>
185193
<div class="method-description">
186194

187195
<div class="method-source-code" id="all-source">
188-
<pre><span class="ruby-comment"># File lib/easypost/services/api_key.rb, line 5</span>
196+
<pre><span class="ruby-comment"># File lib/easypost/services/api_key.rb, line 7</span>
189197
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">all</span>
190198
<span class="ruby-identifier">response</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">&#39;api_keys&#39;</span>)
191199

192-
<span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">InternalUtilities</span><span class="ruby-operator">::</span><span class="ruby-constant">Json</span>.<span class="ruby-identifier">convert_json_to_object</span>(<span class="ruby-identifier">response</span>, <span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">Models</span><span class="ruby-operator">::</span><span class="ruby-constant">ApiKey</span>)
200+
<span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">InternalUtilities</span><span class="ruby-operator">::</span><span class="ruby-constant">Json</span>.<span class="ruby-identifier">convert_json_to_object</span>(<span class="ruby-identifier">response</span>, <span class="ruby-constant">MODEL_CLASS</span>)
193201
<span class="ruby-keyword">end</span></pre>
194202
</div>
195203

@@ -204,6 +212,191 @@ <h3>Public Instance Methods</h3>
204212

205213

206214

215+
</div>
216+
217+
218+
<div id="method-i-create" class="method-detail anchor-link ">
219+
<div class="method-header">
220+
221+
<div class="method-heading">
222+
<a href="#method-i-create" title="Link to this method">
223+
<span class="method-name">create</span>
224+
<span class="method-args">(mode)</span>
225+
</a>
226+
</div>
227+
228+
</div>
229+
230+
231+
<div class="method-controls">
232+
<details class="method-source-toggle">
233+
<summary>Source</summary>
234+
</details>
235+
</div>
236+
237+
238+
239+
<div class="method-description">
240+
241+
<div class="method-source-code" id="create-source">
242+
<pre><span class="ruby-comment"># File lib/easypost/services/api_key.rb, line 33</span>
243+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create</span>(<span class="ruby-identifier">mode</span>)
244+
<span class="ruby-identifier">response</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:post</span>, <span class="ruby-string">&#39;api_keys&#39;</span>, { <span class="ruby-value">mode:</span> <span class="ruby-identifier">mode</span> })
245+
246+
<span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">InternalUtilities</span><span class="ruby-operator">::</span><span class="ruby-constant">Json</span>.<span class="ruby-identifier">convert_json_to_object</span>(<span class="ruby-identifier">response</span>, <span class="ruby-constant">MODEL_CLASS</span>)
247+
<span class="ruby-keyword">end</span></pre>
248+
</div>
249+
250+
251+
252+
<p>Create an API key for a child or referral customer user</p>
253+
254+
255+
</div>
256+
257+
258+
259+
260+
261+
</div>
262+
263+
264+
<div id="method-i-delete" class="method-detail anchor-link ">
265+
<div class="method-header">
266+
267+
<div class="method-heading">
268+
<a href="#method-i-delete" title="Link to this method">
269+
<span class="method-name">delete</span>
270+
<span class="method-args">(id)</span>
271+
</a>
272+
</div>
273+
274+
</div>
275+
276+
277+
<div class="method-controls">
278+
<details class="method-source-toggle">
279+
<summary>Source</summary>
280+
</details>
281+
</div>
282+
283+
284+
285+
<div class="method-description">
286+
287+
<div class="method-source-code" id="delete-source">
288+
<pre><span class="ruby-comment"># File lib/easypost/services/api_key.rb, line 40</span>
289+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete</span>(<span class="ruby-identifier">id</span>)
290+
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:delete</span>, <span class="ruby-node">&quot;api_keys/#{id}&quot;</span>)
291+
292+
<span class="ruby-comment"># Return true if succeeds, an error will be thrown if it fails</span>
293+
<span class="ruby-keyword">true</span>
294+
<span class="ruby-keyword">end</span></pre>
295+
</div>
296+
297+
298+
299+
<p>Delete an API key for a child or referral customer user</p>
300+
301+
302+
</div>
303+
304+
305+
306+
307+
308+
</div>
309+
310+
311+
<div id="method-i-disable" class="method-detail anchor-link ">
312+
<div class="method-header">
313+
314+
<div class="method-heading">
315+
<a href="#method-i-disable" title="Link to this method">
316+
<span class="method-name">disable</span>
317+
<span class="method-args">(id)</span>
318+
</a>
319+
</div>
320+
321+
</div>
322+
323+
324+
<div class="method-controls">
325+
<details class="method-source-toggle">
326+
<summary>Source</summary>
327+
</details>
328+
</div>
329+
330+
331+
332+
<div class="method-description">
333+
334+
<div class="method-source-code" id="disable-source">
335+
<pre><span class="ruby-comment"># File lib/easypost/services/api_key.rb, line 55</span>
336+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">disable</span>(<span class="ruby-identifier">id</span>)
337+
<span class="ruby-identifier">response</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:post</span>, <span class="ruby-node">&quot;api_keys/#{id}/disable&quot;</span>)
338+
339+
<span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">InternalUtilities</span><span class="ruby-operator">::</span><span class="ruby-constant">Json</span>.<span class="ruby-identifier">convert_json_to_object</span>(<span class="ruby-identifier">response</span>, <span class="ruby-constant">MODEL_CLASS</span>)
340+
<span class="ruby-keyword">end</span></pre>
341+
</div>
342+
343+
344+
345+
<p>Disable an API key for a child or referral customer user</p>
346+
347+
348+
</div>
349+
350+
351+
352+
353+
354+
</div>
355+
356+
357+
<div id="method-i-enable" class="method-detail anchor-link ">
358+
<div class="method-header">
359+
360+
<div class="method-heading">
361+
<a href="#method-i-enable" title="Link to this method">
362+
<span class="method-name">enable</span>
363+
<span class="method-args">(id)</span>
364+
</a>
365+
</div>
366+
367+
</div>
368+
369+
370+
<div class="method-controls">
371+
<details class="method-source-toggle">
372+
<summary>Source</summary>
373+
</details>
374+
</div>
375+
376+
377+
378+
<div class="method-description">
379+
380+
<div class="method-source-code" id="enable-source">
381+
<pre><span class="ruby-comment"># File lib/easypost/services/api_key.rb, line 48</span>
382+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">enable</span>(<span class="ruby-identifier">id</span>)
383+
<span class="ruby-identifier">response</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:post</span>, <span class="ruby-node">&quot;api_keys/#{id}/enable&quot;</span>)
384+
385+
<span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">InternalUtilities</span><span class="ruby-operator">::</span><span class="ruby-constant">Json</span>.<span class="ruby-identifier">convert_json_to_object</span>(<span class="ruby-identifier">response</span>, <span class="ruby-constant">MODEL_CLASS</span>)
386+
<span class="ruby-keyword">end</span></pre>
387+
</div>
388+
389+
390+
391+
<p>Enable an API key for a child or referral customer user</p>
392+
393+
394+
</div>
395+
396+
397+
398+
399+
207400
</div>
208401

209402

@@ -231,7 +424,7 @@ <h3>Public Instance Methods</h3>
231424
<div class="method-description">
232425

233426
<div class="method-source-code" id="retrieve_api_keys_for_user-source">
234-
<pre><span class="ruby-comment"># File lib/easypost/services/api_key.rb, line 12</span>
427+
<pre><span class="ruby-comment"># File lib/easypost/services/api_key.rb, line 14</span>
235428
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">retrieve_api_keys_for_user</span>(<span class="ruby-identifier">id</span>)
236429
<span class="ruby-identifier">api_keys</span> = <span class="ruby-identifier">all</span>
237430

0 commit comments

Comments
 (0)