From 0c6c53bcefa802619f3f536b6e6026c61aa30692 Mon Sep 17 00:00:00 2001 From: "ct-sdks[bot]" <153784748+ct-sdks[bot]@users.noreply.github.com> Date: Thu, 14 Nov 2024 15:22:40 +0000 Subject: [PATCH] build(codegen): updating SDK --- changes.md | 71 +------------------ lib/commercetools-api/docs/RequestBuilder.md | 2 +- .../src/Models/Error/GraphQLErrorObject.php | 2 +- .../Models/Error/GraphQLErrorObjectModel.php | 2 +- .../GraphQLInsufficientScopeErrorModel.php | 2 +- .../Error/GraphQLInvalidSubjectErrorModel.php | 2 +- .../Error/GraphQLInvalidTokenErrorModel.php | 2 +- .../src/Models/GraphQl/GraphQLError.php | 8 ++- .../Models/GraphQl/GraphQLErrorBuilder.php | 8 ++- .../Models/GraphQl/GraphQLErrorLocation.php | 4 ++ .../GraphQl/GraphQLErrorLocationBuilder.php | 4 ++ .../GraphQl/GraphQLErrorLocationModel.php | 4 ++ .../src/Models/GraphQl/GraphQLErrorModel.php | 8 ++- .../src/Models/GraphQl/GraphQLRequest.php | 6 ++ .../Models/GraphQl/GraphQLRequestBuilder.php | 6 ++ .../Models/GraphQl/GraphQLRequestModel.php | 6 ++ .../src/Models/GraphQl/GraphQLResponse.php | 4 ++ .../Models/GraphQl/GraphQLResponseBuilder.php | 4 ++ .../Models/GraphQl/GraphQLResponseModel.php | 4 ++ references.txt | 1 + 20 files changed, 73 insertions(+), 77 deletions(-) diff --git a/changes.md b/changes.md index 191dc4b301d..208cb3f1ff7 100644 --- a/changes.md +++ b/changes.md @@ -1,74 +1,9 @@ **Api changes**
-Added Type(s) +Changed Property(s) -- added type `ApprovalRuleSetCustomFieldAction` -- added type `ApprovalRuleSetCustomTypeAction` -- added type `SearchNotReadyError` -- added type `GraphQLSearchNotReadyError` -- added type `ProductTailoringAttribute` -- added type `ProductTailoringSetAttributeAction` -- added type `ProductTailoringSetAttributeInAllVariantsAction` -- added type `ImageProcessingOngoingWarning` -- added type `WarningObject` -
- - -
-Removed Type(s) - -- :warning: removed type `ProductSearchStatus` -
- - -
-Added Property(s) - -- added property `custom` to type `ApprovalRule` -- added property `staged` to type `ProductVariantDeletedMessage` -- added property `staged` to type `ProductVariantDeletedMessagePayload` -- added property `warnings` to type `ProductTailoring` -- added property `attributes` to type `ProductVariantTailoring` -- added property `attributes` to type `ProductVariantTailoringDraft` -- added property `attributes` to type `ProductTailoringAddVariantAction` -- added property `warnings` to type `Product` -- added property `customers` to type `SearchIndexingConfiguration` -- added property `source` to type `EventBridgeDestination` -
- - -
-Added Enum(s) - -- added enum `customer-group` to type `ExtensionResourceTypeId` -- added enum `product-tailoring` to type `MessageSubscriptionResourceTypeId` -- added enum `approval-rule` to type `CustomFieldReferenceValue` -- added enum `approval-rule` to type `ResourceTypeId` -- added enum `product-tailoring` to type `ResourceTypeId` -
- - -
-Added Method(s) - -- added method `$apiRoot->withProjectKey()->productTailoring()->head()` -
- -**Import changes** - -
-Added Type(s) - -- added type `InvalidFieldsUpdateError` -- added type `NewMasterVariantAdditionNotAllowedError` -
- -**History changes** - -
-Required Property(s) - -- changed property `id` of type `ModifiedBy` to be optional +- :warning: changed property `line` of type `GraphQLErrorLocation` from type `integer` to `number` +- :warning: changed property `column` of type `GraphQLErrorLocation` from type `integer` to `number`
diff --git a/lib/commercetools-api/docs/RequestBuilder.md b/lib/commercetools-api/docs/RequestBuilder.md index bc1aad41477..a66c4a878b7 100644 --- a/lib/commercetools-api/docs/RequestBuilder.md +++ b/lib/commercetools-api/docs/RequestBuilder.md @@ -3260,7 +3260,7 @@ $request = $builder ``` ## `withProjectKey("projectKey")->graphql()->post(null)` -Execute a GraphQL query +Execute a GraphQL request. ### Example ```php diff --git a/lib/commercetools-api/src/Models/Error/GraphQLErrorObject.php b/lib/commercetools-api/src/Models/Error/GraphQLErrorObject.php index ac251a91abe..7ee748c4caf 100644 --- a/lib/commercetools-api/src/Models/Error/GraphQLErrorObject.php +++ b/lib/commercetools-api/src/Models/Error/GraphQLErrorObject.php @@ -18,7 +18,7 @@ interface GraphQLErrorObject extends JsonObject public const FIELD_PATTERN1 = '//'; /** - *

Error identifier.

+ *

One of the error codes that is listed on the Errors page.

* * @return null|string diff --git a/lib/commercetools-api/src/Models/Error/GraphQLErrorObjectModel.php b/lib/commercetools-api/src/Models/Error/GraphQLErrorObjectModel.php index 00a1ec20e38..067718cae79 100644 --- a/lib/commercetools-api/src/Models/Error/GraphQLErrorObjectModel.php +++ b/lib/commercetools-api/src/Models/Error/GraphQLErrorObjectModel.php @@ -120,7 +120,7 @@ public function __construct( } /** - *

Error identifier.

+ *

One of the error codes that is listed on the Errors page.

* * * @return null|string diff --git a/lib/commercetools-api/src/Models/Error/GraphQLInsufficientScopeErrorModel.php b/lib/commercetools-api/src/Models/Error/GraphQLInsufficientScopeErrorModel.php index 659ea7c36c1..2037b566432 100644 --- a/lib/commercetools-api/src/Models/Error/GraphQLInsufficientScopeErrorModel.php +++ b/lib/commercetools-api/src/Models/Error/GraphQLInsufficientScopeErrorModel.php @@ -37,7 +37,7 @@ public function __construct( } /** - *

Error identifier.

+ *

One of the error codes that is listed on the Errors page.

* * * @return null|string diff --git a/lib/commercetools-api/src/Models/Error/GraphQLInvalidSubjectErrorModel.php b/lib/commercetools-api/src/Models/Error/GraphQLInvalidSubjectErrorModel.php index d21bf045fea..1b4e358f282 100644 --- a/lib/commercetools-api/src/Models/Error/GraphQLInvalidSubjectErrorModel.php +++ b/lib/commercetools-api/src/Models/Error/GraphQLInvalidSubjectErrorModel.php @@ -37,7 +37,7 @@ public function __construct( } /** - *

Error identifier.

+ *

One of the error codes that is listed on the Errors page.

* * * @return null|string diff --git a/lib/commercetools-api/src/Models/Error/GraphQLInvalidTokenErrorModel.php b/lib/commercetools-api/src/Models/Error/GraphQLInvalidTokenErrorModel.php index 6278eab6f96..cc0fc71d023 100644 --- a/lib/commercetools-api/src/Models/Error/GraphQLInvalidTokenErrorModel.php +++ b/lib/commercetools-api/src/Models/Error/GraphQLInvalidTokenErrorModel.php @@ -37,7 +37,7 @@ public function __construct( } /** - *

Error identifier.

+ *

One of the error codes that is listed on the Errors page.

* * * @return null|string diff --git a/lib/commercetools-api/src/Models/GraphQl/GraphQLError.php b/lib/commercetools-api/src/Models/GraphQl/GraphQLError.php index 3b480fc924b..cf464fa092f 100644 --- a/lib/commercetools-api/src/Models/GraphQl/GraphQLError.php +++ b/lib/commercetools-api/src/Models/GraphQl/GraphQLError.php @@ -20,25 +20,31 @@ interface GraphQLError extends JsonObject public const FIELD_EXTENSIONS = 'extensions'; /** + *

Detailed description of the error explaining the root cause of the problem and suggesting how to correct the error.

+ * * @return null|string */ public function getMessage(); /** + *

Location within your query where the error occurred.

+ * * @return null|GraphQLErrorLocationCollection */ public function getLocations(); /** + *

Query fields listed in order from the root of the query response up to the field in which the error occurred. path is displayed in the response only if an error is associated with a particular field in the query result.

+ * * @return null|array */ public function getPath(); /** - *

Represents a single error.

+ *

Dictionary with additional information where applicable.

* * @return null|GraphQLErrorObject diff --git a/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorBuilder.php b/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorBuilder.php index 727adde5abf..10075377ff8 100644 --- a/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorBuilder.php +++ b/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorBuilder.php @@ -47,6 +47,8 @@ final class GraphQLErrorBuilder implements Builder private $extensions; /** + *

Detailed description of the error explaining the root cause of the problem and suggesting how to correct the error.

+ * * @return null|string */ @@ -56,6 +58,8 @@ public function getMessage() } /** + *

Location within your query where the error occurred.

+ * * @return null|GraphQLErrorLocationCollection */ @@ -65,6 +69,8 @@ public function getLocations() } /** + *

Query fields listed in order from the root of the query response up to the field in which the error occurred. path is displayed in the response only if an error is associated with a particular field in the query result.

+ * * @return null|array */ @@ -74,7 +80,7 @@ public function getPath() } /** - *

Represents a single error.

+ *

Dictionary with additional information where applicable.

* * @return null|GraphQLErrorObject diff --git a/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorLocation.php b/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorLocation.php index 5d302b0c470..c629c122a35 100644 --- a/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorLocation.php +++ b/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorLocation.php @@ -17,12 +17,16 @@ interface GraphQLErrorLocation extends JsonObject public const FIELD_COLUMN = 'column'; /** + *

Line number of the query where the error occurred.

+ * * @return null|int */ public function getLine(); /** + *

Position in line where the error occurred.

+ * * @return null|int */ diff --git a/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorLocationBuilder.php b/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorLocationBuilder.php index e5bcbace28f..662508e114e 100644 --- a/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorLocationBuilder.php +++ b/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorLocationBuilder.php @@ -33,6 +33,8 @@ final class GraphQLErrorLocationBuilder implements Builder private $column; /** + *

Line number of the query where the error occurred.

+ * * @return null|int */ @@ -42,6 +44,8 @@ public function getLine() } /** + *

Position in line where the error occurred.

+ * * @return null|int */ diff --git a/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorLocationModel.php b/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorLocationModel.php index 37d9c17125a..ac4700d1019 100644 --- a/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorLocationModel.php +++ b/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorLocationModel.php @@ -44,6 +44,8 @@ public function __construct( } /** + *

Line number of the query where the error occurred.

+ * * * @return null|int */ @@ -62,6 +64,8 @@ public function getLine() } /** + *

Position in line where the error occurred.

+ * * * @return null|int */ diff --git a/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorModel.php b/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorModel.php index 1c0f0ebc7e7..5d1d01c81b7 100644 --- a/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorModel.php +++ b/lib/commercetools-api/src/Models/GraphQl/GraphQLErrorModel.php @@ -62,6 +62,8 @@ public function __construct( } /** + *

Detailed description of the error explaining the root cause of the problem and suggesting how to correct the error.

+ * * * @return null|string */ @@ -80,6 +82,8 @@ public function getMessage() } /** + *

Location within your query where the error occurred.

+ * * * @return null|GraphQLErrorLocationCollection */ @@ -98,6 +102,8 @@ public function getLocations() } /** + *

Query fields listed in order from the root of the query response up to the field in which the error occurred. path is displayed in the response only if an error is associated with a particular field in the query result.

+ * * * @return null|array */ @@ -116,7 +122,7 @@ public function getPath() } /** - *

Represents a single error.

+ *

Dictionary with additional information where applicable.

* * * @return null|GraphQLErrorObject diff --git a/lib/commercetools-api/src/Models/GraphQl/GraphQLRequest.php b/lib/commercetools-api/src/Models/GraphQl/GraphQLRequest.php index 6238d5650e7..3c6df8b271f 100644 --- a/lib/commercetools-api/src/Models/GraphQl/GraphQLRequest.php +++ b/lib/commercetools-api/src/Models/GraphQl/GraphQLRequest.php @@ -18,18 +18,24 @@ interface GraphQLRequest extends JsonObject public const FIELD_VARIABLES = 'variables'; /** + *

String representation of the Source Text of the Document that is specified in the Language section of the GraphQL specification.

+ * * @return null|string */ public function getQuery(); /** + *

Name of the operation, if you defined several operations in query.

+ * * @return null|string */ public function getOperationName(); /** + *

JSON object that contains key-value pairs in which the keys are variable names and the values are variable values.

+ * * @return null|GraphQLVariablesMap */ diff --git a/lib/commercetools-api/src/Models/GraphQl/GraphQLRequestBuilder.php b/lib/commercetools-api/src/Models/GraphQl/GraphQLRequestBuilder.php index 99b2d96e5e0..8294894ec32 100644 --- a/lib/commercetools-api/src/Models/GraphQl/GraphQLRequestBuilder.php +++ b/lib/commercetools-api/src/Models/GraphQl/GraphQLRequestBuilder.php @@ -39,6 +39,8 @@ final class GraphQLRequestBuilder implements Builder private $variables; /** + *

String representation of the Source Text of the Document that is specified in the Language section of the GraphQL specification.

+ * * @return null|string */ @@ -48,6 +50,8 @@ public function getQuery() } /** + *

Name of the operation, if you defined several operations in query.

+ * * @return null|string */ @@ -57,6 +61,8 @@ public function getOperationName() } /** + *

JSON object that contains key-value pairs in which the keys are variable names and the values are variable values.

+ * * @return null|GraphQLVariablesMap */ diff --git a/lib/commercetools-api/src/Models/GraphQl/GraphQLRequestModel.php b/lib/commercetools-api/src/Models/GraphQl/GraphQLRequestModel.php index 11af37b4d96..f5a0113b1fd 100644 --- a/lib/commercetools-api/src/Models/GraphQl/GraphQLRequestModel.php +++ b/lib/commercetools-api/src/Models/GraphQl/GraphQLRequestModel.php @@ -52,6 +52,8 @@ public function __construct( } /** + *

String representation of the Source Text of the Document that is specified in the Language section of the GraphQL specification.

+ * * * @return null|string */ @@ -70,6 +72,8 @@ public function getQuery() } /** + *

Name of the operation, if you defined several operations in query.

+ * * * @return null|string */ @@ -88,6 +92,8 @@ public function getOperationName() } /** + *

JSON object that contains key-value pairs in which the keys are variable names and the values are variable values.

+ * * * @return null|GraphQLVariablesMap */ diff --git a/lib/commercetools-api/src/Models/GraphQl/GraphQLResponse.php b/lib/commercetools-api/src/Models/GraphQl/GraphQLResponse.php index 76fcaeb112f..f8594d516b7 100644 --- a/lib/commercetools-api/src/Models/GraphQl/GraphQLResponse.php +++ b/lib/commercetools-api/src/Models/GraphQl/GraphQLResponse.php @@ -17,12 +17,16 @@ interface GraphQLResponse extends JsonObject public const FIELD_ERRORS = 'errors'; /** + *

JSON object that contains the results of a GraphQL query.

+ * * @return null|mixed */ public function getData(); /** + *

Errors that the GraphQL query returns.

+ * * @return null|GraphQLErrorCollection */ diff --git a/lib/commercetools-api/src/Models/GraphQl/GraphQLResponseBuilder.php b/lib/commercetools-api/src/Models/GraphQl/GraphQLResponseBuilder.php index 735c233c5f4..9b5525ff5d4 100644 --- a/lib/commercetools-api/src/Models/GraphQl/GraphQLResponseBuilder.php +++ b/lib/commercetools-api/src/Models/GraphQl/GraphQLResponseBuilder.php @@ -33,6 +33,8 @@ final class GraphQLResponseBuilder implements Builder private $errors; /** + *

JSON object that contains the results of a GraphQL query.

+ * * @return null|mixed */ @@ -42,6 +44,8 @@ public function getData() } /** + *

Errors that the GraphQL query returns.

+ * * @return null|GraphQLErrorCollection */ diff --git a/lib/commercetools-api/src/Models/GraphQl/GraphQLResponseModel.php b/lib/commercetools-api/src/Models/GraphQl/GraphQLResponseModel.php index 1765d6e2bf0..d2abb6aca6d 100644 --- a/lib/commercetools-api/src/Models/GraphQl/GraphQLResponseModel.php +++ b/lib/commercetools-api/src/Models/GraphQl/GraphQLResponseModel.php @@ -44,6 +44,8 @@ public function __construct( } /** + *

JSON object that contains the results of a GraphQL query.

+ * * * @return null|mixed */ @@ -62,6 +64,8 @@ public function getData() } /** + *

Errors that the GraphQL query returns.

+ * * * @return null|GraphQLErrorCollection */ diff --git a/references.txt b/references.txt index 01d75bd8ba0..a5feab92960 100644 --- a/references.txt +++ b/references.txt @@ -323,3 +323,4 @@ ccf4522140c12b0093aefe0e2a27d62bcc4834a6 07b822efee634159a97f9ba24f86114b984d8d4c 8e09aa861a0ba58755289bc185dcb268ac4f1c13 0be69283d6aba9d3a2f895140378673f2f80f7b0 +f254d17f05343dcc4299fc53ff9b335b5ef63d69