easypost 4.8.1 → 4.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitattributes +5 -0
- data/.github/workflows/ci.yml +8 -0
- data/.gitignore +10 -14
- data/CHANGELOG.md +4 -0
- data/Makefile +10 -2
- data/README.md +5 -1
- data/VERSION +1 -1
- data/docs/EasyPost/Address.html +222 -0
- data/docs/EasyPost/ApiKey.html +99 -0
- data/docs/EasyPost/Batch.html +269 -0
- data/docs/EasyPost/Beta/EndShipper.html +225 -0
- data/docs/EasyPost/Beta/Referral.html +338 -0
- data/docs/EasyPost/Beta.html +91 -0
- data/docs/EasyPost/Billing.html +253 -0
- data/docs/EasyPost/Brand.html +140 -0
- data/docs/EasyPost/CarbonOffset.html +99 -0
- data/docs/EasyPost/CarrierAccount.html +136 -0
- data/docs/EasyPost/CarrierType.html +99 -0
- data/docs/EasyPost/CustomsInfo.html +136 -0
- data/docs/EasyPost/CustomsItem.html +136 -0
- data/docs/EasyPost/EasyPostObject.html +662 -0
- data/docs/EasyPost/EndShipper.html +175 -0
- data/docs/EasyPost/Error.html +258 -0
- data/docs/EasyPost/Event.html +136 -0
- data/docs/EasyPost/Insurance.html +99 -0
- data/docs/EasyPost/Order.html +222 -0
- data/docs/EasyPost/Parcel.html +136 -0
- data/docs/EasyPost/PaymentMethod.html +137 -0
- data/docs/EasyPost/Pickup.html +222 -0
- data/docs/EasyPost/PickupRate.html +99 -0
- data/docs/EasyPost/PostageLabel.html +99 -0
- data/docs/EasyPost/Rate.html +136 -0
- data/docs/EasyPost/Referral.html +334 -0
- data/docs/EasyPost/Refund.html +99 -0
- data/docs/EasyPost/Report.html +167 -0
- data/docs/EasyPost/Resource.html +399 -0
- data/docs/EasyPost/ScanForm.html +137 -0
- data/docs/EasyPost/Shipment.html +456 -0
- data/docs/EasyPost/TaxIdentifier.html +99 -0
- data/docs/EasyPost/Tracker.html +139 -0
- data/docs/EasyPost/User.html +307 -0
- data/docs/EasyPost/Util.html +462 -0
- data/docs/EasyPost/Webhook.html +221 -0
- data/docs/EasyPost.html +440 -0
- data/docs/created.rid +40 -0
- data/docs/css/fonts.css +167 -0
- data/docs/css/rdoc.css +639 -0
- data/docs/fonts/Lato-Light.ttf +0 -0
- data/docs/fonts/Lato-LightItalic.ttf +0 -0
- data/docs/fonts/Lato-Regular.ttf +0 -0
- data/docs/fonts/Lato-RegularItalic.ttf +0 -0
- data/docs/fonts/SourceCodePro-Bold.ttf +0 -0
- data/docs/fonts/SourceCodePro-Regular.ttf +0 -0
- data/docs/images/add.png +0 -0
- data/docs/images/arrow_up.png +0 -0
- data/docs/images/brick.png +0 -0
- data/docs/images/brick_link.png +0 -0
- data/docs/images/bug.png +0 -0
- data/docs/images/bullet_black.png +0 -0
- data/docs/images/bullet_toggle_minus.png +0 -0
- data/docs/images/bullet_toggle_plus.png +0 -0
- data/docs/images/date.png +0 -0
- data/docs/images/delete.png +0 -0
- data/docs/images/find.png +0 -0
- data/docs/images/loadingAnimation.gif +0 -0
- data/docs/images/macFFBgHack.png +0 -0
- data/docs/images/package.png +0 -0
- data/docs/images/page_green.png +0 -0
- data/docs/images/page_white_text.png +0 -0
- data/docs/images/page_white_width.png +0 -0
- data/docs/images/plugin.png +0 -0
- data/docs/images/ruby.png +0 -0
- data/docs/images/tag_blue.png +0 -0
- data/docs/images/tag_green.png +0 -0
- data/docs/images/transparent.png +0 -0
- data/docs/images/wrench.png +0 -0
- data/docs/images/wrench_orange.png +0 -0
- data/docs/images/zoom.png +0 -0
- data/docs/index.html +117 -0
- data/docs/js/darkfish.js +84 -0
- data/docs/js/navigation.js +105 -0
- data/docs/js/navigation.js.gz +0 -0
- data/docs/js/search.js +110 -0
- data/docs/js/search_index.js +1 -0
- data/docs/js/search_index.js.gz +0 -0
- data/docs/js/searcher.js +229 -0
- data/docs/js/searcher.js.gz +0 -0
- data/docs/table_of_contents.html +785 -0
- data/easypost.gemspec +3 -1
- data/lib/easypost/carrier_account.rb +17 -0
- data/lib/easypost/shipment.rb +1 -1
- data/lib/easypost/user.rb +5 -2
- data/lib/easypost/util.rb +2 -0
- metadata +115 -6
|
@@ -0,0 +1,269 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class EasyPost::Batch - EasyPost Ruby Docs</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../";
|
|
11
|
+
var index_rel_prefix = "../";
|
|
12
|
+
</script>
|
|
13
|
+
|
|
14
|
+
<script src="../js/navigation.js" defer></script>
|
|
15
|
+
<script src="../js/search.js" defer></script>
|
|
16
|
+
<script src="../js/search_index.js" defer></script>
|
|
17
|
+
<script src="../js/searcher.js" defer></script>
|
|
18
|
+
<script src="../js/darkfish.js" defer></script>
|
|
19
|
+
|
|
20
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
|
21
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<body id="top" role="document" class="class">
|
|
25
|
+
<nav role="navigation">
|
|
26
|
+
<div id="project-navigation">
|
|
27
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
28
|
+
<h2>
|
|
29
|
+
<a href="../index.html" rel="home">Home</a>
|
|
30
|
+
</h2>
|
|
31
|
+
|
|
32
|
+
<div id="table-of-contents-navigation">
|
|
33
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
|
34
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
35
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
36
|
+
</div>
|
|
37
|
+
</div>
|
|
38
|
+
|
|
39
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
40
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
41
|
+
<div id="search-field-wrapper">
|
|
42
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
43
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
44
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
45
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
<ul id="search-results" aria-label="Search Results"
|
|
49
|
+
aria-busy="false" aria-expanded="false"
|
|
50
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
51
|
+
</form>
|
|
52
|
+
</div>
|
|
53
|
+
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
<div id="class-metadata">
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
<div id="parent-class-section" class="nav-section">
|
|
62
|
+
<h3>Parent</h3>
|
|
63
|
+
|
|
64
|
+
<p class="link"><a href="Resource.html">EasyPost::Resource</a>
|
|
65
|
+
</div>
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
<!-- Method Quickref -->
|
|
71
|
+
<div id="method-list-section" class="nav-section">
|
|
72
|
+
<h3>Methods</h3>
|
|
73
|
+
|
|
74
|
+
<ul class="link-list" role="directory">
|
|
75
|
+
<li ><a href="#method-c-create_and_buy">::create_and_buy</a>
|
|
76
|
+
<li ><a href="#method-i-add_shipments">#add_shipments</a>
|
|
77
|
+
<li ><a href="#method-i-buy">#buy</a>
|
|
78
|
+
<li ><a href="#method-i-create_scan_form">#create_scan_form</a>
|
|
79
|
+
<li ><a href="#method-i-label">#label</a>
|
|
80
|
+
<li ><a href="#method-i-remove_shipments">#remove_shipments</a>
|
|
81
|
+
</ul>
|
|
82
|
+
</div>
|
|
83
|
+
|
|
84
|
+
</div>
|
|
85
|
+
</nav>
|
|
86
|
+
|
|
87
|
+
<main role="main" aria-labelledby="class-EasyPost::Batch">
|
|
88
|
+
<h1 id="class-EasyPost::Batch" class="class">
|
|
89
|
+
class EasyPost::Batch
|
|
90
|
+
</h1>
|
|
91
|
+
|
|
92
|
+
<section class="description">
|
|
93
|
+
|
|
94
|
+
<p>The <a href="Batch.html"><code>Batch</code></a> object allows you to perform operations on multiple Shipments at once.</p>
|
|
95
|
+
|
|
96
|
+
</section>
|
|
97
|
+
|
|
98
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
105
|
+
<header>
|
|
106
|
+
<h3>Public Class Methods</h3>
|
|
107
|
+
</header>
|
|
108
|
+
|
|
109
|
+
<div id="method-c-create_and_buy" class="method-detail ">
|
|
110
|
+
<div class="method-heading">
|
|
111
|
+
<span class="method-name">create_and_buy</span><span
|
|
112
|
+
class="method-args">(params = {}, api_key = nil)</span>
|
|
113
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
114
|
+
</div>
|
|
115
|
+
|
|
116
|
+
<div class="method-description">
|
|
117
|
+
<p>Create and buy a batch in one call.</p>
|
|
118
|
+
|
|
119
|
+
<div class="method-source-code" id="create_and_buy-source">
|
|
120
|
+
<pre><span class="ruby-comment"># File lib/easypost/batch.rb, line 6</span>
|
|
121
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">create_and_buy</span>(<span class="ruby-identifier">params</span> = {}, <span class="ruby-identifier">api_key</span> = <span class="ruby-keyword">nil</span>)
|
|
122
|
+
<span class="ruby-identifier">wrapped_params</span> = {}
|
|
123
|
+
<span class="ruby-identifier">wrapped_params</span>[<span class="ruby-identifier">class_name</span>.<span class="ruby-identifier">to_sym</span>] = <span class="ruby-identifier">params</span>
|
|
124
|
+
<span class="ruby-identifier">response</span> = <span class="ruby-constant">EasyPost</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:post</span>, <span class="ruby-node">"#{url}/create_and_buy"</span>, <span class="ruby-identifier">api_key</span>, <span class="ruby-identifier">wrapped_params</span>)
|
|
125
|
+
|
|
126
|
+
<span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">convert_to_easypost_object</span>(<span class="ruby-identifier">response</span>, <span class="ruby-identifier">api_key</span>)
|
|
127
|
+
<span class="ruby-keyword">end</span></pre>
|
|
128
|
+
</div>
|
|
129
|
+
</div>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
</div>
|
|
133
|
+
|
|
134
|
+
</section>
|
|
135
|
+
|
|
136
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
137
|
+
<header>
|
|
138
|
+
<h3>Public Instance Methods</h3>
|
|
139
|
+
</header>
|
|
140
|
+
|
|
141
|
+
<div id="method-i-add_shipments" class="method-detail ">
|
|
142
|
+
<div class="method-heading">
|
|
143
|
+
<span class="method-name">add_shipments</span><span
|
|
144
|
+
class="method-args">(params = {})</span>
|
|
145
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
146
|
+
</div>
|
|
147
|
+
|
|
148
|
+
<div class="method-description">
|
|
149
|
+
<p>Add Shipments to a <a href="Batch.html"><code>Batch</code></a>.</p>
|
|
150
|
+
|
|
151
|
+
<div class="method-source-code" id="add_shipments-source">
|
|
152
|
+
<pre><span class="ruby-comment"># File lib/easypost/batch.rb, line 39</span>
|
|
153
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_shipments</span>(<span class="ruby-identifier">params</span> = {})
|
|
154
|
+
<span class="ruby-identifier">response</span> = <span class="ruby-constant">EasyPost</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:post</span>, <span class="ruby-node">"#{url}/add_shipments"</span>, <span class="ruby-ivar">@api_key</span>, <span class="ruby-identifier">params</span>)
|
|
155
|
+
<span class="ruby-identifier">refresh_from</span>(<span class="ruby-identifier">response</span>, <span class="ruby-ivar">@api_key</span>)
|
|
156
|
+
|
|
157
|
+
<span class="ruby-keyword">self</span>
|
|
158
|
+
<span class="ruby-keyword">end</span></pre>
|
|
159
|
+
</div>
|
|
160
|
+
</div>
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
</div>
|
|
164
|
+
|
|
165
|
+
<div id="method-i-buy" class="method-detail ">
|
|
166
|
+
<div class="method-heading">
|
|
167
|
+
<span class="method-name">buy</span><span
|
|
168
|
+
class="method-args">(params = {})</span>
|
|
169
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
170
|
+
</div>
|
|
171
|
+
|
|
172
|
+
<div class="method-description">
|
|
173
|
+
<p>Buy a <a href="Batch.html"><code>Batch</code></a>.</p>
|
|
174
|
+
|
|
175
|
+
<div class="method-source-code" id="buy-source">
|
|
176
|
+
<pre><span class="ruby-comment"># File lib/easypost/batch.rb, line 15</span>
|
|
177
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">buy</span>(<span class="ruby-identifier">params</span> = {})
|
|
178
|
+
<span class="ruby-identifier">response</span> = <span class="ruby-constant">EasyPost</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:post</span>, <span class="ruby-node">"#{url}/buy"</span>, <span class="ruby-ivar">@api_key</span>, <span class="ruby-identifier">params</span>)
|
|
179
|
+
<span class="ruby-identifier">refresh_from</span>(<span class="ruby-identifier">response</span>, <span class="ruby-ivar">@api_key</span>)
|
|
180
|
+
|
|
181
|
+
<span class="ruby-keyword">self</span>
|
|
182
|
+
<span class="ruby-keyword">end</span></pre>
|
|
183
|
+
</div>
|
|
184
|
+
</div>
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
</div>
|
|
188
|
+
|
|
189
|
+
<div id="method-i-create_scan_form" class="method-detail ">
|
|
190
|
+
<div class="method-heading">
|
|
191
|
+
<span class="method-name">create_scan_form</span><span
|
|
192
|
+
class="method-args">(params = {})</span>
|
|
193
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
194
|
+
</div>
|
|
195
|
+
|
|
196
|
+
<div class="method-description">
|
|
197
|
+
<p>Create a ScanForm for a <a href="Batch.html"><code>Batch</code></a>.</p>
|
|
198
|
+
|
|
199
|
+
<div class="method-source-code" id="create_scan_form-source">
|
|
200
|
+
<pre><span class="ruby-comment"># File lib/easypost/batch.rb, line 47</span>
|
|
201
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_scan_form</span>(<span class="ruby-identifier">params</span> = {})
|
|
202
|
+
<span class="ruby-constant">EasyPost</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:post</span>, <span class="ruby-node">"#{url}/scan_form"</span>, <span class="ruby-ivar">@api_key</span>, <span class="ruby-identifier">params</span>)
|
|
203
|
+
<span class="ruby-keyword">end</span></pre>
|
|
204
|
+
</div>
|
|
205
|
+
</div>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
</div>
|
|
209
|
+
|
|
210
|
+
<div id="method-i-label" class="method-detail ">
|
|
211
|
+
<div class="method-heading">
|
|
212
|
+
<span class="method-name">label</span><span
|
|
213
|
+
class="method-args">(params = {})</span>
|
|
214
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
215
|
+
</div>
|
|
216
|
+
|
|
217
|
+
<div class="method-description">
|
|
218
|
+
<p>Convert the label format of a <a href="Batch.html"><code>Batch</code></a>.</p>
|
|
219
|
+
|
|
220
|
+
<div class="method-source-code" id="label-source">
|
|
221
|
+
<pre><span class="ruby-comment"># File lib/easypost/batch.rb, line 23</span>
|
|
222
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">label</span>(<span class="ruby-identifier">params</span> = {})
|
|
223
|
+
<span class="ruby-identifier">response</span> = <span class="ruby-constant">EasyPost</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:post</span>, <span class="ruby-node">"#{url}/label"</span>, <span class="ruby-ivar">@api_key</span>, <span class="ruby-identifier">params</span>)
|
|
224
|
+
<span class="ruby-identifier">refresh_from</span>(<span class="ruby-identifier">response</span>, <span class="ruby-ivar">@api_key</span>)
|
|
225
|
+
|
|
226
|
+
<span class="ruby-keyword">self</span>
|
|
227
|
+
<span class="ruby-keyword">end</span></pre>
|
|
228
|
+
</div>
|
|
229
|
+
</div>
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
</div>
|
|
233
|
+
|
|
234
|
+
<div id="method-i-remove_shipments" class="method-detail ">
|
|
235
|
+
<div class="method-heading">
|
|
236
|
+
<span class="method-name">remove_shipments</span><span
|
|
237
|
+
class="method-args">(params = {})</span>
|
|
238
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
239
|
+
</div>
|
|
240
|
+
|
|
241
|
+
<div class="method-description">
|
|
242
|
+
<p>Remove Shipments from a <a href="Batch.html"><code>Batch</code></a>.</p>
|
|
243
|
+
|
|
244
|
+
<div class="method-source-code" id="remove_shipments-source">
|
|
245
|
+
<pre><span class="ruby-comment"># File lib/easypost/batch.rb, line 31</span>
|
|
246
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">remove_shipments</span>(<span class="ruby-identifier">params</span> = {})
|
|
247
|
+
<span class="ruby-identifier">response</span> = <span class="ruby-constant">EasyPost</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:post</span>, <span class="ruby-node">"#{url}/remove_shipments"</span>, <span class="ruby-ivar">@api_key</span>, <span class="ruby-identifier">params</span>)
|
|
248
|
+
<span class="ruby-identifier">refresh_from</span>(<span class="ruby-identifier">response</span>, <span class="ruby-ivar">@api_key</span>)
|
|
249
|
+
|
|
250
|
+
<span class="ruby-keyword">self</span>
|
|
251
|
+
<span class="ruby-keyword">end</span></pre>
|
|
252
|
+
</div>
|
|
253
|
+
</div>
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
</div>
|
|
257
|
+
|
|
258
|
+
</section>
|
|
259
|
+
|
|
260
|
+
</section>
|
|
261
|
+
</main>
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
<footer id="validator-badges" role="contentinfo">
|
|
265
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
266
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
|
|
267
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
268
|
+
</footer>
|
|
269
|
+
|
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class EasyPost::Beta::EndShipper - EasyPost Ruby Docs</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../../";
|
|
11
|
+
var index_rel_prefix = "../../";
|
|
12
|
+
</script>
|
|
13
|
+
|
|
14
|
+
<script src="../../js/navigation.js" defer></script>
|
|
15
|
+
<script src="../../js/search.js" defer></script>
|
|
16
|
+
<script src="../../js/search_index.js" defer></script>
|
|
17
|
+
<script src="../../js/searcher.js" defer></script>
|
|
18
|
+
<script src="../../js/darkfish.js" defer></script>
|
|
19
|
+
|
|
20
|
+
<link href="../../css/fonts.css" rel="stylesheet">
|
|
21
|
+
<link href="../../css/rdoc.css" rel="stylesheet">
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<body id="top" role="document" class="class">
|
|
25
|
+
<nav role="navigation">
|
|
26
|
+
<div id="project-navigation">
|
|
27
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
28
|
+
<h2>
|
|
29
|
+
<a href="../../index.html" rel="home">Home</a>
|
|
30
|
+
</h2>
|
|
31
|
+
|
|
32
|
+
<div id="table-of-contents-navigation">
|
|
33
|
+
<a href="../../table_of_contents.html#pages">Pages</a>
|
|
34
|
+
<a href="../../table_of_contents.html#classes">Classes</a>
|
|
35
|
+
<a href="../../table_of_contents.html#methods">Methods</a>
|
|
36
|
+
</div>
|
|
37
|
+
</div>
|
|
38
|
+
|
|
39
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
40
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
41
|
+
<div id="search-field-wrapper">
|
|
42
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
43
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
44
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
45
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
46
|
+
</div>
|
|
47
|
+
|
|
48
|
+
<ul id="search-results" aria-label="Search Results"
|
|
49
|
+
aria-busy="false" aria-expanded="false"
|
|
50
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
51
|
+
</form>
|
|
52
|
+
</div>
|
|
53
|
+
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
<div id="class-metadata">
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
<div id="parent-class-section" class="nav-section">
|
|
62
|
+
<h3>Parent</h3>
|
|
63
|
+
|
|
64
|
+
<p class="link"><a href="../Resource.html">EasyPost::Resource</a>
|
|
65
|
+
</div>
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
<!-- Method Quickref -->
|
|
71
|
+
<div id="method-list-section" class="nav-section">
|
|
72
|
+
<h3>Methods</h3>
|
|
73
|
+
|
|
74
|
+
<ul class="link-list" role="directory">
|
|
75
|
+
<li ><a href="#method-c-all">::all</a>
|
|
76
|
+
<li ><a href="#method-c-create">::create</a>
|
|
77
|
+
<li ><a href="#method-c-retrieve">::retrieve</a>
|
|
78
|
+
<li ><a href="#method-i-save">#save</a>
|
|
79
|
+
</ul>
|
|
80
|
+
</div>
|
|
81
|
+
|
|
82
|
+
</div>
|
|
83
|
+
</nav>
|
|
84
|
+
|
|
85
|
+
<main role="main" aria-labelledby="class-EasyPost::Beta::EndShipper">
|
|
86
|
+
<h1 id="class-EasyPost::Beta::EndShipper" class="class">
|
|
87
|
+
class EasyPost::Beta::EndShipper
|
|
88
|
+
</h1>
|
|
89
|
+
|
|
90
|
+
<section class="description">
|
|
91
|
+
|
|
92
|
+
<p><a href="EndShipper.html"><code>EndShipper</code></a> objects are fully-qualified Address objects that require all parameters and get verified upon creation.</p>
|
|
93
|
+
|
|
94
|
+
</section>
|
|
95
|
+
|
|
96
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
103
|
+
<header>
|
|
104
|
+
<h3>Public Class Methods</h3>
|
|
105
|
+
</header>
|
|
106
|
+
|
|
107
|
+
<div id="method-c-all" class="method-detail ">
|
|
108
|
+
<div class="method-heading">
|
|
109
|
+
<span class="method-name">all</span><span
|
|
110
|
+
class="method-args">(params = {}, api_key = nil)</span>
|
|
111
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
112
|
+
</div>
|
|
113
|
+
|
|
114
|
+
<div class="method-description">
|
|
115
|
+
<p>Retrieves a list of <a href="EndShipper.html"><code>EndShipper</code></a> objects. <strong>DEPRECATED:</strong> Please use <code>EndShipper</code> in the main namespace instead.</p>
|
|
116
|
+
|
|
117
|
+
<div class="method-source-code" id="all-source">
|
|
118
|
+
<pre><span class="ruby-comment"># File lib/easypost/beta/end_shipper.rb, line 23</span>
|
|
119
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">all</span>(<span class="ruby-identifier">params</span> = {}, <span class="ruby-identifier">api_key</span> = <span class="ruby-keyword">nil</span>)
|
|
120
|
+
<span class="ruby-identifier">warn</span> <span class="ruby-string">'[DEPRECATION] Please use `EndShipper.all` in the main namespace instead.'</span>
|
|
121
|
+
<span class="ruby-identifier">response</span> = <span class="ruby-constant">EasyPost</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:get</span>, <span class="ruby-string">'/beta/end_shippers'</span>, <span class="ruby-identifier">api_key</span>, <span class="ruby-identifier">params</span>)
|
|
122
|
+
<span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">convert_to_easypost_object</span>(<span class="ruby-identifier">response</span>, <span class="ruby-identifier">api_key</span>)
|
|
123
|
+
<span class="ruby-keyword">end</span></pre>
|
|
124
|
+
</div>
|
|
125
|
+
</div>
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
</div>
|
|
129
|
+
|
|
130
|
+
<div id="method-c-create" class="method-detail ">
|
|
131
|
+
<div class="method-heading">
|
|
132
|
+
<span class="method-name">create</span><span
|
|
133
|
+
class="method-args">(params = {}, api_key = nil)</span>
|
|
134
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
135
|
+
</div>
|
|
136
|
+
|
|
137
|
+
<div class="method-description">
|
|
138
|
+
<p>Create an <a href="EndShipper.html"><code>EndShipper</code></a> object. <strong>DEPRECATED:</strong> Please use <code>EndShipper</code> in the main namespace instead.</p>
|
|
139
|
+
|
|
140
|
+
<div class="method-source-code" id="create-source">
|
|
141
|
+
<pre><span class="ruby-comment"># File lib/easypost/beta/end_shipper.rb, line 7</span>
|
|
142
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">create</span>(<span class="ruby-identifier">params</span> = {}, <span class="ruby-identifier">api_key</span> = <span class="ruby-keyword">nil</span>)
|
|
143
|
+
<span class="ruby-identifier">warn</span> <span class="ruby-string">'[DEPRECATION] Please use `EndShipper.create` in the main namespace instead.'</span>
|
|
144
|
+
<span class="ruby-identifier">response</span> = <span class="ruby-constant">EasyPost</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:post</span>, <span class="ruby-string">'/beta/end_shippers'</span>, <span class="ruby-identifier">api_key</span>, { <span class="ruby-value">address:</span> <span class="ruby-identifier">params</span> })
|
|
145
|
+
<span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">convert_to_easypost_object</span>(<span class="ruby-identifier">response</span>, <span class="ruby-identifier">api_key</span>)
|
|
146
|
+
<span class="ruby-keyword">end</span></pre>
|
|
147
|
+
</div>
|
|
148
|
+
</div>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
</div>
|
|
152
|
+
|
|
153
|
+
<div id="method-c-retrieve" class="method-detail ">
|
|
154
|
+
<div class="method-heading">
|
|
155
|
+
<span class="method-name">retrieve</span><span
|
|
156
|
+
class="method-args">(id, params = {}, api_key = nil)</span>
|
|
157
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
158
|
+
</div>
|
|
159
|
+
|
|
160
|
+
<div class="method-description">
|
|
161
|
+
<p>Retrieves an <a href="EndShipper.html"><code>EndShipper</code></a> object. <strong>DEPRECATED:</strong> Please use <code>EndShipper</code> in the main namespace instead.</p>
|
|
162
|
+
|
|
163
|
+
<div class="method-source-code" id="retrieve-source">
|
|
164
|
+
<pre><span class="ruby-comment"># File lib/easypost/beta/end_shipper.rb, line 15</span>
|
|
165
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">retrieve</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">params</span> = {}, <span class="ruby-identifier">api_key</span> = <span class="ruby-keyword">nil</span>)
|
|
166
|
+
<span class="ruby-identifier">warn</span> <span class="ruby-string">'[DEPRECATION] Please use `EndShipper.retrieve` in the main namespace instead.'</span>
|
|
167
|
+
<span class="ruby-identifier">response</span> = <span class="ruby-constant">EasyPost</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:get</span>, <span class="ruby-node">"/beta/end_shippers/#{id}"</span>, <span class="ruby-identifier">api_key</span>, <span class="ruby-identifier">params</span>)
|
|
168
|
+
<span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">convert_to_easypost_object</span>(<span class="ruby-identifier">response</span>, <span class="ruby-identifier">api_key</span>)
|
|
169
|
+
<span class="ruby-keyword">end</span></pre>
|
|
170
|
+
</div>
|
|
171
|
+
</div>
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
</div>
|
|
175
|
+
|
|
176
|
+
</section>
|
|
177
|
+
|
|
178
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
179
|
+
<header>
|
|
180
|
+
<h3>Public Instance Methods</h3>
|
|
181
|
+
</header>
|
|
182
|
+
|
|
183
|
+
<div id="method-i-save" class="method-detail ">
|
|
184
|
+
<div class="method-heading">
|
|
185
|
+
<span class="method-name">save</span><span
|
|
186
|
+
class="method-args">()</span>
|
|
187
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
188
|
+
</div>
|
|
189
|
+
|
|
190
|
+
<div class="method-description">
|
|
191
|
+
<p>Updates (saves) an <a href="EndShipper.html"><code>EndShipper</code></a> object. This requires all parameters to be set. <strong>DEPRECATED:</strong> Please use <code>EndShipper</code> in the main namespace instead.</p>
|
|
192
|
+
|
|
193
|
+
<div class="method-source-code" id="save-source">
|
|
194
|
+
<pre><span class="ruby-comment"># File lib/easypost/beta/end_shipper.rb, line 31</span>
|
|
195
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">save</span>
|
|
196
|
+
<span class="ruby-identifier">warn</span> <span class="ruby-string">'[DEPRECATION] Please use `endShipper.save` in the main namespace instead.'</span>
|
|
197
|
+
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@unsaved_values</span>.<span class="ruby-identifier">length</span>.<span class="ruby-identifier">positive?</span>
|
|
198
|
+
<span class="ruby-identifier">values</span> = {}
|
|
199
|
+
<span class="ruby-ivar">@unsaved_values</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span><span class="ruby-operator">|</span> <span class="ruby-identifier">values</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-ivar">@values</span>[<span class="ruby-identifier">k</span>] }
|
|
200
|
+
|
|
201
|
+
<span class="ruby-identifier">wrapped_params</span> = { <span class="ruby-value">address:</span> <span class="ruby-identifier">values</span> }
|
|
202
|
+
|
|
203
|
+
<span class="ruby-identifier">response</span> = <span class="ruby-constant">EasyPost</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:put</span>, <span class="ruby-node">"/beta/end_shippers/#{id}"</span>, <span class="ruby-ivar">@api_key</span>, <span class="ruby-identifier">wrapped_params</span>)
|
|
204
|
+
<span class="ruby-identifier">refresh_from</span>(<span class="ruby-identifier">response</span>, <span class="ruby-identifier">api_key</span>)
|
|
205
|
+
<span class="ruby-keyword">end</span>
|
|
206
|
+
<span class="ruby-keyword">self</span>
|
|
207
|
+
<span class="ruby-keyword">end</span></pre>
|
|
208
|
+
</div>
|
|
209
|
+
</div>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
</div>
|
|
213
|
+
|
|
214
|
+
</section>
|
|
215
|
+
|
|
216
|
+
</section>
|
|
217
|
+
</main>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
<footer id="validator-badges" role="contentinfo">
|
|
221
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
222
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
|
|
223
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
224
|
+
</footer>
|
|
225
|
+
|