easypost 4.8.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ad992fe480aa1a1c8b1fc7e85dd06c7af4478bca9bcc3a2f083daaeeedcc39e
-  data.tar.gz: f37a2a32dac1dcc1efa0121dce6b6edbf14e3aa690308d393815ecaabddedda4
+  metadata.gz: 74cc993ead7c401dc7dbd719667872b1317a83e31c93bf85e3489cdc5b322a51
+  data.tar.gz: 17095956ef150f649b12b9b974db4098b495bbfe7710fe368d594e7e6410e6ea
 SHA512:
-  metadata.gz: 6f0e9c8cbfb299608c58c865a2193e163739ca3543fb5bbea44026930bbecf34ae8d772fc2377909492a89d8c7d3d1440c7a9f7ebf25935927db35bc6ba1b7c3
-  data.tar.gz: 8b02eee4c36c0c918e4a3f4884694c48d453bbf3aba7db653669618462d67bad30c0cf0ceec96ee44de0b335626e0992b493ad06e4457feeb5f661ebe55ceb70
+  metadata.gz: 8708b3ed757fdcec975e84a585bbbdc5e428de0f32b34b047b3d1860fb663db7b48748a49a5841de405adb00bc3102c3bc7ffea56d7d4ff0bf7ff6a74e81015d
+  data.tar.gz: 4fb43956853af9c440f7b84a804250e5e817ea3261e9900f821236bf2ae4fc623d1a68a36a899628b655ca6b1833e9095b3b943d2224224a95af24fb6c732bca

data/.gitattributes

@@ -1,4 +1,9 @@
 * text=auto
 
+# Cassettes
 spec/cassettes/**/* -diff
 spec/cassettes/**/* linguist-generated
+
+# Docs
+docs/**/* -diff
+docs/**/* linguist-generated

data/.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: "CI"
+name: 'CI'
 
 on:
   push:
@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rubyversion: ["2.5", "2.6", "2.7", "3.0", "3.1"]
+        rubyversion: ['2.6', '2.7', '3.0', '3.1', '3.2']
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3
@@ -19,11 +19,18 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.rubyversion }}
+          rubygems: '3.0.0'
           bundler-cache: true
       - name: Install Dependencies
         run: make install
       - name: run tests
         run: EASYPOST_TEST_API_KEY=123 EASYPOST_PROD_API_KEY=123 make test
+      - name: Coveralls
+        if: github.ref == 'refs/heads/master'
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: './coverage/lcov/easypost-ruby.lcov'
   lint:
     runs-on: ubuntu-latest
     steps:
@@ -32,11 +39,33 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "3.1"
+          ruby-version: '3.2'
+          rubygems: '3.0.0'
           bundler-cache: true
       - name: Install Dependencies
         run: make install
+      - name: Install style guides
+        run: make install-styleguide
       - name: Lint Project
         run: make lint
-      - name: Run security analysis
-        run: make scan
+  docs:
+    if: github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          rubygems: '3.0.0'
+          bundler-cache: true
+      - name: Install Dependencies
+        run: make install
+      - name: Generate Docs
+        run: make docs
+      - name: Deploy docs
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs

data/.gitignore

@@ -1,9 +1,20 @@
-*.gem
-*.rbc
+._*
+.AppleDouble
 .bundle
 .config
-Gemfile.lock
+.DS_Store
+.env
+.idea/
+.LSOverride
+.Spotlight-V100
+.Trashes
+*.gem
+*.rbc
 coverage
+dist
+docs
+Gemfile.lock
+Icon
 InstalledFiles
 lib/bundler/man
 pkg
@@ -12,21 +23,17 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.idea/
-dist
-
-# YARD artifacts
-.yardoc
-_yardoc
-doc/
-
-# iOS
-.DS_Store
-.AppleDouble
-.LSOverride
-Icon
-._*
-.Spotlight-V100
-.Trashes
 vendor/
-.env
+/easycop.yml
+/.rubocop.yml
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+Session.vim
+Sessionx.vim
+.netrwhist
+*~
+tags
+[._]*.un~

data/CHANGELOG.md

@@ -1,5 +1,61 @@
 # CHANGELOG
 
+## v5.1.0 (2023-07-28)
+
+- Adds hooks to introspect the request and response of API calls (see `HTTP Hooks` section in the README for more details)
+- Maps 400 status code responses to the new `BadRequestError` class
+
+## v5.0.1 (2023-06-20)
+
+- Fixes a bug where the params of a `customs_info` on create weren't wrapped properly which led to an empty set of `customs_items`
+
+## v5.0.0 (2023-06-06)
+
+See our [Upgrade Guide](UPGRADE_GUIDE.md#upgrading-from-4x-to-50) for more details.
+
+- Library is now thread-safe. Closes GitHub Issue ([#183](https://github.com/EasyPost/easypost-ruby/issues/183))
+  - Initialize a `Client` object with an API key. Optionally set open and read timeout params
+  - Previous classes have been diverted into `Services` and `Models`
+    - All methods (i.e. `create`, `retrieve`, `all`) exist in services, accessed via property of the client (eg: `client.shipment.create()`)
+      - E.g. `bought_shipment = client.shipment.buy(shipment_id, rate)`
+- Beta namespace changed from `easypost.beta.x` to `client.beta_x`
+- References to `Referral` are now `ReferralCustomer` and `referral_customer` to match the API and docs
+- References to `smartrate` are now `SmartRate` and `smart_rate` to match the API and docs
+  - Rename function `get_smartrates` to `get_smart_rates`
+  - Rename function `get_lowest_smartrate` to `get_lowest_smart_rate`
+- Empty API response functions for `delete` return `true` instead of empty object
+- Drops support for Ruby 2.5
+- Bumps all dev dependencies
+- Improves Error Deserialization to dynamically handle edge cases that have a bad format
+- Adds `retrieve_estimated_delivery_date` function in Shipment
+- Removes deprecated `endshipper` beta class, please use the GA one `EasyPost::Services::EndShipper`
+
+## v4.13.0 (2023-04-04)
+
+- Adds `get_next_page` function to each object which retrieves the next page of a collection when the `has_more` key is present in the response
+
+## v4.12.0 (2023-02-21)
+
+- Adds beta `retrieve_stateless_rates` function
+- Adds `get_lowest_stateless_rate` utility
+
+## v4.11.0 (2023-01-18)
+
+- Added function to retrieve all pickups, accessible via `EasyPost::Pickup.all`
+- Added payload functions `retrieve_all_payloads` and `retrieve_payload` to retrieve all payloads or a specific payload for an event.
+
+## v4.10.0 (2023-01-11)
+
+- Added new beta billing functionality for referral customer users, accessible via `EasyPost::Beta::Referral`
+  - `add_payment_method` to add an existing Stripe bank account or credit card to your EasyPost account
+  - `refund_by_amount` refunds you wallet balance by a specified amount
+  - `refund_by_payment_log` refunds you wallet balance by a specified payment log
+- Fix bug where bank account and credit card payment methods were not deserializing to the `EasyPost::PaymentMethod` class
+
+## v4.9.0 (2022-12-07)
+
+- Routes requests for creating a carrier account with a custom workflow (eg: FedEx, UPS) to the correct endpoint when using the `create` function
+
 ## v4.8.1 (2022-10-24)
 
 - Concatenates `error.message` if it incorrectly comes back from the API as an array

data/Makefile

@@ -12,19 +12,27 @@ build:
 clean:
 	rm -rf coverage doc *.gem dist
 
-## fix - Fix Rubocop errors
-fix:
-	bundle exec rubocop -A
+## coverage - Generate a test coverage report
+coverage:
+	make test
+
+## docs - Generate documentation for the library
+docs:
+	bundle exec rdoc lib -o docs --title "EasyPost Ruby Docs"
+
+## install-styleguide - Import the style guides (Unix only)
+install-styleguide: | update-examples-submodule
+	sh examples/symlink_directory_files.sh examples/style_guides/ruby .
 
 ## install - Install globally from source
-install:
-	git submodule init
-	git submodule update
+install: | update-examples-submodule
 	bundle install
 
 ## lint - Lint the project
-lint:
-	bundle exec rubocop
+lint: rubocop scan
+
+## lint-fix - Fix Rubocop errors
+lint-fix: rubocop-fix
 
 ## publish - Publishes the built gem to Rubygems
 publish:
@@ -35,17 +43,28 @@ publish:
 release:
 	gh release create ${tag} dist/*
 
+## rubocop - lints the project with rubocop
+rubocop:
+	bundle exec rubocop
+
+## rubocop-fix - fix rubocop errors
+rubocop-fix:
+	bundle exec rubocop -a
+
 ## scan - Runs security analysis on the project with Brakeman
 scan:
 	bundle exec brakeman lib --force
 
 ## test - Test the project (and ignore warnings for test output)
 test:
-	RUBYOPT="-W0" bundle exec rspec
+	bundle exec rspec
 
 ## update - Updates dependencies
-update:
+update: | update-examples-submodule
+
+## update-examples-submodule - Update the examples submodule
+update-examples-submodule:
 	git submodule init
 	git submodule update --remote
 
-.PHONY: help build clean fix install lint publish release scan test update
+.PHONY: help build clean coverage docs install install-styleguide lint lint-fix publish release rubocop rubocop-fix scan test update update-examples-submodule

data/README.md

@@ -1,6 +1,7 @@
 # EasyPost Ruby Client Library
 
 [![Build Status](https://github.com/EasyPost/easypost-ruby/workflows/CI/badge.svg)](https://github.com/EasyPost/easypost-ruby/actions?query=workflow%3ACI)
+[![Coverage Status](https://coveralls.io/repos/github/EasyPost/easypost-ruby/badge.svg?branch=master)](https://coveralls.io/github/EasyPost/easypost-ruby?branch=master)
 [![Gem Version](https://badge.fury.io/rb/easypost.svg)](https://badge.fury.io/rb/easypost)
 
 EasyPost, the simple shipping solution. You can sign up for an account at <https://easypost.com>.
@@ -23,9 +24,9 @@ A simple create & buy shipment example:
 ```ruby
 require 'easypost'
 
-EasyPost.api_key = ENV['EASYPOST_API_KEY']
+client = EasyPost::Client.new(api_key: ENV['EASYPOST_TEST_API_KEY'])
 
-shipment = EasyPost::Shipment.create(
+shipment = client.shipment.create(
   from_address: {
     company: 'EasyPost',
     street1: '118 2nd Street',
@@ -52,39 +53,47 @@ shipment = EasyPost::Shipment.create(
   },
 )
 
-shipment.buy(rate: shipment.lowest_rate)
+bought_shipment = client.shipment.buy(shipment.id, rate: shipment.lowest_rate)
 
-puts shipment
+puts bought_shipment
 ```
 
 ### Custom Connections
 
-Set `EasyPost.default_connection` to an object that responds to `call(method, path, api_key = nil, body = nil)`
+Pass in a lambda function as `custom_client_exec` when initializing a client that responds to `call(method, uri, headers, open_timeout, read_timeout, body = nil)` where:
+
+- `uri` is the fully-qualified URL of the EasyPost endpoint, including query parameters (`Uri` object)
+- `method` is the lowercase name of the HTTP method being used for the request (e.g. `:get`, `:post`, `:put`, `:delete`)
+- `headers` is a hash with all headers needed for the request pre-populated, including authorization (`Hash` object)
+- `open_timeout` is the number of seconds to wait for the connection to open (integer)
+- `read_timeout` is the number of seconds to wait for one block to be read (integer)
+- `body` is a string of the body data to be included in the request, or nil (e.g. GET or DELETE request) (string or `nil`)
+
+The lambda function should return an object with `code` and `body` attributes, where:
+
+- `code` is the HTTP response status code (integer)
+- `body` is the response body (string)
 
 #### Faraday
 
 ```ruby
 require 'faraday'
-require 'faraday/response/logger'
-require 'logger'
-
-EasyPost.default_connection = lambda do |method, path, api_key = nil, body = nil|
-  Faraday
-    .new(url: EasyPost.api_base, headers: EasyPost.default_headers) { |builder|
-      builder.use Faraday::Response::Logger, Logger.new(STDOUT), {bodies: true, headers: true}
-      builder.adapter :net_http
-    }
-    .public_send(method, path) { |request|
-      request.headers['Authorization'] = EasyPost.authorization(api_key)
-      request.body = JSON.dump(EasyPost::Util.objects_to_ids(body)) if body
-    }.yield_self { |response|
-      EasyPost.parse_response(
-        status: response.status,
-        body: response.body,
-        json: response.headers['Content-Type'].start_with?('application/json'),
-      )
-    }
-end
+
+custom_connection = lambda { |method, uri, headers, _open_timeout, _read_timeout, body = nil|
+  conn = Faraday.new(url: uri.to_s, headers: headers) do |faraday|
+    faraday.adapter Faraday.default_adapter
+  end
+  conn.public_send(method, uri.path) { |request|
+    request.body = body if body
+  }.yield_self do |response|
+    OpenStruct.new(code: response.status, body: response.body)
+  end
+}
+
+my_client = described_class.new(
+  api_key: ENV['EASYPOST_API_KEY'],
+  custom_client_exec: custom_connection,
+)
 ```
 
 #### Typhoeus
@@ -92,25 +101,79 @@ end
 ```ruby
 require 'typhoeus'
 
-EasyPost.default_connection = lambda do |method, path, api_key = nil, body = nil|
+custom_connection = lambda { |method, uri, headers, _open_timeout, _read_timeout, body = nil|
   Typhoeus.public_send(
     method,
-    File.join(EasyPost.api_base, path),
-    headers: EasyPost.default_headers.merge('Authorization' => EasyPost.authorization(api_key)),
-    body: body.nil? ? nil : JSON.dump(EasyPost::Util.objects_to_ids(body)),
-  ).yield_self { |response|
-    EasyPost.parse_response(
-      status: response.code,
-      body: response.body,
-      json: response.headers['Content-Type'].start_with?('application/json'),
-    )
-  }
+    uri.to_s,
+    headers: headers,
+    body: body,
+  ).yield_self do |response|
+    OpenStruct.new(code: response.code, body: response.body)
+  end
+}
+
+my_client = described_class.new(
+  api_key: ENV['EASYPOST_API_KEY'],
+  custom_client_exec: custom_connection,
+)
+```
+
+### HTTP Hooks
+
+Users can audit HTTP requests and responses being made by the library by subscribing to request and response events. To do so, pass a block to the `subscribe_request_hook` and `subscribe_response_hook` methods of an instance of `EasyPost::Client`:
+
+```ruby
+require 'easypost'
+
+client = EasyPost::Client.new(api_key: ENV['EASYPOST_API_KEY'])
+
+# Returns a randomly-generated symbol which you can use to later unsubscribe the request hook
+client.subscribe_request_hook do |request_data|
+  # Your code goes here
+end
+# Returns a randomly-generated symbol which you can use to later unsubscribe the response hook
+client.subscribe_response_hook do |response_data|
+  # Your code goes here
 end
 ```
 
+You can also name your hook subscriptions by providing an optional parameter to the methods above:
+
+```ruby
+require 'easypost'
+
+client = EasyPost::Client.new(api_key: ENV['EASYPOST_API_KEY'])
+
+request_hook = client.subscribe_request_hook(:my_request_hook) do |request_data|
+  # Your code goes here
+end
+response_hook = client.subscribe_response_hook(:my_response_hook) do |response_data|
+  # Your code goes here
+end
+
+puts request_hook  # :my_request_hook
+puts response_hook # :my_response_hook
+```
+
+Keep in mind that subscribing a hook with the same name of an existing hook will replace the existing hook with the new one. A request hook and a response hook can share the same name.
+
+#### Custom HTTP Connections with HTTP Hooks
+
+If you're using a custom HTTP connection, keep in mind that the `response_data` parameter that a response hook receives *will not be hydrated* with all the response data. You will have to inspect the `client_response_object` property in `response_data` to inspect the response code, response headers and response body.
+
 ## Documentation
 
-API Documentation can be found at: <https://easypost.com/docs/api>.
+API documentation can be found at: <https://easypost.com/docs/api>.
+
+Library documentation can be found on the web at: <https://easypost.github.io/easypost-ruby/> or by building them locally via the `make docs` command.
+
+Upgrading major versions of this project? Refer to the [Upgrade Guide](UPGRADE_GUIDE.md).
+
+## Support
+
+New features and bug fixes are released on the latest major release of this library. If you are on an older major release of this library, we recommend upgrading to the most recent release to take advantage of new features, bug fixes, and security patches. Older versions of this library will continue to work and be available as long as the API version they are tied to remains active; however, they will not receive updates and are considered EOL.
+
+For additional support, see our [org-wide support policy](https://github.com/EasyPost/.github/blob/main/SUPPORT.md).
 
 ## Development
 
@@ -118,11 +181,12 @@ API Documentation can be found at: <https://easypost.com/docs/api>.
 # Install dependencies
 make install
 
+# Install style guide (Unix only)
+make install-style
+
 # Lint project
 make lint
-
-# Fix linting errors
-make fix
+make lint-fix
 
 # Run tests (coverage is generated on a successful test suite run)
 EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make test
@@ -130,14 +194,16 @@ EASYPOST_TEST_API_KEY=123... EASYPOST_PROD_API_KEY=123... make test
 # Run security analysis
 make scan
 
+# Generate library documentation
+make docs
+
 # Update submodules
-git submodule init
-git submodule update --remote
+make update-examples-submodule
 ```
 
 ### Testing
 
-The test suite in this project was specifically built to produce consistent results on every run, regardless of when they run or who is running them. This project uses [VCR](https://github.com/vcr/vcr) to record and replay HTTP requests and responses via "cassettes". When the suite is run, the HTTP requests and responses for each test function will be saved to a cassette if they do not exist already and replayed from this saved file if they do, which saves the need to make live API calls on every test run.
+The test suite in this project was specifically built to produce consistent results on every run, regardless of when they run or who is running them. This project uses [VCR](https://github.com/vcr/vcr) to record and replay HTTP requests and responses via "cassettes". When the suite is run, the HTTP requests and responses for each test function will be saved to a cassette if they do not exist already and replayed from this saved file if they do, which saves the need to make live API calls on every test run. If you receive errors about a cassette expiring, delete and re-record the cassette to ensure the data is up-to-date.
 
 **Sensitive Data:** We've made every attempt to include scrubbers for sensitive data when recording cassettes so that PII or sensitive info does not persist in version control; however, please ensure when recording or re-recording cassettes that prior to committing your changes, no PII or sensitive information gets persisted by inspecting the cassette.
 
@@ -155,5 +221,5 @@ The following are required on every test run:
 Some tests may require an EasyPost user with a particular set of enabled features such as a `Partner` user when creating referrals. We have attempted to call out these functions in their respective docstrings. The following are required when you need to re-record cassettes for applicable tests:
 
 - `USPS_CARRIER_ACCOUNT_ID` (eg: one-call buying a shipment for non-EasyPost employees)
-- `PARTNER_USER_PROD_API_KEY` (eg: creating a referral user)
-- `REFERRAL_USER_PROD_API_KEY` (eg: adding a credit card to a referral user)
+- `PARTNER_USER_PROD_API_KEY` (eg: creating a referral customer)
+- `REFERRAL_CUSTOMER_PROD_API_KEY` (eg: adding a credit card to a referral customer)

data/UPGRADE_GUIDE.md

@@ -2,8 +2,127 @@
 
 Use the following guide to assist in the upgrade process of the `easypost-ruby` library between major versions.
 
+- [Upgrading from 4.x to 5.0](#upgrading-from-4x-to-50)
+- [Upgrading from 3.x to 4.0](#upgrading-from-3x-to-40)
+
+## Upgrading from 4.x to 5.0
+
+### 5.0 High Impact Changes
+
+- [New Client object](#50-thread-safe-with-client-object)
+- [Updated Dependencies](#50-updated-dependencies)
+- [Improved Error Handling](#50-improved-error-handling)
+
+### 5.0 Medium Impact Changes
+
+- [Corrected Naming Conventions](#50-corrected-naming-conventions)
+
+### 5.0 Low Impact Changes
+
+- [Beta Namespace Changed](#50-beta-namespace-changed)
+
+## 5.0 Thread-Safe with Client Object
+
+Likelihood of Impact: High
+
+This library is now thread-safe with the introduction of a new `Client` object. Instead of defining a global API key that all requests use, you now create an `Client` object and pass your API key to it with optional open and read timeout params. You then call your desired functions against a `service` which are called against a `Client` object:
+
+```ruby
+# Old way
+EasyPost.api_key = ENV['EASYPOST_API_KEY']
+shipment = EasyPost::Shipment.retrieve('shp_...')
+
+# New way
+client = EasyPost::Client.new(api_key: ENV['EASYPOST_TEST_API_KEY'])
+shipment = client.shipment.retrieve('shp_...')
+```
+
+All instance methods are now static with the exception of `lowest_rate` as these make API calls and require the Client object(EasyPost objects do not contain an API key to make API calls with).
+
+Previously used `.save()` instance methods are now static `.update()` functions where you specify first the ID of the object you are updating and second, the parameters that need updating.
+
+## 5.0 Updated Dependencies
+
+Likelihood of Impact: High
+
+**Ruby 2.6 Required**
+
+easypost-ruby now requires Ruby 2.6 or greater.
+
+**Dependencies**
+
+All dependencies had minor version bumps.
+
+## 5.0 Improved Error Handling
+
+Likelihood of Impact: High
+
+There are ~2 dozen new error types that extend either `ApiError` or `EasyPostError`.
+
+New ApiErrors (extends EasyPostError):
+
+- `ApiError`
+- `ConnectionError`
+- `ExternalApiError`
+- `ForbiddenError`
+- `GatewayTimeoutError`
+- `InternalServerError`
+- `InvalidRequestError`
+- `MethodNotAllowedError`
+- `NotFoundError`
+- `PaymentError`
+- `ProxyError`
+- `RateLimitError`
+- `RedirectError`
+- `RetryError`
+- `ServiceUnavailableError`
+- `SSLError`
+- `TimeoutError`
+- `UnauthorizedError`
+- `UnknownApiError`
+
+New EasyPostErrors (extends builtin Exception):
+
+- `EasyPostError`
+- `EndOfPaginationError`
+- `FilteringError`
+- `InvalidObjectError`
+- `InvalidParameterError`
+- `MissingParameterError`
+- `SignatureVerificationError`
+
+ApiErrors will behave like the previous Error class did. They will include a `message`, `http_status`, and `http_body`. Additionally, a new `code` and `errors` keys are present and populate when available. This class extends the more generic `EasyPostError` which only contains a message, used for errors thrown directly from this library.
+
+## 5.0 Corrected Naming Conventions
+
+Likelihood of Impact: Medium
+
+Occurances of `referral` are now `referral_customer` and `Referral` are now `ReferralCustomer` to match the documentation and API.
+
+Occurances of `smartrate` are now `smart_rate` and `Smartrate` are now `SmartRate` to match the documentation and API.
+
+Occurances of `scanform` are now `scan_form` and `Scanform` are now `ScanForm` to match the documentation and API.
+
+Rename function `get_smartrates` to `get_smart_rates`
+
+Rename function `get_lowest_smartrate` to `get_lowest_smart_rate`
+
+## 5.0 Beta Namespace Changed
+
+Likelihood of Impact: Low
+
+Previously, the beta namespace was found at `easypost.beta.x` where `x` is the name of your model. Now, the beta namespace is simply prepended to the name of your service: `client.beta_x`. for instance, you can call `client.beta_referral_customer.add_payment_method()`.
+
+## 5.0 Return True For Empty API Response
+
+Likelihood of Impact: Low
+
+Empty API response functions for `delete` return `true` instead of empty object
+
 ## Upgrading from 3.x to 4.0
 
+**NOTICE:** v4 is deprecated.
+
 ### 4.0 High Impact Changes
 
 * [Updating Dependencies](#40-updating-dependencies)

data/VERSION

@@ -1 +1 @@
-4.8.1
+5.1.0