spree_api 5.6.1 → 6.0.0.beta1

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

@@ -11,11 +11,11 @@ module Spree
           attributes created_at: :iso8601, updated_at: :iso8601
 
           attribute :storefront_visible do |custom_field|
-            custom_field.metafield_definition.available_on_front_end?
+            custom_field.custom_field_definition.storefront_visible
           end
 
           attribute :custom_field_definition_id do |custom_field|
-            custom_field.metafield_definition.prefixed_id
+            custom_field.custom_field_definition.prefixed_id
           end
         end
       end

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

@@ -5,12 +5,9 @@ module Spree
         # Admin API Customer Serializer
         # Full customer data including admin-only fields
         class CustomerSerializer < V3::CustomerSerializer
-          typelize login: [:string, nullable: true],
-                   last_sign_in_at: [:string, nullable: true], current_sign_in_at: [:string, nullable: true],
-                   sign_in_count: :number, failed_attempts: :number,
-                   last_sign_in_ip: [:string, nullable: true], current_sign_in_ip: [:string, nullable: true],
+          typelize failed_attempts: :number,
                    tags: [:string, multi: true],
-                   internal_note_html: [:string, nullable: true],
+                   internal_note: [:string, nullable: true], internal_note_html: [:string, nullable: true],
                    metadata: 'Record<string, unknown>',
                    orders_count: :number,
                    total_spent: :string,
@@ -18,35 +15,33 @@ module Spree
                    last_order_completed_at: [:string, nullable: true],
                    default_billing_address_id: [:string, nullable: true],
                    default_shipping_address_id: [:string, nullable: true],
-                   customer_group_ids: [:string, multi: true]
+                   customer_group_ids: [:string, multi: true],
+                   email_marketing_consent_source: [:string, nullable: true],
+                   anonymized_at: [:string, nullable: true],
+                   anonymized: :boolean
 
           # Admin-only attributes
-          attributes :login, :metadata,
-                     last_sign_in_at: :iso8601, current_sign_in_at: :iso8601,
+          attributes :failed_attempts, :metadata, :email_marketing_consent_source,
                      created_at: :iso8601, updated_at: :iso8601
 
-          attribute :sign_in_count do |user|
-            user.sign_in_count
+          attribute :anonymized_at do |user|
+            user.anonymized_at&.iso8601
           end
 
-          attribute :failed_attempts do |user|
-            user.failed_attempts
-          end
-
-          attribute :last_sign_in_ip do |user|
-            user.last_sign_in_ip
-          end
-
-          attribute :current_sign_in_ip do |user|
-            user.current_sign_in_ip
+          attribute :anonymized do |user|
+            user.anonymized?
           end
 
           attribute :tags do |user|
             user.tags.map(&:name) # not pluck as we preload tags
           end
 
+          attribute :internal_note do |user|
+            user.respond_to?(:internal_note) ? Spree::RichTextHelper.to_plain_text(user.internal_note).presence : nil
+          end
+
           attribute :internal_note_html do |user|
-            user.respond_to?(:internal_note) ? user.internal_note&.body&.to_s.presence : nil
+            user.respond_to?(:internal_note) ? user.internal_note.presence : nil
           end
 
           attribute :default_billing_address_id do |user|
@@ -71,7 +66,7 @@ module Spree
 
           attribute :display_total_spent do |user|
             amount = user.attributes['total_spent'] || user.orders.complete.sum(:total)
-            currency = Spree::Current.currency || Spree::Current.store&.default_currency || Spree::Config[:currency]
+            currency = Spree::Current.currency || Spree::Current.store&.default_currency
             Spree::Money.new(amount, currency: currency).to_s
           end
 
@@ -110,6 +105,12 @@ module Spree
           many :customer_groups,
                resource: proc { Spree.api.admin_customer_group_serializer },
                if: proc { expand?('customer_groups') }
+
+          # Membership rows only — standing over a parent is a question for the
+          # standing filter, not a claim of membership.
+          many :companies,
+               resource: proc { Spree.api.admin_company_serializer },
+               if: proc { expand?('companies') }
         end
       end
     end

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

@@ -0,0 +1,24 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        # One home-screen counter, as evaluated for the caller. A value
+        # object, so it carries no id: `key` is the registered counter name,
+        # and it carries no copy either — the dashboard owns every string it
+        # shows and translates the key in its own locale.
+        class DashboardCounterSerializer
+          include Alba::Resource
+          include Typelizer::DSL
+
+          typelize key: [:string, comment: 'Registered counter name. The dashboard translates it; built-in: orders_to_fulfill, payments_to_collect, open_returns, open_exchanges, open_claims, low_stock_items, out_of_stock_items.'],
+                   value: :number,
+                   link: ['{ resource: string; filters: Array<{ field: string; operator: string; value: string }> } | null',
+                          comment: 'The list filter that shows exactly the rows counted, or null when no list can.'],
+                   nav: [:string, nullable: true, comment: 'Sidebar entry key this count badges, or null.']
+
+          attributes :key, :value, :link, :nav
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        # Admin API Data Request Serializer
+        class DataRequestSerializer < V3::DataRequestSerializer
+          # The inherited link needs no authentication of its own, so rendering
+          # it here would hand the whole export to anyone who can list requests
+          # — `read_customers` alone, rather than the four permissions the
+          # export action asks for. Staff download through that action instead.
+          # This is the same reasoning that keeps the link out of event
+          # payloads and the webhook delivery log.
+          _attributes.delete(:download_url)
+
+          typelize email: :string,
+                   error_message: [:string, nullable: true],
+                   customer_id: [:string, nullable: true],
+                   requested_by_id: [:string, nullable: true]
+
+          attributes :email, :error_message, created_at: :iso8601, updated_at: :iso8601
+
+          attribute :customer_id do |data_request|
+            data_request.customer&.prefixed_id
+          end
+
+          # Null when the subject asked for it themselves.
+          attribute :requested_by_id do |data_request|
+            data_request.requested_by&.prefixed_id
+          end
+
+          one :customer, resource: proc { Spree.api.admin_customer_serializer }, if: proc { expand?('customer') }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class DeliveryMethodRuleSerializer < BaseSerializer
+          typelize type: [:string, comment: 'Rule type. Built-in: item_total_rule, weight_rule, excluded_products_rule, channel_rule, volume_rule, company_rule. Extensions may register more.'],
+                   active: :boolean,
+                   preferences: 'Record<string, unknown>',
+                   preference_schema: "Array<{ key: string; type: string; default: unknown; choices?: string[] }>",
+                   product_ids: [:string, multi: true]
+
+          attributes :active, created_at: :iso8601, updated_at: :iso8601
+
+          # Wire shorthand (e.g. `item_total_rule`), matching the types
+          # discovery endpoint.
+          attribute :type do |rule|
+            rule.class.api_type
+          end
+
+          attribute :preferences, &:serialized_preferences
+          attribute :preference_schema, &:serialized_preference_schema
+
+          # Association-backed config (ExcludedProductsRule); empty for
+          # preference-only rules. Same name read and written.
+          attribute :product_ids do |rule|
+            rule.respond_to?(:product_prefixed_ids) ? rule.product_prefixed_ids : []
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,72 @@ module Spree
     module V3
       module Admin
         class DeliveryMethodSerializer < V3::DeliveryMethodSerializer
-          attributes created_at: :iso8601, updated_at: :iso8601
+          typelize admin_name: [:string, nullable: true],
+                   fulfillment_provider: :string, pickup_point_provider: [:string, nullable: true],
+                   rate_provider: [:string, nullable: true],
+                   storefront_visible: :boolean, tracking_url: [:string, nullable: true],
+                   tax_category_id: [:string, nullable: true],
+                   delivery_profile_id: :string,
+                   delivery_origin_group_id: [:string, nullable: true],
+                   delivery_zone_id: [:string, nullable: true],
+                   stock_location_ids: [:string, multi: true],
+                   calculator_type: [:string, nullable: true],
+                   calculator_preferences: ['Record<string, unknown>', nullable: true],
+                   markup_flat: [:string, nullable: true],
+                   markup_percent: [:string, nullable: true],
+                   available_to_sellers: :boolean,
+                   seller_id: [:string, nullable: true],
+                   seller_name: [:string, nullable: true]
+
+          attributes :admin_name, :fulfillment_provider, :pickup_point_provider,
+                     :rate_provider, :storefront_visible, :tracking_url,
+                     :markup_flat, :markup_percent, :available_to_sellers,
+                     created_at: :iso8601, updated_at: :iso8601, deleted_at: :iso8601
+
+          # Which seller runs this method, so the operator's list can say
+          # whose it is. Null is the marketplace's own
+          # (docs/plans/6.0-multi-vendor-marketplace.md, Decision 13).
+          attribute :seller_id do |record|
+            record.seller&.prefixed_id
+          end
+
+          attribute :seller_name do |record|
+            record.seller&.name
+          end
+
+          many :services, resource: proc { Spree.api.admin_delivery_method_service_serializer }
+
+          # Embedded so a list of methods can be summarized by their
+          # eligibility without a request per method.
+          many :delivery_method_rules, key: :rules, resource: proc { Spree.api.admin_delivery_method_rule_serializer }
+
+          attribute :tax_category_id do |record|
+            record.tax_category&.prefixed_id
+          end
+
+          attribute :delivery_profile_id do |record|
+            record.delivery_profile&.prefixed_id
+          end
+
+          attribute :delivery_origin_group_id do |record|
+            record.delivery_origin_group&.prefixed_id
+          end
+
+          attribute :delivery_zone_id do |record|
+            record.delivery_zone&.prefixed_id
+          end
+
+          attribute :stock_location_ids do |record|
+            record.pickup_locations.map(&:prefixed_id)
+          end
+
+          attribute :calculator_type do |record|
+            record.calculator&.class&.api_type
+          end
+
+          attribute :calculator_preferences do |record|
+            record.calculator.respond_to?(:serialized_preferences) ? record.calculator.serialized_preferences : record.calculator&.preferences
+          end
         end
       end
     end

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

@@ -0,0 +1,15 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class DeliveryMethodServiceSerializer < BaseSerializer
+          typelize carrier: :string, service: :string, label: [:string, nullable: true],
+                   markup_flat: [:string, nullable: true], markup_percent: [:string, nullable: true],
+                   position: :number
+
+          attributes :carrier, :service, :label, :markup_flat, :markup_percent, :position
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class DeliveryOriginGroupSerializer < BaseSerializer
+          typelize name: [:string, nullable: true], position: [:number, nullable: true],
+                   delivery_profile_id: :string,
+                   stock_location_ids: [:string, multi: true],
+                   delivery_zones_count: :number, delivery_methods_count: :number
+
+          attributes :name, :position,
+                     created_at: :iso8601, updated_at: :iso8601
+
+          attribute :delivery_profile_id do |record|
+            record.delivery_profile&.prefixed_id
+          end
+
+          # Empty means every store location.
+          attribute :stock_location_ids do |record|
+            record.stock_locations.map(&:prefixed_id)
+          end
+
+          attribute :delivery_zones_count do |record|
+            record.delivery_zones.count
+          end
+
+          attribute :delivery_methods_count do |record|
+            record.delivery_methods.count
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class DeliveryProfileSerializer < BaseSerializer
+          typelize name: :string, default: :boolean, position: [:number, nullable: true],
+                   kind: [:string, comment: 'Profile kind. Built-in: shipping, digital. Extensions may register more.'],
+                   digital: :boolean,
+                   offers_pickup: :boolean, offers_shipping: :boolean,
+                   stock_location_ids: [:string, multi: true],
+                   origin_groups: ['Array<{ id: string; name: string | null; position: number | null; stock_location_ids: Array<string> }>'],
+                   products_count: :number, delivery_methods_count: :number,
+                   delivery_zones_count: :number
+
+          attributes :name, :default, :position,
+                     created_at: :iso8601, updated_at: :iso8601
+
+          # The STI class in wire form (`shipping`, `digital`, extension
+          # kinds), so clients never parse Ruby class names.
+          attribute :kind do |record|
+            record.class.api_type
+          end
+
+          attribute :digital, &:digital?
+
+          # Capability badges for admin lists: which products can be collected
+          # or shipped is decided by the profile's method set, never declared.
+          attribute :offers_pickup, &:offers_pickup?
+          attribute :offers_shipping, &:offers_shipping?
+
+          # The default origin group's members — the simple-store surface.
+          # Empty means every store location fulfills this profile.
+          attribute :stock_location_ids do |record|
+            record.default_origin_group&.stock_locations&.map(&:prefixed_id) || []
+          end
+
+          # Origin groups partition the profile's fulfillment origins; zones
+          # and methods reference one. A null name renders as "All locations".
+          attribute :origin_groups do |record|
+            record.delivery_origin_groups.map do |group|
+              {
+                id: group.prefixed_id,
+                name: group.name,
+                position: group.position,
+                stock_location_ids: group.stock_locations.map(&:prefixed_id)
+              }
+            end
+          end
+
+          attribute :products_count do |record|
+            record.products.count
+          end
+
+          attribute :delivery_methods_count do |record|
+            record.delivery_methods.count
+          end
+
+          attribute :delivery_zones_count do |record|
+            record.delivery_zones.count
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,9 +3,18 @@ module Spree
     module V3
       module Admin
         class DeliveryRateSerializer < V3::DeliveryRateSerializer
+          typelize metadata: ['Record<string, unknown>', nullable: true]
+
+          # Raw carrier payload (quote ids, service codes) — operational
+          # detail a customer must never see.
+          attributes :metadata
           attributes created_at: :iso8601, updated_at: :iso8601
 
-          one :shipping_method, key: :delivery_method, resource: proc { Spree.api.admin_delivery_method_serializer }, if: proc { expand?('delivery_method') }
+          one :delivery_method, resource: proc { Spree.api.admin_delivery_method_serializer }, if: proc { expand?('delivery_method') }
+
+          # An admin twin, so this package carries its own type rather
+          # than importing the store one.
+          one :freight_summary, resource: proc { Spree.api.admin_freight_summary_serializer }
         end
       end
     end

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

@@ -0,0 +1,20 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class DeliverySerializer < V3::DeliverySerializer
+          typelize shipping_label_id: [:string, nullable: true],
+                   details: ['Record<string, unknown>', nullable: true]
+
+          # The raw carrier payload — scan history, signature, failure reason.
+          # Operational detail, so admin-only.
+          attributes :details, created_at: :iso8601, updated_at: :iso8601
+
+          attribute :shipping_label_id do |delivery|
+            delivery.shipping_label&.prefixed_id
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class DeliveryZoneMemberSerializer < V3::DeliveryZoneMemberSerializer
+          attributes created_at: :iso8601, updated_at: :iso8601
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class DeliveryZoneSerializer < V3::DeliveryZoneSerializer
+          typelize delivery_method_ids: [:string, multi: true],
+                   delivery_profile_id: :string,
+                   delivery_origin_group_id: [:string, nullable: true]
+
+          attributes created_at: :iso8601, updated_at: :iso8601
+
+          attribute :delivery_profile_id do |record|
+            record.delivery_profile&.prefixed_id
+          end
+
+          attribute :delivery_origin_group_id do |record|
+            record.delivery_origin_group&.prefixed_id
+          end
+
+          attribute :delivery_method_ids do |record|
+            record.delivery_methods.map(&:prefixed_id)
+          end
+
+          many :members, resource: proc { Spree.api.admin_delivery_zone_member_serializer }, if: proc { expand?('members') }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      module Admin
+        class DigitalAssetSerializer < V3::DigitalAssetSerializer
+          typelize byte_size: [:number, nullable: true],
+                   authorized_clicks: [:number, nullable: true],
+                   authorized_days: [:number, nullable: true],
+                   effective_authorized_clicks: :number,
+                   effective_authorized_days: :number,
+                   provider_type: [:string, nullable: true],
+                   provider_name: [:string, comment: 'Digital asset provider name. Built-in: File. Extensions may register more.'],
+                   provider_settings: 'Record<string, unknown>',
+                   download_url: [:string, nullable: true]
+
+          attributes :authorized_clicks, :authorized_days, :byte_size, :provider_type, :provider_settings
+          attributes created_at: :iso8601, updated_at: :iso8601
+
+          # Human-readable source for the admin listing. Blank provider_type is
+          # the uploaded-file default, so this reads "File" there.
+          attribute :provider_name do |digital_asset|
+            digital_asset.provider_class.provider_name
+          end
+
+          # Lets a merchant check what they actually uploaded. Short-lived and
+          # admin-only: this is the file itself, not a customer's download
+          # grant, so it carries no counter and spends nobody's allowance.
+          # Nil for a provider-backed asset (no file to preview) and outside a
+          # request (the Disk service needs a host only a controller supplies).
+          attribute :download_url do |digital_asset, params|
+            next nil unless digital_asset.downloadable?
+
+            store = params&.dig(:store) || Spree::Current.store || digital_asset.store
+            begin
+              digital_asset.download_url(expires_in: store.preferred_digital_asset_link_expire_time.seconds)
+            rescue ArgumentError
+              nil
+            end
+          end
+
+          # The limits actually applied, after the store-settings fallback. The
+          # request's store answers it — an admin request always carries one;
+          # the asset's own store covers serialization outside a request.
+          attribute :effective_authorized_clicks do |digital_asset, params|
+            store = params&.dig(:store) || Spree::Current.store || digital_asset.store
+            digital_asset.effective_authorized_clicks(store)
+          end
+
+          attribute :effective_authorized_days do |digital_asset, params|
+            store = params&.dig(:store) || Spree::Current.store || digital_asset.store
+            digital_asset.effective_authorized_days(store)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,11 +3,10 @@ module Spree
     module V3
       module Admin
         class DiscountSerializer < V3::DiscountSerializer
-          # The Admin API has no guest gating — money fields inherited from the
-          # store serializer are always present, so override their nullability.
-          typelize amount: [:string, nullable: false], display_amount: [:string, nullable: false]
+          typelize amount: [:string, nullable: false], display_amount: [:string, nullable: false],
+                   metadata: ['Record<string, unknown>', nullable: true]
 
-          attributes created_at: :iso8601, updated_at: :iso8601
+          attributes :metadata, created_at: :iso8601, updated_at: :iso8601
         end
       end
     end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      module Admin
+        class ExchangeLineItemSerializer < V3::ExchangeLineItemSerializer
+          attributes created_at: :iso8601, updated_at: :iso8601
+
+          one :original_variant, resource: proc { Spree.api.admin_variant_serializer }, if: proc { expand?('original_variant') }
+          one :new_variant, resource: proc { Spree.api.admin_variant_serializer }, if: proc { expand?('new_variant') }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      module Admin
+        class ExchangeSerializer < V3::ExchangeSerializer
+          typelize memo: [:string, nullable: true],
+                   metadata: 'Record<string, unknown>',
+                   stock_location_id: [:string, nullable: true],
+                   created_by_id: [:string, nullable: true]
+
+          attributes :memo, :metadata, created_at: :iso8601, updated_at: :iso8601
+
+          attribute :stock_location_id do |exchange|
+            exchange.stock_location&.prefixed_id
+          end
+
+          attribute :created_by_id do |exchange|
+            exchange.created_by&.prefixed_id
+          end
+
+          many :exchange_line_items,
+               resource: proc { Spree.api.admin_exchange_line_item_serializer },
+               if: proc { expand?('exchange_line_items') }
+
+          one :reason, resource: proc { Spree.api.admin_return_reason_serializer }, if: proc { expand?('reason') }
+          one :order, resource: proc { Spree.api.admin_order_serializer }, if: proc { expand?('order') }
+          one :stock_location, resource: proc { Spree.api.admin_stock_location_serializer }, if: proc { expand?('stock_location') }
+          many :refunds, resource: proc { Spree.api.admin_refund_serializer }, if: proc { expand?('refunds') }
+        end
+      end
+    end
+  end
+end

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

@@ -12,10 +12,29 @@ module Spree
           typelize done: :boolean,
                    download_url: [:string, nullable: true],
                    filename: [:string, nullable: true],
-                   byte_size: [:number, nullable: true]
+                   byte_size: [:number, nullable: true],
+                   store_id: [:string, nullable: true],
+                   seller_id: [:string, nullable: true],
+                   seller_name: [:string, nullable: true]
 
           attribute(:done) { |export| export.done? }
 
+          # Which marketplace this export belongs to, and — when a seller ran
+          # it — whose it is. A null `seller_id` means the operator's own.
+          # The name rides along so the list can show who without a second
+          # request per row.
+          attribute :store_id do |export|
+            export.store&.prefixed_id
+          end
+
+          attribute :seller_id do |export|
+            export.seller&.prefixed_id
+          end
+
+          attribute :seller_name do |export|
+            export.seller&.name
+          end
+
           # Safe-nav on `blob` — `attachment.attached?` can stay true while a
           # background job purges the underlying blob (e.g. retention sweeps).
           attribute :filename do |export|

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

@@ -0,0 +1,14 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class FeeSerializer < V3::FeeSerializer
+          typelize amount: [:string, nullable: false], display_amount: [:string, nullable: false],
+                   metadata: ['Record<string, unknown>', nullable: true]
+
+          attributes :metadata, created_at: :iso8601, updated_at: :iso8601
+        end
+      end
+    end
+  end
+end