peddler 4.4.0 → 4.6.0

data/lib/peddler/types/fulfillment_inbound_2024_03_20/address_input.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # Specific details to identify a place.
+      AddressInput = Structure.new do
+        # @return [String] Street address information.
+        attribute(:address_line1, String, from: "addressLine1")
+
+        # @return [String] Additional street address information.
+        attribute(:address_line2, String, from: "addressLine2")
+
+        # @return [String] The city.
+        attribute(:city, String)
+
+        # @return [String] The name of the business.
+        attribute(:company_name, String, from: "companyName")
+
+        # @return [String] The country code in two-character ISO 3166-1 alpha-2 format.
+        attribute(:country_code, String, from: "countryCode")
+
+        # @return [String] The district or county.
+        attribute(:district_or_county, String, from: "districtOrCounty")
+
+        # @return [String] The email address.
+        attribute(:email, String)
+
+        # @return [String] The name of the individual who is the primary contact.
+        attribute(:name, String)
+
+        # @return [String] The phone number.
+        attribute(:phone_number, String, from: "phoneNumber")
+
+        # @return [String] The postal code.
+        attribute(:postal_code, String, from: "postalCode")
+
+        # @return [String] The state or province code.
+        attribute(:state_or_province_code, String, from: "stateOrProvinceCode")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/appointment_slot.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "peddler/types/fulfillment_inbound_2024_03_20/appointment_slot_time"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The fulfillment center appointment slot for the transportation option.
+      AppointmentSlot = Structure.new do
+        # @return [String] An identifier to a self-ship appointment slot.
+        attribute(:slot_id, String, from: "slotId")
+
+        # @return [AppointmentSlotTime]
+        attribute(:slot_time, AppointmentSlotTime, from: "slotTime")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/appointment_slot_time.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # An appointment slot time with start and end.
+      AppointmentSlotTime = Structure.new do
+        # @return [String] The end timestamp of the appointment in UTC.
+        attribute(:end_time, String, from: "endTime")
+
+        # @return [String] The start timestamp of the appointment in UTC.
+        attribute(:start_time, String, from: "startTime")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/box.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "peddler/types/fulfillment_inbound_2024_03_20/region"
+require "peddler/types/fulfillment_inbound_2024_03_20/dimensions"
+require "peddler/types/fulfillment_inbound_2024_03_20/item"
+require "peddler/types/fulfillment_inbound_2024_03_20/weight"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # Contains information about a box that is used in the inbound plan. The box is a container that holds multiple
+      # items.
+      Box = Structure.new do
+        # @return [String] The ID provided by Amazon that identifies a given box. This ID is comprised of the external
+        # shipment ID (which is generated after transportation has been confirmed) and the index of the box.
+        attribute(:box_id, String, from: "boxId")
+
+        # @return [String]
+        attribute(:content_information_source, String, from: "contentInformationSource")
+
+        # @return [Region]
+        attribute(:destination_region, Region, from: "destinationRegion")
+
+        # @return [Dimensions]
+        attribute(:dimensions, Dimensions)
+
+        # @return [String] The external identifier for this container / box.
+        attribute(:external_container_identifier, String, from: "externalContainerIdentifier")
+
+        # @return [String] Type of the external identifier used. Can be: `AMAZON`, `SSCC`.
+        attribute(:external_container_identifier_type, String, from: "externalContainerIdentifierType")
+
+        # @return [Array<Item>] Items contained within the box.
+        attribute(:items, [Item])
+
+        # @return [String] Primary key to uniquely identify a Package (Box or Pallet).
+        attribute(:package_id, String, from: "packageId")
+
+        # @return [Integer] The number of containers where all other properties like weight or dimensions are identical.
+        attribute(:quantity, Integer)
+
+        # @return [String] Template name of the box.
+        attribute(:template_name, String, from: "templateName")
+
+        # @return [Weight]
+        attribute(:weight, Weight)
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/box_input.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "peddler/types/fulfillment_inbound_2024_03_20/dimensions"
+require "peddler/types/fulfillment_inbound_2024_03_20/item_input"
+require "peddler/types/fulfillment_inbound_2024_03_20/weight"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # Input information for a given box.
+      BoxInput = Structure.new do
+        # @return [String]
+        attribute(:content_information_source, String, from: "contentInformationSource")
+
+        # @return [Dimensions]
+        attribute(:dimensions, Dimensions)
+
+        # @return [Array<ItemInput>] The items and their quantity in the box. This must be empty if the box
+        # `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`.
+        attribute(:items, [ItemInput])
+
+        # @return [Integer] The number of containers where all other properties like weight or dimensions are identical.
+        attribute(:quantity, Integer)
+
+        # @return [Weight]
+        attribute(:weight, Weight)
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/box_requirements.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "peddler/types/fulfillment_inbound_2024_03_20/weight_range"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The requirements for a box in the packing option.
+      BoxRequirements = Structure.new do
+        # @return [WeightRange]
+        attribute(:weight, WeightRange)
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/box_update_input.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "peddler/types/fulfillment_inbound_2024_03_20/dimensions"
+require "peddler/types/fulfillment_inbound_2024_03_20/item_input"
+require "peddler/types/fulfillment_inbound_2024_03_20/weight"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # Input information for updating a box
+      BoxUpdateInput = Structure.new do
+        # @return [String]
+        attribute(:content_information_source, String, from: "contentInformationSource")
+
+        # @return [Dimensions]
+        attribute(:dimensions, Dimensions)
+
+        # @return [Array<ItemInput>] The items and their quantity in the box. This must be empty if the box
+        # `contentInformationSource` is `BARCODE_2D` or `MANUAL_PROCESS`.
+        attribute(:items, [ItemInput])
+
+        # @return [String] Primary key to uniquely identify a Box Package. PackageId must be provided if the intent is
+        # to update an existing box. Adding a new box will not require providing this value. Any existing PackageIds not
+        # provided will be treated as to-be-removed
+        attribute(:package_id, String, from: "packageId")
+
+        # @return [Integer] The number of containers where all other properties like weight or dimensions are identical.
+        attribute(:quantity, Integer)
+
+        # @return [Weight]
+        attribute(:weight, Weight)
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/cancel_inbound_plan_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The `cancelInboundPlan` response.
+      CancelInboundPlanResponse = Structure.new do
+        # @return [String] UUID for the given operation.
+        attribute(:operation_id, String, from: "operationId")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/cancel_self_ship_appointment_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The `cancelSelfShipAppointment` request.
+      CancelSelfShipAppointmentRequest = Structure.new do
+        # @return [String]
+        attribute(:reason_comment, String, from: "reasonComment")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/cancel_self_ship_appointment_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The `CancelSelfShipAppointment` response.
+      CancelSelfShipAppointmentResponse = Structure.new do
+        # @return [String] UUID for the given operation.
+        attribute(:operation_id, String, from: "operationId")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/carrier.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The carrier for the inbound shipment.
+      Carrier = Structure.new do
+        # @return [String] The carrier code. For example, USPS or DHLEX.
+        attribute(:alpha_code, String, from: "alphaCode")
+
+        # @return [String] The name of the carrier.
+        attribute(:name, String)
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/carrier_appointment.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # Contains details for a transportation carrier appointment. This appointment is vended out by Amazon and is an
+      # indicator for when a transportation carrier is accepting shipments to be picked up.
+      CarrierAppointment = Structure.new do
+        # @return [String] The end timestamp of the appointment in UTC.
+        attribute(:end_time, String, from: "endTime")
+
+        # @return [String] The start timestamp of the appointment in UTC.
+        attribute(:start_time, String, from: "startTime")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/compliance_detail.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "peddler/types/fulfillment_inbound_2024_03_20/tax_details"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # Contains item identifiers and related tax information.
+      ComplianceDetail = Structure.new do
+        # @return [String] The Amazon Standard Identification Number, which identifies the detail page identifier.
+        attribute(:asin, String)
+
+        # @return [String] The Fulfillment Network SKU, which identifies a real fulfillable item with catalog data and
+        # condition.
+        attribute(:fnsku, String)
+
+        # @return [String] The merchant SKU, a merchant-supplied identifier for a specific SKU.
+        attribute(:msku, String)
+
+        # @return [TaxDetails]
+        attribute(:tax_details, TaxDetails, from: "taxDetails")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/confirm_delivery_window_options_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The `confirmDeliveryWindowOptions` response.
+      ConfirmDeliveryWindowOptionsResponse = Structure.new do
+        # @return [String] UUID for the given operation.
+        attribute(:operation_id, String, from: "operationId")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/confirm_packing_option_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The `confirmPackingOption` response.
+      ConfirmPackingOptionResponse = Structure.new do
+        # @return [String] UUID for the given operation.
+        attribute(:operation_id, String, from: "operationId")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/confirm_placement_option_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The `confirmPlacementOption` response.
+      ConfirmPlacementOptionResponse = Structure.new do
+        # @return [String] UUID for the given operation.
+        attribute(:operation_id, String, from: "operationId")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/confirm_shipment_content_update_preview_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The `confirmShipmentContentUpdatePreview` response.
+      ConfirmShipmentContentUpdatePreviewResponse = Structure.new do
+        # @return [String] UUID for the given operation.
+        attribute(:operation_id, String, from: "operationId")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/confirm_transportation_options_request.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "peddler/types/fulfillment_inbound_2024_03_20/transportation_selection"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The `confirmTransportationOptions` request.
+      ConfirmTransportationOptionsRequest = Structure.new do
+        # @return [Array<TransportationSelection>] Information needed to confirm one of the available transportation
+        # options.
+        attribute(:transportation_selections, [TransportationSelection], from: "transportationSelections")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/confirm_transportation_options_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The `confirmTransportationOptions` response.
+      ConfirmTransportationOptionsResponse = Structure.new do
+        # @return [String] UUID for the given operation.
+        attribute(:operation_id, String, from: "operationId")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/contact_information.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The seller's contact information.
+      ContactInformation = Structure.new do
+        # @return [String] The email address.
+        attribute(:email, String)
+
+        # @return [String] The contact's name.
+        attribute(:name, String)
+
+        # @return [String] The phone number.
+        attribute(:phone_number, String, from: "phoneNumber")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/content_update_preview.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "peddler/types/fulfillment_inbound_2024_03_20/requested_updates"
+require "peddler/types/fulfillment_inbound_2024_03_20/transportation_option"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # Preview of the changes that will be applied to the shipment.
+      ContentUpdatePreview = Structure.new do
+        # @return [String] Identifier of a content update preview.
+        attribute(:content_update_preview_id, String, from: "contentUpdatePreviewId")
+
+        # @return [String] The time at which the content update expires. In [ISO
+        # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) datetime format with pattern
+        # `yyyy-MM-ddTHH:mm:ss.sssZ`.
+        attribute(:expiration, String)
+
+        # @return [RequestedUpdates]
+        attribute(:requested_updates, RequestedUpdates, from: "requestedUpdates")
+
+        # @return [TransportationOption]
+        attribute(:transportation_option, TransportationOption, from: "transportationOption")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/create_inbound_plan_request.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "peddler/types/fulfillment_inbound_2024_03_20/item_input"
+require "peddler/types/fulfillment_inbound_2024_03_20/address_input"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The `createInboundPlan` request.
+      CreateInboundPlanRequest = Structure.new do
+        # @return [Array<String>] Marketplaces where the items need to be shipped to. Currently only one marketplace can
+        # be selected in this request.
+        attribute(:destination_marketplaces, [String], from: "destinationMarketplaces")
+
+        # @return [Array<ItemInput>] Items included in this plan.
+        attribute(:items, [ItemInput])
+
+        # @return [String] Name for the Inbound Plan. If one isn't provided, a default name will be provided.
+        attribute(:name, String)
+
+        # @return [AddressInput]
+        attribute(:source_address, AddressInput, from: "sourceAddress")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/create_inbound_plan_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The `createInboundPlan` response.
+      CreateInboundPlanResponse = Structure.new do
+        # @return [String] Identifier of an inbound plan.
+        attribute(:inbound_plan_id, String, from: "inboundPlanId")
+
+        # @return [String] UUID for the given operation.
+        attribute(:operation_id, String, from: "operationId")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/create_marketplace_item_labels_request.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "peddler/types/fulfillment_inbound_2024_03_20/msku_quantity"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The `createMarketplaceItemLabels` request.
+      CreateMarketplaceItemLabelsRequest = Structure.new do
+        # @return [Float] The height of the item label.
+        attribute(:height, Float)
+
+        # @return [String]
+        attribute(:label_type, String, from: "labelType")
+
+        # @return [String] The locale code constructed from ISO 639 language code and ISO 3166-1 alpha-2 standard of
+        # country codes separated by an underscore character.
+        attribute(:locale_code, String, from: "localeCode")
+
+        # @return [String] The Marketplace ID. For a list of possible values, refer to [Marketplace
+        # IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+        attribute(:marketplace_id, String, from: "marketplaceId")
+
+        # @return [Array<MskuQuantity>] Represents the quantity of an MSKU to print item labels for.
+        attribute(:msku_quantities, [MskuQuantity], from: "mskuQuantities")
+
+        # @return [String]
+        attribute(:page_type, String, from: "pageType")
+
+        # @return [Float] The width of the item label.
+        attribute(:width, Float)
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/create_marketplace_item_labels_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "peddler/types/fulfillment_inbound_2024_03_20/document_download"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The `createMarketplaceItemLabels` response.
+      CreateMarketplaceItemLabelsResponse = Structure.new do
+        # @return [Array<DocumentDownload>] Resources to download the requested document.
+        attribute(:document_downloads, [DocumentDownload], from: "documentDownloads")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/currency.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # The type and amount of currency.
+      Currency = Structure.new do
+        # @return [Float] Decimal value of the currency.
+        attribute(:amount, Float)
+
+        # @return [String] ISO 4217 standard of a currency code.
+        attribute(:code, String)
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/custom_placement_input.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "peddler/types/fulfillment_inbound_2024_03_20/item_input"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # Provide units going to the warehouse.
+      CustomPlacementInput = Structure.new do
+        # @return [Array<ItemInput>] Items included while creating Inbound Plan.
+        attribute(:items, [ItemInput])
+
+        # @return [String] Warehouse Id.
+        attribute(:warehouse_id, String, from: "warehouseId")
+      end
+    end
+  end
+end

data/lib/peddler/types/fulfillment_inbound_2024_03_20/dates.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "peddler/types/fulfillment_inbound_2024_03_20/window"
+
+module Peddler
+  module Types
+    module FulfillmentInbound20240320
+      # Specifies the date that the seller expects their shipment will be shipped.
+      Dates = Structure.new do
+        # @return [Window]
+        attribute(:ready_to_ship_window, Window, from: "readyToShipWindow")
+      end
+    end
+  end
+end