@nautical-commerce/graphql-schema 1.66.0-3-g1956f004b → 1.66.0-4-gbb96a1bbe

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."""
@@ -9150,6 +9180,100 @@ enum RefundSortField {
9150
9180
  TOKEN
9151
9181
  }
9152
9182
 
9183
+ """
9184
+ A policy that can be manually added by a shop operator through the dashboard.
9185
+ """
9186
+ type Policy implements Node & ObjectWithMetadata {
9187
+ """The ID of the object"""
9188
+ id: ID!
9189
+ publicationDate: Date
9190
+ createdAt: DateTime!
9191
+ updatedAt: DateTime!
9192
+ content: String!
9193
+ contentHtml: String!
9194
+ seoTitle: String
9195
+ seoDescription: String
9196
+ category: PolicyCategory!
9197
+ slug: String!
9198
+ title: String!
9199
+
9200
+ """
9201
+ List of private metadata items.Requires proper staff permissions to access.
9202
+ """
9203
+ privateMetadata: [MetadataItem!]!
9204
+
9205
+ """List of public metadata items. Can be accessed without permissions."""
9206
+ metadata: [MetadataItem!]!
9207
+
9208
+ """Whether the policy is published."""
9209
+ isPublished: Boolean!
9210
+ }
9211
+
9212
+ """An enumeration."""
9213
+ enum PolicyCategory {
9214
+ """Terms of Service"""
9215
+ TERMS_OF_SERVICE
9216
+
9217
+ """Privacy Policy"""
9218
+ PRIVACY_POLICY
9219
+
9220
+ """Returns & Refund"""
9221
+ RETURNS_AND_REFUNDS
9222
+
9223
+ """Shipping Policy"""
9224
+ SHIPPING_POLICY
9225
+
9226
+ """Custom"""
9227
+ CUSTOM
9228
+ }
9229
+
9230
+ type PolicyCountableConnection {
9231
+ """Pagination data for this connection."""
9232
+ pageInfo: PageInfo!
9233
+ edges: [PolicyCountableEdge!]!
9234
+
9235
+ """A total count of items in the collection."""
9236
+ totalCount: Int
9237
+ }
9238
+
9239
+ type PolicyCountableEdge {
9240
+ """The item at the end of the edge."""
9241
+ node: Policy!
9242
+
9243
+ """A cursor for use in pagination."""
9244
+ cursor: String!
9245
+ }
9246
+
9247
+ input PolicySortingInput {
9248
+ """Specifies the direction in which to sort products."""
9249
+ direction: OrderDirection!
9250
+
9251
+ """Sort policies by the selected field."""
9252
+ field: PolicySortField!
9253
+ }
9254
+
9255
+ enum PolicySortField {
9256
+ """Sort policies by title."""
9257
+ TITLE
9258
+
9259
+ """Sort policies by slug."""
9260
+ SLUG
9261
+
9262
+ """Sort policies by visibility."""
9263
+ VISIBILITY
9264
+
9265
+ """Sort policies by creation date."""
9266
+ CREATION_DATE
9267
+
9268
+ """Sort policies by publication date."""
9269
+ PUBLICATION_DATE
9270
+ }
9271
+
9272
+ input PolicyFilterInput {
9273
+ search: String
9274
+ isPublished: Boolean
9275
+ }
9276
+
9153
9277
  type DigitalContentCountableConnection {
9154
9278
  """Pagination data for this connection."""
9155
9279
  pageInfo: PageInfo!
@@ -13203,7 +13327,7 @@ type Mutation {
13203
13327
  description: String
13204
13328
 
13205
13329
  """
13206
- Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: application/vnd.oasis.opendocument.spreadsheet, image/webp, image/dxf, application/eps, image/x-tif, application/x-gzip, application/x-csv, image/svg, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/x-rtf, image/heic-sequence, application/vnd.ms-powerpoint, application/jpg, pplication/vnd.rar, application/x-dwg, image/x-dwg, application/vnd.pdf, image/vnd.dwg, text/comma-separated-values, application/rtf, application/vnd.oasis.opendocument.text, image/tiff, application/x-acad, image/x-dxf, image/x-tiff, application/x-eps, image/jpeg, text/svg, text/x-comma-separated-values, application/msword, text/rtf, image/x-bmp, image/heic, application/gzip-compressed, application/gzip, drawing/x-dwf, image/x-eps, application/vnd.ms-excel, application/x-zip-compressed, application/postscript, image/tif, text/svg-xml, drawing/dwg, image/heif-sequence, application/svg+xml, image/heif, application/x-tif, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/svg+xml, application/zip, application/dwg, text/plain, application/x-pdf, text/x-pdf, application/vnd.oasis.opendocument.presentation, image/png, application/gzipped, application/pdf, application/x-tiff, application/x-rar, text/x-csv, application/vnd.ms-word, text/pdf, application/x-tar, image/eps, text/csv, application/tif, image/x-ms-bmp, application/acad, image/bmp, application/csv, application/x-jpg, drawing/x-dwg, application/excel, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/x-rar-compressed, application/x-autocad, image/gif, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/tiff, application/acrobat, application/x-dxf, image/jpg, application/dxf.
13330
+ Used when uploading a new document or file in a multipart request that does not exist in the system already. Supported file types: image/heif-sequence, application/x-zip-compressed, application/excel, image/eps, application/csv, application/vnd.oasis.opendocument.text, application/x-csv, text/svg, application/gzip, application/jpg, image/webp, image/heic, application/svg+xml, image/x-eps, text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, image/tif, image/x-bmp, application/vnd.ms-powerpoint, text/rtf, text/x-csv, image/tiff, application/dwg, image/gif, application/vnd.oasis.opendocument.presentation, image/dxf, application/x-dwg, application/tiff, image/x-dwg, application/zip, application/vnd.openxmlformats-officedocument.presentationml.presentation, text/x-comma-separated-values, image/x-dxf, application/x-rar, application/vnd.oasis.opendocument.spreadsheet, image/x-tif, application/acrobat, image/jpg, application/x-gzip, application/eps, application/vnd.ms-word, text/comma-separated-values, pplication/vnd.rar, image/svg+xml, application/x-tif, application/x-tar, text/svg-xml, application/vnd.ms-excel, application/msword, application/x-acad, text/x-pdf, application/vnd.pdf, application/acad, image/x-ms-bmp, application/rtf, image/heif, application/vnd.openxmlformats-officedocument.presentationml.slideshow, application/gzipped, application/x-rar-compressed, text/pdf, application/x-rtf, application/gzip-compressed, image/bmp, application/pdf, application/postscript, application/dxf, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/x-tiff, image/jpeg, image/png, application/x-dxf, application/x-jpg, drawing/dwg, text/plain, application/tif, application/x-autocad, application/x-eps, application/x-pdf, application/x-tiff, image/heic-sequence, image/svg, drawing/x-dwf, image/vnd.dwg, drawing/x-dwg.
13207
13331
  """
13208
13332
  file: Upload!
13209
13333
 
@@ -14074,6 +14198,42 @@ type Mutation {
14074
14198
  refundId: ID!
14075
14199
  ): RefundPaymentsDelete
14076
14200
 
14201
+ """Creates a new policy."""
14202
+ policyCreate(
14203
+ """Fields required to create a policy."""
14204
+ input: PolicyInput!
14205
+ ): PolicyCreate
14206
+
14207
+ """Deletes a policy."""
14208
+ policyDelete(
14209
+ """ID of the policy to delete."""
14210
+ id: ID!
14211
+ ): PolicyDelete
14212
+
14213
+ """Deletes policy."""
14214
+ policyBulkDelete(
14215
+ """List of policy IDs to delete."""
14216
+ ids: [ID!]!
14217
+ ): PolicyBulkDelete
14218
+
14219
+ """Publish policy."""
14220
+ policyBulkPublish(
14221
+ """List of policy IDs to (un)publish."""
14222
+ ids: [ID!]!
14223
+
14224
+ """Determine if policy will be published or not."""
14225
+ isPublished: Boolean!
14226
+ ): PolicyBulkPublish
14227
+
14228
+ """Updates an existing policy."""
14229
+ policyUpdate(
14230
+ """ID of the policy to update."""
14231
+ id: ID!
14232
+
14233
+ """Fields required to update a policy."""
14234
+ input: PolicyInput!
14235
+ ): PolicyUpdate
14236
+
14077
14237
  """Creates a new price book."""
14078
14238
  priceBookCreate(
14079
14239
  """Fields required to create a price book."""
@@ -18680,6 +18840,80 @@ type RefundPaymentsDelete {
18680
18840
  refundErrors: [RefundError!]!
18681
18841
  }
18682
18842
 
18843
+ """Creates a new policy."""
18844
+ type PolicyCreate {
18845
+ policyErrors: [PolicyError!]!
18846
+ policy: Policy
18847
+ }
18848
+
18849
+ type PolicyError {
18850
+ """
18851
+ Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
18852
+ """
18853
+ field: String
18854
+
18855
+ """The error message."""
18856
+ message: String!
18857
+
18858
+ """The error code."""
18859
+ code: PolicyErrorCode!
18860
+ }
18861
+
18862
+ """An enumeration."""
18863
+ enum PolicyErrorCode {
18864
+ GRAPHQL_ERROR
18865
+ INVALID
18866
+ NOT_FOUND
18867
+ REQUIRED
18868
+ UNIQUE
18869
+ }
18870
+
18871
+ input PolicyInput {
18872
+ """Policy internal name."""
18873
+ slug: String
18874
+
18875
+ """Policy title."""
18876
+ title: String
18877
+
18878
+ """Policy content (HTML)."""
18879
+ contentHtml: String
18880
+
18881
+ """Determines if the policy is visible in the storefront."""
18882
+ isPublished: Boolean
18883
+
18884
+ """Publication date. ISO 8601 standard."""
18885
+ publicationDate: String
18886
+
18887
+ """Search engine optimization fields."""
18888
+ seo: SeoInput
18889
+ }
18890
+
18891
+ """Deletes a policy."""
18892
+ type PolicyDelete {
18893
+ policyErrors: [PolicyError!]!
18894
+ policy: Policy
18895
+ }
18896
+
18897
+ """Deletes policy."""
18898
+ type PolicyBulkDelete {
18899
+ """Returns how many objects were affected."""
18900
+ count: Int!
18901
+ policyErrors: [PolicyError!]!
18902
+ }
18903
+
18904
+ """Publish policy."""
18905
+ type PolicyBulkPublish {
18906
+ """Returns how many objects were affected."""
18907
+ count: Int!
18908
+ policyErrors: [PolicyError!]!
18909
+ }
18910
+
18911
+ """Updates an existing policy."""
18912
+ type PolicyUpdate {
18913
+ policyErrors: [PolicyError!]!
18914
+ policy: Policy
18915
+ }
18916
+
18683
18917
  """Creates a new price book."""
18684
18918
  type PriceBookCreate {
18685
18919
  priceBookErrors: [PriceBookError!]!
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nautical-commerce/graphql-schema",
3
- "version": "v1.66.0-3-g1956f004b",
3
+ "version": "v1.66.0-4-gbb96a1bbe",
4
4
  "description": "## Getting Started",
5
5
  "main": "./nautical/schema.graphql",
6
6
  "scripts": {