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/index.html ADDED
@@ -0,0 +1,117 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>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="file">
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
+
40
+ <div id="search-section" role="search" class="project-section initially-hidden">
41
+ <form action="#" method="get" accept-charset="utf-8">
42
+ <div id="search-field-wrapper">
43
+ <input id="search-field" role="combobox" aria-label="Search"
44
+ aria-autocomplete="list" aria-controls="search-results"
45
+ type="text" name="search" placeholder="Search" spellcheck="false"
46
+ title="Type to search, Up and Down to navigate, Enter to load">
47
+ </div>
48
+
49
+ <ul id="search-results" aria-label="Search Results"
50
+ aria-busy="false" aria-expanded="false"
51
+ aria-atomic="false" class="initially-hidden"></ul>
52
+ </form>
53
+ </div>
54
+
55
+ </div>
56
+
57
+ <div id="project-metadata">
58
+
59
+
60
+ <div id="classindex-section" class="nav-section">
61
+ <h3>Class and Module Index</h3>
62
+
63
+ <ul class="link-list">
64
+ <li><a href="./EasyPost.html">EasyPost</a>
65
+ <li><a href="./EasyPost/Address.html">EasyPost::Address</a>
66
+ <li><a href="./EasyPost/ApiKey.html">EasyPost::ApiKey</a>
67
+ <li><a href="./EasyPost/Batch.html">EasyPost::Batch</a>
68
+ <li><a href="./EasyPost/Beta.html">EasyPost::Beta</a>
69
+ <li><a href="./EasyPost/Beta/EndShipper.html">EasyPost::Beta::EndShipper</a>
70
+ <li><a href="./EasyPost/Beta/Referral.html">EasyPost::Beta::Referral</a>
71
+ <li><a href="./EasyPost/Billing.html">EasyPost::Billing</a>
72
+ <li><a href="./EasyPost/Brand.html">EasyPost::Brand</a>
73
+ <li><a href="./EasyPost/CarbonOffset.html">EasyPost::CarbonOffset</a>
74
+ <li><a href="./EasyPost/CarrierAccount.html">EasyPost::CarrierAccount</a>
75
+ <li><a href="./EasyPost/CarrierType.html">EasyPost::CarrierType</a>
76
+ <li><a href="./EasyPost/CustomsInfo.html">EasyPost::CustomsInfo</a>
77
+ <li><a href="./EasyPost/CustomsItem.html">EasyPost::CustomsItem</a>
78
+ <li><a href="./EasyPost/EasyPostObject.html">EasyPost::EasyPostObject</a>
79
+ <li><a href="./EasyPost/EndShipper.html">EasyPost::EndShipper</a>
80
+ <li><a href="./EasyPost/Error.html">EasyPost::Error</a>
81
+ <li><a href="./EasyPost/Event.html">EasyPost::Event</a>
82
+ <li><a href="./EasyPost/Insurance.html">EasyPost::Insurance</a>
83
+ <li><a href="./EasyPost/Order.html">EasyPost::Order</a>
84
+ <li><a href="./EasyPost/Parcel.html">EasyPost::Parcel</a>
85
+ <li><a href="./EasyPost/PaymentMethod.html">EasyPost::PaymentMethod</a>
86
+ <li><a href="./EasyPost/Pickup.html">EasyPost::Pickup</a>
87
+ <li><a href="./EasyPost/PickupRate.html">EasyPost::PickupRate</a>
88
+ <li><a href="./EasyPost/PostageLabel.html">EasyPost::PostageLabel</a>
89
+ <li><a href="./EasyPost/Rate.html">EasyPost::Rate</a>
90
+ <li><a href="./EasyPost/Referral.html">EasyPost::Referral</a>
91
+ <li><a href="./EasyPost/Refund.html">EasyPost::Refund</a>
92
+ <li><a href="./EasyPost/Report.html">EasyPost::Report</a>
93
+ <li><a href="./EasyPost/Resource.html">EasyPost::Resource</a>
94
+ <li><a href="./EasyPost/ScanForm.html">EasyPost::ScanForm</a>
95
+ <li><a href="./EasyPost/Shipment.html">EasyPost::Shipment</a>
96
+ <li><a href="./EasyPost/TaxIdentifier.html">EasyPost::TaxIdentifier</a>
97
+ <li><a href="./EasyPost/Tracker.html">EasyPost::Tracker</a>
98
+ <li><a href="./EasyPost/User.html">EasyPost::User</a>
99
+ <li><a href="./EasyPost/Util.html">EasyPost::Util</a>
100
+ <li><a href="./EasyPost/Webhook.html">EasyPost::Webhook</a>
101
+ </ul>
102
+ </div>
103
+
104
+ </div>
105
+ </nav>
106
+
107
+ <main role="main">
108
+ <p>This is the API documentation for EasyPost Ruby Docs.
109
+ </main>
110
+
111
+
112
+ <footer id="validator-badges" role="contentinfo">
113
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
114
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
115
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
116
+ </footer>
117
+
@@ -0,0 +1,84 @@
1
+ /**
2
+ *
3
+ * Darkfish Page Functions
4
+ * $Id: darkfish.js 53 2009-01-07 02:52:03Z deveiant $
5
+ *
6
+ * Author: Michael Granger <mgranger@laika.com>
7
+ *
8
+ */
9
+
10
+ /* Provide console simulation for firebug-less environments */
11
+ /*
12
+ if (!("console" in window) || !("firebug" in console)) {
13
+ var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml",
14
+ "group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"];
15
+
16
+ window.console = {};
17
+ for (var i = 0; i < names.length; ++i)
18
+ window.console[names[i]] = function() {};
19
+ };
20
+ */
21
+
22
+
23
+ function showSource( e ) {
24
+ var target = e.target;
25
+ while (!target.classList.contains('method-detail')) {
26
+ target = target.parentNode;
27
+ }
28
+ if (typeof target !== "undefined" && target !== null) {
29
+ target = target.querySelector('.method-source-code');
30
+ }
31
+ if (typeof target !== "undefined" && target !== null) {
32
+ target.classList.toggle('active-menu')
33
+ }
34
+ };
35
+
36
+ function hookSourceViews() {
37
+ document.querySelectorAll('.method-heading').forEach(function (codeObject) {
38
+ codeObject.addEventListener('click', showSource);
39
+ });
40
+ };
41
+
42
+ function hookSearch() {
43
+ var input = document.querySelector('#search-field');
44
+ var result = document.querySelector('#search-results');
45
+ result.classList.remove("initially-hidden");
46
+
47
+ var search_section = document.querySelector('#search-section');
48
+ search_section.classList.remove("initially-hidden");
49
+
50
+ var search = new Search(search_data, input, result);
51
+
52
+ search.renderItem = function(result) {
53
+ var li = document.createElement('li');
54
+ var html = '';
55
+
56
+ // TODO add relative path to <script> per-page
57
+ html += '<p class="search-match"><a href="' + index_rel_prefix + result.path + '">' + this.hlt(result.title);
58
+ if (result.params)
59
+ html += '<span class="params">' + result.params + '</span>';
60
+ html += '</a>';
61
+
62
+
63
+ if (result.namespace)
64
+ html += '<p class="search-namespace">' + this.hlt(result.namespace);
65
+
66
+ if (result.snippet)
67
+ html += '<div class="search-snippet">' + result.snippet + '</div>';
68
+
69
+ li.innerHTML = html;
70
+
71
+ return li;
72
+ }
73
+
74
+ search.select = function(result) {
75
+ window.location.href = result.firstChild.firstChild.href;
76
+ }
77
+
78
+ search.scrollIntoView = search.scrollInWindow;
79
+ };
80
+
81
+ document.addEventListener('DOMContentLoaded', function() {
82
+ hookSourceViews();
83
+ hookSearch();
84
+ });
@@ -0,0 +1,105 @@
1
+ /*
2
+ * Navigation allows movement using the arrow keys through the search results.
3
+ *
4
+ * When using this library you will need to set scrollIntoView to the
5
+ * appropriate function for your layout. Use scrollInWindow if the container
6
+ * is not scrollable and scrollInElement if the container is a separate
7
+ * scrolling region.
8
+ */
9
+ Navigation = new function() {
10
+ this.initNavigation = function() {
11
+ var _this = this;
12
+
13
+ document.addEventListener('keydown', function(e) {
14
+ _this.onkeydown(e);
15
+ });
16
+
17
+ this.navigationActive = true;
18
+ }
19
+
20
+ this.setNavigationActive = function(state) {
21
+ this.navigationActive = state;
22
+ }
23
+
24
+ this.onkeydown = function(e) {
25
+ if (!this.navigationActive) return;
26
+ switch(e.keyCode) {
27
+ case 37: //Event.KEY_LEFT:
28
+ if (this.moveLeft()) e.preventDefault();
29
+ break;
30
+ case 38: //Event.KEY_UP:
31
+ if (e.keyCode == 38 || e.ctrlKey) {
32
+ if (this.moveUp()) e.preventDefault();
33
+ }
34
+ break;
35
+ case 39: //Event.KEY_RIGHT:
36
+ if (this.moveRight()) e.preventDefault();
37
+ break;
38
+ case 40: //Event.KEY_DOWN:
39
+ if (e.keyCode == 40 || e.ctrlKey) {
40
+ if (this.moveDown()) e.preventDefault();
41
+ }
42
+ break;
43
+ case 13: //Event.KEY_RETURN:
44
+ if (this.current) e.preventDefault();
45
+ this.select(this.current);
46
+ break;
47
+ }
48
+ if (e.ctrlKey && e.shiftKey) this.select(this.current);
49
+ }
50
+
51
+ this.moveRight = function() {
52
+ }
53
+
54
+ this.moveLeft = function() {
55
+ }
56
+
57
+ this.move = function(isDown) {
58
+ }
59
+
60
+ this.moveUp = function() {
61
+ return this.move(false);
62
+ }
63
+
64
+ this.moveDown = function() {
65
+ return this.move(true);
66
+ }
67
+
68
+ /*
69
+ * Scrolls to the given element in the scrollable element view.
70
+ */
71
+ this.scrollInElement = function(element, view) {
72
+ var offset, viewHeight, viewScroll, height;
73
+ offset = element.offsetTop;
74
+ height = element.offsetHeight;
75
+ viewHeight = view.offsetHeight;
76
+ viewScroll = view.scrollTop;
77
+
78
+ if (offset - viewScroll + height > viewHeight) {
79
+ view.scrollTop = offset - viewHeight + height;
80
+ }
81
+ if (offset < viewScroll) {
82
+ view.scrollTop = offset;
83
+ }
84
+ }
85
+
86
+ /*
87
+ * Scrolls to the given element in the window. The second argument is
88
+ * ignored
89
+ */
90
+ this.scrollInWindow = function(element, ignored) {
91
+ var offset, viewHeight, viewScroll, height;
92
+ offset = element.offsetTop;
93
+ height = element.offsetHeight;
94
+ viewHeight = window.innerHeight;
95
+ viewScroll = window.scrollY;
96
+
97
+ if (offset - viewScroll + height > viewHeight) {
98
+ window.scrollTo(window.scrollX, offset - viewHeight + height);
99
+ }
100
+ if (offset < viewScroll) {
101
+ window.scrollTo(window.scrollX, offset);
102
+ }
103
+ }
104
+ }
105
+
Binary file
data/docs/js/search.js ADDED
@@ -0,0 +1,110 @@
1
+ Search = function(data, input, result) {
2
+ this.data = data;
3
+ this.input = input;
4
+ this.result = result;
5
+
6
+ this.current = null;
7
+ this.view = this.result.parentNode;
8
+ this.searcher = new Searcher(data.index);
9
+ this.init();
10
+ }
11
+
12
+ Search.prototype = Object.assign({}, Navigation, new function() {
13
+ var suid = 1;
14
+
15
+ this.init = function() {
16
+ var _this = this;
17
+ var observer = function(e) {
18
+ switch(e.keyCode) {
19
+ case 38: // Event.KEY_UP
20
+ case 40: // Event.KEY_DOWN
21
+ return;
22
+ }
23
+ _this.search(_this.input.value);
24
+ };
25
+ this.input.addEventListener('keyup', observer);
26
+ this.input.addEventListener('click', observer); // mac's clear field
27
+
28
+ this.searcher.ready(function(results, isLast) {
29
+ _this.addResults(results, isLast);
30
+ })
31
+
32
+ this.initNavigation();
33
+ this.setNavigationActive(false);
34
+ }
35
+
36
+ this.search = function(value, selectFirstMatch) {
37
+ value = value.trim().toLowerCase();
38
+ if (value) {
39
+ this.setNavigationActive(true);
40
+ } else {
41
+ this.setNavigationActive(false);
42
+ }
43
+
44
+ if (value == '') {
45
+ this.lastQuery = value;
46
+ this.result.innerHTML = '';
47
+ this.result.setAttribute('aria-expanded', 'false');
48
+ this.setNavigationActive(false);
49
+ } else if (value != this.lastQuery) {
50
+ this.lastQuery = value;
51
+ this.result.setAttribute('aria-busy', 'true');
52
+ this.result.setAttribute('aria-expanded', 'true');
53
+ this.firstRun = true;
54
+ this.searcher.find(value);
55
+ }
56
+ }
57
+
58
+ this.addResults = function(results, isLast) {
59
+ var target = this.result;
60
+ if (this.firstRun && (results.length > 0 || isLast)) {
61
+ this.current = null;
62
+ this.result.innerHTML = '';
63
+ }
64
+
65
+ for (var i=0, l = results.length; i < l; i++) {
66
+ var item = this.renderItem.call(this, results[i]);
67
+ item.setAttribute('id', 'search-result-' + target.childElementCount);
68
+ target.appendChild(item);
69
+ };
70
+
71
+ if (this.firstRun && results.length > 0) {
72
+ this.firstRun = false;
73
+ this.current = target.firstChild;
74
+ this.current.classList.add('search-selected');
75
+ }
76
+ //TODO: ECMAScript
77
+ //if (jQuery.browser.msie) this.$element[0].className += '';
78
+
79
+ if (isLast) this.result.setAttribute('aria-busy', 'false');
80
+ }
81
+
82
+ this.move = function(isDown) {
83
+ if (!this.current) return;
84
+ var next = isDown ? this.current.nextElementSibling : this.current.previousElementSibling;
85
+ if (next) {
86
+ this.current.classList.remove('search-selected');
87
+ next.classList.add('search-selected');
88
+ this.input.setAttribute('aria-activedescendant', next.getAttribute('id'));
89
+ this.scrollIntoView(next, this.view);
90
+ this.current = next;
91
+ this.input.value = next.firstChild.firstChild.text;
92
+ this.input.select();
93
+ }
94
+ return true;
95
+ }
96
+
97
+ this.hlt = function(html) {
98
+ return this.escapeHTML(html).
99
+ replace(/\u0001/g, '<em>').
100
+ replace(/\u0002/g, '</em>');
101
+ }
102
+
103
+ this.escapeHTML = function(html) {
104
+ return html.replace(/[&<>]/g, function(c) {
105
+ return '&#' + c.charCodeAt(0) + ';';
106
+ });
107
+ }
108
+
109
+ });
110
+
@@ -0,0 +1 @@
1
+ var search_data = {"index":{"searchIndex":["easypost","address","apikey","batch","beta","endshipper","referral","billing","brand","carbonoffset","carrieraccount","carriertype","customsinfo","customsitem","easypostobject","endshipper","error","event","insurance","order","parcel","paymentmethod","pickup","pickuprate","postagelabel","rate","referral","refund","report","resource","scanform","shipment","taxidentifier","tracker","user","util","webhook","==()","[]()","[]=()","add_accessors()","add_credit_card()","add_credit_card()","add_shipments()","all()","all()","all()","all()","all()","all()","all()","all()","all()","all()","all()","all()","all_api_keys()","api_keys()","as_json()","authorization()","build_dict_key()","buy()","buy()","buy()","buy()","cancel()","class_name()","construct_from()","convert_to_easypost_object()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create_and_buy()","create_and_verify()","create_easypost_credit_card()","create_easypost_credit_card()","create_list()","create_scan_form()","create_stripe_token()","create_stripe_token()","deconstruct_keys()","default_connection()","default_headers()","default_http_config()","delete()","delete()","delete()","delete_payment_method()","each()","each()","flatten_unsaved()","form_encode_params()","fund_wallet()","generate_form()","get_lowest_object_rate()","get_lowest_smartrate()","get_payment_method_info()","get_rates()","get_smartrates()","http_config()","http_config=()","id()","id=()","inspect()","insure()","keys()","label()","label()","lowest_rate()","lowest_rate()","lowest_rate()","lowest_smartrate()","make_client()","make_request()","metaclass()","new()","new()","normalize_string_list()","objects_to_ids()","os_arch()","os_name()","os_version()","parse_response()","receive()","refresh()","refresh_from()","refund()","regenerate_rates()","remove_shipments()","reset_http_config()","retrieve()","retrieve()","retrieve_easypost_stripe_api_key()","retrieve_easypost_stripe_api_key()","retrieve_me()","retrieve_payment_methods()","save()","save()","save()","save()","to_hash()","to_json()","to_s()","to_s()","types()","update()","update_brand()","update_email()","update_email()","url()","url()","url()","user_agent()","validate_webhook()","values()","verify()"],"longSearchIndex":["easypost","easypost::address","easypost::apikey","easypost::batch","easypost::beta","easypost::beta::endshipper","easypost::beta::referral","easypost::billing","easypost::brand","easypost::carbonoffset","easypost::carrieraccount","easypost::carriertype","easypost::customsinfo","easypost::customsitem","easypost::easypostobject","easypost::endshipper","easypost::error","easypost::event","easypost::insurance","easypost::order","easypost::parcel","easypost::paymentmethod","easypost::pickup","easypost::pickuprate","easypost::postagelabel","easypost::rate","easypost::referral","easypost::refund","easypost::report","easypost::resource","easypost::scanform","easypost::shipment","easypost::taxidentifier","easypost::tracker","easypost::user","easypost::util","easypost::webhook","easypost::error#==()","easypost::easypostobject#[]()","easypost::easypostobject#[]=()","easypost::easypostobject#add_accessors()","easypost::beta::referral::add_credit_card()","easypost::referral::add_credit_card()","easypost::batch#add_shipments()","easypost::beta::endshipper::all()","easypost::beta::referral::all()","easypost::customsinfo::all()","easypost::customsitem::all()","easypost::order::all()","easypost::parcel::all()","easypost::paymentmethod::all()","easypost::pickup::all()","easypost::rate::all()","easypost::referral::all()","easypost::report::all()","easypost::resource::all()","easypost::user::all_api_keys()","easypost::user#api_keys()","easypost::easypostobject#as_json()","easypost::authorization()","easypost::util::build_dict_key()","easypost::batch#buy()","easypost::order#buy()","easypost::pickup#buy()","easypost::shipment#buy()","easypost::pickup#cancel()","easypost::resource::class_name()","easypost::easypostobject::construct_from()","easypost::util::convert_to_easypost_object()","easypost::address::create()","easypost::beta::endshipper::create()","easypost::beta::referral::create()","easypost::endshipper::create()","easypost::referral::create()","easypost::report::create()","easypost::resource::create()","easypost::scanform::create()","easypost::shipment::create()","easypost::user::create()","easypost::batch::create_and_buy()","easypost::address::create_and_verify()","easypost::beta::referral::create_easypost_credit_card()","easypost::referral::create_easypost_credit_card()","easypost::tracker::create_list()","easypost::batch#create_scan_form()","easypost::beta::referral::create_stripe_token()","easypost::referral::create_stripe_token()","easypost::easypostobject#deconstruct_keys()","easypost::default_connection()","easypost::default_headers()","easypost::default_http_config()","easypost::resource#delete()","easypost::user#delete()","easypost::webhook#delete()","easypost::billing::delete_payment_method()","easypost::easypostobject#each()","easypost::resource::each()","easypost::easypostobject#flatten_unsaved()","easypost::util::form_encode_params()","easypost::billing::fund_wallet()","easypost::shipment#generate_form()","easypost::util::get_lowest_object_rate()","easypost::shipment::get_lowest_smartrate()","easypost::billing::get_payment_method_info()","easypost::order#get_rates()","easypost::shipment#get_smartrates()","easypost::http_config()","easypost::http_config=()","easypost::easypostobject#id()","easypost::easypostobject#id=()","easypost::easypostobject#inspect()","easypost::shipment#insure()","easypost::easypostobject#keys()","easypost::batch#label()","easypost::shipment#label()","easypost::order#lowest_rate()","easypost::pickup#lowest_rate()","easypost::shipment#lowest_rate()","easypost::shipment#lowest_smartrate()","easypost::make_client()","easypost::make_request()","easypost::easypostobject#metaclass()","easypost::easypostobject::new()","easypost::error::new()","easypost::util::normalize_string_list()","easypost::util::objects_to_ids()","easypost::util::os_arch()","easypost::util::os_name()","easypost::util::os_version()","easypost::parse_response()","easypost::event::receive()","easypost::resource#refresh()","easypost::easypostobject#refresh_from()","easypost::shipment#refund()","easypost::shipment#regenerate_rates()","easypost::batch#remove_shipments()","easypost::reset_http_config()","easypost::beta::endshipper::retrieve()","easypost::resource::retrieve()","easypost::beta::referral::retrieve_easypost_stripe_api_key()","easypost::referral::retrieve_easypost_stripe_api_key()","easypost::user::retrieve_me()","easypost::billing::retrieve_payment_methods()","easypost::beta::endshipper#save()","easypost::endshipper#save()","easypost::resource#save()","easypost::user#save()","easypost::easypostobject#to_hash()","easypost::easypostobject#to_json()","easypost::easypostobject#to_s()","easypost::error#to_s()","easypost::carrieraccount::types()","easypost::webhook#update()","easypost::user#update_brand()","easypost::beta::referral::update_email()","easypost::referral::update_email()","easypost::brand#url()","easypost::resource::url()","easypost::resource#url()","easypost::user_agent()","easypost::webhook::validate_webhook()","easypost::easypostobject#values()","easypost::address#verify()"],"info":[["EasyPost","","EasyPost.html","",""],["EasyPost::Address","","EasyPost/Address.html","","<p>Address objects are used to represent people, places, and organizations in a number of contexts.\n"],["EasyPost::ApiKey","","EasyPost/ApiKey.html","","<p>An ApiKey allows you to authenticate with the EasyPost API.\n"],["EasyPost::Batch","","EasyPost/Batch.html","","<p>The Batch object allows you to perform operations on multiple Shipments at once.\n"],["EasyPost::Beta","","EasyPost/Beta.html","",""],["EasyPost::Beta::EndShipper","","EasyPost/Beta/EndShipper.html","","<p>EndShipper objects are fully-qualified Address objects that require all parameters and get verified upon …\n"],["EasyPost::Beta::Referral","","EasyPost/Beta/Referral.html","","<p>Referral objects are User objects created from a Partner user.\n"],["EasyPost::Billing","","EasyPost/Billing.html","","<p>Billing class that users can manage their payment and fund\n"],["EasyPost::Brand","","EasyPost/Brand.html","","<p>The Brand object allows you to customize the publicly-accessible html page that shows tracking details …\n"],["EasyPost::CarbonOffset","","EasyPost/CarbonOffset.html","","<p>The CarbonOffset object is a summary of carbon offset data for a given rate, including grams, price and …\n"],["EasyPost::CarrierAccount","","EasyPost/CarrierAccount.html","","<p>A CarrierAccount encapsulates your credentials with the carrier.\n"],["EasyPost::CarrierType","","EasyPost/CarrierType.html","","<p>The CarrierType object provides an interface for determining the valid fields of a CarrierAccount.\n"],["EasyPost::CustomsInfo","","EasyPost/CustomsInfo.html","","<p>CustomsInfo objects contain CustomsItem objects and all necessary information for the generation of customs …\n"],["EasyPost::CustomsItem","","EasyPost/CustomsItem.html","","<p>A CustomsItem object describes goods for international shipment and should be created then included in …\n"],["EasyPost::EasyPostObject","","EasyPost/EasyPostObject.html","","<p>The EasyPostObject is extended by the EasyPost Resource object.\n"],["EasyPost::EndShipper","","EasyPost/EndShipper.html","","<p>EndShipper objects are fully-qualified Address objects that require all parameters and get verified upon …\n"],["EasyPost::Error","","EasyPost/Error.html","","<p>EasyPost Error object.\n"],["EasyPost::Event","","EasyPost/Event.html","","<p>Webhook Events are triggered by changes in objects you’ve created via the API.\n"],["EasyPost::Insurance","","EasyPost/Insurance.html","","<p>An Insurance object represents insurance for packages purchased both via the EasyPost API as well as …\n"],["EasyPost::Order","","EasyPost/Order.html","","<p>The Order object represents a collection of packages and can be used for Multi-Piece Shipments.\n"],["EasyPost::Parcel","","EasyPost/Parcel.html","","<p>Parcel objects represent the physical container being shipped.\n"],["EasyPost::PaymentMethod","","EasyPost/PaymentMethod.html","","<p>PaymentMethod objects represent a payment method of a user.\n"],["EasyPost::Pickup","","EasyPost/Pickup.html","","<p>The Pickup object allows you to schedule a pickup from your carrier from your customer’s residence …\n"],["EasyPost::PickupRate","","EasyPost/PickupRate.html","","<p>A PickupRate is the rate available for a Pickup.\n"],["EasyPost::PostageLabel","","EasyPost/PostageLabel.html","","<p>PostageLabel is the object containing details about the shipping label.\n"],["EasyPost::Rate","","EasyPost/Rate.html","","<p>A Rate object contains all the details about the rate of a Shipment.\n"],["EasyPost::Referral","","EasyPost/Referral.html","","<p>Referral objects are User objects created from a Partner user.\n"],["EasyPost::Refund","","EasyPost/Refund.html","","<p>The Refund object contains details about the Refund of a Shipment.\n"],["EasyPost::Report","","EasyPost/Report.html","","<p>A Report contains a csv that is a log of all the objects created within a certain time frame.\n"],["EasyPost::Resource","","EasyPost/Resource.html","","<p>The Resource object is extended by each EasyPost object.\n"],["EasyPost::ScanForm","","EasyPost/ScanForm.html","","<p>A ScanForm can be created to speed up and simplify the carrier pickup process. The ScanForm is one document …\n"],["EasyPost::Shipment","","EasyPost/Shipment.html","","<p>The workhorse of the EasyPost API, a Shipment is made up of a “to” and “from” Address …\n"],["EasyPost::TaxIdentifier","","EasyPost/TaxIdentifier.html","","<p>TaxIdentifiers are identifying numbers or IDs that are used to charge a specific party when dealing with …\n"],["EasyPost::Tracker","","EasyPost/Tracker.html","","<p>A Tracker object contains all of the tracking information for a package.\n"],["EasyPost::User","","EasyPost/User.html","","<p>The User object can be used to manage your own account and to create child accounts.\n"],["EasyPost::Util","","EasyPost/Util.html","","<p>Internal utilities helpful for this libraries operation.\n"],["EasyPost::Webhook","","EasyPost/Webhook.html","","<p>Each Webhook contains the url which EasyPost will notify whenever an object in our system updates. Several …\n"],["==","EasyPost::Error","EasyPost/Error.html#method-i-3D-3D","(other)","<p>Compare error properties.\n"],["[]","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-5B-5D","(key)","<p>Get element of an array.\n"],["[]=","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-5B-5D-3D","(key, value)","<p>Set the element of an array.\n"],["add_accessors","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-add_accessors","(keys)","<p>Add accessors of an object.\n"],["add_credit_card","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-add_credit_card","(referral_api_key, number, expiration_month, expiration_year, cvc, priority = 'primary')","<p>Add credit card to a referral customer. This function requires the Referral Customer’s API key. <strong>DEPRECATED:</strong> …\n"],["add_credit_card","EasyPost::Referral","EasyPost/Referral.html#method-c-add_credit_card","(referral_api_key, number, expiration_month, expiration_year, cvc, priority = 'primary')","<p>Add credit card to a referral customer. This function requires the Referral Customer’s API key.\n"],["add_shipments","EasyPost::Batch","EasyPost/Batch.html#method-i-add_shipments","(params = {})","<p>Add Shipments to a Batch.\n"],["all","EasyPost::Beta::EndShipper","EasyPost/Beta/EndShipper.html#method-c-all","(params = {}, api_key = nil)","<p>Retrieves a list of EndShipper objects. <strong>DEPRECATED:</strong> Please use <code>EndShipper</code> in the main namespace instead. …\n"],["all","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-all","(params = {}, api_key = nil)","<p>Retrieve a list of referral customers. This function requires the Partner User’s API key. <strong>DEPRECATED:</strong> …\n"],["all","EasyPost::CustomsInfo","EasyPost/CustomsInfo.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieve a list of CustomsInfo objects\n"],["all","EasyPost::CustomsItem","EasyPost/CustomsItem.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieve a list of CustomsItem objects\n"],["all","EasyPost::Order","EasyPost/Order.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieve a list of Order objects.\n"],["all","EasyPost::Parcel","EasyPost/Parcel.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieving all Parcel objects is not supported.\n"],["all","EasyPost::PaymentMethod","EasyPost/PaymentMethod.html#method-c-all","(_filters = {}, api_key = nil)","<p><strong>DEPRECATED:</strong> Please use <code>Billing class</code> instead. Deprecated: v4.5.0 - v6.0.0\n"],["all","EasyPost::Pickup","EasyPost/Pickup.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieve a list of all Pickup objects.\n"],["all","EasyPost::Rate","EasyPost/Rate.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieving all Rate objects is not supported.\n"],["all","EasyPost::Referral","EasyPost/Referral.html#method-c-all","(params = {}, api_key = nil)","<p>Retrieve a list of referral customers. This function requires the Partner User’s API key.\n"],["all","EasyPost::Report","EasyPost/Report.html#method-c-all","(filters = {}, api_key = nil)","<p>Retrieve a list of Report objects.\n"],["all","EasyPost::Resource","EasyPost/Resource.html#method-c-all","(filters = {}, api_key = nil)","<p>Retrieve a list of EasyPost objects.\n"],["all_api_keys","EasyPost::User","EasyPost/User.html#method-c-all_api_keys","()","<p>Retrieve a list of ApiKey objects.\n"],["api_keys","EasyPost::User","EasyPost/User.html#method-i-api_keys","()","<p>Retrieve a list of ApiKey objects of a child User.\n"],["as_json","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-as_json","(_options = {})","<p>Get values as JSON.\n"],["authorization","EasyPost","EasyPost.html#method-c-authorization","(key)",""],["build_dict_key","EasyPost::Util","EasyPost/Util.html#method-c-build_dict_key","(keys)","<p>Build a dict key from a list of keys. Example: [code, number] -&gt; code\n"],["buy","EasyPost::Batch","EasyPost/Batch.html#method-i-buy","(params = {})","<p>Buy a Batch.\n"],["buy","EasyPost::Order","EasyPost/Order.html#method-i-buy","(params = {})","<p>Buy an Order.\n"],["buy","EasyPost::Pickup","EasyPost/Pickup.html#method-i-buy","(params = {})","<p>Buy a Pickup.\n"],["buy","EasyPost::Shipment","EasyPost/Shipment.html#method-i-buy","(params = {}, with_carbon_offset = false, end_shipper_id = nil)","<p>Buy a Shipment.\n"],["cancel","EasyPost::Pickup","EasyPost/Pickup.html#method-i-cancel","(params = {})","<p>Cancel a Pickup.\n"],["class_name","EasyPost::Resource","EasyPost/Resource.html#method-c-class_name","()","<p>The class name of an EasyPost object.\n"],["construct_from","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-c-construct_from","(values, api_key = nil, parent = nil, name = nil)","<p>Construct an object from values.\n"],["convert_to_easypost_object","EasyPost::Util","EasyPost/Util.html#method-c-convert_to_easypost_object","(response, api_key, parent = nil, name = nil)","<p>Convert data to an EasyPost Object.\n"],["create","EasyPost::Address","EasyPost/Address.html#method-c-create","(params = {}, api_key = nil)","<p>Create an Address.\n"],["create","EasyPost::Beta::EndShipper","EasyPost/Beta/EndShipper.html#method-c-create","(params = {}, api_key = nil)","<p>Create an EndShipper object. <strong>DEPRECATED:</strong> Please use <code>EndShipper</code> in the main namespace instead.\n"],["create","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-create","(params = {}, api_key = nil)","<p>Create a referral customer. This function requires the Partner User’s API key. <strong>DEPRECATED:</strong> Please use …\n"],["create","EasyPost::EndShipper","EasyPost/EndShipper.html#method-c-create","(params = {}, api_key = nil)","<p>Create an EndShipper object.\n"],["create","EasyPost::Referral","EasyPost/Referral.html#method-c-create","(params = {}, api_key = nil)","<p>Create a referral customer. This function requires the Partner User’s API key.\n"],["create","EasyPost::Report","EasyPost/Report.html#method-c-create","(params = {}, api_key = nil)","<p>Create a Report.\n"],["create","EasyPost::Resource","EasyPost/Resource.html#method-c-create","(params = {}, api_key = nil)","<p>Create an EasyPost object.\n"],["create","EasyPost::ScanForm","EasyPost/ScanForm.html#method-c-create","(params = {}, api_key = nil)","<p>Create a ScanForm.\n"],["create","EasyPost::Shipment","EasyPost/Shipment.html#method-c-create","(params = {}, api_key = nil, with_carbon_offset = false)","<p>Create a Shipment.\n"],["create","EasyPost::User","EasyPost/User.html#method-c-create","(params = {}, api_key = nil)","<p>Create a child User.\n"],["create_and_buy","EasyPost::Batch","EasyPost/Batch.html#method-c-create_and_buy","(params = {}, api_key = nil)","<p>Create and buy a batch in one call.\n"],["create_and_verify","EasyPost::Address","EasyPost/Address.html#method-c-create_and_verify","(params = {}, api_key = nil)","<p>Create and verify an Address in one call.\n"],["create_easypost_credit_card","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-create_easypost_credit_card","(referral_api_key, stripe_object_id, priority = 'primary')","<p>Submit Stripe credit card token to EasyPost.\n"],["create_easypost_credit_card","EasyPost::Referral","EasyPost/Referral.html#method-c-create_easypost_credit_card","(referral_api_key, stripe_object_id, priority = 'primary')","<p>Submit Stripe credit card token to EasyPost.\n"],["create_list","EasyPost::Tracker","EasyPost/Tracker.html#method-c-create_list","(params = {}, api_key = nil)","<p>Create multiple Tracker objects in bulk.\n"],["create_scan_form","EasyPost::Batch","EasyPost/Batch.html#method-i-create_scan_form","(params = {})","<p>Create a ScanForm for a Batch.\n"],["create_stripe_token","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-create_stripe_token","(number, expiration_month, expiration_year, cvc, easypost_stripe_token)","<p>Get credit card token from Stripe.\n"],["create_stripe_token","EasyPost::Referral","EasyPost/Referral.html#method-c-create_stripe_token","(number, expiration_month, expiration_year, cvc, easypost_stripe_token)","<p>Get credit card token from Stripe.\n"],["deconstruct_keys","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-deconstruct_keys","(_keys)","<p>Deconstruct the keys of an object.\n"],["default_connection","EasyPost","EasyPost.html#method-c-default_connection","()",""],["default_headers","EasyPost","EasyPost.html#method-c-default_headers","()",""],["default_http_config","EasyPost","EasyPost.html#method-c-default_http_config","()",""],["delete","EasyPost::Resource","EasyPost/Resource.html#method-i-delete","()","<p>Delete an EasyPost object.\n"],["delete","EasyPost::User","EasyPost/User.html#method-i-delete","()","<p>Delete a User.\n"],["delete","EasyPost::Webhook","EasyPost/Webhook.html#method-i-delete","()","<p>Delete a Webhook.\n"],["delete_payment_method","EasyPost::Billing","EasyPost/Billing.html#method-c-delete_payment_method","(primary_or_secondary, api_key = nil)","<p>Delete a payment method.\n"],["each","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-each","(&blk)","<p>Get each element of values.\n"],["each","EasyPost::Resource","EasyPost/Resource.html#method-c-each","(filters = {}, api_key = EasyPost.api_key, &block)","<p>Filter all results based on criteria.\n"],["flatten_unsaved","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-flatten_unsaved","()","<p>Flatten the unsaved values of an object.\n"],["form_encode_params","EasyPost::Util","EasyPost/Util.html#method-c-form_encode_params","(hash, parent_keys = [], parent_dict = {})","<p>Form-encode a multi-layer dictionary to a one-layer dictionary.\n"],["fund_wallet","EasyPost::Billing","EasyPost/Billing.html#method-c-fund_wallet","(amount, primary_or_secondary = 'primary', api_key = nil)","<p>Fund your EasyPost wallet by charging your primary or secondary card on file.\n"],["generate_form","EasyPost::Shipment","EasyPost/Shipment.html#method-i-generate_form","(form_type, form_options = {})","<p>Generate a form for a Shipment.\n"],["get_lowest_object_rate","EasyPost::Util","EasyPost/Util.html#method-c-get_lowest_object_rate","(easypost_object, carriers = [], services = [], rates_key = 'rates')","<p>Gets the lowest rate of an EasyPost object such as a Shipment, Order, or Pickup. You can exclude by having …\n"],["get_lowest_smartrate","EasyPost::Shipment","EasyPost/Shipment.html#method-c-get_lowest_smartrate","(smartrates, delivery_days, delivery_accuracy)","<p>Get the lowest smartrate from a list of smartrates.\n"],["get_payment_method_info","EasyPost::Billing","EasyPost/Billing.html#method-c-get_payment_method_info","(primary_or_secondary)","<p>Get payment method info (type of the payment method and ID of the payment method)\n"],["get_rates","EasyPost::Order","EasyPost/Order.html#method-i-get_rates","(params = {})","<p>Get the rates of an Order.\n"],["get_smartrates","EasyPost::Shipment","EasyPost/Shipment.html#method-i-get_smartrates","()","<p>Get the SmartRates of a Shipment.\n"],["http_config","EasyPost","EasyPost.html#method-c-http_config","()","<p>Get the HTTP config.\n"],["http_config=","EasyPost","EasyPost.html#method-c-http_config-3D","(http_config_params)","<p>Set the HTTP config.\n"],["id","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-id","()","<p>Get the ID of an object.\n"],["id=","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-id-3D","(id)","<p>Set the ID of an object.\n"],["inspect","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-inspect","()","<p>Inspect JSON.\n"],["insure","EasyPost::Shipment","EasyPost/Shipment.html#method-i-insure","(params = {})","<p>Insure a Shipment.\n"],["keys","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-keys","()","<p>Keys of an object.\n"],["label","EasyPost::Batch","EasyPost/Batch.html#method-i-label","(params = {})","<p>Convert the label format of a Batch.\n"],["label","EasyPost::Shipment","EasyPost/Shipment.html#method-i-label","(params = {})","<p>Convert the label format of a Shipment.\n"],["lowest_rate","EasyPost::Order","EasyPost/Order.html#method-i-lowest_rate","(carriers = [], services = [])","<p>Get the lowest rate of an Order (can exclude by having ‘’!‘` as the first element of your optional …\n"],["lowest_rate","EasyPost::Pickup","EasyPost/Pickup.html#method-i-lowest_rate","(carriers = [], services = [])","<p>Get the lowest rate of a Pickup (can exclude by having ‘’!‘` as the first element of your optional …\n"],["lowest_rate","EasyPost::Shipment","EasyPost/Shipment.html#method-i-lowest_rate","(carriers = [], services = [])","<p>Get the lowest rate of a Shipment (can exclude by having ‘’!‘` as the first element of your optional …\n"],["lowest_smartrate","EasyPost::Shipment","EasyPost/Shipment.html#method-i-lowest_smartrate","(delivery_days, delivery_accuracy)","<p>Get the lowest smartrate of a Shipment.\n"],["make_client","EasyPost","EasyPost.html#method-c-make_client","(url)","<p>Create an EasyPost Client.\n<p>@deprecated\n"],["make_request","EasyPost","EasyPost.html#method-c-make_request","(method, path, api_key = nil, body = nil)","<p>Make an HTTP request against the {default_connection}\n<p>@param method [Symbol] the HTTP Verb (get, method, …\n"],["metaclass","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-metaclass","()","<p>The metaclass of an object.\n"],["new","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-c-new","(id = nil, api_key = nil, parent = nil, name = nil)","<p>Initialize an EasyPostObject.\n"],["new","EasyPost::Error","EasyPost/Error.html#method-c-new","(message = nil, status = nil, code = nil, errors = nil, http_body = nil)","<p>Initialize a new EasyPost Error\n"],["normalize_string_list","EasyPost::Util","EasyPost/Util.html#method-c-normalize_string_list","(lst)","<p>Normalizes a list of strings.\n"],["objects_to_ids","EasyPost::Util","EasyPost/Util.html#method-c-objects_to_ids","(obj)","<p>Converts an object to an object ID.\n"],["os_arch","EasyPost::Util","EasyPost/Util.html#method-c-os_arch","()",""],["os_name","EasyPost::Util","EasyPost/Util.html#method-c-os_name","()",""],["os_version","EasyPost::Util","EasyPost/Util.html#method-c-os_version","()",""],["parse_response","EasyPost","EasyPost.html#method-c-parse_response","(status:, body:, json:)",""],["receive","EasyPost::Event","EasyPost/Event.html#method-c-receive","(values)","<p>Converts a raw webhook event into an EasyPost object.\n"],["refresh","EasyPost::Resource","EasyPost/Resource.html#method-i-refresh","()","<p>Refresh an object from the API response.\n"],["refresh_from","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-refresh_from","(values, api_key)","<p>Refresh an object from the API.\n"],["refund","EasyPost::Shipment","EasyPost/Shipment.html#method-i-refund","(params = {})","<p>Refund a Shipment.\n"],["regenerate_rates","EasyPost::Shipment","EasyPost/Shipment.html#method-i-regenerate_rates","(with_carbon_offset = false)","<p>Regenerate the rates of a Shipment.\n"],["remove_shipments","EasyPost::Batch","EasyPost/Batch.html#method-i-remove_shipments","(params = {})","<p>Remove Shipments from a Batch.\n"],["reset_http_config","EasyPost","EasyPost.html#method-c-reset_http_config","()","<p>Reset the HTTP config.\n"],["retrieve","EasyPost::Beta::EndShipper","EasyPost/Beta/EndShipper.html#method-c-retrieve","(id, params = {}, api_key = nil)","<p>Retrieves an EndShipper object. <strong>DEPRECATED:</strong> Please use <code>EndShipper</code> in the main namespace instead.\n"],["retrieve","EasyPost::Resource","EasyPost/Resource.html#method-c-retrieve","(id, api_key = nil)","<p>Retrieve an EasyPost object.\n"],["retrieve_easypost_stripe_api_key","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-retrieve_easypost_stripe_api_key","()","<p>Retrieve EasyPost’s Stripe public API key.\n"],["retrieve_easypost_stripe_api_key","EasyPost::Referral","EasyPost/Referral.html#method-c-retrieve_easypost_stripe_api_key","()","<p>Retrieve EasyPost’s Stripe public API key.\n"],["retrieve_me","EasyPost::User","EasyPost/User.html#method-c-retrieve_me","()","<p>Retrieve the authenticated User.\n"],["retrieve_payment_methods","EasyPost::Billing","EasyPost/Billing.html#method-c-retrieve_payment_methods","(api_key = nil)","<p>Retrieve all payment methods.\n"],["save","EasyPost::Beta::EndShipper","EasyPost/Beta/EndShipper.html#method-i-save","()","<p>Updates (saves) an EndShipper object. This requires all parameters to be set. <strong>DEPRECATED:</strong> Please use …\n"],["save","EasyPost::EndShipper","EasyPost/EndShipper.html#method-i-save","()","<p>Updates (saves) an EndShipper object. This requires all parameters to be set.\n"],["save","EasyPost::Resource","EasyPost/Resource.html#method-i-save","()","<p>Save (update) and EasyPost object.\n"],["save","EasyPost::User","EasyPost/User.html#method-i-save","()","<p>Save (update) a User.\n"],["to_hash","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-to_hash","()","<p>Make values a hash.\n"],["to_json","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-to_json","(_options = {})","<p>Make values JSON.\n"],["to_s","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-to_s","(*_args)","<p>Convert to a string.\n"],["to_s","EasyPost::Error","EasyPost/Error.html#method-i-to_s","()","<p>Convert an error to a string.\n"],["types","EasyPost::CarrierAccount","EasyPost/CarrierAccount.html#method-c-types","()","<p>Retrieve a list of available CarrierAccount types for the authenticated User.\n"],["update","EasyPost::Webhook","EasyPost/Webhook.html#method-i-update","(params = {})","<p>Update a Webhook.\n"],["update_brand","EasyPost::User","EasyPost/User.html#method-i-update_brand","(**attrs)","<p>Update the Brand of a User.\n"],["update_email","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-update_email","(email, user_id, api_key = nil)","<p>Update a referral customer. This function requires the Partner User’s API key. <strong>DEPRECATED:</strong> Please use …\n"],["update_email","EasyPost::Referral","EasyPost/Referral.html#method-c-update_email","(email, user_id, api_key = nil)","<p>Update a referral customer. This function requires the Partner User’s API key.\n"],["url","EasyPost::Brand","EasyPost/Brand.html#method-i-url","()","<p>The url of the Brand object.\n"],["url","EasyPost::Resource","EasyPost/Resource.html#method-c-url","()","<p>The instance url of the Resource.\n"],["url","EasyPost::Resource","EasyPost/Resource.html#method-i-url","()","<p>The url of the Resource.\n"],["user_agent","EasyPost","EasyPost.html#method-c-user_agent","()",""],["validate_webhook","EasyPost::Webhook","EasyPost/Webhook.html#method-c-validate_webhook","(event_body, headers, webhook_secret)","<p>Validate a webhook by comparing the HMAC signature header sent from EasyPost to your shared secret. …\n"],["values","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-values","()","<p>Values of an object.\n"],["verify","EasyPost::Address","EasyPost/Address.html#method-i-verify","()","<p>Verify an Address.\n"]]}}
Binary file