shipengine_sdk 1.0.3

data/lib/shipengine/domain/labels.rb

@@ -0,0 +1,297 @@
+# frozen_string_literal: true
+
+require 'hashie'
+require_relative 'labels/create_from_rate'
+require_relative 'labels/create_from_shipment_details'
+require_relative 'labels/void_label'
+
+module ShipEngine
+  module Domain
+    class Labels # rubocop:todo Metrics/ClassLength
+      require 'shipengine/constants'
+
+      # @param [ShipEngine::InternalClient] internal_client
+      def initialize(internal_client)
+        @internal_client = internal_client
+      end
+
+      # @param label_id [String]
+      # @param params [Hash]
+      # @param config [Hash?]
+      #
+      # @return [ShipEngine::Domain::Labels::CreateFromRate::Response]
+      #
+      # @see https://shipengine.github.io/shipengine-openapi/#operation/create_label_from_rate
+      def create_from_rate(rate_id, params, config)
+        response = @internal_client.post("/v1/labels/rates/#{rate_id}", params, config)
+        label_api_result = response.body
+        mash_result = Hashie::Mash.new(label_api_result)
+
+        shipment_cost = nil
+        if mash_result.shipment_cost
+          shipment_cost = CreateFromRate::Response::MonetaryValue.new(
+            currency: mash_result.shipment_cost.currency,
+            amount: mash_result.shipment_cost.amount
+          )
+        end
+
+        insurance_cost = nil
+        if mash_result.insurance_cost
+          insurance_cost = CreateFromRate::Response::MonetaryValue.new(
+            currency: mash_result.insurance_cost.currency,
+            amount: mash_result.insurance_cost.amount
+          )
+        end
+
+        label_download = nil
+        if mash_result.label_download
+          label_download = CreateFromRate::Response::LabelDownload.new(
+            href: mash_result.label_download.href,
+            pdf: mash_result.label_download.pdf,
+            png: mash_result.label_download.png,
+            zpl: mash_result.label_download.zpl
+          )
+        end
+
+        form_download = nil
+        if mash_result.form_download
+          form_download = CreateFromRate::Response::FormDownload.new(
+            href: mash_result.form_download.href,
+            type: mash_result.form_download.type
+          )
+        end
+
+        insurance_claim = nil
+        if mash_result.insurance_claim
+          insurance_claim = CreateFromRate::Response::InsuranceClaim.new(
+            href: mash_result.insurance_claim.href,
+            type: mash_result.insurance_claim.type
+          )
+        end
+
+        packages = mash_result.packages.map do |package|
+          weight = CreateFromRate::Response::Weight.new(
+            value: package.weight.value,
+            unit: package.weight.unit
+          )
+
+          dimensions = nil
+          if package.dimensions
+            dimensions = CreateFromRate::Response::Dimensions.new(
+              unit: package.dimensions.unit,
+              length: package.dimensions['length'],
+              width: package.dimensions.width,
+              height: package.dimensions.height
+            )
+          end
+
+          insured_value = nil
+          if package.insured_value
+            insured_value = CreateFromRate::Response::MonetaryValue.new(
+              currency: package.insured_value.currency,
+              amount: package.insured_value.amount
+            )
+          end
+
+          label_messages = nil
+          if package.label_messages
+            label_messages = CreateFromRate::Response::Package::LabelMessages.new(
+              reference1: package.label_messages.reference1,
+              reference2: package.label_messages.reference2,
+              reference3: package.label_messages.reference3
+            )
+          end
+
+          CreateFromRate::Response::Package.new(
+            package_code: package.package_code,
+            weight:,
+            dimensions:,
+            insured_value:,
+            tracking_number: package.tracking_number,
+            label_messages:,
+            external_package_id: package.external_package_id
+          )
+        end
+
+        CreateFromRate::Response.new(
+          label_id: mash_result.label_id,
+          status: mash_result.status,
+          shipment_id: mash_result.shipment_id,
+          ship_date: mash_result.ship_date,
+          created_at: mash_result.created_at,
+          shipment_cost:,
+          insurance_cost:,
+          tracking_number: mash_result.tracking_number,
+          is_return_label: mash_result.is_return_label,
+          rma_number: mash_result.rma_number,
+          is_international: mash_result.is_international,
+          batch_id: mash_result.batch_id,
+          carrier_id: mash_result.carrier_id,
+          charge_event: mash_result.charge_event,
+          service_code: mash_result.service_code,
+          package_code: mash_result.package_code,
+          voided: mash_result.voided,
+          voided_at: mash_result.voided_at,
+          label_format: mash_result.label_format,
+          display_scheme: mash_result.display_scheme,
+          label_layout: mash_result.label_layout,
+          trackable: mash_result.trackable,
+          label_image_id: mash_result.label_image_id,
+          carrier_code: mash_result.carrier_code,
+          tracking_status: mash_result.tracking_status,
+          label_download:,
+          form_download:,
+          insurance_claim:,
+          packages:
+        )
+      end
+
+      # @param params [Hash]
+      # @param config [Hash?]
+      #
+      # @return [ShipEngine::Domain::Labels::CreateFromShipmentDetails::Response]
+      #
+      # @see https://shipengine.github.io/shipengine-openapi/#operation/create_label
+      def create_from_shipment_details(params, config)
+        response = @internal_client.post('/v1/labels', params, config)
+        label_api_result = response.body
+        mash_result = Hashie::Mash.new(label_api_result)
+
+        shipment_cost = nil
+        if mash_result.shipment_cost
+          shipment_cost = CreateFromShipmentDetails::Response::MonetaryValue.new(
+            currency: mash_result.shipment_cost.currency,
+            amount: mash_result.shipment_cost.amount
+          )
+        end
+
+        insurance_cost = nil
+        if mash_result.insurance_cost
+          insurance_cost = CreateFromShipmentDetails::Response::MonetaryValue.new(
+            currency: mash_result.insurance_cost.currency,
+            amount: mash_result.insurance_cost.amount
+          )
+        end
+
+        label_download = nil
+        if mash_result.label_download
+          label_download = CreateFromShipmentDetails::Response::LabelDownload.new(
+            href: mash_result.label_download.href,
+            pdf: mash_result.label_download.pdf,
+            png: mash_result.label_download.png,
+            zpl: mash_result.label_download.zpl
+          )
+        end
+
+        form_download = nil
+        if mash_result.form_download
+          form_download = CreateFromShipmentDetails::Response::FormDownload.new(
+            href: mash_result.form_download.href,
+            type: mash_result.form_download.type
+          )
+        end
+
+        insurance_claim = nil
+        if mash_result.insurance_claim
+          insurance_claim = CreateFromShipmentDetails::Response::InsuranceClaim.new(
+            href: mash_result.insurance_claim.href,
+            type: mash_result.insurance_claim.type
+          )
+        end
+
+        packages = mash_result.packages.map do |package|
+          weight = CreateFromShipmentDetails::Response::Weight.new(
+            value: package.weight.value,
+            unit: package.weight.unit
+          )
+
+          dimensions = nil
+          if package.dimensions
+            dimensions = CreateFromShipmentDetails::Response::Dimensions.new(
+              unit: package.dimensions.unit,
+              length: package.dimensions['length'],
+              width: package.dimensions.width,
+              height: package.dimensions.height
+            )
+          end
+
+          insured_value = nil
+          if package.insured_value
+            insured_value = CreateFromShipmentDetails::Response::MonetaryValue.new(
+              currency: package.insured_value.currency,
+              amount: package.insured_value.amount
+            )
+          end
+
+          label_messages = nil
+          if package.label_messages
+            label_messages = CreateFromShipmentDetails::Response::Package::LabelMessages.new(
+              reference1: package.label_messages.reference1,
+              reference2: package.label_messages.reference2,
+              reference3: package.label_messages.reference3
+            )
+          end
+
+          CreateFromShipmentDetails::Response::Package.new(
+            package_code: package.package_code,
+            weight:,
+            dimensions:,
+            insured_value:,
+            tracking_number: package.tracking_number,
+            label_messages:,
+            external_package_id: package.external_package_id
+          )
+        end
+
+        CreateFromShipmentDetails::Response.new(
+          label_id: mash_result.label_id,
+          status: mash_result.status,
+          shipment_id: mash_result.shipment_id,
+          ship_date: mash_result.ship_date,
+          created_at: mash_result.created_at,
+          shipment_cost:,
+          insurance_cost:,
+          tracking_number: mash_result.tracking_number,
+          is_return_label: mash_result.is_return_label,
+          rma_number: mash_result.rma_number,
+          is_international: mash_result.is_international,
+          batch_id: mash_result.batch_id,
+          carrier_id: mash_result.carrier_id,
+          charge_event: mash_result.charge_event,
+          service_code: mash_result.service_code,
+          package_code: mash_result.package_code,
+          voided: mash_result.voided,
+          voided_at: mash_result.voided_at,
+          label_format: mash_result.label_format,
+          display_scheme: mash_result.display_scheme,
+          label_layout: mash_result.label_layout,
+          trackable: mash_result.trackable,
+          label_image_id: mash_result.label_image_id,
+          carrier_code: mash_result.carrier_code,
+          tracking_status: mash_result.tracking_status,
+          label_download:,
+          form_download:,
+          insurance_claim:,
+          packages:
+        )
+      end
+
+      # @param label_id [String]
+      # @param config [Hash?]
+      #
+      # @return [ShipEngine::Domain::Labels::CreateFromShipmentDetails::Response]
+      #
+      # @see https://shipengine.github.io/shipengine-openapi/#operation/create_label
+      def void(label_id, config)
+        response = @internal_client.put("/v1/labels/#{label_id}/void", {}, config)
+        label_api_result = response.body
+        mash_result = Hashie::Mash.new(label_api_result)
+
+        VoidLabel::Response.new(
+          approved: mash_result.approved,
+          message: mash_result['message']
+        )
+      end
+    end
+  end
+end

data/lib/shipengine/domain/rates/get_with_shipment_details.rb

@@ -0,0 +1,347 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  module Domain
+    class Rates
+      module GetWithShipmentDetails
+        class Response
+          attr_reader :shipment_id,
+                      :carrier_id,
+                      :service_code,
+                      :external_order_id,
+                      :items,
+                      :tax_identifiers,
+                      :external_shipment_id,
+                      :ship_date,
+                      :created_at,
+                      :modified_at,
+                      :shipment_status,
+                      :ship_to,
+                      :ship_from,
+                      :warehouse_id,
+                      :return_to,
+                      :confirmation,
+                      :customs,
+                      :advanced_options,
+                      :origin_type,
+                      :insurance_provider,
+                      :tags,
+                      :order_source_code,
+                      :packages,
+                      :total_weight,
+                      :rate_response
+
+          # rubocop:todo Metrics/ParameterLists
+          def initialize(shipment_id:, carrier_id:, service_code:, external_order_id:, items:, tax_identifiers:, external_shipment_id:, ship_date:, created_at:, modified_at:, shipment_status:, ship_to:, ship_from:, warehouse_id:, return_to:, confirmation:, customs:, advanced_options:, origin_type:,
+                         insurance_provider:, tags:, order_source_code:, packages:, total_weight:, rate_response:)
+            # rubocop:enable Metrics/ParameterLists
+            @shipment_id = shipment_id
+            @carrier_id = carrier_id
+            @service_code = service_code
+            @external_order_id = external_order_id
+            @items = items
+            @tax_identifiers = tax_identifiers
+            @external_shipment_id = external_shipment_id
+            @ship_date = ship_date
+            @created_at = created_at
+            @modified_at = modified_at
+            @shipment_status = shipment_status
+            @ship_to = ship_to
+            @ship_from = ship_from
+            @warehouse_id = warehouse_id
+            @return_to = return_to
+            @confirmation = confirmation
+            @customs = customs
+            @advanced_options = advanced_options
+            @origin_type = origin_type
+            @insurance_provider = insurance_provider
+            @tags = tags
+            @order_source_code = order_source_code
+            @packages = packages
+            @total_weight = total_weight
+            @rate_response = rate_response
+          end
+
+          class Item
+            attr_reader :name, :sales_order_id, :sales_order_item_id, :quantity, :sku, :external_order_id, :external_order_item_id, :asin, :order_source_code
+
+            def initialize(name:, sales_order_id:, sales_order_item_id:, quantity:, sku:, external_order_id:, external_order_item_id:, asin:, order_source_code:) # rubocop:todo Metrics/ParameterLists
+              @name = name
+              @sales_order_id = sales_order_id
+              @sales_order_item_id = sales_order_item_id
+              @quantity = quantity
+              @sku = sku
+              @external_order_id = external_order_id
+              @external_order_item_id = external_order_item_id
+              @asin = asin
+              @order_source_code = order_source_code
+            end
+          end
+
+          class TaxIdentifier
+            attr_reader :taxable_entity_type, :identifier_type, :issuing_authority, :value
+
+            def initialize(taxable_entity_type:, identifier_type:, issuing_authority:, value:)
+              @taxable_entity_type = taxable_entity_type
+              @identifier_type = identifier_type
+              @issuing_authority = issuing_authority
+              @value = value
+            end
+          end
+
+          class Address
+            attr_reader :name, :phone, :company_name, :address_line1, :address_line2, :address_line3, :city_locality, :state_province, :postal_code, :country_code, :address_residential_indicator
+
+            def initialize(name:, phone:, company_name:, address_line1:, address_line2:, address_line3:, city_locality:, state_province:, postal_code:, country_code:, address_residential_indicator:) # rubocop:todo Metrics/ParameterLists
+              @name = name
+              @phone = phone
+              @company_name = company_name
+              @address_line1 = address_line1
+              @address_line2 = address_line2
+              @address_line3 = address_line3
+              @city_locality = city_locality
+              @state_province = state_province
+              @postal_code = postal_code
+              @country_code = country_code
+              @address_residential_indicator = address_residential_indicator
+            end
+          end
+
+          class Customs
+            attr_reader :contents, :non_delivery, :customs_items
+
+            def initialize(contents:, non_delivery:, customs_items:)
+              @contents = contents
+              @non_delivery = non_delivery
+              @customs_items = customs_items
+            end
+
+            class CustomsItem
+              attr_reader :customs_item_id, :description, :quantity, :value, :harmonized_tariff_code, :country_of_origin, :unit_of_measure, :sku, :sku_description
+
+              def initialize(customs_item_id:, description:, quantity:, value:, harmonized_tariff_code:, country_of_origin:, unit_of_measure:, sku:, sku_description:) # rubocop:todo Metrics/ParameterLists
+                @customs_item_id = customs_item_id
+                @description = description
+                @quantity = quantity
+                @value = value
+                @harmonized_tariff_code = harmonized_tariff_code
+                @country_of_origin = country_of_origin
+                @unit_of_measure = unit_of_measure
+                @sku = sku
+                @sku_description = sku_description
+              end
+            end
+          end
+
+          class MonetaryValue
+            attr_reader :currency, :amount
+
+            def initialize(currency:, amount:)
+              @currency = currency
+              @amount = amount
+            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
+
+          class AdvancedOptions
+            attr_reader :bill_to_account,
+                        :bill_to_country_code,
+                        :bill_to_party,
+                        :bill_to_postal_code,
+                        :contains_alcohol,
+                        :delivered_duty_paid,
+                        :dry_ice,
+                        :dry_ice_weight,
+                        :non_machinable,
+                        :saturday_delivery,
+                        :use_ups_ground_freight_pricing,
+                        :freight_class,
+                        :custom_field1,
+                        :custom_field2,
+                        :custom_field3,
+                        :origin_type,
+                        :shipper_release,
+                        :collect_on_delivery
+
+            # rubocop:todo Metrics/ParameterLists
+            def initialize(bill_to_account:, bill_to_country_code:, bill_to_party:, bill_to_postal_code:, contains_alcohol:, delivered_duty_paid:, dry_ice:, dry_ice_weight:, non_machinable:, saturday_delivery:, use_ups_ground_freight_pricing:, freight_class:, custom_field1:, custom_field2:,
+                           custom_field3:, origin_type:, shipper_release:, collect_on_delivery:)
+              # rubocop:enable Metrics/ParameterLists
+              @bill_to_account = bill_to_account
+              @bill_to_country_code = bill_to_country_code
+              @bill_to_party = bill_to_party
+              @bill_to_postal_code = bill_to_postal_code
+              @contains_alcohol = contains_alcohol
+              @delivered_duty_paid = delivered_duty_paid
+              @dry_ice = dry_ice
+              @dry_ice_weight = dry_ice_weight
+              @non_machinable = non_machinable
+              @saturday_delivery = saturday_delivery
+              @use_ups_ground_freight_pricing = use_ups_ground_freight_pricing
+              @freight_class = freight_class
+              @custom_field1 = custom_field1
+              @custom_field2 = custom_field2
+              @custom_field3 = custom_field3
+              @origin_type = origin_type
+              @shipper_release = shipper_release
+              @collect_on_delivery = collect_on_delivery
+            end
+
+            class CollectOnDelivery
+              attr_reader :payment_type, :payment_amount
+
+              def initialize(payment_type:, payment_amount:)
+                @payment_type = payment_type
+                @payment_amount = payment_amount
+              end
+            end
+          end
+
+          class Tag
+            attr_reader :name
+
+            def initialize(name:)
+              @name = name
+            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 RateResponse
+            attr_reader :rates, :invalid_rates, :rate_request_id, :shipment_id, :created_at, :status, :errors
+
+            def initialize(rates:, invalid_rates:, rate_request_id:, shipment_id:, created_at:, status:, errors:) # rubocop:todo Metrics/ParameterLists
+              @rates = rates
+              @invalid_rates = invalid_rates
+              @rate_request_id = rate_request_id
+              @shipment_id = shipment_id
+              @created_at = created_at
+              @status = status
+              @errors = errors
+            end
+
+            class Rate
+              attr_reader :rate_id,
+                          :rate_type,
+                          :carrier_id,
+                          :shipping_amount,
+                          :insurance_amount,
+                          :confirmation_amount,
+                          :other_amount,
+                          :tax_amount,
+                          :zone,
+                          :package_type,
+                          :delivery_days,
+                          :guaranteed_service,
+                          :estimated_delivery_date,
+                          :carrier_delivery_days,
+                          :ship_date,
+                          :negotiated_rate,
+                          :service_type,
+                          :service_code,
+                          :trackable,
+                          :carrier_code,
+                          :carrier_nickname,
+                          :carrier_friendly_name,
+                          :validation_status,
+                          :warning_messages,
+                          :error_messages
+
+              # rubocop:todo Metrics/ParameterLists
+              def initialize(rate_id:, rate_type:, carrier_id:, shipping_amount:, insurance_amount:, confirmation_amount:, other_amount:, tax_amount:, zone:, package_type:, delivery_days:, guaranteed_service:, estimated_delivery_date:, carrier_delivery_days:, ship_date:, negotiated_rate:,
+                             service_type:, service_code:, trackable:, carrier_code:, carrier_nickname:, carrier_friendly_name:, validation_status:, warning_messages:, error_messages:)
+                # rubocop:enable Metrics/ParameterLists
+                @rate_id = rate_id
+                @rate_type = rate_type
+                @carrier_id = carrier_id
+                @shipping_amount = shipping_amount
+                @insurance_amount = insurance_amount
+                @confirmation_amount = confirmation_amount
+                @other_amount = other_amount
+                @tax_amount = tax_amount
+                @zone = zone
+                @package_type = package_type
+                @delivery_days = delivery_days
+                @guaranteed_service = guaranteed_service
+                @estimated_delivery_date = estimated_delivery_date
+                @carrier_delivery_days = carrier_delivery_days
+                @ship_date = ship_date
+                @negotiated_rate = negotiated_rate
+                @service_type = service_type
+                @service_code = service_code
+                @trackable = trackable
+                @carrier_code = carrier_code
+                @carrier_nickname = carrier_nickname
+                @carrier_friendly_name = carrier_friendly_name
+                @validation_status = validation_status
+                @warning_messages = warning_messages
+                @error_messages = error_messages
+              end
+            end
+
+            class Error
+              attr_reader :error_source, :error_type, :error_code, :message
+
+              # type ["carrier" | "order_source" | "shipengine"] error_source
+              # type ["account_status" | "business_rules" | "validation" | "security" | "system" | "integrations"] error_type
+              # @param [String] error_code
+              # @param [String] message
+              def initialize(error_source:, error_type:, error_code:, message:)
+                @error_source = error_source
+                @error_type = error_type
+                @error_code = error_code
+                @message = message
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end