peddler 4.5.0 → 4.6.1

data/lib/peddler/types/merchant_fulfillment_v0/cancel_shipment_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "peddler/types/merchant_fulfillment_v0/shipment"
+require "peddler/types/merchant_fulfillment_v0/error"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Response schema.
+      CancelShipmentResponse = Structure.new do
+        # @return [Shipment] The payload for the `cancelShipment` operation.
+        attribute(:payload, Shipment)
+
+        # @return [Array<Error>] One or more unexpected errors occurred during the `cancelShipment` operation.
+        attribute(:errors, [Error])
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/constraint.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # A validation constraint.
+      Constraint = Structure.new do
+        # @return [String] A regular expression.
+        attribute(:validation_reg_ex, String, from: "ValidationRegEx")
+
+        # @return [String] A validation string.
+        attribute(:validation_string, String, from: "ValidationString")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/create_shipment_request.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "peddler/types/merchant_fulfillment_v0/shipment_request_details"
+require "peddler/types/merchant_fulfillment_v0/label_format_option_request"
+require "peddler/types/merchant_fulfillment_v0/additional_seller_inputs"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Request schema.
+      CreateShipmentRequest = Structure.new do
+        # @return [ShipmentRequestDetails] Shipment information required to create a shipment.
+        attribute(:shipment_request_details, ShipmentRequestDetails, from: "ShipmentRequestDetails")
+
+        # @return [String]
+        attribute(:shipping_service_id, String, from: "ShippingServiceId")
+
+        # @return [String] Identifies a shipping service order made by a carrier.
+        attribute(:shipping_service_offer_id, String, from: "ShippingServiceOfferId")
+
+        # @return [String] Hazardous materials options for a package. Consult the terms and conditions for each carrier
+        # for more information about hazardous materials.
+        attribute(:hazmat_type, String, from: "HazmatType")
+
+        # @return [LabelFormatOptionRequest]
+        attribute(:label_format_option, LabelFormatOptionRequest, from: "LabelFormatOption")
+
+        # @return [Array<AdditionalSellerInputs>] A list of additional seller inputs required to ship this shipment.
+        attribute(:shipment_level_seller_inputs_list, [AdditionalSellerInputs], from: "ShipmentLevelSellerInputsList")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/create_shipment_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "peddler/types/merchant_fulfillment_v0/shipment"
+require "peddler/types/merchant_fulfillment_v0/error"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Response schema.
+      CreateShipmentResponse = Structure.new do
+        # @return [Shipment] Shipment information.
+        attribute(:payload, Shipment)
+
+        # @return [Array<Error>] One or more unexpected errors occurred during the `createShipment` operation.
+        attribute(:errors, [Error])
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/currency_amount.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Currency type and amount.
+      CurrencyAmount = Structure.new do
+        # @return [String] Three-digit currency code in ISO 4217 format.
+        attribute(:currency_code, String, from: "CurrencyCode")
+
+        # @return [Float] The currency amount.
+        attribute(:amount, Float, from: "Amount")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/dangerous_goods_details.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Details related to any dangerous goods or items that are shipped.
+      DangerousGoodsDetails = Structure.new do
+        # @return [String] The specific UNID of the item being shipped.
+        attribute(:united_nations_regulatory_id, String, from: "UnitedNationsRegulatoryId")
+
+        # @return [String] The specific regulatory class of the shipped item.
+        attribute(:transportation_regulatory_class, String, from: "TransportationRegulatoryClass")
+
+        # @return [String] The specific packaging group of the item being shipped.
+        attribute(:packing_group, String, from: "PackingGroup")
+
+        # @return [String] The specific packing instruction of the item being shipped.
+        attribute(:packing_instruction, String, from: "PackingInstruction")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Error response returned when the request is unsuccessful.
+      Error = Structure.new do
+        # @return [String] An error code that identifies the type of error that occurred.
+        attribute(:code, String)
+
+        # @return [String] A message that describes the error condition in a human-readable form.
+        attribute(:message, String)
+
+        # @return [String] Additional details that can help the caller understand or fix the issue.
+        attribute(:details, String)
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/excluded_benefit.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # An object representing an excluded benefit that is excluded for a shipping offer or rate.
+      ExcludedBenefit = Structure.new do
+        # @return [String] A benefit that is being excluded from a shipment.
+        attribute(:benefit, String, from: "Benefit")
+
+        # @return [Array]
+        attribute(:reason_codes, Array, from: "ReasonCodes")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/file_contents.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # The document data and checksum.
+      FileContents = Structure.new do
+        # @return [String] Data for printing labels encoded into a Base64, GZip-compressed string.
+        attribute(:contents, String, from: "Contents")
+
+        # @return [String]
+        attribute(:file_type, String, from: "FileType")
+
+        # @return [String] An MD5 hash to validate the PDF document data, in the form of a Base64 string.
+        attribute(:checksum, String, from: "Checksum")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/get_additional_seller_inputs_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "peddler/types/merchant_fulfillment_v0/address"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Request schema.
+      GetAdditionalSellerInputsRequest = Structure.new do
+        # @return [String]
+        attribute(:shipping_service_id, String, from: "ShippingServiceId")
+
+        # @return [Address] The address from which to ship.
+        attribute(:ship_from_address, Address, from: "ShipFromAddress")
+
+        # @return [String] An Amazon defined order identifier
+        attribute(:order_id, String, from: "OrderId")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/get_additional_seller_inputs_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "peddler/types/merchant_fulfillment_v0/get_additional_seller_inputs_result"
+require "peddler/types/merchant_fulfillment_v0/error"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Response schema.
+      GetAdditionalSellerInputsResponse = Structure.new do
+        # @return [GetAdditionalSellerInputsResult]
+        attribute(:payload, GetAdditionalSellerInputsResult)
+
+        # @return [Array<Error>]
+        attribute(:errors, [Error])
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/get_additional_seller_inputs_result.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "peddler/types/merchant_fulfillment_v0/additional_inputs"
+require "peddler/types/merchant_fulfillment_v0/item_level_fields"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # The payload for the `getAdditionalSellerInputs` operation.
+      GetAdditionalSellerInputsResult = Structure.new do
+        # @return [Array<AdditionalInputs>]
+        attribute(:shipment_level_fields, [AdditionalInputs], from: "ShipmentLevelFields")
+
+        # @return [Array<ItemLevelFields>]
+        attribute(:item_level_fields_list, [ItemLevelFields], from: "ItemLevelFieldsList")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/get_eligible_shipment_services_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "peddler/types/merchant_fulfillment_v0/shipment_request_details"
+require "peddler/types/merchant_fulfillment_v0/shipping_offering_filter"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Request schema.
+      GetEligibleShipmentServicesRequest = Structure.new do
+        # @return [ShipmentRequestDetails] Shipment information required for requesting shipping service offers.
+        attribute(:shipment_request_details, ShipmentRequestDetails, from: "ShipmentRequestDetails")
+
+        # @return [ShippingOfferingFilter]
+        attribute(:shipping_offering_filter, ShippingOfferingFilter, from: "ShippingOfferingFilter")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/get_eligible_shipment_services_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "peddler/types/merchant_fulfillment_v0/get_eligible_shipment_services_result"
+require "peddler/types/merchant_fulfillment_v0/error"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Response schema.
+      GetEligibleShipmentServicesResponse = Structure.new do
+        # @return [GetEligibleShipmentServicesResult]
+        attribute(:payload, GetEligibleShipmentServicesResult)
+
+        # @return [Array<Error>] One or more unexpected errors occurred during this operation.
+        attribute(:errors, [Error])
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/get_eligible_shipment_services_result.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "peddler/types/merchant_fulfillment_v0/shipping_service"
+require "peddler/types/merchant_fulfillment_v0/rejected_shipping_service"
+require "peddler/types/merchant_fulfillment_v0/temporarily_unavailable_carrier"
+require "peddler/types/merchant_fulfillment_v0/terms_and_conditions_not_accepted_carrier"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # The payload for the `getEligibleShipmentServices` operation.
+      GetEligibleShipmentServicesResult = Structure.new do
+        # @return [Array<ShippingService>] A list of shipping services offers.
+        attribute(:shipping_service_list, [ShippingService], from: "ShippingServiceList")
+
+        # @return [Array<RejectedShippingService>]
+        attribute(:rejected_shipping_service_list, [RejectedShippingService], from: "RejectedShippingServiceList")
+
+        # @return [Array<TemporarilyUnavailableCarrier>]
+        attribute(:temporarily_unavailable_carrier_list, [TemporarilyUnavailableCarrier], from: "TemporarilyUnavailableCarrierList")
+
+        # @return [Array<TermsAndConditionsNotAcceptedCarrier>]
+        attribute(:terms_and_conditions_not_accepted_carrier_list, [TermsAndConditionsNotAcceptedCarrier], from: "TermsAndConditionsNotAcceptedCarrierList")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/get_shipment_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "peddler/types/merchant_fulfillment_v0/shipment"
+require "peddler/types/merchant_fulfillment_v0/error"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Response schema.
+      GetShipmentResponse = Structure.new do
+        # @return [Shipment] The payload for the `getShipment` operation.
+        attribute(:payload, Shipment)
+
+        # @return [Array<Error>] One or more unexpected errors occurred during this operation.
+        attribute(:errors, [Error])
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/item.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "peddler/types/merchant_fulfillment_v0/weight"
+require "peddler/types/merchant_fulfillment_v0/additional_seller_inputs"
+require "peddler/types/merchant_fulfillment_v0/liquid_volume"
+require "peddler/types/merchant_fulfillment_v0/dangerous_goods_details"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # An Amazon order item identifier and a quantity.
+      Item = Structure.new do
+        # @return [String]
+        attribute(:order_item_id, String, from: "OrderItemId")
+
+        # @return [Integer]
+        attribute(:quantity, Integer, from: "Quantity")
+
+        # @return [Weight]
+        attribute(:item_weight, Weight, from: "ItemWeight")
+
+        # @return [String]
+        attribute(:item_description, String, from: "ItemDescription")
+
+        # @return [Array<TransparencyCode>]
+        attribute(:transparency_code_list, Array, from: "TransparencyCodeList")
+
+        # @return [Array<AdditionalSellerInputs>] A list of additional seller inputs required to ship this item using
+        # the chosen shipping service.
+        attribute(:item_level_seller_inputs_list, [AdditionalSellerInputs], from: "ItemLevelSellerInputsList")
+
+        # @return [LiquidVolume]
+        attribute(:liquid_volume, LiquidVolume, from: "LiquidVolume")
+
+        # @return [:boolean] When true, the item qualifies as hazardous materials (hazmat). Defaults to false.
+        attribute(:hazmat, :boolean, from: "IsHazmat")
+
+        # @return [DangerousGoodsDetails]
+        attribute(:dangerous_goods_details, DangerousGoodsDetails, from: "DangerousGoodsDetails")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/item_level_fields.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "peddler/types/merchant_fulfillment_v0/additional_inputs"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # A list of item level fields.
+      ItemLevelFields = Structure.new do
+        # @return [String] The Amazon Standard Identification Number (ASIN) of the item.
+        attribute(:asin, String, from: "Asin")
+
+        # @return [Array<AdditionalInputs>]
+        attribute(:additional_inputs, [AdditionalInputs], from: "AdditionalInputs")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/label.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "peddler/types/merchant_fulfillment_v0/label_dimensions"
+require "peddler/types/merchant_fulfillment_v0/file_contents"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Data for creating a shipping label and dimensions for printing the label.
+      Label = Structure.new do
+        # @return [String]
+        attribute(:custom_text_for_label, String, from: "CustomTextForLabel")
+
+        # @return [LabelDimensions]
+        attribute(:dimensions, LabelDimensions, from: "Dimensions")
+
+        # @return [FileContents]
+        attribute(:file_contents, FileContents, from: "FileContents")
+
+        # @return [String]
+        attribute(:label_format, String, from: "LabelFormat")
+
+        # @return [String]
+        attribute(:standard_id_for_label, String, from: "StandardIdForLabel")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/label_customization.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Custom text for shipping labels.
+      LabelCustomization = Structure.new do
+        # @return [String]
+        attribute(:custom_text_for_label, String, from: "CustomTextForLabel")
+
+        # @return [String]
+        attribute(:standard_id_for_label, String, from: "StandardIdForLabel")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/label_dimensions.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Dimensions for printing a shipping label.
+      LabelDimensions = Structure.new do
+        # @return [Float] The length dimension.
+        attribute(:length, Float, from: "Length")
+
+        # @return [Float] The width dimension.
+        attribute(:width, Float, from: "Width")
+
+        # @return [String] The unit of measurement.
+        attribute(:unit, String, from: "Unit")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/label_format_option.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # The label format details and whether to include a packing slip.
+      LabelFormatOption = Structure.new do
+        # @return [:boolean] When true, include a packing slip with the label.
+        attribute(:include_packing_slip_with_label, :boolean, from: "IncludePackingSlipWithLabel")
+
+        # @return [String]
+        attribute(:label_format, String, from: "LabelFormat")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/label_format_option_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Whether to include a packing slip.
+      LabelFormatOptionRequest = Structure.new do
+        # @return [:boolean] When true, include a packing slip with the label.
+        attribute(:include_packing_slip_with_label, :boolean, from: "IncludePackingSlipWithLabel")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/length.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # The length.
+      Length = Structure.new do
+        # @return [Float] The value in units.
+        attribute(:value, Float)
+
+        # @return [String]
+        attribute(:unit, String)
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/liquid_volume.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Liquid volume.
+      LiquidVolume = Structure.new do
+        # @return [String] The unit of measurement.
+        attribute(:unit, String, from: "Unit")
+
+        # @return [Float] The measurement value.
+        attribute(:value, Float, from: "Value")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/package_dimensions.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # The dimensions of a package contained in a shipment.
+      PackageDimensions = Structure.new do
+        # @return [Float] The length dimension. If you don't specify `PredefinedPackageDimensions`, you must specify the
+        # length.
+        attribute(:length, Float, from: "Length")
+
+        # @return [Float] The width dimension. If you don't specify `PredefinedPackageDimensions`, you must specify the
+        # width.
+        attribute(:width, Float, from: "Width")
+
+        # @return [Float] The height dimension. If you don't specify `PredefinedPackageDimensions`, you must specify the
+        # height.
+        attribute(:height, Float, from: "Height")
+
+        # @return [String] The unit of measurement. If you don't specify `PredefinedPackageDimensions`, you must specify
+        # the unit.
+        attribute(:unit, String, from: "Unit")
+
+        # @return [String]
+        attribute(:predefined_package_dimensions, String, from: "PredefinedPackageDimensions")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/rejected_shipping_service.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Information about a rejected shipping service
+      RejectedShippingService = Structure.new do
+        # @return [String] The rejected shipping carrier name. For example, USPS.
+        attribute(:carrier_name, String, from: "CarrierName")
+
+        # @return [String] The rejected shipping service localized name. For example, FedEx Standard Overnight.
+        attribute(:shipping_service_name, String, from: "ShippingServiceName")
+
+        # @return [String] The rejected shipping service identifier. For example, `FEDEX_PTP_STANDARD_OVERNIGHT`.
+        attribute(:shipping_service_id, String, from: "ShippingServiceId")
+
+        # @return [String] A reason code meant to be consumed programatically. For example,
+        # `CARRIER_CANNOT_SHIP_TO_POBOX`.
+        attribute(:rejection_reason_code, String, from: "RejectionReasonCode")
+
+        # @return [String] A localized human readable description of the rejected reason.
+        attribute(:rejection_reason_message, String, from: "RejectionReasonMessage")
+      end
+    end
+  end
+end

data/lib/peddler/types/merchant_fulfillment_v0/seller_input_definition.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "peddler/types/merchant_fulfillment_v0/constraint"
+require "peddler/types/merchant_fulfillment_v0/additional_seller_input"
+
+module Peddler
+  module Types
+    module MerchantFulfillmentV0
+      # Specifies characteristics that apply to a seller input.
+      SellerInputDefinition = Structure.new do
+        # @return [:boolean] When true, the additional input field is required.
+        attribute(:required, :boolean, from: "IsRequired")
+
+        # @return [String] The data type of the additional input field.
+        attribute(:data_type, String, from: "DataType")
+
+        # @return [Array<Constraint>]
+        attribute(:constraints, [Constraint], from: "Constraints")
+
+        # @return [String] The display text for the additional input field.
+        attribute(:input_display_text, String, from: "InputDisplayText")
+
+        # @return [String] Whether the seller input applies to the item or the shipment.
+        attribute(:input_target, String, from: "InputTarget")
+
+        # @return [AdditionalSellerInput]
+        attribute(:stored_value, AdditionalSellerInput, from: "StoredValue")
+
+        # @return [Array]
+        attribute(:restricted_set_values, Array, from: "RestrictedSetValues")
+      end
+    end
+  end
+end