shipengine_ruby 0.0.1

data/lib/shipengine/domains/package_types.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "hashie"
+
+module ShipEngine
+  module Domain
+    class PackageTypes
+      def initialize
+        @client = ShipEngine::Client.new
+      end
+
+      def list_custom_package_types(params: {})
+        response = @client.get(
+          path: ShipEngine::Constants::PATHS.v1.package_types.root,
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def create_custom_package_types(params: {})
+        response = @client.post(
+          path: ShipEngine::Constants::PATHS.v1.package_types.root,
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def custom_package_types_by_id(package_id:, params: {})
+        response = @client.get(
+          path: "#{ShipEngine::Constants::PATHS.v1.package_types.root}/#{package_id}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def update_custom_package_types_by_id(package_id:, params: {})
+        response = @client.put(
+          path: "#{ShipEngine::Constants::PATHS.v1.package_types.root}/#{package_id}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def delete_custom_package_types_by_id(package_id:, params: {})
+        response = @client.delete(
+          path: "#{ShipEngine::Constants::PATHS.v1.package_types.root}/#{package_id}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+    end
+  end
+end

data/lib/shipengine/domains/rates.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "hashie"
+
+module ShipEngine
+  module Domain
+    class Rates
+      def initialize
+        @client = ShipEngine::Client.new
+      end
+
+      def shipping_rates(params: {})
+        response = @client.post(
+          path: ShipEngine::Constants::PATHS.v1.rates.root,
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def bulk_rates(params: {})
+        response = @client.post(
+          path: "#{ShipEngine::Constants::PATHS.v1.rates.root}/bulk",
+          options: params
+        )
+
+        response.body.map { |rate| Hashie::Mash.new(rate) }
+      end
+
+      def estimate_rates(params: {})
+        response = @client.post(
+          path: "#{ShipEngine::Constants::PATHS.v1.rates.root}/estimate",
+          options: params
+        )
+
+        response.body.map { |rate| Hashie::Mash.new(rate) }
+      end
+
+      def rate_by_id(rate_id:, params: {})
+        response = @client.get(
+          path: "#{ShipEngine::Constants::PATHS.v1.rates.root}/#{rate_id}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+    end
+  end
+end

data/lib/shipengine/domains/service_points.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "hashie"
+
+module ShipEngine
+  module Domain
+    class ServicePoints
+      def initialize
+        @client = ShipEngine::Client.new
+      end
+
+      def list_service_points(params: {})
+        response = @client.post(
+          path: "#{ShipEngine::Constants::PATHS.v1.service_points.root}/list",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def service_point_by_id(carrier_code:, country_code:, service_point_id:, params: {})
+        response = @client.get(
+          path: "#{ShipEngine::Constants::PATHS.v1.service_points.root}/#{carrier_code}/#{country_code}/#{service_point_id}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+    end
+  end
+end

data/lib/shipengine/domains/shipments.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require "hashie"
+
+module ShipEngine
+  module Domain
+    class Shipments
+      def initialize
+        @client = ShipEngine::Client.new
+      end
+
+      def list_shipments(params: {})
+        response = @client.get(
+          path: ShipEngine::Constants::PATHS.v1.shipments.root,
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def create_shipments(params: {})
+        response = @client.post(
+          path: ShipEngine::Constants::PATHS.v1.shipments.root,
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def shipment_by_external_id(external_shipment_id:, params: {})
+        response = @client.get(
+          path: "#{ShipEngine::Constants::PATHS.v1.shipments.shipment_by_external_id}/#{external_shipment_id}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def parse_shipping_info(params: {})
+        response = @client.put(
+          path: ShipEngine::Constants::PATHS.v1.shipments.parse_shipping_info,
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def shipment_by_id(shipment_id:, params: {})
+        response = @client.get(
+          path: "#{ShipEngine::Constants::PATHS.v1.shipments.root}/#{shipment_id}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def update_shipment_by_id(shipment_id:, params: {})
+        response = @client.put(
+          path: "#{ShipEngine::Constants::PATHS.v1.shipments.root}/#{shipment_id}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def cancel_shipment_by_id(shipment_id:, params: {})
+        response = @client.delete(
+          path: "#{ShipEngine::Constants::PATHS.v1.shipments.root}/#{shipment_id}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def shipment_rates(shipment_id:, params: {})
+        response = @client.get(
+          path: "#{ShipEngine::Constants::PATHS.v1.shipments.root}/#{shipment_id}/rates",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def add_tag_to_shipment(shipment_id:, tag_name:, params: {})
+        response = @client.post(
+          path: "#{ShipEngine::Constants::PATHS.v1.shipments.root}/#{shipment_id}/tags/#{tag_name}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def remove_tag_to_shipment(shipment_id:, tag_name:, params: {})
+        response = @client.delete(
+          path: "#{ShipEngine::Constants::PATHS.v1.shipments.root}/#{shipment_id}/tags/#{tag_name}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+    end
+  end
+end

data/lib/shipengine/domains/shipsurance.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "hashie"
+
+module ShipEngine
+  module Domain
+    class Shipsurance
+      def initialize
+        @client = ShipEngine::Client.new
+      end
+
+      def disconnect_shipsurance_account(params: {})
+        response = @client.delete(
+          path: ShipEngine::Constants::PATHS.v1.shipsurance.root,
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def connect_shipsurance_account(params: {})
+        response = @client.post(
+          path: ShipEngine::Constants::PATHS.v1.shipsurance.root,
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def add_funds_to_insurance(params: {})
+        response = @client.patch(
+          path: ShipEngine::Constants::PATHS.v1.shipsurance.add_funds,
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def get_insurance_funds_balance(params: {})
+        response = @client.get(
+          path: ShipEngine::Constants::PATHS.v1.shipsurance.balance,
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+    end
+  end
+end

data/lib/shipengine/domains/tags.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "hashie"
+
+module ShipEngine
+  module Domain
+    class Tags
+      def initialize
+        @client = ShipEngine::Client.new
+      end
+
+      def list_tags(params: {})
+        response = @client.get(
+          path: ShipEngine::Constants::PATHS.v1.tags.root,
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def create_tag(tag_name:, params: {})
+        response = @client.post(
+          path: "#{ShipEngine::Constants::PATHS.v1.tags.root}/#{tag_name}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def delete_tag(tag_name:, params: {})
+        response = @client.delete(
+          path: "#{ShipEngine::Constants::PATHS.v1.tags.root}/#{tag_name}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def update_tag(tag_name:, new_tag_name:, params: {})
+        response = @client.put(
+          path: "#{ShipEngine::Constants::PATHS.v1.tags.root}/#{tag_name}/#{new_tag_name}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+    end
+  end
+end

data/lib/shipengine/domains/tokens.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "hashie"
+
+module ShipEngine
+  module Domain
+    class Tokens
+      def initialize
+        @client = ShipEngine::Client.new
+      end
+
+      def ephemeral_token(params: {})
+        response = @client.post(
+          path: ShipEngine::Constants::PATHS.v1.tokens.root,
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+    end
+  end
+end

data/lib/shipengine/domains/tracking.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "hashie"
+
+module ShipEngine
+  module Domain
+    class Tracking
+      def initialize
+        @client = ShipEngine::Client.new
+      end
+
+      def tracking_information(params: {})
+        response = @client.get(
+          path: ShipEngine::Constants::PATHS.v1.tracking.root,
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def start_tracking_package(params: {})
+        response = @client.post(
+          path: "#{ShipEngine::Constants::PATHS.v1.tracking.root}/start",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def stop_tracking_package(params: {})
+        response = @client.post(
+          path: "#{ShipEngine::Constants::PATHS.v1.tracking.root}/stop",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+    end
+  end
+end

data/lib/shipengine/domains/warehouses.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "hashie"
+
+module ShipEngine
+  module Domain
+    class Warehouses
+      def initialize
+        @client = ShipEngine::Client.new
+      end
+
+      def list_warehouses(params: {})
+        response = @client.get(
+          path: ShipEngine::Constants::PATHS.v1.warehouses.root,
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def create_warehouse(params: {})
+        response = @client.post(
+          path: ShipEngine::Constants::PATHS.v1.warehouses.root,
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def warehouse_by_id(warehouse_id:, params: {})
+        response = @client.get(
+          path: "#{ShipEngine::Constants::PATHS.v1.warehouses.root}/#{warehouse_id}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def update_warehouse_by_id(warehouse_id:, params: {})
+        response = @client.put(
+          path: "#{ShipEngine::Constants::PATHS.v1.warehouses.root}/#{warehouse_id}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def delete_warehouse_by_id(warehouse_id:, params: {})
+        response = @client.delete(
+          path: "#{ShipEngine::Constants::PATHS.v1.warehouses.root}/#{warehouse_id}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+    end
+  end
+end

data/lib/shipengine/domains/webhooks.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "hashie"
+
+module ShipEngine
+  module Domain
+    class Webhooks
+      def initialize
+        @client = ShipEngine::Client.new
+      end
+
+      def list_webhooks(params: {})
+        response = @client.get(
+          path: ShipEngine::Constants::PATHS.v1.webhooks.root,
+          options: params
+        )
+
+        response.body.map { |webhook| Hashie::Mash.new(webhook) }
+      end
+
+      def create_webhook(params: {})
+        response = @client.post(
+          path: ShipEngine::Constants::PATHS.v1.webhooks.root,
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def webhook_by_id(webhook_id:, params: {})
+        response = @client.get(
+          path: "#{ShipEngine::Constants::PATHS.v1.webhooks.root}/#{webhook_id}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def update_webhook_by_id(webhook_id:, params: {})
+        response = @client.put(
+          path: "#{ShipEngine::Constants::PATHS.v1.webhooks.root}/#{webhook_id}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+
+      def delete_webhook_by_id(webhook_id:, params: {})
+        response = @client.delete(
+          path: "#{ShipEngine::Constants::PATHS.v1.webhooks.root}/#{webhook_id}",
+          options: params
+        )
+
+        Hashie::Mash.new(response.body)
+      end
+    end
+  end
+end

data/lib/shipengine/domains.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "shipengine/domains/addresses"
+require "shipengine/domains/batches"
+require "shipengine/domains/carriers"
+require "shipengine/domains/carriers_accounts"
+require "shipengine/domains/labels"
+require "shipengine/domains/manifests"
+require "shipengine/domains/package_pickups"
+require "shipengine/domains/package_types"
+require "shipengine/domains/rates"
+require "shipengine/domains/service_points"
+require "shipengine/domains/shipments"
+require "shipengine/domains/shipsurance"
+require "shipengine/domains/tags"
+require "shipengine/domains/tokens"
+require "shipengine/domains/tracking"
+require "shipengine/domains/warehouses"
+require "shipengine/domains/webhooks"

data/lib/shipengine/enums/address_residential_indicator_types.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  module Enums
+    module AddressResidentialIndicatorTypes
+
+      UNKNOWN = "unknown"
+
+      YES = "yes"
+
+      NO = "no"
+
+      ALL = [
+        UNKNOWN,
+        YES,
+        NO,
+      ].freeze
+    end
+  end
+end

data/lib/shipengine/enums/address_status.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  module Enums
+    module AddressStatus
+      #
+      # Address validation was not validated against the database because pre-validation failed.
+      #
+      UNVERIFIED = "unverified"
+
+      #
+      # Address was successfully verified.
+      #
+      VERIFIED = "verified"
+
+      #
+      # The address was validated, but the address should be double checked.
+      #
+      WARNING = "warning"
+
+      #
+      # The address could not be validated with any degree of certainty against the database.
+      #
+      ERROR = "error"
+
+      ALL = [
+        UNVERIFIED,
+        VERIFIED,
+        WARNING,
+        ERROR,
+      ].freeze
+    end
+  end
+end

data/lib/shipengine/enums/batch_status.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  module Enums
+    module BatchStatus
+      OPEN = "open"
+
+      QUEUED = "queued"
+
+      PROCESSING = "processing"
+
+      COMPLETED = "completed"
+
+      COMPLETED_WITH_ERRORS = "completed_with_errors"
+
+      ARCHIVED = "archived"
+
+      NOTIFYING = "notifying"
+
+      INVALID = "invalid"
+
+      ALL = [
+        OPEN,
+        QUEUED,
+        PROCESSING,
+        COMPLETED,
+        COMPLETED_WITH_ERRORS,
+        ARCHIVED,
+        NOTIFYING,
+        INVALID,
+      ].freeze
+    end
+  end
+end