@nautical-commerce/graphql-schema 1.49.1 → 1.50.0-10-g06972ffcc

package/nautical/schema.graphql

@@ -205,6 +205,27 @@ type Query {
     last: Int
   ): MediaCountableConnection
 
+  """Look up a tenant by ID."""
+  tenant(
+    """ID of a tenant."""
+    id: ID!
+  ): Tenant
+
+  """List of tenants."""
+  tenants(
+    """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
+  ): TenantCountableConnection
+
   """Return information about the shop."""
   shop: Shop!
 
@@ -1633,6 +1654,27 @@ type Query {
     dimension: String
   ): DashboardGraphType
 
+  """List of the fonts for the storefront."""
+  fontList(
+    """Filtering options for fonts for storefront."""
+    filter: ContentFilterInput
+
+    """Sort fonts for storefront."""
+    sortBy: ContentSortingInput
+
+    """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
+  ): FontCountableConnection
+
   """List of journal entries in the ledger system."""
   journalEntries(
     """Filtering options for journal entries."""
@@ -3317,11 +3359,20 @@ type SellerUserTypeCountableEdge {
 type SellerUserType implements Node {
   """The ID of the object"""
   id: ID!
+  tenant: Tenant!
   seller: Seller!
   user: User!
   isDefault: Boolean!
 }
 
+"""Represents a Tenant in a multi-tenant deployment"""
+type Tenant implements Node {
+  """The ID of the object"""
+  id: ID!
+  name: String!
+  isActive: Boolean!
+}
+
 type SellerEventTypeCountableConnection {
   """Pagination data for this connection."""
   pageInfo: PageInfo!
@@ -3379,6 +3430,7 @@ type SellerOnboardingChecklist implements Node {
   id: ID!
   createdAt: DateTime!
   updatedAt: DateTime!
+  tenant: Tenant!
   seller: Seller!
   position: Int!
   title: String!
@@ -3400,6 +3452,15 @@ enum SellerChecklistCompetitionTriggersEnum {
 
   """First Product Created"""
   FIRST_PRODUCT_CREATED
+
+  """First Shipping Zone Created"""
+  FIRST_SHIPPING_ZONE_CREATED
+
+  """Page Setup in Store"""
+  PAGE_SETUP_IN_STORE
+
+  """Invite Staff"""
+  INVITE_STAFF
 }
 
 type SellerApplication implements Node {
@@ -3476,6 +3537,7 @@ type VendorPayout implements Node & ObjectWithMetadata {
 
   """List of public metadata items. Can be accessed without permissions."""
   metadata: [MetadataItem!]!
+  tenant: Tenant!
   created: DateTime!
   updated: DateTime!
   gateway: String!
@@ -3532,6 +3594,7 @@ type Payout implements Node & ObjectWithMetadata {
 
   """List of public metadata items. Can be accessed without permissions."""
   metadata: [MetadataItem!]!
+  tenant: Tenant!
   created: String!
   updated: DateTime!
   startDate: Date
@@ -4642,6 +4705,7 @@ type ProductTypeProductFeature implements Node {
   """The ID of the object"""
   id: ID!
   sortOrder: Int
+  tenant: Tenant!
 
   """The type that we expect to render the feature's values as."""
   featureType: FeatureTypeEnum!
@@ -4691,6 +4755,7 @@ type ProductFeature implements Node {
   deletedByUser: User
   deletedByApp: App
   deletionBatchUuid: UUID
+  tenant: Tenant!
 
   """The type that we expect to render the feature's values as."""
   featureType: FeatureTypeEnum!
@@ -4936,6 +5001,7 @@ type ProductTypeVariantFeature implements Node {
   """The ID of the object"""
   id: ID!
   sortOrder: Int
+  tenant: Tenant!
 
   """The type that we expect to render the feature's values as."""
   featureType: FeatureTypeEnum!
@@ -4970,6 +5036,7 @@ type VariantFeature implements Node {
   """The ID of the object"""
   id: ID!
   sortOrder: Int
+  tenant: Tenant!
 
   """The type that we expect to render the feature's values as."""
   featureType: FeatureTypeEnum!
@@ -5025,6 +5092,7 @@ type AttributeValue implements Node {
   """The ID of the object"""
   id: ID!
   sortOrder: Int
+  tenant: Tenant!
 
   """Name of a value displayed in the interface."""
   name: String!
@@ -5439,6 +5507,7 @@ type AffiliateCodes implements Node {
 type Channel implements Node {
   """The ID of the object"""
   id: ID!
+  tenant: Tenant!
   createdAt: DateTime
   updatedAt: DateTime
   channel: String!
@@ -6855,6 +6924,7 @@ type Bid implements Node {
   id: ID!
   privateMetadata: JSONString!
   metadata: JSONString!
+  tenant: Tenant!
   createdAt: DateTime!
   updatedAt: DateTime!
   status: BidStatus!
@@ -7122,6 +7192,7 @@ enum RefundTypeEnum {
 type OrderFee implements Node {
   """The ID of the object"""
   id: ID!
+  tenant: Tenant!
   order: Order
 
   """Currency of the fee."""
@@ -7294,6 +7365,7 @@ type AgreementSellersCountableEdge {
 type AgreementSellers implements Node & ObjectWithMetadata {
   """The ID of the object"""
   id: ID!
+  tenant: Tenant!
   seller: Seller!
   acknowledgedOn: DateTime
   plan: Agreement
@@ -7321,6 +7393,7 @@ type Agreement implements Node & ObjectWithMetadata {
   content: String!
   contentHtml: String!
   contentJson: JSONString!
+  tenant: Tenant!
   seoTitle: String
   seoDescription: String
   slug: String!
@@ -7395,6 +7468,7 @@ enum AgreementAgreementType {
 type AgreementCommission implements Node & ObjectWithMetadata {
   """The ID of the object"""
   id: ID!
+  tenant: Tenant!
   commission: Decimal!
   agreement: Agreement!
 
@@ -7412,6 +7486,7 @@ type AgreementCommission implements Node & ObjectWithMetadata {
 type AgreementFees implements Node {
   """The ID of the object"""
   id: ID!
+  tenant: Tenant!
   agreement: Agreement!
 
   """type of fee"""
@@ -7517,6 +7592,7 @@ type Document {
   id: ID!
   createdAt: DateTime!
   updatedAt: DateTime!
+  tenant: Tenant!
   file: String!
   name: String!
   description: String!
@@ -8135,6 +8211,8 @@ type AddressType implements Node & ObjectWithMetadata {
 
 """Represents an shipping method for a particular seller on a checkout."""
 type CheckoutSellerShipping implements Node {
+  tenant: Tenant!
+
   """The ID of the object"""
   id: ID!
   seller: Seller!
@@ -8487,6 +8565,7 @@ type WebhookEventLogCountableEdge {
 type WebhookEventLog implements Node {
   """The ID of the object"""
   id: ID!
+  tenant: Tenant!
 
   """
   Created event time. Naming is used to keep consistent with OrderEvent/SellerEvent naming
@@ -8550,6 +8629,7 @@ type WebhookJob implements Node & Job {
 
   """Date time of job last update in ISO 8601 format."""
   updatedAt: DateTime!
+  tenant: Tenant!
   body: JSONString
   requestMeta: JSONString
   source: String
@@ -8847,6 +8927,8 @@ enum ContentSortField {
 
 """Media object."""
 type Media implements Node {
+  tenant: Tenant!
+
   """The ID of the object"""
   id: ID!
 
@@ -8895,6 +8977,23 @@ enum MediaSortField {
   CREATED_AT
 }
 
+type TenantCountableConnection {
+  """Pagination data for this connection."""
+  pageInfo: PageInfo!
+  edges: [TenantCountableEdge!]!
+
+  """A total count of items in the collection."""
+  totalCount: Int
+}
+
+type TenantCountableEdge {
+  """The item at the end of the edge."""
+  node: Tenant!
+
+  """A cursor for use in pagination."""
+  cursor: String!
+}
+
 """
 Represents a shop resource containing general shop data and configuration.
 """
@@ -8947,9 +9046,6 @@ type Shop {
   """Dashboard url for the shop."""
   dashboardUrl: String
 
-  """Whether the marketplace has enabled master products"""
-  enableMasterProducts: Boolean @deprecated(reason: "Master product mode is deprecated. This will be removed on September 12, 2024")
-
   """Whether the marketplace has enabled quote orders."""
   enableQuoteOrders: Boolean
 
@@ -9027,16 +9123,6 @@ type Shop {
   crispWebsiteId: String
   geolocationEnabled: Boolean @deprecated(reason: "Locations will be removed on November 28, 2024.")
 
-  """
-  Enable master product over products. When this option is enabled, then seller's product variant can be assigned to master products where owner is marketplace.
-  """
-  masterProductManagementEnabled: Boolean @deprecated(reason: "Master product mode is deprecated. This will be removed on September 12, 2024")
-
-  """
-  Min checkout amount for all orders for marketplace (in the currency of marketplace)
-  """
-  minCheckoutAmount: PositiveDecimal @deprecated(reason: "Hosted checkout will handle minimum amount requirements for payment processors. This will be removed on September 12, 2024, and will always be 0.00 for now.")
-
   """Determines whether seller products require approval"""
   requireProductApproval: Boolean
 
@@ -9218,6 +9304,7 @@ type Plugin implements Node {
   allowManyActivePluginsInCategory: Boolean!
   paymentType: PluginConfigurationPaymentType!
   rating: PluginConfigurationRating!
+  tenant: Tenant!
   identifier: String!
   name: String!
   description: String!
@@ -9377,13 +9464,6 @@ enum ConfigurationTypeFieldEnum {
   OUTPUT
 }
 
-"""
-Positive Decimal scalar implementation.
-
-Should be used in places where value must be positive.
-"""
-scalar PositiveDecimal
-
 """Represents a checkout page's theme options."""
 type CheckoutTheme implements Node {
   """The ID of the object"""
@@ -9420,6 +9500,21 @@ type StorefrontTheme implements Node {
 
   """URL of the favicon."""
   faviconUrl: String
+
+  """Font to be used on the storefront"""
+  font: Font
+}
+
+"""Font for a storefront."""
+type Font implements Node {
+  """The ID of the object"""
+  id: ID!
+
+  """Name of the font."""
+  name: String
+
+  """Slug of the font."""
+  slug: String
 }
 
 """Represents seller onboarding settings from the MPO."""
@@ -9433,6 +9528,9 @@ type SellerOnboardingSettings implements Node {
   """Summary of the MP for sellers."""
   summary: String
 
+  """Welcome message set by MP for sellers."""
+  welcomeMessage: String
+
   """The fulfillment model used by the MP."""
   fulfillmentModel: String
 
@@ -9441,6 +9539,9 @@ type SellerOnboardingSettings implements Node {
 
   """Text displayed when the MP is not accepting new sellers."""
   notAcceptingSellersMessage: String
+
+  """Shows if the seller is allowed to import products."""
+  isProductImportAllowed: Boolean
 }
 
 input ShippingZoneFilterInput {
@@ -10279,6 +10380,7 @@ type BusinessEntity implements Node & ObjectWithMetadata {
   metadata: [MetadataItem!]!
   createdAt: DateTime!
   updatedAt: DateTime!
+  tenant: Tenant!
   externalPayoutAccountId: String
   externalPayoutSource: BusinessEntityExternalPayoutSource
   externalPayoutOnboardingUrl: String
@@ -10741,6 +10843,7 @@ type TypeformFormOption {
 """Flow mapping for a plugin"""
 type Flow {
   id: ID!
+  tenant: Tenant!
   identifier: String!
   seller: Seller
   process: FlowProcess!
@@ -10779,6 +10882,13 @@ input StripeClientPaymentData {
   paymentMethodToken: String
 }
 
+"""
+Positive Decimal scalar implementation.
+
+Should be used in places where value must be positive.
+"""
+scalar PositiveDecimal
+
 input AddressInput {
   """Given name."""
   firstName: String
@@ -10864,6 +10974,8 @@ type CheckoutEventCountableEdge {
 
 """Represents checkout event."""
 type CheckoutEvent implements Node {
+  tenant: Tenant!
+
   """The ID of the object"""
   id: ID!
   createdAt: DateTime!
@@ -11522,6 +11634,8 @@ input MenuItemFilterInput {
 
 """Represents a marketplace configuration resource."""
 type MarketplaceConfiguration {
+  tenant: Tenant!
+  id: UUID!
   marketplaceName: String!
   maxProductsInGroup: Int!
 
@@ -11600,21 +11714,6 @@ type MarketplaceConfiguration {
   includeTaxesInPrices: Boolean!
   chargeTaxesOnShipping: Boolean!
 
-  """
-  Deprecated: Maximum total quantity of all items allowed in a checkout, will always be 0 until full removal after deprecation period
-  """
-  maxCheckoutQuantity: Int! @deprecated(reason: "Maximum quantities are only be based on stock availability rather than this additional configuration item. This will be removed on September 12, 2024, and will always be 0 for now.")
-
-  """
-  Deprecated: Maximum line quantity of a single item allowed in a checkout, will always be 0 until full removal after deprecation period
-  """
-  maxCheckoutLineQuantity: Int! @deprecated(reason: "Maximum quantities are only be based on stock availability rather than this additional configuration item. This will be removed on September 12, 2024, and will always be 0 for now.")
-
-  """
-  Min checkout amount for all orders for marketplace (in the currency of marketplace)
-  """
-  minCheckoutAmount: PositiveDecimal! @deprecated(reason: "Hosted checkout will handle minimum amount requirements for payment processors. This will be removed on September 12, 2024, and will always be 0.00 for now.")
-
   """
   Deprecated: This field will always be overridden as True and will be removed on Nov 1, 2024.
   """
@@ -12241,6 +12340,7 @@ type EmailEventCountableEdge {
 type EmailEvent implements Node {
   """The ID of the object"""
   id: ID!
+  tenant: Tenant!
 
   """
   Created event time. Naming is used to keep consistent with OrderEvent/SellerEvent naming
@@ -13087,6 +13187,23 @@ type GraphDataType {
   dimension: DateTime
 }
 
+type FontCountableConnection {
+  """Pagination data for this connection."""
+  pageInfo: PageInfo!
+  edges: [FontCountableEdge!]!
+
+  """A total count of items in the collection."""
+  totalCount: Int
+}
+
+type FontCountableEdge {
+  """The item at the end of the edge."""
+  node: Font!
+
+  """A cursor for use in pagination."""
+  cursor: String!
+}
+
 type JournalEntryCountableConnection {
   """Pagination data for this connection."""
   pageInfo: PageInfo!
@@ -13426,12 +13543,14 @@ enum VoucherSortField {
 }
 
 type DesignerDataType {
+  tenant: Tenant!
   name: String!
   jsonContent: JSONString!
 }
 
 type BrandingType {
   id: ID!
+  tenant: Tenant!
   jsonContent: JSONString!
   logo(
     """Size of the image."""
@@ -13582,6 +13701,7 @@ enum ExportFileSortField {
 }
 
 type CoreDataType {
+  tenant: Tenant!
   name: String!
   jsonContent: JSONString!
 }
@@ -13951,6 +14071,20 @@ type _Service {
 }
 
 type Mutation {
+  """Create a tenant"""
+  tenantCreate(
+    """Fields required to create Tenant"""
+    input: TenantCreateInput!
+  ): TenantCreate
+
+  """Update a tenant"""
+  tenantUpdate(
+    id: ID!
+
+    """Fields required to create Tenant"""
+    input: TenantUpdateInput!
+  ): TenantUpdate
+
   """Creates a new business entity."""
   businessEntityCreate(
     """Input fields required to create a business entity"""
@@ -13980,7 +14114,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: text/svg, application/gzip, application/rtf, image/heic, image/svg, image/webp, image/x-tiff, application/x-eps, application/excel, application/x-tar, application/x-dxf, application/eps, image/tif, application/pdf, application/x-zip-compressed, application/gzipped, application/zip, drawing/x-dwf, image/jpeg, text/comma-separated-values, application/x-acad, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.ms-word, application/postscript, application/x-dwg, application/dwg, application/vnd.ms-excel, application/vnd.pdf, application/tif, application/dxf, application/vnd.oasis.opendocument.spreadsheet, image/x-eps, image/tiff, application/x-gzip, application/jpg, application/svg+xml, image/svg+xml, image/bmp, application/x-pdf, application/x-tiff, application/x-autocad, image/x-dwg, application/vnd.oasis.opendocument.presentation, drawing/x-dwg, text/rtf, application/x-tif, application/acrobat, image/png, image/heif-sequence, image/vnd.dwg, image/x-dxf, application/vnd.ms-powerpoint, application/x-csv, application/tiff, image/x-bmp, application/x-rtf, application/x-rar, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, image/dxf, drawing/dwg, pplication/vnd.rar, text/svg-xml, text/csv, application/acad, text/plain, text/x-csv, text/pdf, text/x-pdf, image/gif, image/jpg, application/gzip-compressed, image/x-tif, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.oasis.opendocument.text, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/csv, image/heif, application/x-jpg, application/x-rar-compressed, image/heic-sequence, image/x-ms-bmp, text/x-comma-separated-values, image/eps, application/msword.
+    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-zip-compressed, text/plain, drawing/x-dwf, application/x-dwg, application/pdf, application/x-rtf, image/svg, image/x-bmp, application/rtf, application/eps, application/vnd.ms-word, text/svg-xml, image/gif, image/x-tiff, application/csv, text/comma-separated-values, application/gzip, application/gzipped, application/x-autocad, application/vnd.oasis.opendocument.presentation, image/heic-sequence, image/jpg, application/x-rar, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/x-gzip, application/jpg, application/vnd.oasis.opendocument.spreadsheet, image/heif-sequence, application/excel, application/vnd.ms-excel, text/csv, image/svg+xml, image/bmp, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/x-jpg, image/heic, application/x-tif, application/x-tar, application/zip, image/heif, application/x-rar-compressed, application/x-dxf, application/postscript, image/jpeg, application/vnd.ms-powerpoint, application/tiff, text/svg, application/acrobat, image/x-dwg, application/dwg, application/tif, image/x-tif, text/pdf, image/tif, application/gzip-compressed, text/rtf, image/vnd.dwg, image/x-eps, application/x-acad, pplication/vnd.rar, application/dxf, application/x-csv, text/x-csv, image/png, drawing/dwg, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/vnd.pdf, application/vnd.oasis.opendocument.text, image/webp, image/x-ms-bmp, text/x-pdf, image/x-dxf, text/x-comma-separated-values, application/x-eps, application/x-pdf, image/eps, application/acad, application/x-tiff, image/tiff, drawing/x-dwg, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/msword, application/svg+xml, image/dxf.
     """
     file: Upload!
 
@@ -17385,6 +17519,60 @@ type Mutation {
   ): PermissionGroupDelete
 }
 
+"""Create a tenant"""
+type TenantCreate {
+  tenant: Tenant
+  tenantErrors: [TenantError!]!
+}
+
+type TenantError {
+  """
+  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: TenantErrorCode!
+}
+
+"""An enumeration."""
+enum TenantErrorCode {
+  NOT_FOUND
+  REQUIRED
+  GRAPHQL_ERROR
+  INVALID
+  ALREADY_EXISTS
+  NOT_ALLOWED
+}
+
+input TenantCreateInput {
+  """The name of the tenant"""
+  name: String!
+
+  """The URL of the dashboard for this tenant"""
+  dashboardUrl: String!
+
+  """The URL of storefront for this tenant"""
+  storefrontUrl: String!
+
+  """If true, trial env data will be created in the tenant"""
+  populateTrialData: Boolean
+}
+
+"""Update a tenant"""
+type TenantUpdate {
+  tenant: Tenant
+  tenantErrors: [TenantError!]!
+}
+
+input TenantUpdateInput {
+  isActive: Boolean
+  name: String
+}
+
 """Creates a new business entity."""
 type BusinessEntityCreate {
   businessEntityErrors: [BusinessEntityError!]!
@@ -18928,7 +19116,7 @@ input SellerAgreementInput {
   agreement: ID!
 
   """When this agreement becomes effective for the seller"""
-  effectiveAt: DateTime!
+  effectiveAt: Date!
 
   """ID of seller that agreed to plan"""
   seller: ID!
@@ -19834,6 +20022,9 @@ input StorefrontThemeInput {
 
   """URL of the favicon."""
   faviconUrl: String
+
+  """ID of of the selected font."""
+  font: String
 }
 
 """Update a storefront theme."""
@@ -19857,6 +20048,9 @@ input SellerOnboardingSettingsCreateInput {
   """Summary of the MP for sellers."""
   summary: String!
 
+  """Welcome message set by MP for sellers."""
+  welcomeMessage: String
+
   """The fulfillment model used by the MP."""
   fulfillmentModel: String!
 
@@ -19881,6 +20075,9 @@ input SellerOnboardingSettingsUpdateInput {
   """Summary of the MP for sellers."""
   summary: String
 
+  """Welcome message set by MP for sellers."""
+  welcomeMessage: String
+
   """The fulfillment model used by the MP."""
   fulfillmentModel: String
 

package/package.json

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