From 9f77df66bc6b779153c9aa283f580c10b11ce754 Mon Sep 17 00:00:00 2001 From: rafalp Date: Mon, 30 Oct 2023 14:01:19 +0000 Subject: [PATCH] Update gh-pages to output generated at 91aa745 --- data/schema-changes.json | 142 +++++++++++- data/schema-previous.json | 450 +++++++++++++++++++++++++++++++++++++- index.html | 136 +++++++++++- 3 files changed, 716 insertions(+), 12 deletions(-) diff --git a/data/schema-changes.json b/data/schema-changes.json index ea14c9a..4a1caf1 100644 --- a/data/schema-changes.json +++ b/data/schema-changes.json @@ -1,7 +1,147 @@ [ + { + "diff": "type_new", + "type": "ExportVoucherCodes" + }, + { + "diff": "type_new", + "type": "ExportVoucherCodesInput" + }, + { + "diff": "type_new", + "type": "VoucherCode" + }, + { + "diff": "type_new", + "type": "VoucherCodeBulkDelete" + }, + { + "diff": "type_new", + "type": "VoucherCodeBulkDeleteError" + }, + { + "diff": "type_new", + "type": "VoucherCodeBulkDeleteErrorCode" + }, + { + "diff": "type_new", + "type": "VoucherCodeCountableConnection" + }, + { + "diff": "type_new", + "type": "VoucherCodeCountableEdge" + }, + { + "diff": "type_new", + "type": "VoucherCodeExportCompleted" + }, + { + "diff": "field_new", + "type": "DiscountError", + "field": "voucherCodes" + }, + { + "diff": "field_new", + "type": "DraftOrderCreateInput", + "field": "voucherCode" + }, + { + "diff": "field_new", + "type": "DraftOrderInput", + "field": "voucherCode" + }, + { + "diff": "field_new", + "type": "Mutation", + "field": "exportVoucherCodes" + }, + { + "diff": "field_new", + "type": "Mutation", + "field": "voucherCodeBulkDelete" + }, + { + "diff": "field_new", + "type": "Order", + "field": "voucherCode" + }, + { + "diff": "field_new", + "type": "OrderBulkCreateInput", + "field": "voucherCode" + }, + { + "diff": "field_new", + "type": "Voucher", + "field": "codes" + }, + { + "diff": "field_new", + "type": "Voucher", + "field": "singleUse" + }, + { + "diff": "field_new", + "type": "VoucherInput", + "field": "addCodes" + }, + { + "diff": "field_new", + "type": "VoucherInput", + "field": "singleUse" + }, + { + "diff": "field_deprecated", + "type": "OrderBulkCreateInput", + "field": "voucher", + "version": "3.19" + }, + { + "diff": "field_deprecated", + "type": "Voucher", + "field": "code", + "version": "4.0" + }, + { + "diff": "field_deprecated", + "type": "VoucherInput", + "field": "code", + "version": "4.0" + }, + { + "diff": "enum_value_new", + "enum": "DiscountErrorCode", + "value": "VOUCHER_ALREADY_USED" + }, { "diff": "enum_value_new", "enum": "OrderErrorCode", - "value": "INVALID_VOUCHER" + "value": "INVALID_VOUCHER_CODE" + }, + { + "diff": "enum_value_new", + "enum": "VoucherSortField", + "value": "NAME" + }, + { + "diff": "enum_value_new", + "enum": "WebhookEventTypeAsyncEnum", + "value": "VOUCHER_CODE_EXPORT_COMPLETED" + }, + { + "diff": "enum_value_new", + "enum": "WebhookEventTypeEnum", + "value": "VOUCHER_CODE_EXPORT_COMPLETED" + }, + { + "diff": "enum_value_new", + "enum": "WebhookSampleEventTypeEnum", + "value": "VOUCHER_CODE_EXPORT_COMPLETED" + }, + { + "diff": "enum_value_deprecated", + "enum": "VoucherSortField", + "value": "CODE", + "version": "4.0" } ] \ No newline at end of file diff --git a/data/schema-previous.json b/data/schema-previous.json index a192331..e482889 100644 --- a/data/schema-previous.json +++ b/data/schema-previous.json @@ -15887,6 +15887,13 @@ "deprecated": null, "message": null, "arguments": {} + }, + "voucherCodes": { + "type": "[String!]", + "description": "List of voucher codes which causes the error.\n\nAdded in Saleor 3.18.", + "deprecated": null, + "message": null, + "arguments": {} } } }, @@ -15935,6 +15942,11 @@ "description": null, "deprecated": null, "message": null + }, + "VOUCHER_ALREADY_USED": { + "description": null, + "deprecated": null, + "message": null } } }, @@ -16236,6 +16248,13 @@ "deprecated": null, "message": null, "default": null + }, + "voucherCode": { + "type": "String", + "description": "A code of the voucher associated with the order.\n\nAdded in Saleor 3.18.", + "deprecated": null, + "message": null, + "default": null } } }, @@ -16443,6 +16462,13 @@ "deprecated": null, "message": null, "default": null + }, + "voucherCode": { + "type": "String", + "description": "A code of the voucher associated with the order.\n\nAdded in Saleor 3.18.", + "deprecated": null, + "message": null, + "default": null } } }, @@ -17580,6 +17606,58 @@ } } }, + "ExportVoucherCodes": { + "type": "object", + "interfaces": [], + "description": "Export voucher codes to csv/xlsx file.\n\nAdded in Saleor 3.18.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_CODE_EXPORT_COMPLETED (async): A notification for the exported file.", + "deprecated": null, + "message": null, + "fields": { + "errors": { + "type": "[ExportError!]!", + "description": null, + "deprecated": null, + "message": null, + "arguments": {} + }, + "exportFile": { + "type": "ExportFile", + "description": "The newly created export file job which is responsible for export data.", + "deprecated": null, + "message": null, + "arguments": {} + } + } + }, + "ExportVoucherCodesInput": { + "type": "input", + "description": null, + "deprecated": null, + "message": null, + "fields": { + "fileType": { + "type": "FileTypesEnum!", + "description": "Type of exported file.", + "deprecated": null, + "message": null, + "default": null + }, + "ids": { + "type": "[ID!]", + "description": "List of voucher code IDs to export.", + "deprecated": null, + "message": null, + "default": null + }, + "voucherId": { + "type": "ID", + "description": "The ID of the voucher. If provided, exports all codes belonging to the voucher.", + "deprecated": null, + "message": null, + "default": null + } + } + }, "ExternalAuthentication": { "type": "object", "interfaces": [], @@ -29983,6 +30061,21 @@ } } }, + "exportVoucherCodes": { + "type": "ExportVoucherCodes", + "description": "Export voucher codes to csv/xlsx file.\n\nAdded in Saleor 3.18.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_CODE_EXPORT_COMPLETED (async): A notification for the exported file.", + "deprecated": null, + "message": null, + "arguments": { + "input": { + "type": "ExportVoucherCodesInput!", + "description": "Fields required to export voucher codes.", + "deprecated": null, + "message": null, + "default": null + } + } + }, "externalAuthenticationUrl": { "type": "ExternalAuthenticationUrl", "description": "Prepare external authentication URL for user by custom plugin.", @@ -34397,6 +34490,21 @@ } } }, + "voucherCodeBulkDelete": { + "type": "VoucherCodeBulkDelete", + "description": "Deletes voucher codes.\n\nAdded in Saleor 3.18. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_UPDATED (async): A voucher was updated.", + "deprecated": null, + "message": null, + "arguments": { + "ids": { + "type": "[ID!]!", + "description": "List of voucher codes IDs to delete.", + "deprecated": null, + "message": null, + "default": null + } + } + }, "voucherCreate": { "type": "VoucherCreate", "description": "Creates a new voucher. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_CREATED (async): A voucher was created.", @@ -35303,6 +35411,13 @@ "message": null, "arguments": {} }, + "voucherCode": { + "type": "String", + "description": "Voucher code that was used for Order.\n\nAdded in Saleor 3.18.", + "deprecated": null, + "message": null, + "arguments": {} + }, "weight": { "type": "Weight!", "description": null, @@ -35915,7 +36030,14 @@ }, "voucher": { "type": "String", - "description": "Code of a voucher associated with the order.", + "description": "Code of a voucher associated with the order.\n\nDEPRECATED: this field will be removed in Saleor 3.19. Use `voucherCode` instead.", + "deprecated": "3.19", + "message": "Code of a voucher associated with the order.\n\nDEPRECATED: this field will be removed in Saleor 3.19. Use `voucherCode` instead.", + "default": null + }, + "voucherCode": { + "type": "String", + "description": "Code of a voucher associated with the order.\n\nAdded in Saleor 3.18.", "deprecated": null, "message": null, "default": null @@ -37153,6 +37275,11 @@ "deprecated": null, "message": null }, + "INVALID_VOUCHER_CODE": { + "description": null, + "deprecated": null, + "message": null + }, "NOT_AVAILABLE_IN_CHANNEL": { "description": null, "deprecated": null, @@ -68585,11 +68712,47 @@ "arguments": {} }, "code": { - "type": "String!", - "description": "The code of the voucher.", + "type": "String", + "description": "The code of the voucher.This field will be removed in Saleor 4.0.", + "deprecated": "4.0", + "message": "The code of the voucher.This field will be removed in Saleor 4.0.", + "arguments": {} + }, + "codes": { + "type": "VoucherCodeCountableConnection", + "description": "List of codes available for this voucher.\n\nAdded in Saleor 3.18.", "deprecated": null, "message": null, - "arguments": {} + "arguments": { + "after": { + "type": "String", + "description": "Return the elements in the list that come after the specified cursor.", + "deprecated": null, + "message": null, + "default": null + }, + "before": { + "type": "String", + "description": "Return the elements in the list that come before the specified cursor.", + "deprecated": null, + "message": null, + "default": null + }, + "first": { + "type": "Int", + "description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.", + "deprecated": null, + "message": null, + "default": null + }, + "last": { + "type": "Int", + "description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.", + "deprecated": null, + "message": null, + "default": null + } + } }, "collections": { "type": "CollectionCountableConnection", @@ -68807,6 +68970,13 @@ } } }, + "singleUse": { + "type": "Boolean!", + "description": "Determine if the voucher codes can be used once or multiple times.\n\nAdded in Saleor 3.18.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.", + "deprecated": null, + "message": null, + "arguments": {} + }, "startDate": { "type": "DateTime!", "description": "The start date and time of voucher.", @@ -69075,6 +69245,232 @@ } } }, + "VoucherCode": { + "type": "object", + "interfaces": [], + "description": "Represents voucher code.\n\nAdded in Saleor 3.18.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.", + "deprecated": null, + "message": null, + "fields": { + "code": { + "type": "String", + "description": "Code to use the voucher.", + "deprecated": null, + "message": null, + "arguments": {} + }, + "createdAt": { + "type": "DateTime!", + "description": "Date time of code creation.", + "deprecated": null, + "message": null, + "arguments": {} + }, + "id": { + "type": "ID!", + "description": "The ID of the voucher code.", + "deprecated": null, + "message": null, + "arguments": {} + }, + "isActive": { + "type": "Boolean", + "description": "Whether a code is active or not.", + "deprecated": null, + "message": null, + "arguments": {} + }, + "used": { + "type": "Int", + "description": "Number of times a code has been used.", + "deprecated": null, + "message": null, + "arguments": {} + } + } + }, + "VoucherCodeBulkDelete": { + "type": "object", + "interfaces": [], + "description": "Deletes voucher codes.\n\nAdded in Saleor 3.18. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_UPDATED (async): A voucher was updated.", + "deprecated": null, + "message": null, + "fields": { + "count": { + "type": "Int!", + "description": "Returns how many codes were deleted.", + "deprecated": null, + "message": null, + "arguments": {} + }, + "errors": { + "type": "[VoucherCodeBulkDeleteError!]!", + "description": null, + "deprecated": null, + "message": null, + "arguments": {} + } + } + }, + "VoucherCodeBulkDeleteError": { + "type": "object", + "interfaces": [], + "description": null, + "deprecated": null, + "message": null, + "fields": { + "code": { + "type": "VoucherCodeBulkDeleteErrorCode!", + "description": "The error code.", + "deprecated": null, + "message": null, + "arguments": {} + }, + "message": { + "type": "String", + "description": "The error message.", + "deprecated": null, + "message": null, + "arguments": {} + }, + "path": { + "type": "String", + "description": "Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.", + "deprecated": null, + "message": null, + "arguments": {} + }, + "voucherCodes": { + "type": "[ID!]", + "description": "List of voucher codes which causes the error.", + "deprecated": null, + "message": null, + "arguments": {} + } + } + }, + "VoucherCodeBulkDeleteErrorCode": { + "type": "enum", + "description": "An enumeration.", + "deprecated": null, + "message": null, + "values": { + "GRAPHQL_ERROR": { + "description": null, + "deprecated": null, + "message": null + }, + "INVALID": { + "description": null, + "deprecated": null, + "message": null + }, + "NOT_FOUND": { + "description": null, + "deprecated": null, + "message": null + } + } + }, + "VoucherCodeCountableConnection": { + "type": "object", + "interfaces": [], + "description": null, + "deprecated": null, + "message": null, + "fields": { + "edges": { + "type": "[VoucherCodeCountableEdge!]!", + "description": null, + "deprecated": null, + "message": null, + "arguments": {} + }, + "pageInfo": { + "type": "PageInfo!", + "description": "Pagination data for this connection.", + "deprecated": null, + "message": null, + "arguments": {} + }, + "totalCount": { + "type": "Int", + "description": "A total count of items in the collection.", + "deprecated": null, + "message": null, + "arguments": {} + } + } + }, + "VoucherCodeCountableEdge": { + "type": "object", + "interfaces": [], + "description": null, + "deprecated": null, + "message": null, + "fields": { + "cursor": { + "type": "String!", + "description": "A cursor for use in pagination.", + "deprecated": null, + "message": null, + "arguments": {} + }, + "node": { + "type": "VoucherCode!", + "description": "The item at the end of the edge.", + "deprecated": null, + "message": null, + "arguments": {} + } + } + }, + "VoucherCodeExportCompleted": { + "type": "object", + "interfaces": [ + "Event" + ], + "description": "Event sent when voucher code export is completed.\n\nAdded in Saleor 3.18.", + "deprecated": null, + "message": null, + "fields": { + "export": { + "type": "ExportFile", + "description": "The export file for voucher codes.", + "deprecated": null, + "message": null, + "arguments": {} + }, + "issuedAt": { + "type": "DateTime", + "description": "Time of the event.", + "deprecated": null, + "message": null, + "arguments": {} + }, + "issuingPrincipal": { + "type": "IssuingPrincipal", + "description": "The user or application that triggered the event.", + "deprecated": null, + "message": null, + "arguments": {} + }, + "recipient": { + "type": "App", + "description": "The application receiving the webhook.", + "deprecated": null, + "message": null, + "arguments": {} + }, + "version": { + "type": "String", + "description": "Saleor version that triggered the event.", + "deprecated": null, + "message": null, + "arguments": {} + } + } + }, "VoucherCountableConnection": { "type": "object", "interfaces": [], @@ -69382,6 +69778,13 @@ "deprecated": null, "message": null, "fields": { + "addCodes": { + "type": "[String!]", + "description": "List of codes to add.\n\nAdded in Saleor 3.18.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.", + "deprecated": null, + "message": null, + "default": null + }, "applyOncePerCustomer": { "type": "Boolean", "description": "Voucher should be applied once per customer.", @@ -69405,9 +69808,9 @@ }, "code": { "type": "String", - "description": "Code to use the voucher.", - "deprecated": null, - "message": null, + "description": "Code to use the voucher. This field will be removed in Saleor 4.0. Use `addCodes` instead.", + "deprecated": "4.0", + "message": "Code to use the voucher. This field will be removed in Saleor 4.0. Use `addCodes` instead.", "default": null }, "collections": { @@ -69466,6 +69869,13 @@ "message": null, "default": null }, + "singleUse": { + "type": "Boolean", + "description": "When set to 'True', each voucher code can be used only once; otherwise, codes can be used multiple times depending on `usageLimit`.\n\nThe option can only be changed if none of the voucher codes have been used.\n\nAdded in Saleor 3.18.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.", + "deprecated": null, + "message": null, + "default": null + }, "startDate": { "type": "DateTime", "description": "Start date of the voucher in ISO 8601 format.", @@ -69587,9 +69997,9 @@ "message": null, "values": { "CODE": { - "description": "Sort vouchers by code.", - "deprecated": null, - "message": null + "description": "Sort vouchers by code.\n\nDEPRECATED: this field will be removed in Saleor 4.0.", + "deprecated": "4.0", + "message": "Sort vouchers by code.\n\nDEPRECATED: this field will be removed in Saleor 4.0." }, "END_DATE": { "description": "Sort vouchers by end date.", @@ -69601,6 +70011,11 @@ "deprecated": null, "message": null }, + "NAME": { + "description": "Sort vouchers by name.\n\nAdded in Saleor 3.18.", + "deprecated": null, + "message": null + }, "START_DATE": { "description": "Sort vouchers by start date.", "deprecated": null, @@ -71947,6 +72362,11 @@ "deprecated": null, "message": null }, + "VOUCHER_CODE_EXPORT_COMPLETED": { + "description": "A voucher code export is completed.\n\nAdded in Saleor 3.18.", + "deprecated": null, + "message": null + }, "VOUCHER_CREATED": { "description": "A new voucher created.", "deprecated": null, @@ -72765,6 +73185,11 @@ "deprecated": null, "message": null }, + "VOUCHER_CODE_EXPORT_COMPLETED": { + "description": "A voucher code export is completed.\n\nAdded in Saleor 3.18.", + "deprecated": null, + "message": null + }, "VOUCHER_CREATED": { "description": "A new voucher created.", "deprecated": null, @@ -73586,6 +74011,11 @@ "deprecated": null, "message": null }, + "VOUCHER_CODE_EXPORT_COMPLETED": { + "description": null, + "deprecated": null, + "message": null + }, "VOUCHER_CREATED": { "description": null, "deprecated": null, diff --git a/index.html b/index.html index 9c2e509..6965e05 100644 --- a/index.html +++ b/index.html @@ -12,7 +12,7 @@

Saleor Deprecations Report

-

Generated on 2023-10-27 14:01:04

+

Generated on 2023-10-30 14:01:17

Summary

@@ -815,6 +815,17 @@

Summary

4.0 + + + ... + + + Voucher + code + + 4.0 + + ... @@ -1275,6 +1286,17 @@

Summary

4.0 + + + ... + + + VoucherSortField + CODE + + 4.0 + + ... @@ -3559,6 +3581,17 @@

Summary

4.0 + + + ... + + + OrderBulkCreateInput + voucher + + 3.19 + + ... @@ -4080,6 +4113,17 @@

Summary

4.0 + + + ... + + + VoucherInput + code + + 4.0 + + ... @@ -6879,6 +6923,27 @@

+
+
+
+

+ + Field code of type Voucher + +

+

Removed in Saleor 4.0

+

The code of the voucher.This field will be removed in Saleor 4.0.

+
+
+
type Voucher {
+  ...
+  code: String
+  ...
+}
+
+
+
+