spree_api 6.0.0.rc4 → 6.0.0.rc6

data/app/serializers/spree/api/v3/admin/tax_line_serializer.rb

@@ -7,7 +7,7 @@ module Spree
 
           typelize amount: [:string, nullable: false],
                    provider_id: [:string, nullable: true], metadata: ['Record<string, unknown>', nullable: true],
-                   taxability_reason: [:string, nullable: true], country_code: [:string, nullable: true, enum: Spree::IsoData.country_codes, enum_type_name: 'CountryCode'],
+                   taxability_reason: [:string, nullable: true, enum: Spree::TaxLine::BUILT_IN_TAXABILITY_REASONS, enum_type_name: 'TaxabilityReason'], country_code: [:string, nullable: true, enum: Spree::IsoData.country_codes, enum_type_name: 'CountryCode'],
                    state_code: [:string, nullable: true], data: ['Record<string, unknown>', nullable: true],
                    original_tax_line_id: [:string, nullable: true]
 

data/app/serializers/spree/api/v3/admin/variant_serializer.rb

@@ -24,7 +24,7 @@ module Spree
                    deleted_at: [:string, nullable: true],
                    delivery_profile_id: [:string, nullable: true],
                    minimum_order_quantity: ['number | null'], order_multiple: ['number | null'],
-                   purchase_unit: [:string, nullable: true, enum: Spree::Variant::PURCHASE_UNITS],
+                   purchase_unit: [:string, nullable: true, enum: Spree::Variant::PURCHASE_UNITS, enum_type_name: 'PurchaseUnit'],
                    carton_package_type_id: [:string, nullable: true],
                    carton_weight: [:string, nullable: true],
                    cartons_per_pallet: ['number | null'],

data/app/serializers/spree/api/v3/base_serializer.rb

@@ -126,7 +126,7 @@ module Spree
           names = model.exposed_preference_names.to_a - except if names.empty?
           definitions = model.preference_definitions
           names.each do |name|
-            typelize name => preference_type_hint(Spree::PreferenceSchema::JsonSchema.property_schema(definitions.fetch(name)))
+            typelize name => preference_type_hint(Spree::PreferenceSchema::JsonSchema.property_schema(definitions.fetch(name)), name)
             reader = :"preferred_#{name}"
             attribute(name) do |object|
               value = object.public_send(reader)
@@ -138,12 +138,34 @@ module Spree
         TYPELIZER_TYPES = { 'string' => :string, 'integer' => :number, 'number' => :number, 'boolean' => :boolean }.freeze
         private_constant :TYPELIZER_TYPES
 
-        def self.preference_type_hint(schema)
+        # The shared name of each setting's value list, so it is defined once
+        # in `@spree/core` rather than inline wherever the setting appears.
+        PREFERENCE_LIST_NAMES = {
+          capture_method: 'CaptureMethod',
+          default_payouts_schedule_interval: 'PayoutScheduleInterval',
+          document_number_format: 'DocumentNumberFormat',
+          email_font: 'EmailFont',
+          inventory_provider_failure_policy: 'ProviderFailurePolicy',
+          pricing_provider_failure_policy: 'ProviderFailurePolicy',
+          storefront_access: 'StorefrontAccess',
+          unit_system: 'UnitSystem'
+        }.freeze
+        private_constant :PREFERENCE_LIST_NAMES
+
+        def self.preference_type_hint(schema, name)
           types = Array(schema['type'])
-          hint = TYPELIZER_TYPES.fetch((types - ['null']).first, :unknown)
           options = {}
           options[:nullable] = true if types.include?('null')
-          options[:enum] = schema['enum'].compact if schema['enum']
+          if types.include?('array')
+            hint = TYPELIZER_TYPES.fetch(Array(schema.dig('items', 'type')).first, :unknown)
+            options[:multi] = true
+          else
+            hint = TYPELIZER_TYPES.fetch((types - ['null']).first, :unknown)
+          end
+          if schema['enum']
+            options[:enum] = schema['enum'].compact
+            options[:enum_type_name] = PREFERENCE_LIST_NAMES[name.to_sym] if PREFERENCE_LIST_NAMES.key?(name.to_sym)
+          end
           options.empty? ? hint : [hint, options]
         end
         private_class_method :preference_type_hint
@@ -277,6 +299,10 @@ module Spree
             currency: current_currency,
             store: current_store,
             user: current_user,
+            company: params[:company],
+            market: params[:market],
+            channel: params[:channel],
+            country: params[:country],
             quantity: quantity
           )
         end
@@ -295,8 +321,9 @@ module Spree
           return Spree::QuantityRule.new if current_store.nil?
 
           Spree::Current.quantity_rules_resolver_for(
-            company: Spree::Current.standing_company_for(current_user),
-            user: current_user
+            company: params.key?(:company) ? params[:company] : Spree::Current.standing_company_for(current_user),
+            user: current_user,
+            channel: params[:channel]
           ).call(variant)
         end
 

data/app/serializers/spree/api/v3/claim_serializer.rb

@@ -7,7 +7,7 @@ module Spree
       class ClaimSerializer < BaseSerializer
         typelize number: :string,
                  status: [:string, enum: Spree::Claim.statuses, enum_type_name: 'ClaimStatus'],
-                 resolution: [:string, nullable: true],
+                 resolution: [:string, nullable: true, enum: Spree::Claim::RESOLUTIONS, enum_type_name: 'ClaimResolution'],
                  order_id: [:string, nullable: true],
                  reason_id: [:string, nullable: true],
                  approved_at: [:string, nullable: true],

data/app/serializers/spree/api/v3/collection_serializer.rb

@@ -6,7 +6,7 @@ module Spree
       # back-office state exposed only by the Admin serializer.
       class CollectionSerializer < BaseSerializer
         typelize name: :string, permalink: :string, position: :number,
-                 sort_order: :string,
+                 sort_order: [:string, enum: Spree::Collection::SORT_ORDERS, enum_type_name: 'CollectionSortOrder'],
                  meta_title: [:string, nullable: true], meta_description: [:string, nullable: true], meta_keywords: [:string, nullable: true],
                  description: :string, description_html: :string,
                  image_url: [:string, nullable: true], square_image_url: [:string, nullable: true],

data/app/serializers/spree/api/v3/company_invitation_serializer.rb

@@ -4,7 +4,7 @@ module Spree
       # A pending (or spent) invitation into a company node. The token is
       # deliberately absent — it travels only in the invite email.
       class CompanyInvitationSerializer < BaseSerializer
-        typelize email: :string, company_id: :string, status: [:string, enum: %w[pending accepted revoked expired]],
+        typelize email: :string, company_id: :string, status: [:string, enum: %w[pending accepted revoked expired], enum_type_name: 'CompanyInvitationStatus'],
                  expires_at: [:string, nullable: true]
 
         attributes :email, expires_at: :iso8601

data/app/serializers/spree/api/v3/company_serializer.rb

@@ -7,7 +7,7 @@ module Spree
       # back-office fields stay in one place.
       class CompanySerializer < BaseSerializer
         typelize name: :string,
-                 kind: [:string, enum: Spree::Company::KINDS], parent_id: [:string, nullable: true],
+                 kind: [:string, enum: Spree::Company::KINDS, enum_type_name: 'CompanyKind'], parent_id: [:string, nullable: true],
                  po_number_required: :boolean,
                  ancestors: 'Array<{id: string, name: string, kind: string}>'
 

data/app/serializers/spree/api/v3/data_request_confirmation_requested_event_serializer.rb

@@ -0,0 +1,28 @@
+module Spree
+  module Api
+    module V3
+      # The event shape for `data_request.confirmation_requested`: what a
+      # storefront that sends its own emails needs to ask the person to confirm
+      # a request they raised. `confirmation_token` is a live credential, so
+      # the event reaches only endpoints that name it.
+      class DataRequestConfirmationRequestedEventSerializer < DataRequestEventSerializer
+        typelize email: :string, confirmation_token: :string, store_id: :string,
+                 redirect_url: [:string, optional: true]
+
+        attributes :email
+
+        attribute :confirmation_token do
+          params[:confirmation_token]
+        end
+
+        attribute :store_id do |data_request|
+          data_request.store.prefixed_id
+        end
+
+        attribute :redirect_url, if: proc { params[:redirect_url].present? } do
+          params[:redirect_url]
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/data_request_event_serializer.rb

@@ -11,7 +11,7 @@ module Spree
       # log. Subscribers get the fact that a request finished; fetching the
       # file stays an authenticated act by the person it belongs to.
       class DataRequestEventSerializer < BaseSerializer
-        typelize number: :string, kind: [:string, enum: Spree::DataRequest::KINDS], status: [:string, enum: Spree::DataRequest.statuses, enum_type_name: 'DataRequestStatus'],
+        typelize number: :string, kind: [:string, enum: Spree::DataRequest::KINDS, enum_type_name: 'DataRequestKind'], status: [:string, enum: Spree::DataRequest.statuses, enum_type_name: 'DataRequestStatus'],
                  requested_at: [:string, nullable: true],
                  completed_at: [:string, nullable: true]
 

data/app/serializers/spree/api/v3/data_request_serializer.rb

@@ -4,7 +4,7 @@ module Spree
       # Store API Data Request Serializer
       # A customer's own GDPR access or erasure request.
       class DataRequestSerializer < BaseSerializer
-        typelize number: :string, kind: [:string, enum: Spree::DataRequest::KINDS], status: [:string, enum: Spree::DataRequest.statuses, enum_type_name: 'DataRequestStatus'],
+        typelize number: :string, kind: [:string, enum: Spree::DataRequest::KINDS, enum_type_name: 'DataRequestKind'], status: [:string, enum: Spree::DataRequest.statuses, enum_type_name: 'DataRequestStatus'],
                  requested_at: [:string, nullable: true],
                  completed_at: [:string, nullable: true],
                  expires_at: [:string, nullable: true],
@@ -25,11 +25,15 @@ module Spree
         end
 
         # Present only while the file is still there — a link the storefront
-        # can render without having to reason about expiry itself.
-        attribute :download_url do |data_request, params|
+        # can render without having to reason about expiry itself — and only
+        # to a caller holding the confirmation token, never to the signed-in
+        # account, because the export covers guest orders placed at the address
+        # the request names.
+        attribute :download_url do |data_request|
+          next nil unless params[:download_url_visible]
           next nil unless data_request.downloadable?
 
-          host = (params&.dig(:store) || data_request.store)&.formatted_url
+          host = (params[:store] || data_request.store)&.formatted_url
           next nil if host.blank?
 
           Spree::Api::DataRequestUrls.download_url(data_request, host)

data/app/serializers/spree/api/v3/delivery_serializer.rb

@@ -10,7 +10,7 @@ module Spree
                  carrier: [:string, nullable: true],
                  carrier_name: [:string, nullable: true],
                  service: [:string, nullable: true],
-                 status: [:string, enum: Spree::Delivery::STATUSES],
+                 status: [:string, enum: Spree::Delivery::STATUSES, enum_type_name: 'DeliveryStatus'],
                  estimated_delivery_at: [:string, nullable: true],
                  delivered_at: [:string, nullable: true]
 

data/app/serializers/spree/api/v3/delivery_zone_member_serializer.rb

@@ -2,7 +2,7 @@ module Spree
   module Api
     module V3
       class DeliveryZoneMemberSerializer < BaseSerializer
-        typelize member_type: [:string, enum: Spree::DeliveryZoneMember::MEMBER_TYPES], country_code: [:string, nullable: true, enum: Spree::IsoData.country_codes, enum_type_name: 'CountryCode'],
+        typelize member_type: [:string, enum: Spree::DeliveryZoneMember::MEMBER_TYPES, enum_type_name: 'DeliveryZoneMemberType'], country_code: [:string, nullable: true, enum: Spree::IsoData.country_codes, enum_type_name: 'CountryCode'],
                  country_name: [:string, nullable: true],
                  state_code: [:string, nullable: true], state_name: [:string, nullable: true],
                  postal_code_prefix: [:string, nullable: true],

data/app/serializers/spree/api/v3/discount_serializer.rb

@@ -5,7 +5,7 @@ module Spree
       # line item or fulfillment. The embedded `discounts` key on Cart/Order
       # stays the applied-promotion summary — see AppliedPromotionSerializer.
       class DiscountSerializer < BaseSerializer
-        typelize label: :string, kind: [:string, enum: Spree::Discount::KINDS], code: [:string, nullable: true],
+        typelize label: :string, kind: [:string, enum: Spree::Discount::KINDS, enum_type_name: 'DiscountKind'], code: [:string, nullable: true],
                  value: [:string, nullable: true], value_type: [:string, nullable: true],
                  promotion_id: [:string, nullable: true], line_item_id: [:string, nullable: true],
                  fulfillment_id: [:string, nullable: true]

data/app/serializers/spree/api/v3/file_upload_serializer.rb

@@ -15,7 +15,7 @@ module Spree
                  filename: :string,
                  content_type: :string,
                  byte_size: :number,
-                 visibility: [:string, enum: Spree::FileUpload::VISIBILITIES],
+                 visibility: [:string, enum: Spree::FileUpload::VISIBILITIES, enum_type_name: 'FileUploadVisibility'],
                  expires_at: :string,
                  upload: [:FileUploadTarget, nullable: true]
 

data/app/serializers/spree/api/v3/fulfillment_serializer.rb

@@ -4,7 +4,7 @@ module Spree
       class FulfillmentSerializer < BaseSerializer
         typelize number: :string,
                  status: [:string, enum: Spree::Fulfillment.statuses, enum_type_name: 'FulfillmentStatus'],
-                 fulfillment_type: [:string, enum: %w[shipping digital pickup pickup_point]],
+                 fulfillment_type: [:string, enum: %w[shipping digital pickup pickup_point], enum_type_name: 'FulfillmentType'],
                  tracking: [:string, nullable: true], tracking_url: [:string, nullable: true],
                  fulfilled_at: [:string, nullable: true], delivered_at: [:string, nullable: true], unpriced: :boolean,
                  items: 'Array<{ item_id: string; variant_id: string; quantity: number }>',

data/app/serializers/spree/api/v3/media_event_serializer.rb

@@ -7,7 +7,7 @@ module Spree
         # `type` is not exposed: the old Spree::Image/Spree::Video STI collapsed
         # into one class, so the column is a legacy vestige with no subclasses
         # — `media_type` is the discriminator (see MediaSerializer).
-        typelize media_type: [:string, enum: Spree::Media::MEDIA_TYPES], viewable_type: :string,
+        typelize media_type: [:string, enum: Spree::Media::MEDIA_TYPES, enum_type_name: 'MediaType'], viewable_type: :string,
                  viewable_id: :string, position: [:number, nullable: true],
                  alt: [:string, nullable: true]
 

data/app/serializers/spree/api/v3/media_serializer.rb

@@ -5,7 +5,7 @@ module Spree
         typelize position: :number, alt: [:string, nullable: true],
                  product_id: [:string, nullable: true],
                  variant_ids: [:string, multi: true],
-                 media_type: [:string, enum: Spree::Media::MEDIA_TYPES],
+                 media_type: [:string, enum: Spree::Media::MEDIA_TYPES, enum_type_name: 'MediaType'],
                  focal_point_x: [:number, nullable: true],
                  focal_point_y: [:number, nullable: true],
                  external_video_url: [:string, nullable: true],

data/app/serializers/spree/api/v3/newsletter_subscriber_serializer.rb

@@ -16,7 +16,11 @@ module Spree
           subscriber.verified_at&.iso8601
         end
 
-        prefixed_id_attributes :customer
+        # Shown to the account's owner only: for anyone else, posting an email
+        # must not tell them whether an account exists for it.
+        attribute :customer_id do |subscriber|
+          subscriber.customer&.prefixed_id if current_user && subscriber.customer_id == current_user.id
+        end
       end
     end
   end

data/app/serializers/spree/api/v3/option_type_serializer.rb

@@ -2,7 +2,7 @@ module Spree
   module Api
     module V3
       class OptionTypeSerializer < BaseSerializer
-        typelize name: :string, label: :string, position: :number, kind: [:string, enum: Spree::OptionType::KINDS]
+        typelize name: :string, label: :string, position: :number, kind: [:string, enum: Spree::OptionType::KINDS, enum_type_name: 'OptionTypeKind']
 
         attributes :name, :label, :position, :kind
       end

data/app/serializers/spree/api/v3/order_group_serializer.rb

@@ -9,8 +9,8 @@ module Spree
       # inside it, each carrying its own items, delivery and tracking.
       class OrderGroupSerializer < BaseSerializer
         typelize number: :string, email: [:string, nullable: true], currency: [:string, enum: Spree::Money::Rounding::CURRENCY_CODES, enum_type_name: 'CurrencyCode'],
-                 fulfillment_status: [:string, nullable: true, enum: Spree::Order::FULFILLMENT_STATUSES],
-                 payment_status: [:string, nullable: true, enum: Spree::Order::PAYMENT_STATUSES],
+                 fulfillment_status: [:string, nullable: true, enum: Spree::Order::FULFILLMENT_STATUSES, enum_type_name: 'OrderFulfillmentStatus'],
+                 payment_status: [:string, nullable: true, enum: Spree::Order::PAYMENT_STATUSES, enum_type_name: 'OrderPaymentStatus'],
                  completed_at: [:string, nullable: true],
                  billing_address: { nullable: true }, shipping_address: { nullable: true }
 

data/app/serializers/spree/api/v3/order_serializer.rb

@@ -11,10 +11,11 @@ module Spree
                  po_document_filename: [:string, nullable: true], po_document_byte_size: ['number | null'],
                  currency: [:string, enum: Spree::Money::Rounding::CURRENCY_CODES, enum_type_name: 'CurrencyCode'], locale: [:string, nullable: true, enum: Spree::Locales::ALL, enum_type_name: 'LocaleCode'], total_quantity: :number,
                  coupon_code: [:string, nullable: true],
-                 fulfillment_status: [:string, nullable: true, enum: Spree::Order::FULFILLMENT_STATUSES],
-                 payment_status: [:string, nullable: true, enum: Spree::Order::PAYMENT_STATUSES],
+                 fulfillment_status: [:string, nullable: true, enum: Spree::Order::FULFILLMENT_STATUSES, enum_type_name: 'OrderFulfillmentStatus'],
+                 payment_status: [:string, nullable: true, enum: Spree::Order::PAYMENT_STATUSES, enum_type_name: 'OrderPaymentStatus'],
                  completed_at: [:string, nullable: true],
                  withdrawal_period_ends_at: [:string, nullable: true], within_withdrawal_period: :boolean,
+                 shipping_eq_billing_address: :boolean,
                  billing_address: { nullable: true }, shipping_address: { nullable: true },
                  gift_card: { nullable: true }, market: { nullable: true }
 
@@ -28,6 +29,7 @@ module Spree
         end
 
         attribute :within_withdrawal_period, &:within_withdrawal_period?
+        attribute :shipping_eq_billing_address, &:shipping_eq_billing_address?
 
         # The checkout handle this order was born from (nil for admin drafts).
         # Lets abandonment tooling match cart.* events to the conversion.

data/app/serializers/spree/api/v3/payment_serializer.rb

@@ -4,7 +4,7 @@ module Spree
       class PaymentSerializer < BaseSerializer
         typelize status: [:string, enum: Spree::Payment.statuses, enum_type_name: 'PaymentStatus'],
                  payment_method_id: :string, response_code: [:string, nullable: true], number: :string,
-                 source_type: [:string, nullable: true, enum: %w[credit_card store_credit payment_source]],
+                 source_type: [:string, nullable: true, enum: %w[credit_card store_credit payment_source], enum_type_name: 'PaymentSourceType'],
                  source_id: [:string, nullable: true], source: 'CreditCard | StoreCredit | PaymentSource | null'
 
         prefixed_id_attributes :payment_method

data/app/serializers/spree/api/v3/product_filter_availability_option_serializer.rb

@@ -2,7 +2,7 @@ module Spree
   module Api
     module V3
       class ProductFilterAvailabilityOptionSerializer < BaseSerializer
-        typelize id: [:string, enum: %w[in_stock out_of_stock]], count: :number
+        typelize id: [:string, enum: %w[in_stock out_of_stock], enum_type_name: 'StockAvailability'], count: :number
 
         attributes :id, :count
       end

data/app/serializers/spree/api/v3/product_filter_option_serializer.rb

@@ -6,7 +6,7 @@ module Spree
                  type: "'option'",
                  name: :string,
                  label: :string,
-                 kind: [:string, enum: Spree::OptionType::KINDS],
+                 kind: [:string, enum: Spree::OptionType::KINDS, enum_type_name: 'OptionTypeKind'],
                  options: [:ProductFilterOptionValue, multi: true]
 
         attributes :id, :type, :name, :label, :kind

data/app/serializers/spree/api/v3/seller/address_serializer.rb

@@ -3,8 +3,9 @@ module Spree
     module V3
       module Seller
         class AddressSerializer < V3::AddressSerializer
-          # The Store API keeps these deprecated names until 6.1.
-          %i[state_abbr country_iso].each { |key| _attributes.delete(key) }
+          # The Store API keeps these deprecated names until 6.1. A seller
+          # keeps no address book of the buyer's, so has no owner to read.
+          %i[state_abbr country_iso owner].each { |key| _attributes.delete(key) }
         end
       end
     end

data/app/serializers/spree/api/v3/seller/digital_asset_serializer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      module Seller
+        # A downloadable file on a seller's own product. Leaves out the
+        # provider's settings: they configure the operator's own systems, not
+        # the seller's listing.
+        class DigitalAssetSerializer < V3::DigitalAssetSerializer
+          include Spree::Api::V3::DigitalAssetDetails
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/seller/order_serializer.rb

@@ -23,9 +23,9 @@ module Spree
         class OrderSerializer < V3::BaseSerializer
           typelize number: :string, customer_note: [:string, nullable: true], currency: [:string, enum: Spree::Money::Rounding::CURRENCY_CODES, enum_type_name: 'CurrencyCode'],
                    total_quantity: :number,
-                   fulfillment_status: [:string, nullable: true, enum: Spree::Order::FULFILLMENT_STATUSES],
-                   payment_status: [:string, nullable: true, enum: Spree::Order::PAYMENT_STATUSES],
-                   status: [:string, enum: Spree::Order::STATUSES], canceled_at: [:string, nullable: true],
+                   fulfillment_status: [:string, nullable: true, enum: Spree::Order::FULFILLMENT_STATUSES, enum_type_name: 'OrderFulfillmentStatus'],
+                   payment_status: [:string, nullable: true, enum: Spree::Order::PAYMENT_STATUSES, enum_type_name: 'OrderPaymentStatus'],
+                   status: [:string, enum: Spree::Order::STATUSES, enum_type_name: 'OrderStatus'], canceled_at: [:string, nullable: true],
                    cancel_reason_name: [:string, nullable: true], cancel_note: [:string, nullable: true],
                    internal_note: [:string, nullable: true], internal_note_html: [:string, nullable: true]
 

data/app/serializers/spree/api/v3/seller/package_type_serializer.rb

@@ -15,14 +15,14 @@ module Spree
         # refuses to write them (docs/plans/6.0-seller-package-types.md).
         class PackageTypeSerializer < V3::BaseSerializer
           typelize name: :string,
-                   kind: [:string, enum: Spree::PackageType::KINDS],
+                   kind: [:string, enum: Spree::PackageType::KINDS, enum_type_name: 'PackageTypeKind'],
                    length: [:string, nullable: true],
                    width: [:string, nullable: true],
                    height: [:string, nullable: true],
-                   dimensions_unit: [:string, enum: Spree::Variant::DIMENSION_UNITS],
+                   dimensions_unit: [:string, enum: Spree::Variant::DIMENSION_UNITS, enum_type_name: 'DimensionUnit'],
                    weight: [:string, nullable: true],
                    max_weight: [:string, nullable: true],
-                   weight_unit: [:string, enum: Spree::Variant::WEIGHT_UNITS],
+                   weight_unit: [:string, enum: Spree::Variant::WEIGHT_UNITS, enum_type_name: 'WeightUnit'],
                    volume: [:string, nullable: true],
                    default: :boolean,
                    editable: :boolean,

data/app/serializers/spree/api/v3/seller/payout_serializer.rb

@@ -22,8 +22,8 @@ module Spree
           # How many earnings this settlement covers. Read from a count the
           # controller made for the whole page when there is one; a single
           # payout read falls back to asking for its own.
-          attribute(:transfers_count) do |payout, params|
-            counts = params && params[:transfer_counts]
+          attribute(:transfers_count) do |payout|
+            counts = params[:transfer_counts]
 
             counts ? counts.fetch(payout.id, 0) : payout.transfers.count
           end

data/app/serializers/spree/api/v3/seller/profile_serializer.rb

@@ -8,8 +8,8 @@ module Spree
                    registration_number: [:string, nullable: true],
                    contact_email: [:string, nullable: true],
                    billing_email: [:string, nullable: true],
-                   tax_remittance: :string,
-                   payouts_schedule_interval: [:string, nullable: true],
+                   tax_remittance: [:string, enum: Spree::Seller::TAX_REMITTANCES, enum_type_name: 'TaxRemittance'],
+                   payouts_schedule_interval: [:string, nullable: true, enum: Spree::Seller::PAYOUT_INTERVALS, enum_type_name: 'PayoutScheduleInterval'],
                    minimum_payout_amount: [:string, nullable: true],
                    holiday_mode_until: [:string, nullable: true],
                    terms_accepted_at: [:string, nullable: true],

data/app/serializers/spree/api/v3/seller/requirement_status_serializer.rb

@@ -8,7 +8,7 @@ module Spree
 
           typelize id: :string, kind: [:string, comment: 'Requirement kind. Built-in: accept_terms, complete_profile, billing_address, returns_address, delivery_method, package_type, minimum_products, payout_account, required_custom_fields, policy, attestation, operator_review, document. Extensions may register more.'], name: :string,
                    description: [:string, nullable: true],
-                   required: :boolean, position: :number, status: [:string, enum: Spree::SellerRequirementStatus::STATUSES],
+                   required: :boolean, position: :number, status: [:string, enum: Spree::SellerRequirementStatus::STATUSES, enum_type_name: 'SellerRequirementState'],
                    blocking: :boolean, action_url: [:string, nullable: true],
                    blocker: ['{ state: string; message: string | null } | null'],
                    accepts_submissions: :boolean, requires_file: :boolean,

data/app/serializers/spree/api/v3/seller/store_serializer.rb

@@ -0,0 +1,18 @@
+module Spree
+  module Api
+    module V3
+      module Seller
+        # What a seller may know about the marketplace they sell on: its name,
+        # and the settings that shape what the panel lets them do.
+        class StoreSerializer < V3::BaseSerializer
+          typelize name: :string
+
+          attributes :name
+
+          preference_attributes Spree::Store, :seller_digital_assets_enabled, :seller_digital_asset_content_types,
+                                              :review_seller_digital_asset_changes
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/seller/tax_identifier_serializer.rb

@@ -4,7 +4,7 @@ module Spree
       module Seller
         class TaxIdentifierSerializer < V3::BaseSerializer
           typelize kind: [:string, comment: 'Tax identifier kind, keyed to a registered validator. Built-in: eu_vat. Extensions may register more.'], value: :string,
-                   validation_status: [:string, nullable: true, enum: Spree::TaxIdentifier::VALIDATION_STATUSES],
+                   validation_status: [:string, nullable: true, enum: Spree::TaxIdentifier::VALIDATION_STATUSES, enum_type_name: 'TaxIdentifierValidationStatus'],
                    validated_at: [:string, nullable: true]
 
           attributes :kind, :value, :validation_status, validated_at: :iso8601

data/app/serializers/spree/api/v3/seller/variant_serializer.rb

@@ -25,7 +25,7 @@ module Spree
                    country_of_origin: [:string, nullable: true, enum: Spree::IsoData.country_codes, enum_type_name: 'CountryCode'],
                    customs_description: [:string, nullable: true],
                    minimum_order_quantity: ['number | null'], order_multiple: ['number | null'],
-                   purchase_unit: [:string, nullable: true, enum: Spree::Variant::PURCHASE_UNITS],
+                   purchase_unit: [:string, nullable: true, enum: Spree::Variant::PURCHASE_UNITS, enum_type_name: 'PurchaseUnit'],
                    metadata: 'Record<string, unknown>'
 
           attributes :metadata, :position, :cost_currency,

data/app/serializers/spree/api/v3/shipping_label_event_serializer.rb

@@ -6,7 +6,7 @@ module Spree
       # stay behind the Admin API.
       class ShippingLabelEventSerializer < BaseSerializer
         typelize owner_id: :string,
-                 owner_type: [:string, enum: %w[fulfillment return]],
+                 owner_type: [:string, enum: %w[fulfillment return], enum_type_name: 'ShippingLabelOwnerType'],
                  status: [:string, enum: Spree::ShippingLabel.statuses, enum_type_name: 'ShippingLabelStatus'],
                  carrier: [:string, nullable: true],
                  service: [:string, nullable: true],

data/app/serializers/spree/api/v3/stock_movement_serializer.rb

@@ -7,7 +7,7 @@ module Spree
         # `kind` is nullable for the lifetime of 6.0: a legacy row on an
         # install that has not run spree:migrate_stock_movements_to_typed_rows
         # has no kind yet.
-        typelize quantity: :number, kind: [:string, nullable: true, enum: Spree::StockMovement::KINDS],
+        typelize quantity: :number, kind: [:string, nullable: true, enum: Spree::StockMovement::KINDS, enum_type_name: 'StockMovementKind'],
                  reason: [:string, nullable: true], stock_level_id: [:string, nullable: true]
 
         attributes :quantity, :kind, :reason,

data/app/serializers/spree/api/v3/stock_receipt_event_serializer.rb

@@ -6,7 +6,7 @@ module Spree
       class StockReceiptEventSerializer < BaseSerializer
         typelize number: :string,
                  received_at: :string,
-                 receivable_type: [:string, enum: %w[purchase_order stock_transfer]],
+                 receivable_type: [:string, enum: %w[purchase_order stock_transfer], enum_type_name: 'StockReceiptReceivableType'],
                  receivable_id: :string,
                  quantity_accepted_total: :number,
                  quantity_rejected_total: :number

data/app/serializers/spree/api/v3/variant_serializer.rb

@@ -10,11 +10,11 @@ module Spree
                  purchasable: :boolean, in_stock: :boolean, backorderable: :boolean, preorder: :boolean,
                  preorder_ships_at: [:string, nullable: true],
                  weight: [:number, nullable: true], height: [:number, nullable: true], width: [:number, nullable: true], depth: [:number, nullable: true],
-                 weight_unit: [:string, enum: Spree::Variant::WEIGHT_UNITS], dimensions_unit: [:string, enum: Spree::Variant::DIMENSION_UNITS],
+                 weight_unit: [:string, enum: Spree::Variant::WEIGHT_UNITS, enum_type_name: 'WeightUnit'], dimensions_unit: [:string, enum: Spree::Variant::DIMENSION_UNITS, enum_type_name: 'DimensionUnit'],
                  price: 'Price',
                  original_price: ['Price', nullable: true],
                  minimum_order_quantity: :number, order_multiple: :number,
-                 purchase_unit: [:string, enum: Spree::Variant::PURCHASE_UNITS], units_per_carton: ['number | null'],
+                 purchase_unit: [:string, enum: Spree::Variant::PURCHASE_UNITS, enum_type_name: 'PurchaseUnit'], units_per_carton: ['number | null'],
                  seller_id: [:string, nullable: true]
 
         prefixed_id_attributes :product

data/app/services/spree/api/v3/filter_table.rb

@@ -25,6 +25,17 @@ module Spree
           boolean: 'boolean'
         }.freeze
 
+        # Columns holding a value from one of the closed code lists the API
+        # publishes as a shared type, matched by name (`locale`,
+        # `default_locale`, `cost_currency`), so clients filter with that type,
+        # not free text.
+        CODE_TYPES = {
+          'locale' => 'LocaleCode',
+          'currency' => 'CurrencyCode',
+          'country_code' => 'CountryCode',
+          'country_of_origin' => 'CountryCode'
+        }.freeze
+
         # Raised when an endpoint's table cannot be described — a column of a
         # kind the contract has no predicates for, or two models sharing a name.
         class Error < StandardError; end
@@ -124,8 +135,9 @@ module Spree
           self.class.name_for(model)
         end
 
-        # @return [Hash{String => String, Hash}] attribute => value kind, or
-        #   `{ 'enum' => [values] }` for a status
+        # @return [Hash{String => String, Hash}] attribute => value kind,
+        #   `{ 'enum' => [values] }` for a status, or `{ 'code' => type }` for
+        #   a value from a shared code list
         def attributes
           @attributes ||= kinds.reject { |_, kind| kind == :unclassified }.compact
         end
@@ -210,6 +222,10 @@ module Spree
         #   attribute the model does not have (`position` on a table without
         #   one), `:unclassified` for one the contract cannot describe
         def attribute_kind(attribute)
+          if (code_type = code_type(attribute))
+            return { 'code' => code_type }
+          end
+
           aliased = model._ransack_aliases[attribute] || model.attribute_aliases[attribute]
           return attribute_kind(aliased) if aliased
           return ransacker_kind(model._ransackers[attribute]) if model._ransackers.key?(attribute)
@@ -220,7 +236,6 @@ module Spree
           if (values = inclusion_values(attribute))
             return { 'enum' => values }
           end
-
           column = model.columns_hash[attribute]
           return COLUMN_KINDS.fetch(column.type, :unclassified) if column
           return 'text' if translated_attribute?(attribute)
@@ -229,6 +244,10 @@ module Spree
           :unclassified
         end
 
+        def code_type(attribute)
+          CODE_TYPES.find { |name, _| attribute == name || attribute.end_with?("_#{name}") }&.last
+        end
+
         # The fixed list an inclusion validation allows, for a column that
         # holds one of a known set of values (`payment_status`, `kind`).
         def inclusion_values(attribute)