feat: Add functions to retrieve event payload(s) (#239)

- New functions to retrieve all payloads or a specific payload for a specific event
- New unit tests, cassettes
- New Payload class, JSON deserialization mapping

Author: nwithan8

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## [Unreleased]
+
+- 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`

lib/easypost.rb

@@ -26,6 +26,7 @@
 require 'easypost/insurance'
 require 'easypost/order'
 require 'easypost/parcel'
+require 'easypost/payload'
 require 'easypost/payment_method' # deprecated
 require 'easypost/pickup_rate'
 require 'easypost/pickup'

lib/easypost/event.rb

@@ -8,4 +8,16 @@ class EasyPost::Event < EasyPost::Resource
   def self.receive(values)
     EasyPost::Util.convert_to_easypost_object(JSON.parse(values), nil)
   end
+
+  # Retrieve all payloads for an event.
+  def retrieve_all_payloads(api_key = nil)
+    response = EasyPost.make_request(:get, "#{url}/payloads", api_key)
+    EasyPost::Util.convert_to_easypost_object(response, api_key)
+  end
+
+  # Retrieve a specific payload for an event.
+  def retrieve_payload(payload_id, api_key = nil)
+    response = EasyPost.make_request(:get, "#{url}/payloads/#{payload_id}", api_key)
+    EasyPost::Util.convert_to_easypost_object(response, api_key)
+  end
 end

lib/easypost/payload.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Webhook Event Payloads are triggered by changes in objects you've created via the API.
+class EasyPost::Payload < EasyPost::Resource
+end

lib/easypost/util.rb

@@ -19,6 +19,7 @@ module EasyPost::Util
     'hook' => EasyPost::Webhook,
     'ins' => EasyPost::Insurance,
     'order' => EasyPost::Order,
+    'payload' => EasyPost::Payload,
     'pickup' => EasyPost::Pickup,
     'pickuprate' => EasyPost::PickupRate,
     'pl' => EasyPost::PostageLabel,