shipengine_sdk 1.0.3

data/lib/shipengine/domain/carriers.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'hashie'
+require_relative 'carriers/list_carriers'
+require 'shipengine/constants'
+
+module ShipEngine
+  module Domain
+    class Carriers
+      # @param [ShipEngine::InternalClient] internal_client
+      def initialize(internal_client)
+        @internal_client = internal_client
+      end
+
+      def list_carriers(config:)
+        response = @internal_client.get('/v1/carriers', {}, config)
+        carriers_api_result = response.body
+        mash_result = Hashie::Mash.new(carriers_api_result)
+        carriers = mash_result.carriers.map do |carrier|
+          services = carrier.services.map do |service|
+            ListCarriers::Carrier::Service.new(
+              carrier_id: service.carrier_id,
+              carrier_code: service.carrier_code,
+              service_code: service.service_code,
+              name: service.name,
+              domestic: service.domestic,
+              international: service.international,
+              is_multi_package_supported: service.is_multi_package_supported
+            )
+          end
+
+          packages = carrier.packages.map do |package|
+            dimensions = nil
+            if package.dimensions
+              dimensions = ListCarriers::Carrier::Package::Dimensions.new(
+                unit: package.dimensions.unit,
+                length: package.dimensions['length'],
+                width: package.dimensions.width,
+                height: package.dimensions.height
+              )
+            end
+            ListCarriers::Carrier::Package.new(
+              package_id: package.package_id,
+              package_code: package.package_code,
+              name: package.name,
+              dimensions:,
+              description: package.description
+            )
+          end
+
+          options = carrier.options.map do |option|
+            ListCarriers::Carrier::Option.new(
+              name: option.name,
+              default_value: option.default_value,
+              description: option.description
+            )
+          end
+
+          ListCarriers::Carrier.new(
+            carrier_id: carrier.carrier_id,
+            carrier_code: carrier.carrier_code,
+            account_number: carrier.account_number,
+            requires_funded_amount: carrier.requires_funded_amount,
+            balance: carrier.balance,
+            nickname: carrier.nickname,
+            friendly_name: carrier.friendly_name,
+            primary: carrier.primary,
+            has_multi_package_supporting_services: carrier.has_multi_package_supporting_services,
+            supports_label_messages: carrier.supports_label_messages,
+            services:,
+            packages:,
+            options:
+          )
+        end
+
+        errors = mash_result.errors.map do |error|
+          ListCarriers::Error.new(
+            error_source: error.error_source,
+            error_type: error.error_type,
+            error_code: error.error_code,
+            message: error['message']
+          )
+        end
+
+        ListCarriers::Response.new(
+          carriers:,
+          request_id: mash_result.request_id,
+          errors:
+        )
+      end
+    end
+  end
+end

data/lib/shipengine/domain/labels/create_from_rate.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  module Domain
+    class Labels
+      module CreateFromRate
+        class Response
+          attr_reader :label_id,
+                      :status,
+                      :shipment_id,
+                      :ship_date,
+                      :created_at,
+                      :shipment_cost,
+                      :insurance_cost,
+                      :tracking_number,
+                      :is_return_label,
+                      :rma_number,
+                      :is_international,
+                      :batch_id,
+                      :carrier_id,
+                      :charge_event,
+                      :service_code,
+                      :package_code,
+                      :voided,
+                      :voided_at,
+                      :label_format,
+                      :display_scheme,
+                      :label_layout,
+                      :trackable,
+                      :label_image_id,
+                      :carrier_code,
+                      :tracking_status,
+                      :label_download,
+                      :form_download,
+                      :insurance_claim,
+                      :packages
+
+          # rubocop:todo Metrics/ParameterLists
+          def initialize(label_id:, status:, shipment_id:, ship_date:, created_at:, shipment_cost:, insurance_cost:, tracking_number:, is_return_label:, rma_number:, is_international:, batch_id:, carrier_id:, charge_event:, service_code:, package_code:, voided:, voided_at:, label_format:,
+                         display_scheme:, label_layout:, trackable:, label_image_id:, carrier_code:, tracking_status:, label_download:, form_download:, insurance_claim:, packages:)
+            # rubocop:enable Metrics/ParameterLists
+            @label_id = label_id
+            @status = status
+            @shipment_id = shipment_id
+            @ship_date = ship_date
+            @created_at = created_at
+            @shipment_cost = shipment_cost
+            @insurance_cost = insurance_cost
+            @tracking_number = tracking_number
+            @is_return_label = is_return_label
+            @rma_number = rma_number
+            @is_international = is_international
+            @batch_id = batch_id
+            @carrier_id = carrier_id
+            @charge_event = charge_event
+            @service_code = service_code
+            @package_code = package_code
+            @voided = voided
+            @voided_at = voided_at
+            @label_format = label_format
+            @display_scheme = display_scheme
+            @label_layout = label_layout
+            @trackable = trackable
+            @label_image_id = label_image_id
+            @carrier_code = carrier_code
+            @tracking_status = tracking_status
+            @label_download = label_download
+            @form_download = form_download
+            @insurance_claim = insurance_claim
+            @packages = packages
+          end
+
+          class MonetaryValue
+            attr_reader :currency, :amount
+
+            def initialize(currency:, amount:)
+              @currency = currency
+              @amount = amount
+            end
+          end
+
+          class Package
+            attr_reader :package_code, :weight, :dimensions, :insured_value, :tracking_number, :label_messages, :external_package_id
+
+            def initialize(package_code:, weight:, dimensions:, insured_value:, tracking_number:, label_messages:, external_package_id:) # rubocop:todo Metrics/ParameterLists
+              @package_code = package_code
+              @weight = weight
+              @dimensions = dimensions
+              @insured_value = insured_value
+              @tracking_number = tracking_number
+              @label_messages = label_messages
+              @external_package_id = external_package_id
+            end
+
+            class LabelMessages
+              attr_reader :reference1, :reference2, :reference3
+
+              def initialize(reference1:, reference2:, reference3:)
+                @reference1 = reference1
+                @reference2 = reference2
+                @reference3 = reference3
+              end
+            end
+          end
+
+          class LabelDownload
+            attr_reader :href, :pdf, :png, :zpl
+
+            def initialize(href:, pdf:, png:, zpl:)
+              @href = href
+              @pdf = pdf
+              @png = png
+              @zpl = zpl
+            end
+          end
+
+          class FormDownload
+            attr_reader :href, :type
+
+            def initialize(href:, type:)
+              @href = href
+              @type = type
+            end
+          end
+
+          class InsuranceClaim
+            attr_reader :href, :type
+
+            def initialize(href:, type:)
+              @href = href
+              @type = type
+            end
+          end
+
+          class Weight
+            attr_reader :value, :unit
+
+            def initialize(value:, unit:)
+              @value = value
+              @unit = unit
+            end
+          end
+
+          class Dimensions
+            attr_reader :unit, :length, :width, :height
+
+            # type ["inch" | "centimeter"] unit
+            # @param [Double] length - e.g. 1.0
+            # @param [Double] width - e.g. 1.0
+            # @param [Double] height - e.g. 1.0
+
+            def initialize(unit:, length:, width:, height:)
+              @unit = unit
+              @length = length
+              @width = width
+              @height = height
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shipengine/domain/labels/create_from_shipment_details.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  module Domain
+    class Labels
+      module CreateFromShipmentDetails
+        class Response
+          attr_reader :label_id,
+                      :status,
+                      :shipment_id,
+                      :ship_date,
+                      :created_at,
+                      :shipment_cost,
+                      :insurance_cost,
+                      :tracking_number,
+                      :is_return_label,
+                      :rma_number,
+                      :is_international,
+                      :batch_id,
+                      :carrier_id,
+                      :charge_event,
+                      :service_code,
+                      :package_code,
+                      :voided,
+                      :voided_at,
+                      :label_format,
+                      :display_scheme,
+                      :label_layout,
+                      :trackable,
+                      :label_image_id,
+                      :carrier_code,
+                      :tracking_status,
+                      :label_download,
+                      :form_download,
+                      :insurance_claim,
+                      :packages
+
+          # rubocop:todo Metrics/ParameterLists
+          def initialize(label_id:, status:, shipment_id:, ship_date:, created_at:, shipment_cost:, insurance_cost:, tracking_number:, is_return_label:, rma_number:, is_international:, batch_id:, carrier_id:, charge_event:, service_code:, package_code:, voided:, voided_at:, label_format:,
+                         display_scheme:, label_layout:, trackable:, label_image_id:, carrier_code:, tracking_status:, label_download:, form_download:, insurance_claim:, packages:)
+            # rubocop:enable Metrics/ParameterLists
+            @label_id = label_id
+            @status = status
+            @shipment_id = shipment_id
+            @ship_date = ship_date
+            @created_at = created_at
+            @shipment_cost = shipment_cost
+            @insurance_cost = insurance_cost
+            @tracking_number = tracking_number
+            @is_return_label = is_return_label
+            @rma_number = rma_number
+            @is_international = is_international
+            @batch_id = batch_id
+            @carrier_id = carrier_id
+            @charge_event = charge_event
+            @service_code = service_code
+            @package_code = package_code
+            @voided = voided
+            @voided_at = voided_at
+            @label_format = label_format
+            @display_scheme = display_scheme
+            @label_layout = label_layout
+            @trackable = trackable
+            @label_image_id = label_image_id
+            @carrier_code = carrier_code
+            @tracking_status = tracking_status
+            @label_download = label_download
+            @form_download = form_download
+            @insurance_claim = insurance_claim
+            @packages = packages
+          end
+
+          class MonetaryValue
+            attr_reader :currency, :amount
+
+            def initialize(currency:, amount:)
+              @currency = currency
+              @amount = amount
+            end
+          end
+
+          class Package
+            attr_reader :package_code, :weight, :dimensions, :insured_value, :tracking_number, :label_messages, :external_package_id
+
+            def initialize(package_code:, weight:, dimensions:, insured_value:, tracking_number:, label_messages:, external_package_id:) # rubocop:todo Metrics/ParameterLists
+              @package_code = package_code
+              @weight = weight
+              @dimensions = dimensions
+              @insured_value = insured_value
+              @tracking_number = tracking_number
+              @label_messages = label_messages
+              @external_package_id = external_package_id
+            end
+
+            class LabelMessages
+              attr_reader :reference1, :reference2, :reference3
+
+              def initialize(reference1:, reference2:, reference3:)
+                @reference1 = reference1
+                @reference2 = reference2
+                @reference3 = reference3
+              end
+            end
+          end
+
+          class LabelDownload
+            attr_reader :href, :pdf, :png, :zpl
+
+            def initialize(href:, pdf:, png:, zpl:)
+              @href = href
+              @pdf = pdf
+              @png = png
+              @zpl = zpl
+            end
+          end
+
+          class FormDownload
+            attr_reader :href, :type
+
+            def initialize(href:, type:)
+              @href = href
+              @type = type
+            end
+          end
+
+          class InsuranceClaim
+            attr_reader :href, :type
+
+            def initialize(href:, type:)
+              @href = href
+              @type = type
+            end
+          end
+
+          class Weight
+            attr_reader :value, :unit
+
+            def initialize(value:, unit:)
+              @value = value
+              @unit = unit
+            end
+          end
+
+          class Dimensions
+            attr_reader :unit, :length, :width, :height
+
+            # type ["inch" | "centimeter"] unit
+            # @param [Double] length - e.g. 1.0
+            # @param [Double] width - e.g. 1.0
+            # @param [Double] height - e.g. 1.0
+
+            def initialize(unit:, length:, width:, height:)
+              @unit = unit
+              @length = length
+              @width = width
+              @height = height
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shipengine/domain/labels/void_label.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  module Domain
+    class Labels
+      module VoidLabel
+        class Response
+          attr_reader :approved, :message
+
+          def initialize(approved:, message:)
+            @approved = approved
+            @message = message
+          end
+        end
+      end
+    end
+  end
+end