@nautical-commerce/graphql-schema 4.7.0 → 4.9.0

package/nautical/schema.graphql

@@ -513,8 +513,8 @@ type AgreementCommissionEvent implements Node {
   """Global ID of user who made the change."""
   userId: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String
@@ -643,8 +643,8 @@ type AgreementEvent implements Node {
   """Global ID of user who made the change."""
   userId: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String
@@ -765,8 +765,8 @@ type AgreementFeesEvent implements Node {
   """Global ID of user who made the change."""
   userId: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String
@@ -918,8 +918,8 @@ type AgreementSellersEvent implements Node {
   """Global ID of user who made the change."""
   userId: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String
@@ -997,8 +997,8 @@ type AgreementTimelineEvent implements Node {
   """Global ID of user who made the change."""
   userId: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String
@@ -1043,6 +1043,58 @@ type AgreementUpdate {
   agreementErrors: [AgreementError!]!
 }
 
+"""Result of an asynchronous Algolia maintenance action."""
+type AlgoliaAction {
+  """True when the background job was queued. It runs asynchronously."""
+  started: Boolean!
+
+  """List of errors that occurred executing the mutation."""
+  pluginsErrors: [PluginError!]!
+}
+
+"""Category of an Algolia sync problem."""
+enum AlgoliaProblemCode {
+  AUTH_ERROR
+  RECORD_TOO_LARGE
+  INDEXING_FAILED
+  SETTINGS_FAILED
+  CONFIG_INVALID
+}
+
+"""A problem the Algolia sync hit, with what to do about it."""
+type AlgoliaSyncProblem {
+  """Problem id."""
+  id: ID!
+
+  """When the problem was recorded."""
+  createdAt: DateTime!
+
+  """Problem category."""
+  code: AlgoliaProblemCode!
+
+  """What went wrong."""
+  message: String!
+
+  """
+  Pointer to the affected object, e.g. 'product:123'. Empty when not object-specific.
+  """
+  objectLabel: String!
+
+  """Suggested next step for this category."""
+  remediation: String!
+}
+
+"""Result of algoliaVerifyCredentials."""
+type AlgoliaVerifyCredentials {
+  """
+  True when the configured admin key exists and carries every required ACL.
+  """
+  verified: Boolean!
+
+  """List of errors that occurred executing the mutation."""
+  pluginsErrors: [PluginError!]!
+}
+
 """Represents stock allocation for an order line."""
 type Allocation implements Node {
   """The Globally Unique ID of this object"""
@@ -1515,7 +1567,9 @@ type Attribute implements Node & ObjectWithMetadata {
   """The input type to use for entering attribute values in the dashboard."""
   inputType: AttributeInputTypeEnum!
 
-  """The values available for this attribute"""
+  """
+  ALL values defined for this attribute — the full catalogue of options it can take, NOT the values assigned to any particular product or variant. For the values assigned to a specific object, use the `values` field on SelectedAttribute (a sibling of `attribute`, one level up). Narrowed to a subset when `search` or `first` is supplied. Returns an empty list unless `inputType` is DROPDOWN or MULTISELECT — the other input types carry a unique value per object rather than a shared catalogue.
+  """
   values(search: String = null, first: Int = null): [AttributeValue!]!
 
   """Seller who created this attribute, if any"""
@@ -1600,8 +1654,8 @@ type AttributeAuditEvent implements Node {
   """Global ID of the user who made the change."""
   userId: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String
@@ -2958,8 +3012,8 @@ type CategoryAuditEvent implements Node {
   """Global ID of the user who made the change."""
   userId: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String
@@ -3960,8 +4014,8 @@ type CollectionAuditEvent implements Node {
   """Global ID of the user who made the change."""
   userId: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String
@@ -5554,8 +5608,8 @@ type DigitalContentAuditEvent implements Node {
   """Global ID of the user who made the change."""
   userId: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String
@@ -5728,8 +5782,8 @@ type DigitalContentUrlAuditEvent implements Node {
   """Global ID of the user who made the change."""
   userId: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String
@@ -5780,6 +5834,15 @@ input DigitalContentUrlCreateInput {
   content: ID!
 }
 
+"""Result of digital content URL rotate mutation."""
+type DigitalContentUrlRotate {
+  """The newly issued digital content URL."""
+  digitalContentUrl: DigitalContentUrl
+
+  """List of errors that occurred executing the mutation."""
+  productErrors: [ProductError!]!
+}
+
 """Represents errors from discount operations."""
 type DiscountError {
   field: String
@@ -9957,10 +10020,10 @@ type Mutation {
   """Clear all seller shipping methods."""
   checkoutSellerShippingMethodsClear(checkoutId: ID!): CheckoutSellerShippingMethodsClear!
 
-  """Add a promo code (voucher or gift card)."""
+  """Add a voucher code to the checkout."""
   checkoutAddPromoCode(checkoutId: ID!, promoCode: String!): CheckoutAddPromoCode!
 
-  """Remove a promo code."""
+  """Remove a voucher code from the checkout."""
   checkoutRemovePromoCode(checkoutId: ID!, promoCode: String!): CheckoutRemovePromoCode!
 
   """Add purchase order numbers."""
@@ -10046,6 +10109,9 @@ type Mutation {
   """Publish products in bulk."""
   productBulkPublish(ids: [ID!]!, isPublished: Boolean!): ProductBulkPublish!
 
+  """Update approval status for products in bulk."""
+  productBulkSubStatusUpdate(ids: [ID!]!, subStatus: ProductSubStatusEnum!, subStatusReason: String = null): ProductBulkSubStatusUpdate!
+
   """Update category for products in bulk."""
   productBulkCategoryUpdate(ids: [ID!]!, category: ID!): ProductBulkCategoryUpdate!
 
@@ -10198,6 +10264,11 @@ type Mutation {
   """Creates a download URL for digital content."""
   digitalContentUrlCreate(input: DigitalContentUrlCreateInput!): DigitalContentUrlCreate!
 
+  """
+  Re-issue the download link for an order line. The existing link stops working immediately and is replaced by one with a fresh token and a reset download count. Accepts either an OrderLine or a NauticalOrderLine id. The customer's entitlement is left untouched — this replaces the delivery credential, not their ownership. Requires MANAGE_ORDERS.
+  """
+  digitalContentUrlRotate(lineId: ID!): DigitalContentUrlRotate!
+
   """
   Create a product bundle. Builds a Product flagged is_bundle=True + its single sellable ProductVariant + BundleItem rows for each component, all in one transaction.
   """
@@ -10642,6 +10713,21 @@ type Mutation {
   """Create a checkout event for analytics tracking."""
   checkoutEventTriggered(type: CheckoutEventType!, checkoutId: String!): CheckoutEventTriggered!
 
+  """
+  Check the configured Algolia admin credentials and required ACLs. Works on a saved but not yet activated configuration.
+  """
+  algoliaVerifyCredentials: AlgoliaVerifyCredentials!
+
+  """
+  Push the plugin-owned index settings to Algolia. Tenant-authored relevance settings are never overwritten.
+  """
+  algoliaPushSettings: AlgoliaAction!
+
+  """
+  Rebuild the whole product index from the database. The swap is atomic: the live index is only replaced once the rebuild succeeds.
+  """
+  algoliaReindex: AlgoliaAction!
+
   """Create a new warehouse."""
   warehouseCreate(input: WarehouseCreateInput!): WarehouseCreate!
 
@@ -11240,8 +11326,8 @@ type NauticalOrderAuditEvent implements Node {
   """Global ID of user who made the change."""
   changedById: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String
@@ -12343,8 +12429,8 @@ type OrderAuditEvent implements Node {
   """Email of staff/app user who made the change."""
   changedByEmail: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """App name if change was via API token."""
   appName: String
@@ -13790,8 +13876,8 @@ type PaymentEvent implements Node {
   """Email of user who made the change."""
   changedByEmail: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """App name if change was via API token."""
   appName: String
@@ -15006,8 +15092,8 @@ type ProductAuditEvent implements Node {
   """Global ID of the user who made the change."""
   userId: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String
@@ -15195,6 +15281,15 @@ type ProductBulkPublish {
   productErrors: [ProductError!]!
 }
 
+"""Result of product bulk approval status update mutation."""
+type ProductBulkSubStatusUpdate {
+  """Number of products whose approval status was updated."""
+  count: Int!
+
+  """List of errors that occurred executing the mutation."""
+  productErrors: [ProductError!]!
+}
+
 """Product category report data."""
 type ProductCategoryReportType {
   """Category ID"""
@@ -15571,8 +15666,8 @@ type ProductImageAuditEvent implements Node {
   """Global ID of the user who made the change."""
   userId: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String
@@ -16154,8 +16249,8 @@ type ProductTypeAuditEvent implements Node {
   """Global ID of the user who made the change."""
   userId: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String
@@ -16567,8 +16662,8 @@ type ProductVariantAuditEvent implements Node {
   """Global ID of the user who made the change."""
   userId: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String
@@ -17178,8 +17273,8 @@ type ProductVideoAuditEvent implements Node {
   """Global ID of the user who made the change."""
   userId: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String
@@ -18346,6 +18441,11 @@ type Query {
   """List all plugins. Requires MANAGE_PLUGINS permission."""
   plugins(first: Int = null, last: Int = null, before: String = null, after: String = null, filter: PluginFilterInput = null, sortBy: PluginSortingInput = null): PluginCountableConnection!
 
+  """
+  Problems recorded by the Algolia sync, newest first. Bounded by the plugin's own retention cap, so this is a short operator list rather than a log store.
+  """
+  algoliaSyncProblems: [AlgoliaSyncProblem!]!
+
   """Look up a webhook by ID."""
   webhook(id: ID!): Webhook
 
@@ -18787,6 +18887,16 @@ type Query {
     """Returns the items in the list that come after the specified cursor."""
     last: Int = null
   ): MarketplaceSubscriptionCountableConnection!
+
+  """
+  Fetch any object by its global ID. Access is deny-by-default: a type is only reachable here once it has been opted in with expose_as_node(), naming the permissions the lookup requires.
+  """
+  node(id: ID!): Node
+
+  """
+  Fetch several objects by global ID. Returns one entry per id, in order, null where the id did not resolve. Same deny-by-default policy as `node`.
+  """
+  nodes(ids: [ID!]!): [Node]!
 }
 
 """The recipient type for an email template."""
@@ -18961,8 +19071,8 @@ type RefundAuditEvent implements Node {
   """Email of user who made the change."""
   changedByEmail: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """App name if change was via API token."""
   appName: String
@@ -19848,12 +19958,79 @@ type SalesVelocityReport {
   currency: String!
 }
 
+"""
+How to search this shop's catalog. When provider is ALGOLIA the credentials below are a per-request, index-scoped, expiring secured key safe to use from a browser. When provider is POSTGRES no credentials are issued and consumers should use products(filter: {search: ...}).
+"""
+type SearchConfiguration {
+  """
+  Engine backing search. POSTGRES means fall back to the GraphQL FTS path.
+  """
+  provider: SearchProvider!
+
+  """
+  Granularity of index records; VARIANT records collapse to one hit per product.
+  """
+  recordModel: SearchRecordModel!
+
+  """
+  Version of the record schema, so clients can detect field-shape changes.
+  """
+  schemaVersion: Int!
+
+  """Indexes this client may query. Empty when provider is POSTGRES."""
+  indexes: [SearchIndexDescriptor!]!
+
+  """Algolia application ID. Null when provider is POSTGRES."""
+  applicationId: String
+
+  """Index-name prefix owned by this shop. Null when POSTGRES."""
+  indexPrefix: String
+
+  """
+  Secured, index-scoped, expiring search key minted for this request. Never the tenant's raw search or admin key. Null when provider is POSTGRES.
+  """
+  searchApiKey: String
+
+  """When searchApiKey stops working. Null when provider is POSTGRES."""
+  validUntil: DateTime
+}
+
+"""An index the client may query, and what it contains."""
+type SearchIndexDescriptor {
+  """What this index holds."""
+  purpose: SearchIndexPurpose!
+
+  """Fully-qualified index name, prefix included."""
+  name: String!
+}
+
+"""What a search index holds."""
+enum SearchIndexPurpose {
+  PRODUCTS
+}
+
+"""Which engine backs storefront product search for this shop."""
+enum SearchProvider {
+  ALGOLIA
+  POSTGRES
+}
+
+"""Granularity of the records in the products index."""
+enum SearchRecordModel {
+  VARIANT
+  PRODUCT
+}
+
 """Represents a selected attribute with its values"""
 type SelectedAttribute {
-  """The attribute definition"""
+  """
+  The attribute definition. Its `values` field lists every value the attribute CAN take — for the values actually assigned here, use the `values` field alongside this one, not the one nested inside it.
+  """
   attribute: Attribute!
 
-  """Values of the attribute"""
+  """
+  The values assigned to THIS object — this product, variant, or custom-field owner. Usually the field you want. Contrast `attribute.values`, which is the attribute's full catalogue of possible values and is identical for every object sharing it.
+  """
   values: [AttributeValue!]!
 
   """
@@ -20339,8 +20516,8 @@ type SellerAuditEvent implements Node {
   """Global ID of user who made the change."""
   userId: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String
@@ -21481,6 +21658,11 @@ type Shop {
   """Gets active plugins."""
   activePlugins: [Plugin!]!
 
+  """
+  How to search this shop's catalog, including a per-request secured search key when an Algolia search provider is active.
+  """
+  searchConfiguration: SearchConfiguration!
+
   """Storefront integrations for the given contexts."""
   storefrontUiIntegrations(contexts: [AppStorefrontIntegrationContextEnum!] = null): [AppStorefrontIntegration!]!
 }
@@ -23382,8 +23564,8 @@ type VendorPayoutAuditEvent implements Node {
   """Global ID of user who made the change."""
   userId: String
 
-  """Tenant ID where the change occurred."""
-  tenantId: Int
+  """UUID of the tenant where the change occurred."""
+  tenantId: String
 
   """Tenant slug where the change occurred."""
   tenantSlug: String

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nautical-commerce/graphql-schema",
-  "version": "4.7.0",
+  "version": "4.9.0",
   "description": "Traide API GraphQL Schema",
   "main": "./nautical/schema.graphql",
   "scripts": {