spree_api 6.0.0.beta3 → 6.0.0.rc1

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

@@ -11,7 +11,10 @@ module Spree
                    position: :number,
                    metadata: 'Record<string, unknown>',
                    preferences: 'Record<string, unknown>',
-                   preference_schema: "Array<{ key: string; type: string; default: unknown; choices?: string[] }>"
+                   preference_schema: "Array<{ key: string; type: string; default: unknown; choices?: string[] }>",
+                   logo_url: [:string, nullable: true],
+                   docs_url: [:string, nullable: true],
+                   third_party: :boolean
 
           # Null capture_method means the method inherits from its store;
           # resolved_capture_method is what actually applies, so the dashboard
@@ -22,6 +25,9 @@ module Spree
 
           attribute :preferences, &:serialized_preferences
           attribute :preference_schema, &:serialized_preference_schema
+          attribute(:logo_url) { |payment_method| payment_method.class.logo_url }
+          attribute(:docs_url) { |payment_method| payment_method.class.docs_url }
+          attribute(:third_party) { |payment_method| payment_method.class.third_party? }
         end
       end
     end

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

@@ -17,13 +17,8 @@ module Spree
           attributes :metadata, :avs_response, :cvv_response_code, :cvv_response_message,
                      created_at: :iso8601, updated_at: :iso8601
 
-          attribute :captured_amount do |payment|
-            payment.captured_amount.to_s
-          end
-
-          attribute :order_id do |payment|
-            payment.order&.prefixed_id
-          end
+          attributes captured_amount: :string
+          prefixed_id_attributes :order
 
           # Override inherited associations to use admin serializers
           one :payment_method, resource: proc { Spree.api.admin_payment_method_serializer }, if: proc { expand?('payment_method') }

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

@@ -4,7 +4,7 @@ module Spree
       module Admin
         # Serializes one permission catalog entry
         # (Spree::PermissionConfiguration::Entry) for the discovery endpoint.
-        # Labels and descriptions resolve through Spree.t so backend extensions
+        # Labels and descriptions resolve through I18n so backend extensions
         # localize without shipping dashboard translations.
         class PermissionSerializer
           include Alba::Resource
@@ -20,17 +20,17 @@ module Spree
           attribute(:group) { |entry| entry.scope.group.to_s }
 
           attribute(:group_label) do |entry|
-            Spree.t("permissions_catalog.groups.#{entry.scope.group}",
+            I18n.t("spree.permissions_catalog.groups.#{entry.scope.group}",
                     default: entry.scope.group.to_s.humanize)
           end
 
           attribute(:label) do |entry|
-            Spree.t("permissions_catalog.resources.#{entry.scope.name}.label",
+            I18n.t("spree.permissions_catalog.resources.#{entry.scope.name}.label",
                     default: entry.scope.name.to_s.humanize)
           end
 
           attribute(:description) do |entry|
-            Spree.t("permissions_catalog.resources.#{entry.scope.name}.description", default: '')
+            I18n.t("spree.permissions_catalog.resources.#{entry.scope.name}.description", default: '')
           end
         end
       end

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

@@ -17,9 +17,7 @@ module Spree
             rule.class.api_type
           end
 
-          attribute :price_list_id do |rule|
-            rule.price_list&.prefixed_id
-          end
+          prefixed_id_attributes :price_list
 
           attribute :preferences, &:serialized_preferences
           attribute :preference_schema, &:serialized_preference_schema

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

@@ -24,9 +24,7 @@ module Spree
                      :metadata, deleted_at: :iso8601,
                      created_at: :iso8601, updated_at: :iso8601
 
-          attribute :delivery_profile_id do |product|
-            product.delivery_profile&.prefixed_id
-          end
+          prefixed_id_attributes :delivery_profile
 
           # The live row in the review trail: who submitted, who decided,
           # when, and what the seller was told. Expanded rather than always
@@ -47,13 +45,7 @@ module Spree
               resource: proc { Spree.api.admin_seller_serializer },
               if: proc { expand?('seller') }
 
-          attribute :product_type_id do |product|
-            product.product_type&.prefixed_id
-          end
-
-          attribute :tax_category_id do |product|
-            product.tax_category&.prefixed_id
-          end
+          prefixed_id_attributes :product_type, :tax_category
 
           attribute :price do |product|
             price = price_for(product.default_variant)

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

@@ -14,13 +14,7 @@ module Spree
 
           attributes :metadata, updated_at: :iso8601
 
-          attribute :submitted_by_id do |submission|
-            submission.submitted_by&.prefixed_id
-          end
-
-          attribute :reviewed_by_id do |submission|
-            submission.reviewed_by&.prefixed_id
-          end
+          prefixed_id_attributes :submitted_by, :reviewed_by
 
           # An operator reading the trail wants a name, not an id to resolve.
           attribute :reviewed_by_name do |submission|
@@ -29,9 +23,7 @@ module Spree
 
           # Distinguishes "the store approves listings automatically" from a
           # decision whose author we failed to record.
-          attribute :auto_approved do |submission|
-            submission.auto_approved?
-          end
+          attribute :auto_approved, &:auto_approved?
         end
       end
     end

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

@@ -15,9 +15,7 @@ module Spree
 
           # The creation-time template: stamped onto products at creation,
           # never synced afterwards.
-          attribute :delivery_profile_id do |record|
-            record.delivery_profile&.prefixed_id
-          end
+          prefixed_id_attributes :delivery_profile
 
           # Prefixed ids of the option types and categories this type seeds onto
           # new products — the same payload the client sends back on PATCH.

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

@@ -22,9 +22,7 @@ module Spree
             action.class.api_type
           end
 
-          attribute :promotion_id do |action|
-            action.promotion&.prefixed_id
-          end
+          prefixed_id_attributes :promotion
 
           attribute :preferences, &:serialized_preferences
           attribute :preference_schema, &:serialized_preference_schema

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

@@ -23,9 +23,7 @@ module Spree
             rule.class.api_type
           end
 
-          attribute :promotion_id do |rule|
-            rule.promotion&.prefixed_id
-          end
+          prefixed_id_attributes :promotion
 
           attribute :preferences, &:serialized_preferences
           attribute :preference_schema, &:serialized_preference_schema

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

@@ -32,25 +32,12 @@ module Spree
             item.unit_cost&.to_s
           end
 
-          attribute :total_cost do |item|
-            item.total_cost.to_s
-          end
-
-          attribute :display_unit_cost do |item|
-            item.display_unit_cost.to_s
-          end
-
-          attribute :display_total_cost do |item|
-            item.display_total_cost.to_s
-          end
-
+          attributes total_cost: :string, display_unit_cost: :string, display_total_cost: :string
           attribute :purchase_order_id do |item|
             Spree::PurchaseOrder.prefixed_id_for(item.purchase_order_id)
           end
 
-          attribute :variant_id do |item|
-            item.variant&.prefixed_id
-          end
+          prefixed_id_attributes :variant
 
           # The product the line's variant belongs to, so a line can link
           # straight to the screen where that SKU's stock lives.

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

@@ -56,21 +56,8 @@ module Spree
 
           attribute :editable, &:editable?
 
-          attribute :subtotal do |purchase_order|
-            purchase_order.subtotal.to_s
-          end
-
-          attribute :display_subtotal do |purchase_order|
-            purchase_order.display_subtotal.to_s
-          end
-
-          attribute :supplier_id do |purchase_order|
-            purchase_order.supplier&.prefixed_id
-          end
-
-          attribute :destination_location_id do |purchase_order|
-            purchase_order.destination_location&.prefixed_id
-          end
+          attributes subtotal: :string, display_subtotal: :string
+          prefixed_id_attributes :supplier, :destination_location
 
           many :items,
                resource: proc { Spree.api.admin_purchase_order_item_serializer },

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

@@ -17,9 +17,7 @@ module Spree
 
           # Lets the dashboard hide destructive controls instead of offering a
           # delete that the model will refuse.
-          attribute :can_be_deleted do |reason|
-            reason.can_be_deleted?
-          end
+          attribute :can_be_deleted, &:can_be_deleted?
         end
       end
     end

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

@@ -7,11 +7,14 @@ module Spree
                    refund_reason_id: [:string, nullable: true],
                    refunder_id: [:string, nullable: true],
                    refunder_type: [:string, nullable: true, enum: Spree::Actor::BUILT_IN_KINDS, enum_type_name: 'ActorKind'],
-                   metadata: 'Record<string, unknown>'
+                   metadata: 'Record<string, unknown>',
+                   tax_amount: :string
 
           attributes :metadata,
                      created_at: :iso8601, updated_at: :iso8601
 
+          # The tax inside the amount, when what was refunded carried tax.
+          attributes tax_amount: :string
           # Who issued it — an admin user, or the API key an integration
           # refunded through.
           actor_attributes :refunder

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

@@ -9,6 +9,7 @@ module Spree
 
           one :variant, resource: proc { Spree.api.admin_variant_serializer }, if: proc { expand?('variant') }
           one :line_item, resource: proc { Spree.api.admin_line_item_serializer }, if: proc { expand?('line_item') }
+          many :tax_lines, resource: proc { Spree.api.admin_tax_line_serializer }, if: proc { expand?('tax_lines') }
         end
       end
     end

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

@@ -11,9 +11,7 @@ module Spree
 
           # Lets the dashboard hide destructive controls instead of offering a
           # delete that the model will refuse.
-          attribute :can_be_deleted do |reason|
-            reason.can_be_deleted?
-          end
+          attribute :can_be_deleted, &:can_be_deleted?
         end
       end
     end

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

@@ -12,24 +12,16 @@ module Spree
                    created_by_id: [:string, nullable: true],
                    created_by_type: [:string, nullable: true, enum: Spree::Actor::BUILT_IN_KINDS, enum_type_name: 'ActorKind'],
                    refunded_total: :string,
+                   display_refunded_total: :string,
                    refundable_total: :string
 
           attributes :memo, :metadata, created_at: :iso8601, updated_at: :iso8601
 
-          attribute :stock_location_id do |return_record|
-            return_record.stock_location&.prefixed_id
-          end
+          prefixed_id_attributes :stock_location
 
           actor_attributes :created_by
 
-          attribute :refunded_total do |return_record|
-            return_record.refunded_total.to_s
-          end
-
-          attribute :refundable_total do |return_record|
-            return_record.refundable_total.to_s
-          end
-
+          attributes refunded_total: :string, display_refunded_total: :string, refundable_total: :string
           many :return_line_items,
                resource: proc { Spree.api.admin_return_line_item_serializer },
                if: proc { expand?('return_line_items') }

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

@@ -16,9 +16,7 @@ module Spree
 
           attributes :name, :description, :query, :seeded, :created_at, :updated_at
 
-          attribute :user_id do |report|
-            report.user&.prefixed_id
-          end
+          prefixed_id_attributes :user
 
           # The same "name, else email" rule every actor answers, so a report's
           # author and an order's canceler read alike.

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

@@ -11,7 +11,7 @@ module Spree
           typelize seller_id: :string,
                    seller_name: 'string | null',
                    status: [:string, enum: Spree::SellerPayout.statuses, enum_type_name: 'SellerPayoutStatus'],
-                   provider: [:string, comment: 'Payout provider class name. Built-in: Spree::PayoutProvider::System. Provider gems register more.'],
+                   provider: [:string, comment: 'Payout provider. Built-in: system. Provider gems register more (e.g. stripe).'],
                    amount: :string,
                    currency: :string,
                    reference: 'string | null',
@@ -20,7 +20,7 @@ module Spree
                    transfers_count: :number,
                    display_amount: :string
 
-          attributes :status, :currency, :provider, :reference, :metadata,
+          attributes :status, :currency, :reference, :metadata,
                      period_start: :iso8601, period_end: :iso8601,
                      created_at: :iso8601, updated_at: :iso8601
 
@@ -39,6 +39,8 @@ module Spree
 
             counts ? counts.fetch(payout.id, 0) : payout.transfers.count
           end
+
+          api_type_attributes :provider
         end
       end
     end

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

@@ -22,17 +22,13 @@ module Spree
           # Whether this stands between the seller and approval. Serialized
           # rather than left to each client to derive, so the dashboard's
           # override warning and the approval gate cannot disagree.
-          attribute :blocking do |status|
-            status.blocking?
-          end
+          attribute :blocking, &:blocking?
 
           # The document this line asks for, and what the seller published
           # against it. Embedded rather than left to a second request: the
           # operator is deciding whether to approve, and a line that says
           # "Done" without showing the text is not something to approve on.
-          attribute :required_policy_name do |status|
-            status.required_policy_name
-          end
+          attributes :required_policy_name
 
           one :submission,
               resource: proc { Spree.api.admin_seller_requirement_submission_serializer },

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

@@ -21,13 +21,7 @@ module Spree
                      created_at: :iso8601,
                      updated_at: :iso8601
 
-          attribute :seller_id do |submission|
-            submission.seller&.prefixed_id
-          end
-
-          attribute :requirement_id do |submission|
-            submission.requirement&.prefixed_id
-          end
+          prefixed_id_attributes :seller, :requirement
 
           # The reviewer is looking at a queue of these and needs to know what
           # each one answers without fetching the requirement.

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

@@ -43,20 +43,14 @@ module Spree
 
           # Approved but away still cannot sell, and the list has to say so
           # without the dashboard re-deriving the rule.
-          attribute :on_holiday do |seller|
-            seller.on_holiday?
-          end
+          attribute :on_holiday, &:on_holiday?
 
-          attribute :sellable do |seller|
-            seller.sellable?
-          end
+          attribute :sellable, &:sellable?
 
           # Saves the dashboard a request per row for the two counts its list
           # and header show. Read off the seller, which memoizes the SQL count
           # so the minimum-products requirement asks the same question free.
-          attribute :products_count do |seller|
-            seller.products_count
-          end
+          attributes :products_count
 
           attribute :users_count do |seller|
             seller.users.size
@@ -67,13 +61,9 @@ module Spree
           # requirements themselves, with their submissions, stay on the
           # heavier `onboarding` action; a list of sellers needs the number,
           # not the rows behind it.
-          attribute :onboarding_progress do |seller|
-            seller.onboarding_progress
-          end
+          attributes :onboarding_progress
 
-          attribute :onboarding_complete do |seller|
-            seller.onboarding_complete?
-          end
+          attribute :onboarding_complete, &:onboarding_complete?
 
           attribute :legal_name, &:legal_name
           attribute :registration_number, &:registration_number

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

@@ -16,7 +16,7 @@ module Spree
                    order_number: 'string | null',
                    kind: [:string, enum: Spree::SellerTransfer::KINDS],
                    status: [:string, enum: Spree::SellerTransfer.statuses, enum_type_name: 'SellerTransferStatus'],
-                   provider: [:string, comment: 'Payout provider class name. Built-in: Spree::PayoutProvider::System. Provider gems register more.'],
+                   provider: [:string, comment: 'Payout provider. Built-in: system. Provider gems register more (e.g. stripe).'],
                    amount: :string,
                    currency: :string,
                    settled_amount: 'string | null',
@@ -25,7 +25,7 @@ module Spree
                    reference: 'string | null',
                    display_amount: :string
 
-          attributes :kind, :status, :currency, :provider, :reference, :metadata,
+          attributes :kind, :status, :currency, :reference, :metadata,
                      created_at: :iso8601, updated_at: :iso8601
 
           # A string, so the figure a seller is paid round-trips exactly.
@@ -46,6 +46,8 @@ module Spree
           # by row and these are what identify a row to an operator.
           attribute(:seller_name) { |transfer| transfer.seller&.name }
           attribute(:order_number) { |transfer| transfer.order&.number }
+
+          api_type_attributes :provider
         end
       end
     end

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

@@ -7,7 +7,7 @@ module Spree
         # The file is streamed through +download_url+, never linked to storage.
         class ShippingLabelSerializer < V3::BaseSerializer
           typelize owner_id: :string,
-                   owner_type: [:string, enum: Spree::ShippingLabel::OWNER_TYPES],
+                   owner_type: [:string, enum: Spree::ShippingLabel::OWNER_TYPES.map { |type| Spree::Base.polymorphic_api_type(type) }],
                    source: [:string, enum: Spree::ShippingLabel::SOURCES],
                    status: [:string, enum: Spree::ShippingLabel.statuses, enum_type_name: 'ShippingLabelStatus'],
                    carrier: [:string, nullable: true],
@@ -28,31 +28,18 @@ module Spree
           attributes :source, :status, :carrier, :carrier_name, :service, :tracking_number, :currency, :format,
                      :external_id, :metadata, refunded_at: :iso8601, created_at: :iso8601, updated_at: :iso8601
 
-          attribute :owner_id do |shipping_label|
-            shipping_label.owner&.prefixed_id
-          end
+          prefixed_id_attributes :owner
 
           attribute :owner_type do |shipping_label|
-            shipping_label.owner_type == 'Spree::Return' ? 'return' : 'fulfillment'
-          end
-
-          attribute :cost do |shipping_label|
-            shipping_label.cost.to_s
+            Spree::Base.polymorphic_api_type(shipping_label.owner_type)
           end
 
-          attribute :display_cost do |shipping_label|
-            shipping_label.display_cost.to_s
-          end
-
-          attribute :integration_id do |shipping_label|
-            shipping_label.integration&.prefixed_id
-          end
+          attributes cost: :string, display_cost: :string
+          prefixed_id_attributes :integration
 
           # Whether the file is still being fetched from the carrier; the
           # download proxies the provider's copy meanwhile.
-          attribute :file_pending do |shipping_label|
-            shipping_label.file_pending?
-          end
+          attribute :file_pending, &:file_pending?
 
           # Our own endpoint rather than a storage URL: the controller streams
           # the bytes, so admin auth runs on every print.

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

@@ -27,9 +27,7 @@ module Spree
             stock_level.stock_location&.name
           end
 
-          attribute :product_id do |stock_level|
-            stock_level.product&.prefixed_id
-          end
+          prefixed_id_attributes :product
 
           attribute :options_text do |stock_level|
             stock_level.variant&.options_text.presence

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

@@ -22,9 +22,7 @@ module Spree
                      :pickup_ready_in_minutes, :pickup_instructions,
                      created_at: :iso8601, updated_at: :iso8601
 
-          attribute :seller_id do |stock_location|
-            stock_location.seller&.prefixed_id
-          end
+          prefixed_id_attributes :seller
 
           attribute :seller_name do |stock_location|
             stock_location.seller&.name

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

@@ -68,9 +68,7 @@ module Spree
             Spree::StockTransfer.prefixed_id_for(movement.stock_transfer_id)
           end
 
-          attribute :stock_receipt_id do |movement|
-            movement.stock_receipt&.prefixed_id
-          end
+          prefixed_id_attributes :stock_receipt
 
           attribute :purchase_order_id do |movement|
             Spree::PurchaseOrder.prefixed_id_for(movement.purchase_order_id)

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

@@ -25,13 +25,7 @@ module Spree
             item.line_type.demodulize.underscore
           end
 
-          attribute :line_id do |item|
-            item.line&.prefixed_id
-          end
-
-          attribute :variant_id do |item|
-            item.variant&.prefixed_id
-          end
+          prefixed_id_attributes :line, :variant
 
           # The product the line's variant belongs to, so a delivery's line
           # can link to the screen where that SKU's stock lives.

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

@@ -28,9 +28,7 @@ module Spree
             receipt.receivable_type.demodulize.underscore
           end
 
-          attribute :receivable_id do |receipt|
-            receipt.receivable&.prefixed_id
-          end
+          prefixed_id_attributes :receivable
 
           actor_attributes :received_by
 

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

@@ -34,9 +34,7 @@ module Spree
 
           attributes :quantity, expires_at: :iso8601
 
-          attribute :active do |reservation|
-            reservation.active?
-          end
+          attribute :active, &:active?
 
           attributes created_at: :iso8601, updated_at: :iso8601
         end

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

@@ -25,9 +25,7 @@ module Spree
             Spree::StockTransfer.prefixed_id_for(item.stock_transfer_id)
           end
 
-          attribute :variant_id do |item|
-            item.variant&.prefixed_id
-          end
+          prefixed_id_attributes :variant
 
           # The product the line's variant belongs to, so a line can link
           # straight to the screen where that SKU's stock lives.

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

@@ -11,9 +11,7 @@ module Spree
 
           attributes updated_at: :iso8601
 
-          attribute :store_credit_id do |event|
-            event.store_credit&.prefixed_id
-          end
+          prefixed_id_attributes :store_credit
 
           attribute :originator_type do |event|
             Spree::Base.polymorphic_api_type(event.originator_type)

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

@@ -16,27 +16,13 @@ module Spree
           attributes :memo, :metadata,
                      created_at: :iso8601, updated_at: :iso8601
 
-          attribute :amount_authorized do |store_credit|
-            store_credit.amount_authorized.to_s
-          end
-
+          attributes amount_authorized: :string
           # Answers the same question as the `outstanding` filter, so the row
           # and the filter cannot disagree.
-          attribute :outstanding do |store_credit|
-            store_credit.outstanding?
-          end
-
-          attribute :display_amount_authorized do |store_credit|
-            store_credit.display_amount_authorized.to_s
-          end
-
-          attribute :customer_id do |store_credit|
-            store_credit.customer&.prefixed_id
-          end
+          attribute :outstanding, &:outstanding?
 
-          attribute :created_by_id do |store_credit|
-            store_credit.created_by&.prefixed_id
-          end
+          attributes display_amount_authorized: :string
+          prefixed_id_attributes :customer, :created_by
 
           # Why the credit exists: the return, exchange, claim or gift card
           # that issued it, or null when an admin issued it by hand. The type