easypost 4.8.1 → 5.1.0

data/lib/easypost/services/batch.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::Batch < EasyPost::Services::Service
+  MODEL_CLASS = EasyPost::Models::Batch
+
+  # Create a Batch.
+  def create(params = {})
+    wrapped_params = { batch: params }
+
+    @client.make_request(:post, 'batches', MODEL_CLASS, wrapped_params)
+  end
+
+  # Create and buy a batch in one call.
+  def create_and_buy(params = {})
+    wrapped_params = { batch: params }
+
+    @client.make_request(:post, 'batches/create_and_buy', MODEL_CLASS, wrapped_params)
+  end
+
+  def all(params = {})
+    @client.make_request(:get, 'batches', EasyPost::Models::ApiKey, params)
+  end
+
+  # Retrieve a Batch
+  def retrieve(id)
+    @client.make_request(:get, "batches/#{id}", MODEL_CLASS)
+  end
+
+  # Buy a Batch.
+  def buy(id, params = {})
+    @client.make_request(:post, "batches/#{id}/buy", MODEL_CLASS, params)
+  end
+
+  # Convert the label format of a Batch.
+  def label(id, params = {})
+    @client.make_request(:post, "batches/#{id}/label", MODEL_CLASS, params)
+  end
+
+  # Remove Shipments from a Batch.
+  def remove_shipments(id, params = {})
+    @client.make_request(:post, "batches/#{id}/remove_shipments", MODEL_CLASS, params)
+  end
+
+  # Add Shipments to a Batch.
+  def add_shipments(id, params = {})
+    @client.make_request(:post, "batches/#{id}/add_shipments", MODEL_CLASS, params)
+  end
+
+  # Create a ScanForm for a Batch.
+  def create_scan_form(id, params = {})
+    @client.make_request(:post, "batches/#{id}/scan_form", MODEL_CLASS, params)
+  end
+end

data/lib/easypost/services/beta_rate.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::BetaRate < EasyPost::Services::Service
+  # Retrieve a list of stateless rates.
+  def retrieve_stateless_rates(params = {})
+    wrapped_params = {
+      shipment: params,
+    }
+
+    @client.make_request(:post, 'rates', EasyPost::Models::Rate, wrapped_params, 'beta').rates
+  end
+end

data/lib/easypost/services/beta_referral_customer.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::BetaReferralCustomer < EasyPost::Services::Service
+  # Add a Stripe payment method to a ReferralCustomer Customer. This function requires the ReferralCustomer Customer's API key.
+  def add_payment_method(stripe_customer_id, payment_method_reference, priority = 'primary')
+    wrapped_params = {
+      payment_method: {
+        stripe_customer_id: stripe_customer_id,
+        payment_method_reference: payment_method_reference,
+        priority: priority.downcase,
+      },
+    }
+    @client.make_request(
+      :post,
+      'referral_customers/payment_method',
+      EasyPost::Models::EasyPostObject,
+      wrapped_params,
+      'beta',
+    )
+  end
+
+  # Refund a ReferralCustomer Customer's wallet by a specified amount. Refund will be issued to the user's original payment method.
+  # This function requires the ReferralCustomer Customer's API key.
+  def refund_by_amount(amount)
+    params = {
+      refund_amount: amount,
+    }
+    @client.make_request(:post, 'referral_customers/refunds', EasyPost::Models::EasyPostObject, params, 'beta')
+    # noinspection RubyMismatchedReturnType
+  end
+
+  # Refund a ReferralCustomer Customer's wallet for a specified payment log entry. Refund will be issued to the user's original payment method.
+  # This function requires the ReferralCustomer Customer's API key.
+  def refund_by_payment_log(payment_log_id)
+    params = {
+      payment_log_id: payment_log_id,
+    }
+    @client.make_request(:post, 'referral_customers/refunds', EasyPost::Models::EasyPostObject, params, 'beta')
+  end
+end

data/lib/easypost/services/billing.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'easypost/constants'
+
+class EasyPost::Services::Billing < EasyPost::Services::Service
+  # Get payment method info (type of the payment method and ID of the payment method)
+  def self.get_payment_method_info(priority)
+    payment_methods = EasyPost::Services::Billing.retrieve_payment_methods
+    payment_method_map = {
+      'primary' => 'primary_payment_method',
+      'secondary' => 'secondary_payment_method',
+    }
+
+    payment_method_to_use = payment_method_map[priority]
+
+    error_string = EasyPost::Constants::INVALID_PAYMENT_METHOD
+    suggestion = "Please use a valid payment method: #{payment_method_map.keys.join(', ')}"
+    if payment_methods[payment_method_to_use].nil?
+      raise EasyPost::Errors::InvalidParameterError.new(
+        error_string,
+        suggestion,
+      )
+    end
+
+    payment_method_id = payment_methods[payment_method_to_use]['id']
+
+    unless payment_method_id.nil?
+      if payment_method_id.start_with?('card_')
+        endpoint = '/v2/credit_cards'
+      elsif payment_method_id.start_with?('bank_')
+        endpoint = '/v2/bank_accounts'
+      else
+        raise EasyPost::Errors::InvalidObjectError.new(error_string)
+      end
+    end
+
+    [endpoint, payment_method_id]
+  end
+
+  # Fund your EasyPost wallet by charging your primary or secondary card on file.
+  def fund_wallet(amount, priority = 'primary')
+    payment_info = EasyPost::Services::Billing.get_payment_method_info(priority.downcase)
+    endpoint = payment_info[0]
+    payment_id = payment_info[1]
+
+    wrapped_params = { amount: amount }
+    @client.make_request(:post, "#{endpoint}/#{payment_id}/charges", EasyPost::Models::EasyPostObject, wrapped_params)
+
+    # Return true if succeeds, an error will be thrown if it fails
+    true
+  end
+
+  # Delete a payment method.
+  def delete_payment_method(priority)
+    payment_info = EasyPost::Services::Billing.get_payment_method_info(priority.downcase)
+    endpoint = payment_info[0]
+    payment_id = payment_info[1]
+
+    @client.make_request(:delete, "#{endpoint}/#{payment_id}")
+
+    # Return true if succeeds, an error will be thrown if it fails
+    true
+  end
+
+  # Retrieve all payment methods.
+  def retrieve_payment_methods
+    response = @client.make_request(:get, '/v2/payment_methods')
+
+    if response['id'].nil?
+      raise EasyPost::Errors::InvalidObjectError.new(EasyPost::Constants::NO_PAYMENT_METHODS)
+    end
+
+    response
+  end
+end

data/lib/easypost/services/carrier_account.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::CarrierAccount < EasyPost::Services::Service
+  CUSTOM_WORKFLOW_CARRIER_TYPES = %w[UpsAccount FedexAccount].freeze
+  MODEL_CLASS = EasyPost::Models::CarrierAccount
+
+  # Create a carrier account
+  def create(params = {})
+    wrapped_params = { carrier_account: params }
+
+    # For UPS and FedEx the endpoint is different
+    create_url = if CUSTOM_WORKFLOW_CARRIER_TYPES.include?(params[:type])
+                   'carrier_accounts/register'
+                 else
+                   'carrier_accounts'
+                 end
+
+    @client.make_request(:post, create_url, MODEL_CLASS, wrapped_params)
+  end
+
+  # Retrieve a carrier account
+  def retrieve(id)
+    @client.make_request(:get, "carrier_accounts/#{id}", MODEL_CLASS)
+  end
+
+  # Retrieve all carrier accounts
+  def all(params = {})
+    @client.make_request(:get, 'carrier_accounts', MODEL_CLASS, params)
+  end
+
+  # Update a carrier account
+  def update(id, params = {})
+    wrapped_params = { carrier_account: params }
+    @client.make_request(:put, "carrier_accounts/#{id}", MODEL_CLASS, wrapped_params)
+  end
+
+  # Delete a carrier account
+  def delete(id)
+    @client.make_request(:delete, "carrier_accounts/#{id}")
+
+    # Return true if succeeds, an error will be thrown if it fails
+    true
+  end
+end

data/lib/easypost/services/carrier_metadata.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::CarrierMetadata < EasyPost::Services::Service
+  # Retrieve metadata for carrier(s).
+  def retrieve(carriers = [], types = [])
+    path = '/metadata/carriers?'
+
+    params = {}
+
+    if carriers.length.positive?
+      params[:carriers] = carriers.join(',')
+    end
+
+    if types.length.positive?
+      params[:types] = types.join(',')
+    end
+
+    path += URI.encode_www_form(params)
+
+    @client.make_request(:get, path, EasyPost::Models::EasyPostObject, params).carriers
+  end
+end

data/lib/easypost/services/customs_info.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::CustomsInfo < EasyPost::Services::Service
+  MODEL_CLASS = EasyPost::Models::CustomsInfo
+
+  # Create a CustomsInfo object
+  def create(params)
+    wrapped_params = { customs_info: params }
+
+    @client.make_request(:post, 'customs_infos', MODEL_CLASS, wrapped_params)
+  end
+
+  # Retrieve a CustomsInfo object
+  def retrieve(id)
+    @client.make_request(:get, "customs_infos/#{id}", MODEL_CLASS)
+  end
+end

data/lib/easypost/services/customs_item.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::CustomsItem < EasyPost::Services::Service
+  MODEL_CLASS = EasyPost::Models::CustomsItem
+
+  # Create a CustomsItem object
+  def create(params)
+    @client.make_request(:post, 'customs_items', MODEL_CLASS, params)
+  end
+
+  # Retrieve a CustomsItem object
+  def retrieve(id)
+    @client.make_request(:get, "customs_items/#{id}", MODEL_CLASS)
+  end
+end

data/lib/easypost/services/end_shipper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::EndShipper < EasyPost::Services::Service
+  MODEL_CLASS = EasyPost::Models::EndShipper
+
+  # Create an EndShipper object.
+  def create(params = {})
+    wrapped_params = { address: params }
+
+    @client.make_request(:post, 'end_shippers', MODEL_CLASS, wrapped_params)
+  end
+
+  # Retrieve an EndShipper object.
+  def retrieve(id)
+    @client.make_request(:get, "end_shippers/#{id}", MODEL_CLASS)
+  end
+
+  # Retrieve all EndShipper objects.
+  def all(params = {})
+    @client.make_request(:get, 'end_shippers', MODEL_CLASS, params)
+  end
+
+  # Updates an EndShipper object. This requires all parameters to be set.
+  def update(id, params)
+    wrapped_params = { address: params }
+
+    @client.make_request(:put, "end_shippers/#{id}", MODEL_CLASS, wrapped_params)
+  end
+
+  # TODO: Add support for getting the next page of end shippers when the API supports it.
+end

data/lib/easypost/services/event.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'json'
+
+class EasyPost::Services::Event < EasyPost::Services::Service
+  MODEL_CLASS = EasyPost::Models::Event
+
+  # Retrieve an Event object
+  def retrieve(id)
+    @client.make_request(:get, "events/#{id}", MODEL_CLASS)
+  end
+
+  # Retrieve all Event objects
+  def all(params = {})
+    @client.make_request(:get, 'events', MODEL_CLASS, params)
+  end
+
+  # Retrieve all payloads for an event.
+  def retrieve_all_payloads(event_id)
+    @client.make_request(:get, "events/#{event_id}/payloads", EasyPost::Models::Payload)
+  end
+
+  # Retrieve a specific payload for an event.
+  def retrieve_payload(event_id, payload_id)
+    @client.make_request(:get, "events/#{event_id}/payloads/#{payload_id}", EasyPost::Models::Payload)
+  end
+
+  # Get the next page of events.
+  def get_next_page(collection, page_size = nil)
+    get_next_page_helper(collection, collection.events, 'events', MODEL_CLASS, page_size)
+  end
+end

data/lib/easypost/services/insurance.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::Insurance < EasyPost::Services::Service
+  MODEL_CLASS = EasyPost::Models::Insurance
+
+  # Create an Insurance object
+  def create(params = {})
+    wrapped_params = { insurance: params }
+    @client.make_request(:post, 'insurances', MODEL_CLASS, wrapped_params)
+  end
+
+  # Retrieve an Insurance object
+  def retrieve(id)
+    @client.make_request(:get, "insurances/#{id}", MODEL_CLASS)
+  end
+
+  # Retrieve all Insurance objects
+  def all(params = {})
+    @client.make_request(:get, 'insurances', MODEL_CLASS, params)
+  end
+
+  # Get the next page of insurances.
+  def get_next_page(collection, page_size = nil)
+    get_next_page_helper(collection, collection.insurances, 'insurances', MODEL_CLASS, page_size)
+  end
+end

data/lib/easypost/services/order.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::Order < EasyPost::Services::Service
+  MODEL_CLASS = EasyPost::Models::Order
+
+  # Create an Order object
+  def create(params = {})
+    wrapped_params = { order: params }
+    @client.make_request(:post, 'orders', MODEL_CLASS, wrapped_params)
+  end
+
+  # Retrieve an Order object
+  def retrieve(id)
+    @client.make_request(:get, "orders/#{id}", MODEL_CLASS)
+  end
+
+  # Retrieve new rates for an Order object
+  def get_rates(id, params = {})
+    @client.make_request(:get, "orders/#{id}/rates", MODEL_CLASS, params)
+  end
+
+  # Buy an Order object
+  def buy(id, params = {})
+    if params.instance_of?(EasyPost::Models::Rate)
+      params = { carrier: params[:carrier], service: params[:service] }
+    end
+
+    @client.make_request(:post, "orders/#{id}/buy", MODEL_CLASS, params)
+  end
+end

data/lib/easypost/services/parcel.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::Parcel < EasyPost::Services::Service
+  MODEL_CLASS = EasyPost::Models::Parcel
+
+  # Create a Parcel object
+  def create(params = {})
+    wrapped_params = { parcel: params }
+    @client.make_request(:post, 'parcels', MODEL_CLASS, wrapped_params)
+  end
+
+  # Retrieve a Parcel object
+  def retrieve(id)
+    @client.make_request(:get, "parcels/#{id}", MODEL_CLASS)
+  end
+end

data/lib/easypost/services/pickup.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::Pickup < EasyPost::Services::Service
+  MODEL_CLASS = EasyPost::Models::Pickup
+
+  # Create a Pickup object
+  def create(params = {})
+    wrapped_params = { pickup: params }
+    @client.make_request(:post, 'pickups', MODEL_CLASS, wrapped_params)
+  end
+
+  # Retrieve a Pickup object
+  def retrieve(id)
+    @client.make_request(:get, "pickups/#{id}", MODEL_CLASS)
+  end
+
+  # Retrieve all Pickup objects
+  def all(params = {})
+    @client.make_request(:get, 'pickups', MODEL_CLASS, params)
+  end
+
+  # Buy a Pickup
+  def buy(id, params = {})
+    if params.instance_of?(EasyPost::Models::PickupRate)
+      params = { carrier: params[:carrier], service: params[:service] }
+    end
+
+    @client.make_request(:post, "pickups/#{id}/buy", MODEL_CLASS, params)
+  end
+
+  # Cancel a Pickup
+  def cancel(id, params = {})
+    @client.make_request(:post, "pickups/#{id}/cancel", MODEL_CLASS, params)
+  end
+
+  # Get next page of Pickups
+  def get_next_page(collection, page_size = nil)
+    get_next_page_helper(collection, collection.pickups, 'pickups', MODEL_CLASS, page_size)
+  end
+end

data/lib/easypost/services/rate.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::Rate < EasyPost::Services::Service
+  # Retrieve a Rate
+  def retrieve(id)
+    @client.make_request(:get, "rates/#{id}", EasyPost::Models::Rate)
+  end
+end

data/lib/easypost/services/referral_customer.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::ReferralCustomer < EasyPost::Services::Service
+  MODEL_CLASS = EasyPost::Models::User
+
+  # Create a referral customer. This function requires the Partner User's API key.
+  def create(params = {})
+    @client.make_request(:post, 'referral_customers', MODEL_CLASS, { user: params })
+  end
+
+  # Update a referral customer. This function requires the Partner User's API key.
+  def update_email(user_id, email)
+    wrapped_params = {
+      user: {
+        email: email,
+      },
+    }
+    @client.make_request(:put, "referral_customers/#{user_id}", MODEL_CLASS, wrapped_params)
+
+    # return true if API succeeds, else an error is throw if it fails.
+    true
+  end
+
+  # Retrieve a list of referral customers. This function requires the Partner User's API key.
+  def all(params = {})
+    @client.make_request(:get, 'referral_customers', MODEL_CLASS, params)
+  end
+
+  # Get the next page of referral customers.
+  def get_next_page(collection, page_size = nil)
+    get_next_page_helper(collection, collection.referral_customers, 'referral_customers', MODEL_CLASS, page_size)
+  end
+
+  # Add credit card to a referral customer. This function requires the ReferralCustomer Customer's API key.
+  def add_credit_card(referral_api_key, number, expiration_month, expiration_year, cvc, priority = 'primary')
+    easypost_stripe_api_key = retrieve_easypost_stripe_api_key
+
+    begin
+      stripe_credit_card_token = create_stripe_token(
+        number,
+        expiration_month,
+        expiration_year,
+        cvc,
+        easypost_stripe_api_key,
+      )
+    rescue StandardError
+      raise EasyPost::Errors::ExternalApiError.new(EasyPost::Constants::STRIPE_CARD_CREATE_FAILED)
+    end
+
+    create_easypost_credit_card(referral_api_key, stripe_credit_card_token, priority)
+  end
+
+  private
+
+  # Retrieve EasyPost's Stripe public API key.
+  def retrieve_easypost_stripe_api_key
+    response = @client.make_request(:get, 'partners/stripe_public_key', EasyPost::Models::EasyPostObject, nil, 'beta')
+    response['public_key']
+  end
+
+  # Get credit card token from Stripe.
+  def create_stripe_token(number, expiration_month, expiration_year,
+                          cvc, easypost_stripe_token)
+    headers = {
+      # This Stripe endpoint only accepts URL form encoded bodies.
+      Authorization: "Bearer #{easypost_stripe_token}",
+      'Content-type': 'application/x-www-form-urlencoded',
+    }
+
+    credit_card_hash = {
+      card: {
+        number: number,
+        exp_month: expiration_month,
+        exp_year: expiration_year,
+        cvc: cvc,
+      },
+    }
+
+    form_encoded_params = EasyPost::InternalUtilities.form_encode_params(credit_card_hash)
+
+    uri = URI.parse('https://api.stripe.com/v1/tokens')
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    request = Net::HTTP::Post.new(uri.request_uri, headers)
+    query = URI.encode_www_form(form_encoded_params)
+
+    response = http.request(request, query)
+    response_json = JSON.parse(response.body)
+    response_json['id']
+  end
+
+  # Submit Stripe credit card token to EasyPost.
+  def create_easypost_credit_card(referral_api_key, stripe_object_id, priority = 'primary')
+    wrapped_params = {
+      credit_card: {
+        stripe_object_id: stripe_object_id,
+        priority: priority,
+      },
+    }
+    referral_client = EasyPost::Client.new(api_key: referral_api_key)
+    referral_client.make_request(:post, 'credit_cards', EasyPost::Models::EasyPostObject, wrapped_params, 'beta')
+  end
+end

data/lib/easypost/services/refund.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::Refund < EasyPost::Services::Service
+  MODEL_CLASS = EasyPost::Models::Refund
+
+  # Create a Refund object
+  def create(params = {})
+    wrapped_params = { refund: params }
+    @client.make_request(:post, 'refunds', MODEL_CLASS, wrapped_params)
+  end
+
+  # Retrieve a Refund object
+  def retrieve(id)
+    @client.make_request(:get, "refunds/#{id}", MODEL_CLASS)
+  end
+
+  # Retrieve all Refund objects
+  def all(params = {})
+    @client.make_request(:get, 'refunds', MODEL_CLASS, params)
+  end
+
+  # Get the next page of refunds
+  def get_next_page(collection, page_size = nil)
+    get_next_page_helper(collection, collection.refunds, 'refunds', MODEL_CLASS, page_size)
+  end
+end

data/lib/easypost/services/report.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::Report < EasyPost::Services::Service
+  MODEL_CLASS = EasyPost::Models::Report
+
+  # Create a Report
+  def create(params = {})
+    unless params[:type]
+      raise ArgumentError, "Missing 'type' parameter in params" # TODO: replace the error in the error-handling overhaul PR
+    end
+
+    type = params.delete(:type)
+    url = "reports/#{type}"
+
+    @client.make_request(:post, url, MODEL_CLASS, params)
+  end
+
+  # Retrieve a Report
+  def retrieve(id)
+    @client.make_request(:get, "reports/#{id}", MODEL_CLASS)
+  end
+
+  # Retrieve all Report objects
+  def all(params = {})
+    unless params[:type]
+      raise ArgumentError, "Missing 'type' parameter in params" # TODO: replace the error in the error-handling overhaul PR
+    end
+
+    type = params.delete(:type)
+    url = "reports/#{type}"
+
+    response = @client.make_request(:get, url, MODEL_CLASS, params)
+    response.define_singleton_method(:type) { type }
+    response
+  end
+
+  # Get next page of Report objects
+  def get_next_page(collection, page_size = nil)
+    url = "reports/#{collection.type}"
+    get_next_page_helper(collection, collection.reports, url, MODEL_CLASS, page_size)
+  end
+end

data/lib/easypost/services/scan_form.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::ScanForm < EasyPost::Services::Service
+  MODEL_CLASS = EasyPost::Models::ScanForm
+
+  # Create a ScanForm.
+  def create(params = {})
+    @client.make_request(:post, 'scan_forms', MODEL_CLASS, params)
+  end
+
+  # Retrieve a ScanForm.
+  def retrieve(id)
+    @client.make_request(:get, "scan_forms/#{id}", MODEL_CLASS)
+  end
+
+  # Retrieve a list of ScanForms
+  def all(params = {})
+    @client.make_request(:get, 'scan_forms', MODEL_CLASS, params)
+  end
+
+  # Get the next page of ScanForms.
+  def get_next_page(collection, page_size = nil)
+    get_next_page_helper(collection, collection.scan_forms, 'scan_forms', MODEL_CLASS, page_size)
+  end
+end