@nautical-commerce/graphql-schema 1.66.0-1-g62de05314 → 1.66.0-11-g957919fa9

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.
@@ -499,6 +499,36 @@ type Query {
499
499
  last: Int
500
500
  ): RefundCountableConnection
501
501
 
502
+ """Look up a policy by ID or slug."""
503
+ policy(
504
+ """ID of the policy."""
505
+ id: ID
506
+
507
+ """The slug of the policy."""
508
+ slug: String
509
+ ): Policy
510
+
511
+ """List of the shop's policies."""
512
+ policies(
513
+ """Sort policies."""
514
+ sortBy: PolicySortingInput
515
+
516
+ """Filtering options for policies."""
517
+ filter: PolicyFilterInput
518
+
519
+ """Return the elements in the list that come before the specified cursor."""
520
+ before: String
521
+
522
+ """Return the elements in the list that come after the specified cursor."""
523
+ after: String
524
+
525
+ """Return the first n elements from the list."""
526
+ first: Int
527
+
528
+ """Return the last n elements from the list."""
529
+ last: Int
530
+ ): PolicyCountableConnection
531
+
502
532
  """Look up digital content by ID."""
503
533
  digitalContent(
504
534
  """ID of the digital content."""
@@ -611,9 +641,6 @@ type Query {
611
641
  """
612
642
  identifier: ID
613
643
 
614
- """Microsite ID to filter by"""
615
- microsite: ID
616
-
617
644
  """Return the elements in the list that come before the specified cursor."""
618
645
  before: String
619
646
 
@@ -1441,42 +1468,6 @@ type Query {
1441
1468
  """Return all nautical configuration items"""
1442
1469
  nauticalConfigurationList: [NauticalConfiguration!]
1443
1470
 
1444
- """Look up a microsite by ID or slug"""
1445
- microsite(
1446
- """ID of the microsite."""
1447
- id: ID
1448
-
1449
- """Slug of the microsite"""
1450
- slug: String
1451
- ): Microsite @deprecated(reason: "Microsites will be removed on January 2, 2025.")
1452
-
1453
- """List of microsites"""
1454
- microsites(
1455
- """Filtering options for microsites"""
1456
- filter: MicrositeFilterInput
1457
-
1458
- """Sort microsites"""
1459
- sortBy: MicrositeSortingInput
1460
-
1461
- """Return the elements in the list that come before the specified cursor."""
1462
- before: String
1463
-
1464
- """Return the elements in the list that come after the specified cursor."""
1465
- after: String
1466
-
1467
- """Return the first n elements from the list."""
1468
- first: Int
1469
-
1470
- """Return the last n elements from the list."""
1471
- last: Int
1472
- ): MicrositeCountableConnection @deprecated(reason: "Microsites will be removed on January 2, 2025.")
1473
-
1474
- """Look up microsite by vendor ID"""
1475
- vendorMicrosite(
1476
- """ID of vendor to fetch microsite for."""
1477
- id: ID!
1478
- ): Microsite @deprecated(reason: "Microsites will be removed on January 2, 2025.")
1479
-
1480
1471
  """Look up a navigation menu by ID or name."""
1481
1472
  menu(
1482
1473
  """ID of the menu."""
@@ -1572,14 +1563,14 @@ type Query {
1572
1563
 
1573
1564
  """End of the period to filter results"""
1574
1565
  endDate: Date!
1575
- ): InReportOrderCustomerSummaryType
1566
+ ): InReportOrderCustomerSummaryType @deprecated(reason: "This will be removed on April 13, 2025.")
1576
1567
  insightsOrdersSellerSummary(
1577
1568
  """Beginning of the period to filter results"""
1578
1569
  startDate: Date!
1579
1570
 
1580
1571
  """End of the period to filter results"""
1581
1572
  endDate: Date!
1582
- ): InReportOrderSellerSummaryType
1573
+ ): InReportOrderSellerSummaryType @deprecated(reason: "This will be removed on April 13, 2025.")
1583
1574
  insightsOrdersMarketplaceSummary(
1584
1575
  """Beginning of the period to filter results"""
1585
1576
  startDate: Date!
@@ -1589,14 +1580,14 @@ type Query {
1589
1580
 
1590
1581
  """Period dimension such as DAY, WEEK, MONTH, QUARTER, YEAR"""
1591
1582
  dimension: InsightDimensionEnum = MONTH
1592
- ): InReportOrderMarketplaceSummaryType
1583
+ ): InReportOrderMarketplaceSummaryType @deprecated(reason: "This will be removed on April 13, 2025.")
1593
1584
  insightsMarketplacePayoutsSummary(
1594
1585
  """Beginning of the period to filter results"""
1595
1586
  startDate: Date!
1596
1587
 
1597
1588
  """End of the period to filter results"""
1598
1589
  endDate: Date!
1599
- ): InReportMarketplacePayoutsSummaryType
1590
+ ): InReportMarketplacePayoutsSummaryType @deprecated(reason: "This will be removed on April 13, 2025.")
1600
1591
  insightsMarketplaceTaxSummary(
1601
1592
  """Beginning of the period to filter results"""
1602
1593
  startDate: Date!
@@ -1606,21 +1597,21 @@ type Query {
1606
1597
 
1607
1598
  """Period dimension such as DAY, WEEK, MONTH, QUARTER, YEAR"""
1608
1599
  dimension: InsightDimensionEnum = YEAR
1609
- ): InReportMarketplaceTaxSummaryType
1600
+ ): InReportMarketplaceTaxSummaryType @deprecated(reason: "This will be removed on April 13, 2025.")
1610
1601
  insightsMarketplaceTaxesByCountry(
1611
1602
  """Beginning of the period to filter results"""
1612
1603
  startDate: Date!
1613
1604
 
1614
1605
  """End of the period to filter results"""
1615
1606
  endDate: Date!
1616
- ): InReportMarketplaceTaxesByCountryType
1607
+ ): InReportMarketplaceTaxesByCountryType @deprecated(reason: "This will be removed on April 13, 2025.")
1617
1608
  insightsMarketplaceTaxesByCountryArea(
1618
1609
  """Beginning of the period to filter results"""
1619
1610
  startDate: Date!
1620
1611
 
1621
1612
  """End of the period to filter results"""
1622
1613
  endDate: Date!
1623
- ): InReportMarketplaceTaxesByCountryType
1614
+ ): InReportMarketplaceTaxesByCountryType @deprecated(reason: "This will be removed on April 13, 2025.")
1624
1615
  insightsTopPerformingProducts(
1625
1616
  """Beginning of the period to filter results"""
1626
1617
  startDate: Date!
@@ -1665,7 +1656,7 @@ type Query {
1665
1656
 
1666
1657
  """Period dimension such as DAY, WEEK, MONTH, QUARTER, YEAR"""
1667
1658
  dimension: InsightDimensionEnum = DAY
1668
- ): InReportMarketplacePaymentsSummaryType
1659
+ ): InReportMarketplacePaymentsSummaryType @deprecated(reason: "This will be removed on April 13, 2025.")
1669
1660
  dashboardOrdersSummary(
1670
1661
  """ID of seller for filtering"""
1671
1662
  identifier: ID
@@ -1978,6 +1969,14 @@ type Query {
1978
1969
  id: ID!
1979
1970
  ): App
1980
1971
 
1972
+ """Dashboard integrations for the given contexts"""
1973
+ dashboardUiIntegrations(
1974
+ """
1975
+ Contexts that integrations should be filtered to. If not specified, all contexts will be returned.
1976
+ """
1977
+ contexts: [AppDashboardIntegrationContextEnum!]
1978
+ ): [AppDashboardIntegration!]!
1979
+
1981
1980
  """Look up a marketplace agreement by ID or slug."""
1982
1981
  agreement(
1983
1982
  """ID of the marketplace agreement."""
@@ -3104,7 +3103,7 @@ type Product implements Node & ObjectWithMetadata {
3104
3103
  isAvailableForPurchase: Boolean
3105
3104
 
3106
3105
  """
3107
- Product sort order in the specific collection or in microsite. Make sense only as a part of the parent 'collection(s)' or 'microsite(s)' queries.
3106
+ Product sort order in the specific collection. Make sense only as a part of the parent 'collection(s)' queries.
3108
3107
  """
3109
3108
  sortOrder: Int
3110
3109
 
@@ -3209,9 +3208,6 @@ type Seller implements Node & ObjectWithMetadata {
3209
3208
  """Date seller acknowledged their existing agreement."""
3210
3209
  agreementAcknowledged: DateTime
3211
3210
  canUseInStorefront: Boolean
3212
-
3213
- """Microsite of the seller."""
3214
- microsite: Microsite
3215
3211
  pk: Int
3216
3212
  externalPayoutStatus: Boolean
3217
3213
  externalPayoutSchedule: String
@@ -4590,7 +4586,6 @@ input AttributeFilterInput {
4590
4586
  inCollection: ID
4591
4587
  inProductSearch: String
4592
4588
  inVariantSearch: String
4593
- inMicrosite: ID
4594
4589
  inCategory: ID
4595
4590
 
4596
4591
  """
@@ -4708,6 +4703,9 @@ type App implements Node & ObjectWithMetadata {
4708
4703
  """Type of the app."""
4709
4704
  type: AppTypeEnum
4710
4705
 
4706
+ """List of dashboard integrations for this app"""
4707
+ dashboardIntegrations: [AppDashboardIntegration!]
4708
+
4711
4709
  """List of storefront integrations for this app"""
4712
4710
  storefrontIntegrations: [AppStorefrontIntegration!]
4713
4711
 
@@ -4804,6 +4802,31 @@ enum AppTypeEnum {
4804
4802
  THIRDPARTY
4805
4803
  }
4806
4804
 
4805
+ """Represents a dashboard integration for an App."""
4806
+ type AppDashboardIntegration implements Node {
4807
+ """The ID of the object"""
4808
+ id: ID!
4809
+
4810
+ """
4811
+ App this integration is for. This may be null for integrations that come from plugins.
4812
+ """
4813
+ app: App
4814
+
4815
+ """What context this integration should be rendered in"""
4816
+ context: AppDashboardIntegrationContextEnum!
4817
+
4818
+ """The URL to load for this integration"""
4819
+ iframeUrl: String!
4820
+ }
4821
+
4822
+ enum AppDashboardIntegrationContextEnum {
4823
+ """Nautical order details page"""
4824
+ NAUTICAL_ORDER
4825
+
4826
+ """Seller order details page"""
4827
+ ORDER
4828
+ }
4829
+
4807
4830
  """Represents a storefront integration for an App."""
4808
4831
  type AppStorefrontIntegration implements Node {
4809
4832
  """The ID of the object"""
@@ -4879,8 +4902,6 @@ enum WebhookEventTypeEnum {
4879
4902
  INVOICE_DELETED
4880
4903
  INVOICE_REQUESTED
4881
4904
  INVOICE_SENT
4882
- MICROSITE_CREATED
4883
- MICROSITE_UPDATED
4884
4905
  NAUTICAL_ORDER_CANCELLED
4885
4906
  NAUTICAL_ORDER_CREATED
4886
4907
  NAUTICAL_ORDER_FULFILLED
@@ -7161,61 +7182,6 @@ type WarehouseCountableEdge {
7161
7182
  cursor: String!
7162
7183
  }
7163
7184
 
7164
- """Represents a microsite of products."""
7165
- type Microsite implements Node & ObjectWithMetadata {
7166
- """The ID of the object"""
7167
- id: ID!
7168
- publicationDate: Date
7169
- description: String!
7170
- descriptionHtml: String!
7171
- seoTitle: String
7172
- seoDescription: String
7173
- name: String!
7174
- slug: String!
7175
- footerText: String
7176
- seller: Seller
7177
-
7178
- """
7179
- List of private metadata items.Requires proper staff permissions to access.
7180
- """
7181
- privateMetadata: [MetadataItem!]!
7182
-
7183
- """List of public metadata items. Can be accessed without permissions."""
7184
- metadata: [MetadataItem!]!
7185
-
7186
- """List of products in this microsite."""
7187
- products(
7188
- """Filtering options for products."""
7189
- filter: ProductFilterInput
7190
-
7191
- """Sort products."""
7192
- sortBy: ProductOrder
7193
-
7194
- """Return the elements in the list that come before the specified cursor."""
7195
- before: String
7196
-
7197
- """Return the elements in the list that come after the specified cursor."""
7198
- after: String
7199
-
7200
- """Return the first n elements from the list."""
7201
- first: Int
7202
-
7203
- """Return the last n elements from the list."""
7204
- last: Int
7205
- ): ProductCountableConnection
7206
- bannerImage(
7207
- """Size of the image."""
7208
- size: Int
7209
- ): Image
7210
- logoImage(
7211
- """Size of the image."""
7212
- size: Int
7213
- ): Image
7214
-
7215
- """Whether the microsite is published."""
7216
- isPublished: Boolean!
7217
- }
7218
-
7219
7185
  """Document"""
7220
7186
  type Document {
7221
7187
  """Global ID of the Document."""
@@ -8130,8 +8096,6 @@ enum WebhookSampleEventTypeEnum {
8130
8096
  INVOICE_DELETED
8131
8097
  INVOICE_REQUESTED
8132
8098
  INVOICE_SENT
8133
- MICROSITE_CREATED
8134
- MICROSITE_UPDATED
8135
8099
  NAUTICAL_ORDER_CANCELLED
8136
8100
  NAUTICAL_ORDER_CREATED
8137
8101
  NAUTICAL_ORDER_FULFILLED
@@ -9150,6 +9114,100 @@ enum RefundSortField {
9150
9114
  TOKEN
9151
9115
  }
9152
9116
 
9117
+ """
9118
+ A policy that can be manually added by a shop operator through the dashboard.
9119
+ """
9120
+ type Policy implements Node & ObjectWithMetadata {
9121
+ """The ID of the object"""
9122
+ id: ID!
9123
+ publicationDate: Date
9124
+ createdAt: DateTime!
9125
+ updatedAt: DateTime!
9126
+ content: String!
9127
+ contentHtml: String!
9128
+ seoTitle: String
9129
+ seoDescription: String
9130
+ category: PolicyCategory!
9131
+ slug: String!
9132
+ title: String!
9133
+
9134
+ """
9135
+ List of private metadata items.Requires proper staff permissions to access.
9136
+ """
9137
+ privateMetadata: [MetadataItem!]!
9138
+
9139
+ """List of public metadata items. Can be accessed without permissions."""
9140
+ metadata: [MetadataItem!]!
9141
+
9142
+ """Whether the policy is published."""
9143
+ isPublished: Boolean!
9144
+ }
9145
+
9146
+ """An enumeration."""
9147
+ enum PolicyCategory {
9148
+ """Terms of Service"""
9149
+ TERMS_OF_SERVICE
9150
+
9151
+ """Privacy Policy"""
9152
+ PRIVACY_POLICY
9153
+
9154
+ """Returns & Refund"""
9155
+ RETURNS_AND_REFUNDS
9156
+
9157
+ """Shipping Policy"""
9158
+ SHIPPING_POLICY
9159
+
9160
+ """Custom"""
9161
+ CUSTOM
9162
+ }
9163
+
9164
+ type PolicyCountableConnection {
9165
+ """Pagination data for this connection."""
9166
+ pageInfo: PageInfo!
9167
+ edges: [PolicyCountableEdge!]!
9168
+
9169
+ """A total count of items in the collection."""
9170
+ totalCount: Int
9171
+ }
9172
+
9173
+ type PolicyCountableEdge {
9174
+ """The item at the end of the edge."""
9175
+ node: Policy!
9176
+
9177
+ """A cursor for use in pagination."""
9178
+ cursor: String!
9179
+ }
9180
+
9181
+ input PolicySortingInput {
9182
+ """Specifies the direction in which to sort products."""
9183
+ direction: OrderDirection!
9184
+
9185
+ """Sort policies by the selected field."""
9186
+ field: PolicySortField!
9187
+ }
9188
+
9189
+ enum PolicySortField {
9190
+ """Sort policies by title."""
9191
+ TITLE
9192
+
9193
+ """Sort policies by slug."""
9194
+ SLUG
9195
+
9196
+ """Sort policies by visibility."""
9197
+ VISIBILITY
9198
+
9199
+ """Sort policies by creation date."""
9200
+ CREATION_DATE
9201
+
9202
+ """Sort policies by publication date."""
9203
+ PUBLICATION_DATE
9204
+ }
9205
+
9206
+ input PolicyFilterInput {
9207
+ search: String
9208
+ isPublished: Boolean
9209
+ }
9210
+
9153
9211
  type DigitalContentCountableConnection {
9154
9212
  """Pagination data for this connection."""
9155
9213
  pageInfo: PageInfo!
@@ -10796,58 +10854,6 @@ type NauticalConfiguration {
10796
10854
  configurationValueString: String
10797
10855
  }
10798
10856
 
10799
- type MicrositeCountableConnection {
10800
- """Pagination data for this connection."""
10801
- pageInfo: PageInfo!
10802
- edges: [MicrositeCountableEdge!]!
10803
-
10804
- """A total count of items in the collection."""
10805
- totalCount: Int
10806
- }
10807
-
10808
- type MicrositeCountableEdge {
10809
- """The item at the end of the edge."""
10810
- node: Microsite!
10811
-
10812
- """A cursor for use in pagination."""
10813
- cursor: String!
10814
- }
10815
-
10816
- input MicrositeFilterInput {
10817
- published: MicrositePublished
10818
- search: String
10819
- ids: [ID]
10820
- metadata: MetadataFilterInput
10821
- privateMetadata: MetadataFilterInput
10822
- }
10823
-
10824
- enum MicrositePublished {
10825
- PUBLISHED
10826
- HIDDEN
10827
- }
10828
-
10829
- input MicrositeSortingInput {
10830
- """Specifies the direction in which to sort products."""
10831
- direction: OrderDirection!
10832
-
10833
- """Sort microsites by the selected field."""
10834
- field: MicrositeSortField!
10835
- }
10836
-
10837
- enum MicrositeSortField {
10838
- """Sort microsites by name."""
10839
- NAME
10840
-
10841
- """Sort microsites by availability."""
10842
- AVAILABILITY
10843
-
10844
- """Sort microsites by product count."""
10845
- PRODUCT_COUNT
10846
-
10847
- """Sort microsites by publication date."""
10848
- PUBLICATION_DATE
10849
- }
10850
-
10851
10857
  """
10852
10858
  Represents a single menu - an object that is used to help navigate through the store.
10853
10859
  """
@@ -13169,7 +13175,7 @@ enum StaffMemberStatus {
13169
13175
  DEACTIVATED
13170
13176
  }
13171
13177
 
13172
- union _Entity = WishlistItem | Wishlist | User | Address | ProductVariant | Product | Category | ProductType | App | Collection | Microsite | ProductImage | ProductStatusLog | Group | CatalogImportProcess | CatalogImportProcessLogRecord
13178
+ union _Entity = WishlistItem | Wishlist | User | Address | ProductVariant | Product | Category | ProductType | App | Collection | ProductImage | ProductStatusLog | Group | CatalogImportProcess | CatalogImportProcessLogRecord
13173
13179
 
13174
13180
  scalar _Any
13175
13181
 
@@ -13203,7 +13209,7 @@ type Mutation {
13203
13209
  description: String
13204
13210
 
13205
13211
  """
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/dxf, application/jpg, text/comma-separated-values, application/x-zip-compressed, application/zip, application/csv, text/rtf, application/x-csv, application/gzipped, application/eps, drawing/x-dwg, image/x-tif, application/x-gzip, application/gzip, image/heic, image/heic-sequence, application/x-jpg, image/heif-sequence, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/x-rtf, text/svg-xml, application/dwg, image/heif, image/x-eps, application/vnd.oasis.opendocument.text, application/x-tiff, application/x-rar-compressed, image/eps, text/csv, text/svg, text/x-pdf, image/bmp, image/x-tiff, application/x-eps, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/gzip-compressed, application/vnd.oasis.opendocument.presentation, application/acrobat, application/postscript, image/x-ms-bmp, image/svg, application/vnd.ms-word, application/x-pdf, drawing/dwg, drawing/x-dwf, application/dxf, application/x-autocad, application/x-rar, application/tif, image/gif, application/tiff, application/x-tif, application/pdf, application/msword, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, image/webp, image/tif, image/x-dwg, image/png, application/svg+xml, text/plain, pplication/vnd.rar, application/rtf, image/vnd.dwg, application/vnd.ms-excel, image/svg+xml, text/x-csv, application/x-dxf, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/jpg, application/x-tar, image/x-dxf, application/vnd.oasis.opendocument.spreadsheet, application/excel, application/vnd.pdf, text/x-comma-separated-values, application/x-acad, image/jpeg, application/acad, image/x-bmp, application/vnd.ms-powerpoint, text/pdf, image/tiff, application/x-dwg.
13212
+ Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: image/gif, application/x-eps, application/x-tar, application/msword, application/vnd.pdf, application/postscript, image/x-tif, text/x-pdf, image/x-dxf, image/jpeg, image/eps, image/heic, image/heif, application/excel, image/x-dwg, application/gzip-compressed, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/rtf, drawing/x-dwf, application/dwg, application/x-gzip, image/x-bmp, application/x-rar, application/vnd.oasis.opendocument.spreadsheet, text/plain, image/tiff, application/zip, application/rtf, image/svg, application/acad, application/x-autocad, image/x-eps, application/csv, application/vnd.ms-excel, application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.presentationml.slideshow, text/svg-xml, image/svg+xml, application/x-rtf, application/x-dxf, drawing/dwg, application/dxf, application/x-acad, application/gzipped, application/x-tif, application/x-dwg, application/eps, application/vnd.ms-word, application/tif, application/x-tiff, application/svg+xml, text/comma-separated-values, pplication/vnd.rar, application/x-pdf, image/jpg, image/tif, application/vnd.oasis.opendocument.text, image/x-tiff, text/svg, application/pdf, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, image/dxf, application/x-jpg, application/jpg, application/tiff, image/bmp, application/x-csv, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.oasis.opendocument.presentation, application/gzip, image/vnd.dwg, text/x-comma-separated-values, application/x-rar-compressed, application/acrobat, image/png, image/heif-sequence, drawing/x-dwg, text/pdf, image/webp, text/x-csv, text/csv, image/heic-sequence, application/x-zip-compressed, image/x-ms-bmp.
13207
13213
  """
13208
13214
  file: Upload!
13209
13215
 
@@ -13471,69 +13477,6 @@ type Mutation {
13471
13477
  wishlistId: ID
13472
13478
  ): WishlistRemoveProductVariant
13473
13479
 
13474
- """Adds products to a microsite."""
13475
- micrositeAddProducts(
13476
- """ID of a microsite."""
13477
- micrositeId: ID!
13478
-
13479
- """List of product IDs."""
13480
- products: [ID!]!
13481
- ): MicrositeAddProducts @deprecated(reason: "Microsites will be removed on January 2, 2025.")
13482
-
13483
- """Creates a new microsite."""
13484
- micrositeCreate(
13485
- """Fields required to create a microsite."""
13486
- input: MicrositeCreateInput!
13487
- ): MicrositeCreate @deprecated(reason: "Microsites will be removed on January 2, 2025.")
13488
-
13489
- """Deletes a microsite."""
13490
- micrositeDelete(
13491
- """ID of a microsite to delete."""
13492
- id: ID!
13493
- ): MicrositeDelete @deprecated(reason: "Microsites will be removed on January 2, 2025.")
13494
-
13495
- """Reorder the products of a microsite."""
13496
- micrositeReorderProducts(
13497
- """ID of a microsite."""
13498
- micrositeId: ID!
13499
-
13500
- """The microsite products position operations."""
13501
- moves: [MoveProductInput!]!
13502
- ): MicrositeReorderProducts @deprecated(reason: "Microsites will be removed on January 2, 2025.")
13503
-
13504
- """Deletes microsites."""
13505
- micrositeBulkDelete(
13506
- """List of microsite IDs to delete."""
13507
- ids: [ID!]!
13508
- ): MicrositeBulkDelete @deprecated(reason: "Microsites will be removed on January 2, 2025.")
13509
-
13510
- """Publish microsites."""
13511
- micrositeBulkPublish(
13512
- """List of microsites IDs to (un)publish."""
13513
- ids: [ID!]!
13514
-
13515
- """Determine if microsites will be published or not."""
13516
- isPublished: Boolean!
13517
- ): MicrositeBulkPublish @deprecated(reason: "Microsites will be removed on January 2, 2025.")
13518
-
13519
- """Remove products from a microsite."""
13520
- micrositeRemoveProducts(
13521
- """ID of a microsite."""
13522
- micrositeId: ID!
13523
-
13524
- """List of product IDs."""
13525
- products: [ID!]!
13526
- ): MicrositeRemoveProducts @deprecated(reason: "Microsites will be removed on January 2, 2025.")
13527
-
13528
- """Updates a microsite."""
13529
- micrositeUpdate(
13530
- """ID of a microsite to update."""
13531
- id: ID!
13532
-
13533
- """Fields required to update a microsite."""
13534
- input: MicrositeInput!
13535
- ): MicrositeUpdate @deprecated(reason: "Microsites will be removed on January 2, 2025.")
13536
-
13537
13480
  """Creates a new agreement."""
13538
13481
  agreementCreate(
13539
13482
  """Fields required to create a agreement."""
@@ -14074,6 +14017,42 @@ type Mutation {
14074
14017
  refundId: ID!
14075
14018
  ): RefundPaymentsDelete
14076
14019
 
14020
+ """Creates a new policy."""
14021
+ policyCreate(
14022
+ """Fields required to create a policy."""
14023
+ input: PolicyInput!
14024
+ ): PolicyCreate
14025
+
14026
+ """Deletes a policy."""
14027
+ policyDelete(
14028
+ """ID of the policy to delete."""
14029
+ id: ID!
14030
+ ): PolicyDelete
14031
+
14032
+ """Deletes policy."""
14033
+ policyBulkDelete(
14034
+ """List of policy IDs to delete."""
14035
+ ids: [ID!]!
14036
+ ): PolicyBulkDelete
14037
+
14038
+ """Publish policy."""
14039
+ policyBulkPublish(
14040
+ """List of policy IDs to (un)publish."""
14041
+ ids: [ID!]!
14042
+
14043
+ """Determine if policy will be published or not."""
14044
+ isPublished: Boolean!
14045
+ ): PolicyBulkPublish
14046
+
14047
+ """Updates an existing policy."""
14048
+ policyUpdate(
14049
+ """ID of the policy to update."""
14050
+ id: ID!
14051
+
14052
+ """Fields required to update a policy."""
14053
+ input: PolicyInput!
14054
+ ): PolicyUpdate
14055
+
14077
14056
  """Creates a new price book."""
14078
14057
  priceBookCreate(
14079
14058
  """Fields required to create a price book."""
@@ -16030,6 +16009,18 @@ type Mutation {
16030
16009
  token: String!
16031
16010
  ): AppTokenVerify
16032
16011
 
16012
+ """Creates a new dashboard integration for an app."""
16013
+ appDashboardIntegrationCreate(
16014
+ """Fields required to create a dashboard integration."""
16015
+ input: AppDashboardIntegrationInput!
16016
+ ): AppDashboardIntegrationCreate
16017
+
16018
+ """Deletes an app storefront integration from the app."""
16019
+ appDashboardIntegrationDelete(
16020
+ """ID of a app dashboard integration to delete."""
16021
+ id: ID!
16022
+ ): AppDashboardIntegrationDelete
16023
+
16033
16024
  """Creates a new storefront integration for an app."""
16034
16025
  appStorefrontIntegrationCreate(
16035
16026
  """Fields required to create a storefront integration."""
@@ -17033,200 +17024,6 @@ type WishlistRemoveProductVariant {
17033
17024
  wishlistErrors: [WishlistError!]!
17034
17025
  }
17035
17026
 
17036
- """Adds products to a microsite."""
17037
- type MicrositeAddProducts {
17038
- """Microsite to which products will be added."""
17039
- microsite: Microsite
17040
- micrositeErrors: [ProductError!]!
17041
- }
17042
-
17043
- type ProductError {
17044
- """
17045
- Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
17046
- """
17047
- field: String
17048
-
17049
- """The error message."""
17050
- message: String!
17051
-
17052
- """The error code."""
17053
- code: ProductErrorCode!
17054
-
17055
- """List of attributes IDs which causes the error."""
17056
- attributes: [ID!]
17057
- }
17058
-
17059
- """An enumeration."""
17060
- enum ProductErrorCode {
17061
- ALREADY_EXISTS
17062
- ATTRIBUTE_ALREADY_ASSIGNED
17063
- ATTRIBUTE_CANNOT_BE_ASSIGNED
17064
- ATTRIBUTE_VARIANTS_DISABLED
17065
- DUPLICATED_INPUT_ITEM
17066
- GRAPHQL_ERROR
17067
- INVALID
17068
- INVALID_PHONE
17069
- NOT_PRODUCTS_IMAGE
17070
- NOT_PRODUCTS_VARIANT
17071
- NOT_FOUND
17072
- REQUIRED
17073
- UNIQUE
17074
- VARIANT_NO_DIGITAL_CONTENT
17075
- VARIANT_IN_ACTIVE_ORDER
17076
- CATEGORY_CANNOT_BE_ASSIGNED
17077
- CATEGORY_CANNOT_BE_DELETED
17078
- COLLECTION_CANNOT_BE_CHANGED
17079
- COLLECTION_ALLOWED_FOR_PRODUCTS_ONLY
17080
- COLLECTION_ALLOWED_FOR_VARIANTS_ONLY
17081
- INVENTORY_FIELD_CANNOT_BE_EDITED
17082
- }
17083
-
17084
- """Creates a new microsite."""
17085
- type MicrositeCreate {
17086
- micrositeErrors: [ProductError!]!
17087
- microsite: Microsite
17088
- }
17089
-
17090
- input MicrositeCreateInput {
17091
- """Informs whether a microsite is published."""
17092
- isPublished: Boolean
17093
-
17094
- """Name of the microsite."""
17095
- name: String
17096
-
17097
- """Text to appear in footer of microsite."""
17098
- footerText: String
17099
-
17100
- """Slug of the microsite."""
17101
- slug: String
17102
-
17103
- """Description of the microsite (plaintext, deprecated for input)."""
17104
- description: String
17105
-
17106
- """Description of the microsite (HTML)."""
17107
- descriptionHtml: String
17108
-
17109
- """Banner image file."""
17110
- bannerImage: Upload
17111
-
17112
- """Alt text for an image."""
17113
- bannerImageAlt: String
17114
-
17115
- """Logo image file."""
17116
- logoImage: Upload
17117
-
17118
- """Alt text for an image."""
17119
- logoImageAlt: String
17120
-
17121
- """Search engine optimization fields."""
17122
- seo: SeoInput
17123
-
17124
- """Publication date. ISO 8601 standard."""
17125
- publicationDate: Date
17126
-
17127
- """List of products to be added to the microsite."""
17128
- products: [ID!]
17129
-
17130
- """Vendor that microsite belongs to"""
17131
- vendor: ID!
17132
- }
17133
-
17134
- input SeoInput {
17135
- """SEO title."""
17136
- title: String
17137
-
17138
- """SEO description."""
17139
- description: String
17140
- }
17141
-
17142
- """Deletes a microsite."""
17143
- type MicrositeDelete {
17144
- micrositeErrors: [ProductError!]!
17145
- microsite: Microsite
17146
- }
17147
-
17148
- """Reorder the products of a microsite."""
17149
- type MicrositeReorderProducts {
17150
- """Microsite from which products are reordered."""
17151
- microsite: Microsite
17152
- micrositeErrors: [ProductError!]!
17153
- }
17154
-
17155
- input MoveProductInput {
17156
- """The ID of the product to move."""
17157
- productId: ID!
17158
-
17159
- """
17160
- The relative sorting position of the product (from -inf to +inf) starting from the first given product's actual position.1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged.
17161
- """
17162
- sortOrder: Int
17163
- }
17164
-
17165
- """Deletes microsites."""
17166
- type MicrositeBulkDelete {
17167
- """Returns how many objects were affected."""
17168
- count: Int!
17169
- micrositeErrors: [ProductError!]!
17170
- }
17171
-
17172
- """Publish microsites."""
17173
- type MicrositeBulkPublish {
17174
- """Returns how many objects were affected."""
17175
- count: Int!
17176
- micrositeErrors: [ProductError!]!
17177
- }
17178
-
17179
- """Remove products from a microsite."""
17180
- type MicrositeRemoveProducts {
17181
- """Microsite from which products will be removed."""
17182
- microsite: Microsite
17183
- micrositeErrors: [ProductError!]!
17184
- }
17185
-
17186
- """Updates a microsite."""
17187
- type MicrositeUpdate {
17188
- micrositeErrors: [ProductError!]!
17189
- microsite: Microsite
17190
- }
17191
-
17192
- input MicrositeInput {
17193
- """Informs whether a microsite is published."""
17194
- isPublished: Boolean
17195
-
17196
- """Name of the microsite."""
17197
- name: String
17198
-
17199
- """Text to appear in footer of microsite."""
17200
- footerText: String
17201
-
17202
- """Slug of the microsite."""
17203
- slug: String
17204
-
17205
- """Description of the microsite (plaintext, deprecated for input)."""
17206
- description: String
17207
-
17208
- """Description of the microsite (HTML)."""
17209
- descriptionHtml: String
17210
-
17211
- """Banner image file."""
17212
- bannerImage: Upload
17213
-
17214
- """Alt text for an image."""
17215
- bannerImageAlt: String
17216
-
17217
- """Logo image file."""
17218
- logoImage: Upload
17219
-
17220
- """Alt text for an image."""
17221
- logoImageAlt: String
17222
-
17223
- """Search engine optimization fields."""
17224
- seo: SeoInput
17225
-
17226
- """Publication date. ISO 8601 standard."""
17227
- publicationDate: Date
17228
- }
17229
-
17230
17027
  """Creates a new agreement."""
17231
17028
  type AgreementCreate {
17232
17029
  agreementErrors: [AgreementError!]!
@@ -17298,6 +17095,14 @@ input AgreementInput {
17298
17095
  markupCommissionValue: Decimal
17299
17096
  }
17300
17097
 
17098
+ input SeoInput {
17099
+ """SEO title."""
17100
+ title: String
17101
+
17102
+ """SEO description."""
17103
+ description: String
17104
+ }
17105
+
17301
17106
  """Deletes a agreement."""
17302
17107
  type AgreementDelete {
17303
17108
  agreementErrors: [AgreementError!]!
@@ -18680,6 +18485,80 @@ type RefundPaymentsDelete {
18680
18485
  refundErrors: [RefundError!]!
18681
18486
  }
18682
18487
 
18488
+ """Creates a new policy."""
18489
+ type PolicyCreate {
18490
+ policyErrors: [PolicyError!]!
18491
+ policy: Policy
18492
+ }
18493
+
18494
+ type PolicyError {
18495
+ """
18496
+ Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
18497
+ """
18498
+ field: String
18499
+
18500
+ """The error message."""
18501
+ message: String!
18502
+
18503
+ """The error code."""
18504
+ code: PolicyErrorCode!
18505
+ }
18506
+
18507
+ """An enumeration."""
18508
+ enum PolicyErrorCode {
18509
+ GRAPHQL_ERROR
18510
+ INVALID
18511
+ NOT_FOUND
18512
+ REQUIRED
18513
+ UNIQUE
18514
+ }
18515
+
18516
+ input PolicyInput {
18517
+ """Policy internal name."""
18518
+ slug: String
18519
+
18520
+ """Policy title."""
18521
+ title: String
18522
+
18523
+ """Policy content (HTML)."""
18524
+ contentHtml: String
18525
+
18526
+ """Determines if the policy is visible in the storefront."""
18527
+ isPublished: Boolean
18528
+
18529
+ """Publication date. ISO 8601 standard."""
18530
+ publicationDate: String
18531
+
18532
+ """Search engine optimization fields."""
18533
+ seo: SeoInput
18534
+ }
18535
+
18536
+ """Deletes a policy."""
18537
+ type PolicyDelete {
18538
+ policyErrors: [PolicyError!]!
18539
+ policy: Policy
18540
+ }
18541
+
18542
+ """Deletes policy."""
18543
+ type PolicyBulkDelete {
18544
+ """Returns how many objects were affected."""
18545
+ count: Int!
18546
+ policyErrors: [PolicyError!]!
18547
+ }
18548
+
18549
+ """Publish policy."""
18550
+ type PolicyBulkPublish {
18551
+ """Returns how many objects were affected."""
18552
+ count: Int!
18553
+ policyErrors: [PolicyError!]!
18554
+ }
18555
+
18556
+ """Updates an existing policy."""
18557
+ type PolicyUpdate {
18558
+ policyErrors: [PolicyError!]!
18559
+ policy: Policy
18560
+ }
18561
+
18683
18562
  """Creates a new price book."""
18684
18563
  type PriceBookCreate {
18685
18564
  priceBookErrors: [PriceBookError!]!
@@ -18993,6 +18872,47 @@ type CategoryCreate {
18993
18872
  category: Category
18994
18873
  }
18995
18874
 
18875
+ type ProductError {
18876
+ """
18877
+ Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
18878
+ """
18879
+ field: String
18880
+
18881
+ """The error message."""
18882
+ message: String!
18883
+
18884
+ """The error code."""
18885
+ code: ProductErrorCode!
18886
+
18887
+ """List of attributes IDs which causes the error."""
18888
+ attributes: [ID!]
18889
+ }
18890
+
18891
+ """An enumeration."""
18892
+ enum ProductErrorCode {
18893
+ ALREADY_EXISTS
18894
+ ATTRIBUTE_ALREADY_ASSIGNED
18895
+ ATTRIBUTE_CANNOT_BE_ASSIGNED
18896
+ ATTRIBUTE_VARIANTS_DISABLED
18897
+ DUPLICATED_INPUT_ITEM
18898
+ GRAPHQL_ERROR
18899
+ INVALID
18900
+ INVALID_PHONE
18901
+ NOT_PRODUCTS_IMAGE
18902
+ NOT_PRODUCTS_VARIANT
18903
+ NOT_FOUND
18904
+ REQUIRED
18905
+ UNIQUE
18906
+ VARIANT_NO_DIGITAL_CONTENT
18907
+ VARIANT_IN_ACTIVE_ORDER
18908
+ CATEGORY_CANNOT_BE_ASSIGNED
18909
+ CATEGORY_CANNOT_BE_DELETED
18910
+ COLLECTION_CANNOT_BE_CHANGED
18911
+ COLLECTION_ALLOWED_FOR_PRODUCTS_ONLY
18912
+ COLLECTION_ALLOWED_FOR_VARIANTS_ONLY
18913
+ INVENTORY_FIELD_CANNOT_BE_EDITED
18914
+ }
18915
+
18996
18916
  input CategoryInput {
18997
18917
  """Category description (plaintext, deprecated as input)."""
18998
18918
  description: String
@@ -19159,6 +19079,16 @@ type CollectionReorderProducts {
19159
19079
  productErrors: [ProductError!]!
19160
19080
  }
19161
19081
 
19082
+ input MoveProductInput {
19083
+ """The ID of the product to move."""
19084
+ productId: ID!
19085
+
19086
+ """
19087
+ The relative sorting position of the product (from -inf to +inf) starting from the first given product's actual position.1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged.
19088
+ """
19089
+ sortOrder: Int
19090
+ }
19091
+
19162
19092
  """Deletes collections."""
19163
19093
  type CollectionBulkDelete {
19164
19094
  """Returns how many objects were affected."""
@@ -23091,6 +23021,29 @@ type AppTokenVerify {
23091
23021
  appErrors: [AppError!]!
23092
23022
  }
23093
23023
 
23024
+ """Creates a new dashboard integration for an app."""
23025
+ type AppDashboardIntegrationCreate {
23026
+ appErrors: [AppError!]!
23027
+ appDashboardIntegration: AppDashboardIntegration
23028
+ }
23029
+
23030
+ input AppDashboardIntegrationInput {
23031
+ """ID of app."""
23032
+ app: ID!
23033
+
23034
+ """URL to the iframe"""
23035
+ iframeUrl: String!
23036
+
23037
+ """Context for where this integration should render"""
23038
+ context: AppDashboardIntegrationContextEnum!
23039
+ }
23040
+
23041
+ """Deletes an app storefront integration from the app."""
23042
+ type AppDashboardIntegrationDelete {
23043
+ appErrors: [AppError!]!
23044
+ appDashboardIntegration: AppDashboardIntegration
23045
+ }
23046
+
23094
23047
  """Creates a new storefront integration for an app."""
23095
23048
  type AppStorefrontIntegrationCreate {
23096
23049
  appErrors: [AppError!]!
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nautical-commerce/graphql-schema",
3
- "version": "v1.66.0-1-g62de05314",
3
+ "version": "v1.66.0-11-g957919fa9",
4
4
  "description": "## Getting Started",
5
5
  "main": "./nautical/schema.graphql",
6
6
  "scripts": {