@nautical-commerce/graphql-schema 1.53.0 → 1.53.1-10-g0f6efe437

package/nautical/schema.graphql

@@ -8,6 +8,30 @@ parses float to the Decimal on the way back
 scalar Decimal
 
 type Query {
+  """Look up an email template by ID."""
+  emailTemplate(
+    """ID of an email template"""
+    id: ID!
+  ): EmailTemplate
+
+  """List of email templates."""
+  emailTemplates(
+    """Filtering options for email templates."""
+    filter: EmailTemplateFilterInput
+
+    """Return the elements in the list that come before the specified cursor."""
+    before: String
+
+    """Return the elements in the list that come after the specified cursor."""
+    after: String
+
+    """Return the first n elements from the list."""
+    first: Int
+
+    """Return the last n elements from the list."""
+    last: Int
+  ): EmailTemplateCountableConnection
+
   """List of the wishlist items by name."""
   wishlistItemsByName(
     """Filtering options for wishlist items."""
@@ -613,7 +637,6 @@ type Query {
     """Return the last n elements from the list."""
     last: Int
   ): ProductVariantCountableConnection
-  productRatingsAndReviews(productId: String!): ProductRatingsAndReviews @deprecated(reason: "This will be removed on October 1, 2024.")
 
   """Look up a price book by ID."""
   priceBook(
@@ -1764,9 +1787,6 @@ type Query {
   designerdatalist: [DesignerDataType!]! @deprecated(reason: "This will be removed on October 25, 2024")
   branding: BrandingType! @deprecated(reason: "This will be removed on October 25, 2024")
 
-  """Return information about the dashboard."""
-  dashboard: Dashboard! @deprecated(reason: "This query is deprecated and will be removed on October 1, 2024.")
-
   """Token nexessary for connecting to the embedded integration platform"""
   integrationEmbeddingToken: String
 
@@ -2136,10 +2156,99 @@ type Query {
   _service: _Service!
 }
 
-type WishlistItemCountableConnection {
+"""Represents an email template."""
+type EmailTemplate implements Node {
+  """The ID of the object"""
+  id: ID!
+  title: String!
+  subject: String!
+  content: String
+  renderedContent: String
+  isCustom: Boolean!
+  isActive: Boolean!
+  isEditable: Boolean!
+  createdAt: DateTime!
+  updatedAt: DateTime!
+
+  """The recipient type of the email template"""
+  recipientType: RecipientTypeEnum!
+
+  """The event type associated with the email template"""
+  eventType: EventTypeEnum!
+}
+
+"""An object with an ID"""
+interface Node {
+  """The ID of the object"""
+  id: ID!
+}
+
+"""
+The `DateTime` scalar type represents a DateTime
+value as specified by
+[iso8601](https://en.wikipedia.org/wiki/ISO_8601).
+"""
+scalar DateTime
+
+"""Represents the recipient type for an email template."""
+enum RecipientTypeEnum {
+  CUSTOMER
+  SELLER_PRIMARY_CONTACT
+  STAFF_MEMBER_MARKETPLACE
+  STAFF_MEMBER_SELLER
+  STAFF_MEMBER_MARKETPLACE_OR_SELLER
+}
+
+"""An enumeration."""
+enum EventTypeEnum {
+  account_confirmation
+  account_password_reset
+  account_change_email_request
+  account_change_email_confirm
+  account_delete
+  account_set_customer_password
+  invoice_ready
+  order_confirmation
+  order_fulfillment_confirmation
+  order_fulfillment_denied
+  order_fulfillment_update
+  order_payment_confirmation
+  order_canceled
+  partial_order_cancel
+  order_refund_confirmation
+  seller_bid_action
+  pending_quote
+  account_set_staff_password
+  csv_export_products_success
+  csv_export_failed
+  staff_order_confirmation
+  account_staff_reset_password
+  vendor_payout_confirmation
+  pending_seller
+  updated_status
+  seller_status_pending
+  seller_status_approved
+  seller_status_declined
+  seller_status_paused
+  seller_agreement_accepted
+  seller_agreement_not_accepted
+  vin_decode_success
+  vin_decode_failed
+  import_catalog_failed
+  import_catalog_success
+  account_activate_request
+  account_activated
+  account_deactivated
+  pending_order
+  pending_customer
+  buyer_bid_action
+  quote_requested
+}
+
+type EmailTemplateCountableConnection {
   """Pagination data for this connection."""
   pageInfo: PageInfo!
-  edges: [WishlistItemCountableEdge!]!
+  edges: [EmailTemplateCountableEdge!]!
 
   """A total count of items in the collection."""
   totalCount: Int
@@ -2162,6 +2271,30 @@ type PageInfo {
   endCursor: String
 }
 
+type EmailTemplateCountableEdge {
+  """The item at the end of the edge."""
+  node: EmailTemplate!
+
+  """A cursor for use in pagination."""
+  cursor: String!
+}
+
+"""Filter input class for email templates."""
+input EmailTemplateFilterInput {
+  title: String
+  recipientType: RecipientTypeEnum
+  eventType: EventTypeEnum
+}
+
+type WishlistItemCountableConnection {
+  """Pagination data for this connection."""
+  pageInfo: PageInfo!
+  edges: [WishlistItemCountableEdge!]!
+
+  """A total count of items in the collection."""
+  totalCount: Int
+}
+
 type WishlistItemCountableEdge {
   """The item at the end of the edge."""
   node: WishlistItem!
@@ -2185,12 +2318,6 @@ type WishlistItem implements Node {
   requestedPrice: Money
 }
 
-"""An object with an ID"""
-interface Node {
-  """The ID of the object"""
-  id: ID!
-}
-
 """Wishlist item."""
 type Wishlist implements Node {
   """The ID of the object"""
@@ -2216,13 +2343,6 @@ type Wishlist implements Node {
   ): WishlistItemCountableConnection
 }
 
-"""
-The `DateTime` scalar type represents a DateTime
-value as specified by
-[iso8601](https://en.wikipedia.org/wiki/ISO_8601).
-"""
-scalar DateTime
-
 """Represents user data."""
 type User implements Node & ObjectWithMetadata {
   """The ID of the object"""
@@ -4810,7 +4930,6 @@ enum PermissionEnum {
   MANAGE_TRANSLATIONS
   MANAGE_CHECKOUTS
   MANAGE_AGREEMENTS
-  MANAGE_DASHBOARD_CONFIGURATION
   MANAGE_MARKETPLACE
   MANAGE_MARKETPLACE_CONFIGURATION
   MANAGE_MICROSITES
@@ -9340,8 +9459,9 @@ type CheckoutTheme implements Node {
   secondaryColor: String
   logo: Image
 
-  """URL of the favicon."""
+  """URL of favicon"""
   faviconUrl: String
+  faviconImage: Image
 
   """URL of the confirmation page."""
   confirmationUrl: String!
@@ -9361,6 +9481,7 @@ type StorefrontTheme implements Node {
   """Accent color in hex."""
   accentColor: String
   logo: Image
+  faviconImage: Image
 
   """URL of the favicon."""
   faviconUrl: String
@@ -9727,45 +9848,6 @@ enum ProductTypeSortField {
   EXTERNAL_SOURCE
 }
 
-"""Represents ratings and reviews for a product."""
-type ProductRatingsAndReviews {
-  """Summary of all ratings and reviews"""
-  bottomline: BottomLine
-
-  """List of reviews."""
-  reviews: [Review!]
-}
-
-type BottomLine {
-  """Average star rating over all ratings."""
-  averageScore: Float
-
-  """Total ratings/reviews."""
-  totalReview: Int
-}
-
-type Review {
-  """Review content."""
-  content: String
-
-  """Date and time review was created."""
-  createdAt: String
-
-  """Product rating out of 5 stars."""
-  score: Int
-
-  """Title of the review."""
-  title: String
-
-  """User who created the rating and review."""
-  user: Reviewer
-}
-
-type Reviewer {
-  """Reviewer username"""
-  displayName: String
-}
-
 type PriceBookCountableConnection {
   """Pagination data for this connection."""
   pageInfo: PageInfo!
@@ -12185,6 +12267,24 @@ enum EmailEventMessageType {
   """Updated Status"""
   UPDATED_STATUS
 
+  """Seller Status Pending"""
+  SELLER_STATUS_PENDING
+
+  """Seller Status Approved"""
+  SELLER_STATUS_APPROVED
+
+  """Seller Status Declined"""
+  SELLER_STATUS_DECLINED
+
+  """Seller Status Paused"""
+  SELLER_STATUS_PAUSED
+
+  """Seller Agreement Accepted"""
+  SELLER_AGREEMENT_ACCEPTED
+
+  """Seller Agreement Not Accepted"""
+  SELLER_AGREEMENT_NOT_ACCEPTED
+
   """Vin Decode Success"""
   VIN_DECODE_SUCCESS
 
@@ -12302,6 +12402,24 @@ enum NotifyEventTypeEnum {
   """Updated Status"""
   UPDATED_STATUS
 
+  """Seller Status Pending"""
+  SELLER_STATUS_PENDING
+
+  """Seller Status Approved"""
+  SELLER_STATUS_APPROVED
+
+  """Seller Status Declined"""
+  SELLER_STATUS_DECLINED
+
+  """Seller Status Paused"""
+  SELLER_STATUS_PAUSED
+
+  """Seller Agreement Accepted"""
+  SELLER_AGREEMENT_ACCEPTED
+
+  """Seller Agreement Not Accepted"""
+  SELLER_AGREEMENT_NOT_ACCEPTED
+
   """Vin Decode Success"""
   VIN_DECODE_SUCCESS @deprecated(reason: "Will be removed on Nov 12, 2024")
 
@@ -13319,26 +13437,6 @@ type BrandingType {
   footerText: String!
 }
 
-"""
-Represents a dashboard resource containing general dashboard data and configuration.
-"""
-type Dashboard {
-  """Dashboard main menu structure in JSON format."""
-  configurationMainMenu: JSONString
-
-  """Dashboard product create page structure in JSON format."""
-  configurationProductCreate: JSONString
-
-  """Dashboard product update page structure in JSON format."""
-  configurationProductUpdate: JSONString
-
-  """Dashboard product variant create page structure in JSON format."""
-  configurationProductVariantCreate: JSONString
-
-  """Dashboard product variant update page structure in JSON format."""
-  configurationProductVariantUpdate: JSONString
-}
-
 """Represents a job data of exported file."""
 type ExportFile implements Node & Job {
   """The ID of the object"""
@@ -13821,6 +13919,15 @@ type _Service {
 }
 
 type Mutation {
+  """EmailTemplate update mutation."""
+  emailTemplateUpdate(
+    """ID of the email template to update."""
+    id: ID!
+
+    """Fields to update on the email template."""
+    input: EmailTemplateUpdateInput!
+  ): EmailTemplateUpdate
+
   """Create a tenant"""
   tenantCreate(
     """Fields required to create Tenant"""
@@ -13843,7 +13950,7 @@ type Mutation {
     description: String
 
     """
-    Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: image/x-bmp, application/x-dwg, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/gzip, image/gif, application/x-pdf, application/pdf, text/svg, application/acad, text/rtf, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/x-ms-bmp, text/csv, text/x-comma-separated-values, text/svg-xml, application/eps, application/x-dxf, application/excel, application/csv, application/x-autocad, application/x-csv, image/heif-sequence, application/rtf, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/x-rar-compressed, application/dwg, image/tif, application/x-gzip, application/jpg, application/x-zip-compressed, application/postscript, text/x-csv, image/svg+xml, drawing/x-dwf, image/vnd.dwg, application/vnd.pdf, application/msword, application/vnd.oasis.opendocument.spreadsheet, image/png, image/svg, application/x-rtf, image/tiff, application/tiff, application/x-tar, image/x-dwg, image/jpg, application/x-acad, image/jpeg, application/vnd.oasis.opendocument.text, text/pdf, application/gzip-compressed, image/webp, application/vnd.ms-powerpoint, image/heic-sequence, application/x-tif, application/x-rar, application/x-jpg, image/eps, application/x-eps, application/tif, drawing/x-dwg, image/x-dxf, application/vnd.ms-word, text/comma-separated-values, image/heif, application/vnd.ms-excel, text/x-pdf, image/bmp, image/x-tif, application/acrobat, image/dxf, application/svg+xml, application/vnd.oasis.opendocument.presentation, image/heic, application/dxf, text/plain, application/x-tiff, pplication/vnd.rar, image/x-tiff, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, image/x-eps, drawing/dwg, application/zip, application/gzipped.
+    Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: application/x-dwg, image/vnd.dwg, application/x-pdf, text/pdf, image/x-tiff, application/vnd.oasis.opendocument.text, application/svg+xml, application/x-gzip, application/vnd.ms-powerpoint, application/x-tif, image/heic-sequence, image/webp, application/msword, application/jpg, image/x-bmp, image/jpeg, text/x-csv, application/x-rtf, application/tif, image/x-dwg, text/svg-xml, image/png, application/gzip-compressed, text/comma-separated-values, image/svg+xml, application/x-eps, application/x-rar, application/dxf, image/gif, application/postscript, application/x-tar, text/plain, image/x-dxf, application/acad, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-word, text/csv, image/x-eps, text/x-pdf, application/vnd.oasis.opendocument.spreadsheet, application/rtf, image/tif, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/gzipped, drawing/x-dwf, image/bmp, image/x-ms-bmp, image/x-tif, application/dwg, application/x-tiff, application/x-rar-compressed, application/x-csv, drawing/x-dwg, application/excel, image/heif-sequence, application/gzip, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/eps, application/vnd.ms-excel, application/csv, image/svg, application/vnd.pdf, application/x-autocad, drawing/dwg, application/x-zip-compressed, text/x-comma-separated-values, application/x-jpg, application/zip, pplication/vnd.rar, application/acrobat, application/x-acad, image/dxf, image/heif, application/pdf, application/tiff, text/svg, image/jpg, application/vnd.oasis.opendocument.presentation, application/eps, image/heic, application/vnd.openxmlformats-officedocument.presentationml.slideshow, text/rtf, image/tiff, application/x-dxf.
     """
     file: Upload!
 
@@ -15455,27 +15562,6 @@ type Mutation {
     type: LocationTypeEnum!
   ): ProductSetLocationType @deprecated(reason: "Locations will be removed on November 28, 2024.")
 
-  """Submit a rating and review for a product."""
-  productReviewSubmit(
-    """Email address of the reviewer"""
-    emailAddress: String
-
-    """Headline of the product review"""
-    headline: String
-
-    """Encoded ID of the product"""
-    productId: String
-
-    """Display name of the reviewer"""
-    publicName: String
-
-    """Rating for the product from 1 to 5"""
-    rating: String
-
-    """Written product review"""
-    review: String
-  ): ProductReviewSubmit @deprecated(reason: "This will be removed on October 1, 2024.")
-
   """Captures the authorized payment amount."""
   paymentCapture(
     """Transaction amount."""
@@ -16300,7 +16386,7 @@ type Mutation {
 
     """Seller ID"""
     sellerId: ID
-  ): CatalogExport @deprecated(reason: "This mutation is no longer supported. This will be removed on October 1, 2024.")
+  ): CatalogExport
 
   """Export customer list."""
   customersExport(
@@ -16470,12 +16556,6 @@ type Mutation {
     input: CatalogueInput!
   ): VoucherRemoveCatalogues
 
-  """Updates dashboard configuration."""
-  dashboardConfigurationUpdate(
-    """Fields required to update configuration object."""
-    input: DashboardConfigurationInput
-  ): DashboardConfigurationUpdate @deprecated(reason: "This mutation is deprecated and will be removed on October 1, 2024.")
-
   """Gets and sets Explo dashboard embedding token in cookies"""
   dashboardEmbeddingToken: DashboardEmbeddingToken
 
@@ -17250,6 +17330,39 @@ type Mutation {
   ): PermissionGroupDelete
 }
 
+"""EmailTemplate update mutation."""
+type EmailTemplateUpdate {
+  emailTemplate: EmailTemplate
+  notificationErrors: [NotificationError!]!
+}
+
+type NotificationError {
+  """
+  Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
+  """
+  field: String
+
+  """The error message."""
+  message: String!
+
+  """The error code."""
+  code: NotificationErrorCode!
+}
+
+"""An enumeration."""
+enum NotificationErrorCode {
+  GRAPHQL_ERROR
+  NOT_FOUND
+  REQUIRED
+  INVALID
+}
+
+"""Input type for email template update."""
+input EmailTemplateUpdateInput {
+  """The content of the email template."""
+  content: String
+}
+
 """Create a tenant"""
 type TenantCreate {
   tenant: Tenant
@@ -19630,6 +19743,9 @@ input CheckoutThemeCreateInput {
   """Logo file."""
   logo: Upload
 
+  """Favicon file."""
+  faviconImage: Upload
+
   """URL of the favicon."""
   faviconUrl: String
 
@@ -19654,6 +19770,9 @@ input CheckoutThemeInput {
   """Logo file."""
   logo: Upload
 
+  """Favicon file."""
+  faviconImage: Upload
+
   """URL of the favicon."""
   faviconUrl: String
 
@@ -19681,6 +19800,9 @@ input StorefrontThemeInput {
   """Logo file."""
   logo: Upload
 
+  """Favicon file"""
+  faviconImage: Upload
+
   """URL of the favicon."""
   faviconUrl: String
 
@@ -21807,12 +21929,6 @@ type ProductSetLocationType {
   productErrors: [ProductError!]!
 }
 
-"""Submit a rating and review for a product."""
-type ProductReviewSubmit {
-  submissionSuccessful: Boolean
-  productErrors: [ProductError!]!
-}
-
 """Captures the authorized payment amount."""
 type PaymentCapture {
   """Updated payment."""
@@ -23782,53 +23898,6 @@ type VoucherRemoveCatalogues {
   discountErrors: [DiscountError!]!
 }
 
-"""Updates dashboard configuration."""
-type DashboardConfigurationUpdate {
-  """Updated dashboard"""
-  dashboard: Dashboard
-  dashboardConfigurationErrors: [DashboardConfigurationError!]!
-}
-
-type DashboardConfigurationError {
-  """
-  Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
-  """
-  field: String
-
-  """The error message."""
-  message: String!
-
-  """The error code."""
-  code: NauticalConfigurationErrorCode!
-}
-
-input DashboardConfigurationInput {
-  """Name of the element to update."""
-  configurationElement: DashboardConfigurationOptionsEnum!
-
-  """
-  Configuration value to set. This field will not be validated and will be saved as is
-  """
-  configurationValue: JSONString!
-}
-
-enum DashboardConfigurationOptionsEnum {
-  """main_menu"""
-  MAIN_MENU
-
-  """product_create"""
-  PRODUCT_CREATE
-
-  """product_update"""
-  PRODUCT_UPDATE
-
-  """product_variant_create"""
-  PRODUCT_VARIANT_CREATE
-
-  """product_variant_update"""
-  PRODUCT_VARIANT_UPDATE
-}
-
 """Gets and sets Explo dashboard embedding token in cookies"""
 type DashboardEmbeddingToken {
   """JWT token for embedding"""

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nautical-commerce/graphql-schema",
-  "version": "v1.53.0",
+  "version": "v1.53.1-10-g0f6efe437",
   "description": "## Getting Started",
   "main": "./nautical/schema.graphql",
   "scripts": {