easypost 4.8.1 → 4.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (95) hide show
  1. checksums.yaml +4 -4
  2. data/.gitattributes +5 -0
  3. data/.github/workflows/ci.yml +8 -0
  4. data/.gitignore +10 -14
  5. data/CHANGELOG.md +4 -0
  6. data/Makefile +10 -2
  7. data/README.md +5 -1
  8. data/VERSION +1 -1
  9. data/docs/EasyPost/Address.html +222 -0
  10. data/docs/EasyPost/ApiKey.html +99 -0
  11. data/docs/EasyPost/Batch.html +269 -0
  12. data/docs/EasyPost/Beta/EndShipper.html +225 -0
  13. data/docs/EasyPost/Beta/Referral.html +338 -0
  14. data/docs/EasyPost/Beta.html +91 -0
  15. data/docs/EasyPost/Billing.html +253 -0
  16. data/docs/EasyPost/Brand.html +140 -0
  17. data/docs/EasyPost/CarbonOffset.html +99 -0
  18. data/docs/EasyPost/CarrierAccount.html +136 -0
  19. data/docs/EasyPost/CarrierType.html +99 -0
  20. data/docs/EasyPost/CustomsInfo.html +136 -0
  21. data/docs/EasyPost/CustomsItem.html +136 -0
  22. data/docs/EasyPost/EasyPostObject.html +662 -0
  23. data/docs/EasyPost/EndShipper.html +175 -0
  24. data/docs/EasyPost/Error.html +258 -0
  25. data/docs/EasyPost/Event.html +136 -0
  26. data/docs/EasyPost/Insurance.html +99 -0
  27. data/docs/EasyPost/Order.html +222 -0
  28. data/docs/EasyPost/Parcel.html +136 -0
  29. data/docs/EasyPost/PaymentMethod.html +137 -0
  30. data/docs/EasyPost/Pickup.html +222 -0
  31. data/docs/EasyPost/PickupRate.html +99 -0
  32. data/docs/EasyPost/PostageLabel.html +99 -0
  33. data/docs/EasyPost/Rate.html +136 -0
  34. data/docs/EasyPost/Referral.html +334 -0
  35. data/docs/EasyPost/Refund.html +99 -0
  36. data/docs/EasyPost/Report.html +167 -0
  37. data/docs/EasyPost/Resource.html +399 -0
  38. data/docs/EasyPost/ScanForm.html +137 -0
  39. data/docs/EasyPost/Shipment.html +456 -0
  40. data/docs/EasyPost/TaxIdentifier.html +99 -0
  41. data/docs/EasyPost/Tracker.html +139 -0
  42. data/docs/EasyPost/User.html +307 -0
  43. data/docs/EasyPost/Util.html +462 -0
  44. data/docs/EasyPost/Webhook.html +221 -0
  45. data/docs/EasyPost.html +440 -0
  46. data/docs/created.rid +40 -0
  47. data/docs/css/fonts.css +167 -0
  48. data/docs/css/rdoc.css +639 -0
  49. data/docs/fonts/Lato-Light.ttf +0 -0
  50. data/docs/fonts/Lato-LightItalic.ttf +0 -0
  51. data/docs/fonts/Lato-Regular.ttf +0 -0
  52. data/docs/fonts/Lato-RegularItalic.ttf +0 -0
  53. data/docs/fonts/SourceCodePro-Bold.ttf +0 -0
  54. data/docs/fonts/SourceCodePro-Regular.ttf +0 -0
  55. data/docs/images/add.png +0 -0
  56. data/docs/images/arrow_up.png +0 -0
  57. data/docs/images/brick.png +0 -0
  58. data/docs/images/brick_link.png +0 -0
  59. data/docs/images/bug.png +0 -0
  60. data/docs/images/bullet_black.png +0 -0
  61. data/docs/images/bullet_toggle_minus.png +0 -0
  62. data/docs/images/bullet_toggle_plus.png +0 -0
  63. data/docs/images/date.png +0 -0
  64. data/docs/images/delete.png +0 -0
  65. data/docs/images/find.png +0 -0
  66. data/docs/images/loadingAnimation.gif +0 -0
  67. data/docs/images/macFFBgHack.png +0 -0
  68. data/docs/images/package.png +0 -0
  69. data/docs/images/page_green.png +0 -0
  70. data/docs/images/page_white_text.png +0 -0
  71. data/docs/images/page_white_width.png +0 -0
  72. data/docs/images/plugin.png +0 -0
  73. data/docs/images/ruby.png +0 -0
  74. data/docs/images/tag_blue.png +0 -0
  75. data/docs/images/tag_green.png +0 -0
  76. data/docs/images/transparent.png +0 -0
  77. data/docs/images/wrench.png +0 -0
  78. data/docs/images/wrench_orange.png +0 -0
  79. data/docs/images/zoom.png +0 -0
  80. data/docs/index.html +117 -0
  81. data/docs/js/darkfish.js +84 -0
  82. data/docs/js/navigation.js +105 -0
  83. data/docs/js/navigation.js.gz +0 -0
  84. data/docs/js/search.js +110 -0
  85. data/docs/js/search_index.js +1 -0
  86. data/docs/js/search_index.js.gz +0 -0
  87. data/docs/js/searcher.js +229 -0
  88. data/docs/js/searcher.js.gz +0 -0
  89. data/docs/table_of_contents.html +785 -0
  90. data/easypost.gemspec +3 -1
  91. data/lib/easypost/carrier_account.rb +17 -0
  92. data/lib/easypost/shipment.rb +1 -1
  93. data/lib/easypost/user.rb +5 -2
  94. data/lib/easypost/util.rb +2 -0
  95. metadata +115 -6
data/docs/EasyPost/EndShipper.html ADDED
@@ -0,0 +1,175 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>class EasyPost::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-create">::create</a>
76
+ <li ><a href="#method-i-save">#save</a>
77
+ </ul>
78
+ </div>
79
+
80
+ </div>
81
+ </nav>
82
+
83
+ <main role="main" aria-labelledby="class-EasyPost::EndShipper">
84
+ <h1 id="class-EasyPost::EndShipper" class="class">
85
+ class EasyPost::EndShipper
86
+ </h1>
87
+
88
+ <section class="description">
89
+
90
+ <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>
91
+
92
+ </section>
93
+
94
+ <section id="5Buntitled-5D" class="documentation-section">
95
+
96
+
97
+
98
+
99
+
100
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section">
101
+ <header>
102
+ <h3>Public Class Methods</h3>
103
+ </header>
104
+
105
+ <div id="method-c-create" class="method-detail ">
106
+ <div class="method-heading">
107
+ <span class="method-name">create</span><span
108
+ class="method-args">(params = {}, api_key = nil)</span>
109
+ <span class="method-click-advice">click to toggle source</span>
110
+ </div>
111
+
112
+ <div class="method-description">
113
+ <p>Create an <a href="EndShipper.html"><code>EndShipper</code></a> object.</p>
114
+
115
+ <div class="method-source-code" id="create-source">
116
+ <pre><span class="ruby-comment"># File lib/easypost/end_shipper.rb, line 6</span>
117
+ <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>)
118
+ <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-identifier">url</span>, <span class="ruby-identifier">api_key</span>, { <span class="ruby-value">address:</span> <span class="ruby-identifier">params</span> })
119
+ <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>)
120
+ <span class="ruby-keyword">end</span></pre>
121
+ </div>
122
+ </div>
123
+
124
+
125
+ </div>
126
+
127
+ </section>
128
+
129
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
130
+ <header>
131
+ <h3>Public Instance Methods</h3>
132
+ </header>
133
+
134
+ <div id="method-i-save" class="method-detail ">
135
+ <div class="method-heading">
136
+ <span class="method-name">save</span><span
137
+ class="method-args">()</span>
138
+ <span class="method-click-advice">click to toggle source</span>
139
+ </div>
140
+
141
+ <div class="method-description">
142
+ <p>Updates (saves) an <a href="EndShipper.html"><code>EndShipper</code></a> object. This requires all parameters to be set.</p>
143
+
144
+ <div class="method-source-code" id="save-source">
145
+ <pre><span class="ruby-comment"># File lib/easypost/end_shipper.rb, line 12</span>
146
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">save</span>
147
+ <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>
148
+ <span class="ruby-identifier">values</span> = {}
149
+ <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>] }
150
+
151
+ <span class="ruby-identifier">wrapped_params</span> = { <span class="ruby-value">address:</span> <span class="ruby-identifier">values</span> }
152
+
153
+ <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-identifier">url</span>, <span class="ruby-ivar">@api_key</span>, <span class="ruby-identifier">wrapped_params</span>)
154
+ <span class="ruby-identifier">refresh_from</span>(<span class="ruby-identifier">response</span>, <span class="ruby-identifier">api_key</span>)
155
+ <span class="ruby-keyword">end</span>
156
+ <span class="ruby-keyword">self</span>
157
+ <span class="ruby-keyword">end</span></pre>
158
+ </div>
159
+ </div>
160
+
161
+
162
+ </div>
163
+
164
+ </section>
165
+
166
+ </section>
167
+ </main>
168
+
169
+
170
+ <footer id="validator-badges" role="contentinfo">
171
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
172
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
173
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
174
+ </footer>
175
+
data/docs/EasyPost/Error.html ADDED
@@ -0,0 +1,258 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>class EasyPost::Error - 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">StandardError
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 class="calls-super" ><a href="#method-c-new">::new</a>
76
+ <li ><a href="#method-i-3D-3D">#==</a>
77
+ <li ><a href="#method-i-to_s">#to_s</a>
78
+ </ul>
79
+ </div>
80
+
81
+ </div>
82
+ </nav>
83
+
84
+ <main role="main" aria-labelledby="class-EasyPost::Error">
85
+ <h1 id="class-EasyPost::Error" class="class">
86
+ class EasyPost::Error
87
+ </h1>
88
+
89
+ <section class="description">
90
+
91
+ <p><a href="../EasyPost.html"><code>EasyPost</code></a> <a href="Error.html"><code>Error</code></a> object.</p>
92
+
93
+ </section>
94
+
95
+ <section id="5Buntitled-5D" class="documentation-section">
96
+
97
+
98
+
99
+ <section class="attribute-method-details" class="method-section">
100
+ <header>
101
+ <h3>Attributes</h3>
102
+ </header>
103
+
104
+ <div id="attribute-i-code" class="method-detail">
105
+ <div class="method-heading attribute-method-heading">
106
+ <span class="method-name">code</span><span
107
+ class="attribute-access-type">[R]</span>
108
+ </div>
109
+
110
+ <div class="method-description">
111
+
112
+ </div>
113
+ </div>
114
+ <div id="attribute-i-errors" class="method-detail">
115
+ <div class="method-heading attribute-method-heading">
116
+ <span class="method-name">errors</span><span
117
+ class="attribute-access-type">[R]</span>
118
+ </div>
119
+
120
+ <div class="method-description">
121
+
122
+ </div>
123
+ </div>
124
+ <div id="attribute-i-http_body" class="method-detail">
125
+ <div class="method-heading attribute-method-heading">
126
+ <span class="method-name">http_body</span><span
127
+ class="attribute-access-type">[R]</span>
128
+ </div>
129
+
130
+ <div class="method-description">
131
+
132
+ </div>
133
+ </div>
134
+ <div id="attribute-i-message" class="method-detail">
135
+ <div class="method-heading attribute-method-heading">
136
+ <span class="method-name">message</span><span
137
+ class="attribute-access-type">[R]</span>
138
+ </div>
139
+
140
+ <div class="method-description">
141
+
142
+ </div>
143
+ </div>
144
+ <div id="attribute-i-status" class="method-detail">
145
+ <div class="method-heading attribute-method-heading">
146
+ <span class="method-name">status</span><span
147
+ class="attribute-access-type">[R]</span>
148
+ </div>
149
+
150
+ <div class="method-description">
151
+
152
+ </div>
153
+ </div>
154
+ </section>
155
+
156
+
157
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section">
158
+ <header>
159
+ <h3>Public Class Methods</h3>
160
+ </header>
161
+
162
+ <div id="method-c-new" class="method-detail ">
163
+ <div class="method-heading">
164
+ <span class="method-name">new</span><span
165
+ class="method-args">(message = nil, status = nil, code = nil, errors = nil, http_body = nil)</span>
166
+ <span class="method-click-advice">click to toggle source</span>
167
+ </div>
168
+
169
+ <div class="method-description">
170
+ <p>Initialize a new <a href="../EasyPost.html"><code>EasyPost</code></a> <a href="Error.html"><code>Error</code></a></p>
171
+ <div class="method-calls-super">
172
+ Calls superclass method
173
+
174
+ </div>
175
+
176
+ <div class="method-source-code" id="new-source">
177
+ <pre><span class="ruby-comment"># File lib/easypost/error.rb, line 8</span>
178
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">message</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">status</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">code</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">errors</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">http_body</span> = <span class="ruby-keyword">nil</span>)
179
+ <span class="ruby-comment"># message should be a string but can sometimes incorrectly come back as an array</span>
180
+ <span class="ruby-ivar">@message</span> = <span class="ruby-identifier">message</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">message</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39;, &#39;</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">message</span>
181
+ <span class="ruby-ivar">@status</span> = <span class="ruby-identifier">status</span>
182
+ <span class="ruby-ivar">@code</span> = <span class="ruby-identifier">code</span>
183
+ <span class="ruby-ivar">@errors</span> = <span class="ruby-identifier">errors</span>
184
+ <span class="ruby-ivar">@http_body</span> = <span class="ruby-identifier">http_body</span>
185
+
186
+ <span class="ruby-keyword">super</span>(<span class="ruby-identifier">message</span>)
187
+ <span class="ruby-keyword">end</span></pre>
188
+ </div>
189
+ </div>
190
+
191
+
192
+ </div>
193
+
194
+ </section>
195
+
196
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
197
+ <header>
198
+ <h3>Public Instance Methods</h3>
199
+ </header>
200
+
201
+ <div id="method-i-3D-3D" class="method-detail ">
202
+ <div class="method-heading">
203
+ <span class="method-name">==</span><span
204
+ class="method-args">(other)</span>
205
+ <span class="method-click-advice">click to toggle source</span>
206
+ </div>
207
+
208
+ <div class="method-description">
209
+ <p>Compare error properties.</p>
210
+
211
+ <div class="method-source-code" id="3D-3D-source">
212
+ <pre><span class="ruby-comment"># File lib/easypost/error.rb, line 25</span>
213
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">==</span>(<span class="ruby-identifier">other</span>)
214
+ <span class="ruby-identifier">other</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>) <span class="ruby-operator">&amp;&amp;</span>
215
+ <span class="ruby-identifier">message</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">message</span> <span class="ruby-operator">&amp;&amp;</span>
216
+ <span class="ruby-identifier">status</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">status</span> <span class="ruby-operator">&amp;&amp;</span>
217
+ <span class="ruby-identifier">code</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">code</span> <span class="ruby-operator">&amp;&amp;</span>
218
+ <span class="ruby-identifier">errors</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">errors</span>
219
+ <span class="ruby-keyword">end</span></pre>
220
+ </div>
221
+ </div>
222
+
223
+
224
+ </div>
225
+
226
+ <div id="method-i-to_s" class="method-detail ">
227
+ <div class="method-heading">
228
+ <span class="method-name">to_s</span><span
229
+ class="method-args">()</span>
230
+ <span class="method-click-advice">click to toggle source</span>
231
+ </div>
232
+
233
+ <div class="method-description">
234
+ <p>Convert an error to a string.</p>
235
+
236
+ <div class="method-source-code" id="to_s-source">
237
+ <pre><span class="ruby-comment"># File lib/easypost/error.rb, line 20</span>
238
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span>
239
+ <span class="ruby-node">&quot;#{code} (#{status}): #{message} #{errors}&quot;</span>.<span class="ruby-identifier">strip</span>
240
+ <span class="ruby-keyword">end</span></pre>
241
+ </div>
242
+ </div>
243
+
244
+
245
+ </div>
246
+
247
+ </section>
248
+
249
+ </section>
250
+ </main>
251
+
252
+
253
+ <footer id="validator-badges" role="contentinfo">
254
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
255
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
256
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
257
+ </footer>
258
+
data/docs/EasyPost/Event.html ADDED
@@ -0,0 +1,136 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>class EasyPost::Event - 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-receive">::receive</a>
76
+ </ul>
77
+ </div>
78
+
79
+ </div>
80
+ </nav>
81
+
82
+ <main role="main" aria-labelledby="class-EasyPost::Event">
83
+ <h1 id="class-EasyPost::Event" class="class">
84
+ class EasyPost::Event
85
+ </h1>
86
+
87
+ <section class="description">
88
+
89
+ <p>Webhook Events are triggered by changes in objects you’ve created via the API.</p>
90
+
91
+ </section>
92
+
93
+ <section id="5Buntitled-5D" class="documentation-section">
94
+
95
+
96
+
97
+
98
+
99
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section">
100
+ <header>
101
+ <h3>Public Class Methods</h3>
102
+ </header>
103
+
104
+ <div id="method-c-receive" class="method-detail ">
105
+ <div class="method-heading">
106
+ <span class="method-name">receive</span><span
107
+ class="method-args">(values)</span>
108
+ <span class="method-click-advice">click to toggle source</span>
109
+ </div>
110
+
111
+ <div class="method-description">
112
+ <p>Converts a raw webhook event into an <a href="../EasyPost.html"><code>EasyPost</code></a> object.</p>
113
+
114
+ <div class="method-source-code" id="receive-source">
115
+ <pre><span class="ruby-comment"># File lib/easypost/event.rb, line 8</span>
116
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">receive</span>(<span class="ruby-identifier">values</span>)
117
+ <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-constant">JSON</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">values</span>), <span class="ruby-keyword">nil</span>)
118
+ <span class="ruby-keyword">end</span></pre>
119
+ </div>
120
+ </div>
121
+
122
+
123
+ </div>
124
+
125
+ </section>
126
+
127
+ </section>
128
+ </main>
129
+
130
+
131
+ <footer id="validator-badges" role="contentinfo">
132
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
133
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
134
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
135
+ </footer>
136
+
data/docs/EasyPost/Insurance.html ADDED
@@ -0,0 +1,99 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>class EasyPost::Insurance - 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
+ </div>
71
+ </nav>
72
+
73
+ <main role="main" aria-labelledby="class-EasyPost::Insurance">
74
+ <h1 id="class-EasyPost::Insurance" class="class">
75
+ class EasyPost::Insurance
76
+ </h1>
77
+
78
+ <section class="description">
79
+
80
+ <p>An <a href="Insurance.html"><code>Insurance</code></a> object represents insurance for packages purchased both via the <a href="../EasyPost.html"><code>EasyPost</code></a> API as well as shipments purchased through third parties and later registered with <a href="../EasyPost.html"><code>EasyPost</code></a>.</p>
81
+
82
+ </section>
83
+
84
+ <section id="5Buntitled-5D" class="documentation-section">
85
+
86
+
87
+
88
+
89
+
90
+ </section>
91
+ </main>
92
+
93
+
94
+ <footer id="validator-badges" role="contentinfo">
95
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
96
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
97
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
98
+ </footer>
99
+