@nautical-commerce/graphql-schema 1.53.1 → 1.54.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.
@@ -14,6 +14,15 @@ type Query {
14
14
  id: ID!
15
15
  ): EmailTemplate
16
16
 
17
+ """Preview a template rendered."""
18
+ emailTemplatePreview(
19
+ """ID of an email template."""
20
+ id: ID!
21
+
22
+ """Rendered content to be previewed."""
23
+ content: String!
24
+ ): EmailTemplatePreview
25
+
17
26
  """List of email templates."""
18
27
  emailTemplates(
19
28
  """Filtering options for email templates."""
@@ -637,7 +646,6 @@ type Query {
637
646
  """Return the last n elements from the list."""
638
647
  last: Int
639
648
  ): ProductVariantCountableConnection
640
- productRatingsAndReviews(productId: String!): ProductRatingsAndReviews @deprecated(reason: "This will be removed on October 1, 2024.")
641
649
 
642
650
  """Look up a price book by ID."""
643
651
  priceBook(
@@ -1382,7 +1390,7 @@ type Query {
1382
1390
 
1383
1391
  """Slug of the microsite"""
1384
1392
  slug: String
1385
- ): Microsite
1393
+ ): Microsite @deprecated(reason: "Microsites will be removed on January 2, 2025.")
1386
1394
 
1387
1395
  """List of microsites"""
1388
1396
  microsites(
@@ -1403,13 +1411,13 @@ type Query {
1403
1411
 
1404
1412
  """Return the last n elements from the list."""
1405
1413
  last: Int
1406
- ): MicrositeCountableConnection
1414
+ ): MicrositeCountableConnection @deprecated(reason: "Microsites will be removed on January 2, 2025.")
1407
1415
 
1408
1416
  """Look up microsite by vendor ID"""
1409
1417
  vendorMicrosite(
1410
1418
  """ID of vendor to fetch microsite for."""
1411
1419
  id: ID!
1412
- ): Microsite
1420
+ ): Microsite @deprecated(reason: "Microsites will be removed on January 2, 2025.")
1413
1421
 
1414
1422
  """Look up a navigation menu by ID or name."""
1415
1423
  menu(
@@ -1788,9 +1796,6 @@ type Query {
1788
1796
  designerdatalist: [DesignerDataType!]! @deprecated(reason: "This will be removed on October 25, 2024")
1789
1797
  branding: BrandingType! @deprecated(reason: "This will be removed on October 25, 2024")
1790
1798
 
1791
- """Return information about the dashboard."""
1792
- dashboard: Dashboard! @deprecated(reason: "This query is deprecated and will be removed on October 1, 2024.")
1793
-
1794
1799
  """Token nexessary for connecting to the embedded integration platform"""
1795
1800
  integrationEmbeddingToken: String
1796
1801
 
@@ -2166,8 +2171,11 @@ type EmailTemplate implements Node {
2166
2171
  id: ID!
2167
2172
  title: String!
2168
2173
  subject: String!
2174
+ senderEmailAddress: String
2169
2175
  content: String
2176
+ defaultContent: String
2170
2177
  renderedContent: String
2178
+ description: String
2171
2179
  isCustom: Boolean!
2172
2180
  isActive: Boolean!
2173
2181
  isEditable: Boolean!
@@ -2230,6 +2238,12 @@ enum EventTypeEnum {
2230
2238
  vendor_payout_confirmation
2231
2239
  pending_seller
2232
2240
  updated_status
2241
+ seller_status_pending
2242
+ seller_status_approved
2243
+ seller_status_declined
2244
+ seller_status_paused
2245
+ seller_agreement_accepted
2246
+ seller_agreement_not_accepted
2233
2247
  vin_decode_success
2234
2248
  vin_decode_failed
2235
2249
  import_catalog_failed
@@ -2243,6 +2257,15 @@ enum EventTypeEnum {
2243
2257
  quote_requested
2244
2258
  }
2245
2259
 
2260
+ """Represents an email template preview."""
2261
+ type EmailTemplatePreview {
2262
+ """ID of the email template"""
2263
+ id: ID
2264
+
2265
+ """The content of the email template"""
2266
+ renderedContent: String
2267
+ }
2268
+
2246
2269
  type EmailTemplateCountableConnection {
2247
2270
  """Pagination data for this connection."""
2248
2271
  pageInfo: PageInfo!
@@ -2979,7 +3002,7 @@ type ProductVariant implements Node & ObjectWithMetadata {
2979
3002
 
2980
3003
  """Total quantity ordered."""
2981
3004
  quantityOrdered: Int
2982
- features: [VariantFeature!]
3005
+ features: [VariantFeature!] @deprecated(reason: "Features will be removed on January 2, 2025.")
2983
3006
 
2984
3007
  """
2985
3008
  List of product variant images. When 'strict_product_image_handling' is enabled:- Display only the images owned by the product variant owner.
@@ -3175,7 +3198,7 @@ type Product implements Node & ObjectWithMetadata {
3175
3198
 
3176
3199
  """Whether the product is published."""
3177
3200
  isPublished: Boolean!
3178
- features: [ProductFeature!]
3201
+ features: [ProductFeature!] @deprecated(reason: "Features will be removed on January 2, 2025.")
3179
3202
 
3180
3203
  """List of all product's locations."""
3181
3204
  locations: [Location!] @deprecated(reason: "Locations will be removed on November 28, 2024.")
@@ -3215,6 +3238,9 @@ type Product implements Node & ObjectWithMetadata {
3215
3238
  The product's sorting priority weight in query results. A larger value indicates a higher priority. This field can be used in both ascending and descending sorting methods.
3216
3239
  """
3217
3240
  sortPriorityWeight: Decimal
3241
+
3242
+ """List of logs for product status changes."""
3243
+ productStatusLogs: [ProductStatusLog!]
3218
3244
  }
3219
3245
 
3220
3246
  """
@@ -3233,6 +3259,11 @@ type Seller implements Node & ObjectWithMetadata {
3233
3259
  """Size of the avatar."""
3234
3260
  size: Int
3235
3261
  ): Image
3262
+ status: SellerStatus!
3263
+ banner(
3264
+ """Size of the banner."""
3265
+ size: Int
3266
+ ): Image
3236
3267
  products(offset: Int, before: String, after: String, first: Int, last: Int): ProductCountableConnection!
3237
3268
  variants(offset: Int, before: String, after: String, first: Int, last: Int): ProductVariantCountableConnection!
3238
3269
  externalPayoutAccountId: String
@@ -3250,11 +3281,6 @@ type Seller implements Node & ObjectWithMetadata {
3250
3281
  owner: User
3251
3282
  defaultCurrency: String!
3252
3283
  fulfilledByMarketplace: Boolean!
3253
- status: SellerStatus!
3254
- banner(
3255
- """Size of the banner."""
3256
- size: Int
3257
- ): Image
3258
3284
  sellerusers(offset: Int, before: String, after: String, first: Int, last: Int): SellerUserTypeCountableConnection!
3259
3285
  events(offset: Int, before: String, after: String, first: Int, last: Int): SellerEventTypeCountableConnection!
3260
3286
 
@@ -3317,6 +3343,7 @@ type Seller implements Node & ObjectWithMetadata {
3317
3343
  firstOrderPlacedDate: DateTime
3318
3344
  created: DateTime!
3319
3345
  updated: DateTime!
3346
+ accountSetupTasksAreDone: Boolean
3320
3347
  }
3321
3348
 
3322
3349
  """Represents an image."""
@@ -3328,6 +3355,33 @@ type Image {
3328
3355
  alt: String
3329
3356
  }
3330
3357
 
3358
+ """An enumeration."""
3359
+ enum SellerStatus {
3360
+ """Applying"""
3361
+ APPLYING
3362
+
3363
+ """Pending"""
3364
+ PENDING
3365
+
3366
+ """Approved"""
3367
+ APPROVED
3368
+
3369
+ """Declined"""
3370
+ DECLINED
3371
+
3372
+ """Paused"""
3373
+ PAUSED
3374
+
3375
+ """Suspended"""
3376
+ SUSPENDED
3377
+
3378
+ """Banned"""
3379
+ BANNED
3380
+
3381
+ """Deactivated"""
3382
+ DEACTIVATED
3383
+ }
3384
+
3331
3385
  type ProductCountableConnection {
3332
3386
  """Pagination data for this connection."""
3333
3387
  pageInfo: PageInfo!
@@ -3374,33 +3428,6 @@ enum SellerExternalPayoutSource {
3374
3428
  NAUTICAL_PAYMENTS_TROLLEY
3375
3429
  }
3376
3430
 
3377
- """An enumeration."""
3378
- enum SellerStatus {
3379
- """Applying"""
3380
- APPLYING
3381
-
3382
- """Pending"""
3383
- PENDING
3384
-
3385
- """Approved"""
3386
- APPROVED
3387
-
3388
- """Declined"""
3389
- DECLINED
3390
-
3391
- """Paused"""
3392
- PAUSED
3393
-
3394
- """Suspended"""
3395
- SUSPENDED
3396
-
3397
- """Banned"""
3398
- BANNED
3399
-
3400
- """Deactivated"""
3401
- DEACTIVATED
3402
- }
3403
-
3404
3431
  type SellerUserTypeCountableConnection {
3405
3432
  """Pagination data for this connection."""
3406
3433
  pageInfo: PageInfo!
@@ -4701,10 +4728,10 @@ type ProductType implements Node & ObjectWithMetadata {
4701
4728
  ): AttributeCountableConnection
4702
4729
 
4703
4730
  """Product features of this product type."""
4704
- productFeatures: [ProductTypeProductFeature!]!
4731
+ productFeatures: [ProductTypeProductFeature!]! @deprecated(reason: "Features will be removed on January 2, 2025.")
4705
4732
 
4706
4733
  """Variant features of this product type."""
4707
- variantFeatures: [ProductTypeVariantFeature!]!
4734
+ variantFeatures: [ProductTypeVariantFeature!]! @deprecated(reason: "Features will be removed on January 2, 2025.")
4708
4735
 
4709
4736
  """Brand of the product"""
4710
4737
  model: String
@@ -4912,6 +4939,7 @@ enum PermissionEnum {
4912
4939
  MANAGE_APPS
4913
4940
  MANAGE_DISCOUNTS
4914
4941
  MANAGE_DOCUMENTS
4942
+ MANAGE_EMAILS
4915
4943
  MANAGE_PLUGINS
4916
4944
  MANAGE_PRICEBOOKS
4917
4945
  MANAGE_STOREFRONTS
@@ -4928,7 +4956,6 @@ enum PermissionEnum {
4928
4956
  MANAGE_TRANSLATIONS
4929
4957
  MANAGE_CHECKOUTS
4930
4958
  MANAGE_AGREEMENTS
4931
- MANAGE_DASHBOARD_CONFIGURATION
4932
4959
  MANAGE_MARKETPLACE
4933
4960
  MANAGE_MARKETPLACE_CONFIGURATION
4934
4961
  MANAGE_MICROSITES
@@ -7751,6 +7778,32 @@ enum ProductAction {
7751
7778
  APPROVED
7752
7779
  }
7753
7780
 
7781
+ """Represents logs for each product state change."""
7782
+ type ProductStatusLog implements Node & ObjectWithMetadata {
7783
+ """The user who updated the product status."""
7784
+ user: User
7785
+
7786
+ """The sub status of the product."""
7787
+ subStatus: ProductSubStatusEnum
7788
+
7789
+ """The reason for the sub status of the product."""
7790
+ subStatusReason: String
7791
+
7792
+ """The date and time the product state was created."""
7793
+ createdAt: DateTime
7794
+
7795
+ """The ID of the object"""
7796
+ id: ID!
7797
+
7798
+ """
7799
+ List of private metadata items.Requires proper staff permissions to access.
7800
+ """
7801
+ privateMetadata: [MetadataItem!]!
7802
+
7803
+ """List of public metadata items. Can be accessed without permissions."""
7804
+ metadata: [MetadataItem!]!
7805
+ }
7806
+
7754
7807
  """Represents availability of a variant in the storefront."""
7755
7808
  type VariantPricingInfo {
7756
7809
  """Whether it is in sale or not."""
@@ -9539,9 +9592,15 @@ type PublicSeller implements Node {
9539
9592
  companyName: String!
9540
9593
  slug: String!
9541
9594
  logo(
9542
- """Size of the avatar."""
9595
+ """Size of the store's logo."""
9543
9596
  size: Int
9544
9597
  ): Image
9598
+ status: SellerStatus!
9599
+ banner(
9600
+ """Size of the store's banner."""
9601
+ size: Int
9602
+ ): Image
9603
+ storeDescription: String!
9545
9604
  products(offset: Int, before: String, after: String, first: Int, last: Int): ProductCountableConnection!
9546
9605
  variants(offset: Int, before: String, after: String, first: Int, last: Int): ProductVariantCountableConnection!
9547
9606
  }
@@ -9847,45 +9906,6 @@ enum ProductTypeSortField {
9847
9906
  EXTERNAL_SOURCE
9848
9907
  }
9849
9908
 
9850
- """Represents ratings and reviews for a product."""
9851
- type ProductRatingsAndReviews {
9852
- """Summary of all ratings and reviews"""
9853
- bottomline: BottomLine
9854
-
9855
- """List of reviews."""
9856
- reviews: [Review!]
9857
- }
9858
-
9859
- type BottomLine {
9860
- """Average star rating over all ratings."""
9861
- averageScore: Float
9862
-
9863
- """Total ratings/reviews."""
9864
- totalReview: Int
9865
- }
9866
-
9867
- type Review {
9868
- """Review content."""
9869
- content: String
9870
-
9871
- """Date and time review was created."""
9872
- createdAt: String
9873
-
9874
- """Product rating out of 5 stars."""
9875
- score: Int
9876
-
9877
- """Title of the review."""
9878
- title: String
9879
-
9880
- """User who created the rating and review."""
9881
- user: Reviewer
9882
- }
9883
-
9884
- type Reviewer {
9885
- """Reviewer username"""
9886
- displayName: String
9887
- }
9888
-
9889
9909
  type PriceBookCountableConnection {
9890
9910
  """Pagination data for this connection."""
9891
9911
  pageInfo: PageInfo!
@@ -12305,6 +12325,24 @@ enum EmailEventMessageType {
12305
12325
  """Updated Status"""
12306
12326
  UPDATED_STATUS
12307
12327
 
12328
+ """Seller Status Pending"""
12329
+ SELLER_STATUS_PENDING
12330
+
12331
+ """Seller Status Approved"""
12332
+ SELLER_STATUS_APPROVED
12333
+
12334
+ """Seller Status Declined"""
12335
+ SELLER_STATUS_DECLINED
12336
+
12337
+ """Seller Status Paused"""
12338
+ SELLER_STATUS_PAUSED
12339
+
12340
+ """Seller Agreement Accepted"""
12341
+ SELLER_AGREEMENT_ACCEPTED
12342
+
12343
+ """Seller Agreement Not Accepted"""
12344
+ SELLER_AGREEMENT_NOT_ACCEPTED
12345
+
12308
12346
  """Vin Decode Success"""
12309
12347
  VIN_DECODE_SUCCESS
12310
12348
 
@@ -12422,6 +12460,24 @@ enum NotifyEventTypeEnum {
12422
12460
  """Updated Status"""
12423
12461
  UPDATED_STATUS
12424
12462
 
12463
+ """Seller Status Pending"""
12464
+ SELLER_STATUS_PENDING
12465
+
12466
+ """Seller Status Approved"""
12467
+ SELLER_STATUS_APPROVED
12468
+
12469
+ """Seller Status Declined"""
12470
+ SELLER_STATUS_DECLINED
12471
+
12472
+ """Seller Status Paused"""
12473
+ SELLER_STATUS_PAUSED
12474
+
12475
+ """Seller Agreement Accepted"""
12476
+ SELLER_AGREEMENT_ACCEPTED
12477
+
12478
+ """Seller Agreement Not Accepted"""
12479
+ SELLER_AGREEMENT_NOT_ACCEPTED
12480
+
12425
12481
  """Vin Decode Success"""
12426
12482
  VIN_DECODE_SUCCESS @deprecated(reason: "Will be removed on Nov 12, 2024")
12427
12483
 
@@ -13439,26 +13495,6 @@ type BrandingType {
13439
13495
  footerText: String!
13440
13496
  }
13441
13497
 
13442
- """
13443
- Represents a dashboard resource containing general dashboard data and configuration.
13444
- """
13445
- type Dashboard {
13446
- """Dashboard main menu structure in JSON format."""
13447
- configurationMainMenu: JSONString
13448
-
13449
- """Dashboard product create page structure in JSON format."""
13450
- configurationProductCreate: JSONString
13451
-
13452
- """Dashboard product update page structure in JSON format."""
13453
- configurationProductUpdate: JSONString
13454
-
13455
- """Dashboard product variant create page structure in JSON format."""
13456
- configurationProductVariantCreate: JSONString
13457
-
13458
- """Dashboard product variant update page structure in JSON format."""
13459
- configurationProductVariantUpdate: JSONString
13460
- }
13461
-
13462
13498
  """Represents a job data of exported file."""
13463
13499
  type ExportFile implements Node & Job {
13464
13500
  """The ID of the object"""
@@ -13932,7 +13968,7 @@ enum StaffMemberStatus {
13932
13968
  DEACTIVATED
13933
13969
  }
13934
13970
 
13935
- union _Entity = WishlistItem | Wishlist | User | Address | ProductVariant | Product | Category | ProductType | App | Collection | Bid | Microsite | ProductImage | Location | Group | CatalogImportProcess | CatalogImportProcessLogRecord
13971
+ union _Entity = WishlistItem | Wishlist | User | Address | ProductVariant | Product | Category | ProductType | App | Collection | Bid | Microsite | ProductImage | Location | ProductStatusLog | Group | CatalogImportProcess | CatalogImportProcessLogRecord
13936
13972
 
13937
13973
  scalar _Any
13938
13974
 
@@ -13941,11 +13977,14 @@ type _Service {
13941
13977
  }
13942
13978
 
13943
13979
  type Mutation {
13944
- """Create a tenant"""
13945
- tenantCreate(
13946
- """Fields required to create Tenant"""
13947
- input: TenantCreateInput!
13948
- ): TenantCreate
13980
+ """EmailTemplate update mutation."""
13981
+ emailTemplateUpdate(
13982
+ """ID of the email template to update."""
13983
+ id: ID!
13984
+
13985
+ """Fields to update on the email template."""
13986
+ input: EmailTemplateUpdateInput!
13987
+ ): EmailTemplateUpdate
13949
13988
 
13950
13989
  """Update a tenant"""
13951
13990
  tenantUpdate(
@@ -13963,7 +14002,7 @@ type Mutation {
13963
14002
  description: String
13964
14003
 
13965
14004
  """
13966
- Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: text/pdf, application/x-tif, image/bmp, image/vnd.dwg, application/postscript, text/x-comma-separated-values, application/vnd.openxmlformats-officedocument.presentationml.presentation, image/svg+xml, application/vnd.ms-excel, application/dwg, application/x-dxf, application/x-csv, application/gzip-compressed, text/rtf, image/x-ms-bmp, drawing/x-dwg, image/png, application/gzipped, image/tiff, image/heic, application/acrobat, application/zip, application/x-rar, application/x-autocad, application/tif, application/svg+xml, application/x-zip-compressed, text/x-pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/x-dxf, application/vnd.pdf, application/x-dwg, image/x-eps, text/plain, image/jpeg, application/csv, application/x-tar, application/eps, application/vnd.oasis.opendocument.spreadsheet, text/comma-separated-values, drawing/x-dwf, application/x-jpg, application/excel, application/x-pdf, application/rtf, text/svg, application/x-gzip, application/x-rtf, image/heif-sequence, text/csv, application/x-eps, application/x-acad, text/svg-xml, image/x-tif, application/acad, drawing/dwg, application/x-rar-compressed, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/msword, image/eps, image/tif, image/x-bmp, pplication/vnd.rar, application/tiff, image/svg, application/x-tiff, application/pdf, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, image/webp, application/vnd.ms-word, image/gif, text/x-csv, image/heic-sequence, image/jpg, image/x-dwg, image/dxf, application/vnd.ms-powerpoint, application/vnd.oasis.opendocument.presentation, application/gzip, image/x-tiff, application/vnd.oasis.opendocument.text, application/dxf, application/jpg, image/heif.
14005
+ 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-dxf, application/x-eps, image/x-dwg, image/tiff, application/vnd.ms-word, application/gzip, application/dwg, application/zip, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/tiff, application/x-rar-compressed, application/dxf, text/comma-separated-values, application/x-tar, application/rtf, drawing/x-dwg, image/heic-sequence, application/tif, application/x-tif, text/svg, image/heif, text/x-pdf, text/svg-xml, image/x-eps, application/x-zip-compressed, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.oasis.opendocument.spreadsheet, application/x-tiff, application/pdf, application/vnd.oasis.opendocument.text, image/x-tif, image/eps, application/jpg, image/tif, image/jpg, image/heic, application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/rtf, application/excel, image/vnd.dwg, application/csv, application/vnd.pdf, image/png, image/x-ms-bmp, application/x-autocad, image/bmp, application/x-rar, application/acrobat, application/x-jpg, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/gzip-compressed, application/msword, image/dxf, application/vnd.oasis.opendocument.presentation, application/x-gzip, image/x-bmp, text/plain, application/x-pdf, image/gif, application/gzipped, application/svg+xml, image/heif-sequence, application/acad, image/svg, text/csv, application/eps, text/x-comma-separated-values, image/svg+xml, pplication/vnd.rar, image/webp, text/pdf, application/postscript, text/x-csv, application/x-dwg, image/x-dxf, application/x-rtf, application/vnd.ms-excel, application/x-acad, image/x-tiff, drawing/dwg, drawing/x-dwf, image/jpeg, application/x-csv.
13967
14006
  """
13968
14007
  file: Upload!
13969
14008
 
@@ -14303,19 +14342,19 @@ type Mutation {
14303
14342
 
14304
14343
  """List of product IDs."""
14305
14344
  products: [ID!]!
14306
- ): MicrositeAddProducts
14345
+ ): MicrositeAddProducts @deprecated(reason: "Microsites will be removed on January 2, 2025.")
14307
14346
 
14308
14347
  """Creates a new microsite."""
14309
14348
  micrositeCreate(
14310
14349
  """Fields required to create a microsite."""
14311
14350
  input: MicrositeCreateInput!
14312
- ): MicrositeCreate
14351
+ ): MicrositeCreate @deprecated(reason: "Microsites will be removed on January 2, 2025.")
14313
14352
 
14314
14353
  """Deletes a microsite."""
14315
14354
  micrositeDelete(
14316
14355
  """ID of a microsite to delete."""
14317
14356
  id: ID!
14318
- ): MicrositeDelete
14357
+ ): MicrositeDelete @deprecated(reason: "Microsites will be removed on January 2, 2025.")
14319
14358
 
14320
14359
  """Reorder the products of a microsite."""
14321
14360
  micrositeReorderProducts(
@@ -14324,13 +14363,13 @@ type Mutation {
14324
14363
 
14325
14364
  """The microsite products position operations."""
14326
14365
  moves: [MoveProductInput!]!
14327
- ): MicrositeReorderProducts
14366
+ ): MicrositeReorderProducts @deprecated(reason: "Microsites will be removed on January 2, 2025.")
14328
14367
 
14329
14368
  """Deletes microsites."""
14330
14369
  micrositeBulkDelete(
14331
14370
  """List of microsite IDs to delete."""
14332
14371
  ids: [ID!]!
14333
- ): MicrositeBulkDelete
14372
+ ): MicrositeBulkDelete @deprecated(reason: "Microsites will be removed on January 2, 2025.")
14334
14373
 
14335
14374
  """Publish microsites."""
14336
14375
  micrositeBulkPublish(
@@ -14339,7 +14378,7 @@ type Mutation {
14339
14378
 
14340
14379
  """Determine if microsites will be published or not."""
14341
14380
  isPublished: Boolean!
14342
- ): MicrositeBulkPublish
14381
+ ): MicrositeBulkPublish @deprecated(reason: "Microsites will be removed on January 2, 2025.")
14343
14382
 
14344
14383
  """Remove products from a microsite."""
14345
14384
  micrositeRemoveProducts(
@@ -14348,7 +14387,7 @@ type Mutation {
14348
14387
 
14349
14388
  """List of product IDs."""
14350
14389
  products: [ID!]!
14351
- ): MicrositeRemoveProducts
14390
+ ): MicrositeRemoveProducts @deprecated(reason: "Microsites will be removed on January 2, 2025.")
14352
14391
 
14353
14392
  """Updates a microsite."""
14354
14393
  micrositeUpdate(
@@ -14357,7 +14396,7 @@ type Mutation {
14357
14396
 
14358
14397
  """Fields required to update a microsite."""
14359
14398
  input: MicrositeInput!
14360
- ): MicrositeUpdate
14399
+ ): MicrositeUpdate @deprecated(reason: "Microsites will be removed on January 2, 2025.")
14361
14400
 
14362
14401
  """Creates a new affiliate code"""
14363
14402
  affiliateCodeCreate(
@@ -15485,7 +15524,7 @@ type Mutation {
15485
15524
  featureCreate(
15486
15525
  """Fields required to create a feature"""
15487
15526
  input: FeatureCreateInput!
15488
- ): FeatureCreate
15527
+ ): FeatureCreate @deprecated(reason: "Features will be removed on January 2, 2025.")
15489
15528
 
15490
15529
  """Updates a feature."""
15491
15530
  featureUpdate(
@@ -15494,19 +15533,19 @@ type Mutation {
15494
15533
 
15495
15534
  """Input required to update a feature."""
15496
15535
  input: FeatureInput!
15497
- ): FeatureUpdate
15536
+ ): FeatureUpdate @deprecated(reason: "Features will be removed on January 2, 2025.")
15498
15537
 
15499
15538
  """Deletes a feature."""
15500
15539
  featureDelete(
15501
15540
  """ID of a feature to delete."""
15502
15541
  id: ID!
15503
- ): FeatureDelete
15542
+ ): FeatureDelete @deprecated(reason: "Features will be removed on January 2, 2025.")
15504
15543
 
15505
15544
  """Creates a new product or variant feature on a product type."""
15506
15545
  productTypeFeatureCreate(
15507
15546
  """Fields required to create a feature for a product type."""
15508
15547
  input: ProductTypeFeatureCreateInput!
15509
- ): ProductTypeFeatureCreate
15548
+ ): ProductTypeFeatureCreate @deprecated(reason: "Features will be removed on January 2, 2025.")
15510
15549
 
15511
15550
  """Updates a product or variant feature on a product type."""
15512
15551
  productTypeFeatureUpdate(
@@ -15515,13 +15554,13 @@ type Mutation {
15515
15554
 
15516
15555
  """Fields required to update a feature for a product type."""
15517
15556
  input: ProductTypeFeatureInput!
15518
- ): ProductTypeFeatureUpdate
15557
+ ): ProductTypeFeatureUpdate @deprecated(reason: "Features will be removed on January 2, 2025.")
15519
15558
 
15520
15559
  """Deletes a product or variant feature on a product type."""
15521
15560
  productTypeFeatureDelete(
15522
15561
  """ID of the product type feature to delete."""
15523
15562
  id: ID!
15524
- ): ProductTypeFeatureDelete
15563
+ ): ProductTypeFeatureDelete @deprecated(reason: "Features will be removed on January 2, 2025.")
15525
15564
 
15526
15565
  """Create a new location for the product."""
15527
15566
  productLocationCreate(
@@ -15575,27 +15614,6 @@ type Mutation {
15575
15614
  type: LocationTypeEnum!
15576
15615
  ): ProductSetLocationType @deprecated(reason: "Locations will be removed on November 28, 2024.")
15577
15616
 
15578
- """Submit a rating and review for a product."""
15579
- productReviewSubmit(
15580
- """Email address of the reviewer"""
15581
- emailAddress: String
15582
-
15583
- """Headline of the product review"""
15584
- headline: String
15585
-
15586
- """Encoded ID of the product"""
15587
- productId: String
15588
-
15589
- """Display name of the reviewer"""
15590
- publicName: String
15591
-
15592
- """Rating for the product from 1 to 5"""
15593
- rating: String
15594
-
15595
- """Written product review"""
15596
- review: String
15597
- ): ProductReviewSubmit @deprecated(reason: "This will be removed on October 1, 2024.")
15598
-
15599
15617
  """Captures the authorized payment amount."""
15600
15618
  paymentCapture(
15601
15619
  """Transaction amount."""
@@ -16420,7 +16438,7 @@ type Mutation {
16420
16438
 
16421
16439
  """Seller ID"""
16422
16440
  sellerId: ID
16423
- ): CatalogExport @deprecated(reason: "This mutation is no longer supported. This will be removed on October 1, 2024.")
16441
+ ): CatalogExport
16424
16442
 
16425
16443
  """Export customer list."""
16426
16444
  customersExport(
@@ -16590,12 +16608,6 @@ type Mutation {
16590
16608
  input: CatalogueInput!
16591
16609
  ): VoucherRemoveCatalogues
16592
16610
 
16593
- """Updates dashboard configuration."""
16594
- dashboardConfigurationUpdate(
16595
- """Fields required to update configuration object."""
16596
- input: DashboardConfigurationInput
16597
- ): DashboardConfigurationUpdate @deprecated(reason: "This mutation is deprecated and will be removed on October 1, 2024.")
16598
-
16599
16611
  """Gets and sets Explo dashboard embedding token in cookies"""
16600
16612
  dashboardEmbeddingToken: DashboardEmbeddingToken
16601
16613
 
@@ -17370,13 +17382,13 @@ type Mutation {
17370
17382
  ): PermissionGroupDelete
17371
17383
  }
17372
17384
 
17373
- """Create a tenant"""
17374
- type TenantCreate {
17375
- tenant: Tenant
17376
- tenantErrors: [TenantError!]!
17385
+ """EmailTemplate update mutation."""
17386
+ type EmailTemplateUpdate {
17387
+ emailTemplate: EmailTemplate
17388
+ notificationErrors: [NotificationError!]!
17377
17389
  }
17378
17390
 
17379
- type TenantError {
17391
+ type NotificationError {
17380
17392
  """
17381
17393
  Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
17382
17394
  """
@@ -17386,36 +17398,30 @@ type TenantError {
17386
17398
  message: String!
17387
17399
 
17388
17400
  """The error code."""
17389
- code: TenantErrorCode!
17401
+ code: NotificationErrorCode!
17390
17402
  }
17391
17403
 
17392
17404
  """An enumeration."""
17393
- enum TenantErrorCode {
17405
+ enum NotificationErrorCode {
17406
+ GRAPHQL_ERROR
17394
17407
  NOT_FOUND
17395
17408
  REQUIRED
17396
- GRAPHQL_ERROR
17397
17409
  INVALID
17398
- ALREADY_EXISTS
17399
- NOT_ALLOWED
17400
17410
  }
17401
17411
 
17402
- input TenantCreateInput {
17403
- """The name of the tenant"""
17404
- name: String!
17405
-
17406
- """
17407
- Unique slug for the tenant. Will be generated from the name if not provided
17408
- """
17409
- slug: String
17412
+ """Input type for email template update."""
17413
+ input EmailTemplateUpdateInput {
17414
+ """The content of the email template."""
17415
+ content: String
17410
17416
 
17411
- """The URL of the dashboard for this tenant"""
17412
- dashboardUrl: String!
17417
+ """The subject of the email template."""
17418
+ subject: String
17413
17419
 
17414
- """The URL of storefront for this tenant"""
17415
- storefrontUrl: String!
17420
+ """The content of the email template."""
17421
+ senderEmailAddress: String
17416
17422
 
17417
- """If true, trial env data will be created in the tenant"""
17418
- populateTrialData: Boolean
17423
+ """Determine if the email template is custom."""
17424
+ isCustom: Boolean
17419
17425
  }
17420
17426
 
17421
17427
  """Update a tenant"""
@@ -17424,6 +17430,29 @@ type TenantUpdate {
17424
17430
  tenantErrors: [TenantError!]!
17425
17431
  }
17426
17432
 
17433
+ type TenantError {
17434
+ """
17435
+ Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
17436
+ """
17437
+ field: String
17438
+
17439
+ """The error message."""
17440
+ message: String!
17441
+
17442
+ """The error code."""
17443
+ code: TenantErrorCode!
17444
+ }
17445
+
17446
+ """An enumeration."""
17447
+ enum TenantErrorCode {
17448
+ NOT_FOUND
17449
+ REQUIRED
17450
+ GRAPHQL_ERROR
17451
+ INVALID
17452
+ ALREADY_EXISTS
17453
+ NOT_ALLOWED
17454
+ }
17455
+
17427
17456
  input TenantUpdateInput {
17428
17457
  isActive: Boolean
17429
17458
  name: String
@@ -20853,6 +20882,11 @@ input ProductCreateInput {
20853
20882
  """Substatus the product is to be changed to."""
20854
20883
  subStatus: ProductSubStatusEnum
20855
20884
 
20885
+ """
20886
+ A reason for why the sub status changed, which will be displayed to the creator of the product.
20887
+ """
20888
+ subStatusReason: String
20889
+
20856
20890
  """Sort priority for product"""
20857
20891
  sortPriorityWeight: Decimal
20858
20892
 
@@ -21064,6 +21098,11 @@ input ProductInput {
21064
21098
  """Substatus the product is to be changed to."""
21065
21099
  subStatus: ProductSubStatusEnum
21066
21100
 
21101
+ """
21102
+ A reason for why the sub status changed, which will be displayed to the creator of the product.
21103
+ """
21104
+ subStatusReason: String
21105
+
21067
21106
  """Sort priority for product"""
21068
21107
  sortPriorityWeight: Decimal
21069
21108
 
@@ -21564,6 +21603,16 @@ input ProductVariantBulkCreateInput {
21564
21603
 
21565
21604
  """Stocks of a product available for sale."""
21566
21605
  stocks: [StockInput!]
21606
+
21607
+ """
21608
+ The external source identifier of a foreign system (e.g. nautical.fulfillment.shopify) if a product variant originated from that system, used in combination with provided externalId. If submitting externalSource, you must also provide an externalId argument.
21609
+ """
21610
+ externalSource: String
21611
+
21612
+ """
21613
+ The external ID from a foreign system if a product variant originated from that system, used in combination with provided externalSource. If submitting externalId, you must also provide an externalSource argument.
21614
+ """
21615
+ externalId: String
21567
21616
  }
21568
21617
 
21569
21618
  """Deletes product variants."""
@@ -21936,12 +21985,6 @@ type ProductSetLocationType {
21936
21985
  productErrors: [ProductError!]!
21937
21986
  }
21938
21987
 
21939
- """Submit a rating and review for a product."""
21940
- type ProductReviewSubmit {
21941
- submissionSuccessful: Boolean
21942
- productErrors: [ProductError!]!
21943
- }
21944
-
21945
21988
  """Captures the authorized payment amount."""
21946
21989
  type PaymentCapture {
21947
21990
  """Updated payment."""
@@ -23911,53 +23954,6 @@ type VoucherRemoveCatalogues {
23911
23954
  discountErrors: [DiscountError!]!
23912
23955
  }
23913
23956
 
23914
- """Updates dashboard configuration."""
23915
- type DashboardConfigurationUpdate {
23916
- """Updated dashboard"""
23917
- dashboard: Dashboard
23918
- dashboardConfigurationErrors: [DashboardConfigurationError!]!
23919
- }
23920
-
23921
- type DashboardConfigurationError {
23922
- """
23923
- Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
23924
- """
23925
- field: String
23926
-
23927
- """The error message."""
23928
- message: String!
23929
-
23930
- """The error code."""
23931
- code: NauticalConfigurationErrorCode!
23932
- }
23933
-
23934
- input DashboardConfigurationInput {
23935
- """Name of the element to update."""
23936
- configurationElement: DashboardConfigurationOptionsEnum!
23937
-
23938
- """
23939
- Configuration value to set. This field will not be validated and will be saved as is
23940
- """
23941
- configurationValue: JSONString!
23942
- }
23943
-
23944
- enum DashboardConfigurationOptionsEnum {
23945
- """main_menu"""
23946
- MAIN_MENU
23947
-
23948
- """product_create"""
23949
- PRODUCT_CREATE
23950
-
23951
- """product_update"""
23952
- PRODUCT_UPDATE
23953
-
23954
- """product_variant_create"""
23955
- PRODUCT_VARIANT_CREATE
23956
-
23957
- """product_variant_update"""
23958
- PRODUCT_VARIANT_UPDATE
23959
- }
23960
-
23961
23957
  """Gets and sets Explo dashboard embedding token in cookies"""
23962
23958
  type DashboardEmbeddingToken {
23963
23959
  """JWT token for embedding"""
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nautical-commerce/graphql-schema",
3
- "version": "v1.53.1",
3
+ "version": "v1.54.0",
4
4
  "description": "## Getting Started",
5
5
  "main": "./nautical/schema.graphql",
6
6
  "scripts": {