easypost 4.8.1 → 4.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (103) 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 +12 -0
  6. data/Makefile +10 -2
  7. data/README.md +7 -3
  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/beta/payment_refund.rb +5 -0
  92. data/lib/easypost/beta/referral.rb +52 -4
  93. data/lib/easypost/carrier_account.rb +17 -0
  94. data/lib/easypost/payment_method.rb +2 -1
  95. data/lib/easypost/referral.rb +4 -4
  96. data/lib/easypost/shipment.rb +1 -1
  97. data/lib/easypost/user.rb +5 -2
  98. data/lib/easypost/util.rb +21 -12
  99. metadata +117 -11
  100. data/CODE_OF_CONDUCT.md +0 -16
  101. data/CONTRIBUTING.md +0 -47
  102. data/SECURITY.md +0 -7
  103. data/SUPPORT.md +0 -3
data/docs/EasyPost/Billing.html ADDED
@@ -0,0 +1,253 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>class EasyPost::Billing - 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-delete_payment_method">::delete_payment_method</a>
76
+ <li ><a href="#method-c-fund_wallet">::fund_wallet</a>
77
+ <li ><a href="#method-c-get_payment_method_info">::get_payment_method_info</a>
78
+ <li ><a href="#method-c-retrieve_payment_methods">::retrieve_payment_methods</a>
79
+ </ul>
80
+ </div>
81
+
82
+ </div>
83
+ </nav>
84
+
85
+ <main role="main" aria-labelledby="class-EasyPost::Billing">
86
+ <h1 id="class-EasyPost::Billing" class="class">
87
+ class EasyPost::Billing
88
+ </h1>
89
+
90
+ <section class="description">
91
+
92
+ <p><a href="Billing.html"><code>Billing</code></a> class that users can manage their payment and fund</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-delete_payment_method" class="method-detail ">
108
+ <div class="method-heading">
109
+ <span class="method-name">delete_payment_method</span><span
110
+ class="method-args">(primary_or_secondary, 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>Delete a payment method.</p>
116
+
117
+ <div class="method-source-code" id="delete_payment_method-source">
118
+ <pre><span class="ruby-comment"># File lib/easypost/billing.rb, line 51</span>
119
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">delete_payment_method</span>(<span class="ruby-identifier">primary_or_secondary</span>, <span class="ruby-identifier">api_key</span> = <span class="ruby-keyword">nil</span>)
120
+ <span class="ruby-identifier">payment_info</span> = <span class="ruby-identifier">get_payment_method_info</span>(<span class="ruby-identifier">primary_or_secondary</span>.<span class="ruby-identifier">downcase</span>)
121
+ <span class="ruby-identifier">endpoint</span> = <span class="ruby-identifier">payment_info</span>[<span class="ruby-value">0</span>]
122
+ <span class="ruby-identifier">payment_id</span> = <span class="ruby-identifier">payment_info</span>[<span class="ruby-value">1</span>]
123
+
124
+ <span class="ruby-constant">EasyPost</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:delete</span>, <span class="ruby-node">&quot;#{endpoint}/#{payment_id}&quot;</span>, <span class="ruby-identifier">api_key</span>)
125
+
126
+ <span class="ruby-comment"># Return true if succeeds, an error will be thrown if it fails</span>
127
+ <span class="ruby-keyword">true</span>
128
+ <span class="ruby-keyword">end</span></pre>
129
+ </div>
130
+ </div>
131
+
132
+
133
+ </div>
134
+
135
+ <div id="method-c-fund_wallet" class="method-detail ">
136
+ <div class="method-heading">
137
+ <span class="method-name">fund_wallet</span><span
138
+ class="method-args">(amount, primary_or_secondary = &#39;primary&#39;, api_key = nil)</span>
139
+ <span class="method-click-advice">click to toggle source</span>
140
+ </div>
141
+
142
+ <div class="method-description">
143
+ <p>Fund your <a href="../EasyPost.html"><code>EasyPost</code></a> wallet by charging your primary or secondary card on file.</p>
144
+
145
+ <div class="method-source-code" id="fund_wallet-source">
146
+ <pre><span class="ruby-comment"># File lib/easypost/billing.rb, line 38</span>
147
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">fund_wallet</span>(<span class="ruby-identifier">amount</span>, <span class="ruby-identifier">primary_or_secondary</span> = <span class="ruby-string">&#39;primary&#39;</span>, <span class="ruby-identifier">api_key</span> = <span class="ruby-keyword">nil</span>)
148
+ <span class="ruby-identifier">payment_info</span> = <span class="ruby-identifier">get_payment_method_info</span>(<span class="ruby-identifier">primary_or_secondary</span>.<span class="ruby-identifier">downcase</span>)
149
+ <span class="ruby-identifier">endpoint</span> = <span class="ruby-identifier">payment_info</span>[<span class="ruby-value">0</span>]
150
+ <span class="ruby-identifier">payment_id</span> = <span class="ruby-identifier">payment_info</span>[<span class="ruby-value">1</span>]
151
+
152
+ <span class="ruby-identifier">wrapped_params</span> = { <span class="ruby-value">amount:</span> <span class="ruby-identifier">amount</span> }
153
+ <span class="ruby-constant">EasyPost</span>.<span class="ruby-identifier">make_request</span>(<span class="ruby-value">:post</span>, <span class="ruby-node">&quot;#{endpoint}/#{payment_id}/charges&quot;</span>, <span class="ruby-identifier">api_key</span>, <span class="ruby-identifier">wrapped_params</span>)
154
+
155
+ <span class="ruby-comment"># Return true if succeeds, an error will be thrown if it fails</span>
156
+ <span class="ruby-keyword">true</span>
157
+ <span class="ruby-keyword">end</span></pre>
158
+ </div>
159
+ </div>
160
+
161
+
162
+ </div>
163
+
164
+ <div id="method-c-retrieve_payment_methods" class="method-detail ">
165
+ <div class="method-heading">
166
+ <span class="method-name">retrieve_payment_methods</span><span
167
+ class="method-args">(api_key = nil)</span>
168
+ <span class="method-click-advice">click to toggle source</span>
169
+ </div>
170
+
171
+ <div class="method-description">
172
+ <p>Retrieve all payment methods.</p>
173
+
174
+ <div class="method-source-code" id="retrieve_payment_methods-source">
175
+ <pre><span class="ruby-comment"># File lib/easypost/billing.rb, line 63</span>
176
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">retrieve_payment_methods</span>(<span class="ruby-identifier">api_key</span> = <span class="ruby-keyword">nil</span>)
177
+ <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">&#39;/v2/payment_methods&#39;</span>, <span class="ruby-identifier">api_key</span>)
178
+
179
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>[<span class="ruby-string">&#39;id&#39;</span>].<span class="ruby-identifier">nil?</span>
180
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&#39;Billing has not been setup for this user. Please add a payment method.&#39;</span>)
181
+ <span class="ruby-keyword">end</span>
182
+
183
+ <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>)
184
+ <span class="ruby-keyword">end</span></pre>
185
+ </div>
186
+ </div>
187
+
188
+
189
+ </div>
190
+
191
+ </section>
192
+
193
+ <section id="protected-class-5Buntitled-5D-method-details" class="method-section">
194
+ <header>
195
+ <h3>Protected Class Methods</h3>
196
+ </header>
197
+
198
+ <div id="method-c-get_payment_method_info" class="method-detail ">
199
+ <div class="method-heading">
200
+ <span class="method-name">get_payment_method_info</span><span
201
+ class="method-args">(primary_or_secondary)</span>
202
+ <span class="method-click-advice">click to toggle source</span>
203
+ </div>
204
+
205
+ <div class="method-description">
206
+ <p>Get payment method info (type of the payment method and ID of the payment method)</p>
207
+
208
+ <div class="method-source-code" id="get_payment_method_info-source">
209
+ <pre><span class="ruby-comment"># File lib/easypost/billing.rb, line 9</span>
210
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_payment_method_info</span>(<span class="ruby-identifier">primary_or_secondary</span>)
211
+ <span class="ruby-identifier">payment_methods</span> = <span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">Billing</span>.<span class="ruby-identifier">retrieve_payment_methods</span>
212
+ <span class="ruby-identifier">payment_method_map</span> = {
213
+ <span class="ruby-string">&#39;primary&#39;</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-string">&#39;primary_payment_method&#39;</span>,
214
+ <span class="ruby-string">&#39;secondary&#39;</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-string">&#39;secondary_payment_method&#39;</span>,
215
+ }
216
+
217
+ <span class="ruby-identifier">payment_method_to_use</span> = <span class="ruby-identifier">payment_method_map</span>[<span class="ruby-identifier">primary_or_secondary</span>]
218
+
219
+ <span class="ruby-identifier">error_string</span> = <span class="ruby-string">&#39;The chosen payment method is not valid. Please try again.&#39;</span>
220
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">error_string</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">payment_methods</span>[<span class="ruby-identifier">payment_method_to_use</span>].<span class="ruby-identifier">nil?</span>
221
+
222
+ <span class="ruby-identifier">payment_method_id</span> = <span class="ruby-identifier">payment_methods</span>[<span class="ruby-identifier">payment_method_to_use</span>][<span class="ruby-string">&#39;id&#39;</span>]
223
+
224
+ <span class="ruby-keyword">unless</span> <span class="ruby-identifier">payment_method_id</span>.<span class="ruby-identifier">nil?</span>
225
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">payment_method_id</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-string">&#39;card_&#39;</span>)
226
+ <span class="ruby-identifier">endpoint</span> = <span class="ruby-string">&#39;/v2/credit_cards&#39;</span>
227
+ <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">payment_method_id</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-string">&#39;bank_&#39;</span>)
228
+ <span class="ruby-identifier">endpoint</span> = <span class="ruby-string">&#39;/v2/bank_accounts&#39;</span>
229
+ <span class="ruby-keyword">else</span>
230
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">error_string</span>)
231
+ <span class="ruby-keyword">end</span>
232
+ <span class="ruby-keyword">end</span>
233
+
234
+ [<span class="ruby-identifier">endpoint</span>, <span class="ruby-identifier">payment_method_id</span>]
235
+ <span class="ruby-keyword">end</span></pre>
236
+ </div>
237
+ </div>
238
+
239
+
240
+ </div>
241
+
242
+ </section>
243
+
244
+ </section>
245
+ </main>
246
+
247
+
248
+ <footer id="validator-badges" role="contentinfo">
249
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
250
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
251
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
252
+ </footer>
253
+
data/docs/EasyPost/Brand.html ADDED
@@ -0,0 +1,140 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>class EasyPost::Brand - 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-i-url">#url</a>
76
+ </ul>
77
+ </div>
78
+
79
+ </div>
80
+ </nav>
81
+
82
+ <main role="main" aria-labelledby="class-EasyPost::Brand">
83
+ <h1 id="class-EasyPost::Brand" class="class">
84
+ class EasyPost::Brand
85
+ </h1>
86
+
87
+ <section class="description">
88
+
89
+ <p>The <a href="Brand.html"><code>Brand</code></a> object allows you to customize the publicly-accessible html page that shows tracking details for every <a href="../EasyPost.html"><code>EasyPost</code></a> tracker.</p>
90
+
91
+ </section>
92
+
93
+ <section id="5Buntitled-5D" class="documentation-section">
94
+
95
+
96
+
97
+
98
+
99
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
100
+ <header>
101
+ <h3>Public Instance Methods</h3>
102
+ </header>
103
+
104
+ <div id="method-i-url" class="method-detail ">
105
+ <div class="method-heading">
106
+ <span class="method-name">url</span><span
107
+ class="method-args">()</span>
108
+ <span class="method-click-advice">click to toggle source</span>
109
+ </div>
110
+
111
+ <div class="method-description">
112
+ <p>The url of the <a href="Brand.html"><code>Brand</code></a> object.</p>
113
+
114
+ <div class="method-source-code" id="url-source">
115
+ <pre><span class="ruby-comment"># File lib/easypost/brand.rb, line 6</span>
116
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">url</span>
117
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">user_id</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">user_id</span>.<span class="ruby-identifier">empty?</span>
118
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>, <span class="ruby-node">&quot;Missing user_id: #{self.class} instance is missing user_id&quot;</span>
119
+ <span class="ruby-keyword">end</span>
120
+
121
+ <span class="ruby-node">&quot;#{::EasyPost::User.url}/#{CGI.escape(user_id)}/brand&quot;</span>
122
+ <span class="ruby-keyword">end</span></pre>
123
+ </div>
124
+ </div>
125
+
126
+
127
+ </div>
128
+
129
+ </section>
130
+
131
+ </section>
132
+ </main>
133
+
134
+
135
+ <footer id="validator-badges" role="contentinfo">
136
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
137
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
138
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
139
+ </footer>
140
+
data/docs/EasyPost/CarbonOffset.html ADDED
@@ -0,0 +1,99 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>class EasyPost::CarbonOffset - 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::CarbonOffset">
74
+ <h1 id="class-EasyPost::CarbonOffset" class="class">
75
+ class EasyPost::CarbonOffset
76
+ </h1>
77
+
78
+ <section class="description">
79
+
80
+ <p>The <a href="CarbonOffset.html"><code>CarbonOffset</code></a> object is a summary of carbon offset data for a given rate, including grams, price and currency</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
+
data/docs/EasyPost/CarrierAccount.html ADDED
@@ -0,0 +1,136 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>class EasyPost::CarrierAccount - 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-types">::types</a>
76
+ </ul>
77
+ </div>
78
+
79
+ </div>
80
+ </nav>
81
+
82
+ <main role="main" aria-labelledby="class-EasyPost::CarrierAccount">
83
+ <h1 id="class-EasyPost::CarrierAccount" class="class">
84
+ class EasyPost::CarrierAccount
85
+ </h1>
86
+
87
+ <section class="description">
88
+
89
+ <p>A <a href="CarrierAccount.html"><code>CarrierAccount</code></a> encapsulates your credentials with the carrier.</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-types" class="method-detail ">
105
+ <div class="method-heading">
106
+ <span class="method-name">types</span><span
107
+ class="method-args">()</span>
108
+ <span class="method-click-advice">click to toggle source</span>
109
+ </div>
110
+
111
+ <div class="method-description">
112
+ <p>Retrieve a list of available <a href="CarrierAccount.html"><code>CarrierAccount</code></a> types for the authenticated User.</p>
113
+
114
+ <div class="method-source-code" id="types-source">
115
+ <pre><span class="ruby-comment"># File lib/easypost/carrier_account.rb, line 6</span>
116
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">types</span>
117
+ <span class="ruby-constant">EasyPost</span><span class="ruby-operator">::</span><span class="ruby-constant">CarrierType</span>.<span class="ruby-identifier">all</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
+