easypost 4.8.1 → 4.10.0

data/easypost.gemspec

@@ -23,10 +23,12 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'brakeman', '~> 5.2'
   spec.add_development_dependency 'pry', '~> 0.14'
+  spec.add_development_dependency 'psych', '~> 4.0' # TODO: pinned because rdoc has an optimistic pin of this dep and 5.0 breaks on CI
   spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rdoc', '~> 6.4'
   spec.add_development_dependency 'rspec', '~> 3.10'
   spec.add_development_dependency 'rubocop', '= 1.27' # rubocop 1.28 requires Ruby 2.6+
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.7'
+  spec.add_development_dependency 'rubocop-rspec', '= 2.10' # rubocop-rspec 2.11 requires Ruby 2.6+
   spec.add_development_dependency 'simplecov', '~> 0.21'
   spec.add_development_dependency 'simplecov-lcov', '~> 0.8'
   spec.add_development_dependency 'vcr', '= 6.0' # VCR 6.1 requires Ruby 2.6+

data/lib/easypost/beta/payment_refund.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# PaymentRefund objects represent a refund of a payment.
+class EasyPost::Beta::PaymentRefund < EasyPost::Resource
+end

data/lib/easypost/beta/referral.rb

@@ -55,7 +55,7 @@ class EasyPost::Beta::Referral < EasyPost::Resource
     end
   end
 
-  # Create a referral user. This function requires the Partner User's API key.
+  # Create a referral customer. This function requires the Partner User's API key.
   # <b>DEPRECATED:</b> Please use <tt>Referral</tt> in the main namespace instead.
   def self.create(params = {}, api_key = nil)
     warn '[DEPRECATION] Please use `Referral.create` in the main namespace instead.'
@@ -63,7 +63,7 @@ class EasyPost::Beta::Referral < EasyPost::Resource
     EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
 
-  # Update a referral user. This function requires the Partner User's API key.
+  # Update a referral customer. This function requires the Partner User's API key.
   # <b>DEPRECATED:</b> Please use <tt>Referral</tt> in the main namespace instead.
   def self.update_email(email, user_id, api_key = nil)
     warn '[DEPRECATION] Please use `Referral.update_email` in the main namespace instead.'
@@ -78,7 +78,7 @@ class EasyPost::Beta::Referral < EasyPost::Resource
     true
   end
 
-  # Retrieve a list of referral users. This function requires the Partner User's API key.
+  # Retrieve a list of referral customers. This function requires the Partner User's API key.
   # <b>DEPRECATED:</b> Please use <tt>Referral</tt> in the main namespace instead.
   def self.all(params = {}, api_key = nil)
     warn '[DEPRECATION] Please use `Referral.all` in the main namespace instead.'
@@ -86,7 +86,7 @@ class EasyPost::Beta::Referral < EasyPost::Resource
     EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
 
-  # Add credit card to a referral user. This function requires the Referral User's API key.
+  # Add credit card to a referral customer. This function requires the Referral Customer's API key.
   # <b>DEPRECATED:</b> Please use <tt>Referral</tt> in the main namespace instead.
   def self.add_credit_card(referral_api_key, number, expiration_month, expiration_year, cvc, priority = 'primary')
     warn '[DEPRECATION] Please use `Referral.add_credit_card` in the main namespace instead.'
@@ -107,4 +107,52 @@ class EasyPost::Beta::Referral < EasyPost::Resource
     response = create_easypost_credit_card(referral_api_key, stripe_credit_card_token, priority)
     EasyPost::Util.convert_to_easypost_object(response, referral_api_key)
   end
+
+  # Add a Stripe payment method to a Referral Customer. This function requires the Referral Customer's API key.
+  # @param [String] stripe_customer_id Unique customer ID provided by Stripe.
+  # @param [String] payment_method_reference ID of the card or bank account provided by Stripe.
+  # @param [String] payment_method_type Which priority to save this payment method as on EasyPost, either 'primary' or 'secondary'.
+  # @param [String] api_key Override the API key used for this request.
+  # @return [EasyPost::PaymentMethod] The newly-added payment method.
+  # noinspection RubyParameterNamingConvention
+  def self.add_payment_method(stripe_customer_id, payment_method_reference, priority = 'primary', api_key = nil)
+    wrapped_params = {
+      payment_method: {
+        stripe_customer_id: stripe_customer_id,
+        payment_method_reference: payment_method_reference,
+        priority: priority.downcase,
+      },
+    }
+    response = EasyPost.make_request(:post, '/beta/referral_customers/payment_method', api_key, wrapped_params)
+    # noinspection RubyMismatchedReturnType
+    EasyPost::Util.convert_to_easypost_object(response, api_key)
+  end
+
+  # Refund a Referral Customer's wallet by a specified amount. Refund will be issued to the user's original payment method.
+  # This function requires the Referral Customer's API key.
+  # @param [Integer] amount The amount to refund, in cents.
+  # @param [String] api_key Override the API key used for this request.
+  # @return [EasyPost::Beta::PaymentRefund] The newly-created refund.
+  def self.refund_by_amount(amount, api_key = nil)
+    params = {
+      refund_amount: amount,
+    }
+    response = EasyPost.make_request(:post, '/beta/referral_customers/refunds', api_key, params)
+    # noinspection RubyMismatchedReturnType
+    EasyPost::Util.convert_to_easypost_object(response, api_key) # TODO: Needs "object" or ID prefix to determine object class.
+  end
+
+  # Refund a Referral Customer's wallet for a specified payment log entry. Refund will be issued to the user's original payment method.
+  # This function requires the Referral Customer's API key.
+  # @param [String] payment_log_id Payment log ID to refund.
+  # @param [String] api_key Override the API key used for this request.
+  # @return [EasyPost::Beta::PaymentRefund] The newly-created refund.
+  def self.refund_by_payment_log(payment_log_id, api_key = nil)
+    params = {
+      payment_log_id: payment_log_id,
+    }
+    response = EasyPost.make_request(:post, '/beta/referral_customers/refunds', api_key, params)
+    # noinspection RubyMismatchedReturnType
+    EasyPost::Util.convert_to_easypost_object(response, api_key) # TODO: Needs "object" or ID prefix to determine object class.
+  end
 end

data/lib/easypost/carrier_account.rb

@@ -2,8 +2,25 @@
 
 # A CarrierAccount encapsulates your credentials with the carrier.
 class EasyPost::CarrierAccount < EasyPost::Resource
+  CUSTOM_WORKFLOW_CARRIER_TYPES = %w[UpsAccount FedexAccount].freeze
+
   # Retrieve a list of available CarrierAccount types for the authenticated User.
   def self.types
     EasyPost::CarrierType.all
   end
+
+  def self.create(params = {}, api_key = nil)
+    wrapped_params = {}
+    wrapped_params[class_name.to_sym] = params
+
+    # For Ups and Fedex the endpoint is different
+    create_url = if CUSTOM_WORKFLOW_CARRIER_TYPES.include?(params[:type])
+                   "#{url}/register"
+                 else
+                   url
+                 end
+
+    response = EasyPost.make_request(:post, create_url, api_key, wrapped_params)
+    EasyPost::Util.convert_to_easypost_object(response, api_key)
+  end
 end

data/lib/easypost/payment_method.rb

@@ -2,7 +2,8 @@
 
 # PaymentMethod objects represent a payment method of a user.
 class EasyPost::PaymentMethod < EasyPost::Resource
-  # <b>DEPRECATED:</b> Please use <tt>Billing class</tt> instead.
+  # List all payment methods associated with the current user.
+  # <b>DEPRECATED:</b> Please use <tt>Billing.retrieve_payment_methods</tt> instead.
   # Deprecated: v4.5.0 - v6.0.0
   def self.all(_filters = {}, api_key = nil)
     warn '[DEPRECATION] `all` is deprecated.  Please use `Billing.retrieve_payment_methods` instead.'

data/lib/easypost/referral.rb

@@ -55,13 +55,13 @@ class EasyPost::Referral < EasyPost::Resource
     end
   end
 
-  # Create a referral user. This function requires the Partner User's API key.
+  # Create a referral customer. This function requires the Partner User's API key.
   def self.create(params = {}, api_key = nil)
     response = EasyPost.make_request(:post, '/v2/referral_customers', api_key, { user: params })
     EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
 
-  # Update a referral user. This function requires the Partner User's API key.
+  # Update a referral customer. This function requires the Partner User's API key.
   def self.update_email(email, user_id, api_key = nil)
     wrapped_params = {
       user: {
@@ -74,13 +74,13 @@ class EasyPost::Referral < EasyPost::Resource
     true
   end
 
-  # Retrieve a list of referral users. This function requires the Partner User's API key.
+  # Retrieve a list of referral customers. This function requires the Partner User's API key.
   def self.all(params = {}, api_key = nil)
     response = EasyPost.make_request(:get, '/v2/referral_customers', api_key, params)
     EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
 
-  # Add credit card to a referral user. This function requires the Referral User's API key.
+  # Add credit card to a referral customer. This function requires the Referral Customer's API key.
   def self.add_credit_card(referral_api_key, number, expiration_month, expiration_year, cvc, priority = 'primary')
     easypost_stripe_api_key = retrieve_easypost_stripe_api_key
 

data/lib/easypost/shipment.rb

@@ -75,7 +75,7 @@ class EasyPost::Shipment < EasyPost::Resource
 
   # Refund a Shipment.
   def refund(params = {})
-    response = EasyPost.make_request(:get, "#{url}/refund", @api_key, params)
+    response = EasyPost.make_request(:post, "#{url}/refund", @api_key, params)
     refresh_from(response, @api_key)
 
     self

data/lib/easypost/user.rb

@@ -33,18 +33,21 @@ class EasyPost::User < EasyPost::Resource
     all
   end
 
-  # Retrieve a list of ApiKey objects.
+  # Retrieve a list of all ApiKey objects.
   def self.all_api_keys
     EasyPost::ApiKey.all
   end
 
-  # Retrieve a list of ApiKey objects of a child User.
+  # Retrieve a list of ApiKey objects (works for the authenticated user or a child user).
   def api_keys
     api_keys = EasyPost::User.all_api_keys
 
     if api_keys.id == id
+      # This function was called on the authenticated user
       my_api_keys = api_keys.keys
     else
+      # This function was called on a child user (authenticated as parent, only return this child user's details).
+      my_api_keys = []
       api_keys.children.each do |child|
         if child.id == id
           my_api_keys = child.keys

data/lib/easypost/util.rb

@@ -5,10 +5,13 @@ module EasyPost::Util
   attr_accessor :os_name, :os_version, :os_arch
 
   BY_PREFIX = {
+    'ak' => EasyPost::ApiKey,
     'adr' => EasyPost::Address,
+    'bank' => EasyPost::PaymentMethod,
     'batch' => EasyPost::Batch,
     'brd' => EasyPost::Brand,
     'ca' => EasyPost::CarrierAccount,
+    'card' => EasyPost::PaymentMethod,
     'cstinfo' => EasyPost::CustomsInfo,
     'cstitem' => EasyPost::CustomsItem,
     'es' => EasyPost::EndShipper,
@@ -35,10 +38,13 @@ module EasyPost::Util
 
   BY_TYPE = {
     'Address' => EasyPost::Address,
+    'ApiKey' => EasyPost::ApiKey,
+    'BankAccount' => EasyPost::PaymentMethod,
     'Batch' => EasyPost::Batch,
     'Brand' => EasyPost::Brand,
     'CarbonOffset' => EasyPost::CarbonOffset,
     'CarrierAccount' => EasyPost::CarrierAccount,
+    'CreditCard' => EasyPost::PaymentMethod,
     'CustomsInfo' => EasyPost::CustomsInfo,
     'CustomsItem' => EasyPost::CustomsItem,
     'EndShipper' => EasyPost::EndShipper,
@@ -144,25 +150,28 @@ module EasyPost::Util
     when Array
       response.map { |i| convert_to_easypost_object(i, api_key, parent) }
     when Hash
-      if (cls_name = response[:object])
+      # Determine class based on the "object" key in the JSON response
+      cls_name = response[:object] || response['object']
+      if cls_name
+        # Use the "object" key value to look up the class
         cls = BY_TYPE[cls_name]
-      elsif response[:id]
-        if response[:id].index('_').nil?
-          cls = EasyPost::EasyPostObject
-        elsif (cls_prefix = response[:id][0..response[:id].index('_')])
-          cls = BY_PREFIX[cls_prefix[0..-2]]
-        end
-      elsif response['id']
-        if response['id'].index('_').nil?
+      else
+        # Fallback to determining class based on the "id" prefix in the JSON response
+        id = response[:id] || response['id']
+        if id.nil? || id.index('_').nil?
+          # ID not present or prefix not present (ID malformed)
           cls = EasyPost::EasyPostObject
-        elsif (cls_prefix = response['id'][0..response['id'].index('_')])
-          cls = BY_PREFIX[cls_prefix[0..-2]]
+        else
+          # Parse the prefix from the ID and use it to look up the class
+          cls_prefix = id[0..id.index('_')][0..-2]
+          cls = BY_PREFIX[cls_prefix]
         end
       end
-
+      # Fallback to using the generic class if other determination methods fail (or class lookup produced no results)
       cls ||= EasyPost::EasyPostObject
       cls.construct_from(response, api_key, parent, name)
     else
+      # response is neither a Hash nor Array (used mostly when dealing with final values like strings, booleans, etc.)
       response
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 4.8.1
+  version: 4.10.0
 platform: ruby
 authors:
 - EasyPost Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2023-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brakeman
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +112,16 @@ dependencies:
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -167,18 +195,95 @@ files:
 - ".gitmodules"
 - ".rubocop.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - Makefile
 - README.md
 - Rakefile
-- SECURITY.md
-- SUPPORT.md
 - UPGRADE_GUIDE.md
 - VERSION
 - bin/easypost-irb
+- docs/EasyPost.html
+- docs/EasyPost/Address.html
+- docs/EasyPost/ApiKey.html
+- docs/EasyPost/Batch.html
+- docs/EasyPost/Beta.html
+- docs/EasyPost/Beta/EndShipper.html
+- docs/EasyPost/Beta/Referral.html
+- docs/EasyPost/Billing.html
+- docs/EasyPost/Brand.html
+- docs/EasyPost/CarbonOffset.html
+- docs/EasyPost/CarrierAccount.html
+- docs/EasyPost/CarrierType.html
+- docs/EasyPost/CustomsInfo.html
+- docs/EasyPost/CustomsItem.html
+- docs/EasyPost/EasyPostObject.html
+- docs/EasyPost/EndShipper.html
+- docs/EasyPost/Error.html
+- docs/EasyPost/Event.html
+- docs/EasyPost/Insurance.html
+- docs/EasyPost/Order.html
+- docs/EasyPost/Parcel.html
+- docs/EasyPost/PaymentMethod.html
+- docs/EasyPost/Pickup.html
+- docs/EasyPost/PickupRate.html
+- docs/EasyPost/PostageLabel.html
+- docs/EasyPost/Rate.html
+- docs/EasyPost/Referral.html
+- docs/EasyPost/Refund.html
+- docs/EasyPost/Report.html
+- docs/EasyPost/Resource.html
+- docs/EasyPost/ScanForm.html
+- docs/EasyPost/Shipment.html
+- docs/EasyPost/TaxIdentifier.html
+- docs/EasyPost/Tracker.html
+- docs/EasyPost/User.html
+- docs/EasyPost/Util.html
+- docs/EasyPost/Webhook.html
+- docs/created.rid
+- docs/css/fonts.css
+- docs/css/rdoc.css
+- docs/fonts/Lato-Light.ttf
+- docs/fonts/Lato-LightItalic.ttf
+- docs/fonts/Lato-Regular.ttf
+- docs/fonts/Lato-RegularItalic.ttf
+- docs/fonts/SourceCodePro-Bold.ttf
+- docs/fonts/SourceCodePro-Regular.ttf
+- docs/images/add.png
+- docs/images/arrow_up.png
+- docs/images/brick.png
+- docs/images/brick_link.png
+- docs/images/bug.png
+- docs/images/bullet_black.png
+- docs/images/bullet_toggle_minus.png
+- docs/images/bullet_toggle_plus.png
+- docs/images/date.png
+- docs/images/delete.png
+- docs/images/find.png
+- docs/images/loadingAnimation.gif
+- docs/images/macFFBgHack.png
+- docs/images/package.png
+- docs/images/page_green.png
+- docs/images/page_white_text.png
+- docs/images/page_white_width.png
+- docs/images/plugin.png
+- docs/images/ruby.png
+- docs/images/tag_blue.png
+- docs/images/tag_green.png
+- docs/images/transparent.png
+- docs/images/wrench.png
+- docs/images/wrench_orange.png
+- docs/images/zoom.png
+- docs/index.html
+- docs/js/darkfish.js
+- docs/js/navigation.js
+- docs/js/navigation.js.gz
+- docs/js/search.js
+- docs/js/search_index.js
+- docs/js/search_index.js.gz
+- docs/js/searcher.js
+- docs/js/searcher.js.gz
+- docs/table_of_contents.html
 - easycop.yml
 - easypost.gemspec
 - lib/easypost.rb
@@ -187,6 +292,7 @@ files:
 - lib/easypost/batch.rb
 - lib/easypost/beta.rb
 - lib/easypost/beta/end_shipper.rb
+- lib/easypost/beta/payment_refund.rb
 - lib/easypost/beta/referral.rb
 - lib/easypost/billing.rb
 - lib/easypost/brand.rb
@@ -239,7 +345,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: EasyPost Ruby Client Library

data/CODE_OF_CONDUCT.md

@@ -1,16 +0,0 @@
-# Code of Conduct
-
-> Remember the golden rule? Treat others as you'd like to be treated
-
-## Standards
-
-- Create a welcoming and safe community for `everyone`
-- Demonstrate empathy towards others, realize that everyone has a different `level of experience`
-- Be respectful of others opinions, viewpoints, and experiences
-- Give and receive respectful constructive feedback
-- Accept responsibility and apologize when necessary
-- Focus on what is best for the overall community
-
-## Failure to Follow Standards
-
-If there is a failure to follow the standards laid out above, the user will first be warned. If the offending behavior continues, the user may be blocked entirely.

data/CONTRIBUTING.md

@@ -1,47 +0,0 @@
-# Contributing Guide
-
-Please read this document in its entirety.
-
-## General
-
-- Be nice and respectful of maintainers’ and contributors’ time and viewpoints
-- Be as descriptive as possible! More info is always better than not enough
-- Be patient, there may be a lot of in-flight work, some of it across multiple projects not related to the repo being contributed to
-- Have fun!
-
-## Contributing
-
-Contributing comes in many forms! We are incredibly grateful to anyone who can do any of the following:
-
-- Add new features
-- Fix bugs
-- Fix typos
-- Improve docs
-- Improve tests
-- Triage issues
-- Review pull requests
-- Share opinions and viewpoints on issues
-
-## Issues
-
-- If your issue is security related, please follow the [SECURITY guide](https://github.com/easypost/.github/SECURITY.md)
-- Before opening a new issue, check for existing issues that are related, including closed ones
-- Provide as much information as possible about the issue, including how to reproduce the problem and the expected behavior
-- Don't needlessly bump issues (eg: if there hasn’t been progress for more than a few weeks, feel free to reach back out)
-
-## Pull Requests
-
-- All Pull Requests should be accompanied first by an issue describing the reason why the Pull Request is needed
-- Be as descriptive as possible in your PR description about why the changes are being made and what the changes contain
-- Pull Requests should be as small as possible
-- Don't make unrelated changes in your Pull Request
-- Don't open a Pull Request if you don't plan to see it through. PRs submitted by individuals that cannot complete additional work to get a PR merged may be closed without completion
-- Adhere to the existing code style of the repo, even if it differs from your personal preference
-- When applicable, add tests that provide ample coverage of the logic added or changed
-- Pull Requests should come from branches and never the default `master` branch
-- Pull Requests must pass CI, including linting and testing
-- Pull Requests must go through code review before they can be merged to the main branch
-- Do not include "version bump" changes in the same PR as your code changes; these will be handled as a separate PR and releasing process
-- Make sure the `Allow edits from maintainers` checkbox is checked. That way EasyPost engineers can make certain minor changes as needed, allowing your pull request to be merged sooner.
-
-You agree and acknowledge that you have necessary intellectual property rights to provide your Contribution and hereby assign to EasyPost all right, title and interest in such Contribution.

data/SECURITY.md

@@ -1,7 +0,0 @@
-# Security Guide
-
-We take security seriously at EasyPost. If you find a security issue or vulnerability in our open source projects, please abide by the following guidelines:
-
-- Please read our [Responsible Disclosure Policy](https://www.easypost.com/privacy#disclosure-policy).
-- Do not open an issue on GitHub about the security vulnerability. Doing so draws attention to the issue and exposes it to the public.
-- Send an email to `security-abuse@easypost.com` including as many details as possible.

data/SUPPORT.md

@@ -1,3 +0,0 @@
-# Support Guide
-
-Looking for support for one of our projects? If your question is related to our API, please contact our support team at `support@easypost.com`. If you need support regarding this project, create an issue on GitHub with as many details as possible and we’ll take a look.