@nautical-commerce/graphql-schema 1.65.1 → 1.66.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2194,6 +2194,7 @@ enum EventTypeEnum {
2194
2194
  partial_order_cancel
2195
2195
  order_refund_confirmation
2196
2196
  pending_quote
2197
+ merchant_account_set_password
2197
2198
  account_set_staff_password
2198
2199
  csv_export_products_success
2199
2200
  csv_export_failed
@@ -2592,9 +2593,6 @@ type CountryDisplay {
2592
2593
  """List of required address fields for the country."""
2593
2594
  requiredFields: [String!]
2594
2595
 
2595
- """List of allowed country area choices for this country."""
2596
- allowedCountryAreas: [String!] @deprecated(reason: "Use detailedAllowedCountryAreas instead which returns the code for each area as well. This field will be removed after December 31, 2024.")
2597
-
2598
2596
  """List of allowed country area choices including codes"""
2599
2597
  detailedAllowedCountryAreas: [CountryArea!]!
2600
2598
  }
@@ -2764,7 +2762,6 @@ enum ShippingMethodTypeEnum {
2764
2762
  }
2765
2763
 
2766
2764
  type MultiSellerShippingMethod {
2767
- seller: Int @deprecated(reason: "Use sellerId instead. This will be removed on December 31, 2024.")
2768
2765
  sellerId: ID!
2769
2766
  sellerName: String!
2770
2767
  value: [ShippingMethod!]!
@@ -4711,6 +4708,9 @@ type App implements Node & ObjectWithMetadata {
4711
4708
  """Type of the app."""
4712
4709
  type: AppTypeEnum
4713
4710
 
4711
+ """List of storefront integrations for this app"""
4712
+ storefrontIntegrations: [AppStorefrontIntegration!]
4713
+
4714
4714
  """List of webhooks assigned to this app."""
4715
4715
  webhooks: [Webhook!]
4716
4716
 
@@ -4804,6 +4804,34 @@ enum AppTypeEnum {
4804
4804
  THIRDPARTY
4805
4805
  }
4806
4806
 
4807
+ """Represents a storefront integration for an App."""
4808
+ type AppStorefrontIntegration implements Node {
4809
+ """The ID of the object"""
4810
+ id: ID!
4811
+
4812
+ """
4813
+ App this integration is for. This may be null for integrations that come from plugins.
4814
+ """
4815
+ app: App
4816
+
4817
+ """What context this integration should be rendered in"""
4818
+ context: AppStorefrontIntegrationContextEnum!
4819
+
4820
+ """JSON string of params to pass to the remote component"""
4821
+ params: String!
4822
+
4823
+ """The URL to the remote component to load"""
4824
+ componentUrl: String!
4825
+ }
4826
+
4827
+ enum AppStorefrontIntegrationContextEnum {
4828
+ """Product details page"""
4829
+ PRODUCT_DETAILS
4830
+
4831
+ """Sitewide"""
4832
+ SITE
4833
+ }
4834
+
4807
4835
  """Webhook."""
4808
4836
  type Webhook implements Node {
4809
4837
  name: String!
@@ -7011,7 +7039,7 @@ type AgreementSellersCountableEdge {
7011
7039
  }
7012
7040
 
7013
7041
  """A seller agreement mapping"""
7014
- type AgreementSellers implements Node & ObjectWithMetadata {
7042
+ type AgreementSellers implements Node {
7015
7043
  """The ID of the object"""
7016
7044
  id: ID!
7017
7045
  tenant: Tenant!
@@ -7019,20 +7047,12 @@ type AgreementSellers implements Node & ObjectWithMetadata {
7019
7047
  acknowledgedOn: DateTime
7020
7048
  plan: Agreement
7021
7049
  effectiveAt: DateTime!
7022
-
7023
- """
7024
- List of private metadata items.Requires proper staff permissions to access.
7025
- """
7026
- privateMetadata: [MetadataItem!]!
7027
-
7028
- """List of public metadata items. Can be accessed without permissions."""
7029
- metadata: [MetadataItem!]!
7030
7050
  }
7031
7051
 
7032
7052
  """
7033
7053
  A marketplace agreement created, edited and maintianed in the dashboard
7034
7054
  """
7035
- type Agreement implements Node & ObjectWithMetadata {
7055
+ type Agreement implements Node {
7036
7056
  """The ID of the object"""
7037
7057
  id: ID!
7038
7058
  publicationDate: Date
@@ -7066,14 +7086,6 @@ type Agreement implements Node & ObjectWithMetadata {
7066
7086
 
7067
7087
  """List of extra fees associated with the agreement."""
7068
7088
  fees: [AgreementFees!]!
7069
-
7070
- """
7071
- List of private metadata items.Requires proper staff permissions to access.
7072
- """
7073
- privateMetadata: [MetadataItem!]!
7074
-
7075
- """List of public metadata items. Can be accessed without permissions."""
7076
- metadata: [MetadataItem!]!
7077
7089
  }
7078
7090
 
7079
7091
  enum CommissionTypeEnum {
@@ -7093,20 +7105,12 @@ enum MarkupCommissionTypeEnum {
7093
7105
  }
7094
7106
 
7095
7107
  """An agreement commission"""
7096
- type AgreementCommission implements Node & ObjectWithMetadata {
7108
+ type AgreementCommission implements Node {
7097
7109
  """The ID of the object"""
7098
7110
  id: ID!
7099
7111
  tenant: Tenant!
7100
7112
  commission: Decimal!
7101
7113
  agreement: Agreement!
7102
-
7103
- """
7104
- List of private metadata items.Requires proper staff permissions to access.
7105
- """
7106
- privateMetadata: [MetadataItem!]!
7107
-
7108
- """List of public metadata items. Can be accessed without permissions."""
7109
- metadata: [MetadataItem!]!
7110
7114
  instance: Category
7111
7115
  }
7112
7116
 
@@ -8671,7 +8675,15 @@ type Shop {
8671
8675
  """
8672
8676
  None if shop does not use Crisp, otherwise this contains Crisp Website ID.
8673
8677
  """
8674
- crispWebsiteId: String
8678
+ crispWebsiteId: String @deprecated(reason: "This will be removed on April 7, 2025.")
8679
+
8680
+ """Storefront integrations for the given contexts"""
8681
+ storefrontUiIntegrations(
8682
+ """
8683
+ Contexts that integrations should be filtered to. If not specified, all contexts will be returned.
8684
+ """
8685
+ contexts: [AppStorefrontIntegrationContextEnum!]
8686
+ ): [AppStorefrontIntegration!]!
8675
8687
 
8676
8688
  """Determines whether seller products require approval"""
8677
8689
  requireProductApproval: Boolean
@@ -8942,7 +8954,7 @@ input ShippingZoneFilterInput {
8942
8954
  search: String
8943
8955
  }
8944
8956
 
8945
- type PublicSeller implements Node {
8957
+ type PublicSeller implements Node & ObjectWithMetadata {
8946
8958
  """The ID of the object"""
8947
8959
  id: ID!
8948
8960
  companyName: String!
@@ -8958,6 +8970,14 @@ type PublicSeller implements Node {
8958
8970
  ): Image
8959
8971
  products(offset: Int, before: String, after: String, first: Int, last: Int): ProductCountableConnection!
8960
8972
  variants(offset: Int, before: String, after: String, first: Int, last: Int): ProductVariantCountableConnection!
8973
+
8974
+ """
8975
+ List of private metadata items.Requires proper staff permissions to access.
8976
+ """
8977
+ privateMetadata: [MetadataItem!]!
8978
+
8979
+ """List of public metadata items. Can be accessed without permissions."""
8980
+ metadata: [MetadataItem!]!
8961
8981
  storeDescription: String
8962
8982
  storeDescriptionPlainText: String
8963
8983
  }
@@ -11005,6 +11025,11 @@ type MarketplaceConfiguration {
11005
11025
  customerSetPasswordUrl: String
11006
11026
  includeTaxesInPrices: Boolean!
11007
11027
  chargeTaxesOnShipping: Boolean!
11028
+
11029
+ """
11030
+ The marketplace's end trial date, or null if the marketplace is not in trial mode.
11031
+ """
11032
+ trialEndsAt: DateTime
11008
11033
  }
11009
11034
 
11010
11035
  enum MarketplaceConfigurationPayoutAutomationStrategyEnum {
@@ -11693,6 +11718,9 @@ enum EmailEventMessageType {
11693
11718
  """Pending Quote"""
11694
11719
  PENDING_QUOTE
11695
11720
 
11721
+ """Merchant Account Set Password"""
11722
+ MERCHANT_ACCOUNT_SET_PASSWORD
11723
+
11696
11724
  """Account Set Staff Password"""
11697
11725
  ACCOUNT_SET_STAFF_PASSWORD
11698
11726
 
@@ -11813,6 +11841,9 @@ enum NotifyEventTypeEnum {
11813
11841
  """Pending Quote"""
11814
11842
  PENDING_QUOTE
11815
11843
 
11844
+ """Merchant Account Set Password"""
11845
+ MERCHANT_ACCOUNT_SET_PASSWORD
11846
+
11816
11847
  """Account Set Staff Password"""
11817
11848
  ACCOUNT_SET_STAFF_PASSWORD
11818
11849
 
@@ -13172,7 +13203,7 @@ type Mutation {
13172
13203
  description: String
13173
13204
 
13174
13205
  """
13175
- Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: text/plain, text/csv, application/x-zip-compressed, application/csv, image/heic, application/gzip, application/svg+xml, image/tif, application/dxf, application/gzipped, application/vnd.ms-excel, application/vnd.oasis.opendocument.text, image/x-dxf, image/x-dwg, application/postscript, image/bmp, text/rtf, text/svg, application/x-pdf, text/comma-separated-values, application/vnd.oasis.opendocument.spreadsheet, application/x-gzip, application/acrobat, application/vnd.pdf, application/zip, application/x-tif, pplication/vnd.rar, image/webp, text/pdf, drawing/x-dwg, application/x-jpg, application/vnd.ms-word, application/x-csv, application/tiff, image/jpeg, application/acad, application/vnd.openxmlformats-officedocument.presentationml.presentation, image/tiff, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/svg, application/x-tar, text/x-csv, text/x-comma-separated-values, application/vnd.oasis.opendocument.presentation, application/x-rar-compressed, application/rtf, application/jpg, image/eps, application/x-rar, image/x-ms-bmp, image/heif, application/vnd.ms-powerpoint, image/x-bmp, application/x-dxf, text/x-pdf, image/x-eps, application/x-tiff, image/vnd.dwg, application/excel, application/x-eps, image/svg+xml, application/tif, drawing/dwg, image/x-tiff, application/eps, image/heif-sequence, application/x-dwg, image/x-tif, text/svg-xml, application/dwg, image/heic-sequence, application/pdf, application/vnd.openxmlformats-officedocument.presentationml.slideshow, image/gif, image/dxf, image/png, application/x-autocad, application/msword, image/jpg, application/gzip-compressed, drawing/x-dwf, application/x-acad, application/x-rtf, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.
13206
+ Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: image/webp, image/x-dwg, application/dwg, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/csv, text/x-pdf, application/x-eps, application/vnd.oasis.opendocument.text, application/gzipped, application/zip, text/csv, application/x-tif, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, image/x-eps, application/x-jpg, image/bmp, image/tiff, application/svg+xml, application/vnd.openxmlformats-officedocument.presentationml.slideshow, image/tif, image/svg, image/x-bmp, application/dxf, application/rtf, application/vnd.ms-word, application/x-pdf, text/comma-separated-values, application/x-dxf, application/gzip-compressed, application/vnd.pdf, application/x-rtf, image/x-tif, application/tiff, text/rtf, application/pdf, image/jpeg, image/png, pplication/vnd.rar, application/x-zip-compressed, text/pdf, text/plain, application/x-rar-compressed, text/x-comma-separated-values, application/acad, image/heic, application/x-tar, application/jpg, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/excel, application/vnd.ms-excel, application/msword, image/x-ms-bmp, text/svg-xml, image/jpg, application/vnd.oasis.opendocument.presentation, image/dxf, text/svg, image/vnd.dwg, application/vnd.oasis.opendocument.spreadsheet, image/gif, application/acrobat, application/x-rar, application/gzip, application/x-autocad, image/heif-sequence, application/postscript, drawing/x-dwg, image/svg+xml, application/x-gzip, application/x-dwg, application/x-tiff, application/tif, application/eps, drawing/x-dwf, text/x-csv, image/eps, application/x-csv, image/x-tiff, image/heif, application/x-acad, application/vnd.ms-powerpoint, image/heic-sequence, image/x-dxf, drawing/dwg.
13176
13207
  """
13177
13208
  file: Upload!
13178
13209
 
@@ -15999,6 +16030,18 @@ type Mutation {
15999
16030
  token: String!
16000
16031
  ): AppTokenVerify
16001
16032
 
16033
+ """Creates a new storefront integration for an app."""
16034
+ appStorefrontIntegrationCreate(
16035
+ """Fields required to create a storefront integration."""
16036
+ input: AppStorefrontIntegrationInput!
16037
+ ): AppStorefrontIntegrationCreate
16038
+
16039
+ """Deletes an app storefront integration from the app."""
16040
+ appStorefrontIntegrationDelete(
16041
+ """ID of a app storefront integration to delete."""
16042
+ id: ID!
16043
+ ): AppStorefrontIntegrationDelete
16044
+
16002
16045
  """Install new app by using app manifest."""
16003
16046
  appInstall(
16004
16047
  """Fields required to install a new app."""
@@ -23048,6 +23091,34 @@ type AppTokenVerify {
23048
23091
  appErrors: [AppError!]!
23049
23092
  }
23050
23093
 
23094
+ """Creates a new storefront integration for an app."""
23095
+ type AppStorefrontIntegrationCreate {
23096
+ appErrors: [AppError!]!
23097
+ appStorefrontIntegration: AppStorefrontIntegration
23098
+ }
23099
+
23100
+ input AppStorefrontIntegrationInput {
23101
+ """ID of app."""
23102
+ app: ID!
23103
+
23104
+ """URL to the remote component to load"""
23105
+ componentUrl: String!
23106
+
23107
+ """Context for where this integration should render"""
23108
+ context: AppStorefrontIntegrationContextEnum!
23109
+
23110
+ """
23111
+ JSON formatted string containing any params to pass to the component during render
23112
+ """
23113
+ params: String
23114
+ }
23115
+
23116
+ """Deletes an app storefront integration from the app."""
23117
+ type AppStorefrontIntegrationDelete {
23118
+ appErrors: [AppError!]!
23119
+ appStorefrontIntegration: AppStorefrontIntegration
23120
+ }
23121
+
23051
23122
  """Install new app by using app manifest."""
23052
23123
  type AppInstall {
23053
23124
  appErrors: [AppError!]!
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nautical-commerce/graphql-schema",
3
- "version": "v1.65.1",
3
+ "version": "v1.66.0",
4
4
  "description": "## Getting Started",
5
5
  "main": "./nautical/schema.graphql",
6
6
  "scripts": {